frill 0.0.1

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/frill.rb

@@ -0,0 +1,2 @@
+require 'frill/frill'
+require 'frill/engine' if defined? Rails

data/lib/frill/engine.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+module Frill
+  class Engine < Rails::Engine
+    config.autoload_paths << "app/frills"
+
+    initializer "frill.rails_integration" do
+      require 'frill/rails'
+    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/*"]
+      end
+    end
+
+    def self.force_load files
+      files.each do |f| 
+        load f
+      end
+    end
+  end
+end

data/lib/frill/frill.rb

@@ -0,0 +1,42 @@
+module Frill
+  def self.included(base)
+    self.decorators << base
+    base.extend ClassMethods
+  end
+
+  def self.decorators
+    @decorators ||= []
+  end
+
+  def self.reset!
+    @decorators = nil
+  end
+
+  def self.decorate object, context
+   decorators.each do |d|
+     object.extend d if d.frill? object, context
+   end
+
+   object
+  end
+
+  module ClassMethods
+    def before decorator
+      move Frill.decorators.index(decorator)
+    end
+
+    def after decorator
+      decorator.before self
+    end
+
+    def first
+      move 0
+    end
+
+    private
+    def move index
+      Frill.decorators.delete self
+      Frill.decorators.insert index, self
+    end
+  end
+end

data/lib/frill/rails.rb

@@ -0,0 +1,5 @@
+class ActionController::Base
+  def frill object
+    Frill.decorate object, self
+  end
+end

data/readme.markdown

@@ -0,0 +1,109 @@
+# 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.
+
+Out of the box integration with Rails. 
+
+## Installation
+
+Throw this in your Gemfile:
+
+```ruby
+gem "frill"
+```
+
+## 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.)
+
+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.
+
+This is a perfect fit for the GoF decorator pattern.
+
+Create a new TimestampFrill module in `app/frills/timestamp_frill`:
+
+```ruby
+module TimestampFrill
+  include Frill
+
+  def self.frill? object, context
+    object.respond_to? :created_at
+  end
+
+  def created_at
+    super.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`.
+
+Next, let's create an `HtmlTimestampFrill` module:
+
+```ruby
+module HtmlTimestampFrill
+  include Frill
+  after TimestampFrill
+
+  def self.frill? object, context
+    object.respond_to?(:created_at) && context.request.format == "text/html"
+  end
+
+  def created_at
+    helper.content_tag :b, super
+  end
+end
+```
+
+Two things to note: the `HtmlTimestampFrill` is only applicable to
+objects that respond to `created_at` when presented in "html". Also, we
+tell `Frill` to decorate after `TimestampFrill` is applied (so that
+`super` in `created_at` returns our `TimestampFrill` response).
+
+Next, in our controller, we need to decorate our objects with frills:
+
+```ruby
+class PostsController < ApplicationController
+  respond_to :json, :html
+
+  def show
+    @article = frill Article.find(params[:id])
+    respond_with @article
+  end
+end
+```
+
+Notice that we've wrapped our article in a `frill`.
+
+In your html view, you simply call `@article.created_at`:
+
+```erb
+<%= @article.created_at %>
+```
+
+The same goes for your JSON 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 
+`ActionView::Helper` methods inside of your module methods.
+
+To kickoff the decoration of an object outside of a Rails application,
+simply call `Frill.decorate`:
+
+```ruby
+Frill.decorate my_object, my_context
+```
+
+## License
+
+MIT.

data/spec/frill_spec.rb

@@ -0,0 +1,94 @@
+require_relative '../lib/frill/frill'
+
+describe Frill do
+  before do
+    Frill.reset!
+  end
+
+  describe ".reset" do
+    before do
+      Frill.decorators << Module.new
+      Frill.decorators.should_not be_empty
+    end
+
+    it "should wipe out all decorators" do
+      Frill.reset!
+      Frill.decorators.should be_empty
+    end
+  end
+
+  describe ".decorate" do
+    let(:object)         { double :object  }
+    let(:object_context) { double :object_context }
+    let(:eigenclass)     { (class << object; self; end) }
+
+    let!(:applicable_module) do
+      Module.new do
+        include Frill
+
+        def self.frill? object, context
+          true
+        end
+      end
+    end
+
+    let!(:unapplicable_module) do
+      Module.new do
+        include Frill
+
+        def self.frill? object, context
+          false
+        end
+      end
+    end
+
+    it "should decorate the object with any applicable modules" do
+      Frill.decorate object, object_context
+
+      eigenclass.included_modules.should include applicable_module
+      eigenclass.included_modules.should_not include unapplicable_module
+    end
+  end
+
+  describe ".included" do
+    let(:test_module) { double :module }
+
+    subject { Frill.decorators }
+
+    before { Frill.included test_module }
+
+    it { should include test_module }
+  end
+
+  describe Frill::ClassMethods do
+    let(:module1) { Module.new { include Frill } }
+    let(:module2) { Module.new { include Frill } }
+
+    describe ".before" do
+      it "inserts the current module before the requested module in Frill's list of decorators" do
+        Frill.decorators.should == [module1, module2]
+
+        module2.before module1
+        Frill.decorators.should == [module2, module1]
+      end
+    end
+
+    describe ".after" do
+      it "inserts the current module after the requested module in Frill's list of decorators" do
+        Frill.decorators.should == [module1, module2]
+
+        module1.after module2
+        Frill.decorators.should == [module2, module1]
+      end
+    end
+
+    describe ".first" do
+      it "inserts the current module at the beginning of the list of Frill's decorators" do
+        Frill.decorators.should == [module1, module2]
+
+        module2.first
+        Frill.decorators.should == [module2, module1]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: frill
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70325001861360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70325001861360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70325001860160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325001860160
+description: 
+email: moonmaster9000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/frill/engine.rb
+- lib/frill/frill.rb
+- lib/frill/rails.rb
+- lib/frill.rb
+- VERSION
+- readme.markdown
+- spec/frill_spec.rb
+homepage: https://github.com/moonmaster9000/frill
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Decorating objects for presentation. Supports Rails out of the box.
+test_files:
+- spec/frill_spec.rb