agnostic_presenters 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yeasty Mobs
+
+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,76 @@
+# AgnosticPresenters
+
+AgnosticPresenters is a gem that allow you to have presenters for your objects with a minimal syntax (because we are lazy).
+
+## TODO
+
+* Rename Base and Helper.
+* Do a proper tweak of Proxen
+
+## Usage
+
+<pre><code>require "rubygems"
+gem "yeastymobs-agnostic_presenters"
+require "agnostic_presenters"
+
+Class.send :include, AgnosticPresenters::Helper
+
+class MyModel
+
+  # ...
+  
+  presenters do
+    
+    def myattribute
+      "#{object.fancy} with a presenter"
+    end
+    
+  end
+end
+
+@model = MyModel.new(:myattribute => "fancy")
+@model.myattribute  # => fancy
+@model.myattribute! # => fancy with a presenter</code></pre>
+
+And you can share helpers between presenters with just a line:
+
+<pre><code>module Helpers
+  def escape(string)
+    Rack::Utils.escape(string)
+  end
+end
+
+AgnosticPresenters::Base.send :include, Helpers</code></pre>
+
+## Usage with Rails
+
+<pre><code>config.gem "yeastymobs-agnostic_presenters", :lib => "agnostic_presenters/activerecord", :source => "http://gems.github.com"</code></pre>
+
+And now you have presenters in your models which include ActionView helpers:
+
+<pre><code>class Article < ActiveRecord::Base
+  presenters do
+  
+    def title
+      h object.title
+    end
+    
+    def slug
+      object.title.parameterize
+    end
+    
+  end
+end</code></pre>
+
+If you use another ORM, just change "activerecord".
+
+## Supported ORMs
+
+* ActiveRecord "agnostic_presenters/activerecord"
+* MongoMapper "agnostic_presenters/mongomapper"
+
+## Credits
+
+* Nicolas Mérouze
+* A part of code is taken from active-record-presenters plugin
+* The proxy part is from nakajima-proxen gem

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "agnostic_presenters"
+    gem.summary = %Q{Agnostic Presenters}
+    gem.email = "dev@yeastymobs.com"
+    gem.homepage = "http://github.com/yeastymobs/agnostic_presenters"
+    gem.authors = ["Nicolas Mérouze"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run all the specs for the machinist plugin.'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = false
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/agnostic_presenters.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{agnostic_presenters}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nicolas M\303\251rouze"]
+  s.date = %q{2010-06-11}
+  s.email = %q{dev@yeastymobs.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "agnostic_presenters.gemspec",
+     "lib/agnostic_presenters.rb",
+     "lib/agnostic_presenters/activerecord.rb",
+     "lib/agnostic_presenters/mongomapper.rb",
+     "lib/base.rb",
+     "lib/proxen.rb",
+     "lib/rails-init.rb",
+     "spec/agnostic_presenters_spec.rb",
+     "spec/proxen_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/yeastymobs/agnostic_presenters}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Agnostic Presenters}
+  s.test_files = [
+    "spec/agnostic_presenters_spec.rb",
+     "spec/proxen_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/agnostic_presenters.rb

@@ -0,0 +1,2 @@
+require 'base'
+require 'rails-init'

data/lib/agnostic_presenters/activerecord.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "../agnostic_presenters")
+ActiveRecord::Base.send :extend, AgnosticPresenters::Helper if defined?(ActiveRecord)

data/lib/agnostic_presenters/mongomapper.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "../agnostic_presenters")
+MongoMapper::Document.append_extensions(AgnosticPresenters::Helper) if defined?(MongoMapper)

data/lib/base.rb

@@ -0,0 +1,38 @@
+require "proxen"
+
+module AgnosticPresenters
+  class NoPresenter < StandardError; end
+
+  class Base
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+    end
+  end
+
+  module Helper
+
+    def presenters(&block)
+      klass = Class.new(::AgnosticPresenters::Base)
+      klass.class_eval(&block)
+      const_set(:Presenters, klass)
+      
+      self.send :include, Proxen
+      self.class_eval do
+        Proxen::Proxy.add(self, :_presenters, :if => /!$/)
+
+        def method_missing(sym, *args, &block)
+          Proxen::Proxy.handle(self, sym, *args, &block) || super
+        end
+
+        def _presenters
+          @_presenters ||= self.class::Presenters.new(self)
+        rescue NameError
+          raise ::AgnosticPresenters::NoPresenter, "No presenter has been found for #{self.class.name}."
+        end
+      end
+    end
+
+  end
+end

data/lib/proxen.rb

@@ -0,0 +1,106 @@
+module Proxen
+  class Proxy
+    class << self
+      def add(klass, *args)
+        store[klass] = new(klass, *args)
+      end
+
+      def handle(instance, sym, *args, &block)
+        klass = Object.instance_method(:class).bind(instance).call
+        if proxy = store[klass]
+          proxy.handle(instance, sym, *args, &block)
+        end
+      end
+
+      private
+
+      def store
+        @store ||= {}
+      end
+    end
+
+    def initialize(klass, *args)
+      @klass = klass
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @targets = Array(args).flatten
+
+      blankify! if @options[:blank_slate]
+    end
+
+    def handle(instance, sym, *args, &block)
+      if target = target_for(instance, sym)
+        sym = sym.to_s[0..-2] # Delete !
+        if @options[:compile]
+          compile(target, sym)
+          instance.__send__(sym, *args, &block)
+        else
+          instance.__send__(target).__send__(sym, *args, &block)
+        end
+      end
+    end
+
+    def blankify!
+      @klass.class_eval do
+        instance_methods.each do |sym|
+          undef_method(sym) unless sym.to_s =~ /__/
+        end
+      end
+    end
+
+    private
+    
+    def compile(receiver, sym)
+      @klass.class_eval(<<-END, __FILE__, __LINE__)
+        def #{sym}(*args, &block)
+          #{receiver}.send(#{sym.inspect}, *args, &block)
+        end
+      END
+    end
+
+    def proxying?(instance, sym)
+      case @options[:if] || @options[:unless]
+      when Proc   then calls?(sym)
+      when Regexp then match?(sym)
+      when Symbol then sends?(instance, sym)
+      else true
+      end
+    end
+
+    def calls?(sym)
+      case
+      when fn = @options[:if]      then fn.call(sym)
+      when fn = @options[:unless]  then not fn.call(sym)
+      end
+    end
+
+    def sends?(instance, sym)
+      case
+      when cond = @options[:if]      then instance.__send__(cond, sym)
+      when cond = @options[:unless]  then not instance.__send__(cond, sym)
+      end
+    end
+
+    def match?(sym)
+      case
+      when regex = @options[:if]      then sym.to_s =~ regex
+      when regex = @options[:unless]  then not sym.to_s =~ regex
+      end
+    end
+
+    def target_for(instance, sym)
+      return nil unless proxying?(instance, sym)
+      sym = sym.to_s[0..-2] # Delete !
+      @targets.detect { |t| instance.__send__(t).respond_to?(sym) }
+    end
+  end
+
+  def proxy_to(*targets)
+    Proxen::Proxy.add(self, *targets)
+
+    class_eval(<<-END, __FILE__, __LINE__)
+      def method_missing(sym, *args, &block)
+        Proxen::Proxy.handle(self, sym, *args, &block) || super
+      end
+    END
+  end
+end

data/lib/rails-init.rb

@@ -0,0 +1,16 @@
+File.join(File.dirname(__FILE__), "../lib/agnostic_presenters")
+require 'base'
+
+if defined?(Rails)
+  AgnosticPresenters::Base.send :include, ActionView::Helpers
+
+  class << ActionController::Base
+    def add_template_helper_with_presenters(helper_module, *args, &block)
+      # Hijacking any helper added to controllers so that our presenters can acces 'em.
+      AgnosticPresenters::Base.instance_eval { include helper_module }
+      add_template_helper_without_presenters(helper_module, *args, &block)
+    end
+
+    alias_method_chain :add_template_helper, :presenters
+  end
+end

data/spec/agnostic_presenters_spec.rb

@@ -0,0 +1,51 @@
+require "rubygems"
+require "spec"
+require "rack"
+
+$:.push File.join(File.dirname(__FILE__), "../lib")
+require "agnostic_presenters"
+
+# Helpers
+
+module Helpers
+  
+  def escape(string)
+    Rack::Utils.escape(string)
+  end
+  
+end
+
+AgnosticPresenters::Base.send :include, Helpers
+
+# Model
+
+Class.send :include, AgnosticPresenters::Helper
+
+class Article
+  attr_accessor :title, :body
+  
+  def initialize(title, body)
+    @title, @body = title, body
+  end
+  
+  presenters do
+    
+    def title
+      escape(object.title)
+    end
+    
+  end
+end
+
+describe Article do
+  
+  before(:all) do
+    @article = Article.new("[Agnostic Presenters]", "New presenter plugin.")
+  end
+  
+  it "should present title" do
+    @article.title!.should_not == @article.title
+    @article.title!.should == "%5BAgnostic+Presenters%5D"
+  end
+  
+end

data/spec/proxen_spec.rb

@@ -0,0 +1,211 @@
+require 'rubygems'
+require 'spec'
+require 'rr'
+ 
+require File.dirname(__FILE__) + '/../lib/proxen'
+Class.send :include, Proxen
+ 
+Spec::Runner.configure { |c| c.mock_with(:rr) }
+
+require 'ostruct'
+ 
+describe Proxen do
+  it "proxies method_missing to method" do
+    @klass = Class.new do
+      proxy_to :foo
+ 
+      def foo
+        Class.new { def bar; :proxied end }.new
+      end
+    end
+ 
+    @klass.new.bar.should == :proxied
+  end
+ 
+  it "respects other method missings" do
+    @klass = Class.new do
+      proxy_to :foo
+ 
+      def foo
+        Class.new { def bar; :proxied end }.new
+      end
+ 
+      def method_missing(sym, *args, &block)
+        :not_proxied
+      end
+    end
+ 
+    @klass.new.bar.should == :not_proxied
+  end
+ 
+  it "can generate blank slates" do
+    @klass = Class.new do
+      proxy_to :foo, :blank_slate => true
+ 
+      def foo
+        Class.new { def inspect; :proxied end }.new
+      end
+    end
+ 
+    @klass.new.inspect.should == :proxied
+  end
+ 
+  it "accepts :if method" do
+    @klass = Class.new do
+      proxy_to :foo, :if => :should?
+ 
+      def foo
+        Class.new {
+          def fizz; :proxied end
+          def buzz; :proxied end
+        }.new
+      end
+ 
+      def should?(sym)
+        sym != :buzz
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+ 
+    proc {
+      @klass.new.buzz
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "accepts :unless method" do
+    @klass = Class.new do
+      proxy_to :foo, :unless => :should_not?
+ 
+      def foo
+        Class.new {
+          def fizz; :proxied end
+          def buzz; :proxied end
+        }.new
+      end
+ 
+      def should_not?(sym)
+        sym == :buzz
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+ 
+    proc {
+      @klass.new.buzz
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "accepts :if proc" do
+    @klass = Class.new do
+      proxy_to :foo, :if => proc { |sym| sym == :fizz }
+ 
+      def foo
+        Class.new {
+          def fizz; :proxied end
+          def buzz; :proxied end
+        }.new
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+ 
+    proc {
+      @klass.new.buzz
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "accepts :unless proc" do
+    @klass = Class.new do
+      proxy_to :foo, :unless => proc { |sym| sym == :buzz }
+ 
+      def foo
+        Class.new {
+          def fizz; :proxied end
+          def buzz; :proxied end
+        }.new
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+ 
+    proc {
+      @klass.new.buzz
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "accepts :if regexen" do
+    @klass = Class.new do
+      proxy_to :foo, :if => /zz/
+ 
+      def foo
+        Class.new {
+          def baz; :err end
+          def fizz; :proxied end
+          def buzz; :proxied end
+        }.new
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+    @klass.new.buzz.should == :proxied
+ 
+    proc {
+      @klass.new.baz.should == :proxied
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "accepts :unless regexen" do
+    @klass = Class.new do
+      proxy_to :foo, :unless => /zz/
+ 
+      def foo
+        Class.new {
+          def baz; :proxied end
+          def fizz; :err end
+          def buzz; :err end
+        }.new
+      end
+    end
+ 
+    @klass.new.baz.should == :proxied
+ 
+    proc {
+      @klass.new.fizz
+      @klass.new.buzz
+    }.should raise_error(NoMethodError)
+  end
+ 
+  it "proxies to multiple" do
+    @klass = Class.new do
+      proxy_to :foo, :bar
+ 
+      def foo
+        Class.new { def fizz; :proxied end }.new
+      end
+ 
+      def bar
+        Class.new { def buzz; :proxied end }.new
+      end
+    end
+ 
+    @klass.new.fizz.should == :proxied
+    @klass.new.buzz.should == :proxied
+  end
+ 
+  it "defines methods so that they don't require method missing" do
+    @compiled = Class.new {
+      proxy_to :foo, :blank_slate => true, :compile => true
+ 
+      def foo
+        :COMPILED!
+      end
+    }.new
+ 
+    @compiled.to_s
+ 
+    mock.proxy(Proxen::Proxy).handle(anything).never
+ 
+    @compiled.to_s.should == 'COMPILED!'
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: agnostic_presenters
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Nicolas M\xC3\xA9rouze"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-11 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dev@yeastymobs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- agnostic_presenters.gemspec
+- lib/agnostic_presenters.rb
+- lib/agnostic_presenters/activerecord.rb
+- lib/agnostic_presenters/mongomapper.rb
+- lib/base.rb
+- lib/proxen.rb
+- lib/rails-init.rb
+- spec/agnostic_presenters_spec.rb
+- spec/proxen_spec.rb
+has_rdoc: true
+homepage: http://github.com/yeastymobs/agnostic_presenters
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Agnostic Presenters
+test_files: 
+- spec/agnostic_presenters_spec.rb
+- spec/proxen_spec.rb