acts_as_priceable 0.1.2 → 0.2.0

data/README.md

@@ -1,6 +1,6 @@
 # ActsAsPriceable
 
-TODO: Write a gem description
+This gem is extension for ActiveRecord which provides mechanism for handling prices.
 
 ## Installation
 
@@ -16,9 +16,97 @@ Or install it yourself as:
 
     $ gem install acts_as_priceable
 
+## Migrations
+
+You can add all columns which are needed by this gem using provided migrations
+```ruby
+
+  def change
+    create_table :products do |t|
+      t.price :price
+      # This creates 3 column
+      # t.integer :price_gross
+      # t.integer :price_net
+      # t.integer :price_tax
+    end
+  end
+
+```
+
+```ruby
+
+  def change
+    add_price :products, :price
+  end
+
+```
+
+```ruby
+
+  def change
+    remove_price :products, :price
+  end
+
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Basics
+------
+
+```ruby
+class Product < ActiveRecord::Base
+  has_price :price
+end
+```
+
+This provides accessors which wraps created database columns. `price_gross` and `price_net` converts integer columns into BigDecimal with some scale (default scale is 2).
+Ex. if `price_gross` in database is `1000`, accessor will return `10.00` as BigDecimal.
+
+`price_tax` is percentage VAT tax added to net price.
+`price_tax_value` is value of tax.
+
+Instead of setting `price_net` and `price_gross` separately you can use `price` and `price_mode` accessors.
+
+```ruby
+p = Product.new
+p.price_tax = 20
+p.price = '10.00'
+p.price_mode = 'net'
+p.save
+p.price_net # 10.00
+p.price_gross # 12.00
+```
+
+Recalculating price takes place in before_validation. You can recalculate it manually by calling `update_price` method.
+
+NOTE: `price_net`, `price_gross`, etc. are made from `has_price` method first argument. You can have different name for price accessor or even two or more prices
+
+```ruby
+class Product < ActiveRecord::Base
+  has_price :price
+  has_price :promotion
+end
+```
+
+This defines `price_net` etc. as well as `promotion_net` ...
+
+Validations
+-----------
+
+On default `price_tax`, `price_net` and `price_gross` can't be lower than 0. You can turn off validation by setting `without_validation` parameter to true in options.
+
+Configuration
+-------------
+```ruby
+class Product < ActiveRecord::Base
+  has_price :price, scale: 4,
+                    without_validation: true
+end
+```
+
+
+
 
 ## Contributing
 

data/lib/acts_as_priceable/base.rb

@@ -24,6 +24,8 @@ module ActsAsPriceable
         net = "#{name}_net"
         tax_value = "#{name}_tax_value"
         tax = "#{name}_tax"
+        mode = "#{name}_mode"
+
         send :define_method, gross do
           BigDecimal.new(self[gross.to_sym].to_i) / BigDecimal.new(10**scale.to_i)
         end
@@ -44,11 +46,11 @@ module ActsAsPriceable
           send(gross) - send(net)
         end
 
-        send :attr_accessor, :mode
+        send :attr_accessor, mode.to_sym
         send :attr_accessor, name
 
         send :define_method, "update_#{name}" do
-          if self.mode == 'net'
+          if self.send(mode).to_s == 'net'
             self.send "#{net}=", self.send(name)
             self.send "#{gross}=", self.send(net) * ((BigDecimal.new(self.send(tax)) / 100) + 1)
           else
@@ -58,7 +60,7 @@ module ActsAsPriceable
         end
 
         send :before_validation do
-          if self.send(name) and self.mode
+          if self.send(name) && self.send(mode)
             self.send "update_#{name}"
           end
         end

data/lib/acts_as_priceable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsPriceable
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/base_spec.rb

@@ -28,8 +28,8 @@ describe Dummy do
       end
 
       it 'should have mode attr_accessor' do
-        @dummy.should respond_to(:mode)
-        @dummy.should respond_to(:mode=)
+        @dummy.should respond_to(:price_mode)
+        @dummy.should respond_to(:price_mode=)
       end
 
       it 'should have price_tax_value method' do
@@ -63,7 +63,7 @@ describe Dummy do
       it 'calculates price gross from price_net' do
         @dummy.price = '10.00'
         @dummy.price_tax = 23
-        @dummy.mode = 'net'
+        @dummy.price_mode = 'net'
         @dummy.update_price
         @dummy.price_net.should == BigDecimal.new('10.00')
         @dummy.price_gross.should == BigDecimal.new('12.30')
@@ -72,7 +72,7 @@ describe Dummy do
       it 'calculates price net from price gross' do
         @dummy.price = '12.30'
         @dummy.price_tax = 23
-        @dummy.mode = 'gross'
+        @dummy.price_mode = 'gross'
         @dummy.update_price
         @dummy.price_net.should == BigDecimal.new('10.00')
         @dummy.price_gross.should == BigDecimal.new('12.30')
@@ -81,7 +81,7 @@ describe Dummy do
       it 'calculates tax value properly' do
         @dummy.price = '10.00'
         @dummy.price_tax = 23
-        @dummy.mode = 'net'
+        @dummy.price_mode = 'net'
         @dummy.update_price
         @dummy.price_tax_value.should == BigDecimal.new('2.30')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_priceable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2619945945868084859
+      hash: 415468810773993444
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,10 +120,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2619945945868084859
+      hash: 415468810773993444
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Acts as priceable