crowdfund_tr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6cfb4c115c9a9fe452030b678bc2e4d3438b378
+  data.tar.gz: 7d184cbf32505f0dad908ba9de3a2949cc1239f3
+SHA512:
+  metadata.gz: fac06f0fb7201af825d5eed58a8bd1fd70d867fb5de474a77d933f14e78dd4af7c473277cc75af5c753217c6f0c63630f1c8f8c348ca1e916656b5711447b74c
+  data.tar.gz: 2bf45f015b800e5f66f7c8de87c6c54a3575ce147373b71d8dd2ea15d832501a05dfeb518547e6a9491657b1c15e9c0b4ed42dc72ee7da759e4e55cacf1dc22f

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015 Todd Ruhlen
+
+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,18 @@
+A simple, text-based crowdfunding simulator.  Run a group of projects through a
+series of funding rounds, in which they either receive or lose funds, or are
+skipped.  They also receive a random pledge.  Grant projects never lose funds.
+Match projects have all future funding matched after they reach half-funding.
+Statistics are printed to the console at the end of the simulation.
+
+The normal projects can be specified in a '.csv' file that is given as a command
+line argument when loading the program, or the default projects can be used. The
+format for 'csv' entries is Project Name,Goal,Initial_funding with a comma and
+no spaces between entries and underscores in place of commas within larger
+numbers (e.g. Your Project,10_000,0).
+
+The option is given to save a list of underfunded projects upon exiting the
+program.  The list is saved in 'underfunded.txt' in the top-level folder of the
+application.
+
+Created as a bonus project while completing the Pragmatic Studio Ruby
+Programming course.

data/bin/crowdfund

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+# def say_funding(project, funding=0)
+#   "#{project} has $#{funding} in funding as of #{time}."
+# end
+#
+# def time
+#   current_time = Time.new
+#   current_time.strftime("%A, %m/%d/%y")
+# end
+require_relative '../lib/crowdfund/groupfundrequest'
+require_relative '../lib/crowdfund/grant_project'
+require_relative '../lib/crowdfund/match_project'
+
+tech_projects = Crowdfund::GroupFundRequest.new("Tech Projects")
+default_project_file = File.join(File.dirname(__FILE__), "tech_projects.csv")
+tech_projects.load_projects(ARGV.shift || default_project_file)
+help_out = Crowdfund::GrantProject.new("Help Out", 10_000, 1_000)
+matched = Crowdfund::MatchProject.new("Sponsored", 50_000)
+tech_projects.add_project(help_out)
+tech_projects.add_project(matched)
+
+
+tech_projects.request_funding(1)
+tech_projects.print_funding_status
+tech_projects.print_underfunded
+
+loop do
+  puts "\nHow many rounds of funding should we do? (type 'quit' to exit)"
+  answer = gets.chomp.downcase
+  case answer
+  when /^\d+$/
+    tech_projects.request_funding(answer.to_i)
+  when 'quit', 'exit'
+    tech_projects.print_funding_status
+    tech_projects.print_underfunded
+    break
+  else
+    puts "Please enter a number or 'quit'"
+  end
+end
+
+if tech_projects.underfunded != []
+  puts "\nWould you like to save a list of underfunded projects to send to your friends?"
+  answer = gets.chomp.downcase
+  case answer
+  when 'yes', 'y'
+    tech_projects.save_underfunded
+  else
+    puts "Cheers!"
+  end
+else
+  puts "\nAll projects are fully funded!"
+end

data/bin/tech_projects.csv

@@ -0,0 +1,5 @@
+Airing,100_000,630_649
+Curb,25_000,12_335
+Mikeme,25_000,100_174
+Happy Feet,1_000,525
+Your Project,23_000,0

data/lib/crowdfund/die.rb

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

data/lib/crowdfund/fundable.rb

@@ -0,0 +1,22 @@
+module Crowdfund
+  module Fundable
+
+    def add_funds(amount=25)
+      self.funding += amount
+      puts "#{name} gained some funds!"
+    end
+
+    def lose_funds(amount=15)
+      self.funding -= amount
+      puts "#{name} lost some funds!"
+    end
+
+    def funds_needed
+      goal - funding
+    end
+
+    def fully_funded?
+      funds_needed <= 0
+    end
+  end
+end

data/lib/crowdfund/funding_round.rb

@@ -0,0 +1,25 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'pledge_pool'
+
+module Crowdfund
+  module FundingRound
+    def self.do_round(project)
+      die = Die.new
+      case die.roll
+      when 4..6
+        project.add_funds
+      when 2..3
+        puts "#{project.name} received no funds this time."
+      else
+        project.lose_funds
+      end
+      project.receive_pledge
+    end
+  end
+end
+
+if __FILE__ == $0
+  project = Project.new("Airing", 100_000, 630_649)
+  FundingRound.do_round(project)
+end

data/lib/crowdfund/grant_project.rb

@@ -0,0 +1,11 @@
+require_relative 'project'
+
+module Crowdfund
+  class GrantProject < Project
+
+    def lose_funds
+      puts "#{name} cannot lose funds. It is a grant project."
+    end
+
+  end
+end

data/lib/crowdfund/groupfundrequest.rb

@@ -0,0 +1,88 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'funding_round'
+require_relative 'pledge_pool'
+require 'csv'
+
+module Crowdfund
+  class GroupFundRequest
+    attr_reader :projects
+
+    def initialize(name)
+      @name = name
+      @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],Integer(row[1]),Integer(row[2]))
+        add_project(project)
+      end
+    end
+
+    def request_funding(rounds)
+      puts "\nThere are #{@projects.count} projects in #{@name}:"
+      puts @projects
+      puts "\nThere are #{PledgePool::PLEDGES.count} possible pledge amounts:"
+      PledgePool::PLEDGES.each { |pledge| puts "A #{pledge.name} pledge is worth $#{pledge.amount}" }
+      n = 0
+      1.upto(rounds) do
+        n += 1
+        puts "\n  Round #{n}:"
+        @projects.each { |project| puts "The funding goal of #{project.name} is $#{project.goal}." }
+        @projects.each { |project|
+          FundingRound.do_round(project)
+          if project.fully_funded?
+            puts "#{project.name} is FULLY FUNDED. (Currently $#{project.funding} toward the goal of $#{project.goal}.)\n"
+          else
+            puts "#{project.name} still needs funds. (Currently $#{project.funding} toward the goal of $#{project.goal}.)\n"
+          end
+        }
+      end
+    end
+
+    def print_funding_status
+      puts "\nCurrent Funding of All Projects: "
+      @projects.sort.each { |project| puts "#{project.name} funding: $#{project.funding} of $#{project.goal} "}
+      fully_funded, underfunded = @projects.partition { |project| project.fully_funded? }
+      puts "\nFully Funded Projects: #{fully_funded.size}\nUnderfunded Projects: #{underfunded.size}"
+    end
+
+    def underfunded
+      @projects.sort.reject { |project| project.fully_funded? }
+    end
+
+    def print_underfunded
+      underfunded.each { |project| puts "#{project.name} still needs $#{project.funds_needed}."}
+    end
+
+    def save_underfunded
+      to_file = File.join(File.dirname(File.dirname(File.dirname(__FILE__))), "underfunded.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "Projects that still need funds:"
+        underfunded.each do |project|
+          file.puts "#{project.name} still needs $#{project.funds_needed}."
+        end
+      end
+      puts "The list of underfunded projects has been saved in \"underfunded.txt\"."
+    end
+  end
+end
+
+if __FILE__ == $0
+  project1 = Project.new("Test1", 10_000)
+  project2 = Project.new("Test2", 20_000, 2_000)
+  group = GroupFundRequest.new("Test Group")
+  group.add_project(project1)
+  group.add_project(project2)
+  group.request_funding(2)
+  project3 = Project.new("Test3", 1_000)
+  group.add_project(project3)
+  group.request_funding(3)
+  group.print_funding_status
+  group.print_underfunded
+end

data/lib/crowdfund/match_project.rb

@@ -0,0 +1,27 @@
+require_relative 'project'
+
+module Crowdfund
+  class MatchProject < Project
+
+    def match?
+      @funding >= @goal / 2.0
+    end
+
+    def add_funds(amount=25)
+      if match?
+        super(amount * 2)
+      else
+        super
+      end
+    end
+
+    def receive_pledge
+      if match?
+        match_factor = 2
+        super(match_factor)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/crowdfund/pledge_pool.rb

@@ -0,0 +1,15 @@
+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/crowdfund/project.rb

@@ -0,0 +1,56 @@
+require_relative 'pledge_pool'
+require_relative 'fundable'
+
+module Crowdfund
+  class Project
+    include Fundable
+
+    attr_reader :goal, :pledges
+    attr_accessor :name, :funding
+
+    def initialize (name, goal, funding=0)
+      @name = name
+      @goal = goal
+      @funding = funding
+      @pledges = Hash.new(0)
+    end
+
+    def <=>(other_project)
+      other_project.funding <=> funding
+    end
+
+
+    def receive_pledge(match_factor=1)
+      pledge = PledgePool.random
+      puts "#{name} received a #{pledge.name} pledge worth $#{pledge.amount}."
+      @pledges[pledge.name] += pledge.amount * match_factor
+      @funding += pledge.amount * match_factor
+      puts "#{name}'s pledge amounts:"
+      each_pledge { |pledge| puts "$#{pledge.amount} in #{pledge.name} pledges" }
+    end
+
+    def each_pledge
+      @pledges.sort_by { |name, amount| amount }.each { |name, amount| yield Pledge.new(name, amount) }
+    end
+
+    def to_s
+      "#{@name} has $#{@funding} in funding towards a goal of $#{@goal}."
+    end
+  end
+end
+
+if __FILE__ == $0
+  project = Project.new("Test Project", 10_000)
+  puts project.name
+  puts project.funding
+  project.add_funds
+  puts project.funding
+  project.lose_funds
+  puts project.funding
+  5.times { project.add_funds }
+  puts project.funding
+  puts project
+  puts project.funds_needed
+  project.receive_pledge
+  puts project
+end

data/spec/crowdfund/grant_project_spec.rb

@@ -0,0 +1,20 @@
+require 'crowdfund/grant_project'
+
+module Crowdfund
+  describe GrantProject do
+
+    before do
+      @goal = 10_000
+      @initial_funding = 100
+      @granted = GrantProject.new("Help Out", @goal, @initial_funding)
+      $stdout = StringIO.new
+    end
+
+    it "does not lose funds even when lose funds is called on it" do
+      @granted.lose_funds
+
+      expect(@granted.funding).to eq(@initial_funding)
+    end
+
+  end
+end

data/spec/crowdfund/groupfundrequest_spec.rb

@@ -0,0 +1,39 @@
+# These tests were broken by the addition of pledges.
+#
+# require 'crowdfund/groupfundrequest'
+#
+# module Crowdfund
+#   describe GroupFundRequest do
+#     before do
+#       @group = GroupFundRequest.new("Group")
+#       @initial_funding = 500
+#       @project = Project.new("Test", 10_000, @initial_funding)
+#       @group.add_project(@project)
+#       $stdout = StringIO.new
+#     end
+#
+#     it "adds funds when a 4, 5, or 6 are rolled" do
+#       allow_any_instance_of(Die).to receive(:roll).and_return(4)
+#
+#       @group.request_funding(2)
+#
+#       expect(@project.funding).to eq(@initial_funding + (25 * 2))
+#     end
+#
+#     it "funding doesn't change when a 2 or 3 are rolled" do
+#       allow_any_instance_of(Die).to receive(:roll).and_return(3)
+#
+#       @group.request_funding(2)
+#
+#       expect(@project.funding).to eq(@initial_funding)
+#     end
+#
+#     it "removes funds ($10) when a 1 is rolled" do
+#       allow_any_instance_of(Die).to receive(:roll).and_return(1)
+#
+#       @group.request_funding(2)
+#
+#       expect(@project.funding).to eq(@initial_funding - (15 * 2))
+#     end
+#   end
+# end

data/spec/crowdfund/match_project_spec.rb

@@ -0,0 +1,47 @@
+require 'crowdfund/match_project'
+
+module Crowdfund
+  describe MatchProject do
+
+    before do
+      @goal = 1_000
+      @initial_funding = 350
+      @matched = MatchProject.new("Matched", @goal, @initial_funding)
+      $stdout = StringIO.new
+    end
+
+    it "receives funding like other projects while its secured funding is less than 50% of its goal" do
+      @matched.add_funds
+
+      expect(@matched.funding).to eq(375)
+
+      @matched.receive_pledge
+
+      if @matched.pledges.include?(:bronze)
+        expect(@matched.funding).to eq(425)
+      elsif @matched.pledges.include?(:silver)
+        expect(@matched.funding).to eq(450)
+      else
+        expect(@matched.funding).to eq(475)
+      end
+    end
+
+    it "when its secured funding equals or exceeds 50% of its goal, all additions to its funding are matched" do
+      @matched.add_funds(150)
+      @matched.add_funds
+
+      expect(@matched.funding).to eq(550)
+
+      @matched.receive_pledge
+
+      if @matched.pledges.include?(:bronze)
+        expect(@matched.funding).to eq(650)
+      elsif @matched.pledges.include?(:silver)
+        expect(@matched.funding).to eq(700)
+      else
+        expect(@matched.funding).to eq(750)
+      end
+    end
+
+  end
+end

data/spec/crowdfund/pledge_pool_spec.rb

@@ -0,0 +1,43 @@
+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 an amount attribute" do
+      expect(@pledge.amount).to eq(75)
+    end
+
+  end
+
+  describe PledgePool do
+    it "has 3 pledge types" do
+      expect(PledgePool::PLEDGES.size).to eq(3)
+    end
+
+    it "has a bronze pledge worth $50" do
+      expect(PledgePool::PLEDGES).to include(Pledge.new(:bronze, 50))
+    end
+
+    it "has a silver pledge with $75" do
+      expect(PledgePool::PLEDGES).to include(Pledge.new(:silver, 75))
+    end
+
+    it "has a gold pledge worth $100" do
+      expect(PledgePool::PLEDGES).to include(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,75 @@
+require 'crowdfund/project'
+
+module Crowdfund
+  describe Project do
+
+    before do
+      @initial_target = 10_000
+      @project = Project.new("Test", @initial_target, 200)
+      $stdout = StringIO.new
+    end
+
+    it "has an initial target funding amount" do
+      expect(@project.goal).to eq(10_000)
+    end
+
+    it "computes funds needed" do
+      expect(@project.funds_needed).to eq(9800)
+    end
+
+    it "increases funds by 25 when funds are added" do
+      @project.add_funds
+      expect(@project.funding).to eq(225)
+    end
+
+    it "decreases founds by 15 when funds are removed" do
+      @project.lose_funds
+      expect(@project.funding).to eq(185)
+    end
+
+    context "created without funding amount given" do
+      before do
+        @project = Project.new("Test", 10_000)
+      end
+
+      it "has a default value of 0 for funding amount" do
+        expect(@project.funding).to eq(0)
+      end
+    end
+
+    context "has not reached its funding goal" do
+      before do
+        @project = Project.new("Test", 10_000, 9999)
+      end
+
+      it "has a state of 'not fully funded'" do
+        expect(@project).not_to be_fully_funded
+      end
+    end
+
+    context "has reached its funding goal" do
+      before do
+        @project = Project.new("Test", 10_000, 10_000)
+      end
+
+      it "has a state of 'fully funded'" do
+        expect(@project).to be_fully_funded
+      end
+    end
+
+    context "in a collection of projects" do
+      before do
+        @project1 = Project.new("Test1", 10_000, 2_000)
+        @project2 = Project.new("Test2", 10_000, 5_000)
+        @project3 = Project.new("Test3", 10_000, 10_000)
+
+        @projects = [@project1, @project2, @project3]
+      end
+
+      it "returns sorted array in order from most funding to least" do
+        expect(@projects.sort).to eq([@project3, @project2, @project1])
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: crowdfund_tr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Todd Ruhlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A simple, text-based crowdfunding simulator.  Run a group of projects through a
+  series of funding rounds, in which they either receive or lose funds, or are
+  skipped.  They also receive a random pledge.  Grant projects never lose funds.
+  Match projects have all future funding matched after they reach half-funding.
+  Statistics are printed to the console at the end of the simulation.
+
+  The normal projects can be specified in a '.csv' file that is given as a command
+  line argument when loading the program, or the default projects can be used. The
+  format for 'csv' entries is Project Name,Goal,Initial_funding with a comma and
+  no spaces between entries and underscores in place of commas within larger
+  numbers (e.g. Your Project,10_000,0).
+
+  The option is given to save a list of underfunded projects upon exiting the
+  program.  The list is saved in 'underfunded.txt' in the top-level folder of the
+  application.
+
+  Created as a bonus project while completing the Pragmatic Studio Ruby
+  Programming course.
+email: rhythmtome@yahoo.com
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowdfund
+- bin/tech_projects.csv
+- lib/crowdfund/die.rb
+- lib/crowdfund/fundable.rb
+- lib/crowdfund/funding_round.rb
+- lib/crowdfund/grant_project.rb
+- lib/crowdfund/groupfundrequest.rb
+- lib/crowdfund/match_project.rb
+- lib/crowdfund/pledge_pool.rb
+- lib/crowdfund/project.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/groupfundrequest_spec.rb
+- spec/crowdfund/match_project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/project_spec.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple text-based crowdfunding simulator created during the Pragmatic Studio
+  Ruby Programming course.
+test_files:
+- spec/crowdfund/match_project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/groupfundrequest_spec.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/project_spec.rb