budgetGenerator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 146218f2b54bd0c47fe9e1453ae02c05aa6004cf
+  data.tar.gz: 8f592b0125467d6af57efde6b1e2f5b405270b5f
+SHA512:
+  metadata.gz: 40cb25a6ac6678d6e132d8ee5d02b20b9fda9ca04a366e56e35980b6babedb465c8e93f2a76d717dda7cd98b7ba8088f14e2906a02b22892a1e382fd35906d4a
+  data.tar.gz: c9c506b35f59832c90e04e719d35acf97832568d10113d83bc91424ce19cf6e9392a112408f8ad973358f219886f327284bdfa1051489cf2e4574baacb67e155

data/lib/budgetGenerator.rb

@@ -0,0 +1,153 @@
+#super class defining a Basic Budget class
+
+class BasicBudget
+  def initialize(amount)
+    @amount = amount
+  end
+
+  # getter method for amount
+  def amount
+    @amount
+  end
+
+  # getter method for savings type: aggressive 20% savings on amount
+  def aggressive_savings
+    0.20
+  end
+
+  # getter method for savings type: medium 13% savings on amount
+  def medium_savings
+    0.13
+  end
+
+  # getter method for savings type: low 5% savings on amount
+  def low_savings
+    0.05
+  end
+
+  # getter method for budget category array
+  def budget_category
+    @budget_category = ["Home_Rent", "Utilities", "Food_Groceries", "Departmental", "Entertainment", "Car_Auto", "Insurance_Medical", "Misc"]
+  end
+
+  # getter method for budget category percentage
+  def budget_category_percentage
+    @budget_category_percentage = [0.30, 0.25, 0.15, 0.10, 0.04, 0.06, 0.07, 0.03]
+  end
+
+#generate budget method 
+   def generate_budget
+    @h = Hash.new
+    @budget_category = ["Home_Rent", "Utilities", "Food_Groceries", "Departmental", "Entertainment", "Car_Auto", "Insurance_Medical", "Misc"]
+    @budget_category_percentage = [0.30, 0.25, 0.15, 0.10, 0.04, 0.06, 0.07, 0.03]
+
+#loop through budget category item and calculate pecentage, then store in a hash
+
+    @budget_category.each_with_index do |expense_item, expense_index|
+      @percentage_for_budget_item = @budget_category_percentage[expense_index]
+      @calculated_budget_for_item = @amount.to_f * @percentage_for_budget_item.to_f
+      @h.store("#{expense_item}".to_s, @calculated_budget_for_item.to_f.round(2))
+    end
+
+    @h
+
+  end
+
+end
+
+#Aggressive savings type decorator class
+
+class AggressiveSavings
+  def initialize(basic_budget)
+    @basic_budget = basic_budget
+  end
+
+#generate budget method 
+
+  def generate_budget
+    @h = Hash.new
+    
+    #deduct aggressive savings percentage from budget amount
+    
+    @aggressive_priority_savings = @basic_budget.aggressive_savings
+    @var = @basic_budget.amount.to_f * @aggressive_priority_savings
+    @new_amount = @basic_budget.amount.to_f - @var.to_f
+    @savings_type_name = 'aggressive'
+
+    @get_budget_category = @basic_budget.budget_category
+    @get_budget_percentage = @basic_budget.budget_category_percentage
+
+#loop through budget category item and calculate pecentage, then store in a hash
+    @get_budget_category.each_with_index do |expense_item, expense_index|
+      @percentage_for_budget_item = @get_budget_percentage[expense_index]
+      @calculated_budget_for_item = @new_amount.to_f * @percentage_for_budget_item.to_f
+      @h.store("#{expense_item}".to_s, @calculated_budget_for_item.to_f.round(2))
+    end
+
+   @h
+  end
+end
+
+#Medium savings type decorator class
+class MediumSavings
+  def initialize(basic_budget)
+    @basic_budget = basic_budget
+  end
+
+#generate budget method 
+
+  def generate_budget
+    @h = Hash.new
+    
+    #deduct medium savings percentage from budget amount
+    
+    @medium_priority_savings = @basic_budget.medium_savings
+    @var = @basic_budget.amount.to_f * @medium_priority_savings
+    @new_amount = @basic_budget.amount.to_f - @var.to_f
+    @savings_type_name = 'medium'
+
+    @get_budget_category = @basic_budget.budget_category
+    @get_budget_percentage = @basic_budget.budget_category_percentage
+
+#loop through budget category item and calculate pecentage, then store in a hash
+    @get_budget_category.each_with_index do |expense_item, expense_index|
+      @percentage_for_budget_item = @get_budget_percentage[expense_index]
+      @calculated_budget_for_item = @new_amount.to_f * @percentage_for_budget_item.to_f
+      @h.store("#{expense_item}".to_s, @calculated_budget_for_item.to_f.round(2))
+    end
+
+   @h
+  end
+end
+
+#Low savings type decorator class
+class LowSavings
+  def initialize(basic_budget)
+    @basic_budget = basic_budget
+  end
+
+#generate budget method 
+
+  def generate_budget
+    @h = Hash.new
+    
+     #deduct low savings percentage from budget amount
+     
+    @low_priority_savings = @basic_budget.low_savings
+    @var = @basic_budget.amount.to_f * @low_priority_savings
+    @new_amount = @basic_budget.amount.to_f - @var.to_f
+    @savings_type_name = 'low'
+
+    @get_budget_category = @basic_budget.budget_category
+    @get_budget_percentage = @basic_budget.budget_category_percentage
+
+#loop through budget category item and calculate pecentage, then store in a hash
+    @get_budget_category.each_with_index do |expense_item, expense_index|
+      @percentage_for_budget_item = @get_budget_percentage[expense_index]
+      @calculated_budget_for_item = @new_amount.to_f * @percentage_for_budget_item.to_f
+      @h.store("#{expense_item}".to_s, @calculated_budget_for_item.to_f.round(2))
+    end
+
+   @h
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: budgetGenerator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- weje praise
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies: []
+description: 'Budget generator gem allows users make smart monthly savings according
+  to three different types of savings mode: Aggressive, medium and low. This generates
+  a hash that can be used to build a budget feature within an application. Created
+  by weje praise, 2019'
+email: wejepraise@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/budgetGenerator.rb
+homepage: http://github.com/wejeel/budget-generator
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: This is a budget generator gem. It was built to help people plan their finances
+  with the most common expenses.
+test_files: []