rafters 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eda33be9a4b9d6483e2ca5ab9cca57f42900f31
-  data.tar.gz: ee6926c5bb02bc6fda0884bba1a917040e072371
+  metadata.gz: 46aa108c7fdb1430b81316137e96b4597788c632
+  data.tar.gz: 40bc5436d5e593f804b3d31bedc38a425ac73a79
 SHA512:
-  metadata.gz: 37924228164a3e2507c090fd4b4d5200db0e95fd33b299bdf6b3f0f0f090636190b06c66f09dc3135c0e3b0bdc50755b2473bc6d192d87ade571f454c948ef11
-  data.tar.gz: 9a2ecc6cd6ffc2d08aa4105e365b6673b2a2b45796bc210563ead3d78e5b626b8842f64a30383e59760474b82af73983e5e2b992ff9aae59a5af6b43d0c6205c
+  metadata.gz: 750fa198c767793cfec5e397b060ae88fbab408b28b3617827e6f25cf50618fdd2d6d733dc34dcbba42c4016397099f0316ce1d7ed15c571234e100413f2e491
+  data.tar.gz: 65f55f6c3c41678d035a9e1520f848a7f9ede30a34a81390a7686e26ca870944fd37fedc59a61d90d319c6b43f983e8bb610affa04a5d17c128b11dc9ef43700

data/Gemfile

@@ -6,6 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 # jquery-rails is used by the dummy application
+gem "rails"
 gem "jquery-rails"
 gem "sqlite3"
 

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/andyhite/rafters.png?branch=master)](https://travis-ci.org/andyhite/rafters)
 [![Gem Version](https://badge.fury.io/rb/rafters.png)](http://badge.fury.io/rb/rafters)
 [![Code Climate](https://codeclimate.com/github/andyhite/rafters.png)](https://codeclimate.com/github/andyhite/rafters)
+[![Coverage Status](https://coveralls.io/repos/andyhite/rafters/badge.png)](https://coveralls.io/r/andyhite/rafters)
 
 Rafters lets you think about each page of your application as a collection of small pieces instead of monolithic, difficult to maintain
 views.
@@ -61,12 +62,12 @@ The two most important files generated above are `app/rafters/[name]/[name]_comp
 
 ### Rendering a component
 
-You can render components anywhere - in your view, in your controller, in another component, etc. - but the most common place will (obviously) be in your views. To render a component, call `render_component [symbolized, underscored name]` in one of your app views. For example:
+You can render components anywhere - in your view, in your controller, in another component, etc. - but the most common place will (obviously) be in your views. To render a component, call `render_component :component_name, as: "unique-identifier"` in one of your app views. For example:
 
 ```erb
 ...
 <div class="main">
-  <%= render_component :heading %>
+  <%= render_component :heading, as: "page-heading" %>
 </div>
 ...
 ```
@@ -147,7 +148,7 @@ Setting values are specified when rendering a component:
 ```erb
 ...
 <div class="main">
-  <%= render_component :posts, published: true %>
+  <%= render_component :posts, as: "published-posts", settings: { published: true } %>
 </div>
 ...
 ```

data/lib/rafters/component.rb

@@ -2,13 +2,17 @@ module Rafters::Component
   extend ActiveSupport::Concern
 
   attr_writer :controller
+  attr_reader :identifier
 
   included do
-    attribute :settings
+    attributes :settings, :identifier
   end
 
-  def initialize(settings = {})
-    @settings = settings
+  def initialize(options = {})
+    raise IdentifierMissing unless options.has_key?(:as)
+
+    @identifier = options.delete(:as)
+    @settings = options.delete(:settings) || {}
   end
 
   def name(without_postfix = false)
@@ -16,10 +20,6 @@ module Rafters::Component
     without_postfix ? _name.gsub(/_component/, '') : _name
   end
 
-  def identifier
-    @identifier ||= "#{name}-#{random_identifier}"
-  end
-
   def template_name
     @_template_name ||= begin
       _template_name = (self.class._template_name || self.class.name.underscore)
@@ -43,7 +43,7 @@ module Rafters::Component
   end
 
   def settings
-    @_settings ||= Hashie::Mash.new(@settings.reverse_merge(overrides).reverse_merge(defaults))
+    @_settings ||= Hashie::Mash.new(defaults.merge(@settings).merge(overrides))
   end
 
   def defaults
@@ -55,8 +55,10 @@ module Rafters::Component
   end
 
   def overrides
+    return {} if @controller.nil?
+
     @_overrides ||= Hashie::Mash.new.tap do |_overrides|
-      (controller(:params)[name(true)] || {}).each do |name, value|
+      (controller(:params)[identifier] || {}).each do |name, value|
         _overrides[name] = value
       end
     end
@@ -78,14 +80,6 @@ module Rafters::Component
 
   private
 
-  def random_seed
-    rand(DateTime.now.to_i).to_s
-  end
-
-  def random_identifier
-    Digest::MD5.hexdigest(random_seed)[0..6]
-  end
-
   module ClassMethods
     attr_accessor :_attributes, :_defaults, :_template_name
 
@@ -112,6 +106,6 @@ module Rafters::Component
     end
   end
 
-  class SettingRequired < StandardError; end
+  class IdentifierMissing < StandardError; end
   class InvalidSetting < StandardError; end
 end

data/lib/rafters/component_context.rb

@@ -8,23 +8,23 @@ module Rafters::ComponentContext
     alias_method_chain :render, :component
   end
 
-  def component_attributes(name, settings = {})
-    component = component(name, settings)
+  def component_attributes(name, options = {})
+    component = component(name, options)
     component.as_json
   end
 
-  def render_component(name, settings = {}, template_name = nil)
-    component = component(name, settings)
-    component_renderer.render(component, template_name)
+  def render_component(name, options = {})
+    component = component(name, options)
+    component_renderer.render(component)
   end
 
   def render_with_component(*args, &block)
     if params[:component]
-      component, settings = params[:component], params[:settings]
+      component, settings = params[:component], params[:options]
 
       respond_to do |format|
-        format.html { render_without_component(text: render_component(component, settings)) }
-        format.json { render_without_component(json: component_attributes(component, settings)) }
+        format.html { render_without_component(text: render_component(component, options)) }
+        format.json { render_without_component(json: component_attributes(component, options)) }
       end
     else
       render_without_component(*args, &block)
@@ -37,8 +37,8 @@ module Rafters::ComponentContext
     @_component_renderer ||= Rafters::ComponentRenderer.new(self)
   end
 
-  def component(name, settings = {})
+  def component(name, options = {})
     component_klass = "#{name}_component".classify.constantize
-    component = component_klass.new(settings)
+    component = component_klass.new(options)
   end
 end

data/lib/rafters/component_renderer.rb

@@ -7,15 +7,13 @@ class Rafters::ComponentRenderer
     end
   end
 
-  def render(component, template_name = nil)
+  def render(component)
     component.controller = @controller
 
-    template_name = (template_name || component.template_name)
-
     store(component)
 
     @controller.view_context.content_tag(:div, class: "component", id: component.identifier) do
-      @controller.view_context.render(file: "/#{template_name}", locals: component.attributes)
+      @controller.view_context.render(file: "/#{component.template_name}", locals: component.attributes)
     end
   end
 

data/lib/rafters/version.rb

@@ -1,3 +1,3 @@
 module Rafters
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/rafters.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-rails", "~> 2.14"
   spec.add_development_dependency "capybara", "~> 2.1"
   spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'coveralls', "~> 0.6.7"
 
   spec.add_dependency "rails", "> 3.2"
   spec.add_dependency "sprockets", "> 2.2"

data/spec/dummy/app/components/post/views/post_component.html.erb

@@ -1,5 +1,5 @@
 <h2><%= link_to_if settings.link_to_post?, post.title, post_path(post.id) %></h2>
 
-<%= render_component :author, id: post.author.id %>
+<%= render_component :author, as: "author-#{post.author.id}", settings: { id: post.author.id } %>
 
 <%= simple_format post.body %>

data/spec/dummy/app/components/posts/views/posts_component.html.erb

@@ -1,5 +1,5 @@
 <div class="posts">
   <% posts.each do |post| %>
-    <%= render_component :post, post: post, link_to_post: true %>
+    <%= render_component :post, as: "post-#{post.id}", settings: { post: post, link_to_post: true } %>
   <% end %>
 </div>

data/spec/dummy/app/views/posts/index.html.erb

@@ -1,10 +1,10 @@
 <div class="main">
   <div class="content">
-    <%= render_component :heading, title: "Posts" %>
-    <%= render_component :posts %>
+    <%= render_component :heading, as: "heading", settings: { title: "Posts" } %>
+    <%= render_component :posts, as: "posts" %>
   </div>
 
   <div class="sidebar">
-    <%= render_component :links %>
+    <%= render_component :links, as: "links" %>
   </div>
 </div>

data/spec/rafters/component_context_spec.rb

@@ -18,21 +18,14 @@ describe Rafters::ComponentContext do
 
   describe "#render_component" do
     it "renders the provided component" do
-      renderer.should_receive(:render).with(instance_of(FooComponent), nil)
-      controller.render_component(:foo)
+      renderer.should_receive(:render).with(instance_of(FooComponent))
+      controller.render_component(:foo, as: "foo")
     end
 
     context "with settings" do
       it "renders the provided component with the given settings" do
-        FooComponent.should_receive(:new).with({ test: true })
-        controller.render_component(:foo, test: true)
-      end
-    end
-
-    context "with a specified template name" do
-      it "renders the provided component using the given template name" do
-        renderer.should_receive(:render).with(instance_of(FooComponent), "template_name")
-        controller.render_component(:foo, {}, "template_name")
+        FooComponent.should_receive(:new).with({ as: "foo", settings: { test: true } })
+        controller.render_component(:foo, { as: "foo", settings: { test: true } })
       end
     end
   end

data/spec/rafters/component_renderer_spec.rb

@@ -35,12 +35,5 @@ describe Rafters::ComponentRenderer do
       view_context.should_receive(:render).with(file: "/template", locals: { title: "Foo" })
       subject.render(component)
     end
-
-    context "with a specified template name" do
-      it "renders the component with the specified template" do
-        view_context.should_receive(:render).with(file: "/custom_template", locals: { title: "Foo" })
-        subject.render(component, "custom_template")
-      end
-    end
   end
 end

data/spec/rafters/component_spec.rb

@@ -17,7 +17,7 @@ describe Rafters::Component do
       HeadingComponent.send(:define_method, :title, -> { "Lorem Ipsum" })
       HeadingComponent.attribute(:title)
 
-      heading = HeadingComponent.new
+      heading = HeadingComponent.new(as: "heading")
       heading.attributes.should have_key(:title)
     end
   end
@@ -28,7 +28,7 @@ describe Rafters::Component do
       HeadingComponent.send(:define_method, :subtitle, -> { "Dolor Sit Amet" })
       HeadingComponent.attributes(:title, :subtitle)
 
-      heading = HeadingComponent.new
+      heading = HeadingComponent.new(as: "heading")
       heading.attributes.keys.map(&:to_sym).should include(:title)
       heading.attributes.keys.map(&:to_sym).should include(:subtitle)
     end
@@ -38,7 +38,7 @@ describe Rafters::Component do
     it "adds default values to the component settings" do
       HeadingComponent.defaults(foo: "bar")
 
-      heading = HeadingComponent.new
+      heading = HeadingComponent.new(as: "heading")
       heading.settings.foo.should == "bar"
     end
   end
@@ -49,15 +49,15 @@ describe Rafters::Component do
       HeadingComponent.attribute(:title)
     end
 
-    subject { HeadingComponent.new }
+    subject { HeadingComponent.new(as: "heading") }
 
     it "returns the registered attributes and their values" do
-      subject.attributes.should == Hashie::Mash.new({ title: "Lorem Ipsum", settings: {} })
+      subject.attributes.should == Hashie::Mash.new({ title: "Lorem Ipsum", identifier: "heading", settings: {} })
     end
   end
 
   describe "#settings" do
-    subject { HeadingComponent.new({ type: "h2" }) }
+    subject { HeadingComponent.new(as: "heading", settings: { type: "h2" }) }
 
     it "returns the provided settings" do
       subject.settings.should == Hashie::Mash.new({ type: "h2" })
@@ -70,7 +70,7 @@ describe Rafters::Component do
   end
 
   describe "#template_name" do
-    subject { HeadingComponent.new }
+    subject { HeadingComponent.new(as: "heading") }
 
     context "with no specified template name" do
       it "returns the inferred template name" do
@@ -103,7 +103,7 @@ describe Rafters::Component do
   end
 
   describe "#controller" do
-    subject { HeadingComponent.new }
+    subject { HeadingComponent.new(as: "heading") }
 
     let(:controller) { Object.new }
 
@@ -132,8 +132,8 @@ describe Rafters::Component do
     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.controller(:doesnt_exist) }.should raise_error(Rafters::Component::ControllerMethodOrVariableMissing)
+      it "returns nil" do
+        subject.controller(:doesnt_exist).should == nil
       end
     end
   end
@@ -141,7 +141,7 @@ describe Rafters::Component do
   after do
     # A little housekeeping after each spec runs, so that
     # we have fresh values for each class attribute
-    HeadingComponent._attributes = [:settings]
+    HeadingComponent._attributes = [:settings, :identifier]
     HeadingComponent._defaults = {}
     HeadingComponent._template_name = nil
   end

data/spec/spec_helper.rb

@@ -1,3 +1,11 @@
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec/dummy'
+end
+
 ENV["RAILS_ENV"] ||= 'test'
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require 'rspec/rails'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rafters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Hite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement