acts_as_price 0.1.0

data/Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.7'
+
+#only use in test envirnoment
+group :test do
+	gem 'rspec-rails'
+	gem 'shoulda-matchers'
+	gem 'autotest'
+	gem 'autotest-growl'
+	gem 'rcov'
+	gem 'metrical'
+	gem 'activerecord-nulldb-adapter'
+end
+group :development do
+	gem "jeweler", "~> 1.5.2"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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,60 @@
+=INSTALLATION
+rails plugin install git@github.com:jeroeningen/acts_as_price.git
+
+=USAGE
+Create a column in the table of your database which you want to acts as a price. 
+
+NOTE THAT THE COLUMN MUST BE OF THE TYPE INTEGER.
+
+In your model add the following:
+- acts_as_price column_name, :validates = true
+
+column_name is the name of your database column e.g. price or price_per_liter.
+
+validates is optional and add validation to the column
+
+This plugin creates the following getters and setters:
+- 'price_in_cents' and '<column_name>_in_cents' #sets and returns the price in cents
+- 'price' and '<column_name>' #sets and returns the price
+
+=EXAMPLES
+car = Car.new :price => 12999
+
+car.price #12999.00
+
+car.price_in_cents #1299900
+
+fuel = Fueltype.new :price_per_liter => 1.12
+
+fuel.price #1.12
+
+fuel.price_in_cents #112
+
+fuel.price_per_liter #1.12
+
+fuel.price_per_liter_in_cents #1.12
+
+=RSPEC INTERGRATION
+Acts As Price comes with a helper method to automatically test the plugin using Rspec.
+
+To use this method please add the following to your spec_helper.rb file:
+- config.include(ActsAsPriceHelper)
+Now you may add the following code to your spec-files for your models:
+  context "given an valid model" do
+    it "should acts as price" do
+      test_acts_as_price_methods <column_name>, <fixture or stub>
+    end
+  end
+
+=TESTING
+To test the plugin use the command 'rake test' or 'rspec spec/*_spec.rb' inside the dir '~/vendor/plugins/acts_as_price' 
+
+=KNOWN BUGS
+The acts_as_price plugin does not accept comma-seperated prices at the moment.
+
+=NOTES
+This plugin comes with Rspec tests. 
+However this plugin assumes that you have a database configuration, it actually don't use the database for the Rspec tests.
+
+=FEEDBACK AND BUGS REPORTS
+For feedback and bug reports contact: jeroeningen@gmail.com

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_price plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_price plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsPrice'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_price"
+    gem.homepage = "http://github.com/jeroeningen/acts_as_price"
+    gem.license = "MIT"
+    gem.summary = %Q{A specified database column acts as a price}
+    gem.description = %Q{A specified database column acts as a price and creates on the fly methods like 'price' and 'price_in_cents'. For more information visit: http://github.com/jeroeningen/acts_as_price}
+    gem.email = "jeroeningen@gmail.com"
+    gem.authors = ["Jeroen van Ingen"]
+    gem.add_runtime_dependency 'rails', '3.0.7'
+    gem.add_development_dependency 'rspec-rails'
+    gem.add_development_dependency 'shoulda-matchers'
+    gem.add_development_dependency 'autotest'
+    gem.add_development_dependency 'autotest-growl'
+    gem.add_development_dependency 'rcov'
+    gem.add_development_dependency 'metrical'
+    gem.add_development_dependency 'activerecord-nulldb-adapter'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_price'

data/lib/acts_as_price.rb

@@ -0,0 +1,46 @@
+module ActiveRecord
+  module Acts
+    module Price
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        # Specify the column_name that needs to act as price
+        # 
+        # Valid options:
+        # * :validates => true (performs validates_presence_of and validates_numericality_of)
+        def acts_as_price column_name, options = {}
+          validates column_name, :presence => true, :numericality => {:greater_than => 0} if options[:validates] == true
+          
+          #setters
+          define_method("#{column_name}=") do |val|
+            super((val.to_f * 100).to_s)
+          end
+          alias_method("price=", "#{column_name}=")
+          
+          define_method("price_in_cents=") do |val|
+            self.send("price=", val.to_f / 100)
+          end
+          alias_method "#{column_name}_in_cents=", "price_in_cents="
+          
+          #getters
+          define_method(column_name) do
+            if super == 0.0
+              ""
+            else
+              sprintf("%.2f", super.to_f / 100)
+            end
+          end
+          alias_method "price", column_name
+          
+          define_method("price_in_cents") {((send column_name).to_f * 100).to_s.to_i}
+          alias_method "#{column_name}_in_cents", "price_in_cents"
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Price)

data/lib/acts_as_price_helper.rb

@@ -0,0 +1,76 @@
+module ActsAsPriceHelper
+  # Test the acts_as_price plugin for the specified column_name and model
+  #   
+  # Note the you can also specify the model in a before block in your tests
+  def test_acts_as_price_methods column_name, acts_as_price_model = nil
+    @acts_as_price_model = acts_as_price_model if acts_as_price_model
+    
+    @column_name = column_name
+    columns_in_cents.each do |column|
+      @acts_as_price_model.send(column).should == @acts_as_price_model.price_in_cents
+    end
+    columns_in_doubles.each do |column|
+      @acts_as_price_model.send(column).should == @acts_as_price_model.price
+    end
+    
+    #normal test for setter
+    test_setter_in_cents "144"
+    test_setter_in_doubles "1.41"
+    
+    #test for special cases
+    #test if 1.5 is returned as 1.50
+    test_setter_in_doubles "1.5"
+    
+    #test if float returns 2.05 correctly 
+    #float can return 2.05 as 2.04 in some cases
+    test_setter_in_doubles "2.05"
+    
+    #test an empty_setter
+    test_setter_in_cents ""
+    test_setter_in_doubles ""
+  end  
+  
+  def test_setter_in_cents cents
+    columns_in_cents.each do |setter|
+      @acts_as_price_model.send("#{setter}=", cents)
+      columns_in_cents.each do |getter|
+        @acts_as_price_model.send(getter).should == cents.to_i
+      end
+      columns_in_doubles.each do |getter|
+        if cents == ""
+          @acts_as_price_model.send(getter).should == ""
+        else
+          @acts_as_price_model.send(getter).should == sprintf("%.2f", (cents.to_f / 100).to_s)
+        end
+      end
+    end
+  end
+  
+  def test_setter_in_doubles double
+    columns_in_doubles.each do |setter|
+      @acts_as_price_model.send("#{setter}=", double)
+      columns_in_cents.each do |getter|
+        @acts_as_price_model.send(getter).should == (double.to_f * 100).to_s.to_i
+      end
+      columns_in_doubles.each do |getter|
+        if double == ""
+          @acts_as_price_model.send(getter).should == ""
+        else
+          @acts_as_price_model.send(getter).should == sprintf("%.2f", double)
+        end
+      end
+    end
+  end
+  
+  def columns_in_cents 
+    [:price_in_cents, "#{@column_name}_in_cents"]
+  end
+    
+  def columns_in_doubles
+    [:price, @column_name]
+  end
+    
+  def columns
+    columns_in_doubles + columns_in_cents
+  end
+end

data/spec/car_spec.rb

@@ -0,0 +1,65 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe Car do
+  before(:each) do
+    @column_name = :price
+    @acts_as_price_model = stub_model(Car, :brand => "Ford", :cartype => "Focus", :price => "23995.99")
+  end
+
+  context "given an empty car" do
+    it "should return an invalid car" do
+      car = Car.new
+      should validate_presence_of :brand
+      should validate_presence_of :cartype
+      car.valid?.should be_false
+      car.save.should be_false
+    end
+  end
+  
+  context "given an valid car" do
+    it "should succesfully save" do
+      car = Car.new @acts_as_price_model.attributes
+      car.valid?.should be_true
+      car.save.should be_true
+    end
+  end
+  
+  context "return the price" do
+    it "should return the price in cents" do
+      columns_in_cents.each do |column|
+        @acts_as_price_model.send(column).should == 2399599
+      end
+    end
+    it "should return the price" do
+      columns_in_doubles.each do |column|
+        @acts_as_price_model.send(column).should == "23995.99"
+      end
+    end
+  end
+  
+  context "set the price for hundred different prices" do
+    2200000.upto(2200100) do |i|
+      it "should set the price in cents and return it correctly" do
+        test_setter_in_cents i.to_s
+      end
+      it "should set the price and return it correctly" do
+        test_setter_in_doubles sprintf("%.2f", i.to_f / 100)
+      end
+    end
+    
+  end
+  
+  context "given a float as price" do
+    it "should convert it to the right price in cents" do
+      test_setter_in_doubles "25500.5"
+      test_setter_in_doubles "21599.05"
+    end
+  end
+  
+  context "given the price is zero" do
+    it "should return an empty price per liter" do
+      test_setter_in_cents ""
+      test_setter_in_doubles ""
+    end
+  end
+end

data/spec/fueltype_spec.rb

@@ -0,0 +1,64 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe Fueltype do
+  before(:each) do
+    @column_name = :price_per_liter
+    @acts_as_price_model = stub_model(Fueltype, :name => "Euro 95", :price_per_liter => "1.55")
+  end
+  
+  context "given an empty fueltype" do
+    it "should give an invalid fueltype and not save it" do
+      fueltype = Fueltype.new
+      should validate_presence_of :name
+      should validate_presence_of @column_name
+      fueltype.valid?.should be_false
+      fueltype.save.should be_false
+    end
+  end
+  
+  context "given an valid fueltype" do
+    it "should be valid and saved" do
+      fueltype = Fueltype.new @acts_as_price_model.attributes
+      fueltype.valid?.should be_true
+      fueltype.save.should be_true
+    end
+  end
+  
+  context "return the fueltype price" do
+    it "should return the price in cents" do
+      columns_in_cents.each do |column|
+        @acts_as_price_model.send(column).should == 155
+      end
+    end
+    it "should return the price" do
+      columns_in_doubles.each do |column|
+        @acts_as_price_model.send(column).should == "1.55"
+      end
+    end
+  end
+  
+  context "set the price per liter for hundred different prices" do
+    1.upto(100).each do |i|
+      it "should set the price per liter in cents and return it correctly" do
+        test_setter_in_cents i.to_s
+      end
+      it "should set the price per liter and return it correctly" do
+        test_setter_in_doubles sprintf("%.2f", i.to_f / 100)
+      end
+    end
+  end
+  
+  context "given a float as price per liter" do
+    it "should convert it to the right price in cents" do
+      test_setter_in_doubles "1.5"
+      test_setter_in_doubles "2.05"
+    end
+  end
+  
+  context "given the price is zero" do
+    it "should return an empty price per liter" do
+      test_setter_in_cents ""
+      test_setter_in_doubles ""
+    end
+  end
+end

data/spec/models/car.rb

@@ -0,0 +1,7 @@
+#car model
+class Car < ActiveRecord::Base
+  validates :brand, :presence => true
+  validates :cartype, :presence => true
+  
+  acts_as_price :price
+end

data/spec/models/fueltype.rb

@@ -0,0 +1,6 @@
+#fueltype model
+class Fueltype < ActiveRecord::Base
+  validates :name, :presence => true
+  
+  acts_as_price :price_per_liter, :validates => true
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../../../../../config/environment", __FILE__)
+
+require 'rspec/rails'
+require File.expand_path("../models/fueltype", __FILE__) 
+require File.expand_path("../models/car", __FILE__) 
+
+require 'nulldb_rspec'
+
+include NullDB::RSpec::NullifiedDatabase
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+  
+  #load helper methods
+  config.include(ActsAsPriceHelper)
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_price
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeroen van Ingen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  prerelease: false
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 0
+        - 7
+        version: 3.0.7
+  prerelease: false
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda-matchers
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: autotest-growl
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: metrical
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: activerecord-nulldb-adapter
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id010
+description: "A specified database column acts as a price and creates on the fly methods like 'price' and 'price_in_cents'. For more information visit: http://github.com/jeroeningen/acts_as_price"
+email: jeroeningen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/acts_as_price.rb
+- lib/acts_as_price_helper.rb
+- spec/car_spec.rb
+- spec/fueltype_spec.rb
+- spec/models/car.rb
+- spec/models/fueltype.rb
+- spec/spec_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/jeroeningen/acts_as_price
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A specified database column acts as a price
+test_files: 
+- spec/car_spec.rb
+- spec/fueltype_spec.rb
+- spec/models/car.rb
+- spec/models/fueltype.rb
+- spec/spec_helper.rb