crowdfund_jf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34580ca508b700abaefe50e7c124b45329470c95
+  data.tar.gz: f546c48c82e89adfd5e824c4e6d29ba68c0df10f
+SHA512:
+  metadata.gz: de25838294a3a6a6a485e04a9bc99d59f0c327833422c1200ff34490b45ba4343caa7e4f004f678219add6856f14d5849ef7ed93ed82c08049bd4970df547c1a
+  data.tar.gz: 5dde6017e23b450dc9bdf353b30fa5ebfffb3fee31ebfb7ef9c6e9a984cc7e6254aa7a67dc2bdf7e7cf53e74049606cfc610986f43e796dcd4e251bf1b48d749

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) <2015> <Julian Feliciano>
+
+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/bin/crowdfund

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require_relative '../lib/crowdfund/incubator'
+
+y_combinator = Crowdfund::Incubator.new('Y-Combinator')
+default_project_file = File.join(File.dirname(__FILE__), 'projects.csv')
+y_combinator.load_projects(ARGV.shift || default_project_file)
+
+loop do
+  puts "\nIt's funding time! Enter the number of round or 'quit'"
+  answer = gets.chomp.downcase
+  case answer
+  when /^\d+$/
+    y_combinator.request_funding(answer.to_i)
+  when 'exit', 'quit'
+    y_combinator.status_of_projects
+    break
+  else
+    puts 'Not a valid response.'
+  end
+end
+
+y_combinator.save_projects

data/bin/julians_projects.csv

@@ -0,0 +1,3 @@
+Chicago Leather Goods,5000,0
+Chicago Watch Co.,1000000,225000
+Timeless Magazine,10000,3700

data/bin/projects.csv

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

data/bin/projects_funding.csv

@@ -0,0 +1,3 @@
+Project3,1000,325
+Project1,100,175
+Project2,500,3275

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,25 @@
+module Crowdfund
+  module Fundable
+    def add_funds(funds=2000)
+      self.funding += funds
+      puts "#{name} received funds!"
+    end
+
+    def remove_funds(funds=1000)
+      self.funding -= funds
+      puts "#{name} lost funds!"
+    end
+
+    def funding_needed
+      self.target_funding - total_funding
+    end
+
+    def funded?
+      funding_needed <= 0
+    end
+
+    def <=>(other_project)
+      other_project.funding_needed <=> funding_needed
+    end
+  end
+end

data/lib/crowdfund/funding_round.rb

@@ -0,0 +1,21 @@
+require_relative 'die'
+require_relative 'project'
+require_relative 'pledge_pool'
+
+module Crowdfund
+  module FundingRound
+    def self.pitch_for_funds(project)
+      die = Die.new
+      number_rolled = die.roll
+
+      if number_rolled.even?
+        project.add_funds
+      else
+        project.remove_funds
+      end
+
+      pledge = PledgePool.random
+      project.accept_pledge(pledge)
+    end
+  end
+end

data/lib/crowdfund/grant_project.rb

@@ -0,0 +1,9 @@
+require_relative 'project'
+
+module Crowdfund
+  class GrantProject < Project
+    def remove_funds
+      puts "#{@name} cannot have funds removed."
+    end
+  end
+end

data/lib/crowdfund/incubator.rb

@@ -0,0 +1,109 @@
+require_relative 'funding_round'
+require 'csv'
+
+module Crowdfund
+  class Incubator
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @projects = []
+    end
+
+    def load_projects(from_file)
+      CSV.foreach(from_file) do |row|
+        project = Project.new(row[0], row[1].to_i, row[2].to_i)
+        add_project(project)
+      end
+    end
+
+    def save_projects(to_file='projects_funding.csv')
+      CSV.open(to_file, 'wb') do |csv|
+        @projects.sort.each do |project|
+          csv << [project.name, project.target_funding, project.total_funding]
+        end
+      end
+      # File.open(to_file, 'w') do |file|
+      #   @projects.sort.each do |project|
+      #     file.puts "#{project.name},#{project.target_funding},#{project.total_funding}"
+      #   end
+      # end
+    end
+
+    def add_project(project)
+      @projects << project
+    end
+
+    def total_pledge_amount
+      @projects.reduce(0) { |sum, project| sum += project.total_pledges }
+    end
+
+    def total_funding_amount
+      @projects.reduce(0) { |sum, project| sum += project.total_funding }
+    end
+
+    def request_funding(rounds)
+      puts "There are #{@projects.size} projects in #{@name} that need funding:"
+      puts @projects
+
+      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
+
+      1.upto(rounds) do |round|
+        puts "\nRound #{round}:"
+        @projects.each do |project|
+          FundingRound.pitch_for_funds(project)
+          puts project
+        end
+      end
+    end
+
+    def print_project_name_and_funding(project)
+      puts "#{project.name} ended with $#{project.total_funding} in funding."
+    end
+
+    def status_of_projects
+      fully_funded, under_funded = @projects.partition { |p| p.funded? }
+
+      puts "\n#{@name}'s final funding amounts:"
+      puts "$#{total_funding_amount}"
+
+      puts "\n#{@name}'s total pledges:"
+      puts "$#{total_pledge_amount}"
+
+      @projects.sort.each do |project|
+        puts "\n#{project.name} pledges:"
+        project.each_pledge do |pledge|
+          puts "$#{pledge.amount} in #{pledge.name} pledges"
+        end
+        puts "$#{project.total_pledges} in total pledges"
+      end
+
+      puts "\nFully Funded Projects:"
+      fully_funded.each do |project|
+        print_project_name_and_funding(project)
+      end
+
+      puts "\nUnder Funded Projects:"
+      under_funded.each do |project|
+        print_project_name_and_funding(project)
+      end
+
+      puts "\nStill in need of funding:"
+      under_funded.sort.each do |project|
+        formatted_name = project.name.ljust(50, '.')
+        puts "#{formatted_name} $#{project.funding_needed} needed."
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  project = Project.new('Leather Goods', 5000)
+  incubator = Incubator.new('YC')
+  incubator.add_project(project)
+  incubator.request_funding(2)
+end

data/lib/crowdfund/incubator_spec.rb

@@ -0,0 +1,55 @@
+require_relative 'incubator'
+
+module Crowdfund
+  describe Incubator do
+
+    before do
+      $stdout = StringIO.new
+      @incubator = Incubator.new('YC')
+    end
+
+    context "with one project" do
+
+      before do
+        @funding = 500
+        @project = Project.new('Leather Goods', 5000, @funding)
+
+        @incubator.add_project(@project)
+      end
+
+      it "should add funds if an even number is rolled" do
+        allow_any_instance_of(Die).to receive(:roll).and_return(2)
+
+        @incubator.request_funding(3)
+
+        expect(@project.funding).to eq(@funding + (2000 * 3))
+      end
+
+      it "should remove funds if an odd number is rolled" do
+        allow_any_instance_of(Die).to receive(:roll).and_return(1)
+
+        @incubator.request_funding(3)
+
+        expect(@project.funding).to eq(@funding - (1000 * 3))
+      end
+    end
+
+    context "with more than one project" do
+
+      before do
+        @project1 = Project.new('Leather Goods', 1000)
+        @project2 = Project.new('American Watches', 1000)
+
+        @incubator.add_project(@project1)
+        @incubator.add_project(@project2)
+      end
+
+      it "calculates the total pledge amounts for all projects" do
+        @project1.accept_pledge(Pledge.new(:gold, 100))
+        @project2.accept_pledge(Pledge.new(:gold, 100))
+
+        expect(@incubator.total_pledge_amount).to eq(200)
+      end
+    end
+  end
+end

data/lib/crowdfund/matching_project.rb

@@ -0,0 +1,14 @@
+require_relative 'project'
+
+module Crowdfund
+  class MatchingProject < Project
+
+    def halfway_funded?
+      total_funding >= (@target_funding / 2)
+    end
+
+    def add_funds(funds=2000)
+      halfway_funded? ? super(funds * 2) : super(funds)
+    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,55 @@
+require_relative 'fundable'
+
+module Crowdfund
+  class Project
+    include Fundable
+
+    attr_accessor :name, :target_funding, :funding
+
+    def initialize(name, target_funding, funding=500)
+      @name = name
+      @target_funding = target_funding
+      @funding = funding
+      @pledges = Hash.new(0)
+    end
+
+    def each_pledge
+      @pledges.each do |name, amount|
+        yield(Pledge.new(name, amount))
+      end
+    end
+
+    def accept_pledge(pledge)
+      @pledges[pledge.name] += pledge.amount
+      puts "#{@name} received a #{pledge.name} pledge worth $#{pledge.amount}"
+      puts "#{@name}'s pledges: #{@pledges}"
+    end
+
+    def total_pledges
+      @pledges.values.reduce(0, :+)
+    end
+
+    def total_funding
+      @funding + total_pledges
+    end
+
+    def to_s
+      "#{@name} current funding is $#{total_funding} with $#{funding_needed} needed to reach its target funding amount."
+    end
+  end
+end
+
+if __FILE__ == $0
+  project = Project.new('Leather Goods', 5000)
+  puts project
+  project.add_funds
+  puts project.funding
+  project.remove_funds
+  puts project.funding
+  project.add_funds(250)
+  puts project.funding
+  project.remove_funds(150)
+  puts project.funding
+  puts project.funding_needed
+  puts project
+end

data/spec/crowdfund/grant_project_spec.rb

@@ -0,0 +1,18 @@
+require 'crowdfund/grant_project'
+
+module Crowdfund
+  describe GrantProject do
+
+    before do
+      $stdout = StringIO.new
+      @initial_funding = 1000
+      @project = GrantProject.new('CPS CS classes', 10000, @initial_funding)
+    end
+
+    it "cannot have funds removed" do
+      @project.remove_funds
+
+      expect(@project.funding).to eq(@initial_funding)
+    end
+  end
+end

data/spec/crowdfund/matching_project_spec.rb

@@ -0,0 +1,31 @@
+require 'crowdfund/matching_project'
+
+module Crowdfund
+  describe MatchingProject do
+
+    before do
+      $stdout = StringIO.new
+      @target_funding = 10000
+      @project = MatchingProject.new('Re-issued N64', @target_funding, 0)
+    end
+
+    it "returns true if halfway funded" do
+      @project.add_funds(@target_funding / 2)
+
+      expect(@project.halfway_funded?).to be_truthy
+    end
+
+    it "should not match funds when under halfway to target funding" do
+      @project.add_funds(4999)
+
+      expect(@project.funding).to eq(4999)
+    end
+
+    it "should match funds when halfway to target funding" do
+      @project.add_funds(5000)
+      @project.add_funds(1000)
+
+      expect(@project.funding).to eq(5000 + (1000 * 2))
+    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(:bronze, 50)
+    end
+
+    it "has a name attribute" do
+      expect(@pledge.name).to eq(:bronze)
+    end
+
+    it "has an amount attribute" do
+      expect(@pledge.amount).to eq(50)
+    end
+  end
+
+  describe PledgePool do
+
+    it "has 3 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" do
+      expect(PledgePool::PLEDGES[1]).to eq(Pledge.new(:silver, 75))
+    end
+
+    it "has a gold pledge worth $100" do
+      expect(PledgePool::PLEDGES[2]).to eq(Pledge.new(:gold, 100))
+    end
+
+    it "returns a random pledge" do
+      random = PledgePool.random
+
+      expect(PledgePool::PLEDGES).to include(random)
+    end
+  end
+end

data/spec/crowdfund/project_spec.rb

@@ -0,0 +1,129 @@
+require 'crowdfund/project'
+require 'crowdfund/pledge_pool'
+
+module Crowdfund
+  describe Project do
+
+    before do
+      $stdout = StringIO.new
+      @target_funding = 5000
+      @funding = 500
+      @project = Project.new('Leather Goods', @target_funding, @funding)
+    end
+
+    it "has an initial target funding amount" do
+      expect(@project.target_funding).to eq(5000)
+    end
+
+    it "computes the total funding outstanding as the target funding amount minus the funding amount" do
+      expect(@project.funding_needed).to eq(@target_funding - @funding)
+    end
+
+    it "increases funds by 2000 when funds are added" do
+      @project.add_funds
+
+      expect(@project.funding).to eq(@funding + 2000)
+    end
+
+    it "decreases funds by 1000 when funds are removed" do
+      @project.remove_funds
+
+      expect(@project.funding).to eq(@funding - 1000)
+    end
+
+    it "calculates the total amount of pledges" do
+      expect(@project.total_pledges).to eq(0)
+
+      @project.accept_pledge(Pledge.new(:bronze, 50))
+
+      expect(@project.total_pledges).to eq(50)
+
+      @project.accept_pledge(Pledge.new(:silver, 75))
+
+      expect(@project.total_pledges).to eq(125)
+
+      @project.accept_pledge(Pledge.new(:gold, 100))
+
+      expect(@project.total_pledges).to eq(225)
+    end
+
+    it "calculates total funding as funding with its pledges" do
+      @project.accept_pledge(Pledge.new(:bronze, 50))
+      @project.accept_pledge(Pledge.new(:gold, 100))
+
+      expect(@project.total_funding).to eq(650)
+    end
+
+    it "yields each pledge and its amount" do
+      @project.accept_pledge(Pledge.new(:bronze, 50))
+      @project.accept_pledge(Pledge.new(:bronze, 50))
+      @project.accept_pledge(Pledge.new(:silver, 75))
+      @project.accept_pledge(Pledge.new(:silver, 75))
+      @project.accept_pledge(Pledge.new(:gold, 100))
+      @project.accept_pledge(Pledge.new(:gold, 100))
+
+      yielded = []
+      @project.each_pledge do |pledge|
+        yielded << pledge
+      end
+
+      expect(yielded).to eq([
+        Pledge.new(:bronze, 100),
+        Pledge.new(:silver, 150),
+        Pledge.new(:gold, 200)
+      ])
+    end
+
+    context "with a default funding" do
+
+      before do
+        @project = Project.new('Leather Goods', 5000)
+      end
+
+      it "has a funding amount of 500" do
+        expect(@project.funding).to eq(500)
+      end
+    end
+
+    context "with its target funding met" do
+
+      before do
+        @project = Project.new('Leather Goods', 5000, 5000)
+      end
+
+      it "is funded" do
+        # expect(@project.funded?).to eq(true)
+        # expect(@project.funded?).to be_truthy
+        expect(@project).to be_funded
+      end
+    end
+
+    context "with its target funding not met" do
+
+      before do
+        @project = Project.new('Leather Goods', 5000, 500)
+      end
+
+      it "is not funded" do
+        # expect(@project.funded?).to eq(false)
+        # expect(@project.funded?).to be_falsey
+        expect(@project).not_to be_funded
+      end
+    end
+
+    context "in a collection of projects" do
+
+      before do
+        @project1 = Project.new('Leather Goods', 1000)
+        @project2 = Project.new('Watches', 2000)
+        @project3 = Project.new('Racing Attire', 3000)
+
+        @projects = [@project1, @project2, @project3]
+      end
+
+      it "sorts by amount outstanding in descending order" do
+        expect(@projects.sort).to eq([@project3, @project2, @project1])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: crowdfund_jf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julian Feliciano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-28 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: ''
+email: julsfelic@gmail.com
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/crowdfund
+- bin/julians_projects.csv
+- bin/projects.csv
+- bin/projects_funding.csv
+- lib/crowdfund/die.rb
+- lib/crowdfund/fundable.rb
+- lib/crowdfund/funding_round.rb
+- lib/crowdfund/grant_project.rb
+- lib/crowdfund/incubator.rb
+- lib/crowdfund/incubator_spec.rb
+- lib/crowdfund/matching_project.rb
+- lib/crowdfund/pledge_pool.rb
+- lib/crowdfund/project.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: 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.4.6
+signing_key: 
+specification_version: 4
+summary: A funding app for startups!
+test_files:
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/matching_project_spec.rb
+- spec/crowdfund/pledge_pool_spec.rb
+- spec/crowdfund/project_spec.rb