tlc_ps_crowdfund 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a406c2852a27d3897874565eaa2d3833db2d7ca
+  data.tar.gz: 740b3f68e2e60f006f3947b524c68363085784da
+SHA512:
+  metadata.gz: e836e4a9a21b929d3049b0383c9ad0399c75c4ad80c9b653e183a39e0d6b38678abe920f0b9b1f709d1ae2a5d871de046a3479935961dfef3fab8530e6541318
+  data.tar.gz: e08fc8bdddf8834aaba1788522b6f3a8fe54af20148b411619ba80228f73906d141c8db373818625306b2fac4da755d0ddc557576765b8b59c4d3a1d268727bc

data/LICENSE

@@ -0,0 +1,8 @@
+    Copyright (c) 2014 Travis Lee Cuzick
+
+
+    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 is a fundraising app developed as part of the Pragmatic Studio's course on the Ruby programming language.

data/bin/crowdfund

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+chmod +x bin/crowdfund
+
+require_relative '../lib/fundraising_project/project'
+require_relative '../lib/fundraising_project/fundrequest'
+require_relative '../lib/fundraising_project/matched_funds_project'
+require_relative '../lib/fundraising_project/grant_project'
+project1 = CrowdFund::GrantProject.new("ABC", 100, 1000)
+project2 = CrowdFund::MatchedFundsProject.new("LMN", 500, 3000)
+project3 = CrowdFund::Project.new("XYZ", 25, 75)
+project_queue1 = CrowdFund::FundRequest.new("Q1 Projects")
+project_queue1.add_project(project1)
+project_queue1.add_project(project2)
+project_queue1.add_project(project3)
+
+default_project_file = File.join(File.dirname(__FILE__), 'projects.csv')
+project_queue1.load_projects(ARGV.shift || default_project_file)
+
+loop do
+  puts "\nHow many funding rounds? ('quit' to exit)"
+  rounds = gets.chomp.downcase
+  
+  case rounds 
+  when /^\d+$/
+    rounds = rounds.to_i
+    puts "\nHow much funding should be added or removed?"
+    funds = gets.chomp  
+      case funds
+      when /^\d+$/
+        funds = funds.to_i
+        project_queue1.alter_funding(funds, rounds)      
+      when nil
+        project_queue1.alter_funding(rounds)     
+      else
+        puts "Please enter a valid number"
+      end    
+  when 'quit', 'exit'
+    project_queue1.print_stats
+    break    
+  else
+    puts "Please enter a valid number of rounds or 'quit'"
+  end
+end
+
+project_queue1.print_funding_summary("to_csv")

data/bin/projects.csv

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

data/lib/fundraising_project/die.rb

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

data/lib/fundraising_project/fundable.rb

@@ -0,0 +1,18 @@
+module CrowdFund
+  module Fundable
+    def add_funds(amount=25)
+      self.current_funding_amount += amount
+      self.current_funding_amount = self.current_funding_amount.to_i   
+      puts "Project #{self.name} got more funds!"
+    end
+
+    def remove_funds(amount=15)
+      self.current_funding_amount -= amount
+      puts "Project #{self.name} lost some funds!"    
+    end  
+
+    def fully_funded?
+      self.total_funds >= self.target_funding_amount
+    end  
+  end
+end

data/lib/fundraising_project/funding_round.rb

@@ -0,0 +1,22 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'pledge_pool'
+
+module CrowdFund
+  module FundingRound
+    def self.randomize_funds (project, amount)
+        die = Die.new()
+          if die.roll % 2 == 0 || die.roll % 3 == 0
+            project.add_funds(amount)
+          else 
+            project.remove_funds(amount)
+          end 
+    end
+    def self.random_pledge(project)
+      pledge = PledgePool::PLEDGES.sample
+      project.pledges[pledge.name] += pledge.amount
+      puts "Project #{project.name} received a #{pledge.name} pledge worth $#{pledge.amount}."
+      puts "Project #{project.name}'s pledges: #{project.pledges}"
+    end
+  end
+end

data/lib/fundraising_project/fundrequest.rb

@@ -0,0 +1,79 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'funding_round'
+require 'csv'
+
+module CrowdFund
+  class FundRequest
+    def initialize(project_name)
+      @project_name = project_name
+      @projects = []
+    end
+    def add_project(project)
+      @projects << project
+    end  
+    def load_projects(from_file)
+      CSV.foreach(from_file) do |row|
+        add_project(Project.new(row[0], row[1].to_i, row[2].to_i))
+      end
+    end  
+    def save_projects(to_file)
+      File.open(to_file, "w") do |file|
+        file.puts
+      end
+    end
+    def print_funds_needs(project)
+
+    end
+    def print_funding_summary(method, to_file="funding_needed.csv")
+      funded, not_funded = @projects.partition { |project| project.fully_funded?} 
+      messages = [
+        "\n",
+        "#{funded.size} projects are fully funded.\n",
+        "\n#{not_funded.size} projects are under-funded.\n",      
+        "\nProjects needing more funds:\n"      
+        ]
+      not_funded.sort { |a, b| b.funding_needed <=> a.funding_needed}.each do |project|
+        messages.push("Project #{project.name} ($#{project.funding_needed} still needed)") 
+      end
+        if method == "to_csv"
+          File.open(to_file, "w") do |file|
+            messages.shift
+            file.puts messages
+          end
+        else
+          puts messages
+        end
+      end
+     def print_stats
+        print_funding_summary("to_screen")
+        @projects.each do |project|
+          puts "\nProject #{project.name}'s pledges:"
+          project.each_pledge do |pledge|
+            puts "$#{pledge.amount} in #{pledge.name} pledges"
+          end
+          puts "$#{project.total_pledges} in total pledges"        
+        end        
+       end  
+
+    def alter_funding(amount=25, rounds)
+      puts "There are #{@projects.size} projects in the queue: "
+      @projects.each do |project|
+        puts project
+      end
+      puts "There are 3 possible pledge amounts:"
+      pledges = PledgePool::PLEDGES
+      pledges.each do |pledge|
+        puts "A #{pledge.name} pledge is worth $#{pledge.amount}."
+      end
+      1.upto(rounds) do |n|
+        puts "Round #{n}:\n"
+        @projects.each do |project|
+          FundingRound.randomize_funds(project, amount)
+          FundingRound.random_pledge(project)
+          puts project
+        end
+      end
+    end
+  end
+end

data/lib/fundraising_project/grant_project.rb

@@ -0,0 +1,8 @@
+require_relative 'project'
+
+module CrowdFund
+  class GrantProject < Project
+    def remove_funds(amount)    
+    end
+  end
+end

data/lib/fundraising_project/matched_funds_project.rb

@@ -0,0 +1,14 @@
+require_relative 'project'
+
+module CrowdFund
+  class MatchedFundsProject < Project
+    def half_funded?
+      (@target_funding_amount - total_funds) <= total_funds
+    end
+
+    def add_funds(amount=25)
+      amount *= 2 if half_funded?
+      super(amount)
+    end
+  end
+end

data/lib/fundraising_project/pledge_pool.rb

@@ -0,0 +1,10 @@
+module CrowdFund
+  Pledge = Struct.new(:name, :amount)
+  module PledgePool
+    PLEDGES = [
+      Pledge.new(:silver, 75),
+      Pledge.new(:gold, 100),
+      Pledge.new(:bronze, 50)
+      ]  
+  end
+end

data/lib/fundraising_project/project.rb

@@ -0,0 +1,40 @@
+require_relative "pledge_pool"
+require_relative 'fundable'
+
+module CrowdFund
+  class Project  
+    include Fundable
+
+    attr_reader :target_funding_amount, :pledges
+    attr_accessor :name, :current_funding_amount
+
+    def initialize(name, current_funding_amount=0, target_funding_amount=1000)
+      @name = name
+      @current_funding_amount = current_funding_amount
+      @target_funding_amount = target_funding_amount
+      @pledges = Hash.new(0)
+    end
+
+    def funding_needed
+      @target_funding_amount - total_funds
+    end
+
+    def total_pledges
+      @pledges.values.reduce(0) {|sum, value| sum + value}
+    end 
+
+    def total_funds
+      @current_funding_amount + total_pledges
+    end   
+
+    def to_s
+      "Project #{@name} has $#{total_funds} in funding towards a goal of $#{@target_funding_amount}."
+    end
+
+    def each_pledge
+      @pledges.each do |name, amount|
+        yield(Pledge.new(name, amount))
+      end
+    end
+  end
+end

data/spec/fundraising_project/fundrequest_spec.rb

@@ -0,0 +1,35 @@
+require 'fundraising_project/fundrequest'
+
+module CrowdFund
+  describe FundRequest do
+
+    before do
+      @request = FundRequest.new("BBN")
+      @initial_funding = 1000
+      @target_funding = 10000
+      @project = Project.new("RuppArena", @initial_funding, @target_funding)
+      @request.add_project(@project)
+    end
+
+    it "loses funding when a number not divisible by 2 or 3 is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(5)
+      delta = 25
+      @request.alter_funding(delta, 2)
+      expect(@project.current_funding_amount).to eq(@initial_funding - (delta * 2))
+    end
+
+    it "gains funding when an even number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(4)
+      delta = 25
+      @request.alter_funding(delta, 1)
+      expect(@project.current_funding_amount).to eq((@initial_funding + (delta)).to_i)
+    end  
+
+    it "gains funding when a number divisible by 3 is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(3)
+      delta = 25
+      @request.alter_funding(delta, 1)
+      expect(@project.current_funding_amount).to eq((@initial_funding + (delta)).to_i)
+    end    
+  end
+end

data/spec/fundraising_project/project_spec.rb

@@ -0,0 +1,64 @@
+require 'fundraising_project/project'
+
+module CrowdFund
+  describe Project do
+
+    before do
+      @project = Project.new("my_project")
+      @current_funding_amount = @project.current_funding_amount 
+    end
+
+    before do
+      $stdout = StringIO.new
+    end  
+
+    it "should have an initial target funding amount" do
+      expect(@project.target_funding_amount).not_to be_nil
+    end
+
+    it 'should have "funding needed"" equal to "target funding" - "initial funding"' do
+      expect(@project.funding_needed).to eq(@project.target_funding_amount - @project.current_funding_amount)
+    end
+
+    it "should increase funds by 25 when funds are added" do
+      @project.add_funds
+      expect(@project.current_funding_amount).to eq(@current_funding_amount + 25)
+    end  
+
+    it "should decrease funds by 15 when funds are removed" do
+      @project.remove_funds
+      expect(@project.current_funding_amount).to eq(@current_funding_amount - 15)
+    end    
+
+    it "should have a default value of 0 for funding amount" do
+      expect(@project.current_funding_amount).to eq(0)
+    end
+
+    context "with excess funds" do
+      before do
+        @project = Project.new("test_project", 1111, 1000)
+      end    
+      it "should have 'fully funded' equal to true" do
+        expect(@project).to be_fully_funded
+      end    
+    end
+
+    context "with exactly the target amount of funds" do
+      before do
+        @project = Project.new("test_project", 1000, 1000)
+      end    
+      it "should have 'fully funded' equal to true" do
+        expect(@project).to be_fully_funded
+      end    
+    end  
+
+    context "with less than the target amount of funds" do
+      before do
+        @project = Project.new("test_project", 800, 1000)
+      end    
+      it "should have 'fully funded' equal to false" do
+        expect(@project).not_to be_fully_funded
+      end    
+    end  
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: tlc_ps_crowdfund
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Travis Lee Cuzick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 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: This is a fundraising app developed as part of the Pragmatic Studio's
+  course on the Ruby programming language.
+email: tlcuzick@gmail.com
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowdfund
+- bin/projects.csv
+- lib/fundraising_project/die.rb
+- lib/fundraising_project/fundable.rb
+- lib/fundraising_project/funding_round.rb
+- lib/fundraising_project/fundrequest.rb
+- lib/fundraising_project/grant_project.rb
+- lib/fundraising_project/matched_funds_project.rb
+- lib/fundraising_project/pledge_pool.rb
+- lib/fundraising_project/project.rb
+- spec/fundraising_project/fundrequest_spec.rb
+- spec/fundraising_project/project_spec.rb
+homepage: http://www.pragmaticstudio.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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This is a simple fundraising app developed for the Pragmatic Studio Ruby
+  course.
+test_files:
+- spec/fundraising_project/fundrequest_spec.rb
+- spec/fundraising_project/project_spec.rb