rafters 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7900cb89ffd2a9e271783e382d76ce8aef995a1
-  data.tar.gz: f79f54a8d9ca67f5ccc3c02be7c5b7631446f034
+  metadata.gz: 1ac7e06cae8eb40c60138562dca5806c7e7c91a9
+  data.tar.gz: 27e6adca0f5e3859ab26c2ec2a6dcb84c0be4a20
 SHA512:
-  metadata.gz: fb63afff21e37662bac1b7d76a685b4968a49670bfabd4e1b448303344a2879d0b7747612950d69e6abdb28603b338daaa9e9136966aa78ed46bca44e2d82e83
-  data.tar.gz: cd553bf4f1a515bfd594dea3f465ae1986b6ac0f7e5b666f387168528019d5fb5460544d0efb37f9cedbe214390b1d3382ebabffccc0d71d9b68a83ec6e83d0b
+  metadata.gz: e5f25e71ba70d5b4953a70ec870701b1a82a1d84394fc5f3ebdaa394c6d9291a6deb869d3436f038f4103025f91501c999a14d4a114cade086da3eeaf921b959
+  data.tar.gz: 01891c2592c824bc5da723fa63f9b7b8bbe659d8909975328e10d56376ca4b9d1ce45b7a7d772379564aa205d70565a2a84034eae2c2990ff6851c1ff170d85a

data/README.md

@@ -74,7 +74,7 @@ You can render components anywhere - in your view, in your controller, in anothe
 
 ### Adding an attribute to a component
 
-Each component exposes `attributes` to it's view as locals. The `attributes` are simply a collection of methods that you explicitly declare as `attributes` in your component, using the `Rafters::Component.attribute` method.
+Each component exposes `attributes` to it's view as locals. The `attributes` are simply a collection of methods that you explicitly declare as `attributes` in your component, using the Rafters::Component.attribute` or `Rafters::Component.attributes` methods.
 
 For instance, let's say we have a HeadingComponent that exposes a title attribute:
 
@@ -104,7 +104,7 @@ You can access the method in your component view using the name of the attribute
 
 ### Accessing information from the controller in your components
 
-There will often be times when you need to access data in your component that is only available as an instance variable or method in your controller. Rafters provides a convenience method that lets you get to that data in a uniform way - `Rafters::Component#current`:
+There will often be times when you need to access data in your component that is only available as an instance variable or method in your controller. Rafters provides a convenience method that lets you get to that data in a uniform way - `Rafters::Component#controller`:
 
 ```ruby
 class PostController
@@ -128,7 +128,7 @@ class RelatedPostsComponent
   ...
   
   def related_posts
-    @related_posts ||= current(:post).related_posts.where(author_id: current(:current_user))
+    @related_posts ||= controller(:post).related_posts.where(author_id: controller(:current_user))
   end
 end
 ```
@@ -136,23 +136,13 @@ end
 You can also access the controller's params using this method:
 
 ```ruby
-current(:params)[:id]
+controller(:params)[:id]
 ```
   
-### Adding a setting to a component
+### Specifying settings for a component instance
 
-In order to build components in a way that allows for re-use, you'll want to define settings that allow individual instances of the component to be configured. These settings will likely be used throughout your component view and controller for any number of purposes, like values in query conditions, section titles, turning on or off specific features of a component, etc.
+In order to build components in a way that allows for re-use, you'll want to use settings that allow individual instances of the component to be configured. These settings will likely be used throughout your component view and controller for any number of purposes, like values in query conditions, section titles, turning on or off specific features of a component, etc.
 
-Adding a setting is very similar to adding an attribute, except they don't point at methods:
-
-```ruby
-class PostsComponent
-  include Rafters::Component
-
-  setting :published
-end
-```
-  
 Setting values are specified when rendering a component:
 
 ```erb
@@ -187,22 +177,11 @@ class PostsComponent
 end
 ```
   
-Default values can be provided for settings using the `default` option:
+Default values can be provided for settings using `Rafters::Component.defaults` and `Rafters::Component.default`:
     
 ```ruby
-setting :type, default: "comment"
-```
-  
-Required settings can be specified using the `required` option:
-
-```ruby
-setting :user_id, required: true
-```
-
-If you want to restrict the possible values of a setting to a known list, use the `accepts` option:
-
-```ruby
-setting :type, accepts: %w(post reply comment)
+defaults type: "comment", filter: "none"
+default :published, false
 ```
 
 ## Contributing

data/lib/rafters/component.rb

@@ -30,49 +30,23 @@ module Rafters::Component
   end
 
   def settings
-    return {} if self.class._settings.nil?
-
-    @_settings ||= Hashie::Mash.new.tap do |_settings|
-      self.class._settings.each do |name, options|
-        _settings[name] = value_for_setting(name, options)
-      end
-    end
+    @_settings ||= Hashie::Mash.new(@settings.reverse_merge(self.class._defaults || {}))
   end
 
-  def current(variable_or_method_name)
+  def controller(variable_or_method_name)
     if @controller.instance_variable_defined?("@#{variable_or_method_name}")
       @controller.instance_variable_get("@#{variable_or_method_name}")
     elsif @controller.respond_to?(variable_or_method_name, true)
       @controller.send(variable_or_method_name)
     else
-      raise CurrentMissing, "#{variable_or_method_name.to_s} not found in #{@controller.class.name}"
+      raise ControllerMethodOrVariableMissing, "#{variable_or_method_name.to_s} not found in #{@controller.class.name}"
     end
   end
 
   private
 
-  def value_for_setting(name, options)
-    value = @settings.has_key?(name) ? @settings[name] : options[:default]
-    validate_setting(name, value, options) && value
-  end
-
-  def validate_setting(name, value, options)
-    validate_setting_required(name, value, options[:required])
-    validate_setting_accepts(name, value, options[:accepts])
-  end
-
-  def validate_setting_required(name, value, required)
-    return true unless !!required
-    raise SettingRequired, "#{name} is required but not provided" if value.nil?
-  end
-
-  def validate_setting_accepts(name, value, accepts)
-    return true unless !!accepts
-    raise InvalidSetting, "#{value} is not a valid value for #{name}. Accepts: #{accepts.join(', ')}" unless accepts.include?(value)
-  end
-
   module ClassMethods
-    attr_accessor :_attributes, :_settings, :_template_name
+    attr_accessor :_attributes, :_defaults, :_template_name
 
     def attribute(name)
       self._attributes ||= []
@@ -83,9 +57,13 @@ module Rafters::Component
       names.each { |name| attribute(name) }
     end
 
-    def setting(name, options = {})
-      self._settings ||= {}
-      self._settings[name.to_sym] = options
+    def default(name, value)
+      self._defaults ||= {}
+      self._defaults[name] = value
+    end
+
+    def defaults(settings = {})
+      settings.each { |name, value| default(name, value) }
     end
 
     def template_name(name)
@@ -93,7 +71,7 @@ module Rafters::Component
     end
   end
 
-  class CurrentMissing < StandardError; end
+  class ControllerMethodOrVariableMissing < StandardError; end
   class SettingRequired < StandardError; end
   class InvalidSetting < StandardError; end
 end

data/lib/rafters/component_context.rb

@@ -3,6 +3,7 @@ module Rafters::ComponentContext
 
   included do
     helper_method :render_component
+    alias_method_chain :render, :component
   end
 
   def render_component(name, settings = {}, template_name = nil)
@@ -11,6 +12,30 @@ module Rafters::ComponentContext
     component_renderer.render(component, template_name)
   end
 
+  def render_component_attributes(name, settings = {})
+    component_klass = "#{name}_component".classify.constantize
+    component = component_klass.new(settings)
+    { :"#{name}" => component.attributes }.as_json
+  end
+
+  def render_with_component(*args, &block)
+    if params[:component]
+      component, settings = params[:component], params[:settings]
+
+      respond_to do |format|
+        format.html do
+          render_without_component(text: render_component(component, settings)) and return
+        end
+
+        format.json do
+          render_without_component(json: render_component_attributes(component, settings)) and return
+        end
+      end
+    else
+      render_without_component(*args, &block)
+    end
+  end
+
   private
 
   def component_renderer

data/lib/rafters/version.rb

@@ -1,3 +1,3 @@
 module Rafters
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/dummy/app/components/author/author_component.rb

@@ -1,9 +1,6 @@
 class AuthorComponent
   include Rafters::Component
 
-  # Settings
-  setting :id, required: true
-
   # Attributes
   attribute :author
 

data/spec/dummy/app/components/heading/heading_component.rb

@@ -1,6 +1,5 @@
 class HeadingComponent
   include Rafters::Component
 
-  # Settings
-  setting :title, required: true
+  defaults title: "No Title Specified"
 end

data/spec/dummy/app/components/post/post_component.rb

@@ -1,16 +1,11 @@
 class PostComponent
   include Rafters::Component
 
-  # Settings
-  setting :post
-  setting :link_to_post, accepts: [true, false], default: false
-
-  # Attributes
   attribute :post
 
   private
 
   def post
-    @post ||= (settings.post || current(:post))
+    @post ||= (settings.post || controller(:post))
   end
 end

data/spec/dummy/app/components/posts/posts_component.rb

@@ -6,6 +6,6 @@ class PostsComponent
   private
 
   def posts
-    @posts ||= current(:posts)
+    @posts ||= controller(:posts)
   end
 end

data/spec/rafters/component_context_spec.rb

@@ -6,8 +6,6 @@ end
 
 class FooComponent
   include Rafters::Component
-
-  setting :test
 end
 
 describe Rafters::ComponentContext do

data/spec/rafters/component_spec.rb

@@ -22,30 +22,24 @@ describe Rafters::Component do
     end
   end
 
-  describe ".setting" do
-    it "adds the provided key to the component's settings" do
-      HeadingComponent.setting(:type)
+  describe ".attributes" do
+    it "adds a list of methods to the components attributes" do
+      HeadingComponent.send(:define_method, :title, -> { "Lorem Ipsum" })
+      HeadingComponent.send(:define_method, :subtitle, -> { "Dolor Sit Amet" })
+      HeadingComponent.attributes(:title, :subtitle)
 
       heading = HeadingComponent.new
-      heading.settings.should respond_to(:type)
-    end
-
-    context "with a :default value" do
-      it "sets the setting's value to the provided value when no value is available" do
-        HeadingComponent.setting(:type, default: "h1")
-
-        heading = HeadingComponent.new
-        heading.settings.type.should == "h1"
-      end
+      heading.attributes.keys.map(&:to_sym).should include(:title)
+      heading.attributes.keys.map(&:to_sym).should include(:subtitle)
     end
+  end
 
-    context "with the :required option" do
-      it "raises an error when accessing the settings if the value is nil" do
-        HeadingComponent.setting(:type, required: true)
+  describe ".defaults" do
+    it "adds default values to the component settings" do
+      HeadingComponent.defaults(foo: "bar")
 
-        heading = HeadingComponent.new
-        -> { heading.settings }.should raise_error(Rafters::Component::SettingRequired)
-      end
+      heading = HeadingComponent.new
+      heading.settings.foo.should == "bar"
     end
   end
 
@@ -63,15 +57,16 @@ describe Rafters::Component do
   end
 
   describe "#settings" do
-    before do
-      HeadingComponent.setting(:type)
-    end
-
     subject { HeadingComponent.new({ type: "h2" }) }
 
-    it "returns the registered settings and their values" do
+    it "returns the provided settings" do
       subject.settings.should == Hashie::Mash.new({ type: "h2" })
     end
+
+    it "gives provided settings precedence over default settings" do
+      HeadingComponent.default(:type, "h1")
+      subject.settings[:type].should == "h2"
+    end
   end
 
   describe "#template_name" do
@@ -107,7 +102,7 @@ describe Rafters::Component do
     end
   end
 
-  describe "#current" do
+  describe "#controller" do
     subject { HeadingComponent.new }
 
     let(:controller) { Object.new }
@@ -122,7 +117,7 @@ describe Rafters::Component do
       end
 
       it "returns the value of the instance variable" do
-        subject.current(:foo_bar).should == "lorem ipsum"
+        subject.controller(:foo_bar).should == "lorem ipsum"
       end
     end
 
@@ -132,13 +127,13 @@ describe Rafters::Component do
       end
 
       it "returns the value of the method" do
-        subject.current(:lorem_ipsum).should == "foo bar"
+        subject.controller(:lorem_ipsum).should == "foo bar"
       end
     end
 
     context "when there is neither a method nor an instance variable with the given name in the controller" do
       it "raises an error" do
-        -> { subject.current(:doesnt_exist) }.should raise_error(Rafters::Component::CurrentMissing)
+        -> { subject.controller(:doesnt_exist) }.should raise_error(Rafters::Component::ControllerMethodOrVariableMissing)
       end
     end
   end
@@ -147,7 +142,7 @@ describe Rafters::Component do
     # A little housekeeping after each spec runs, so that
     # we have fresh values for each class attribute
     HeadingComponent._attributes = [:settings]
-    HeadingComponent._settings = nil
+    HeadingComponent._defaults = {}
     HeadingComponent._template_name = nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rafters
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrew Hite