replace REQUIRED_KEYS in components with new requires command

Nils Henning · Nils Henning · commit 00462f51457a · 2020-07-13T14:28:46.000+02:00
diff --git a/.byebug_history b/.byebug_history
@@ -1,4 +1,41 @@
 continue
+save_screenshot
+continue
+save_screenshot
+continue
+save_screenshot
+continue
+prop.flatten
+prop
+continue
+prop
+continue
+prop.flatten
+prop.flatten!
+prop.flatten
+prop.keys.first
+prop.keys
+prop
+prop.flatten
+prop
+prop.key
+prop.values.first[:alias]
+prop.values.first[:alias
+prop.values.first
+prop.values
+prop.first
+prop[:alias]
+prop.is_a? Hash
+self.class.requires_properties
+continue
+self.class.requires_properties
+continue
+Matestack::Ui::Core::Form::Form.instance_methods.include? :method
+Matestack::Ui::Core::Form::Form.instance_methods.contains? :method
+Matestack::Ui::Core::Form::Form.instance_methods
+Matestack::Ui::Core::Form::Form
+save_screenshot
+continue
 PropertyComponent.new(title: 'Test', foo: 'Foo').respond_to?(:title)
 PropertyComponent.new.respond_to?(:title)
 PropertyComponent.new.respond_to?(:title))
diff --git a/app/concepts/matestack/ui/core/bdo/bdo.rb b/app/concepts/matestack/ui/core/bdo/bdo.rb
@@ -1,6 +1,6 @@
 module Matestack::Ui::Core::Bdo
   class Bdo < Matestack::Ui::Core::Component::Static
-    REQUIRED_KEYS = [:dir]
+    requires :dir
 
     def setup
       @tag_attributes.merge!({
diff --git a/app/concepts/matestack/ui/core/form/form.rb b/app/concepts/matestack/ui/core/form/form.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Form
   class Form < Matestack::Ui::Core::Component::Dynamic
 
-    REQUIRED_KEYS = [:for, :path, :method]
+    requires :for, :path, method: { as: :form_method }
 
     def vuejs_component_name
       "matestack-ui-core-form"
diff --git a/app/concepts/matestack/ui/core/form/input/input.rb b/app/concepts/matestack/ui/core/form/input/input.rb
@@ -1,24 +1,16 @@
 module Matestack::Ui::Core::Form::Input
   class Input < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:key, :type]
+    requires :key, :type
 
     def custom_options_validation
       raise "included form config is missing, please add ':include' to parent form component" if @included_config.nil?
     end
 
-    def key
-      options[:key]
-    end
-
     def label
       options[:label]
     end
 
-    def type
-      options[:type]
-    end
-
     def placeholder
       options[:placeholder]
     end
diff --git a/app/concepts/matestack/ui/core/form/select/select.rb b/app/concepts/matestack/ui/core/form/select/select.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Form::Select
   class Select < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:options]
+    requires options: { as: :select_options }
 
     def setup
       if @tag_attributes[:id].nil?
diff --git a/app/concepts/matestack/ui/core/link/link.rb b/app/concepts/matestack/ui/core/link/link.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Link
   class Link < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:path]
+    requires :path
 
     def setup
       @tag_attributes.merge!({
diff --git a/app/concepts/matestack/ui/core/map/map.rb b/app/concepts/matestack/ui/core/map/map.rb
@@ -1,6 +1,6 @@
 module Matestack::Ui::Core::Map
   class Map < Matestack::Ui::Core::Component::Static
-    REQUIRED_KEYS = [:name]
+    requires :name
 
     def setup
       @tag_attributes.merge!({
diff --git a/app/concepts/matestack/ui/core/progress/progress.rb b/app/concepts/matestack/ui/core/progress/progress.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Progress
   class Progress < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:max]
+    requires :max
 
     def setup
       @tag_attributes.merge!({
diff --git a/app/concepts/matestack/ui/core/video/video.rb b/app/concepts/matestack/ui/core/video/video.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Video
   class Video < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:path, :type]
+    requires :path, :type
 
     def setup
       @tag_attributes.merge!({
diff --git a/app/concepts/matestack/ui/core/youtube/youtube.rb b/app/concepts/matestack/ui/core/youtube/youtube.rb
@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::Youtube
   class Youtube < Matestack::Ui::Core::Component::Static
 
-    REQUIRED_KEYS = [:yt_id, :height, :width]
+    requires :yt_id, :height, :width
 
     def setup
       url = 'https://www.youtube.com/embed/'
diff --git a/app/lib/matestack/ui/core/properties.rb b/app/lib/matestack/ui/core/properties.rb
@@ -31,7 +31,13 @@ def optional(*properties)
   
     # define required properties for custom components with `requires :title, :foo, :bar`
     def requires(*properties)
-      properties.each { |property| requires_properties.push(property) }
+      properties.each do |property| 
+        if property.is_a? Hash 
+          property.each { |tmp_property| requires_properties.push(tmp_property) }
+        else
+          requires_properties.push(property) 
+        end
+      end
     end
   
     # array of properties created from the component
@@ -56,6 +62,11 @@ def optional_hooks
 
   def required_hooks
     self.class.requires_properties.compact.each do |prop|
+      if prop.is_a? Array
+        hash = prop.flatten
+        options[hash.last[:as]] = options[hash.first]
+        prop = hash.last[:as]
+      end
       raise PropertyMissingException, "Required property #{prop} is missing for #{self.class}" if self.send(:options)[prop].nil?
       raise PropertyOverwritingExistingMethodException, "Required property #{prop} would overwrite already defined instance method for #{self.class}" if self.respond_to? prop
       send(:define_singleton_method, prop) do
diff --git a/docs/concepts/component.md b/docs/concepts/component.md
@@ -95,7 +95,7 @@ This feature is pretty straightforward - just declare the options as a required
 ```ruby
 class Components::SpecialComponent < Matestack::Ui::StaticComponent
 
-  REQUIRED_KEYS = [:some_option]
+  requires :some_option
 
   def response
     components {
diff --git a/spec/0.8/base/core/component/options_spec.rb b/spec/0.8/base/core/component/options_spec.rb
@@ -60,7 +60,7 @@ def response
 
       class SpecialComponent < Matestack::Ui::StaticComponent
 
-        REQUIRED_KEYS = [:some_option]
+        requires :some_option
 
         def response
           div id: "my-component" do
diff --git a/spec/0.8/components/base/properties_spec.rb b/spec/0.8/components/base/properties_spec.rb
@@ -116,4 +116,26 @@ def response
     expect(page).to have_content('Optional property response would overwrite already defined instance method for TempOptionalPropertyComponent')
   end
 
+  it 'should create instance method with given alias name' do
+    class AliasPropertyComponent < Matestack::Ui::StaticComponent
+      requires method: { as: :my_method }, response: { as: :test }
+      def response
+      end
+    end
+    class AnotherAliasPropertyComponent < Matestack::Ui::StaticComponent
+      requires :bla, method: { as: :my_method }, response: { as: :test }
+      def response
+      end
+    end
+    component = AliasPropertyComponent.new(method: 'Its my method', response: 'Response')
+    another_component = AnotherAliasPropertyComponent.new(bla: 'hi', method: 'Its my method', response: 'Response')
+    expect(component.respond_to? :my_method).to be(true)
+    expect(component.my_method).to eq('Its my method')
+    expect(component.respond_to? :test).to be(true)
+    expect(component.test).to eq('Response')
+    expect(another_component.bla).to eq('hi')
+    expect(another_component.my_method).to eq('Its my method')
+    expect(another_component.test).to eq('Response')
+  end
+
 end
diff --git a/spec/0.8/components/bdo_spec.rb b/spec/0.8/components/bdo_spec.rb
@@ -32,11 +32,11 @@ def response
   it 'Fails if required dir tag is not set' do
     class ExamplePage < Matestack::Ui::Page
       def response
-          bdo text: 'Simple bdo ltr tag'
+        bdo text: 'Simple bdo ltr tag'
       end
     end
 
     visit '/example'
-    expect(page).to have_content("required key 'dir' is missing")
+    expect(page).to have_content("Matestack::Ui::Core::Properties::PropertyMissingException")
   end
 end
diff --git a/spec/0.8/components/dynamic/form/form_spec.rb b/spec/0.8/components/dynamic/form/form_spec.rb
@@ -942,7 +942,6 @@ def response
               custom_some_component
             end
           end
-
         end
 
         visit "/example"
diff --git a/spec/0.8/components/progress_spec.rb b/spec/0.8/components/progress_spec.rb
@@ -25,7 +25,7 @@ def response
     expect(stripped(static_output)).to include(stripped(expected_static_output))
   end
 
-  it 'Example 2: Test REQUIRED_KEYS' do
+  it 'Example 2: Test requires' do
     class ExamplePage < Matestack::Ui::Page
       def response
         # miss max option
@@ -34,7 +34,7 @@ def response
     end
 
     visit '/example'
-    expect(page).to have_content("Matestack::Ui::Core::Progress::Progress: required key 'max' is missing")
+    expect(page).to have_content("Matestack::Ui::Core::Properties::PropertyMissingException")
   end
 
 end
