wunder 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e8f6b22d9b6d0c9044da576131e9d7f3bd3313f695873fe451789458ca0564c
-  data.tar.gz: be323501c72c54d920bbd96132eb2da25cb3945f708826b029164647d1a3b858
+  metadata.gz: 20f583583705c30caecbe64d86d42c51fa75a81c70d825fded9aa914596dfdd2
+  data.tar.gz: 6bb8d8b8423368dc407632cda431e8aac60b47c5bd79406b04a17580fbf1b605
 SHA512:
-  metadata.gz: a0aa9d6fc612de24191aff79c8315fdfa2dcdf0c0e0212de0aee34bafcb3e63630116a794ad90584ffb4f7ee1b1717a2de8b9736d42d92ecc3cbd19cce6f18f0
-  data.tar.gz: 59ab31d94eb31ed66352e5ad23f4d4b44ec4111b7a9a80e569a3985b02ba0f01bbd8128cef556f93636d0ae6ebaf96f9df08369c21838c0c93c4c16081d8f94d
+  metadata.gz: 9476befdb75097f7dac10e039e6a136bb672c2a52015ffc0e62067264c61be9fe965e15662052c4af6a8d0ae9655907e49ab2ea2e0424ef8e3107dbcf5cc8e43
+  data.tar.gz: 0a2a50de553eacd6f20a8f56177c5aac5155b2f1ba6cfd1bad0a749d4ea4ea1d683d1b68c98217799e024b464595b8d9cce1fc6529c80bb8672ab8c4a5bf48ca

data/Gemfile.lock

@@ -15,11 +15,13 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    docile (1.3.1)
     faker (1.8.7)
       i18n (>= 0.7)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     method_source (0.9.0)
     money (6.11.3)
       i18n (>= 0.6.4, < 1.1)
@@ -56,6 +58,11 @@ GEM
     rubocop-rspec (1.25.1)
       rubocop (>= 0.53.0)
     ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sub-inspector (0.1.5)
       rubocop (~> 0.55)
       rubocop-rspec (~> 1.25.1)
@@ -75,6 +82,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.57)
+  simplecov (~> 0.16)
   sub-inspector (= 0.1.5)
   wunder!
 

data/README.md

@@ -1,18 +1,16 @@
 [![Build Status](https://travis-ci.org/basicsaki/wunder.svg?branch=master)](https://travis-ci.org/basicsaki/wunder)
 
 
-# Checkout
+# Wunder
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/checkout`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Sample ruby code for a checkout system with flexible rules. 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'checkout'
+gem 'wunder'
 ```
 
 And then execute:
@@ -23,15 +21,84 @@ Or install it yourself as:
 
     $ gem install checkout
 
-## Usage
+## Steps to add a new rule
+
+Create a new file in the folder
+	 
+	 lib/wunder/promotional/rule/*.rb
+
+Capture any value or paramters in the initialize method.
+
+Make sure that the below mentioned methods are available in the file.
+
+If the discount is on basket define adjustable method as mentioned below.
+
+Total is the parameter after discounts on individual items.
+Define calculate_discounted_price to compute the new value after discounts.
+return false if your rule has only item specific discounts.
+
+      def adjustable?(total)
+        return true if total > value
+        false
+      end
+
+      def calculate_discounted_price(basket_item, discount_type)
+        if discount_type == "percentage"
+          discount = compute_discount(basket_item)
+          basket_item.product.price = discount
+        elsif discount_type == "flat_rate"
+          basket_item.product.price = value
+        end
+      end
+
+If the discount is on an item define eligible method as mentioned below.Item is the individual item scaned during the checkout.
+Define calculate_total_discounted_price to compute the new value after discounts.
+return false if your rule has only basket specific discounts.
+
+      def eligible?(_item)
+        false
+      end
+
+      def calculate_total_discounted_price(total, discount_type)
+        if discount_type == "percentage"
+          discount_price = total - ((total * value) / 100)
+        elsif discount_type == "flat_rate"
+          discount_price = total
+        end
+        discount_price
+      end
 
-TODO: Write usage instructions here
+Methods in concerns/rule_validations can be used readily to validate the input parameters while capturing the rule.
 
-## Development
+##Example
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+An interface example has been added at path wunder/lib/interface.rb to calculate and add existing rules.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+	ruby lib/interface.rb
+
+To run the tests
+	
+	rspec spec
+
+To check rubocop style guidelines
+
+	rubocop 
+
+To check dependent gem venerabilites
+
+	bundle audit
+
+
+#Note
+For rubocop enforcements using a gem sub-inspector for ruby gems.
+
+
+#Ruby documentation
+https://www.rubydoc.info/gems/wunder
+
+##Future Scope
+Making seperate modules for checkout,promotional rules and parsing products.
+Adding priority to rules as many rules can be applied to many products. The order in which the rules are applied can be be sorted.
 
 ## Contributing
 
@@ -44,3 +111,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Checkout project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/checkout/blob/master/CODE_OF_CONDUCT.md).
+

data/lib/interface.rb

@@ -4,36 +4,34 @@ require_relative "./wunder.rb"
 # Parser
 # new expects csv file path,validate {true or false},use mock file true or false
 parser = Parser.new("", true, true)
-parser.process_file
 
-# Product Collection
-products = parser.products
+label = "Percentage discount on prices"
+label1 = "Flat_rate discount on prices"
 
-# promotion
-promotion = Promotion.new("new_year", "1234")
 
 # rules
-quantity_rule_1 = Promotional::Rule::QuantityPrice.new(1, 10)
-quantity_rule_2 = Promotional::Rule::QuantityPrice.new(1, 10)
-
-# promotional rules
-label_1 = "Flat_rate discount on prices"
-label_2 = "percentage discount on prices"
-
-promotion_rule_1 = PromotionalRule.new(label_2, "percentage", true, quantity_rule_2)
-promotion_rule_2 = PromotionalRule.new(label_1, "flat_rate", true, quantity_rule_1)
+quantity_rule1 = Promotional::Rule::ItemQuantityPriceRule.new(1, 10)
+quantity_rule2 = Promotional::Rule::BasketRule.new(20)
+# promotion
+promotion = Promotion.new("New Year Flat Discount", "code_115")
+promotion_rule1 = PromotionalRule.new(label, "percentage", true, quantity_rule1)
+promotion_rule2 = PromotionalRule.new(label, "flat_rate", true, quantity_rule1)
+promotion_rule3 = PromotionalRule.new(label1, "percentage", false, quantity_rule2)
+promotion_rule4 = PromotionalRule.new(label1, "flat_rate", false, quantity_rule2)
+rules = [promotion_rule1,promotion_rule2,promotion_rule3, promotion_rule4]
+promotion.add_rules_in_bulk(rules)
 
 
-promotion.add_rules_in_bulk([promotion_rule_2,promotion_rule_1])
+#File processing
+parser.process_file
+products = parser.products
 
-# promotional Rules
 # Checkout interface
 # scan(item) #remove_scan(item)
-
 co = Checkout.new(promotion.promotion_rules)
-
 co.scan(products[0])
 co.scan(products[1])
+co.remove_scan(products[1])
 co.scan(products[2])
 
 table = Print.new([co]).table

data/lib/wunder/adjustment.rb

@@ -1,9 +1,11 @@
 class Adjustment
-  attr_reader :basket, :promotional_rules, :basket_without_discounts
+  attr_reader :basket, :promotional_rules
 
   def initialize(basket, promotional_rules)
     @basket = basket
     @promotional_rules = promotional_rules
+    @product_promotional_rules = []
+    @basket_promotional_rules = []
     @applied_promotional_rules = []
   end
 
@@ -31,10 +33,11 @@ class Adjustment
   end
 
   def apply_basket_discounts(items_total)
-    @basket_promotional_rules = eligible_basket_promotional_discounts
+    @basket_promotional_rules =
+      eligible_basket_promotional_discounts(items_total)
 
     unless @basket_promotional_rules.empty?
-      basket_promotional_rules.each do |promotional_rule|
+      @basket_promotional_rules.each do |promotional_rule|
         items_total = promotional_rule.calculate_total(items_total)
       end
     end
@@ -56,9 +59,9 @@ class Adjustment
     end
   end
 
-  def eligible_basket_promotional_discounts
+  def eligible_basket_promotional_discounts(total)
     promotional_rules.select do |promo_rule|
-      promo_rule.on_item == false
+      promo_rule.on_item == false && promo_rule.rule.adjustable?(total)
     end
   end
 end

data/lib/wunder/basket.rb

@@ -19,6 +19,7 @@ class Basket
 
   def remove_item(product)
     item = items.find_product(product.product_code)
+    return if item.nil?
     if item.quantity == 1
       items.delete(item)
     else

data/lib/wunder/collections/item_collection.rb

@@ -1,5 +1,6 @@
 class ItemCollection < Array
   def find_product(product_code)
+    @item = nil
     each do |item|
       @item = item if item.product.product_code == product_code
     end

data/lib/wunder/concerns/rule_validations.rb

@@ -1,8 +1,8 @@
 module RuleValidations
   DISCOUNT_TYPES = %w[percentage flat_rate].freeze
 
-  def should_be_present(name, attribute)
-    raise "#{name} Should be present" if attribute == "" || attribute.nil?
+  def should_be_present(name, attr)
+    raise "#{name}.capitalize should be present" if attr == "" || attr.nil?
   end
 
   def check_discount_type(discount_type)
@@ -15,16 +15,11 @@ module RuleValidations
     raise "atleast fill out #{name}" if attr1.empty? && attr2.empty?
   end
 
-  def atleast_one_should_be_present(name, attr1, attr2)
-    raise "either fill out #{name}" if
-    attr1.empty? == false && attr2.empty? == false
-  end
-
   def should_be_a_number(name, attribute)
     raise "#{name} should be a number" if attribute.is_a?(Numeric) == false
   end
 
-  def should_be_less_than(name, attribute, number)
+  def should_be_more_than(name, attribute, number)
     raise "#{name} should be >= #{number}" if attribute < number
   end
 

data/lib/wunder/product.rb

@@ -4,7 +4,7 @@ class Product
   def initialize(product_code, name, price, no_validate = false)
     @product_code = product_code
     @name = name
-    @price = BigDecimal(price)
+    @price = price.nil? ? nil : BigDecimal(price, 2)
 
     validate if no_validate == false
   end
@@ -13,5 +13,6 @@ class Product
     [product_code, name, price].each do |parameter|
       raise ArgumentError, "ProductParameterMissing" if parameter.nil?
     end
+    nil
   end
 end

data/lib/wunder/promotional/rule/basket_rule.rb

@@ -0,0 +1,40 @@
+module Promotional
+  module Rule
+    class BasketRule < PromotionalRule
+      attr_reader :value
+
+      def initialize(value, no_validate = false)
+        @value = value
+
+        validate if no_validate == false
+      end
+
+      def adjustable?(total)
+        return true if total > value
+        false
+      end
+
+      def eligible?(_item)
+        false
+      end
+
+      def calculate_total_discounted_price(total, discount_type)
+        if discount_type == "percentage"
+          discount_price = total - ((total * value) / 100)
+        elsif discount_type == "flat_rate"
+          discount_price = total
+        end
+
+        discount_price
+      end
+
+      def validate
+        should_be_present("BasketRule::Value", value)
+        should_be_a_number("BasketRule::Value",
+                           value)
+        should_be_more_than("BasketRule::MinQuantity",
+                            value, 1)
+      end
+    end
+  end
+end

data/lib/wunder/promotional/rule/{quantity_price.rb → item_quantity_price_rule.rb}

@@ -1,6 +1,6 @@
 module Promotional
   module Rule
-    class QuantityPrice < PromotionalRule
+    class ItemQuantityPriceRule < PromotionalRule
       attr_reader :minimum_quantity, :value
 
       def initialize(minimum_quantity, value, no_validate = false)
@@ -14,21 +14,25 @@ module Promotional
         item.quantity >= minimum_quantity
       end
 
+      def adjustable?(_total)
+        false
+      end
+
       def calculate_discounted_price(basket_item, discount_type)
-        if discount_type == "percentage" && eligible?(basket_item)
+        if discount_type == "percentage"
           discount = compute_discount(basket_item)
           basket_item.product.price = discount
-        elsif discount_type == "flat_rate" && eligible?(basket_item)
+        elsif discount_type == "flat_rate"
           basket_item.product.price = value
         end
       end
 
-      def calulate_total_discounted_price(total); end
-
       def validate
-        should_be_present("QuantityPrice::Value", value)
-        should_be_a_number("QuantiyPrice::MinimumQuantity", minimum_quantity)
-        should_be_less_than("QuantityPrice::MinQuantity", minimum_quantity, 1)
+        should_be_present("ItemQuantityPriceRule::Value", value)
+        should_be_a_number("ItemQuantityPriceRule::MinimumQuantity",
+                           minimum_quantity)
+        should_be_more_than("ItemQuantityPriceRule::MinQuantity",
+                            minimum_quantity, 1)
       end
 
       private

data/lib/wunder/promotional_rule.rb

@@ -18,6 +18,10 @@ class PromotionalRule
     raise "Should be defined by the respective rule"
   end
 
+  def adjustable?(_total)
+    raise "Should be defined by the respective rule"
+  end
+
   def validate
     should_be_present("label", label)
     check_discount_type(discount_type)

data/lib/wunder/version.rb

@@ -1,3 +1,3 @@
 module Wunder
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.3".freeze
 end

data/wunder.gemspec

@@ -36,13 +36,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "terminal-table","~> 1.8"
 
   spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "simplecov","~> 0.16"
   spec.add_development_dependency "faker", "~> 1.8"
   spec.add_development_dependency "rubocop", "~> 0.57"
   spec.add_development_dependency "sub-inspector", "0.1.5"
-
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "bundler-audit","~> 0.6"
-
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wunder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Akhilesh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +198,8 @@ files:
 - lib/wunder/print.rb
 - lib/wunder/product.rb
 - lib/wunder/promotion.rb
-- lib/wunder/promotional/rule/quantity_price.rb
+- lib/wunder/promotional/rule/basket_rule.rb
+- lib/wunder/promotional/rule/item_quantity_price_rule.rb
 - lib/wunder/promotional_rule.rb
 - lib/wunder/version.rb
 - wunder.gemspec