presents 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-09-24
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/presents.rb
+lib/presents/aggregate_presenter.rb
+lib/presents/application_helper_methods.rb
+lib/presents/base_presenter.rb
+lib/presents/railtie.rb
+test/test_presents.rb

data/README.txt

@@ -0,0 +1,62 @@
+= presents
+
+* https://github.com/matthewcalebsmith/presents
+
+== DESCRIPTION:
+
+Minimalist presenter pattern for Rails
+
+== FEATURES/PROBLEMS:
+
+* Present models in a view context through ApplicationHelper methods.
+* Wrap any object by passing it to presenter's initalize method.
+* Bulk up tests.
+* Bulk up documentation.
+
+== SYNOPSIS:
+
+  - present @foo do |_foo|
+    = @foo.do_normal
+    = _foo.do_special
+
+== REQUIREMENTS:
+
+* None besides Rails. Yea!
+
+== INSTALL:
+
+* gem 'presents'
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Matthew Smith
+
+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/Rakefile

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :isolate
+
+Hoe.spec 'presents' do
+  # HEY! If you fill these out in ~/.hoe_template/Rakefile.erb then
+  # you'll never have to touch them again!
+  # (delete this comment too, of course)
+
+  developer('Matt Smith', 'matt@nearapogee.com')
+
+  license 'MIT'
+
+  dependency('rails', '>1.0.0')
+  dependency('isolate', '~>3.2.2', :dev)
+  dependency('hoe-git', '~>1.5.0', :dev)
+end
+
+# vim: syntax=ruby

data/lib/presents.rb

@@ -0,0 +1,5 @@
+module Presents
+  VERSION = '1.0.0'
+end
+
+Dir.glob(File.dirname(__FILE__) + '/presents/*.rb') { |file| require file }

data/lib/presents/aggregate_presenter.rb

@@ -0,0 +1,60 @@
+module Presents
+  class AggregatePresenter
+
+    # Internal: Create a new presenter.
+    #
+    # Called by present method in ApplicationHelper.
+    #
+    # presenters - A hash of the access method name and the presenter
+    #
+    # Returns self.
+    def initialize(presenters, template)
+      @presenters = presenters
+      @template = template
+
+      @presenters.each do |presenter|
+        class_eval do
+          define_method(presenter.class.name.underscore.to_sym) do
+            presenter
+          end
+        end
+      end
+      self
+    end
+
+    # Public: Access the view for helper methods.
+    #
+    # Examples
+    #
+    #   class XxxPresenter < AggregatePresenter
+    #     ...
+    #     def my_attribute
+    #       h.content_tag :span, "Duck", :class => "mallard"
+    #     end
+    #     ...
+    #   end
+    #
+    # Returns the template.
+    def h
+      @template
+    end
+
+    # Internal: Send any unknown methods to the template.
+    #
+    # This is done so you don't have to access them through h.
+    #
+    # Examples
+    #
+    #   class XxxPresenter < AggregatePresenter
+    #     ...
+    #     def my_attribute
+    #       content_tag :span, "Duck", :class => "mallard"
+    #     end
+    #     ...
+    #   end
+    #
+    def method_missing(*args, &block)
+      @template.send(*args, &block)
+    end
+  end
+end

data/lib/presents/application_helper_methods.rb

@@ -0,0 +1,60 @@
+module Presents
+  module ApplicationHelperMethods
+
+    # Public: Render a context in the view to wrap a model with a presenter.
+    # 
+    # object - The object (model) to be presented.
+    # cls - Defaults to nil. Allows manual specification of which Presenter
+    #       to use.
+    #
+    # Examples
+    #
+    #   <% present @user do |user_presenter| %>
+    #     <%= user_presenter.do_presenter_method %>
+    #     <%= user_presenter.do_model_method %>
+    #   <% end %>
+    #
+    # Returns the presenter for the model.
+    def present(object, cls = nil)
+      cls ||= "#{object.class}Presenter".constantize
+      presenter = cls.new(object, self)
+      yield presenter if block_given?
+      presenter
+    end
+
+    # Public: Render a context in the view to wrap thwo presenters in an
+    #           aggregate presenter.
+    #
+    # cls - Full classname constant of the aggregate presenter. This is required
+    #       unlike the present method.
+    # presenters - Variable argument list of presenters/objects. They are
+    #              accessed by their underscore class name in the presenter. There
+    #              should never be a need to pass two of the same class.
+    #
+    # Examples
+    #
+    #   <% present @user do |user_presenter| %>
+    #     <% present @organization do |organization_presenter| %>
+    #       <% aggregate UserOrganizationPresenter, user_presenter, organization_presenter do |user_organization_presenter| %>
+    #
+    #         <%= user_presenter.do_presenter_method %>
+    #         <%= user_presenter.do_model_method %>
+    #
+    #         <%= organization_presenter.do_presenter_method %>
+    #         <%= organization_presenter.do_model_method %>
+    #
+    #         <%= user_organization_presenter.do_presenter_method %>
+    #         <%= user_organization_presenter.do_model_method %>
+    #       <% end %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # Returns the aggregate presenter for the model.
+    def aggregate(cls, *presenters)
+      presenter = cls.new(presenters, self)
+      yield presenter if block_given?
+      presenter
+    end
+
+  end
+end

data/lib/presents/base_presenter.rb

@@ -0,0 +1,69 @@
+module Presents
+  class BasePresenter
+
+    # Internal: Create a new presenter.
+    #
+    # Called by present method in ApplicationHelper.
+    #
+    def initialize(object, template = nil)
+      @object = object
+      @template = template
+    end
+
+    # Public: Create an accessor to the wrapped object.
+    #
+    # Examples
+    #
+    #   class DuckPresenter < BasePresenter
+    #     presents :duck
+    #     
+    #     ...
+    #
+    #     def my_attribute
+    #       h.number_as_currency(duck.attribute)
+    #     end
+    #
+    #   end
+    #
+    def self.presents(name)
+      define_method(name) do
+        @object
+      end
+    end
+
+    # Public: Access the view for helper methods.
+    #
+    # Examples
+    #
+    #   class XxxPresenter < BasePresenter
+    #     ...
+    #     def my_attribute
+    #       h.content_tag :span, "Duck", :class => "mallard"
+    #     end
+    #     ...
+    #   end
+    #
+    # Returns the template.
+    def h
+      @template
+    end
+
+    # Internal: Send any unknown methods to the template.
+    #
+    # This is done so you don't have to access them through h.
+    #
+    # Examples
+    #
+    #   class XxxPresenter < BasePresenter
+    #     ...
+    #     def my_attribute
+    #       content_tag :span, "Duck", :class => "mallard"
+    #     end
+    #     ...
+    #   end
+    #
+    def method_missing(*args, &block)
+      @template.send(*args, &block) if @template
+    end
+  end
+end

data/lib/presents/railtie.rb

@@ -0,0 +1,7 @@
+module Presents
+  class Railtie < Rails::Railtie
+    initializer 'presents.include' do
+      ApplicationHelper.send :include, Presents::ApplicationHelperMethods
+    end
+  end
+end

data/test/test_presents.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require "rails"
+require "presents"
+
+class TestPresents < Test::Unit::TestCase
+  class Foo
+    def name
+      "Foo"
+    end
+  end
+  class MyPresenter < Presents::BasePresenter
+    presents :foo
+    def name_upcase
+      foo.name.upcase
+    end
+  end
+
+  def test_base_presenter_wraps_object
+    assert_equal "FOO", MyPresenter.new(Foo.new).name_upcase
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: presents
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-25 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: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: isolate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Minimalist presenter pattern for Rails
+email:
+- matt@nearapogee.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/presents.rb
+- lib/presents/aggregate_presenter.rb
+- lib/presents/application_helper_methods.rb
+- lib/presents/base_presenter.rb
+- lib/presents/railtie.rb
+- test/test_presents.rb
+- .gemtest
+homepage: https://github.com/matthewcalebsmith/presents
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+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: presents
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Minimalist presenter pattern for Rails
+test_files:
+- test/test_presents.rb