corrency 0.2.0 → 0.3.0

data/.gitignore

@@ -1,9 +1,4 @@
-.bundle/
-log/*.log
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-*.gem
 .bundle
+*.gem
 Gemfile.lock
-pkg/*
+pkg/*

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2@corrency --create
+rvm use 1.9.3@corrency --create

data/Gemfile

@@ -1,15 +1,3 @@
-source "http://rubygems.org"
+source :rubygems
 
-group :development, :test do
-  gem "rake", "0.8.7"
-  gem "capybara", ">= 0.4.0"
-  gem "shoulda"
-  gem "sqlite3"
-  gem "jeweler", "~> 1.6.0"
-  gem "rcov", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "rails", ">=3.0.0"
-  # To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
-  # gem 'ruby-debug'
-  # gem 'ruby-debug19'
-end
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+# Corrency - Useful Ecommerce Core extensions
+
+# Usage
+
+```ruby
+# Configure the VAT rate
+Corrency::Config.vat_rate = 20.00
+
+# Add VAT
+BigDecimal.new('10.00').inc_vat # 12.00
+
+# Remove VAT
+BigDecimal.new('12.00').ex_vat # 10.00
+
+# Roll up to nearest 99p
+BigDecimal.new('12.76').next_ninety_nine # 12.99
+
+# Add 10% Margin
+BigDecimal.new('90.00').add_margin(10.00) # 100.00
+```
+
+# Copyright
+Copyright (c) 2012 Robert Williams. See MIT-LICENSE for further details.

data/Rakefile

@@ -1,15 +1,14 @@
-# encoding: UTF-8
 require 'rubygems'
 begin
-  require 'bundler/setup'
+  require 'bundler'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  exit
 end
 
-require 'rake'
-require 'rake/rdoctask'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require "bundler/gem_tasks"
+require 'cucumber/rake/task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
@@ -18,12 +17,8 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-task :default => :test
+task :default => [:features, :test]
 
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Corrency'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format=pretty"
 end

data/corrency.gemspec

@@ -19,12 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency(%q<capybara>, [">= 0.4.0"])
-  s.add_development_dependency(%q<shoulda>, [">= 0"])
-  s.add_development_dependency(%q<sqlite3>, [">= 0"])
-  s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-  s.add_development_dependency(%q<rcov>, [">= 0"])
-  s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-  s.add_development_dependency(%q<rails>, [">= 3.0.0"])
-  # s.add_runtime_dependency "rest-client"
-end
+  s.add_development_dependency "rake"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "shoulda-context"
+end

data/features/nice_rounding.feature

@@ -0,0 +1,15 @@
+Feature: Nice Rounding
+  In order to make prices look nicer to customers
+  As a user of the Corrency Library
+  I should be able to round a number up to the nearest 99
+
+  Scenario Outline: Rolling Prices up to the next ninety nine
+    Given there is a value of <price>
+    Then I should have a price nearest ninety nine of <nice_price>
+     
+    Examples:
+      | price   | nice_price |
+      | 61.33   | 61.99      |
+      | 90.00   | 89.99      |
+      | 100.00  | 99.99      |
+      | 3.43    | 3.99       |

data/features/profit_margin_calculations.feature

@@ -0,0 +1,17 @@
+Feature: Profit Margin Calculations
+  In order to make the correct amount of profit on an item
+  As a user of the Corrency Library
+  I should be able to work out profit margins correctly.
+
+  Scenario Outline: Adding profit margin to costs
+    Given there is a cost of <cost>
+    And I apply a margin of <margin>
+    Then I should have a value of <price>
+     
+    Examples:
+      | cost    | margin | price  |
+      | 61.33   | 28%    | 85.18  |
+      | 90.00   | 10%    | 100.00 |
+      | 100.00  | 20%    | 125.00 |
+      | 3.43    | 12.3%  | 3.91   |
+

data/features/step_definitions/nice_rounding_steps.rb

@@ -0,0 +1,4 @@
+Then /^I should have a price nearest ninety nine of (.+)$/ do |price|
+  @price = @meh.next_ninety_nine
+  assert_equal(BigDecimal.new(price).to_s, @price.to_s)
+end

data/features/step_definitions/profit_margin_calculations_steps.rb

@@ -0,0 +1,12 @@
+Given /^there is a cost of (.+)$/ do |cost|
+  @meh = BigDecimal.new(cost)
+end
+
+Given /^I apply a margin of (.+)%$/ do |margin|
+  margin = margin.strip.to_f
+  @margin = @meh.add_margin(margin)
+end
+
+Then /^I should have a value of (.+)$/ do |price|
+  assert_equal(BigDecimal.new(price).to_s, @margin.to_s)
+end

data/features/step_definitions/vat_calculations_steps.rb

@@ -0,0 +1,17 @@
+Given /^there is a value of (.+)$/ do |value|
+  @meh = BigDecimal.new(value)
+end
+
+Given /^I configure the VAT rate to (.+)%$/ do |vat_rate|
+  Corrency::Config.vat_rate = vat_rate
+end
+
+Then /^I should have a total inc vat of (.+)$/ do |price|
+  @price_inc_vat = @meh.inc_vat
+  assert_equal(BigDecimal.new(price).to_s, @price_inc_vat.to_s)
+end
+
+Then /^I should have a total ex vat of (.+)$/ do |price|
+  @price_ex_vat = @meh.ex_vat
+  assert_equal(BigDecimal.new(price).to_s, @price_ex_vat.to_s)
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), '../', '../', 'lib')
+require 'corrency'
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/features/vat_calculations.feature

@@ -0,0 +1,29 @@
+Feature: VAT Calculations
+  In order to charge customers the correct amount of VAT
+  As a user of the Corrency Library
+  I should be able to work out VAT correctly.
+
+  Scenario Outline: Adding VAT to price
+    Given there is a value of <price>
+    And I configure the VAT rate to <vat_rate>
+    Then I should have a total inc vat of <total>
+     
+    Examples:
+      | price   | vat_rate | total  |
+      | 61.33   | 20%      | 73.60  |
+      | 90.00   | 17.5%    | 105.75 |
+      | 100.00  | 20%      | 120.00 |
+      | 3.43    | 20%      | 4.12   |
+
+  Scenario Outline: Removing VAT from price
+    Given there is a value of <price>
+    And I configure the VAT rate to <vat_rate>
+    Then I should have a total ex vat of <total>
+     
+    Examples:
+      | price   | vat_rate | total  |
+      | 73.60   | 20%      | 61.33  | 
+      | 105.75  | 17.5%    | 90.00  | 
+      | 120.00  | 20%      | 100.00 | 
+      | 4.12    | 20%      | 3.43   | 
+

data/lib/core_ext/big_decimal.rb

@@ -15,6 +15,10 @@ class BigDecimal
     self.ceil - BigDecimal.new("0.01")
   end
     
+  def add_margin(margin)
+    ((self / (100 - margin)) * 100).to_d.round(2)
+  end
+  
   old_to_s = instance_method :to_s
 
   define_method :to_s do |*param|
@@ -25,4 +29,4 @@ class BigDecimal
     def vat_rate
       1 + (Corrency::Config.vat_rate.to_f / 100)
     end
-end
+end

data/lib/corrency/version.rb

@@ -1,3 +1,3 @@
 module Corrency
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/big_decimal_test.rb

@@ -1,60 +1,20 @@
 require 'test_helper'
 
-class BigDecimalTest < ActiveSupport::TestCase
-  
-  setup do
-    @bd = BigDecimal.new('100.3799')
-  end
-  
-  context "inc_vat" do
-    
-    should "return the correct total inc vat" do
-      assert_equal(BigDecimal.new((@bd * (Corrency::Config.vat_rate.to_f / 100 + 1)).to_s), @bd.inc_vat)
-    end
-    
-    should "return a BigDecimal" do
-      assert_equal(BigDecimal, @bd.inc_vat.class)
-    end
-  end
-  
-  context "ex_vat" do
-    
-    should "return the correct total inc vat" do
-      assert_equal(BigDecimal.new((@bd / (Corrency::Config.vat_rate.to_f / 100 + 1)).to_s), @bd.ex_vat)
-    end
-    
-    should "return a BigDecimal" do
-      assert_equal(BigDecimal, @bd.ex_vat.class)
-    end
-  end
-  
-  context "next_ninety_nine" do
-    
-    should "return the next nearest 0.99 decimal" do
-      assert_equal(BigDecimal.new("100.99"), @bd.next_ninety_nine)
-    end
-    
-    should "return a BigDecimal" do
-      assert_equal(BigDecimal, @bd.next_ninety_nine.class)
-    end
-  end
-  
-  context "to_s" do
-    
-    should "return a string rounded to 2 decimal places" do
-      assert_equal(@bd.round(2).to_s, @bd.to_s)
-    end
-    
-    should "return the correct class" do
-      assert_equal(String, @bd.to_s.class)
+describe BigDecimal do
+
+  describe "#to_s" do
+
+    it "should return a string rounded to 2 decimal places" do
+      @bd = BigDecimal.new('100.3799')
+      assert_equal("100.38", BigDecimal.new("100.38000123").to_s)
     end
     
-    should "still round to two decimal places if 0" do
+    it "should round to two decimal places if 0" do
       assert_equal "0.00", BigDecimal.new("0").to_s
     end
     
-    should "still round to two decimal places if 1.20" do
+    it "should round to two decimal places if 1.20" do
       assert_equal "1.20", BigDecimal.new("1.2").to_s
     end
   end
-end
+end

data/test/corrency_test.rb

@@ -1,25 +1,17 @@
 require 'test_helper'
 
-class CorrencyTest < ActiveSupport::TestCase
+describe Corrency do
 
-  setup do
-    @old_vat_rate = Corrency::Config.vat_rate
+  it "should have a default vat_rate" do
+    Corrency::Config.vat_rate.must_equal Corrency::DEFAULT_VAT_RATE
   end
 
-  context "Config" do
-
-    should "have a default vat_rate" do
-      assert_equal Corrency::Config.vat_rate.class, Float
-    end
-    
-    should "set vat_rate" do
-      Corrency::Config.vat_rate = 17.50
-      assert_equal 17.50, Corrency::Config.vat_rate
-    end
+  it "should set vat_rate" do
+    Corrency::Config.vat_rate = 17.50
+    Corrency::Config.vat_rate.must_equal 17.50
   end
-  
-  teardown do
-    # Makes sure all other tests that expect base tax still pass
-    Corrency::Config.vat_rate = @old_vat_rate
+
+  after do
+    Corrency::Config.vat_rate = Corrency::DEFAULT_VAT_RATE
   end
 end

data/test/test_helper.rb

@@ -1,23 +1,4 @@
-# Configure Rails Envinronment
-ENV["RAILS_ENV"] = "test"
-
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
-require 'shoulda'
-
-ActionMailer::Base.delivery_method = :test
-ActionMailer::Base.perform_deliveries = true
-ActionMailer::Base.default_url_options[:host] = "test.com"
-
-Rails.backtrace_cleaner.remove_silencers!
-
-# Configure capybara for integration testing
-require "capybara/rails"
-Capybara.default_driver   = :rack_test
-Capybara.default_selector = :css
-
-# Run any available migration
-ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+$:.unshift File.join(File.dirname(__FILE__), '../', 'lib')
+require 'corrency'
+require 'minitest/spec'
+require 'minitest/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: corrency
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-02 00:00:00.000000000Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: &70199186560760 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199186560760
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &70199186559660 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70199186559660
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70199186558460 !ruby/object:Gem::Requirement
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,51 +37,28 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199186558460
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70199186557020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *70199186557020
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70199186554800 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70199186554800
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70199186553640 !ruby/object:Gem::Requirement
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199186553640
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70199186552640 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70199186552640
+        version: '0'
 description: Adds Ecommerce Extensions to Various Core Libraries it really does
 email:
 - rob@r-williams.com
@@ -98,57 +69,23 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - corrency.gemspec
+- features/nice_rounding.feature
+- features/profit_margin_calculations.feature
+- features/step_definitions/nice_rounding_steps.rb
+- features/step_definitions/profit_margin_calculations_steps.rb
+- features/step_definitions/vat_calculations_steps.rb
+- features/support/env.rb
+- features/vat_calculations.feature
 - lib/core_ext/big_decimal.rb
 - lib/corrency.rb
 - lib/corrency/config.rb
 - lib/corrency/version.rb
 - test/big_decimal_test.rb
 - test/corrency_test.rb
-- test/dummy/Rakefile
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/products_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/helpers/products_helper.rb
-- test/dummy/app/models/product.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/products/show.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/corrency.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20110511100318_create_products.rb
-- test/dummy/db/schema.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/javascripts/application.js
-- test/dummy/public/javascripts/controls.js
-- test/dummy/public/javascripts/dragdrop.js
-- test/dummy/public/javascripts/effects.js
-- test/dummy/public/javascripts/prototype.js
-- test/dummy/public/javascripts/rails.js
-- test/dummy/public/stylesheets/.gitkeep
-- test/dummy/script/rails
-- test/integration/product_price_test.rb
-- test/support/integration_case.rb
 - test/test_helper.rb
 homepage: ''
 licenses: []
@@ -164,60 +101,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1118588149199432669
+      hash: 1810353474154341246
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1810353474154341246
 requirements: []
 rubyforge_project: corrency
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Adds Ecommerce Extensions to Various Core Libraries
 test_files:
+- features/nice_rounding.feature
+- features/profit_margin_calculations.feature
+- features/step_definitions/nice_rounding_steps.rb
+- features/step_definitions/profit_margin_calculations_steps.rb
+- features/step_definitions/vat_calculations_steps.rb
+- features/support/env.rb
+- features/vat_calculations.feature
 - test/big_decimal_test.rb
 - test/corrency_test.rb
-- test/dummy/Rakefile
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/products_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/helpers/products_helper.rb
-- test/dummy/app/models/product.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/products/show.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/corrency.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20110511100318_create_products.rb
-- test/dummy/db/schema.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/javascripts/application.js
-- test/dummy/public/javascripts/controls.js
-- test/dummy/public/javascripts/dragdrop.js
-- test/dummy/public/javascripts/effects.js
-- test/dummy/public/javascripts/prototype.js
-- test/dummy/public/javascripts/rails.js
-- test/dummy/public/stylesheets/.gitkeep
-- test/dummy/script/rails
-- test/integration/product_price_test.rb
-- test/support/integration_case.rb
 - test/test_helper.rb