presenter 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Vladimir Bobes Tuzinsky
+
+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.rdoc

@@ -0,0 +1,146 @@
+= Presenter gem
+
+This gem is mainly targeted at Rails developers who:
+
+* need to execute a search based on request parameters
+* load records from a database for cached fragments
+* have a lot of view-related logic in models
+
+It will help you to:
+
+* process request parameters (with simple typecasting)
+* cleanup your models and controller
+* postpone querying database until really needed (if needed at all)
+* ... more ...
+
+== Installation
+
+As usual:
+
+  gem install presenter
+
+To keep your code organized, create a directory "app/presenters" in your project and add this line to your environment.rb (or application.rb if you use Rails 3):
+
+  config.load_paths << Rails.root.join("app", "presenters").to_s
+
+Now you can have your presenters in the app/presenters directory and they'll be loaded automatically.
+
+== Basic usage
+
+Presenter:
+
+  # app/presenters/users_presenter.rb
+  class UsersPresenter < Presenter
+
+    # following parameters will be extracted from the params hash and
+    # properly typecasted. Nils, blanks and empty arrays will be discarded.
+    # If a parameter's value is an array, all values in the array will
+    # be typecasted
+    key :name, String
+    key :age, Integer
+
+    # this creates method "users", which calls and memoizes method "find_user".
+    presents :users
+
+    private
+
+    def find_users
+      scope = User
+      scope = scope.scoped(:conditions => { :name => name }) if first_name
+      scope = scope.scoped(:conditions => { :age => age }) if age
+      scope
+    end
+  end
+
+Controller:
+
+  # app/controllers/users_controller.rb
+  class UsersController < ApplicationController
+
+    def index
+      @users_presenter = UsersPresenter.new(params)
+    end
+  end
+
+View:
+
+  # app/views/users/index.html.haml
+  %ul
+    - @users_presenter.users.each do |user|
+      %li= user.name
+
+== Mixins
+
+If some of the code in your models is used only inside views (formatting and such),
+you may extract this code to a module and mix it from the presenter:
+
+  # app/presenters/user_mixin.rb
+  module UserMixin
+    def age_cca
+      age < 20 ? "too young" : age >= 30 ? "30+" : age
+    end
+  end
+
+Then tell the presented to use the module:
+
+  # app/presenters/users_presenter.rb
+  ...
+  presents :users, UserMixin
+  ...
+
+Now you can use the new method in your views:
+
+  # app/views/users/index.html.haml
+  %ul
+    - @users_presenter.users.each do |user|
+      %li
+        = user.name
+        = user.age_cca
+
+== Typecasting
+
+These types are supported out of the box:
++Object+, +Boolean+, +Float+, +Integer+, +String+, +Time+.
+
+All of these can be +nil+, single value or an array of values.
+
+It is also possible to add support for your custom types by implementing class
+method "typecast" for the given class. This would add support for price type:
+
+  # lib/price.rb
+  class Price
+
+    attr :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      if @value
+        "$" + @value.to_s.reverse.scan(/\d{1,3}/).join(",").reverse
+      else
+        ""
+      end
+    end
+
+    def self.typecast(value, options = {})
+      new value.to_s.scan(/\d+/).join.to_i if value
+    end
+  end
+
+== Note on Patches/Pull Requests
+
+As usual:
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Vladimir Bobes Tuzinsky. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "presenter"
+    gem.summary = %Q{Simplifies usage of Presenter pattern in Rails}
+    gem.description = %Q{Simplifies usage of Presenter pattern in Rails}
+    gem.email = "vladimir.tuzinsky@gmail.com"
+    gem.homepage = "http://github.com/bobes/presenter"
+    gem.authors = ["Vladimir Bobes Tuzinsky"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "presenter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,3 @@
+major: 0
+minor: 1
+patch: 0

data/lib/presenter.rb

@@ -0,0 +1,11 @@
+gem 'activesupport', '>= 2.3'
+
+require 'active_support'
+
+class Presenter
+end
+
+Dir[File.join(File.dirname(__FILE__), "presenter", "*.rb")].each do |file|
+  require file
+end
+

data/lib/presenter/core.rb

@@ -0,0 +1,98 @@
+class Presenter
+
+  module Core
+
+    def self.included(model)
+      model.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+  end
+
+  module ClassMethods
+
+    def key(*args)
+      key = Key.new(*args)
+      keys[key.name.to_sym] = key
+      create_accessors_for(key)
+    end
+
+    def presents(*names)
+      mixin = names.pop if names.last.is_a?(Module)
+      names.each { |name| create_finder_for(name, mixin) }
+    end
+
+    def keys
+      @keys ||= superclass.respond_to?(:keys) ? superclass.keys.dup : {}
+    end
+
+    private
+
+    def create_accessors_for(key)
+      module_eval <<-EOS, __FILE__, __LINE__ + 1
+        def #{key.name}
+          values.include?(:#{key.name}) ? values[:#{key.name}] : keys[:#{key.name}].default_value
+        end
+
+        def #{key.name}=(value)
+          values[:#{key.name}] = keys[:#{key.name}].typecast(value)
+        end
+
+        def #{key.name}?
+          #{key.name}.respond_to?(:empty?) ? !#{key.name}.empty? : !!#{key.name}
+        end
+      EOS
+    end
+
+    def create_finder_for(name, mixin = nil)
+      @mixins ||= {}
+      @mixins[name] = mixin
+      module_eval <<-EOS, __FILE__, __LINE__ + 1
+        def #{name}
+          @collections ||= {}
+          @collections[:#{name}] ||= wrap_#{name}(find_#{name})
+        end
+
+        private
+
+        def wrap_#{name}(items)
+          if mixin = self.class.instance_variable_get("@mixins")[:#{name}]
+            items.each { |item| item.extend(mixin) }
+          end
+          items
+        end
+
+        def find_#{name}
+          raise NotImplementedError.new("find_#{name} method not implemented")
+        end
+      EOS
+    end
+  end
+
+  module InstanceMethods
+
+    def initialize(params = nil)
+      if params
+        params.each do |name, value|
+          self.send "#{name}=", value if keys[name.to_sym]
+        end
+      end
+    end
+
+    def keys
+      self.class.keys
+    end
+
+    def values
+      @values ||= {}
+    end
+
+    def params
+      @values.delete_if { |key, value| value.nil? || (value.respond_to?(:empty?) && value.empty?) }
+    end
+  end
+
+  include Core
+end
+

data/lib/presenter/key.rb

@@ -0,0 +1,31 @@
+class Key
+
+  attr_accessor :name
+
+  def initialize(*args)
+    @options = args.last.is_a?(Hash) ? args.pop : {}
+    @name, @type = args.shift.to_s, args.shift || Object
+    @default_value = @options.delete(:default)
+    @options = nil if @type.method(:typecast).arity == 1
+  end
+
+  def typecast(value)
+    if value.is_a?(Array)
+      array = value.map { |v| typecast(v) }.compact
+      array.any? ? array : nil
+    elsif value.nil? || (value.respond_to?(:empty?) && value.empty?)
+      nil
+    else
+      @options ? @type.typecast(value, @options) : @type.typecast(value)
+    end
+  end
+
+  def default_value
+    value = @default_value.is_a?(Proc) ? @default_value.call : @default_value
+    @type.typecast(value)
+  end
+
+  def to_s
+    "#<Key: name=#{name}, type=#{type}>"
+  end
+end

data/lib/presenter/types.rb

@@ -0,0 +1,64 @@
+class Boolean
+
+  def self.typecast(value)
+    if ["true", "1"].include?(value.to_s.downcase)
+      true
+    elsif ["false", "0"].include?(value.to_s.downcase)
+      false
+    else
+      nil
+    end
+  end
+end
+
+class Float
+
+  def self.typecast(value)
+    value_to_f = value.to_f
+    value_to_f == 0 && value.to_s !~ /^0*\.?0+/ ? nil : value_to_f
+  end
+end
+
+class Integer
+
+  def self.typecast(value)
+    value_to_i = value.to_i
+    value_to_i == 0 && value.to_s !~ /^(0x|0b)?0+/ ? nil : value_to_i
+  end
+end
+
+class Object
+
+  def self.typecast(value)
+    value
+  end
+end
+
+class String
+
+  def self.typecast(value)
+    value.nil? ? nil : value.to_s
+  end
+end
+
+class Time
+
+  def self.typecast(value, options = {})
+    if value.is_a?(Time)
+      value
+    elsif value.is_a?(Hash)
+      Time.local(*value.values_at(:year, :month, :day, :hour, :minute, :second))
+    elsif value.is_a?(Date)
+      Time.local(value.year, value.month, value.day)
+    else
+      begin
+        dt = Date._strptime(value.to_s, options[:format] || "%a %b %d %H:%M:%S %Z %Y")
+        time = Time.local(dt[:year], dt[:mon], dt[:mday], dt[:hour], dt[:min], dt[:sec])
+        time += (time.utc_offset - dt[:offset]) if dt[:offset]
+        time
+      rescue StandardError => e
+        nil
+      end
+    end
+  end
+end

data/presenter.gemspec

@@ -0,0 +1,60 @@
+# 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{presenter}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Vladimir Bobes Tuzinsky"]
+  s.date = %q{2010-03-31}
+  s.description = %q{Simplifies usage of Presenter pattern in Rails}
+  s.email = %q{vladimir.tuzinsky@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/presenter.rb",
+     "lib/presenter/core.rb",
+     "lib/presenter/key.rb",
+     "lib/presenter/types.rb",
+     "presenter.gemspec",
+     "test/helper.rb",
+     "test/test_core.rb",
+     "test/test_key.rb",
+     "test/test_presenter.rb",
+     "test/test_types.rb"
+  ]
+  s.homepage = %q{http://github.com/bobes/presenter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simplifies usage of Presenter pattern in Rails}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_core.rb",
+     "test/test_key.rb",
+     "test/test_presenter.rb",
+     "test/test_types.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'presenter'
+
+class Test::Unit::TestCase
+
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".downcase
+    define_method(test_name, &block)
+  end
+end

data/test/test_core.rb

@@ -0,0 +1,142 @@
+require "helper"
+
+class TestCode < Test::Unit::TestCase
+
+  test "module can be included" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name
+    end
+    instance = klass.new
+    instance.name = "Fred"
+  end
+
+  test "key defines accessors" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name
+    end
+    instance = klass.new
+    instance.name = "Fred"
+    assert_equal "Fred", instance.name
+    assert_equal true, instance.name?
+  end
+
+  test "keys are inheritable" do
+    a = Class.new do
+      include Presenter::Core
+      key :name
+    end
+    b = Class.new(a) do
+      key :age
+    end
+    c = Class.new(a) do
+      key :role
+    end
+    assert a.keys[:name], b.keys[:name]
+    assert c.keys[:age].nil?
+  end
+
+  test "setter casts" do
+    klass = Class.new do
+      include Presenter::Core
+      Object.const_set :CustomType, Class.new
+      def CustomType.typecast(value)
+        value.to_s.reverse
+      end
+      key :name, CustomType
+    end
+    instance = klass.new
+    instance.name = "Fred"
+    assert_equal "derF", instance.name
+  end
+
+  test "accepts params in initializer" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name, String
+      key :age, Integer
+    end
+    instance = klass.new(:name => "Fred", "age" => "35")
+    assert_equal "Fred", instance.name
+    assert_equal 35, instance.age
+  end
+
+  test "getters return default values" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name, :default => "Unknown"
+    end
+    assert_equal "Unknown", klass.new.name
+  end
+
+  test "nil in params takes precendence before default value" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name, :default => "Unknown"
+    end
+    instance = klass.new :name => nil
+    assert_nil instance.name
+  end
+
+  test "getters cast default values" do
+    klass = Class.new do
+      include Presenter::Core
+      key :age, String, :default => 35
+    end
+    assert_equal "35", klass.new.age
+  end
+
+  test "default values support procs" do
+    age = Time.now.to_i
+    klass = Class.new do
+      include Presenter::Core
+      key :age, String, :default => lambda { age }
+    end
+    assert_equal age.to_s, klass.new.age
+  end
+
+  test "presents defines collection reader" do
+    klass = Class.new do
+      include Presenter::Core
+      presents :users
+      def find_users; ["user1", "user2"] end
+    end
+    assert_equal ["user1", "user2"], klass.new.users
+  end
+
+  test "collection readers cache finders results" do
+    klass = Class.new do
+      include Presenter::Core
+      presents :hits
+      def find_hits; @count ||= 0; @count += 1 end
+    end
+    assert_equal 1, klass.new.hits
+    assert_equal 1, klass.new.hits
+  end
+
+  test "collection readers can mixin module in items" do
+    mod = Module.new do
+      def name; "John Doe" end
+    end
+    klass = Class.new do
+      include Presenter::Core
+      presents :users, mod
+      def find_users; ["user1", "user2"] end
+    end
+    users = klass.new.users
+    assert_equal ["user1", "user2"], users
+    assert_equal "John Doe", users.first.name
+  end
+
+  test "params returns cleaned up value hash" do
+    klass = Class.new do
+      include Presenter::Core
+      key :name
+      key :age
+      key :role, :default => :guest
+    end
+    instance = klass.new :name => "John Doe"
+    assert_equal({ :name => "John Doe" }, instance.params)
+  end
+end

data/test/test_key.rb

@@ -0,0 +1,12 @@
+require "helper"
+
+class TestKey < Test::Unit::TestCase
+
+  test "cast to array" do
+    key = Key.new :name, String
+    assert_equal ["1", "2", "three"], key.typecast([1, "2", "three"])
+    assert_equal ["1", "three"], key.typecast([1, nil, "three"])
+    assert_equal nil, key.typecast([""])
+    assert_equal nil, key.typecast([nil])
+  end
+end

data/test/test_presenter.rb

@@ -0,0 +1,8 @@
+require "helper"
+
+class TestPresenter < Test::Unit::TestCase
+
+  test "includes Core" do
+    assert Presenter.constants.include?("Core")
+  end
+end

data/test/test_types.rb

@@ -0,0 +1,48 @@
+require "helper"
+
+class TestTypes < Test::Unit::TestCase
+
+  test "cast to boolean" do
+    assert_equal true, Boolean.typecast(true)
+    assert_equal true, Boolean.typecast("true")
+    assert_equal true, Boolean.typecast(1)
+    assert_equal true, Boolean.typecast("1")
+    assert_equal false, Boolean.typecast(false)
+    assert_equal false, Boolean.typecast("false")
+    assert_equal false, Boolean.typecast(0)
+    assert_equal false, Boolean.typecast("0")
+    assert_nil Boolean.typecast(123)
+    assert_nil Boolean.typecast("huh?")
+  end
+
+  test "cast to float" do
+    assert_equal 35.5, Float.typecast("35.5")
+    assert_nil Float.typecast("huh?")
+  end
+
+  test "cast to integer" do
+    assert_equal 35, Integer.typecast(35)
+    assert_equal 35, Integer.typecast("35")
+    assert_equal 35, Integer.typecast("35.5")
+    assert_nil Integer.typecast("huh?")
+  end
+
+  test "cast to string" do
+    assert_equal "35", String.typecast(35)
+    assert_equal "true", String.typecast(true)
+    assert_equal "false", String.typecast(false)
+    assert_equal "anything", String.typecast("anything")
+    assert_nil String.typecast(nil)
+  end
+
+  test "cast to time" do
+    assert_equal Time.local(2009, 12, 28, 10, 35, 25), Time.typecast({
+      :year => "2009", :month => "12", :day => "28", :hour => "10", :minute => "35", :second => "25"
+    })
+    assert_equal Time.utc(2009, 12, 28, 9, 35, 25), Time.typecast("Mon Dec 28 11:35:25 +0200 2009")
+    assert_equal Time.local(2009, 12, 28, 9, 35), Time.typecast("28/12/2009 09:35", :format => "%d/%m/%Y %H:%M")
+    assert_equal Time.local(2009, 12, 28, 10, 35, 25), Time.typecast(Time.local(2009, 12, 28, 10, 35, 25))
+    assert_equal Time.utc(2009, 12, 28, 10, 35, 25), Time.typecast(Time.utc(2009, 12, 28, 10, 35, 25))
+    assert_equal Time.local(2009, 12, 28), Time.typecast(Date.new(2009, 12, 28))
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: presenter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Vladimir Bobes Tuzinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-31 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Simplifies usage of Presenter pattern in Rails
+email: vladimir.tuzinsky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/presenter.rb
+- lib/presenter/core.rb
+- lib/presenter/key.rb
+- lib/presenter/types.rb
+- presenter.gemspec
+- test/helper.rb
+- test/test_core.rb
+- test/test_key.rb
+- test/test_presenter.rb
+- test/test_types.rb
+has_rdoc: true
+homepage: http://github.com/bobes/presenter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simplifies usage of Presenter pattern in Rails
+test_files: 
+- test/helper.rb
+- test/test_core.rb
+- test/test_key.rb
+- test/test_presenter.rb
+- test/test_types.rb