crowdfund23 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c233a84593b27bd3d9a6c89ab028a60beab20ba27427aad01b5225ee5009ea08
+  data.tar.gz: 505c124fa05c915e54c901a2cc8dbcd0a5930252c52728a596b97c25b7cac433
+SHA512:
+  metadata.gz: 3fc99395f879209fe021eeb6564d4b2a69794e9e5d88aa56ad215455a6a5e78b7ebe3fa7fbbcb1649824b4b16346e041cea7fdfcc269d36e31b59e3c99acb5a0
+  data.tar.gz: 655197032c659a46a1d02991fb9d9a0ba7293c8c4f6932aae47dd727eb0c518a8c82e7e56ec2c671f6f90649699e7fe678c1fd9548baef00a63de9144ef720b1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 BluePeony
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1 @@
+This gem is the result of exercises as part of the Ruby Tutorial from PragmaticStudio.

data/bin/crowdfund23

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/crowdfund23/collection'
+project1 = Crowdfund23::Project.new("Books from random strangers", 500, 3000)
+project2 = Crowdfund23::Project.new("For the Love of Quote", 25, 75)
+project3 = Crowdfund23::Project.new("Sucky Sockets", 750, 1000)
+project4 = Crowdfund23::Project.new("Buy a house", 100000, 300000)
+project5 = Crowdfund23::GrantProject.new("A charity project", 500, 2000)
+
+collection = Crowdfund23::Collection.new("Test")
+default_project_file = File.join(File.dirname(__FILE__), 'my_projects.csv')
+collection.load_projects(ARGV.shift || default_project_file)
+collection.add_project(project5)
+
+loop do
+  puts "\nHow many rounds of funding? ('quit' or 'exit' to exit)"
+  answer = gets.chomp
+  case answer
+    when 'quit', 'exit'
+      collection.print_stats
+      collection.save_projects('underfunded_projects.csv')
+      break
+    when /^\d+$/
+      collection.request_funding(answer.to_i)
+    else
+      puts "Please enter a number or 'quit' or 'exit' to exit." 
+  end
+end

data/bin/my_projects.csv

@@ -0,0 +1,3 @@
+Book From Random Strangers, 50
+For the Love of Quote, 100
+Sucky Sockets, 250

data/lib/crowdfund23/collection.rb

@@ -0,0 +1,88 @@
+require_relative 'project'
+require_relative 'grant_project'
+require_relative 'die'
+require_relative 'funding_round'
+require_relative 'pledge_pool'
+require 'csv'
+
+module Crowdfund23
+	class Collection
+
+		def initialize(title)
+			@title = title
+			@projects = []
+		end
+
+		def add_project(project)
+			@projects << project
+		end
+
+		def print_stats
+
+			fully_funded, under_funded = @projects.partition {|project| project.fully_funded? }
+			puts "\n Statistics:"
+
+			puts "\n#{fully_funded.size} fully funded projects:"
+			print_name_and_fundings(fully_funded)
+
+			puts "\n#{under_funded.size} under funded projects:"
+			print_name_and_fundings(under_funded)
+
+			puts "\nStill need contributions:"
+			under_funded.sort {|a, b| b.fund_needed <=> a.fund_needed}.each do |project|
+				puts "#{project.name}: fundings needed: #{project.fund_needed}"
+			end
+
+			@projects.each do |project|
+				puts "\nProject #{project.name}'s pledges:"
+				project.each_pledge_received do |pledge|
+					puts "$#{pledge.amount} in #{pledge.name} pledges"
+				end
+				puts "$#{project.total_amount_pledges} in total pledges"
+			end
+		end
+
+		def print_name_and_fundings(projects)
+			projects.each do |p|
+				puts "#{p.name}: current funding: #{p.current_fund}; funding goal: #{p.fund_goal}"
+			end
+		end
+
+		def load_projects(from_file)
+			CSV.foreach(from_file) do |row|
+				add_project(Project.new(row[0], row[1].to_i))
+			end
+		end
+
+		def save_projects(to_file)
+			underfounded_projects = @projects.reject { |project| project.fully_funded? }
+			File.open(to_file, 'w') do |file|
+				underfounded_projects.each do |project|
+					file.puts "#{project.name} still needs $#{project.fund_needed} of funding."
+				end 
+			end
+		end
+
+		def request_funding(rounds)
+			puts "Currently there are #{@projects.size} projects in the pipeline."
+			puts @projects
+
+			pledges = PledgePool::PLEDGES
+			puts "\nThere are #{pledges.size} possible pledge amounts:"
+
+			pledges.each do |pledge|
+				puts "     A #{pledge.name} pledge is worth $#{pledge.amount}."
+			end
+
+			1.upto(rounds) do |round|
+				puts "\n Funding Round #{round}:"
+				@projects.each do |project|
+					FundingRound.adjust_funds(project)
+					puts project 
+				end
+			end
+
+			@projects.each 
+		end
+	end
+end

data/lib/crowdfund23/die.rb

@@ -0,0 +1,13 @@
+module Crowdfund23
+  class Die
+    attr_reader :number
+    
+    def initialize 
+      roll
+    end
+
+    def roll
+      @number = rand(1..6)
+    end
+  end
+end

data/lib/crowdfund23/fundable.rb

@@ -0,0 +1,23 @@
+module Crowdfund23
+  module Fundable
+
+    def add_funds(new_fund = 25)
+      self.current_fund += new_fund
+      puts "#{name} got more funds!"
+    end
+
+    def remove_funds(lost_fund = 15)
+      self.current_fund -= lost_fund
+      puts "#{name} lost some funds!"
+    end
+
+    def fund_needed
+      fund_goal - current_fund
+    end
+
+    def fully_funded?
+      fund_needed <= 0
+    end
+    
+  end
+end

data/lib/crowdfund23/funding_round.rb

@@ -0,0 +1,25 @@
+require_relative 'die'
+require_relative 'project'
+require_relative 'pledge_pool'
+
+module Crowdfund23
+  module FundingRound
+    def self.adjust_funds(project)
+      die = Die.new
+      number = die.roll
+      if number.even?
+        project.add_funds
+      else
+        project.remove_funds
+      end
+
+      if project.grant_project
+        project.matching_funds
+      end
+
+      pledge = PledgePool.random
+      project.store_pledge(pledge)
+      
+    end
+  end
+end

data/lib/crowdfund23/grant_project.rb

@@ -0,0 +1,35 @@
+require_relative 'project'
+
+module Crowdfund23
+  class GrantProject < Project
+
+    def initialize(name, current_fund, fund_goal)
+      super
+      @grant_project = true
+      @received_matched_funds = false
+    end
+
+    def remove_funds
+      puts "It's a grant project. Funds can't be removed."
+    end
+
+    def matching_funds
+      tipping_point_funds = fund_goal / 2.0
+      if fund_needed <= tipping_point_funds && !@received_matched_funds
+        add_funds(tipping_point_funds)
+        @received_matched_funds = true
+        puts "Congratulation! You received matching funds! The fund goal was: #{fund_goal}. The current fund is: #{current_fund}."
+      end
+    end
+  end
+
+  if __FILE__ == $0
+    project = GrantProject.new("grant project", 100, 500)
+    puts "current funds before the method: #{project.current_fund}"
+    project.remove_funds
+    puts "current funds after the method: #{project.current_fund}"
+
+    project.add_funds(160)
+    project.matching_funds
+  end
+end

data/lib/crowdfund23/pledge_pool.rb

@@ -0,0 +1,16 @@
+module Crowdfund23
+  Pledge = Struct.new(:name, :amount)
+
+  module PledgePool
+
+    PLEDGES = [
+      Pledge.new(:bronze, 50),
+      Pledge.new(:silver, 75),
+      Pledge.new(:gold, 100)
+    ]
+
+    def self.random
+      PLEDGES.sample
+    end
+  end
+end

data/lib/crowdfund23/project.rb

@@ -0,0 +1,41 @@
+require_relative 'pledge_pool'
+require_relative 'fundable'
+
+module Crowdfund23
+	class Project
+
+		include Fundable 
+
+		attr_reader :fund_goal, :pledges_received, :grant_project
+		attr_accessor :name, :current_fund
+
+		def initialize(name, current_fund = 0, fund_goal)
+			@name = name
+			@current_fund = current_fund
+			@fund_goal = fund_goal
+			@pledges_received = Hash.new(0)
+			@grant_project = false
+		end
+
+		def to_s
+			"#{@name} has $#{@current_fund} toward a goal of $#{@fund_goal}."
+		end
+
+		def store_pledge(pledge)
+			@pledges_received[pledge.name] += pledge.amount
+			@current_fund += pledge.amount
+			puts "#{@name} received a #{pledge.name} pledge worth $#{pledge.amount}."
+	    puts "#{@name}'s pledges: #{@pledges_received}"
+		end
+
+		def each_pledge_received
+			@pledges_received.each do |name, amount|
+				yield Pledge.new(name, amount)
+			end
+		end
+
+		def total_amount_pledges
+			@pledges_received.values.reduce(0, :+)
+		end
+	end
+end

data/spec/crowdfund23/collection_spec.rb

@@ -0,0 +1,61 @@
+require 'crowdfund23/collection'
+
+module Crowdfund23
+  describe Collection do
+
+    before do 
+      @collection = Collection.new("Test Collection")
+      @fund_now = 50
+      @fund_end = 100
+      @project = Project.new("First project", @fund_now, @fund_end)
+      @collection.add_project(@project)
+    end
+
+    it "has funds added (+25) when an even number is rolled" do 
+      Die.any_instance.stub(:roll).and_return(4)
+
+      @collection.request_funding(2)
+      pledges_amount_total = @project.pledges_received.values.reduce(0, :+)
+      expect(@project.current_fund).to eq @fund_now + pledges_amount_total + 25*2
+      #@project.current_fund.should == @fund_now + 25
+    end
+
+    it "has funds removed when an odd number is rolled" do 
+      Die.any_instance.stub(:roll).and_return(3)
+
+      @collection.request_funding(2)
+      pledges_amount_total = @project.pledges_received.values.reduce(0, :+)
+      expect(@project.current_fund).to eq @fund_now  + pledges_amount_total - 15*2
+      #@project.current_fund.should == @fund_now - 15
+    end
+
+
+    context "is fully funded" do
+
+      before do 
+        @fund_now = 100
+        @fund_goal = 100
+        @project = Project.new("Fully Funded", @fund_now, @fund_goal)
+      end
+
+      it "is fully funded if fund_needed is less than or equal to 0 " do 
+        expect(@project).to be_fully_funded
+        #@project.should be_fully_funded
+      end
+    end
+
+    context "is not yet fully funded" do 
+
+      before do
+        @fund_now = 10
+        @fund_goal = 100
+        @project = Project.new("Not Fully Funded", @fund_now, @fund_goal)
+      end
+
+      it "is not fully funded" do
+        expect(@project).not_to be_fully_funded
+        #@project.should_not be_fully_funded 
+      end
+    end
+  end
+end

data/spec/crowdfund23/pledge_pool_spec.rb

@@ -0,0 +1,43 @@
+require 'crowdfund23/pledge_pool'
+
+module Crowdfund23
+  describe Pledge do
+
+    before do
+      @pledge = Pledge.new(:bronze, 50)
+    end
+
+    it "has a name" do
+      expect(@pledge.name).to eq :bronze
+    end
+
+    it "has a pledge amount" do 
+      expect(@pledge.amount).to eq 50
+    end
+  end
+
+  describe PledgePool do 
+
+    it "has 3 pledges" do 
+      expect(PledgePool::PLEDGES.size).to eq 3
+    end
+
+    it "has a bronze pledge worth $50" do 
+      expect(PledgePool::PLEDGES[0]).to eq Pledge.new(:bronze, 50)
+    end
+
+    it "has a silver pledge worth $75" do 
+      expect(PledgePool::PLEDGES[1]).to eq Pledge.new(:silver, 75)
+    end
+
+    it "has a gold pledge worth $100" do 
+      expect(PledgePool::PLEDGES[2]).to eq Pledge.new(:gold, 100)
+    end
+
+    it "has a random method" do
+      pledge = PledgePool.random
+
+      expect(PledgePool::PLEDGES).to include(pledge)
+    end
+  end
+end

data/spec/crowdfund23/project_spec.rb

@@ -0,0 +1,57 @@
+require 'crowdfund23/project'
+require 'crowdfund23/pledge_pool'
+
+module Crowdfund23
+  describe Project do 
+
+    before do
+      @fund_now = 50 
+      @fund_target = 100
+      @project = Project.new("RSpec", @fund_now, @fund_target)
+      $stdout = StringIO.new
+    end
+
+    it "has an initial target amount" do 
+      @project.fund_goal.should == @fund_target
+    end
+
+    it "computes the total funding outstanding as the target funding amount minus the funding amount" do
+      @project.fund_needed.should == @fund_target - @fund_now   
+    end
+
+    it "increases funds by 25 when funds are raised" do     
+      @project.add_funds
+      expect(@project.current_fund).to eq @fund_now + 25
+      #@project.current_fund.should == @fund_now + 25
+    end
+
+    it "descreases funds by 15 when funds are removed" do 
+
+      @project.remove_funds
+      expect(@project.current_fund).to eq @fund_now - 15
+      #@project.current_fund.should == @fund_now - 15
+    end
+
+    it "adds the amount for a pledge to the total fundings received" do 
+      @project.add_funds
+      pledge = Pledge.new(:gold, 100)
+      @project.store_pledge(pledge)
+
+      expect(@project.current_fund).to eq 175
+    end
+
+
+    context "created with a default funding_amount" do 
+
+      before do 
+        @p = Project.new("Test for default amount", 50)
+      end
+
+      it "has a default value of 0 for funding amount" do 
+        expect(@p.current_fund).to eq 0
+        #@p.current_fund.should == 0
+      end
+    end
+   
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = [:should, :expect]
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+    mocks.syntax = [:should, :expect]
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: crowdfund23
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BluePeony
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: This gem is the result of exercises as part of the Ruby Tutorial from
+  PragmaticStudio.
+email: live_by@example.com
+executables:
+- crowdfund23
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowdfund23
+- bin/my_projects.csv
+- lib/crowdfund23/collection.rb
+- lib/crowdfund23/die.rb
+- lib/crowdfund23/fundable.rb
+- lib/crowdfund23/funding_round.rb
+- lib/crowdfund23/grant_project.rb
+- lib/crowdfund23/pledge_pool.rb
+- lib/crowdfund23/project.rb
+- spec/crowdfund23/collection_spec.rb
+- spec/crowdfund23/pledge_pool_spec.rb
+- spec/crowdfund23/project_spec.rb
+- spec/spec_helper.rb
+homepage: http://example.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A gem from exercise block of the Ruby course from PragmaticStudio
+test_files:
+- spec/crowdfund23/collection_spec.rb
+- spec/crowdfund23/pledge_pool_spec.rb
+- spec/crowdfund23/project_spec.rb
+- spec/spec_helper.rb