model_presenter 0.0.6 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### Version 0.1.0
+
+1. Add ```moneyize``` helper
+1. Add ```it_moneyize``` rspec test helper 

data/README.md

@@ -1,6 +1,7 @@
 # ModelPresenter
 
 [![Build Status](https://secure.travis-ci.org/ywen/model_presenter.png)](http://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.
 
@@ -80,6 +81,24 @@ 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.
 
+## Moneyize
+
+The presenter comes with a small helper for format the money. The usage:
+
+```ruby
+class User
+  include ModelPresenter::Base
+  forward_from_model :amount_remains
+  moneyize :amount_remains
+end
+```
+
+What ```moneyize``` does it to define a new method ```formatted_amount_remains``` and return a formatted dollar display string.
+
+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```
+
 ## 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:
@@ -99,6 +118,7 @@ And in a presenter test, you can do:
 describe User do
   forward_from_model_attributes :first_name, :last_name, :email
   as_json_attributes :first_name, :gender
+  it_moneyize :amount_remains, :some_other_money_field
 end
 ```
 
@@ -115,7 +135,7 @@ User
     returns the model.email
 ```
 
-and ```as_json_attributes``` macro will generate the following tests:
+```as_json_attributes``` macro will generate the following tests:
 
 ```rspec
 
@@ -124,6 +144,15 @@ and ```as_json_attributes``` macro will generate the following tests:
     has the key gender with value set to presenter.gender
 ```
 
+```it_moneyize``` macro will generate the following tests:
+
+```rspec
+  #formatted_amount_remains
+    returns the formatted money in dollar
+  #formatted_some_other_money_field
+    returns the formatted money in dollar
+```
+
 ## Contributing
 
 1. Fork it

data/lib/model_presenter/base.rb

@@ -1,6 +1,8 @@
 require 'json/ext'
 require 'model_presenter/forward_from_model'
 require 'model_presenter/as_json'
+require 'model_presenter/money'
+require 'model_presenter/moneyize'
 module ModelPresenter
   module Base 
     attr_reader :model
@@ -8,6 +10,7 @@ module ModelPresenter
     def self.included(mod)
       mod.extend ForwardFromModel
       mod.extend AsJson
+      mod.extend Moneyize
     end
 
     def initialize(model)

data/lib/model_presenter/money.rb

@@ -0,0 +1,14 @@
+module ModelPresenter
+  class Money
+    attr_reader :amount_in_cents
+
+    def initialize(amount_in_cents)
+      @amount_in_cents = amount_in_cents
+    end
+
+    def to_dollar
+      amount_in_dollar = amount_in_cents.to_f / 100
+      '%.2f' % amount_in_dollar
+    end
+  end
+end

data/lib/model_presenter/moneyize.rb

@@ -0,0 +1,11 @@
+module ModelPresenter
+  module Moneyize
+    def moneyize(*fields)
+      fields.each do |field|
+        define_method "formatted_#{field}" do
+          "$ #{Money.new(send(field)).to_dollar}"
+        end
+      end
+    end
+  end
+end

data/lib/model_presenter/version.rb

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

data/lib/model_presenter.rb

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

data/spec/support/macros/it_moneyize.rb

@@ -0,0 +1,15 @@
+module Macros
+  module System
+    def it_moneyize(*fields)
+      fields.each do |field|
+        describe "#formatted_#{field}" do
+          let(:expected) { subject.send("formatted_#{field}") }
+          let(:actual) { "$ #{subject.send(field).to_f/100}" }
+          it "returns the formatted money in dollar" do
+            expect(expected).to eq( actual )
+          end
+        end
+      end
+    end
+  end
+end

data/test/model_presenter/base_test.rb

@@ -16,12 +16,19 @@ module ModelPresenter
         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 ".moneyize" do
+      it "responds to .moneyize" do
+        klass.must_respond_to :moneyize
+      end
+    end
+
     describe "#to_json" do
       before(:each) do
         subject.stubs(:as_json).returns(:attr1 => "value1", :attr2 => "value2")

data/test/model_presenter/money_test.rb

@@ -0,0 +1,31 @@
+require_relative "../test_helper"
+
+module ModelPresenter
+  describe Money do
+    describe "#to_dollar" do
+      subject { Money.new 56789 }
+
+      context "cents: 56789" do
+        it "returns dollor amount" do
+          subject.to_dollar.must_equal("567.89")
+        end
+      end
+
+      context "cents: 56700" do
+        subject { Money.new 56700 }
+
+        it "returns dollor amount" do
+          subject.to_dollar.must_equal("567.00")
+        end
+      end
+
+      context "cents: 56760" do
+        subject { Money.new 56760 }
+
+        it "returns dollor amount" do
+          subject.to_dollar.must_equal("567.60")
+        end
+      end
+    end
+  end
+end

data/test/model_presenter/moneyize_test.rb

@@ -0,0 +1,24 @@
+require_relative "../test_helper"
+
+module ModelPresenter
+  describe Moneyize do
+    let(:presenter_class) do
+      Class.new do
+        extend Moneyize
+        moneyize :field1, :field2
+
+        def field1; 45678; end
+        def field2; 76590; end
+      end
+    end
+    subject { presenter_class.new }
+
+    describe ".moneyize" do
+      it "generates method to return the formmated dollar amount" do
+        subject.formatted_field1.must_equal("$ 456.78")
+        subject.formatted_field2.must_equal("$ 765.90")
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_presenter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -151,6 +151,7 @@ files:
 - .rbenv-version
 - .rvmrc.template
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -160,16 +161,21 @@ files:
 - lib/model_presenter/as_json.rb
 - lib/model_presenter/base.rb
 - lib/model_presenter/forward_from_model.rb
+- lib/model_presenter/money.rb
+- lib/model_presenter/moneyize.rb
 - lib/model_presenter/spec_support.rb
 - lib/model_presenter/version.rb
 - lib/spec_support.rb
 - model_presenter.gemspec
 - spec/support/macros/as_json.rb
 - spec/support/macros/forward_from_model.rb
+- spec/support/macros/it_moneyize.rb
 - 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/model_presenter/money_test.rb
+- test/model_presenter/moneyize_test.rb
 - test/support/mock_base_class.rb
 - test/support/mock_model_object.rb
 - test/test_helper.rb
@@ -200,9 +206,12 @@ summary: Provides an implementation of Presenter pattern
 test_files:
 - spec/support/macros/as_json.rb
 - spec/support/macros/forward_from_model.rb
+- spec/support/macros/it_moneyize.rb
 - test/model_presenter/as_json_test.rb
 - test/model_presenter/base_test.rb
 - test/model_presenter/forward_from_model_test.rb
+- test/model_presenter/money_test.rb
+- test/model_presenter/moneyize_test.rb
 - test/support/mock_base_class.rb
 - test/support/mock_model_object.rb
 - test/test_helper.rb