frill 0.1.10 → 0.1.11

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.1.11

data/app/frills/view_context_frill.rb

@@ -1,10 +1,10 @@
 module ViewContextFrill
   include Frill
 
-  def self.frill? object, controller
+  def self.frill? object, context
     object.class_eval do
       define_method :helpers do
-        @frill_helper ||= controller.view_context
+        @frill_helper ||= context.respond_to?(:view_context) ? context.view_context : context
       end
 
       define_method :h do

data/lib/frill.rb

@@ -1,2 +1,3 @@
 require 'frill/frill'
 require 'frill/engine' if defined? Rails
+require 'frill/rspec' if defined?(RSpec) and RSpec.respond_to?(:configure)

data/lib/frill/frill.rb

@@ -1,7 +1,7 @@
 module Frill
   class CyclicDependency < RuntimeError; end
 
-  def self.included(base)
+  def self.included base
     self.dependency_graph.add base
     base.extend ClassMethods
   end
@@ -101,7 +101,7 @@ module Frill
         new(nodes).detect!
       end
 
-      def initialize(nodes)
+      def initialize nodes
         @nodes = nodes
         @visited = {}
       end
@@ -112,19 +112,17 @@ module Frill
         end
       end
 
-
       private
-
       attr_reader :nodes, :visited
 
-      def fan_out(node)
+      def fan_out node
         visited[node.label] = true
 
         fan :next, node
         fan :previous, node
       end
 
-      def fan(direction, start_node)
+      def fan direction, start_node
         current_node = start_node.send direction
 
         while current_node

data/lib/frill/rspec.rb

@@ -0,0 +1,32 @@
+module Frill
+  module RSpec
+    module Helpers
+      def frill model
+        view_context = ApplicationController.new.view_context.tap do |context|
+          context.controller.request ||= ActionController::TestRequest.new
+          context.request            ||= context.controller.request
+          context.params             ||= {}
+        end
+
+        Frill.decorate model, view_context
+      end
+    end
+  end
+end
+
+module Frill
+  module RSpec
+    module ExampleGroup
+      def self.included(base)
+        base.metadata[:type] = :frill
+        base.send :include, Frill::RSpec::Helpers
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Frill::RSpec::ExampleGroup, :type => :frill, :example_group => {
+    :file_path => /spec[\\\/]frills/
+  }
+end

data/readme.markdown

@@ -32,11 +32,14 @@ module FooFrill
   end
 
   def foo
-    h.render partial: "shared/foo", locals: { foo: "#{super} bar" }
+    h.content_tag :b, "#{super} bar"
   end
 end
 ```
 
+The `h` method gives you access to all of the view helpers you would normally expect to use inside a view or a helper.
+It's aliased to `helpers`, so feel free to use either.
+
 Opt objects in your controllers into frill with the `frill` method:
 
 ```ruby
@@ -64,7 +67,8 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-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.
+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
@@ -74,6 +78,31 @@ class FooController < ApplicationController
 end
 ```
 
+### 'frill' decorates individual objects _and_ collections
+
+The `frill` helper will decorate both single objects and collections of objects. You can use it both within your controller
+and within your views.
+
+For example, inside a controller: 
+
+```ruby
+class FoosController < ApplicationController
+  def index
+    @foos = frill Foo.all
+  end
+
+  def show
+    @foo = frill Foo.find(params[:id])
+  end
+end
+```
+
+Or, in a view:
+
+```erb
+<%= render frill(@foo.comments) %>
+```
+
 ## A longer story
 
 Your product manager writes the following story for you: 
@@ -81,12 +110,12 @@ Your product manager writes the following story for you:
 ```cucumber
 Feature: Consistent Timestamp Presentation
   As a user
-  I want "created at" timestamps presented in a uniform way on the site
+  I want "created at" timestamps presented in a uniform, localized way on the site
   So that I can easily discover the age of content on the site
 
   Scenario: Presenting timestamps
     When I navigate to a page that displays a created_at timestamp
-    Then I should see that timestamp marked up as bold and formatted as follows: YYYY/MM/DD
+    Then I should see that timestamp marked up as bold and formatted for the client's locale as follows: Month DD, YYYY HH:MM 
 ```
 
 You see this and roll your eyes. You're thinking about all of the places that you show `created_at` 
@@ -95,7 +124,7 @@ timestamps on the site. Reluctantly, you roll up your sleeves and start by writi
 ```ruby
 module ApplicationHelper
   def format_timestamp(t)
-    render partial: "shared/timestamp", locals: { time: t.strftime "%Y/%m/%d" }
+    render partial: "shared/timestamp", locals: { time: l(t, format: :long) }
   end
 end
 ```
@@ -127,7 +156,7 @@ Feature: Consistent Timestamp Presentation in the API
 
   Scenario: Presenting timestamps
     When I retrieve content with a "created_at" timestamp via the JSON API
-    Then I should see that timestamp formatted as follows: YYYY/MM/DD
+    Then I should see that timestamp formatted for the client's locale as follows: Month DD, YYYY HH:MM 
 ```
 
 You attempt to salvage the helper, updating it with concerns for the JSON format:
@@ -135,7 +164,7 @@ You attempt to salvage the helper, updating it with concerns for the JSON format
 ```ruby
 module ApplicationHelper
   def format_timestamp(t)
-    time = t.strftime "%Y/%m/%d" 
+    time = l t, format: :long 
 
     if request.format.html?
       render partial: "shared/timestamp", locals: { time: time }
@@ -167,13 +196,15 @@ module TimestampFrill
   end
 
   def created_at
-    super.strftime "%Y/%m/%d"
+    helpers.l super, format: :long
   end
 end
 ```
 
 The `frill?` method tells `Frill` when to extend an object with this module. Then we redefine the `created_at` method, 
-calling super and then formatting the date returned with `strftime`.
+calling super and then formatting the date with the rails localization helper `l`. The `helpers` method is made available to 
+frill'ed objects; it contains the same view context that you have access to inside of views and inside of helper methods. 
+You can use the `h` method as well - it's simply an alias for `helpers`.
 
 Simple enough. 
 
@@ -194,13 +225,17 @@ module HtmlTimestampFrill
 end
 ```
 
+```erb
+<b><%=time%></b>
+```
+
 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: 
+Lastly, opt objects into frilling inside your controllers by using the `frill` method: 
 
 ```ruby
 class ArticlesController < ApplicationController
@@ -218,7 +253,7 @@ frill will attempt to extend the object with any applicable frills (i.e., frills
 
 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:
+Note that if you 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:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -241,31 +276,126 @@ end
 
 Now, any instance variables you create in your controllers will be automatically frilled before handed off to your views.
 
-### 'frill' decorates individual objects _and_ collections
 
-As I've hinted at, the `frill` helper will decorate both single objects and collections of objects. You can use it both within your controller
-and within your views.
 
-For example, inside a controller: 
+## Testing
+
+If you're using frill inside a Rails application, you can take advantage of the "frill" rspec helper:
 
 ```ruby
-class PostsController < ApplicationController
-  def index
-    @posts = frill Post.all
+require 'spec_helper'
+
+describe HtmlTimestampFrill do
+  let(:model) {
+    Class.new do
+      def created_at
+        DateTime.new(2012, 1, 1)
+      end
+    end.new
   end
 
-  def show
-    @post = frill Post.find(params[:id])
+  subject { frill model }
+
+  its(:created_at) { should == "<b>January 01, 2012 00:00<b>" }
+end
+```
+
+It will assume an html request context, and it will embue your model with `h` and `helpers` methods.
+
+If you're attempting to test the `MyFrill.frill?` method, you'll need to supply it with stubs:
+
+```ruby
+require 'spec_helper'
+
+describe HtmlTimestampFrill do
+  let(:context) { double :view_context }
+
+  subject { HtmlTimestampFrill.frill? double(:model, created_at: "foo"), context }
+
+  context "given an HTML request" do
+    before { context.stub_chain(:request, :format, :html?).and_return true }
+    it { should be_true }
+  end
+
+  context "given a non-HTML request" do
+    before { context.stub_chain(:request, :format, :html?).and_return false }
+    it { should be_false }
   end
 end
 ```
 
-Or, in a view:
+Since frills are just modules, it's possible to test your frills in relative isolation.
 
-```erb
-<%= render frill(@post.comments) %>
+```ruby
+require 'spec_helper'
+
+describe TimestampFrill do
+  let(:object) do
+    double :object, 
+      created_at: DateTime.new(2012, 1, 1),
+      h: ApplicationController.new.view_context
+  end
+
+  subject { object.extend TimestampFrill }
+
+  its(:created_at) { should == "January 01, 2012 00:00" }
+end
+```
+
+When it comes to view methods that render partials, etc., you could choose to test them with integration:
+
+```ruby
+require 'spec_helper'                                                     
+
+class SomeModel
+  def h 
+    @view_context ||= ApplicationController.new.view_context
+  end
+
+  def created_at
+     Time.new(2012,1,1)
+  end
+end   
+
+describe HtmlTimestampFrill do                                            
+  let(:object) { SomeModel.new.extend TimestampFrill }
+
+  subject { object.extend HtmlTimestampFrill }     
+  
+  describe "#created_at" do
+    it "should render the timestamp partial" do
+      subject.created_at.strip.should == "<b>January 01, 2012 00:00</b>"
+    end
+  end
+end
 ```
 
+Or you could test them by stubbing out the view context, and simply setting up expectations on them:
+
+```ruby
+require 'spec_helper'
+
+class SomeModel
+  def h; end
+  def created_at; end
+end
+  
+describe HtmlTimestampFrill do                                            
+  let(:object) { SomeModel.new }
+  
+  subject { object.extend HtmlTimestampFrill }
+  
+  describe "#created_at" do                                               
+    it "should render the timestamp partial" do
+      subject.h.should_receive(:render)
+      subject.created_at
+    end
+  end
+end
+```
+
+The latter can be nice if you're really just interested in testing conditional logic inside your decoration.
+
 ## Usage outside Rails
 
 There are really just three integrations in a Rails app: the `frill` 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frill
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2012-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70295008464380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 3.2.2
   type: :development
   prerelease: false
-  version_requirements: *70295008464380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70295008463160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70295008463160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70295008458700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70295008458700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70295008457520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70295008457520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70295008456620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70295008456620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: moonmaster9000@gmail.com
 executables: []
@@ -75,6 +100,7 @@ files:
 - lib/frill/engine.rb
 - lib/frill/frill.rb
 - lib/frill/rails.rb
+- lib/frill/rspec.rb
 - lib/frill.rb
 - lib/generators/frill/frill_generator.rb
 - lib/generators/frill/templates/frill.rb
@@ -106,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Decorating objects for presentation. Supports Rails out of the box.