present_foo 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+log
+.DS_store
+*/**/.DS_Store

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    present_foo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    columnize (0.3.6)
+    debugger (1.1.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1)
+      debugger-ruby_core_source (~> 1.1)
+    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.2)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger (= 1.1.1)
+  present_foo!
+  rails (~> 3.2.0)
+  rspec (~> 2.9.0)
+  rspec-rails (~> 2.9.0)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JC Grubbs
+
+MIT License
+
+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,166 @@
+[![Build Status](https://secure.travis-ci.org/devmynd/present_foo.png)](http://travis-ci.org/devmynd/present_foo)
+
+# PresentFoo
+
+PresentFoo is meant to be a very lightweight presenter library for
+Rails.  Presenters are a great way to move logic out of views and
+controllers into a class which represents the state of a "view" whether
+that be HTML, JSON, or other.  It's also a way to reduce the junk-drawer
+effect that happens in the `/helpers` directory of many large Rails
+applications.  This is a super basic implementation and I hope to grow
+it over time.  If you have thoughts on things that would be helpful I'd
+love the feedback.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'present_foo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install present_foo
+
+## Usage
+
+### Create your Presenters
+
+Presenters are just classes that inherit from Presenter and have a name
+which matches the `<Model>Presenter` naming convention (later we'll see
+how to override this).
+
+    class Book < ActiveRecord::Base
+      def some_model_method
+        "foo"
+      end
+    end
+
+    class BookPresenter < Presenter
+      def some_presenter_method
+        "bar"
+      end
+    end
+
+The `Presenter` base class inherits from `SimpleDelegator`, which allows
+instances of the presenter to mirror the public interface of
+the object they are presenting.  For example, if you have a method on
+your presented object or model called `some_model_method`, you can call
+it directly on the presenter and it will be delegated to the wrapped
+object.
+
+Presenters also all have a hook back to the controller they were created
+from.  For example, if you need to get access to helpers or url
+generators you can do so from the `controller` method.
+
+    class BookPresenter < Presenter
+
+      # Access to url generators
+      def edit_url
+        controller.edit_book_url
+      end
+
+      # Access to helper methods
+      def permalink
+        controller.create_permalink(self.title)
+      end
+
+    end
+
+You can also access the `request` or any other contextual data that's
+available to the controller in this manner.
+
+### Use Presenters in Controllers
+
+In a controller action, you simply call `present` or `present_many` which
+sets an instance variable that can be used in views and also returns
+an instance of the presenter for use in non-html responses.
+
+    class BooksController < ApplicationController
+
+      def index
+        books = Book.all
+        present_many books
+      end
+
+      def show
+        book = Book.find(params[:id])
+        present book
+      end
+
+    end
+
+    # app/views/books/index.html.haml
+    %ul.books
+      - @book_presenters.each do |book_presenter|
+        %li= book_presenter.title
+
+    # app/views/books/show.html.haml
+    %h1= @book_presenter.title
+    %h3= @book_presenter.author
+
+### Extending Presenter Initialization
+
+If you need to override the default behavior of a presenter at
+construction-time just override the `initialize` or `new_list` methods.
+
+    class BookPresenter < Presenter
+
+      # Maps to present in controllers
+      def initialize(obj, arg1, arg2)
+        # ... do some more stuff
+        super(obj)
+      end
+
+      # Maps to present_many in controllers
+      def self.new_list(objs, arg1, arg2)
+        # ... do some more stuff
+        super(objs)
+      end
+
+    end
+
+In controllers additional arguments passed to `present` or
+`present_many`
+will be passed to these overridden constructor methods.
+
+    class BooksController < ApplicationController
+
+      def index
+        books = Books.all
+        present_many books, "foo", "bar"
+      end
+
+    end
+
+### Changing the Default Presenter Type
+
+If you want to name your presenter something other than `<Class>Presenter`
+or, if you have more than one presenter for a given type you can simply
+pass the class you want to use as the second argument when calling
+`present` or `present_many`.
+
+    class BooksController < ApplicationController
+
+      def index
+        books = Books.all
+        present_many books, OtherBookPresenter, "foo", "bar"
+      end
+
+    end
+
+## TODO
+
+1. Do something to assist with serialization scenarios
+2. Make PresentFoo work in non-Rails environments
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/present_foo.rb

@@ -0,0 +1,25 @@
+require "delegate"
+require "present_foo/version"
+require "present_foo/serialization"
+require "present_foo/presenter"
+require "present_foo/presentation"
+require "present_foo/errors"
+
+module PresentFoo
+
+  def self.load!
+    hook_rails if defined?(::Rails)
+    # TODO: Figure out how to write hook_sinatra and hook_padrino
+  end
+
+  private
+
+  def self.hook_rails
+    ActiveSupport.on_load(:action_controller) do
+      ::ActionController::Base.send :include, Presentation
+    end
+  end
+
+end
+
+PresentFoo.load!

data/lib/present_foo/errors.rb

@@ -0,0 +1,7 @@
+module PresentFoo
+  module Errors
+
+    PresenterNotFound = Class.new(StandardError)
+
+  end
+end

data/lib/present_foo/presentation.rb

@@ -0,0 +1,50 @@
+module Presentation
+
+  extend ActiveSupport::Concern
+
+  included do
+
+    define_method :present do |obj, *args|
+      klass = presenter_klass(obj, args)
+      presenter = create_presenter(klass, obj, self, args)
+      set_instance_variable(klass, self, presenter, obj)
+      presenter
+    end
+
+    define_method :present_many do |objs, *args|
+      klass = presenter_klass(objs.first, args)
+      presenters = create_many_presenters(klass, objs, self, args)
+      set_instance_variable(klass, self, presenters, objs, true)
+      presenters
+    end
+
+  end
+
+  private
+
+  def create_presenter(klass, obj, source, args)
+    presenter = klass.new(obj, *args)
+    presenter.presenting_object = source
+    presenter
+  end
+
+  def create_many_presenters(klass, objs, source, args)
+    objs.map { |o| create_presenter(klass, o, source, args) }
+  end
+
+  def set_instance_variable(klass, source, value, obj, pluralize = false)
+    var_name = "@#{klass.to_s.underscore}#{"s" if pluralize}".to_sym
+    source.instance_variable_set(var_name, value)
+  end
+
+  def presenter_klass(obj, args)
+    return args.shift if args[0].kind_of?(Class)
+    klass_name = "#{obj.class}Presenter"
+    begin
+      return klass_name.constantize
+    rescue NameError
+      raise PresentFoo::Errors::PresenterNotFound.new("Could not find a presenter for #{obj.class}, looked for #{class_name}.")
+    end
+  end
+
+end

data/lib/present_foo/presenter.rb

@@ -0,0 +1,22 @@
+class Presenter < SimpleDelegator
+
+  def initialize(obj, *args)
+    super(obj)
+  end
+
+  attr_accessor :presenting_object
+  alias_method :controller, :presenting_object if defined?(::Rails)
+
+  def self.new_list(objs, *args)
+    objs.map { |o| new(o) }
+  end
+
+  def obj
+    __getobj__
+  end
+
+  def class
+    obj.class
+  end
+
+end

data/lib/present_foo/serialization.rb

@@ -0,0 +1,18 @@
+# TODO: Still thinking about this.
+#module PresentFoo::Serialization
+
+  #def self.included(base)
+    #base.extend ClassMethods
+    #base.send :class_variable_set, :@@_serializable_attributes, []
+  #end
+
+  #module ClassMethods
+
+    #def serialize_attributes(*attrs)
+      #self._serializable_attributes += attrs
+      #self._serializable_attributes.uniq!
+    #end
+
+  #end
+
+#end

data/lib/present_foo/version.rb

@@ -0,0 +1,3 @@
+module PresentFoo
+  VERSION = "0.1.0"
+end

data/present_foo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/present_foo/version", __FILE__)
+
+Gem::Specification.new do |gem|
+
+  gem.authors       = ["JC Grubbs"]
+  gem.email         = ["jc.grubbs@devmynd.com"]
+  gem.summary       = %q{Very simple presenters for Rails applications.}
+  gem.homepage      = "https://github.com/devmynd/present_foo"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "present_foo"
+  gem.require_paths = ["lib"]
+  gem.version       = PresentFoo::VERSION
+
+  gem.add_dependency "rails", "~> 3.2.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.9.0"
+  gem.add_development_dependency "rspec-rails", "~> 2.9.0"
+
+end

data/spec/controller_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+describe "Controllers" do
+
+  let(:books_controller) { BooksController.new }
+  let(:products_controller) { ProductsController.new }
+
+  it "should have a present method" do
+    books_controller.respond_to?(:present).should be_true
+  end
+
+  it "should have a present_many method" do
+    books_controller.respond_to?(:present_many).should be_true
+  end
+
+  describe "#present_many" do
+
+    before do
+      books_controller.index
+      @presenters = books_controller.instance_variable_get(:@book_presenters)
+    end
+
+    it "assigns @book_presenters" do
+      @presenters.should_not be_nil
+      @presenters.should be_kind_of(Array)
+    end
+
+  end
+
+  describe "#present" do
+
+    before do
+      books_controller.show
+      @presenter = books_controller.instance_variable_get(:@book_presenter)
+    end
+
+    it "assigns @book_presenter" do
+      @presenter.should_not be_nil
+      @presenter.should be_kind_of(BookPresenter)
+    end
+
+    it "@book_presenter has a presenting_object property" do
+      @presenter.presenting_object.should == books_controller
+    end
+
+    it "@book_presenter has a books_controller property (alias for presenting_object in Rails)" do
+      @presenter.controller.should == books_controller
+    end
+
+  end
+
+  describe "#present with specified presenter type" do
+
+    before do
+      books_controller.edit
+      @presenter = books_controller.instance_variable_get(:@alt_book_presenter)
+    end
+
+    it "assigns @alt_book_presenter (and is the correct type)" do
+      @presenter.should_not be_nil
+      @presenter.should be_kind_of(AltBookPresenter)
+    end
+
+  end
+
+  describe "#present with arguments" do
+
+    before do
+      products_controller.show
+      @presenter = products_controller.instance_variable_get(:@product_presenter)
+    end
+
+    it "passes arguments to the presenter's initialize method" do
+      @presenter.attr1.should == "foo"
+      @presenter.attr2.should == "bar"
+      @presenter.attr3.should == "baz"
+    end
+
+  end
+
+end

data/spec/fake_app.rb

@@ -0,0 +1,13 @@
+require "action_controller/railtie"
+
+# Config
+app = Class.new(Rails::Application)
+app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+app.config.session_store :cookie_store, :key => "_myapp_session"
+app.config.active_support.deprecation = :log
+app.initialize!
+
+# Routes
+app.routes.draw do
+  resources :books
+end

data/spec/fake_classes.rb

@@ -0,0 +1,56 @@
+class Book
+
+  attr_accessor :title, :author, :isbn, :publish_date
+
+  def initialize(*attrs)
+    attrs.each { |k,v| self.send("#{k}=".to_sym, v) }
+  end
+
+end
+
+class AltBookPresenter < Presenter; end
+
+class BookPresenter < Presenter; end
+
+class BooksController < ActionController::Base
+
+  def index
+    books = [Book.new, Book.new, Book.new]
+    present_many books
+  end
+
+  def show
+    book = Book.new
+    present book
+  end
+
+  def edit
+    book = Book.new
+    present book, AltBookPresenter
+  end
+
+end
+
+class Product; end
+
+class ProductPresenter < Presenter
+
+  attr_accessor :attr1, :attr2, :attr3
+
+  def initialize(obj, arg1, arg2, arg3)
+    @attr1 = arg1
+    @attr2 = arg2
+    @attr3 = arg3
+    super(obj)
+  end
+
+end
+
+class ProductsController < ActionController::Base
+
+  def show
+    product = Product.new
+    present product, "foo", "bar", "baz"
+  end
+
+end

data/spec/presenter_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Presenter do
+
+  let(:book) { Book.new }
+  let(:presenter) { BookPresenter.new(book) }
+  let(:books) { [Book.new, Book.new, Book.new] }
+
+  it ".obj returns the original object" do
+    presenter.obj.object_id.should == book.object_id
+  end
+
+  it ".class returns the class of the original object" do
+    presenter.class.should == Book
+  end
+
+  it "#new_list maps the given array to a list of presenters" do
+    presenters = BookPresenter.new_list(books)
+    presenters.size.should == 3
+    presenters[0].obj.object_id.should == books[0].object_id
+    presenters[1].obj.object_id.should == books[1].object_id
+    presenters[2].obj.object_id.should == books[2].object_id
+  end
+
+end

data/spec/serialization_spec.rb

@@ -0,0 +1,13 @@
+# TODO: Still thinking about this.
+#require "spec_helper"
+
+#describe "Serialization" do
+
+  #let(:book) { Book.new(title: "Jack and Jill", author: "Old Guy", isbn: 12345, publish_date: (DateTime.now - 60)) }
+  #let(:presenter) { BookPresenter.new(book) }
+
+  #it "#as_json returns a hash of the serializable attributes" do
+    #presenter.as_json.should == { title: book.title, author: book.author }
+  #end
+
+#end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+#$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "spec_helper"
+require "rails"
+require "present_foo"
+require "fake_app"
+require "fake_classes"
+require "rspec/rails"
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: present_foo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- JC Grubbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: 
+email:
+- jc.grubbs@devmynd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/present_foo.rb
+- lib/present_foo/errors.rb
+- lib/present_foo/presentation.rb
+- lib/present_foo/presenter.rb
+- lib/present_foo/serialization.rb
+- lib/present_foo/version.rb
+- present_foo.gemspec
+- spec/app/views/books/test.html.erb
+- spec/controller_spec.rb
+- spec/fake_app.rb
+- spec/fake_classes.rb
+- spec/presenter_spec.rb
+- spec/serialization_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/devmynd/present_foo
+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.23
+signing_key: 
+specification_version: 3
+summary: Very simple presenters for Rails applications.
+test_files:
+- spec/app/views/books/test.html.erb
+- spec/controller_spec.rb
+- spec/fake_app.rb
+- spec/fake_classes.rb
+- spec/presenter_spec.rb
+- spec/serialization_spec.rb
+- spec/spec_helper.rb