model_presenter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rvmrc.template

@@ -0,0 +1 @@
+rvm 1.9.3@model_presenter

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: "bundle exec rake test"
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in model_presenter.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?(.*)_test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| [ "lib/#{m[1]}#{m[2]}.rb", "test/#{m[1]}#{m[2]}_test.rb" ] }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yi Wen
+
+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,79 @@
+# ModelPresenter
+
+[![Build Status](https://secure.travis-ci.org/ywen/model_presenter.png)](http://travis-ci.org/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.
+
+The gem is not trying to provide a automagic way to look cool. Rather, it focuses on explicitly expressing the intent of a Presenter class. Please read the usage for the details
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'model_presenter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install model_presenter
+
+## Usage
+
+An example presenter that uses the ```ModelPresenter::Base```
+
+```ruby
+
+class User
+  include ModelPresenter::Base
+  forward_from_model :last_name, :first_name, :email
+  json_properties :name, :gender, :email
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+
+  def gender
+    model.gender == "M" ? "Male" : "Female"
+  end
+end
+```
+
+The ```forward_from_model``` defines methods ```attr1``` and ```attr2``` which calls the ```model.attr1``` ```model.attr2``` respectively.
+
+The ```json_properties``` defines methods ```as_json```  which returns a hash in which the keys are the properties being passed in the ```json_properties``` and the value of a given property the ```presenter_object.property```
+
+An example output of ```as_json``` returns:
+
+```json
+
+{
+  name: "John Smith",
+  gender: "Male",
+  email: "jsmith@example.com"
+}
+```
+
+Then one can use ```presenter_object.to_json``` to serilize it into a JSON string.
+
+A presenter instance can be initialized with 
+
+```ruby
+
+user = User.new(user_model)
+user.to_json
+```
+
+It always takes a model object as the only argument in the initializer. The model object is referred from within the presenter as ```presenter.model```. It is a private attribute reader.
+
+## 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,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require File.expand_path(File.dirname(__FILE__))+'/tasks/test'

data/lib/model_presenter.rb

@@ -0,0 +1,5 @@
+require "model_presenter/version"
+require 'model_presenter/base'
+
+module ModelPresenter
+end

data/lib/model_presenter/as_json.rb

@@ -0,0 +1,11 @@
+module ModelPresenter
+  module AsJson
+    def json_properties(*properties)
+      self.send :define_method, :as_json do |options = {}|
+        properties.inject({}) do |results, property|
+          results.merge! property => send(property)
+        end
+      end
+    end
+  end
+end

data/lib/model_presenter/base.rb

@@ -0,0 +1,21 @@
+require 'json/ext'
+require 'model_presenter/forward_from_model'
+require 'model_presenter/as_json'
+module ModelPresenter
+  module Base 
+    attr_reader :model
+    private :model
+    def self.included(mod)
+      mod.extend ForwardFromModel
+      mod.extend AsJson
+    end
+
+    def initialize(model)
+      @model = model
+    end
+
+    def to_json(options={})
+      JSON(as_json(options))
+    end
+  end
+end

data/lib/model_presenter/forward_from_model.rb

@@ -0,0 +1,11 @@
+module ModelPresenter
+  module ForwardFromModel
+    def forward_from_model(*attributes)
+      attributes.each do |attr|
+        self.send :define_method, attr do
+          model.send(attr)
+        end
+      end
+    end
+  end
+end

data/lib/model_presenter/version.rb

@@ -0,0 +1,3 @@
+module ModelPresenter
+  VERSION = "0.0.1"
+end

data/model_presenter.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/model_presenter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yi Wen"]
+  gem.email         = ["hayafirst@gmail.com"]
+  gem.description   = %q{Provides an implementation of Presenter pattern, but without needs fo Rails}
+  gem.summary       = %q{Provides an implementation of Presenter pattern}
+  gem.homepage      = ""
+
+  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          = "model_presenter"
+  gem.require_paths = ["lib"]
+  gem.version       = ModelPresenter::VERSION
+  gem.add_runtime_dependency(%q<json>)
+  gem.add_development_dependency(%q<minitest>)
+  gem.add_development_dependency(%q<minitest-growl>)
+  gem.add_development_dependency(%q<guard-minitest>)
+  gem.add_development_dependency(%q<minitest-wscolor>)
+  gem.add_development_dependency(%q<cane>)
+  gem.add_development_dependency(%q<rake>)
+  gem.add_development_dependency(%q<mocha>)
+  gem.add_development_dependency(%q<minitest-spec-context>)
+end

data/tasks/test.rb

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/test/model_presenter/as_json_test.rb

@@ -0,0 +1,33 @@
+require_relative "../test_helper"
+
+module ModelPresenter
+  describe AsJson do
+    let(:klass) {
+      ModelPresenter::TestHelpers.mock_base_class.tap do |c|
+        c.send :extend, AsJson
+        c.send :json_properties, :attr1, :attr2
+        c.send :define_method, :attr1 do 
+          "value1" 
+        end
+        c.send :define_method, :attr2 do 
+          "value2"
+        end
+      end
+    }
+    let(:object) { Object.new }
+    subject {klass.new object}
+    describe ".json_properties" do
+      it "generates as_json method" do
+        subject.must_respond_to :as_json
+      end
+    end
+    describe "#as_json" do
+      let(:result) { subject.as_json }
+      { :attr1 => "value1", :attr2 => "value2" }.each do |key, value|
+        it "generates a JSON contains the key ''#{key}' with the value '#{value}' " do
+          result[key].must_equal value
+        end
+      end
+    end
+  end
+end

data/test/model_presenter/base_test.rb

@@ -0,0 +1,35 @@
+require_relative '../test_helper'
+
+module ModelPresenter
+  describe Base do
+    let(:klass) {
+      Class.new do
+        include Base 
+        json_properties :attr1, :attr2
+      end
+    }
+
+    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 ".json_properties" do
+      it "responds to .json_properties" do
+        klass.must_respond_to :json_properties
+      end
+    end
+
+    describe "#to_json" do
+      before(:each) do
+        subject.stubs(:as_json).returns(:attr1 => "value1", :attr2 => "value2")
+      end
+      
+      it "convert the as_json hash to JSON string" do
+        subject.to_json.must_equal JSON(:attr1 => "value1", :attr2 => "value2")
+      end
+    end
+  end
+end

data/test/model_presenter/forward_from_model_test.rb

@@ -0,0 +1,33 @@
+require_relative '../test_helper'
+
+module ModelPresenter
+  describe ForwardFromModel do
+    let(:klass) {
+      ModelPresenter::TestHelpers.mock_base_class.tap do |c|
+        c.send :extend, ForwardFromModel
+        c.send :forward_from_model, :attr1, :attr2
+      end
+    }
+    let(:object) {  ModelPresenter::TestHelpers.mock_model_object }
+
+    subject { klass.new object }
+
+    describe ".forward_from_model" do
+      { :attr1 => "value1", :attr2 => "value2" }.each do |key, value|
+        it "generates the method #{key} and returns #{value}" do
+          subject.send(key).must_equal(value)
+        end
+      end
+
+      context "when passing in a method that doesn't exist in the model object" do
+        before(:each) do
+          klass.send :forward_from_model, :attr3
+        end
+        
+        it "raises an exception" do
+          lambda{subject.attr3}.must_raise(NoMethodError)
+        end
+      end
+    end
+  end
+end

data/test/support/mock_base_class.rb

@@ -0,0 +1,13 @@
+module ModelPresenter
+  module TestHelpers
+    def self.mock_base_class
+      Class.new do
+        attr_reader :model
+        private :model
+        def initialize(model)
+          @model = model
+        end
+      end
+    end
+  end
+end

data/test/support/mock_model_object.rb

@@ -0,0 +1,15 @@
+module ModelPresenter
+  module TestHelpers
+    def self.mock_model_object
+      Class.new do
+        def attr1
+          "value1"
+        end
+        def attr2
+          "value2"
+        end
+      end.new
+    end
+  end
+end
+

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: model_presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yi Wen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 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
+        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-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: cane
+  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
+  Rails
+email:
+- hayafirst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.template
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/model_presenter.rb
+- lib/model_presenter/as_json.rb
+- lib/model_presenter/base.rb
+- lib/model_presenter/forward_from_model.rb
+- lib/model_presenter/version.rb
+- model_presenter.gemspec
+- tasks/test.rb
+- test/model_presenter/as_json_test.rb
+- test/model_presenter/base_test.rb
+- test/model_presenter/forward_from_model_test.rb
+- test/support/mock_base_class.rb
+- test/support/mock_model_object.rb
+- test/test_helper.rb
+homepage: ''
+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.21
+signing_key: 
+specification_version: 3
+summary: Provides an implementation of Presenter pattern
+test_files:
+- test/model_presenter/as_json_test.rb
+- test/model_presenter/base_test.rb
+- test/model_presenter/forward_from_model_test.rb
+- test/support/mock_base_class.rb
+- test/support/mock_model_object.rb
+- test/test_helper.rb