sales_and_orders_decorator 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52adf7fb40aeb25b51267d302b98ad4b35a18a13
-  data.tar.gz: d1dddc8bb4f81b293b746de28cc902fd99aa292c
+  metadata.gz: 05e350dd6294e496a203c49be9ca501263219294
+  data.tar.gz: 2d2a90b80ad02d6f91dd21cce03bd0ad68f67b3b
 SHA512:
-  metadata.gz: 396aff77d56ab42d12564b4e4feeb40d5ab291465bef8f7ecadd88994dc1079797a4a103d2341744ccd45698351c4af44c6586dc3111bd4b6992f286b68ef512
-  data.tar.gz: 0b5017cb0f6645d8a3c87cc21ce2cdd51621364c4ee3d45d3f64d36fd672d900e36965ad572ec0b7f2b1906f535ddbaa53b0398151543f58fba620128c8cbece
+  metadata.gz: 4ca8161027b04abe0824c641237964ca0d6fc86adb358003f01dc5f9edbedfd3449f1430f8c8943d01fc6a0b493b4ad0396175e05399da5380f667ba80b723c8
+  data.tar.gz: b8a816093ffd9ca29ce74bf75b2f9647b9b5936bf436f2a478e0c4e24856c394cca532dbdb773031f432dad757ec52d6e57647cf5ba005332b3427a1da72c6b9

data/lib/sales_and_orders_decorator.rb

@@ -1,40 +1,48 @@
 require "sales_and_orders_decorator/version"
 
-# the concret component we would like to decorate, a car in our example
+#This component class initialises an empty sales array to store the sales details for each docrators 
 class BasicSales
+	#initialises an empty array for the decorator
 	def initialize
 		@sales_array = []
 	end
 	
-	# getter method
+	# returns sales array
 	def sales_array
 		return @sales_array
 	end
 	
+	#returns total sale value
 	def totalSale_counter_method
 		return @totalSale_order
 	end
 	
+	#returns total quantity sold value
 	def totalSale_quantity_method
 		return @totalSale_quantity
 	end
 	
+	#returns total veg pizza quantity sold value
 	def vegCounter_method
 		return @vegCounter
 	end
 	
+	#returns total non veg pizza quantity sold value
 	def nonVegCounter_method
 		return @nonVegCounter
 	end
 	
+	#returns total offered pizza quantity sold value
 	def offeredSale_counter_method
 		return @offeredSale_counter
 	end
 	
+	#returns total non offered pizza quantity sold value
 	def nonOfferedSale_counter_method
 		return @nonOfferedSale_counter
 	end
 	
+	#a common method to define a logic of selecting the datas for the last 24 hours where the products sold in the specific time line.
 	def common_method
 	    product_sale.each do |product|
         sale_boolean = product.created_at.between?(Time.now.midnight-1.day,Time.now.midnight)
@@ -46,9 +54,10 @@ class BasicSales
 		
 end
 
-# decorator class -- this serves as the superclass for all the concrete decorators
-# the base/super class decorator (i.e. no actual decoration yet), each concrete decorator (i.e. subclass) will add its own decoration
+# decorator class -- this serves as the superclass for all the concrete decorators. 
+#This class provides the structure to all decorator class to define the logic
 class BuisnessDecorator
+	#initialise all the values required to calculate the sales expenditure for the previous day.
 	def initialize(root_sales)
 	    @root_sales = root_sales
 		@totalSale_counter = 0
@@ -60,38 +69,47 @@ class BuisnessDecorator
 		@profit_counter = 0
 	end
 	
+	#returns the sales array from the component class
 	def sales_array
 		return @root_sales.sales_array
 	end
 	
+	#returns the total sales with the root class total sales which is calculated already
 	def totalSale_counter_method
 	    @totalSale_counter += sd.totalSale
 	end
 	
+	#returns the total quantity sales with the root class total quantity sales sold which is calculated already
 	def totalSale_quantity_method
 		return @totalSale_quantity
 	end
 	
+	#returns the total profit sales with the root class total profit of the sales sold which is calculated already
 	def profit_counter_method
 	    @profit_counter += sd.profit
 	end
 	
+	#returns the total veg type quantity sales with the root class total veg pizza quantity sales sold that is calculated already
 	def vegCounter_method
 	    @vegCounter += sd.vegSale
 	end
 	
+	#returns the total non veg type quantity sales with the root class total veg pizza quantity sales sold that is calculated already
 	def nonVegCounter_method
 	    @nonVegCounter += sd.nonVegSale
 	end
 	
+	#returns the total offered type quantity sales with the root class total offered pizza quantity sales sold that is calculated already
 	def offeredSale_counter_method
 	    @offeredSale_counter += sd.offeredSale
 	end
 	
+	#returns the total non offered type quantity sales with the root class total non offered pizza quantity sales sold that is calculated already
 	def nonOfferedSale_counter_method
 	    @nonOfferedSale_counter += sd.nonOfferedSale
 	end
 	
+	#returns the total profit sales with the root class total profit sales sold that is calculated already with the quantity of products sold
 	def check_profit
 	    @root_sales.sales_array.each do |sd|
             @totalSale_counter += sd.total_price
@@ -101,6 +119,7 @@ class BuisnessDecorator
         @profit_counter = @totalSale_counter - @totalProductSold
 	end
 	
+	#to check thte offer availability and calculate the total sales of offered and non offered
 	def check_offer
 	    @root_sales.sales_array.each do |sd|
         prod = Product.find(sd.product_id)
@@ -112,6 +131,7 @@ class BuisnessDecorator
         end
 	end
 	
+	#to check thte food type sales and calculate the total sales of veg and non veg ordered
 	def check_foodType
 	    @root_sales.sales_array.each do |sd|
         prod = Product.find(sd.product_id)
@@ -127,6 +147,7 @@ class BuisnessDecorator
 	    
 	end
 	
+	#Common logic to sort the products for the previous 24 hrs time line.
 	def common_method
 	    @product_sale.each do |product|
         sale_boolean = product.created_at.between?(Time.now.midnight-1.day,Time.now.midnight)
@@ -136,6 +157,7 @@ class BuisnessDecorator
         end
 	end
 	
+	#main method provides the sequence of all other method followed to generate a sales calculation
 	def main_method
 	    common_method
 	    check_profit
@@ -152,13 +174,15 @@ class BuisnessDecorator
 end
 
 
-# a concrete decorator
+# a concrete decorator for day sales stores the sales details calculated in the database with the below functionality
 class DaySalesDecorator < BuisnessDecorator
+	#method used to initialise the day sales object with component class object and the sales array 
 	def initialize(root_sales)
 		super(root_sales)
 		@product_sale = OrderItem.all
 	end
 	
+	#this method provides the logical methods of sequencing the methods to calculate the sales details of the product for a single day.
 	def main_method
 	    common_method
 	    check_profit
@@ -176,13 +200,15 @@ class DaySalesDecorator < BuisnessDecorator
 	end
 end
 
-# another concrete decorator
+# a concrete decorator for week sales stores the sales details calculated in the database with the below functionality
 class WeekSalesDecorator < BuisnessDecorator
+	#method used to initialise the week sales object with component class object and the sales array 
 	def initialize(root_sales)
 		super(root_sales)
 		@product_sale = Dsale.all
 	end
 	
+	#Common logic to sort the products for a week time line.
 	def common_method
 	    @product_sale.each do |product|
         sale_boolean = product.created_at.between?(Time.now.midnight-7.day,Time.now.midnight)
@@ -192,6 +218,7 @@ class WeekSalesDecorator < BuisnessDecorator
         end
 	end
 	
+	#this method provides the logical methods of sequencing the methods to calculate the sales details of the product for the last one week.
 	def main_method
 	    common_method
 	    @root_sales.sales_array.each do |sd|
@@ -222,13 +249,15 @@ class WeekSalesDecorator < BuisnessDecorator
 	
 end
 
-# another concrete decorator
+# a concrete decorator for a month sale stores the sales details calculated in the database with the below functionality
 class MonthSalesDecorator < BuisnessDecorator
+	#method used to initialise the month sales object with component class object and the sales array 
 	def initialize(root_sales)
 		super(root_sales)
 		@product_sale = Wsale.all
 	end
 	
+	#Common logic to sort the products for a period of last one month time line.
 	def common_method
 	    @product_sale.each do |product|
         sale_boolean = product.created_at.between?(Time.now.midnight-1.month,Time.now.midnight)
@@ -238,6 +267,7 @@ class MonthSalesDecorator < BuisnessDecorator
         end
 	end
 	
+	#this method provides the logical methods of sequencing the methods to calculate the sales details of the product for one month.
 	def main_method
 	    common_method
 	    @root_sales.sales_array.each do |sd|

data/lib/sales_and_orders_decorator/version.rb

@@ -1,3 +1,3 @@
 module SalesAndOrdersDecorator
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/sales_and_orders_decorator.gemspec

@@ -6,7 +6,7 @@ require 'sales_and_orders_decorator/version'
 Gem::Specification.new do |spec|
   spec.name          = "sales_and_orders_decorator"
   spec.version       = SalesAndOrdersDecorator::VERSION
-  spec.authors       = ["Subit Benny"]
+  spec.authors       = ["Kishore Kumar"]
   spec.email         = ["x16103602@student.ncirl.ie"]
 
   spec.summary       = %q{This is sales decorator which provides and stores the resultant data into day, week, month sales into database}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sales_and_orders_decorator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
-- Subit Benny
+- Kishore Kumar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler