je_crowdfund 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eecf1a23692aa22c3ec570eea372ddecf925e591ccc681419f5d8edb8fc12711
+  data.tar.gz: 9019a82ce5ea00ed98d256b3fa29619f51132ec41596401e4a67059eec12e9f7
+SHA512:
+  metadata.gz: 8ad2b8173657f52c6bc140d5fd44a6b0970501d1d00f1feea5bc719d2e29080fc15b4d9bccf020efe0426d4548b6bc3bdc4b006712041da73e36691058b43d42
+  data.tar.gz: 4b1a273469f6bb1972a11ac46183a1fb866cf0ea1a19532f9d5b7dcbe5a1349de57336c4e273d177ccdf908dee97559350b5ab6b685717990515ec52956b6969

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Jonathan Eccles
+
+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.md

@@ -0,0 +1,3 @@
+The [Pragmatic Studios](https://pragmaticstudio.com) Crowd Fund bonus game created in their Learn Ruby course. 
+
+Projects can be added, funded, have funds removed and received pledges. There may also be some special types of project lurking...

data/bin/crowdfund

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/crowdfund/fundrequest'
+
+# project1 = Project.new("wooden whistle", 600, 500, 1)
+# project2 = Project.new("paper notebook", 150)
+# project3 = Project.new("brush", 100, 0)
+
+crowd_list = CrowdFund::FundRequest.new("crowd funding")
+# crowd_list.add_project(project1)
+# crowd_list.add_project(project2)
+# crowd_list.add_project(project3)
+
+crowd_list.load_projects(File.join(File.dirname(__FILE__), 'project_list.csv'))
+
+rounds = ARGV.shift || "1"
+crowd_list.request_funding(rounds.to_i)
+
+loop do
+  puts("\nRun another funding roung? (y/n): ")
+  answer = gets.chomp.downcase
+  case answer
+  when 'y', 'yes'
+    crowd_list.request_funding(1)
+  when 'n', 'no', 'x', 'q', 'quit', 'exit'
+    crowd_list.print_stats
+  break
+  else
+    puts "Enter 'y' or 'n' only"
+  end
+end
+
+crowd_list.save_unfunded_projects("#{crowd_list.name.downcase.gsub(' ', '_')}_unfunded_projects.txt")

data/bin/project_list.csv

@@ -0,0 +1,3 @@
+Wooden whistle, 100, 0, 0
+Paper notebook, 500, 50, 1
+Brush, 1000, 100, 2

data/lib/crowdfund/die.rb

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

data/lib/crowdfund/fundable.rb

@@ -0,0 +1,19 @@
+module CrowdFund
+  module Fundable
+    def funded?
+      funding_gap <= 0
+    end
+  
+    def add_funds(amount = 25)
+      self.funding += amount
+      self.backers += 1
+      puts "Project #{name} got an addtional £#{amount} in funding!"        
+    end
+  
+    def remove_funds(amount = 15)
+      self.funding -= amount
+      self.backers -= 1
+      puts "Project #{name} lost £#{amount} in funding!"        
+    end
+  end
+end

data/lib/crowdfund/funding_round.rb

@@ -0,0 +1,17 @@
+require_relative 'die'
+require_relative 'pledge_pool'
+
+module CrowdFund
+  module FundingRound
+    def self.one_round(project)
+      die = Die.new
+      @number_rolled = die.roll
+      if @number_rolled.even?
+        project.add_funds
+      else
+        project.remove_funds
+      end
+      project.record_pledge(PledgePool.random)
+    end
+  end
+end

data/lib/crowdfund/fundrequest.rb

@@ -0,0 +1,65 @@
+require 'csv'
+require_relative 'project'
+require_relative 'funding_round'
+
+module CrowdFund
+  class FundRequest
+    attr_reader :name
+  
+    def initialize(name)
+      @name = name.capitalize
+      @projects = []
+    end
+  
+    def load_projects(filename)
+      CSV.foreach(filename) do |line|
+        add_project(Project.from_csv(line))
+      end
+    end
+  
+    def save_unfunded_projects(to_file = "unfunded_projects.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "#{@name} Unfunded Projects:"
+        under_funded = @projects.filter { |p| p.funded? == false }
+        under_funded.sort.each { |uf| file.puts uf.name_and_funding }
+      end
+    end
+  
+    def add_project(project)
+      @projects << project
+    end
+
+    def request_funding(rounds)
+      puts "There are #{@projects.size} projects in the #{@name} project list:"
+      puts @projects
+    
+      1.upto(rounds) do |round|
+        puts "\nRound: #{round}"
+        @projects.each do |project|
+          FundingRound.one_round(project)
+        end
+      end
+  
+      print_stats
+    end
+
+    def print_stats
+      puts "\nFunding Results"
+  
+      fully_funded, under_funded = @projects.partition { |p| p.funded? }
+      puts "\n#{fully_funded.size} projects funded"
+      fully_funded.each {|ff| puts ff.name_and_funding}
+  
+      puts "\n#{under_funded.size} projects under funded"
+      under_funded.sort.each {|uf| puts uf.name_and_funding}
+  
+      @projects.sort.each do |project|
+        puts "\nProject #{project.name}'s pledges:"
+        project.each_donated_pledge do |pledge|
+          puts "£#{pledge.amount} in #{pledge.name} pledges"
+        end
+        puts "£#{project.pledges} in total pledges"
+      end
+    end
+  end
+end

data/lib/crowdfund/government_match_project.rb

@@ -0,0 +1,15 @@
+require_relative 'project'
+
+module CrowdFund
+  class GovernmentMatchProject < Project
+    def initialize(name, funding_goal, funding = 0, backers = 0)
+      super(name, funding_goal, funding, backers)
+      @name = "[GOV MATCH] #{name.capitalize}"
+    end
+
+    def add_funds(amount = 25)
+      super(amount) if funding_gap <= @funding_goal / 2
+      super(amount)
+    end
+  end
+end

data/lib/crowdfund/grant_project.rb

@@ -0,0 +1,24 @@
+require_relative 'project'
+
+module CrowdFund
+  class GrantProject < Project
+    def initialize(name, funding_goal, funding = 0, backers = 0)
+      super(name, funding_goal, funding, backers)
+      @name = "[GRANT] #{name.capitalize}"
+    end
+  
+    def remove_funds(amount = 0)
+      puts "Project #{@name} is a Grant Project and cannot have funds removed!"        
+    end
+  end
+
+  if __FILE__ == $0
+    grant = GrantProject.new("battery", 150)
+    puts grant.name_and_funding
+    grant.add_funds(100)
+    2.times { grant.add_funds }
+    puts grant.name_and_funding
+    8.times { grant.remove_funds }
+    puts grant.name_and_funding
+  end
+end

data/lib/crowdfund/pledge_pool.rb

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

data/lib/crowdfund/pledgeable.rb

@@ -0,0 +1,19 @@
+module CrowdFund
+  module Pledgeable
+    def record_pledge(pledge)
+      self.pledges_received[pledge.name] += pledge.amount	
+      puts "Project #{name} received a #{pledge.name} pledge worth £#{pledge.amount}."
+      puts "Project #{name}\s pledges #{pledges_received}"
+    end
+
+    def pledges
+      pledges_received.values.reduce(0, :+)
+    end
+
+    def each_donated_pledge
+      pledges_received.each do |name, points|
+        yield(Pledge.new(name, points))
+      end
+    end
+  end
+end

data/lib/crowdfund/project.rb

@@ -0,0 +1,45 @@
+require_relative 'fundable'
+require_relative 'pledgeable'
+
+module CrowdFund
+  class Project
+    include Fundable, Pledgeable
+  
+    attr_reader :funding_goal
+    attr_accessor :name, :funding, :backers, :pledges_received
+  
+    def initialize(name, funding_goal, funding = 0, backers = 0)
+      @name = name.capitalize
+      @funding_goal = funding_goal
+      @funding = funding
+      @backers = backers
+      @pledges_received = Hash.new(0)
+    end
+
+    def self.from_csv(csv_line)
+      Project.new(csv_line[0], Integer(csv_line[1]), Integer(csv_line[2]), Integer(csv_line[3]))
+    end
+
+    def funding_gap
+      funding_goal - funding - pledges
+    end
+
+    def name_and_funding
+      "#{@name.ljust(20, '.')} £#{@funding + pledges} of £#{@funding_goal}"
+    end
+
+    def <=>(project)
+      project.funding_gap <=> self.funding_gap
+    end
+
+    def to_s
+      "Project #{@name} has £#{@funding + pledges} in funding and pledges from #{@backers} backer(s) towards a goal of £#{@funding_goal} leaving a gap of £#{funding_gap} as of #{Time.now.strftime("%F %T")}"
+    end
+  end
+
+
+  if __FILE__ == $0
+    project1 = Project.new("testbed", 1000, 500, 10)
+    puts project1
+  end
+end

data/spec/crowdfund/fundrequest_spec.rb

@@ -0,0 +1,29 @@
+require 'crowdfund/fundrequest'
+
+module CrowdFund
+  describe FundRequest do
+    before do
+      $stdout = StringIO.new
+      @crowd_list = FundRequest.new("crowd funding")
+      @project1 = Project.new("wooden whistle", 600, 500, 1)
+      @crowd_list.add_project(@project1)
+    end
+
+    it "adds funds if an even number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(2)
+    
+      expect{ @crowd_list.request_funding(2) }.to change(@project1, :funding).by(25 * 2)
+    end
+
+    it "removes funds if an odd number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(5)
+    
+      expect{ @crowd_list.request_funding(2) }.to change(@project1, :funding).by(-15 * 2)
+    end
+
+    it "assigns a pledge for funding during a project funding round" do
+      @crowd_list.request_funding(1)
+      expect(@project1.pledges).to_not be_zero
+    end
+  end
+end

data/spec/crowdfund/government_match_project_spec.rb

@@ -0,0 +1,29 @@
+require 'crowdfund/government_match_project'
+
+module CrowdFund
+  describe GovernmentMatchProject do
+    before do
+      $stdout = StringIO.new
+      @initial_funding = 150
+      @initial_backers = 1
+      @funding_goal = 1000
+      @name = "hover car"
+      @match = GovernmentMatchProject.new(@name, @funding_goal, @initial_funding, @initial_backers)
+    end
+  
+    it "has a capitalized name" do
+      expect(@match.name).to eq("[GOV MATCH] #{@name.capitalize}")
+    end
+  
+    it "does not match funds while under half funded" do
+      amount = 150
+      expect{ @match.add_funds(amount) }.to change(@match, :funding).by(150)
+    end
+
+    it "matches additional funds when projects are at least half funded" do
+      amount = 100
+      @match.add_funds(350)
+      expect{ @match.add_funds(amount) }.to change(@match, :funding).by(200)
+    end
+  end
+end

data/spec/crowdfund/grant_project_spec.rb

@@ -0,0 +1,23 @@
+require 'crowdfund/grant_project'
+
+module CrowdFund
+  describe GrantProject do
+    before do
+      $stdout = StringIO.new
+      @initial_funding = 150
+      @initial_backers = 1
+      @funding_goal = 10000
+      @name = "hover car"
+      @grant = GrantProject.new(@name, @funding_goal, @initial_funding, @initial_backers)
+    end
+  
+    it "has a capitalized name" do
+      expect(@grant.name).to eq("[GRANT] #{@name.capitalize}")
+    end
+  
+    it "does not decrease funds when funds are removed" do
+      amount = 15
+      expect{ @grant.remove_funds(amount) }.to change(@grant, :funding).by(0)
+    end
+  end
+end

data/spec/crowdfund/pledge_pool_spec.rb

@@ -0,0 +1,45 @@
+require 'crowdfund/pledge_pool'
+   
+module CrowdFund
+  describe Pledge do
+    before do
+      @pledge = Pledge.new(:silver, 75)
+    end
+
+    it "has a name attribute" do
+      expect(@pledge.name).to eq(:silver)
+    end
+
+    it "has a points attribute" do
+      expect(@pledge.amount).to eq(75)
+    end
+  end
+
+  describe PledgePool do
+    it "has four pledge levels" do
+      expect(PledgePool::PLEDGES.size).to eq(4)
+    end
+
+    it "has a base level worth 25" do
+      expect(PledgePool::PLEDGES[0]).to eq(Pledge.new(:base, 25))
+    end
+
+    it "has a bronze level worth £50" do
+      expect(PledgePool::PLEDGES[1]).to eq(Pledge.new(:bronze, 50))
+    end
+
+    it "has a silver level worth £50" do
+      expect(PledgePool::PLEDGES[2]).to eq(Pledge.new(:silver, 75))
+    end
+
+    it "has a gold level worth £100" do
+      expect(PledgePool::PLEDGES[3]).to eq(Pledge.new(:gold, 100))
+    end
+
+    it "returns a random pledge" do
+      pledge = PledgePool.random
+
+      expect(PledgePool::PLEDGES).to include(pledge)
+    end
+  end
+end

data/spec/crowdfund/project_spec.rb

@@ -0,0 +1,107 @@
+require 'crowdfund/project'
+require 'crowdfund/pledge_pool'
+
+module CrowdFund
+  describe Project do
+    before do
+      $stdout = StringIO.new
+      @initial_funding = 150
+      @initial_backers = 1
+      @funding_goal = 10000
+      @name = "hover car"
+      @project = Project.new(@name, @funding_goal, @initial_funding, @initial_backers)
+    end
+  
+    it "has a capitalized name" do
+      expect(@project.name).to eq(@name.capitalize)
+    end
+  
+    it "has an initial target funding goal" do
+      expect(@project.funding_goal).not_to eq(0)
+    end
+  
+    it "computes the total funding outstanding as the target funding amount minus the funding amount" do
+      expect(@project.funding_gap).to eq(@project.funding_goal - @initial_funding)
+    end
+  
+    it "increases funds by 25 when funds are added" do
+      amount = 25
+      expect{ @project.add_funds(amount) }.to change(@project, :funding).by(amount)
+    end
+  
+    it "increases backers by 1 when funds are added" do
+      amount = 25
+      expect{ @project.add_funds(amount) }.to change(@project, :backers).by(1)
+    end
+
+    it "decreases funds by 15 when funds are removed" do
+      amount = 15
+      expect{ @project.remove_funds(amount) }.to change(@project, :funding).by(-amount)
+    end
+
+    it "decreases backers by 1 when funds are removed" do
+      amount = 15
+      expect{ @project.remove_funds(amount) }.to change(@project, :backers).by(-1)
+    end
+
+    it "is not fully funded when funding < funding_goal" do
+      expect(@project.funded?).to eq(false)
+    end
+
+    it "yields each pledge level and its total value" do
+      @project.record_pledge(Pledge.new(:gold, 100))
+      @project.record_pledge(Pledge.new(:gold, 100))
+      @project.record_pledge(Pledge.new(:silver, 75))
+      @project.record_pledge(Pledge.new(:bronze, 50))
+      @project.record_pledge(Pledge.new(:bronze, 50))
+      @project.record_pledge(Pledge.new(:bronze, 50))
+      @project.record_pledge(Pledge.new(:base, 25))
+      @project.record_pledge(Pledge.new(:base, 25))
+
+      pledged = []
+      @project.each_donated_pledge do |pledge|
+        pledged << pledge
+      end
+
+      expect(pledged).to eq([
+        Pledge.new(:gold, 200),
+        Pledge.new(:silver, 75),
+        Pledge.new(:bronze, 150),
+        Pledge.new(:base, 50)
+      ])
+    end
+
+    it "can be created from a CSV string" do
+      aggregate_failures "from_csv record" do
+        project = Project.from_csv(["jon", "200", "0", "0"])
+  
+        expect(project.name).to eq("Jon")
+        expect(project.funding_goal).to eq(200)
+        expect(project.funding).to eq(0)
+        expect(project.backers).to eq(0)
+      end
+    end
+  
+  
+    context "created with a default funding amount" do
+      before do
+        @project = Project.new(@name, @funding_goal)
+      end
+    
+      it "has a default value of 0 for funding amount" do
+        expect(@project.funding).to eq(0)
+      end
+    end
+
+    context "fully funded" do
+      before do
+        @initial_funding = @funding_goal
+        @project = Project.new(@name, @funding_goal, @initial_funding, @intial_backers)
+      end
+   
+      it "is fully funded when funding gap <= 0" do
+        expect(@project.funded?).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: je_crowdfund
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Eccles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: "The [Pragmatic Studios](https://pragmaticstudio.com) Crowd Fund bonus
+  game created in their Learn Ruby course. \n\nProjects can be added, funded, have
+  funds removed and received pledges. There may also be some special types of project
+  lurking..."
+email: getjon@me.com
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/crowdfund
+- bin/project_list.csv
+- lib/crowdfund/die.rb
+- lib/crowdfund/fundable.rb
+- lib/crowdfund/funding_round.rb
+- lib/crowdfund/fundrequest.rb
+- lib/crowdfund/government_match_project.rb
+- lib/crowdfund/grant_project.rb
+- lib/crowdfund/pledge_pool.rb
+- lib/crowdfund/pledgeable.rb
+- lib/crowdfund/project.rb
+- spec/crowdfund/fundrequest_spec.rb
+- spec/crowdfund/government_match_project_spec.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/project_spec.rb
+homepage: https://pragmaticstudio.com/courses/ruby
+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.1.4
+signing_key:
+specification_version: 4
+summary: Pragmatic Studio Ruby course Crowd Funding bonus game
+test_files:
+- spec/crowdfund/project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/fundrequest_spec.rb
+- spec/crowdfund/government_match_project_spec.rb
+- spec/crowdfund/grant_project_spec.rb