encapsulate_as_money 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 871fc3992a7bc06f07246f53da916ac9488782a5
+  data.tar.gz: cfb3f79877ec1b350bd984235f57126051840ef7
+SHA512:
+  metadata.gz: 11fd7c0c1ea70da59ea3ec0a19e6771cbcac143b63ea1e6c35fe81f2aaa4f3e0f058ecf64bc9a277d4a481c8f6a9be145a1482b99597395d6f59e42b0eaafc10
+  data.tar.gz: 9e2dd5dd3a400dea78ac0bf13c0c44d5b2ce1775fe824942e81d340d2580588f528597415764d996495122892fbb57f2e3a9c52be1c55fd1114f28a5e0b4c048

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+bin/
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 1.9.3
+notifications:
+  email:
+    recipients:
+      - orien@envato.com

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Envato
+
+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,71 @@
+# EncapsulateAsMoney
+[![Build Status](https://travis-ci.org/envato/encapsulate_as_money.svg?branch=master)](https://travis-ci.org/envato/encapsulate_as_money)
+
+Want your model attribute to be a [Money](https://github.com/RubyMoney/money)
+instance? EncapsulateAsMoney provides a simple way to get this done!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'encapsulate_as_money'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Rails
+
+Add the `encapsulate_as_money` method to the Active Record base class.
+
+```ruby
+ActiveRecord::Base.extend(EncapsulateAsMoney)
+```
+
+Now say you have the model:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  encapsulate_as_money :amount
+end
+```
+
+Which is based on the database table:
+
+```ruby
+create_table "my_models" do |table|
+  table.integer "amount"
+end
+```
+
+Now we can create and save an instance like:
+
+```ruby
+MyModel.create!(amount: 5.dollars)
+```
+
+This will create a row as such:
+
+| id | amount |
+| --:| ------:|
+|  1 |    500 |
+
+Note the value is represented as cents.
+
+Once persisted we can find the value like:
+
+```ruby
+MyModel.find_by_id(1).amount #=> 5.dollars
+```
+
+Note that it uses the default Money currency.
+
+## Contributing
+
+1. Fork it ( https://github.com/envato/encapsulate_as_money/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :spec
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.test_files = Dir.glob("spec/**/*_spec.rb")
+end

data/encapsulate_as_money.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "encapsulate_as_money/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "encapsulate_as_money"
+  spec.version       = EncapsulateAsMoney::VERSION
+  spec.authors       = ["Anthony Sellitti", "Orien Madgwick", "Keith Pitt", "Martin Jagusch", "Mark Turnley", "Pete Yandall"]
+  spec.email         = ["anthony.sellitti@envato.com", "_@orien.io", "me@keithpitt.com", "_@mj.io", "mark@envato.com", "pete@envato.com"]
+  spec.summary       = "Represent model attributes as Money instances"
+  spec.homepage      = "https://github.com/envato/encapsulate_as_money"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "money", ">= 5.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-given"
+  spec.add_development_dependency "yard"
+end

data/lib/encapsulate_as_money.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require "encapsulate_as_money/version"
+require "money"
+
+module EncapsulateAsMoney
+  def encapsulate_as_money(*attributes)
+    options = extract_options(attributes)
+    attributes.each do |attribute|
+      encapsulate_attribute_as_money(attribute, options[:preserve_nil])
+    end
+  end
+
+private
+
+  def encapsulate_attribute_as_money(attribute, preserve_nil = true)
+    if preserve_nil
+      define_method attribute do
+        Money.new(super()) if super()
+      end
+    else
+      define_method attribute do
+        Money.new(super() || 0)
+      end
+    end
+
+    define_method "#{attribute}=" do |money|
+      super(money && money.fractional)
+    end
+  end
+
+  def extract_options(args)
+    args.last.is_a?(Hash) ? args.pop : {}
+  end
+end

data/lib/encapsulate_as_money/version.rb

@@ -0,0 +1,3 @@
+module EncapsulateAsMoney
+  VERSION = "0.1"
+end

data/spec/encapsulate_as_money_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe EncapsulateAsMoney do
+
+  Given(:model_base_class_with_attr) {
+    Class.new {
+      extend EncapsulateAsMoney
+      attr_accessor :attribute
+    }
+  }
+  Given(:model_instance) { model_class.new }
+  Given!(:init_attr_value) { model_instance.instance_variable_set :@attribute, initial_attr_value }
+
+  describe "encapsulating the attribute as money" do
+    When(:model_class) {
+      Class.new(model_base_class_with_attr) {
+        encapsulate_as_money :attribute
+      }
+    }
+
+    context "initial value is nil" do
+      Given(:initial_attr_value) { nil }
+      Then { model_instance.attribute == Money.new(0) }
+    end
+
+    context "initial value is 0" do
+      Given(:initial_attr_value) { 0 }
+      Then { model_instance.attribute == Money.new(0) }
+    end
+
+    context "initial value is 1" do
+      Given(:initial_attr_value) { 1 }
+      Then { model_instance.attribute == Money.new(1) }
+    end
+  end
+
+  describe "encapsulating the attribute as money, preserving nil" do
+    When(:model_class) {
+      Class.new(model_base_class_with_attr) {
+        encapsulate_as_money :attribute, :preserve_nil => true
+      }
+    }
+
+    context "initial value is nil" do
+      Given(:initial_attr_value) { nil }
+      Then { model_instance.attribute == nil }
+    end
+
+    context "initial value is 0" do
+      Given(:initial_attr_value) { 0 }
+      Then { model_instance.attribute == Money.new(0) }
+    end
+
+    context "initial value is 1" do
+      Given(:initial_attr_value) { 1 }
+      Then { model_instance.attribute == Money.new(1) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require "encapsulate_as_money"
+require "minitest/autorun"
+require "minitest/given"
+require "minitest/pride"
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: encapsulate_as_money
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Anthony Sellitti
+- Orien Madgwick
+- Keith Pitt
+- Martin Jagusch
+- Mark Turnley
+- Pete Yandall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- anthony.sellitti@envato.com
+- _@orien.io
+- me@keithpitt.com
+- _@mj.io
+- mark@envato.com
+- pete@envato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- encapsulate_as_money.gemspec
+- lib/encapsulate_as_money.rb
+- lib/encapsulate_as_money/version.rb
+- spec/encapsulate_as_money_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/envato/encapsulate_as_money
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Represent model attributes as Money instances
+test_files:
+- spec/encapsulate_as_money_spec.rb
+- spec/spec_helper.rb
+has_rdoc: