frill 0.1.9 → 0.1.10

data/VERSION

@@ -1 +1 @@
-0.1.9
+0.1.10

data/lib/frill/frill.rb

@@ -2,17 +2,17 @@ module Frill
   class CyclicDependency < RuntimeError; end
 
   def self.included(base)
-    self.list.add base
+    self.dependency_graph.add base
     base.extend ClassMethods
   end
 
   def self.decorators
-    @decorators ||= list.to_a
+    @decorators ||= dependency_graph.to_a
   end
 
   def self.reset!
     @decorators = nil
-    @list = nil
+    @dependency_graph = nil
   end
 
   def self.decorate object, context
@@ -23,21 +23,21 @@ module Frill
    object
   end
 
-  def self.list
-    @list ||= List.new
+  def self.dependency_graph
+    @dependency_graph ||= DependencyGraph.new
   end
 
   module ClassMethods
     def before decorator
-      Frill.list.move_before self, decorator
+      Frill.dependency_graph.move_before self, decorator
     end
 
     def after decorator
-      Frill.list.move_before decorator, self
+      Frill.dependency_graph.move_before decorator, self
     end
   end
 
-  class List
+  class DependencyGraph
     def initialize
       @nodes = {}
     end

data/readme.markdown

@@ -14,16 +14,67 @@ Throw this in your Gemfile:
 gem "frill"
 ```
 
-Generate a frill:
+## In a nutshell
+
+Decorate your objects for presentation. 
 
 ```sh
-$ rails g frill Timestamp --test-framework=rspec
-      create  app/frills/timestamp_frill.rb
-      invoke  rspec
-      create    spec/frills/timestamp_frill_spec.rb
+$ rails g frill FooFrill
+```
+
+Frills are just modules that decorate your objects with extra functionality. The `frill?` method on the module tells `Frill` when
+to decorate an object with a module:
+
+```ruby
+module FooFrill
+  def self.frill? object, context
+    object.respond_to?(:foo)
+  end
+
+  def foo
+    h.render partial: "shared/foo", locals: { foo: "#{super} bar" }
+  end
+end
+```
+
+Opt objects in your controllers into frill with the `frill` method:
+
+```ruby
+class FooController < ApplicationController
+  def foo
+    @foo = frill Foo.find(params[:id])
+  end
+end
+```
+
+Then just use the `foo` method on your Foo objects to get their decorated functionality:
+
+```erb
+Awesome foo page!
+
+<%=@foo.foo%>
+```
+
+Instead of manually opting objects into decoration via the `frill` method, you can have all of your controller
+instance variables automatically decorated via the `auto_frill` macro:
+
+```ruby
+class ApplicationController < ActionController::Base
+  auto_frill
+end
 ```
 
-## Refactoring timestamp helpers with decorators
+Now you don't need to use the `frill` method to decorate objects. They'll be automatically decorated before being passed off to your view.
+
+```ruby
+class FooController < ApplicationController
+  def foo
+    @foo = Foo.find params[:id]
+  end
+end
+```
+
+## A longer story
 
 Your product manager writes the following story for you: 
 
@@ -39,7 +90,7 @@ Feature: Consistent Timestamp Presentation
 ```
 
 You see this and roll your eyes. You're thinking about all of the places that you show `created_at` 
-timestamps on the site. Regardless you roll up your sleeves and start by writing the following helper and partial:
+timestamps on the site. Reluctantly, you roll up your sleeves and start by writing the following helper and partial:
 
 ```ruby
 module ApplicationHelper
@@ -64,7 +115,7 @@ You hate this approach.
 
 1. It's tedious
 1. It's procedural
-1. Developers have to remember to manually wrap timestamps with your `format_timestamp` helper. Developers suck at remembering things like that. FACEPALM
+1. Developers have to remember to manually wrap timestamps with your `format_timestamp` helper. 
 
 After you deliver the story, your product owner says "Great! But what about the format of timestamps in the JSON api? Here's another story."
 
@@ -95,7 +146,7 @@ module ApplicationHelper
 end
 ```
 
-And now you begin the tedious track of updating all of the JSON views with the helper:
+And now you begin the tedious task of updating all of the JSON views with the helper:
 
 ```ruby
 json.created_at format_timestamp(@article.created_at)
@@ -143,10 +194,11 @@ module HtmlTimestampFrill
 end
 ```
 
-There's two important things to note: 
+There's three important things to note: 
 
 1. This frill comes after `TimestampFrill`. That tells `Frill` that it should only attempt to extend an object with this module after attempting to extend it with `TimestampFrill`.
 1. The `frill?` method only returns true if it's an HTML request, meaning this frill won't be extended onto objects for your JSON api.
+1. The `h` method gives you access to all of the normal view helper methods you expect to you use inside your views. You can also use `helpers`.
 
 Lastly, opt objects into frilling inside your controllers: 
 
@@ -164,7 +216,7 @@ end
 And that's it. You don't have to update any of your views. Why? When you call the `frill` method inside your controller and pass it an object (or a collection of objects), 
 frill will attempt to extend the object with any applicable frills (i.e., frills that return `true` for the `frill?` method when passed the object and the request context).
 
-That way, you can simple render your `created_at` attributes without any helpers, and they will automatically present themselves appropriately for their context (e.g., HTML v. JSON requests).
+That way, you can simply render your `created_at` attributes without any helpers, and they will automatically present themselves appropriately for their context (e.g., HTML v. JSON requests).
 
 Note that if prefer, you can configure your controllers to automatically frill all objects for presentation by calling the `auto_frill` method inside your `ApplicationController`, instead of manually having to opt them it via the `frill` method:
 
@@ -216,9 +268,9 @@ Or, in a view:
 
 ## Usage outside Rails
 
-There are really just two integrations in a Rails app: the `frill` 
-method inside of your controller, plus the ability to call 
-helper methods inside of your module methods.
+There are really just three integrations in a Rails app: the `frill` 
+method inside of your controller, the `auto_frill` macro for controllers, 
+plus the ability to call view helper methods inside of your module methods.
 
 To kickoff the decoration of an object outside of a Rails application,
 simply call `Frill.decorate`:
@@ -231,3 +283,7 @@ Frill.decorate my_object, my_context
 
 * Ben Moss
 * Nicholas Greenfield
+
+## License
+
+MIT

data/spec/frill_spec.rb

@@ -70,7 +70,7 @@ describe Frill do
     end
 
     describe ".before" do
-      it "inserts the current module before the requested module in Frill's list of decorators" do
+      it "inserts the current module before the requested module in Frill's dependency_graph of decorators" do
         Module4.before Module3
         Module2.before Module1
         Module5.after Module4
@@ -92,20 +92,20 @@ describe Frill do
     end
 
     describe ".before" do
-      it "inserts the current module before the requested module in Frill's list of decorators" do
-        Frill.list.to_a.should == [Module1, Module2, Module3]
+      it "inserts the current module before the requested module in Frill's dependency_graph of decorators" do
+        Frill.dependency_graph.to_a.should == [Module1, Module2, Module3]
 
         Module1.before Module2
-        Frill.list.to_a.should == [Module1, Module2, Module3]
+        Frill.dependency_graph.to_a.should == [Module1, Module2, Module3]
 
         Module3.before Module2
-        Frill.list.to_a.should == [Module3, Module1, Module2]
+        Frill.dependency_graph.to_a.should == [Module3, Module1, Module2]
       end
     end
 
     describe ".after" do
-      it "inserts the current module after the requested module in Frill's list of decorators" do
-        Frill.list.to_a.should == [Module1, Module2, Module3]
+      it "inserts the current module after the requested module in Frill's dependency_graph of decorators" do
+        Frill.dependency_graph.to_a.should == [Module1, Module2, Module3]
 
         Module1.after Module2
         Module3.after Module2
@@ -116,10 +116,10 @@ describe Frill do
     end
   end
 
-  describe Frill::List do 
+  describe Frill::DependencyGraph do 
     describe "#add" do
-      it "should add an element to the list" do
-        g = Frill::List.new
+      it "should add an element to the dependency_graph" do
+        g = Frill::DependencyGraph.new
         g.add "hi"
         g["hi"].should_not be_nil
       end
@@ -127,7 +127,7 @@ describe Frill do
 
     describe "#move_before(label1, label2)" do
       it "should move label1 before label2" do
-        g = Frill::List.new
+        g = Frill::DependencyGraph.new
         g.move_before "a", "b"
         g.move_before "c", "d"
         g.move_before "c", "b"
@@ -135,7 +135,7 @@ describe Frill do
       end
 
       it "should throw exceptions when cycles are detected" do
-        g = Frill::List.new
+        g = Frill::DependencyGraph.new
         g.move_before "c", "b"
         g.move_before "b", "a"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frill
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-25 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70096022400640 !ruby/object:Gem::Requirement
+  requirement: &70295008464380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.2
   type: :development
   prerelease: false
-  version_requirements: *70096022400640
+  version_requirements: *70295008464380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70096022399720 !ruby/object:Gem::Requirement
+  requirement: &70295008463160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096022399720
+  version_requirements: *70295008463160
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70096022399120 !ruby/object:Gem::Requirement
+  requirement: &70295008458700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096022399120
+  version_requirements: *70295008458700
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70096022398500 !ruby/object:Gem::Requirement
+  requirement: &70295008457520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096022398500
+  version_requirements: *70295008457520
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70096022397820 !ruby/object:Gem::Requirement
+  requirement: &70295008456620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096022397820
+  version_requirements: *70295008456620
 description: 
 email: moonmaster9000@gmail.com
 executables: []
@@ -86,7 +86,8 @@ files:
 - LICENSE
 - spec/frill_spec.rb
 homepage: https://github.com/moonmaster9000/frill
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: