active_decorator 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - ruby-head
+
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in active_decorator.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Akira Matsuda
+
+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.

data/README.md

@@ -0,0 +1,66 @@
+# ActiveDecorator
+
+A simple and Rubyish view helper for ActiveRecord models. Keep your helpers and views Object-Oriented!
+
+
+## Features ##
+
+1. automatically mixes decorator module into corresponding model only when:
+  1. passing a model or collection of models or an instance of ActiveRecord::Relation from controllers to views
+  2. rendering partials with models (using `:collection` or `:object` or `:locals` explicitly or implicitly)
+2. the decorator module runs in the model's context. So, you can directly call any attributes or methods in the decorator module
+3. since decorators are considered as sort of helpers, you can also call any ActionView's helper methods such as `content_tag` or `link_to`
+
+
+## Supported versions ##
+
+Rails 3.0.x, 3.1.x, and 3.2 (edge)
+
+
+## Usage ##
+
+1. bundle 'active_decorator' gem
+2. create a decorator module for each AR model. For example, a decorator for a model `User` should be named `UserDecorator`.
+You can use the generator for doing this ( `% rails g decorator user` )
+3. Then it's all done. Without altering any single line of the existing code, the decorator modules will be automatically mixed into your models only in the view context.
+
+
+## Examples ##
+
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      # first_name:string last_name:string website:string
+    end
+    
+    # app/decorators/user_decorator.rb
+    module UserDecorator
+      def full_name
+        "#{first_name} #{last_name}"
+      end
+    
+      def link
+        link_to full_name, website
+      end
+    end
+    
+    # app/controllers/users_controller.rb
+    class UsersController < ApplicationController
+      def index
+        User.all
+      end
+    end
+    
+    # app/views/users/index.html.erb
+    <% @users.each do |user| %>
+      <%= user.link %><br>
+    <% end %>
+
+
+## Contributing to ActiveDecorator ##
+
+* Fork, fix, then send me a pull request.
+
+
+## Copyright ##
+
+Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/active_decorator.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_decorator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_decorator"
+  s.version     = ActiveDecorator::VERSION
+  s.authors     = ["Akira Matsuda"]
+  s.email       = ["ronnie@dio.jp"]
+  s.homepage    = ""
+  s.summary     = %q{A simple and Rubyish view helper for ActiveRecord models}
+  s.description = %q{A simple and Rubyish view helper for ActiveRecord models}
+
+  s.rubyforge_project = "active_decorator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'rails'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'sqlite3'
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/active_decorator.rb

@@ -0,0 +1,4 @@
+require 'active_decorator/version'
+require 'active_decorator/decorator'
+require 'active_decorator/railtie'
+

data/lib/active_decorator/decorator.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+require 'active_decorator/helpers'
+
+module ActiveDecorator
+  class Decorator
+    include Singleton
+
+    def initialize
+      @@decorators = {}
+    end
+
+    def decorate_if_model(obj)
+      case obj
+      when ActiveRecord::Base
+        decorate obj
+      when ActiveRecord::Relation
+        class << obj
+          def to_a_with_decorator
+            arr = to_a_without_decorator
+            arr.each do |model|
+              ActiveDecorator::Decorator.instance.decorate model
+            end
+          end
+          alias_method_chain :to_a, :decorator
+        end
+      when Array
+        obj.each do |r|
+          decorate_if_model r
+        end
+      end
+    end
+
+    def decorate(model)
+      d = decorator_for model.class
+      return model unless d
+      model.extend d unless model.is_a? d
+    end
+
+    private
+    def decorator_for(model_class)
+      return @@decorators[model_class] if @@decorators.has_key? model_class
+
+      decorator_name = "#{model_class.name}Decorator"
+      d = decorator_name.constantize
+      d.send :include, ActiveDecorator::Helpers
+      @@decorators[model_class] = d
+      rescue NameError
+    end
+  end
+end

data/lib/active_decorator/helpers.rb

@@ -0,0 +1,21 @@
+require 'action_view'
+
+module ActiveDecorator
+  module Helpers
+    def method_missing(method, *args, &block)
+      super
+    #TODO need to make sure who raised the error?
+    rescue NoMethodError => no_method_error
+      begin
+        @@_decorator_view_proxy ||= DecoratorViewProxy.new
+        @@_decorator_view_proxy.send method, *args, block
+      rescue NoMethodError
+        raise no_method_error
+      end
+    end
+
+    class DecoratorViewProxy
+      include ::ActionView::Helpers
+    end
+  end
+end

data/lib/active_decorator/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module ActiveDecorator
+  class Railtie < ::Rails::Railtie
+    initializer 'active_decorator' do
+      ActiveSupport.on_load(:action_view) do
+        require 'monkey/action_view/partial_renderer'
+      end
+      ActiveSupport.on_load(:action_controller) do
+        require 'monkey/abstract_controller/rendering'
+      end
+      ActiveSupport.on_load(:action_mailer) do
+        require 'monkey/abstract_controller/rendering'
+      end
+    end
+  end
+end

data/lib/active_decorator/version.rb

@@ -0,0 +1,3 @@
+module ActiveDecorator
+  VERSION = '0.1.0'
+end

data/lib/generators/rails/decorator_generator.rb

@@ -0,0 +1,26 @@
+module Rails
+  module Generators
+    class DecoratorGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc <<DESC
+Description:
+    Stubs out a decorator module in app/decorators directory.
+
+Examples:
+    `rails g decorator book`
+
+    This creates:
+        app/decorators/book_decorator.rb
+DESC
+
+      def create_decorator_file
+        empty_directory 'app/decorators'
+
+        template 'decorator.rb', File.join('app/decorators', "#{singular_name}_decorator.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/rails/templates/decorator.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+module <%= class_name %>Decorator
+end

data/lib/generators/rspec/decorator_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  class DecoratorGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      empty_directory 'spec/decorators'
+
+      template 'decorator_spec.rb', File.join('spec/decorators', "#{singular_name}_decorator_spec.rb")
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe <%= singular_name.camelize %>Decorator do
+  let(:<%= singular_name %>) { <%= class_name %>.new.extend <%= singular_name.camelize %>Decorator }
+  subject { <%= singular_name %> }
+  it { should be_a <%= class_name %> }
+end

data/lib/generators/test_unit/decorator_generator.rb

@@ -0,0 +1,11 @@
+module TestUnit
+  class DecoratorGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_test_file
+      empty_directory 'test/decorators'
+
+      template 'decorator_test.rb', File.join('test/decorators', "#{singular_name}_decorator_test.rb")
+    end
+  end
+end

data/lib/generators/test_unit/templates/decorator_test.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+require 'test_helper'
+
+class <%= singular_name.camelize %>DecoratorTest < ActiveSupport::TestCase
+  def setup
+    @<%= singular_name %> = <%= class_name %>.new.extend <%= singular_name.camelize %>Decorator
+  end
+
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/lib/monkey/abstract_controller/rendering.rb

@@ -0,0 +1,13 @@
+module AbstractController
+  module Rendering
+    def view_assigns_with_decorator
+      hash = view_assigns_without_decorator
+      hash.values.each do |v|
+        ActiveDecorator::Decorator.instance.decorate_if_model v
+      end
+      hash
+    end
+
+    alias_method_chain :view_assigns, :decorator
+  end
+end

data/lib/monkey/action_view/partial_renderer.rb

@@ -0,0 +1,19 @@
+module ActionView
+  class PartialRenderer < AbstractRenderer #:nodoc:
+    def setup_with_decorator(context, options, block)
+      setup_without_decorator context, options, block
+
+      @locals.values.each do |v|
+        ActiveDecorator::Decorator.instance.decorate_if_model v
+      end if @locals.present?
+      ActiveDecorator::Decorator.instance.decorate_if_model @object
+      @collection.each do |v|
+        ActiveDecorator::Decorator.instance.decorate_if_model v
+      end if @collection.present?
+
+      self
+    end
+
+    alias_method_chain :setup, :decorator
+  end
+end

data/spec/fake_app/authors/index.html.erb

@@ -0,0 +1,16 @@
+<% @authors.each do |author| %>
+  <%= author.name %>
+  <%= author.reverse_name %>
+
+  <% if params[:partial] == 'collection' %>
+    <%= render author.books %>
+  <% elsif params[:partial] == 'locals' %>
+    <% author.books.each do |book| %>
+      <%= render :partial => 'books/book_locals', :locals => {:b => book} %>
+    <% end %>
+  <% else %>
+    <% author.books.each do |book| %>
+      <%= render book %>
+    <% end %>
+  <% end %>
+<% end %>

data/spec/fake_app/authors/show.html.erb

@@ -0,0 +1,2 @@
+<%= @author.name %>
+<%= @author.capitalized_name %>

data/spec/fake_app/books/_book.html.erb

@@ -0,0 +1,2 @@
+<%= book.title %>
+<%= book.reverse_title %>

data/spec/fake_app/books/_book_locals.html.erb

@@ -0,0 +1,2 @@
+<%= b.title %>
+<%= b.upcased_title %>

data/spec/fake_app/books/show.html.erb

@@ -0,0 +1 @@
+<%= @book.link %>

data/spec/fake_app/fake_app.rb

@@ -0,0 +1,88 @@
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+# config
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+module ActiveDecoratorTestApp
+  class Application < Rails::Application
+    config.secret_token = '"confusion" will be my epitaph.'
+    config.session_store :cookie_store, :key => '_myapp_session'
+    config.active_support.deprecation = :log
+  end
+end
+ActiveDecoratorTestApp::Application.initialize!
+
+# routes
+ActiveDecoratorTestApp::Application.routes.draw do
+  resources :authors, :only => [:index, :show] do
+    resources :books, :only => :show
+  end
+end
+
+# models
+class Author < ActiveRecord::Base
+  has_many :books
+end
+class Book < ActiveRecord::Base
+  belongs_to :author
+end
+
+# helpers
+module ApplicationHelper; end
+
+# decorators
+module AuthorDecorator
+  def reverse_name
+    name.reverse
+  end
+
+  def capitalized_name
+    name.capitalize
+  end
+end
+module BookDecorator
+  def reverse_title
+    title.reverse
+  end
+
+  def upcased_title
+    title.upcase
+  end
+
+  def link
+    link_to title, 'http://example.com'
+  end
+end
+
+# controllers
+class ApplicationController < ActionController::Base
+  self.append_view_path File.dirname(__FILE__)
+end
+class AuthorsController < ApplicationController
+  def index
+    if params[:variable_type] == 'array'
+      @authors = Author.all
+    else
+      @authors = Author.scoped
+    end
+  end
+
+  def show
+    @author = Author.find params[:id]
+  end
+end
+class BooksController < ApplicationController
+  def show
+    @book = Author.find(params[:author_id]).books.find(params[:id])
+  end
+end
+
+# migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:authors) {|t| t.string :name}
+    create_table(:books) {|t| t.string :title; t.references :author}
+  end
+end

data/spec/requests/action_view_helpers_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+feature 'fallback to helpers' do
+  background do
+    aamine = Author.create! :name => 'aamine'
+    @rhg = aamine.books.create! :title => 'RHG'
+  end
+
+  scenario 'invoking action_view helper methods' do
+    visit "/authors/#{@rhg.author.id}/books/#{@rhg.id}"
+    within 'a' do
+      page.should have_content 'RHG'
+    end
+  end
+end

data/spec/requests/controller_ivar_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+feature 'decorating controller ivar' do
+  background do
+    @matz = Author.create! :name => 'matz'
+    Author.create! :name => 'takahashim'
+  end
+  after do
+    Author.delete_all
+  end
+
+  scenario 'decorating a model object in ivar' do
+    visit "/authors/#{@matz.id}"
+    page.should have_content 'matz'
+    page.should have_content 'matz'.capitalize
+  end
+
+  scenario 'decorating model scope in ivar' do
+    visit '/authors'
+    page.should have_content 'takahashim'
+    page.should have_content 'takahashim'.reverse
+  end
+
+  scenario "decorating models' array in ivar" do
+    visit '/authors?variable_type=array'
+    page.should have_content 'takahashim'
+    page.should have_content 'takahashim'.reverse
+  end
+end

data/spec/requests/partial_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+feature 'decorating partial object' do
+  background do
+    Author.create! :name => 'aamine'
+    nari = Author.create! :name => 'nari'
+    nari.books.create! :title => 'the gc book'
+  end
+  after do
+    Book.delete_all
+    Author.delete_all
+  end
+
+  scenario 'decorating implicit @object' do
+    visit '/authors'
+    page.should have_content 'the gc book'
+    page.should have_content 'the gc book'.reverse
+  end
+
+  scenario 'decorating implicit @collection' do
+    visit '/authors?partial=collection'
+    page.should have_content 'the gc book'
+    page.should have_content 'the gc book'.reverse
+  end
+
+  scenario 'decorating objects in @locals' do
+    visit '/authors?partial=locals'
+    page.should have_content 'the gc book'
+    page.should have_content 'the gc book'.upcase
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+# load Rails first
+require 'rails'
+require 'active_decorator'
+# needs to load the app before loading rspec/rails => capybara
+require 'fake_app/fake_app'
+require 'rspec/rails'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'authors'
+  end
+  config.before :each do
+    Book.delete_all
+    Author.delete_all
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: active_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70282934150240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70282934150240
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70282934149800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70282934149800
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70282934149380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70282934149380
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70282934148940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70282934148940
+description: A simple and Rubyish view helper for ActiveRecord models
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- active_decorator.gemspec
+- lib/active_decorator.rb
+- lib/active_decorator/decorator.rb
+- lib/active_decorator/helpers.rb
+- lib/active_decorator/railtie.rb
+- lib/active_decorator/version.rb
+- lib/generators/rails/decorator_generator.rb
+- lib/generators/rails/templates/decorator.rb
+- lib/generators/rspec/decorator_generator.rb
+- lib/generators/rspec/templates/decorator_spec.rb
+- lib/generators/test_unit/decorator_generator.rb
+- lib/generators/test_unit/templates/decorator_test.rb
+- lib/monkey/abstract_controller/rendering.rb
+- lib/monkey/action_view/partial_renderer.rb
+- spec/fake_app/authors/index.html.erb
+- spec/fake_app/authors/show.html.erb
+- spec/fake_app/books/_book.html.erb
+- spec/fake_app/books/_book_locals.html.erb
+- spec/fake_app/books/show.html.erb
+- spec/fake_app/fake_app.rb
+- spec/requests/action_view_helpers_spec.rb
+- spec/requests/controller_ivar_spec.rb
+- spec/requests/partial_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: active_decorator
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple and Rubyish view helper for ActiveRecord models
+test_files:
+- spec/fake_app/authors/index.html.erb
+- spec/fake_app/authors/show.html.erb
+- spec/fake_app/books/_book.html.erb
+- spec/fake_app/books/_book_locals.html.erb
+- spec/fake_app/books/show.html.erb
+- spec/fake_app/fake_app.rb
+- spec/requests/action_view_helpers_spec.rb
+- spec/requests/controller_ivar_spec.rb
+- spec/requests/partial_spec.rb
+- spec/spec_helper.rb