Merge pull request #428 from DannyBen/refactor/x_arbitrary

Refactor arbitrary options from x- to x_

Author: DannyBen

lib/bashly/concerns/validation_helpers.rb

@@ -40,8 +40,7 @@ def assert_hash(key, value, keys: nil)
 
       return unless keys
 
-      invalid_keys = value.keys.map(&:to_sym) - keys
-      invalid_keys.reject! { |key| key.start_with? 'x-' }
+      invalid_keys = (value.keys.map(&:to_sym) - keys).reject { |k| k.start_with? 'x_' }
       assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 

lib/bashly/script/base.rb

@@ -35,7 +35,8 @@ def method_missing(method_name, *arguments, &block)
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        self.class.option_keys.include?(method_name) || super
+        self.class.option_keys.include?(method_name) ||
+          method_name.to_s.start_with?('x_') || super
       end
     end
   end

schemas/bashly.json

@@ -3,11 +3,11 @@
     "definitions": {
         "custom-properties": {
             "patternProperties": {
-                "^x-.": {
+                "^x_.": {
                     "title": "custom property",
                     "description": "A custom property of any type",
                     "examples": [
-                        "This command shows the status of all `images`, `containers` and `volumes`. Use with `--verbose` to see deleted containers."
+                        "Anything"
                     ]
                 }
             }

spec/bashly/script/base_spec.rb

@@ -25,6 +25,12 @@
         expect { subject.no_such_option }.to raise_error(NoMethodError)
       end
     end
+
+    context 'when the method starts with x_ and does not exist' do
+      it 'returns nil' do
+        expect(subject.x_no_such_option).to be_nil
+      end
+    end
   end
 
   describe '#optional' do

spec/fixtures/script/x-arbitrary.yml

@@ -0,0 +1,29 @@
+name: docker
+x_string: hello
+x_hash: { key: value }
+x_array: [1, 2]
+x_int: 1
+x_float: 1.2
+x_boolean: yes
+x_nil: ~
+
+environment_variables:
+- name: rush_config
+  x_any: hello
+
+commands:
+- name: status
+  x_any: hello
+
+  args:
+  - name: repo
+    x_any: hello
+
+  flags:
+  - long: --purge
+    x_any: hello
+
+- name: images
+  commands:
+  - name: ls
+    x_any: hello

spec/fixtures/script/x_arbitrary.yml

@@ -43,7 +43,7 @@ helpers do
 
   def check_arbitrary
     say "\ngub`Arbitrary`"
-    file = 'spec/fixtures/script/x-arbitrary.yml'
+    file = 'spec/fixtures/script/x_arbitrary.yml'
     schema_check file
   end