refactor validate methods into Introspection::Validate

Author: DannyBen

lib/bashly.rb

@@ -28,7 +28,7 @@ module Script
     module Introspection
       autoloads 'bashly/script/introspection', %i[
         Arguments Commands Dependencies EnvironmentVariables Examples Flags
-        Variables Visibility
+        Validate Variables Visibility
       ]
     end
   end

lib/bashly/script/argument.rb

@@ -3,6 +3,8 @@
 module Bashly
   module Script
     class Argument < Base
+      include Introspection::Validate
+      
       class << self
         def option_keys
           @option_keys ||= %i[
@@ -28,15 +30,6 @@ def label
       def usage_string
         required ? label : "[#{label}]"
       end
-
-      def validate
-        return [] unless options['validate']
-
-        result = options['validate']
-        result.is_a?(Array) ? result : [result]
-      end
-
-      def validate? = validate.any?
     end
   end
 end

lib/bashly/script/environment_variable.rb

@@ -2,6 +2,7 @@ module Bashly
   module Script
     class EnvironmentVariable < Base
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys
@@ -16,15 +17,6 @@ def usage_string(extended: false)
         result << strings[:required] if required && extended
         result.join ' '
       end
-
-      def validate
-        return [] unless options['validate']
-
-        result = options['validate']
-        result.is_a?(Array) ? result : [result]
-      end
-
-      def validate? = validate.any?
     end
   end
 end

lib/bashly/script/flag.rb

@@ -5,6 +5,7 @@ module Script
     class Flag < Base
       include Completions::Flag
       include Introspection::Visibility
+      include Introspection::Validate
 
       class << self
         def option_keys
@@ -46,15 +47,6 @@ def usage_string(extended: false)
         result << strings[:repeatable] if repeatable && extended
         result.join ' '
       end
-
-      def validate
-        return [] unless options['validate']
-
-        result = options['validate']
-        result.is_a?(Array) ? result : [result]
-      end
-
-      def validate? = validate.any?
     end
   end
 end

lib/bashly/script/introspection/validate.rb

@@ -0,0 +1,18 @@
+module Bashly
+  module Script
+    module Introspection
+      module Validate
+        # Returns an array of validations
+        def validate
+          return [] unless options['validate']
+
+          result = options['validate']
+          result.is_a?(Array) ? result : [result]
+        end
+
+        # Returns true if there are any validations defined
+        def validate? = validate.any?
+      end
+    end
+  end
+end

spec/bashly/script/argument_spec.rb

@@ -6,6 +6,15 @@
 
   let(:fixture) { :basic_argument }
 
+  describe 'composition' do
+    it 'includes the necessary modules' do
+      modules = [Script::Introspection::Validate]
+      modules.each do |mod|
+        expect(described_class.ancestors).to include(mod)
+      end
+    end
+  end
+
   describe '#default_string' do
     context 'when default is an array' do
       let(:fixture) { :default_array }
@@ -59,36 +68,4 @@
       end
     end
   end
-
-  describe '#validate' do
-    context 'with a string value' do
-      let(:fixture) { :validate_string }
-
-      it 'returns it as an array' do
-        expect(subject.validate).to eq ['file_exists']
-      end
-    end
-
-    context 'with an array value' do
-      let(:fixture) { :validate_array }
-
-      it 'returns it as is' do
-        expect(subject.validate).to eq ['file_exists', 'file_is_writable']
-      end
-    end
-  end
-
-  describe '#validate?' do
-    it 'returns false' do
-      expect(subject.validate?).to be false
-    end
-
-    context 'when validations are defined' do      
-      let(:fixture) { :validate_string }
-
-      it 'returns true' do
-        expect(subject.validate?).to be true
-      end
-    end
-  end
 end

spec/bashly/script/command_spec.rb

@@ -8,6 +8,25 @@
   let(:fixtures) { load_fixture 'script/commands' }
   let(:fixture) { :basic_command }
 
+  describe 'composition' do
+    it 'includes the necessary modules' do
+      modules = [
+        Script::Introspection::Arguments,
+        Script::Introspection::Commands,
+        Script::Introspection::Dependencies,
+        Script::Introspection::EnvironmentVariables,
+        Script::Introspection::Examples,
+        Script::Introspection::Flags,
+        Script::Introspection::Variables,
+        Script::Introspection::Visibility,
+        Completions::Command
+      ]
+      modules.each do |mod|
+        expect(described_class.ancestors).to include(mod)
+      end
+    end
+  end
+
   describe '#action_name' do
     context 'when it is the root command' do
       it 'returns root' do

spec/bashly/script/environment_variable_spec.rb

@@ -6,6 +6,15 @@
 
   let(:fixture) { :basic_env_var }
 
+  describe 'composition' do
+    it 'includes the necessary modules' do
+      modules = [Script::Introspection::Visibility, Script::Introspection::Validate]
+      modules.each do |mod|
+        expect(described_class.ancestors).to include(mod)
+      end
+    end
+  end
+
   describe '#usage_string' do
     it 'returns a string suitable to be used as a usage pattern' do
       expect(subject.usage_string).to eq 'BUILD_DIR'
@@ -27,36 +36,4 @@
       end
     end
   end
-
-  describe '#validate' do
-    context 'with a string value' do
-      let(:fixture) { :validate_string }
-
-      it 'returns it as an array' do
-        expect(subject.validate).to eq ['dir_exists']
-      end
-    end
-
-    context 'with an array value' do
-      let(:fixture) { :validate_array }
-
-      it 'returns it as is' do
-        expect(subject.validate).to eq ['dir_exists', 'dir_is_writable']
-      end
-    end
-  end
-
-  describe '#validate?' do
-    it 'returns false' do
-      expect(subject.validate?).to be false
-    end
-
-    context 'when validations are defined' do      
-      let(:fixture) { :validate_string }
-
-      it 'returns true' do
-        expect(subject.validate?).to be true
-      end
-    end
-  end
 end

spec/bashly/script/flag_spec.rb

@@ -6,6 +6,18 @@
 
   let(:fixture) { :basic_flag }
 
+  describe 'composition' do
+    it 'includes the necessary modules' do
+      modules = [
+        Script::Introspection::Visibility, Script::Introspection::Validate,
+        Completions::Flag
+      ]
+      modules.each do |mod|
+        expect(described_class.ancestors).to include(mod)
+      end
+    end
+  end
+
   describe '#aliases' do
     context 'with long and short options' do
       it 'returns an array of both long and short values' do
@@ -109,36 +121,4 @@
       end
     end
   end
-
-  describe '#validate' do
-    context 'with a string value' do
-      let(:fixture) { :validate_string }
-
-      it 'returns it as an array' do
-        expect(subject.validate).to eq ['file_exists']
-      end
-    end
-
-    context 'with an array value' do
-      let(:fixture) { :validate_array }
-
-      it 'returns it as is' do
-        expect(subject.validate).to eq ['file_exists', 'file_is_writable']
-      end
-    end
-  end
-
-  describe '#validate?' do
-    it 'returns false' do
-      expect(subject.validate?).to be false
-    end
-
-    context 'when validations are defined' do      
-      let(:fixture) { :validate_string }
-
-      it 'returns true' do
-        expect(subject.validate?).to be true
-      end
-    end
-  end
 end

spec/bashly/script/introspection/validate_spec.rb

@@ -0,0 +1,40 @@
+describe Script::Introspection::Validate do
+  subject do
+    Script::Flag.new fixtures[fixture]
+  end
+
+  let(:fixtures) { load_fixture 'script/arguments' }
+  let(:fixture) { :basic_argument }
+
+  describe '#validate' do
+    context 'with a string value' do
+      let(:fixture) { :validate_string }
+
+      it 'returns it as an array' do
+        expect(subject.validate).to eq ['file_exists']
+      end
+    end
+
+    context 'with an array value' do
+      let(:fixture) { :validate_array }
+
+      it 'returns it as is' do
+        expect(subject.validate).to eq ['file_exists', 'file_is_writable']
+      end
+    end
+  end
+
+  describe '#validate?' do
+    it 'returns false' do
+      expect(subject.validate?).to be false
+    end
+
+    context 'when validations are defined' do      
+      let(:fixture) { :validate_string }
+
+      it 'returns true' do
+        expect(subject.validate?).to be true
+      end
+    end
+  end
+end