model_presenter 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 429c04dd2b9686d6c43f00aadc27f6995410e85f
+  data.tar.gz: 40449ce36dd77e9eec0ab2be8f5b312fe060f3ba
+SHA512:
+  metadata.gz: 193ece5e0a998f6bf4bcf2fadce285a87f7e20889da8e3314b9e51941a5aa69c23adce184e33012a764a6efbbc8ea10dbca1da02626d720a50cfd4034101440d
+  data.tar.gz: 8de75ce08a254ab6c91bc8627956130814087cdfc23330242d7c0d0c356cdcc86b15ff77166a259e8a648d3553b5f768ae62f7e076dcaff7ffa40531adb58842

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 script: "bundle exec rake test"
 rvm:
   - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### Version 0.1.1
+
+1. Add ```has_many``` macro
+
 ### Version 0.1.0
 
 1. Add ```moneyize``` helper

data/README.md

@@ -1,8 +1,9 @@
 # ModelPresenter
 
-[![Build Status](https://secure.travis-ci.org/ywen/model_presenter.png)](http://travis-ci.org/ywen/model_presenter)
+[![Build Status](https://travis-ci.org/ywen/model_presenter.png?branch=master)](https://travis-ci.org/ywen/model_presenter)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ywen/model_presenter)
 
+
 ModelPresenter provides basic framework in creating a presenter. The goal of the gem is that the presenter can be used in any Ruby projects that feel it needs to use this pattern, not limited to Rails projects.
 
 The presenter puts more emphasis on JSON representation of a business model object. But it can be used in classic HTML view just as easy.
@@ -29,10 +30,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install model_presenter
-
 ## Usage
 
 An example presenter that uses the ```ModelPresenter::Base```
@@ -99,6 +96,23 @@ NOTE: the ```amount_remains``` is supposed to be the amount in cents
 
 So assuming ```amount_remains``` is ```46780```. The ```formatted_amount_remains``` returns ```$ 467.80```
 
+## has_many
+
+The presenter can define a ```has_many``` relationship
+
+```ruby
+class User
+  include ModelPresenter::Base
+  has_many :groups, presenter_class: Presenters::Group
+end
+```
+
+The macro will generates a ```groups``` methods, which will return an array. Each element of the array is an instance of ```Presenters::Group``` whose ```model``` is one of the group models that the user has.
+
+## Convention for Using with Rails
+
+In a Rails controller, I always initialize one and only one instance variable for using in the view - an instance of a Presenter class. The presenter has all necessary logic to make the view as dumb as possible. And all the logic can be unit tested just like any PORO, make your testing effort easy and enjoyable.
+
 ## Rspec Macros
 
 The gem provides some rspec macros for speeding up your test effort for your presenters. To use it, in your ```spec_helper.rb``` among your other setup:

data/lib/model_presenter/base.rb

@@ -3,14 +3,17 @@ require 'model_presenter/forward_from_model'
 require 'model_presenter/as_json'
 require 'model_presenter/money'
 require 'model_presenter/moneyize'
+require 'model_presenter/has_many'
+
 module ModelPresenter
-  module Base 
+  module Base
     attr_reader :model
     private :model
     def self.included(mod)
       mod.extend ForwardFromModel
       mod.extend AsJson
       mod.extend Moneyize
+      mod.extend HasMany
     end
 
     def initialize(model)

data/lib/model_presenter/has_many.rb

@@ -0,0 +1,32 @@
+module ModelPresenter
+  module HasMany
+    # The DSL adds an instance method +relation+ to represnet a +has_many+ relationship
+    #
+    #
+    #     class User
+    #       include ModelPresenter::Base
+    #       has_many :groups, presenter_class: Presenters::Group
+    #     end
+    #
+    # The macro will generates a +groups+ methods, which will return an array. Each element of the array is an instance of +Presenters::Group+ whose +model+ is one of the group models that the user has.
+    #
+    # @param [Symbol, #read] relation the name of the relationship
+    # @param [Hash, #read] options Currently it accepts one key +presenter_class+ is a class. The class is supposed to be a presenter class. The +relation+ method will return an array of elements that are instances of the class
+    #
+    # @return none
+    def has_many(relation, options)
+      self.send :define_method, relation do
+        instance_variable_name = "@#{relation}"
+        instance_variable = instance_variable_get("@#{relation}")
+        return instance_variable if instance_variable
+        instance_variable_set(
+          instance_variable_name,
+          model.send(relation).map do |relation_model|
+            options[:presenter_class].new relation_model
+          end
+        )
+      end
+    end
+  end
+end
+

data/lib/model_presenter/version.rb

@@ -1,3 +1,3 @@
 module ModelPresenter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/model_presenter/base_test.rb

@@ -11,12 +11,19 @@ module ModelPresenter
 
     let(:object) {  ModelPresenter::TestHelpers.mock_model_object }
     subject { klass.new object }
+
     describe ".forward_from_model" do
       it "responds to .forward_from_model" do
         klass.must_respond_to :forward_from_model
       end
     end
 
+    describe ".has_many" do
+      it "responds to .has_many" do
+        klass.must_respond_to :has_many
+      end
+    end
+
     describe ".json_properties" do
       it "responds to .json_properties" do
         klass.must_respond_to :json_properties

data/test/model_presenter/forward_from_model_test.rb

@@ -23,7 +23,7 @@ module ModelPresenter
         before(:each) do
           klass.send :forward_from_model, :attr3
         end
-        
+
         it "raises an exception" do
           lambda{subject.attr3}.must_raise(NoMethodError)
         end

data/test/model_presenter/has_many_test.rb

@@ -0,0 +1,51 @@
+require_relative '../test_helper'
+
+module ModelPresenter
+  describe HasMany do
+    describe ".has_many" do
+      subject { klass.new object }
+
+      let(:relationship_class) {
+        Class.new do
+          include ModelPresenter::Base
+        end
+      }
+
+      let(:klass) {
+        ModelPresenter::TestHelpers.mock_base_class.tap do |c|
+          c.send :extend, HasMany
+          c.send :has_many, :test_relationships, presenter_class: relationship_class
+        end
+      }
+      let(:object) {  ModelPresenter::TestHelpers.mock_model_object }
+      let(:test_relationship1) { stub :test_relationship1 }
+      let(:test_relationship2) { stub :test_relationship2 }
+
+      before(:each) do
+        object.stubs(:test_relationships).returns([test_relationship1, test_relationship2])
+      end
+
+      it "creates a test_relationships method" do
+        subject.must_respond_to :test_relationships
+      end
+
+      it "returns an array of objects" do
+        subject.test_relationships.size.must_equal 2
+      end
+
+      it "returns presenter version for each array member" do
+        relationship_class.expects(:new).with(test_relationship1).returns "presenter1"
+        relationship_class.expects(:new).with(test_relationship2).returns "presenter2"
+        subject.test_relationships.must_equal ["presenter1", "presenter2"]
+      end
+
+      it "caches the array" do
+        relationship_class.expects(:new).with(test_relationship1).returns "presenter1"
+        relationship_class.expects(:new).with(test_relationship2).returns "presenter2"
+        subject.test_relationships
+        relationship_class.expects(:new).never
+        subject.test_relationships.must_equal ["presenter1", "presenter2"]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,6 +3,6 @@ gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/wscolor'
 require 'minitest-spec-context'
-require 'mocha'
+require 'mocha/setup'
 require 'model_presenter'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: model_presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Yi Wen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -46,97 +41,85 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-growl
   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: guard-minitest
   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: minitest-wscolor
   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: 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: mocha
   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: minitest-spec-context
   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'
 description: Provides an implementation of Presenter pattern, but without needs fo
@@ -149,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rbenv-version
+- .ruby-version
 - .rvmrc.template
 - .travis.yml
 - CHANGELOG.md
@@ -161,6 +145,7 @@ files:
 - lib/model_presenter/as_json.rb
 - lib/model_presenter/base.rb
 - lib/model_presenter/forward_from_model.rb
+- lib/model_presenter/has_many.rb
 - lib/model_presenter/money.rb
 - lib/model_presenter/moneyize.rb
 - lib/model_presenter/spec_support.rb
@@ -174,6 +159,7 @@ files:
 - test/model_presenter/as_json_test.rb
 - test/model_presenter/base_test.rb
 - test/model_presenter/forward_from_model_test.rb
+- test/model_presenter/has_many_test.rb
 - test/model_presenter/money_test.rb
 - test/model_presenter/moneyize_test.rb
 - test/support/mock_base_class.rb
@@ -181,27 +167,26 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/ywen/model_presenter
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides an implementation of Presenter pattern
 test_files:
 - spec/support/macros/as_json.rb
@@ -210,6 +195,7 @@ test_files:
 - test/model_presenter/as_json_test.rb
 - test/model_presenter/base_test.rb
 - test/model_presenter/forward_from_model_test.rb
+- test/model_presenter/has_many_test.rb
 - test/model_presenter/money_test.rb
 - test/model_presenter/moneyize_test.rb
 - test/support/mock_base_class.rb