crowd_fund_dubesoftware 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e34d49648882cce1048ea25e0c28fb65c2e7c98256f6a57204f7fbee4fb0b51
+  data.tar.gz: 44d07ca6daaf98b1c91662dbe7744acddc47543d2872701f390ae7c8f60c8546
+SHA512:
+  metadata.gz: aa38f2cf8e014867cf28f0ab836c46c7608590defcf3809c727bc328673aac031a6a89dfbbef62fb9811699cd440af5a93586bd1c1a4a2f91d3f366548f71462
+  data.tar.gz: 6ad0e4f280950ce21993a4bd4ec88c2c2a6d8f5b4156cf32b965421bcbc9e9bf7aca1e9d1d754edca340981c6d911632f8869c1eb102da129531d84f05875358

data/LICENSE

@@ -0,0 +1,16 @@
+MIT No Attribution
+
+Copyright 2022 @dubesoftware
+
+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.
+
+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,3 @@
+A console-based funding program written in Ruby.
+
+This program is the outcome of bonus exercise work for the excellent Ruby course by Mike and Nicole Clark of The Pragmatic Studio.

data/bin/crowd_fund

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/crowd_fund/project'
+require_relative '../lib/crowd_fund/project_manager'
+
+project_manager = CrowdFund::ProjectManager.new("VC-Friendly Start-up Projects")
+default_project_file = File.join(File.dirname(__FILE__), 'projects.csv')
+project_manager.load_projects(ARGV.shift || default_project_file)
+
+loop do
+  puts("How many funding rounds? ('quit' to exit)")
+  answer = gets.chomp.downcase
+  
+  case answer
+  when /^\d+$/
+    project_manager.request_funding(Integer(answer))
+  when 'quit', 'exit'
+    project_manager.print_stats
+    break
+  else
+    puts("Please enter a number or 'quit'")
+  end
+end
+
+project_manager.save_needed_funding

data/bin/projects.csv

@@ -0,0 +1,3 @@
+Project1,100,0
+Project2,500,50
+Project3,1000,100

data/lib/crowd_fund/die.rb

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

data/lib/crowd_fund/fundable.rb

@@ -0,0 +1,28 @@
+module CrowdFund
+  module Fundable
+  
+    def add_funds
+      self.current_funding_amount += 25
+      puts "\nProject #{name} got $25 more!"
+    end
+  
+    def remove_funds
+      self.current_funding_amount -= 15
+      puts "\nProject #{name} lost $15!"
+    end
+  
+    def add_to_funds(amount)
+      self.current_funding_amount += amount
+      puts "\nProject #{name} got #{amount} funds!"
+    end
+  
+    def remove_from_funds(amount)
+      self.current_funding_amount -= amount
+      puts "\nProject #{name} lost #{amount} funds!"
+    end
+  
+    def fully_funded?
+      total_funding_received >= target_funding_amount
+    end
+  end
+end

data/lib/crowd_fund/funding_round.rb

@@ -0,0 +1,20 @@
+require_relative 'die'
+require_relative 'pledge_pool'
+
+module CrowdFund
+  module FundingRound
+    def self.fund(project)
+      die = Die.new
+    
+      case die.roll % 2
+      when 0
+        project.add_funds
+      when 1
+        project.remove_funds
+      end
+    
+      pledge = PledgePool.random
+      project.received_pledge(pledge)  
+    end
+  end
+end

data/lib/crowd_fund/grant_project.rb

@@ -0,0 +1,14 @@
+require_relative 'project'
+
+module CrowdFund
+  class GrantProject < Project
+  
+    def remove_funds
+      "Grant projects do not allow removal of funds."
+    end
+  
+    def remove_from_funds(amount)
+      "Grant projects do not allow deduction from funds."
+    end
+  end
+end

data/lib/crowd_fund/matched_funds_project.rb

@@ -0,0 +1,17 @@
+require_relative 'project'
+
+module CrowdFund
+  class MatchedFundsProject < Project
+  
+    def initialize(name, initial_funding_amount, target_funding_amount = 0, matching_ratio = 0.5)
+      super(name, initial_funding_amount, target_funding_amount)
+      @matching_ratio = matching_ratio
+    end
+  
+    def match_funds
+      if @current_funding_amount >= (target_funding_amount * 0.5)
+        add_to_funds(target_funding_amount * 0.5)
+      end
+    end
+  end
+end

data/lib/crowd_fund/pledge_pool.rb

@@ -0,0 +1,16 @@
+module CrowdFund
+  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/crowd_fund/project.rb

@@ -0,0 +1,57 @@
+require_relative 'die'
+require_relative 'pledge_pool'
+require_relative 'fundable'
+
+module CrowdFund
+  class Project
+    include Fundable
+  
+    attr_accessor :name, :current_funding_amount
+    attr_reader :initial_funding_amount, :target_funding_amount
+  
+    def initialize(name, initial_funding_amount, target_funding_amount = 0)
+      @name = name
+      @current_funding_amount = @initial_funding_amount = initial_funding_amount
+      @target_funding_amount = target_funding_amount
+      @received_pledges = Hash.new(0)
+    end
+  
+    def to_s
+      "Project #{@name} has $#{total_funding_received} towards a goal of $#{@target_funding_amount}."
+    end
+  
+    def total_funding_still_needed
+      @target_funding_amount - total_funding_received
+    end
+  
+    def received_pledge(pledge)
+      @received_pledges[pledge.name] += pledge.amount
+      puts "#{@name} received a #{pledge.name} pledge worth $#{pledge.amount}."
+      puts "#{@name}'s pledges: #{@received_pledges}"
+    end
+  
+    def pledges
+      @received_pledges.values.reduce(0, :+)
+    end
+  
+    def total_funding_received
+      @current_funding_amount + pledges
+    end
+  
+    def each_received_pledge
+      @received_pledges.each do |name, amount|
+        yield Pledge.new(name, amount)
+      end
+    end
+  
+    def funding_needed_entry
+      formatted_name = @name.ljust(20, '.')
+      "#{formatted_name} #{total_funding_still_needed}"
+    end
+  
+    def self.from_csv(string)
+      name, initial_funding_amount = string.split(',')
+      Project.new(name, Integer(initial_funding_amount))
+    end
+  end
+end

data/lib/crowd_fund/project_manager.rb

@@ -0,0 +1,91 @@
+require 'csv'
+require_relative 'funding_round'
+require_relative 'pledge_pool'
+
+module CrowdFund
+  class ProjectManager
+    attr_reader :title
+  
+    def initialize(title)
+      @title = title
+      @projects = []
+    end
+  
+    def add_project(project)
+      @projects << project
+    end
+  
+    def load_projects(from_file)
+      CSV.foreach(from_file) do |row|
+        project = Project.new(row[0], row[1].to_i)
+        add_project(project)
+      end
+    end
+  
+    def print_pledge_amounts
+      pledges = PledgePool::PLEDGES
+    
+      puts "\nThere are #{pledges.size} possible pledge amounts:"
+      pledges.each do |pledge|
+        puts "\tA #{pledge.name} pledge is worth $#{pledge.amount}."
+      end
+    end
+  
+    def request_funding(rounds)
+      puts "There are #{@projects.size} projects in #{title}:"
+      puts @projects
+    
+      print_pledge_amounts    
+      puts "\n"
+
+      1.upto(rounds) do
+        @projects.each do |project|
+          FundingRound.fund(project)
+          puts project
+        end
+      end
+    end
+  
+    def print_name_and_total_funding_received(project)
+      puts "#{project.name} (#{project.total_funding_received})"
+    end
+  
+    def print_stats 
+      puts "\n#{@title} Statistics:"
+    
+      fully_funded_projects, under_funded_projects = @projects.partition { |p| p.fully_funded?  }
+    
+      puts "\n#{fully_funded_projects.size} fully-funded projects:"
+      fully_funded_projects.each do |p|
+        print_name_and_total_funding_received(p)
+      end
+    
+      puts "\n#{under_funded_projects.size} under-funded projects:"
+      under_funded_projects.each do |p|
+        print_name_and_total_funding_received(p)
+      end
+    
+      @projects.each do |project|
+        puts "\nProject #{project.name}'s pledges:"
+        project.each_received_pledge do |pledge|
+          puts "$#{pledge.amount} in #{pledge.name} pledges"
+        end
+      end
+    
+      puts "\n#{@title} Needing Contributions:"
+      under_funded_projects.sort { |p| p.total_funding_still_needed }.each do |p|
+        formatted_name = p.name.ljust(20, '.')
+        puts "#{formatted_name} #{p.total_funding_still_needed}"
+      end
+    end
+  
+    def save_needed_funding(to_file="needed_funding.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "#{@title} Needing Funding:"
+        @projects.select { |project| project.total_funding_still_needed > 0 }.sort.each do |project|
+          file.puts(project.funding_needed_entry)
+        end
+      end
+    end
+  end
+end

data/spec/crowd_fund/grant_project_spec.rb

@@ -0,0 +1,27 @@
+require 'crowd_fund/spec_helper'
+require 'crowd_fund/grant_project'
+
+module CrowdFund
+  describe GrantProject do
+  
+    before do
+      $stdout = StringIO.new
+      @name = "Test Grant Project"
+      @initial_funding_amount = 2000
+      @target_funding_amount = 10000
+      @grant_project = GrantProject.new(@name, @initial_funding_amount, @target_funding_amount)
+    end
+  
+    it "does not allow funds to be removed" do
+      @grant_project.remove_funds
+    
+      @grant_project.current_funding_amount.should == @initial_funding_amount
+    end
+  
+    it "does not allow deduction from funds" do
+      @grant_project.remove_from_funds(500)
+    
+      @grant_project.current_funding_amount.should == @initial_funding_amount
+    end
+  end
+end

data/spec/crowd_fund/matched_funds_project_spec.rb

@@ -0,0 +1,29 @@
+require 'crowd_fund/spec_helper'
+require 'crowd_fund/matched_funds_project'
+
+module CrowdFund
+  describe MatchedFundsProject do
+  
+    before do
+      $stdout = StringIO.new
+      @name = "Test Matched Funds Project"
+      @initial_funding_amount = 250
+      @target_funding_amount = 750
+      @matching_ratio = 0.5
+      @matched_funds_project = MatchedFundsProject.new(@name, @initial_funding_amount, @target_funding_amount, @matching_ratio)
+    end
+  
+    it "does not match funds when less than half of target funds have been received" do
+      @matched_funds_project.match_funds
+    
+      @matched_funds_project.current_funding_amount.should == @initial_funding_amount
+    end
+  
+    it "matches funds when half or more of target funds have been received" do
+      @matched_funds_project.add_to_funds(250)
+      @matched_funds_project.match_funds
+    
+      @matched_funds_project.current_funding_amount.should == 875
+    end
+  end
+end

data/spec/crowd_fund/pledge_pool_spec.rb

@@ -0,0 +1,39 @@
+require 'crowd_fund/spec_helper'
+require 'crowd_fund/pledge_pool'
+
+module CrowdFund
+  describe Pledge do
+
+    before do
+      @pledge = Pledge.new(:bronze, 50)
+    end
+
+    it "has a name attribute" do
+      @pledge.name.should == :bronze
+    end
+
+    it "has an amount attribute" do
+      @pledge.amount.should == 50
+    end
+
+  end
+
+  describe PledgePool do
+
+    it "has three pledges" do
+      PledgePool::PLEDGES.size.should == 3
+    end
+
+    it "has a bronze pledge worth $50" do
+      PledgePool::PLEDGES[0].should == Pledge.new(:bronze, 50)
+    end
+
+    it "has a silver pledge worth $75" do
+      PledgePool::PLEDGES[1].should == Pledge.new(:silver, 75)
+    end
+
+    it "has a gold pledge worth $100" do
+      PledgePool::PLEDGES[2].should == Pledge.new(:gold, 100)
+    end
+  end
+end

data/spec/crowd_fund/project_spec.rb

@@ -0,0 +1,105 @@
+require 'crowd_fund/spec_helper'
+require 'crowd_fund/project'
+require 'crowd_fund/pledge_pool'
+
+module CrowdFund
+  describe Project do
+
+    before do
+      $stdout = StringIO.new
+      @name = "Test Project"
+      @initial_funding_amount = 1000
+      @target_funding_amount = 5000
+      @project = Project.new(@name, @initial_funding_amount, @target_funding_amount)
+    end
+  
+    it "has an initial target funding amount" do
+      @project.initial_funding_amount.should == 1000
+    end
+  
+    it "computes the total funding outstanding as the target funding amount minus the total funding received" do
+      @project.total_funding_still_needed.should == @project.target_funding_amount - @project.total_funding_received
+    end
+  
+    it "increases funds by 25 when funds are added" do
+      Die.any_instance.stub(:roll).and_return(2)
+    
+      @project.add_funds
+    
+      @project.current_funding_amount.should == @initial_funding_amount + 25
+    end
+  
+    it "decreases funds by 15 when funds are removed" do
+      Die.any_instance.stub(:roll).and_return(1)
+    
+      @project.remove_funds
+    
+      @project.current_funding_amount.should == @initial_funding_amount - 15
+    end
+  
+    it "adds funds to a project when an even number is rolled" do
+      Die.any_instance.stub(:roll).and_return(2)
+    
+      @project.add_funds
+    
+      @project.current_funding_amount.should == @initial_funding_amount + 25
+    end
+  
+    it "removes funds from a project when an odd number is rolled" do
+      Die.any_instance.stub(:roll).and_return(1)
+    
+      @project.remove_funds
+    
+      @project.current_funding_amount.should == @initial_funding_amount - 15
+    end
+  
+    it "is fully funded when the total funding amount equals or exceeds the target funding amount" do
+      Die.any_instance.stub(:roll).and_return(2)
+    
+      @project.add_to_funds(4000)
+    
+      @project.should be_fully_funded
+    end
+  
+    it "yields each received pledge and its total amount" do
+      @project.received_pledge(Pledge.new(:bronze, 40))
+      @project.received_pledge(Pledge.new(:silver, 65))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+      @project.received_pledge(Pledge.new(:gold, 90))
+    
+      yielded = []
+      @project.each_received_pledge do |pledge|
+        yielded << pledge
+      end
+    
+      yielded.should == [
+        Pledge.new(:bronze, 40),
+        Pledge.new(:silver, 65),
+        Pledge.new(:gold, 720)
+      ]
+    end  
+  
+    it "can be created from a CSV string" do
+      project = Project.from_csv("Project1,150")
+
+      project.name.should == "Project1"
+      project.initial_funding_amount.should == 150
+    end
+  
+    context "created with a default value of 0 for funding amount" do
+      before do
+        @project = Project.new(@name, @initial_funding_amount=0)
+      end
+    
+      it "has a default value of 0 for funding amount" do
+        @project.initial_funding_amount.should == 0
+      end
+    end
+  end
+end

data/spec/crowd_fund/spec_helper.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: crowd_fund_dubesoftware
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "@dubesoftware"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-31 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: |-
+  A console-based funding program written in Ruby.
+
+  This program is the outcome of bonus exercise work for the excellent Ruby course by Mike and Nicole Clark of The Pragmatic Studio.
+email: zebra05+crowdfund@gmail.com
+executables:
+- crowd_fund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowd_fund
+- bin/projects.csv
+- lib/crowd_fund/die.rb
+- lib/crowd_fund/fundable.rb
+- lib/crowd_fund/funding_round.rb
+- lib/crowd_fund/grant_project.rb
+- lib/crowd_fund/matched_funds_project.rb
+- lib/crowd_fund/pledge_pool.rb
+- lib/crowd_fund/project.rb
+- lib/crowd_fund/project_manager.rb
+- spec/crowd_fund/grant_project_spec.rb
+- spec/crowd_fund/matched_funds_project_spec.rb
+- spec/crowd_fund/pledge_pool_spec.rb
+- spec/crowd_fund/project_spec.rb
+- spec/crowd_fund/spec_helper.rb
+homepage: https://github.com/dubesoftware/ruby-programming/tree/main/crowd_fund
+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.3.24
+signing_key:
+specification_version: 4
+summary: A console-based game written in Ruby.
+test_files:
+- spec/crowd_fund/grant_project_spec.rb
+- spec/crowd_fund/matched_funds_project_spec.rb
+- spec/crowd_fund/pledge_pool_spec.rb
+- spec/crowd_fund/project_spec.rb
+- spec/crowd_fund/spec_helper.rb