update documentation, refactor first components

Author: Nils Henning

.byebug_history

@@ -1,4 +1,23 @@
 continue
+save_screenshot
+continue
+path
+::Rails.application.routes.url_helpers.send(property_path, params)
+property_path.is_a? Symbol
+property_path
+continue
+save_screenshot
+continue
+save_screenshot
+continue
+page.html
+continue
+save_screenshot
+page.html
+continue
+save_screenshot
+page.html
+continue
 page.html
 continue
 save_screenshot

app/concepts/matestack/ui/core/abbr/abbr.haml

@@ -1,5 +1,5 @@
 %abbr{@tag_attributes}
-  - if options[:text].blank? && block_given?
+  - if text.blank? && block_given?
     = yield
   - else
-    = options[:text]
+    = text

app/concepts/matestack/ui/core/abbr/abbr.rb

@@ -1,10 +1,11 @@
 module Matestack::Ui::Core::Abbr
   class Abbr < Matestack::Ui::Core::Component::Static
     requires :title
+    optional :text
 
     def setup
       @tag_attributes.merge!({
-        "title": options[:title]
+        "title": title
       })
     end
 

app/concepts/matestack/ui/core/action/action.rb

@@ -1,45 +1,47 @@
 module Matestack::Ui::Core::Action
   class Action < Matestack::Ui::Core::Component::Dynamic
+    optional :path, :success, :failure, :notify, :confirm, 
+      method: { as: :action_method }, params: { as: :action_params }
 
     def vuejs_component_name
       'matestack-ui-core-action'
     end
 
     def setup
       @component_config[:action_path] = action_path
-      @component_config[:method] = options[:method]
-      @component_config[:success] = options[:success]
-      unless options[:success].nil?
-        unless options[:success][:transition].nil?
-          @component_config[:success][:transition][:path] = transition_path options[:success]
+      @component_config[:method] = action_method
+      @component_config[:success] = success
+      unless success.nil?
+        unless success[:transition].nil?
+          @component_config[:success][:transition][:path] = transition_path success
         end
-        unless options[:success][:redirect].nil?
-          @component_config[:success][:redirect][:path] = redirect_path options[:success]
+        unless success[:redirect].nil?
+          @component_config[:success][:redirect][:path] = redirect_path success
         end
       end
-      @component_config[:failure] = options[:failure]
-      unless options[:failure].nil?
-        unless options[:failure][:transition].nil?
-          @component_config[:failure][:transition][:path] = transition_path options[:failure]
+      @component_config[:failure] = failure
+      unless failure.nil?
+        unless failure[:transition].nil?
+          @component_config[:failure][:transition][:path] = transition_path failure
         end
-        unless options[:failure][:redirect].nil?
-          @component_config[:failure][:redirect][:path] = redirect_path options[:failure]
+        unless failure[:redirect].nil?
+          @component_config[:failure][:redirect][:path] = redirect_path failure
         end
       end
-      if options[:notify].nil?
+      if notify.nil?
         @component_config[:notify] = true
       end
-      if @component_config[:confirm] = options[:confirm]
-        @component_config[:confirm_text] = options[:confirm].try(:[], :text) || "Are you sure?"
+      if @component_config[:confirm] = confirm
+        @component_config[:confirm_text] = confirm.try(:[], :text) || "Are you sure?"
       end
     end
 
     def action_path
       begin
-        if options[:path].is_a?(Symbol)
-          return ::Rails.application.routes.url_helpers.send(options[:path], options[:params])
+        if path.is_a?(Symbol)
+          return ::Rails.application.routes.url_helpers.send(path, action_params)
         else
-          return options[:path]
+          return path
         end
       rescue
         raise "Action path not found"

app/concepts/matestack/ui/core/address/address.haml

@@ -1,5 +1,5 @@
 %address{@tag_attributes}
-  - if options[:text].nil? && block_given?
+  - if text.nil? && block_given?
     = yield
   - else
-    = options[:text]
+    = text

app/concepts/matestack/ui/core/address/address.rb

@@ -1,5 +1,5 @@
 module Matestack::Ui::Core::Address
   class Address < Matestack::Ui::Core::Component::Static
-
+    optional :text
   end
 end

app/concepts/matestack/ui/core/area/area.rb

@@ -1,17 +1,19 @@
 module Matestack::Ui::Core::Area
   class Area < Matestack::Ui::Core::Component::Static
+    optional :alt, :coords, :download, :href, :hreflang, :media, :rel, :shape, :target, :type
+    
     def setup
       @tag_attributes.merge!({
-        alt: options[:alt],
-        coords: options[:coords].join(','),
-        download: options[:download],
-        href: options[:href],
-        hreflang: options[:hreflang],
-        media: options[:media],
-        rel: options[:rel],
-        shape: options[:shape],
-        target: options[:target],
-        type: options[:type]
+        alt: alt,
+        coords: coords.join(','),
+        download: download,
+        href: href,
+        hreflang: hreflang,
+        media: media,
+        rel: rel,
+        shape: shape,
+        target: target,
+        type: type
       })
     end
   end

app/lib/matestack/ui/core/properties.rb

@@ -17,9 +17,10 @@ def self.included(base)
   # initializer calls super and creates instance methods for defined required and optional properties afterwards
   module Initializer
     def initialize(model=nil, options={})
+      options = model.dup if options.empty? && model.is_a?(Hash)
+      required_hooks(options)
+      optional_hooks(options)
       super
-      required_hooks
-      optional_hooks
     end
   end
 
@@ -55,7 +56,7 @@ def requires_properties
     end
   end
 
-  def optional_hooks
+  def optional_hooks(options)
     self.class.optional_properties.compact.each do |prop|
       if prop.is_a? Array
         hash = prop.flatten
@@ -69,14 +70,14 @@ def optional_hooks
     end
   end
 
-  def required_hooks
+  def required_hooks(options)
     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 PropertyMissingException, "Required property #{prop} is missing for #{self.class}" if 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
         options[prop]

docs/concepts/component.md

@@ -167,7 +167,13 @@ class SomeComponent < Matestack::Ui::StaticComponent
 end
 ```
 
-#### Options validation
+Some common names that could not be used as properties:
+```ruby
+:method,
+:params
+```
+
+#### Property validations
 
 Coming soon, stay tuned!
 

spec/0.8/components/base/properties_spec.rb

@@ -160,6 +160,36 @@ def response
     expect(another_component.test).to eq('Response')
   end
 
+  it 'should be accesible in setup' do
+    class SetupComponent < Matestack::Ui::StaticComponent
+      requires :title, :desc
+      def setup
+        @foo = title
+      end
+      def prepare
+        @bar = desc
+      end
+      def response
+        paragraph text: @foo
+        paragraph text: @bar
+      end
+      register_self_as :setup_component
+    end
+    class ExamplePage < Matestack::Ui::Page
+      def response
+        setup_component title: 'Foo', desc: 'Bar'
+      end
+    end
+
+    visit '/example'
+    static_output = page.html
+    expected_static_output = <<~HTML
+      <p>Foo</p>
+      <p>Bar</p>
+    HTML
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+
   it 'should work with slots' do
     class SlotComponent < Matestack::Ui::StaticComponent
       requires slot: { as: :some_slot }