frill 0.0.2 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.1

data/app/frills/view_context_frill.rb

@@ -4,9 +4,15 @@ module ViewContextFrill
 
   def self.frill? object, controller
     object.class_eval do
-      define_method :helper do
+      define_method :helpers do
         @frill_helper ||= controller.view_context
       end
+
+      define_method :h do
+        helpers
+      end
+
+      private :h, :helpers
     end
 
     false

data/lib/frill/engine.rb

@@ -5,21 +5,27 @@ module Frill
     config.autoload_paths << "app/frills"
 
     initializer "frill.rails_integration" do
-      require 'frill/rails'
+      ActiveSupport.on_load(:action_controller) do
+        require 'frill/rails'
+      end
+    end
+
+    config.after_initialize do |app|
+      app.config.paths.add 'app/frills', :eager_load => true
     end
 
     config.to_prepare do
       if Rails.env.development? && !Rails.application.config.cache_classes
         Frill.reset!
 
-        Frill::Engine.force_load Dir["#{Frill::Engine.root}/app/frills/*"]
-        Frill::Engine.force_load Dir["#{Rails.root}/app/frills/*"]
+        Frill::Engine.force_load Dir["#{Frill::Engine.root}/app/frills/**/*"]
+        Frill::Engine.force_load Dir["#{Rails.root}/app/frills/**/*"]
       end
     end
 
     def self.force_load files
-      files.each do |f| 
-        load f
+      files.each do |f|
+        require_dependency f
       end
     end
   end

data/lib/frill/rails.rb

@@ -1,5 +1,16 @@
-class ActionController::Base
-  def frill object
-    Frill.decorate object, self
+module ActionController
+  class Base
+    helper_method :frill 
+
+    private
+    def frill object
+      if object.respond_to?(:each)
+        object.each do |o|
+          Frill.decorate o, self
+        end
+      else
+        Frill.decorate object, self
+      end
+    end
   end
 end

data/lib/generators/frill/frill_generator.rb

@@ -0,0 +1,17 @@
+module Rails
+  module Generators
+    class FrillGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision suffix: "Frill"
+
+
+      def create_frill_file
+        template 'frill.rb', File.join('app/frills/', class_path, "#{file_name}_frill.rb")
+      end
+
+      hook_for :test_framework
+
+    end
+  end
+end
+

data/lib/generators/frill/templates/frill.rb

@@ -0,0 +1,28 @@
+<% module_namespacing do -%>
+module <%= class_name %>Frill 
+  include Frill
+
+  # Decorating before or after another frill:
+  #   after SomeFrill
+  # or...
+  #   before SomeFrill
+  # or...
+  #   first
+
+  # frill? tells Frill when to decorate an object with this module.
+  # If you're decorating within a controller action via the `frill`
+  # method, then the context is the controller instance.
+  # This would allow you to scope this frill to only certain types
+  # of requests (e.g., context.request.json?)
+  def self.frill?(object, context)
+    false
+  end
+
+  # Decorate methods on `object`. 
+  # If you want to use a view helper like `link_to` or a route helper like
+  # `root_path`, use the `helpers` method (or its short alias, `h`) to access them:
+  # def created_at
+  #   h.content_tag :b, super
+  # end
+end
+<% end -%>

data/lib/generators/rspec/frill_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class FrillGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      template 'frill_spec.rb', File.join('spec/frills', "#{singular_name}_frill_spec.rb")
+    end
+  end
+end

data/lib/generators/rspec/templates/frill_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe <%=class_name%>Frill do
+  describe ".frill?" do
+    pending "replace this with a real test"
+  end
+end

data/readme.markdown

@@ -1,9 +1,10 @@
 # Frill
 
-Simple decoration of objects for presentation. If you don't know what I'm talking
-about, reading up on decorators and their role in MVC.
+[![Build Status](https://secure.travis-ci.org/moonmaster9000/frill.png)](http://travis-ci.org/moonmaster9000/frill)
+[![Build Dependency Status](https://gemnasium.com/moonmaster9000/frill.png)](https://gemnasium.com/moonmaster9000/frill.png)
+
+Simple decoration of objects for presentation. Out of the box integration with Rails.
 
-Out of the box integration with Rails. 
 
 ## Installation
 
@@ -13,58 +14,104 @@ Throw this in your Gemfile:
 gem "frill"
 ```
 
+Generate a frill:
+
+```sh
+$ rails g frill Timestamp --test-framework=rspec
+      create  app/frills/timestamp_frill.rb
+      invoke  rspec
+      create    spec/frills/timestamp_frill_spec.rb
+```
+
 ## Usage
 
 (For the purposes of this tutorial, I'm going to assume you're using
 `frill` inside a Rails app. Checkout the `Usage outside Rails` section
-below for information about how to use this outside of a Rails app.)
+below if you're not using Rails.)
 
 Imagine you're creating a web application that includes both a
 JSON API and an HTML frontend, and you've decided to always present a
 timestamp as YEAR/MONTH/DAY. Furthermore, when presented in HTML, you
-always want your timestamps wrapped in `<bold>` tags.
+always want your timestamps wrapped in `<b>` tags.
+
+This is a perfect fit for the GoF decorator pattern. Start by generating a `Timestamp` frill:
 
-This is a perfect fit for the GoF decorator pattern.
+```sh
+$ rails g frill Timestamp --test-framework=rspec
+      create  app/frills/timestamp_frill.rb
+      invoke  rspec
+      create    spec/frills/timestamp_frill_spec.rb
+```
+
+You can safely leave off the `--test-framework=rspec` portion if you've configured rspec as your default framework (or
+if you're not using rspec at all).
 
-Create a new TimestampFrill module in `app/frills/timestamp_frill`:
+Now open up `app/frills/timestamp_frill.rb` and format those timestamps:
 
 ```ruby
 module TimestampFrill
   include Frill
 
   def self.frill? object, context
-    object.respond_to? :created_at
+    object.respond_to?(:created_at) && object.respond_to?(:updated_at)
   end
 
   def created_at
-    super.strftime "%Y/%m/%d"
+    format_time super
+  end
+
+  def updated_at
+    format_time super
+  end
+
+  private
+
+  def format_time(t)
+    t.strftime "%Y/%m/%d"
   end
 end
 ```
 
 The first method `self.frill?` tells `Frill` what kind of objects this
-decorator is applicable to. In our case, it's any object that responds
-to `created_at`.
+decorator is applicable to. In our case, it's any object that have timestamps.
 
 Next, let's create an `HtmlTimestampFrill` module:
 
+```sh
+$ rails g frill HtmlTimestamp --test-framework=rspec
+      create  app/frills/html_timestamp_frill.rb
+      invoke  rspec
+      create    spec/frills/html_timestamp_frill_spec.rb
+```
+
 ```ruby
 module HtmlTimestampFrill
   include Frill
   after TimestampFrill
 
   def self.frill? object, context
-    object.respond_to?(:created_at) && context.request.format == "text/html"
+    object.respond_to?(:created_at) &&
+    object.respond_to?(:updated_at) &&
+    context.request.format.html?
   end
 
   def created_at
-    helper.content_tag :b, super
+     format_time_for_html super
+  end
+
+  def updated_at
+    format_time_for_html super
+  end
+
+  private
+  def format_time_for_html t
+    h.content_tag :b, t
   end
 end
 ```
 
 Two things to note: the `HtmlTimestampFrill` is only applicable to
-objects that respond to `created_at` when presented in "html". Also, we
+objects that have timestamps _when presented in "html"_. Also, we
 tell `Frill` to decorate after `TimestampFrill` is applied (so that
 `super` in `created_at` returns our `TimestampFrill` response).
 
@@ -91,6 +138,31 @@ In your html view, you simply call `@article.created_at`:
 
 The same goes for your JSON view.
 
+### 'frill' decorates individual objects _and_ collections
+
+The `frill` helper will decorate both collections and associations. You can use it both within your controller
+and within your views.
+
+For example, inside a controller: 
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    @posts = frill Post.all
+  end
+
+  def show
+    @post = frill Post.find(params[:id])
+  end
+end
+```
+
+Or, in a view:
+
+```erb
+<%= render frill(@post.comments) %>
+```
+
 ## Usage outside Rails
 
 There are really just two integrations in a Rails app: the `frill` 
@@ -106,4 +178,12 @@ Frill.decorate my_object, my_context
 
 ## License
 
-MIT.
+(The MIT License)
+
+Copyright © 2012 Matt Parker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frill
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70197025256920 !ruby/object:Gem::Requirement
+  requirement: &70317754031900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.2
   type: :development
   prerelease: false
-  version_requirements: *70197025256920
+  version_requirements: *70317754031900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70197025254800 !ruby/object:Gem::Requirement
+  requirement: &70317754031320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70197025254800
+  version_requirements: *70317754031320
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70317754030280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70317754030280
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70317754029580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70317754029580
 description: 
 email: moonmaster9000@gmail.com
 executables: []
@@ -43,6 +65,10 @@ files:
 - lib/frill/frill.rb
 - lib/frill/rails.rb
 - lib/frill.rb
+- lib/generators/frill/frill_generator.rb
+- lib/generators/frill/templates/frill.rb
+- lib/generators/rspec/frill_generator.rb
+- lib/generators/rspec/templates/frill_spec.rb
 - app/frills/view_context_frill.rb
 - VERSION
 - readme.markdown