crowdfund_sergio_silva 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f504e5608564e2e76a9b02c6a93b438e6fed955a
+  data.tar.gz: ebb8b1ea04b6891bcb8f9cc98aefddbe6759f768
+SHA512:
+  metadata.gz: fd3dd8a2773fd9bbdd4136f66b0835b4913f6df03795c941dbe35e2924c757e222c2f2b566e3765d9a8d0c842ed097d8f268889498068c89bb79a418af085526
+  data.tar.gz: d5bc9de9151d96a9d3172e27f370532788d9b62b4f37c0b55deb6ea013657d386a599685c8eb68b6f97c256cebf3efa8d870e0170e9076b7fdf73f974cd15eb6

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 The Pragmatic Studio
+
+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:
+
+- You may not use this Software in other training contexts.
+
+- 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,6 @@
+This is an example application used in The Pragmatic Studio's
+Ruby Programming course, as described at
+
+  http://pragmaticstudio.com
+
+This code is Copyright 2012 The Pragmatic Studio. See the LICENSE file.

data/bin/crowdfund

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/crowdfund/project'
+require_relative '../lib/crowdfund/fundrequest'
+require_relative '../lib/crowdfund/grant_project'
+require_relative '../lib/crowdfund/matching_project'
+
+#create a fundrequest
+projects = Crowdfund::FundRequest.new("Ruby course Crowdfunding App")
+puts "#{ projects.title }\n\n"
+
+default_player_file = File.join(File.dirname(__FILE__), 'projects.csv')
+projects.load_projects(ARGV.shift || default_player_file)
+
+#Create other projects
+project4 = Crowdfund::MatchingProject.new("Match", 200)
+project5 = Crowdfund::GrantProject.new("Grant", 1_000, 300)
+
+#Adds these projects
+projects.add_project(project4)
+projects.add_project(project5)
+
+#Running
+loop do
+  puts "\nHow many rounds of funding? ('quit' to exit)"
+  answer = gets.chomp.downcase
+  case answer
+  when /^\d+$/
+    projects.request_funding(answer.to_i)
+  when 'quit', 'exit'
+    projects.print_stats
+    break
+  else
+    puts "Please enter a number or 'quit'"
+  end
+end
+
+#project1 = Crowdfund::Project.new("ABC", 1_000, 500)
+#project2 = Crowdfund::Project.new("LMN", 500, 3_000)
+#project3 = Crowdfund::Project.new("XYZ", 25, 75)
+
+
+#projects.add_project(project1)
+#projects.add_project(project2)
+#projects.add_project(project3)
+
+
+#projects.request_funding(4)
+
+#projects.print_stats

data/bin/projects.csv

@@ -0,0 +1,3 @@
+ABC,10000,5000
+LMN,3000,1500
+XYZ,300,500

data/bin/results.txt

@@ -0,0 +1,3 @@
+Projects needing some donation:
+Grant............... $300 under
+ABC................. $245 under

data/lib/crowdfund/die.rb

@@ -0,0 +1,20 @@
+module Crowdfund
+  class Die
+
+    attr_reader :number
+
+    def initialize
+      @number = 0
+    end
+
+    def roll
+      @number = 1 +rand(6)
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  die = Die.new()
+  puts die.roll
+end

data/lib/crowdfund/fundable.rb

@@ -0,0 +1,23 @@
+module Crowdfund
+  module Fundable
+
+    def remove_funds
+      @funding -= 15
+      puts "#{ @name } lost some funds!"
+    end
+
+    def add_funds
+      @funding += 25
+      puts "#{ @name } got more funds!"
+    end
+
+    def total_funding_outstanding
+      @target - total_funds
+    end
+
+    def fully_funded?
+      total_funding_outstanding <= 0
+    end
+
+  end
+end

data/lib/crowdfund/funding_round.rb

@@ -0,0 +1,23 @@
+require_relative 'die'
+require_relative 'project'
+
+module Crowdfund
+  module FundingRound
+
+    @die = Die.new
+
+    def self.round(project)
+    	number_rolled = @die.roll
+
+      if number_rolled.odd?
+        project.remove_funds
+      else
+        project.add_funds
+      end
+
+      pledge = PledgePool.random
+      project.received_pledge(pledge)
+    end
+
+  end
+end

data/lib/crowdfund/fundrequest.rb

@@ -0,0 +1,114 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'funding_round'
+require_relative 'pledge_pool'
+
+module Crowdfund
+  class FundRequest
+
+    attr_reader :title
+
+    def initialize(title)
+    	@title = title
+    	@projects = []
+    end
+
+    def add_project(project)
+    	@projects.push(project)
+    end
+
+    def request_funding(rounds)
+    	puts"There are #{ @projects.size } projects that you could fund"
+
+    	@projects.each do |project|
+    	  puts project
+    	end
+
+      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
+      puts"\n"
+
+      1.upto(rounds) do |round|
+        puts"Round: #{ round }"
+        @projects.each do |project|
+          FundingRound.round(project)
+          puts "#{ project }\n\n"
+        end
+      end
+    end
+
+    def print_name_and_funding(project)
+      puts "#{ project.name } - #{ project.funding }"
+    end
+
+    def print_name(project)
+      puts "Project #{ project.name }"
+    end
+
+    def print_stats
+      puts"\n#{ fully_funded_projects.size } Fully funded projects"
+      fully_funded_projects.each do |f|
+        print_name(f)
+      end
+
+      puts"\n#{ under_funded_projects.size } Under funded projects"
+      under_funded_projects.each do |u|
+        print_name(u)
+      end
+
+      sorted = sorted_under_funded_projects
+      puts"\nProjects needing some donation"
+      sorted.each do |s|
+        puts under_funded_entry(s)
+      end
+
+      @projects.each do |project|
+        puts"\n#{ project.name }'s pledges:"
+        project.each_received_pledge do |pledge|
+          puts "$#{ pledge.amount } in #{ pledge.name } pledges"
+        end
+        puts "#{ project.pledges } in total pledges"
+      end
+
+      save_under_funded_projects
+    end
+
+    def sorted_under_funded_projects
+      under_funded_projects.sort { |a, b| b.total_funding_outstanding <=> a.total_funding_outstanding}
+    end
+
+    def fully_funded_projects
+      @projects.select { |project| project.fully_funded? }
+    end
+
+    def under_funded_projects
+      @projects.reject { |project| project.fully_funded? }
+    end
+
+    def under_funded_entry(project)
+      formatted_name = project.name.ljust(20, '.')
+      "#{ formatted_name } $#{ project.total_funding_outstanding } under"
+    end
+
+    def load_projects(from_file)
+      File.readlines(from_file).each do |line|
+        name, target_funding_amount, funding = line.split(',')
+        project = Project.new(name, Integer(target_funding_amount), Integer(funding))
+        add_project(project)
+      end
+    end
+
+    def save_under_funded_projects(to_file="results.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "Projects needing some donation:"
+        sorted_under_funded_projects.each do |project|
+          file.puts(under_funded_entry(project))
+        end
+      end
+    end
+
+  end
+end

data/lib/crowdfund/grant_project.rb

@@ -0,0 +1,19 @@
+require_relative 'project'
+
+module Crowdfund
+  class GrantProject < Project
+
+    def remove_funds
+  	  puts"No funds can be removed from a grant project"
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  grant = GrantProject.new("Grant", 1_000, 300)
+
+  puts "#{grant.name} has $#{grant.total_funds} in funding towards a goal of $#{grant.target}."
+  grant.remove_funds
+  puts "#{grant.name} has $#{grant.total_funds} in funding towards a goal of $#{grant.target}."
+end

data/lib/crowdfund/matching_project.rb

@@ -0,0 +1,31 @@
+require_relative 'project'
+
+module Crowdfund
+  class MatchingProject < Project
+
+    def initialize(name, target_funding_amount, funding = 0)
+    	super(name, target_funding_amount, funding)
+    	@half_amount = target_funding_amount / 2
+    end
+
+    def half_amount?
+      @half_amount <= funding
+    end
+
+    def add_funds
+    	if half_amount?
+    	  @funding += (25 * 2)
+    	  puts "#{ name } has received at least half of its target amount"
+    	else
+        super
+      end
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  matching = MatchingProject.new("Matching 123", 200, 0)
+  6.times { matching.add_funds }
+  puts matching.funding
+end

data/lib/crowdfund/pledge_pool.rb

@@ -0,0 +1,22 @@
+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
+
+if __FILE__ == $0
+  puts PledgePool::PLEDGES
+  treasure = PledgePool.random
+  puts "You have received a #{pledge.name} pledge. It values $#{plege.points}"
+end

data/lib/crowdfund/project.rb

@@ -0,0 +1,54 @@
+require_relative 'pledge_pool'
+require_relative 'fundable'
+
+module Crowdfund
+  class Project
+    include Fundable
+
+    attr_accessor :name
+    attr_reader :target, :funding
+
+    def initialize(name, target_funding_amount, funding = 0)
+    	@name = name
+    	@target = target_funding_amount
+      @funding = funding
+      @pledges_container = Hash.new(0)
+    end
+
+    def to_s
+    	"#{ @name } has $#{ total_funds } in funding towards a goal of $#{ @target }."
+    end
+
+    def received_pledge(pledge)
+      @pledges_container[pledge.name] += pledge.amount
+      puts "#{ @name } received a #{ pledge.name } pledge worth $#{ pledge.amount }."
+      puts "#{ @name }'s pledges: #{ @pledges_container }"
+    end
+
+    def pledges
+      @pledges_container.values.reduce(0, :+)
+    end
+
+    def total_funds
+      @funding + pledges
+    end
+
+    def each_received_pledge
+      @pledges_container.each do|key, value|
+          pledge = Pledge.new(key, value)
+          yield(pledge)
+      end
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  project = Project.new("LMN", 500, 3_000)
+  puts project
+  puts project.target
+  project.add_funds
+  puts project.funding
+  project.remove_funds
+  puts project.funding
+end

data/spec/crowdfund/fundrequest_spec.rb

@@ -0,0 +1,42 @@
+require 'crowdfund/fundrequest'
+
+module Crowdfund
+  describe FundRequest do
+
+    before do
+    	@fundrequest = FundRequest.new("Ruby course Crowdfunding App")
+
+    	@initial_funds = 1_000
+    	@project = Project.new("ABC", 5_000, @initial_funds)
+
+    	@fundrequest.add_project(@project)
+    end
+
+    it "adds funds to a project if an even number is rolled" do
+    	allow_any_instance_of(Die).to receive(:roll).and_return(2)
+
+    	@fundrequest.request_funding(1)
+
+    	expect(@project.funding).to eq(@initial_funds + 25)
+    end
+
+    it "remove funds to a project if an odd number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(1)
+
+    	@fundrequest.request_funding(1)
+
+    	expect(@project.funding).to eq(@initial_funds - 15)
+    end
+
+    it "assigns a pledge for amount during a project's funding round" do
+      fundrequest = FundRequest.new("Ruby course Crowdfunding App")
+      project = Project.new("ABC", 5_000, @initial_funds)
+
+      fundrequest.add_project(project)
+      fundrequest.request_funding(1)
+
+      expect(project.pledges).to_not eq 0
+    end
+
+  end
+end

data/spec/crowdfund/grant_project_spec.rb

@@ -0,0 +1,20 @@
+require 'crowdfund/grant_project'
+
+module Crowdfund
+  describe GrantProject do
+
+    before do
+  	  @initial_funds = 1_000
+  	  @grant = GrantProject.new("Grant", 5_000, @initial_funds)
+    end
+
+    it "can not have its funds removed" do
+      expect(@grant.funding).to eq 1_000
+
+      @grant.remove_funds
+
+      expect(@grant.funding).to eq @initial_funds
+    end
+
+  end
+end

data/spec/crowdfund/matching_project_spec.rb

@@ -0,0 +1,30 @@
+require 'crowdfund/matching_project'
+
+module Crowdfund
+  describe MatchingProject do
+
+    before do
+    	@initial_funds = 0
+    	@matching = MatchingProject.new("Match", 200, @initial_funds)
+    end
+
+    it "does not match additional funds when the project is not halfway funded" do
+    	3.times { @matching.add_funds }
+
+    	expect(@matching.half_amount?).to be false
+    end
+
+    it "is halfway funded when it has received half of its target funding amount" do
+      4.times { @matching.add_funds }
+
+    	expect(@matching.half_amount?).to be true
+    end
+
+    it "receives twice as much added funds when it is halfway funded" do
+    	7.times { @matching.add_funds }
+
+    	expect(@matching.funding).to eq(@initial_funds + (4 * 25)+(3 * 25 * 2))
+    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(:bronze, 50)
+    end
+
+    it "has a name attribute" do
+      expect(@pledge.name).to be(:bronze)
+    end
+
+    it "has an amount attribute" do
+      expect(@pledge.amount).to eq 50
+    end
+
+  end
+end
+
+module Crowdfund
+  describe PledgePool do
+
+    it "has three 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 points" do
+      expect(PledgePool::PLEDGES[1]).to eq(Pledge.new(:silver, 75))
+    end
+
+    it "has a gold pledge worth 100 points" do
+      expect(PledgePool::PLEDGES[2]).to eq(Pledge.new(:gold, 100))
+    end
+
+    it "returns a random pledge" do
+      expect(PledgePool.random).to be_an_instance_of(Pledge)
+    end
+
+  end
+end

data/spec/crowdfund/project_spec.rb

@@ -0,0 +1,100 @@
+require 'crowdfund/project'
+
+module Crowdfund
+  describe Project do
+    before do
+    	@initial_founds = 1_000
+      @project = Project.new("ABC", 5_000, @initial_founds)
+    end
+
+    it "has an initial target funding amount" do
+    	expect(@project.target).to eq 5_000
+    end
+
+    it "computes the total funding outstantind as the target amount minus the funding amount" do
+      expect(@project.total_funding_outstanding).to eq (5_000 - 1_000)
+    end
+
+    it "increases funds by 25 when funds are added" do
+    	@project.add_funds
+
+    	expect(@project.funding).to eq(@initial_founds.to_i + 25)
+    end
+
+    it "decreases funds by 15 when funds are removed" do
+      @project.remove_funds
+
+      expect(@project.funding).to eq(@initial_founds.to_i - 15)
+    end
+
+    context "when a project is initialized with no initial funding amount" do
+      before do
+        @project = Project.new("LMN", 5_000)
+      end
+
+      it "has default value of 0 for funding amount" do
+        expect(@project.funding).to eq 0
+      end
+    end
+
+    context "when total funding outstanding is less than or equals zero" do
+      before do
+        @project = Project.new("LMN", 5_000, 5_000)
+      end
+
+      it "is fully funded" do
+        expect(@project).to be_fully_funded
+      end
+    end
+
+    context "when total funding outstanding is greater than zero" do
+      before do
+        @project = Project.new("LMN", 5_000, 1_000)
+      end
+
+      it "is not fully funded" do
+        expect(@project).to_not be_fully_funded
+      end
+    end
+
+    it "computes pledges as the sum of all pledges" do
+      expect(@project.pledges).to eq 0
+
+      @project.received_pledge(Pledge.new(:silver, 75))
+
+      expect(@project.pledges).to eq 75
+
+      @project.received_pledge(Pledge.new(:gold, 100))
+
+      expect(@project.pledges).to eq 175
+
+      @project.received_pledge(Pledge.new(:gold, 100))
+
+      expect(@project.pledges).to eq 275
+
+    end
+
+    it "computes total funds as the sum of a projects funding and pledges" do
+      @project.received_pledge(Pledge.new(:gold, 100))
+      @project.received_pledge(Pledge.new(:gold, 100))
+
+      expect(@project.total_funds).to eq 1_200
+    end
+
+    it "yields each pledge received and its value" do
+      @project.received_pledge(Pledge.new(:bronze, 50))
+      @project.received_pledge(Pledge.new(:silver, 75))
+      @project.received_pledge(Pledge.new(:gold, 100))
+
+      yielded = []
+      @project.each_received_pledge do |pledge|
+        yielded << pledge
+      end
+
+      expect(yielded).to eq([Pledge.new(:bronze, 50),
+                             Pledge.new(:silver, 75),
+                             Pledge.new(:gold, 100)])
+    end
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: crowdfund_sergio_silva
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sérgio Vitarelli Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-01 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 an example application used in The Pragmatic Studio's
+  Ruby Programming course, as described at
+
+    http://pragmaticstudio.com
+
+  This code is Copyright 2012 The Pragmatic Studio. See the LICENSE file.
+email: sergio.silva@dito.com.br
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowdfund
+- bin/projects.csv
+- bin/results.txt
+- lib/crowdfund/die.rb
+- lib/crowdfund/fundable.rb
+- lib/crowdfund/funding_round.rb
+- lib/crowdfund/fundrequest.rb
+- lib/crowdfund/grant_project.rb
+- lib/crowdfund/matching_project.rb
+- lib/crowdfund/pledge_pool.rb
+- lib/crowdfund/project.rb
+- spec/crowdfund/fundrequest_spec.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/matching_project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/project_spec.rb
+homepage: https://github.com/
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Crowdfund application gem
+test_files: []