crowdfund_alec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783050b5dd00a24b8a28767bf31cbe5086eb291d48e7490ffb493a6df854f104
+  data.tar.gz: 32b0582569a592921d126cfa63664ecb98bf9c966e1c73f3c10fac79dfc746e2
+SHA512:
+  metadata.gz: f4c23651ebd47c69f1e9b4c4fff45d855769e956d6a55fe35265d867b68bc7a276305ed32080f84f1ebea84bc1bb85421e7390fcc66cfe051d6d24cc9673b92f
+  data.tar.gz: e09774c699c324d4f94e0437f913aa8e6ef77d62aa8b53b6dac67b31da6189ac261ef8a42a5c5c9f9f3241bc1f92fab444018913652a7344a1dd4582fe98685a

data/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2025 Alec
+
+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 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,12 @@
+# Flicks
+
+Command-line app/gem to fundfraising program.
+
+## Run from source
+ruby bin/crowdfund
+
+## Features
+- Load players from CSV
+- Points system (blam/w00t)
+- Treasure trove
+- Clumsy and beserker player

data/bin/crowdfund

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+begin
+require 'crowdfund/fund_request'
+require 'crowdfund/project'
+rescue LoadError
+  $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+  retry
+end
+
+project1 = Project.new("Project LMN", 5000, 3000)
+project2 = Project.new("Project XYZ", 5000, 6000)
+project3= Project.new("Project ABC", 5000, 2000)
+project4= Project.new("Project TBD", 1000, 1000)
+
+projects=FundRequest.new("Startup do Alec")
+default_project_file = File.join(File.dirname(__FILE__), 'projects.csv')
+projects.load_projects(ARGV.shift || default_project_file)
+
+loop do 
+    puts "How many rounds of funding? ('q' or 'e' to exit)"
+    answer = gets.chomp.downcase
+
+    case answer
+    when /^\d+$/
+        projects.request_funding(answer.to_i)
+    when 'q', 'e'
+        projects.print_results
+        projects.save_under_funded_projects
+        break
+    else
+        puts "Please enter a number or 'q'/'e'"
+    end
+
+end 

data/bin/projects.csv

@@ -0,0 +1,3 @@
+BuyaBoat,5,10000
+TraveltoVictoriaIsland,5,3000
+GetaPuppy,5,300

data/lib/crowdfund/die.rb

@@ -0,0 +1,15 @@
+class Die
+    attr_reader :number
+    def initialize
+        roll
+    end
+def roll
+   @number = rand(1..6)
+end
+end
+if __FILE__ == $0
+    die= Die.new
+    10.times do
+puts die.roll
+end
+end

data/lib/crowdfund/fund_request.rb

@@ -0,0 +1,125 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'funding_round'
+require_relative 'pledge'
+class FundRequest
+  attr_reader :title
+  def initialize(title)
+  @title = title
+  @projects = []
+  end
+
+  def load_projects(from_file)
+    File.readlines(from_file).each do |line|
+      name, fund_amount, target_fund_amount = line.split(',')
+      project = Project.new(name, Integer(fund_amount), Integer(target_fund_amount))
+      add_project(project)
+    end
+  end
+
+  def save_under_funded_projects(to_file= "needmoremoney.txt")
+
+    fully_funded_projects = @projects.select { |proj| proj.funded?}
+    under_funded_projects = @projects.reject { |proj| proj.funded?}
+
+    sorted_projects = under_funded_projects.sort { |a,b| b.funds_needed <=> a.funds_needed}
+
+    File.open(to_file, "w") do |file|
+      file.puts "#{@title} - Funding Report"
+      file.puts
+
+      file.puts "#{fully_funded_projects.size} fully funded projects"
+      fully_funded_projects.each do |proj|
+        file.puts "#{proj.name} ($#{proj.fund_amount})"
+      end
+
+      file.puts "#{under_funded_projects.size} under funded projects"
+      #under_funded_projects.each do |proj|
+        sorted_projects.each do |project|
+        formatted_name = project.name.ljust(20, '.')
+        file.puts "#{formatted_name} $#{project.funds_needed} under"
+        end
+
+        file.puts
+        file.puts "Project snapshots(CSV):"
+        @projects.each do |proje|
+           file.puts proje.to_csv
+      end
+ 
+    puts "Under-funded report written to #{to_file}"
+  end
+end
+
+  def  add_project(a_project)
+  @projects << a_project
+  #@projects.push(a_project)
+  end
+
+  def request_funding(rounds)
+    puts "There are #{@projects.size} projects that you could fund:"
+
+    @projects.each do |p|
+      puts p
+    end
+
+    pledges = Pledgesmod::PLEDGES
+    puts "\nThere are #{pledges.size} possible pledge amounts:"
+    pledges.each do |p|
+      puts "A #{p.name} pledge is worth $#{p.pledge_amount}."
+    end
+
+
+
+    1.upto(rounds) do |round|
+      puts "\nFunding Round #{round}:"
+    @projects.each do |p|
+      FundingRound.one_round(p)
+      puts p
+    end
+  end
+end
+  
+  def print_name_and_funding(project)
+    puts "#{project.name} ($#{project.fund_amount})"
+  end
+
+  def print_results
+    fully_funded_projects = @projects.select {|project| project.funded?}
+    under_funded_projects = @projects.reject {|project| project.funded?}
+
+    puts "\n#{fully_funded_projects.size} Projetos que atingiram a meta(Fully-funded Projects):"
+    fully_funded_projects.each do |project|
+      print_name_and_funding(project)
+    end
+
+    puts "\n#{under_funded_projects.size} Projetos que não atingiram a meta(Under-funded Projects):"
+    under_funded_projects.each do |project|
+      print_name_and_funding(project)
+    end
+
+        sorted_projects = under_funded_projects.sort {|a,b| b.funds_needed <=> a.funds_needed }
+
+    puts "\n#{under_funded_projects.size} projects still need your help:"
+    sorted_projects.each do |project|
+      formatted_name = project.name.ljust(20, '.')
+      puts "#{formatted_name} $#{project.funds_needed} under"
+    end
+
+    @projects.each do |proj|
+      puts "\n#{proj.name}'s pledges:"
+      proj.each_received_pledge do |ple|
+        puts "$#{ple.pledge_amount} in #{ple.name} pledges"
+      end
+      puts "$#{proj.pledges} in total pledges"
+    end
+  end
+end
+if __FILE__ == $0
+project1 = Project.new("Project LMN", 5000, 3000)
+project2 = Project.new("Project XYZ", 5000, 6000)
+projectsun=FundRequest.new("Startup do Alec")
+puts projectsun.title
+projectsun.add_project(project1)
+projectsun.add_project(project2)
+projectsun.request_funding
+end

data/lib/crowdfund/fundable.rb

@@ -0,0 +1,20 @@
+module Fundable
+#remove #add #total #fully
+  def remove_fund
+    @fund_amount -=15
+    "#{@name} lost $15 in funds!"
+    end
+
+  def add_fund
+    @fund_amount +=25
+    "#{@name} got $25 in funds!"
+  end
+
+	def funds_needed
+    @target_fund_amount - @fund_amount 
+  end
+
+  def funded?
+    funds_needed <= 0
+  end
+end

data/lib/crowdfund/funding_round.rb

@@ -0,0 +1,19 @@
+require_relative 'project'
+require_relative 'die'
+require_relative 'pledge'
+
+module FundingRound
+    def self.one_round(project)
+    die = Die.new
+    number_rolled = die.roll
+    if number_rolled.odd?
+        project.remove_fund
+    else
+        project.add_fund
+    end
+
+    pledge = Pledgesmod.random
+    project.received_pledge(pledge)
+    end
+
+end

data/lib/crowdfund/grant_project.rb

@@ -0,0 +1,16 @@
+require_relative 'project'
+
+class GrantProject < Project
+  def remove_fund
+    @fund_amount -= 0
+    puts "#{@name} has not lost or gained any new funds."
+  end
+end
+
+if __FILE__ == $0
+  grant = GrantProject.new("Project 123", 500, 100)
+  
+  puts "#{grant.name} has $#{grant.total_funds} in funding towards a goal of $#{grant.target_fund_amount}."
+  grant.remove_fund
+  puts "#{grant.name} has $#{grant.total_funds} in funding towards a goal of $#{grant.target_fund_amount}."
+end

data/lib/crowdfund/matching_project.rb

@@ -0,0 +1,24 @@
+require_relative 'project'
+
+class MatchingProject < Project
+    def initialize(name, fund_amount, target_fund_amount=0.00 )
+        super(name, fund_amount, target_fund_amount)
+        @halfway_funded = target_fund_amount/2
+    end
+    def halfway_funded?
+        @halfway_funded <= fund_amount
+    end
+    def add_fund
+        if halfway_funded?
+            @fund_amount += (25*2)
+            puts "#{@name} has received at least half its funding!" if halfway_funded?
+        else
+            super
+        end
+    end
+end
+if __FILE__ == $0
+    matchingproject= MatchingProject.new("Matching 123", 0, 100)
+    3.times {matchingproject.add_fund}
+    puts matchingproject.fund_amount
+end

data/lib/crowdfund/pledge.rb

@@ -0,0 +1,19 @@
+Pledge = Struct.new(:name, :pledge_amount)
+
+module Pledgesmod
+PLEDGES = [
+    Pledge.new(:bronze, 50),
+    Pledge.new(:silver, 75),
+    Pledge.new(:gold, 100)
+    ]
+
+    def self.random
+        PLEDGES.sample
+    end
+
+end
+
+
+if __FILE__ == $0
+    puts Pledgesmod::PLEDGES
+end

data/lib/crowdfund/project.rb

@@ -0,0 +1,68 @@
+require_relative 'pledge'
+require_relative 'fundable'
+class Project
+  include Fundable
+  attr_reader :fund_amount, :target_fund_amount
+  attr_accessor :name
+    def initialize(name, fund_amount, target_fund_amount=0.00)
+        @name=name
+        @fund_amount=fund_amount
+        @target_fund_amount=target_fund_amount
+        @received_pledge = Hash.new(0)
+    end 
+
+    def self.from_csv(line)
+      name, fund_amount, target_fund_amount = line.split(',')
+      Project.new(name, Integer(fund_amount), Integer(target_fund_amount))
+    end
+
+    def to_csv
+      "#{@name}, #{@fund_amount}, #{@target_fund_amount}"
+    end
+
+  def to_s
+    if funded?
+      sobra = @fund_amount - @target_fund_amount
+        "#{@name} has $#{@fund_amount} in funds (goal: $#{@target_fund_amount}). Goal achieved! Surplus of $#{sobra}."    else
+      falta = funds_needed
+        "#{@name} has $#{@fund_amount} in funds (goal: $#{@target_fund_amount}). Still needs $#{funds_needed}."    end
+  end
+    def received_pledge(pledge)
+      @received_pledge[pledge.name] += pledge.pledge_amount
+      puts "#{@name} received a #{pledge.name} pledge worth $#{pledge.pledge_amount}."
+      puts "#{@name}'s pledges: #{@received_pledge}"
+    end
+
+    def pledges 
+      @received_pledge.values.reduce(0,:+)
+    end
+
+    def total_funds
+      @fund_amount + pledges
+    end
+
+
+
+
+  def status
+      if funded?
+    "#{@name} has reached the goal of $#{@target_fund_amount} with $#{@fund_amount}."
+      else
+    "#{@name} has not yet reached the goal of $#{@target_fund_amount}. (Still needs $#{funds_needed}.)"
+      end
+  end
+
+  def each_received_pledge
+    @received_pledge.each do |name, amount|
+      yield Pledge.new(name, amount)
+    end
+  end
+end 
+if __FILE__ == $0
+project3= Project.new("Project ABC", 5000, 2000)
+project4= Project.new("Project TBD", 1000, 1000)
+puts project3.status
+puts "*****"
+puts project4.remove_fund
+puts project4
+end

data/spec/crowdfund/fund_request_spec.rb

@@ -0,0 +1,28 @@
+require 'crowdfund/fund_request'
+describe FundRequest do
+before do
+    @fundrequest = FundRequest.new("Fundação de doações")
+
+    @fund_amount = 1000
+    @target_fund_amount = 5000
+    @project = Project.new("Project ABC", @fund_amount, @target_fund_amount)
+
+    @fundrequest.add_project(@project)
+    $stdout = StringIO.new
+end
+
+it "Adds funds to a project if a even number is rolled" do
+     allow_any_instance_of(Die).to receive(:roll).and_return(4)
+
+     @fundrequest.request_funding(2)
+
+     expect(@project.fund_amount).to eq(@fund_amount + (25*2))
+end
+  it "removes funds to a project if an odd number is rolled" do
+     allow_any_instance_of(Die).to receive(:roll).and_return(3)
+    
+    @fundrequest.request_funding(2)
+    
+     expect(@project.fund_amount).to eq(@fund_amount - (15*2))
+  end
+end

data/spec/crowdfund/grant_project_spec.rb

@@ -0,0 +1,14 @@
+require 'crowdfund/grant_project'
+
+describe GrantProject do
+  before do
+    @initial_funds = 1000
+    @project = GrantProject.new("Grant 123", @initial_funds, 5000)
+  end
+  
+  it "does not ever have funds removed" do
+    @project.remove_fund
+    expect(@project.fund_amount).to eq(@initial_funds)
+  end
+end
+    

data/spec/crowdfund/matching_project_spec.rb

@@ -0,0 +1,30 @@
+require 'crowdfund/matching_project'
+
+describe MatchingProject do
+  before do
+    @initial_funds = 0
+    @project = MatchingProject.new("Match 123", @initial_funds, 200)
+  end
+  
+  it "does not match additional funds when the project is not halfway funded" do
+    3.times { @project.add_fund}
+        #@project.halfway_funded?.should be_falsey
+        expect(@project.halfway_funded?).to be_falsey
+  end
+  
+  it "is halfway funded when it has received half of its target funding amount" do
+    4.times { @project.add_fund }
+     
+    #@project.halfway_funded?.should be_truthy
+    expect(@project.halfway_funded?).to be_truthy
+  end
+  
+  it "receives twice as much added funds when it is halfway funded" do
+    7.times { @project.add_fund }
+    
+    #@project.fund_amount.should == @initial_funds + (4 * 25) + (3 * 25 * 2)
+    expect(@project.fund_amount). to eq(((@initial_funds) + (4*25)+(3*25*2)))
+    expect(@project.fund_amount).to eq((@initial_funds+(4 * 25) + (3 * 25 * 2)))
+  end  
+end
+  

data/spec/crowdfund/pledge_spec.rb

@@ -0,0 +1,39 @@
+require 'crowdfund/pledge'
+describe Pledge do
+before do
+    @pledge = Pledge.new(:gold, 100)
+end
+
+it "has  a name attribute" do
+    expect(@pledge.name).to eq(:gold)
+end
+it "has a points attribute" do
+    expect(@pledge.pledge_amount).to eq(100)
+end
+
+end
+
+describe Pledgesmod do
+
+    it "has a three pledges" do
+        expect(Pledgesmod::PLEDGES.size).to eq(3)
+    end
+    it "has a bronze give $50" do
+        expect(Pledgesmod::PLEDGES[0]).to eq(Pledge.new(:bronze, 50))
+    end
+
+    it "has a silver give $75" do
+        expect(Pledgesmod::PLEDGES[1]).to eq(Pledge.new(:silver, 75))
+    end
+
+        it "has a gold give $100" do
+        expect(Pledgesmod::PLEDGES[2]).to eq(Pledge.new(:gold, 100))
+    end
+
+    it "returns a random pledge" do
+    pledge = Pledgesmod.random
+
+    expect(Pledgesmod::PLEDGES).to include(pledge)
+    end
+
+end

data/spec/crowdfund/project_spec.rb

@@ -0,0 +1,105 @@
+require 'crowdfund/project'
+
+describe Project do
+
+before do
+      @fund_amount = 1000
+      @target_fund_amount = 5000
+      @project = Project.new("Project ABC", @fund_amount, @target_fund_amount) 
+      $stdout = StringIO.new
+end
+
+it "has an initial target funding amount" do
+    expect(@project.target_fund_amount).to eq(@target_fund_amount)
+end
+
+it "computes the total funds outstandings as the target funding amount minus the funding amount" do
+        expect(@project.funds_needed).to eq(@target_fund_amount - @fund_amount)
+end
+   
+it "increases funds by 25 when funds are added" do
+    @project.add_fund
+
+    expect(@project.fund_amount).to eq(@fund_amount + 25)
+end
+
+it "decreases funds by 15 when funds are removed" do
+    @project.remove_fund
+
+    expect(@project.fund_amount).to eq(@fund_amount - 15)
+end
+
+context "when total funding outstanding is less than or equal to 0" do
+    before do
+        @project = Project.new("Project ABC", 5000, 5000)
+    end
+     it "Atingiu a meta?" do
+        expect(@project.funded?).to eq(true)
+     end
+     end
+
+ context "when total funding outstanding is greater than 0" do
+    before do
+        @project= Project.new("Project ABC", 1000, 5000)
+    end
+    it "is under-funded" do
+        expect(@project.funded?).to eq(false)
+    end
+ end
+
+
+
+
+
+
+
+
+=begin
+it "Todo projeto possui um nome" do 
+    expect(@project.project).to eq("Project ABC")
+end
+
+it "Todo projeto vem por padrão com sua meta zerada caso não seja informada" do
+   @project1 = Project.new("Projeto sem meta", 5000) 
+   expect(@project1.target_fund_amount).to eq(0.00) 
+end
+
+it "Todo projeto possui um valor inicial" do 
+    expect(@project.fund_amount).to eq(5000)
+end
+
+it "Todo projeto possui uma meta" do 
+    expect(@project.target_fund_amount).to eq(2000)
+end
+
+it "Soma 25 no valor incial(add_fund)" do
+    @project.add_fund
+    expect(@project.fund_amount).to eq(5025) 
+end
+
+it "Subtrai 15 do valor inicial(remove_fund)" do
+    @project.remove_fund
+    expect(@project.fund_amount).to eq(4985) 
+end
+
+it "Possui um método String para representar(to_s)" do 
+     expect(@project.to_s).to eq("Project ABC tem $5000 em doações e sua meta é $2000, portanto, atingiu sua meta e ainda passou $3000.")
+end
+
+it "Quanto falta para bater a meta?" do 
+        expect(@project.how_much_is_left?).to eq(-3000)
+end
+
+it "Atingiu a meta?" do 
+        @project.atingiu_meta?
+        expect(@project.atingiu_meta?).to eq(true)
+end 
+
+it "Mostrar o status do andamento do projeto" do 
+     @project.status
+     expect(@project.status).to eq("Project ABC atingiu a meta de 2000 com $5000.")
+end
+=end
+
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: crowdfund_alec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- LucioAlec
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |-
+  # Flicks
+
+  Command-line app/gem to fundfraising program.
+
+  ## Run from source
+  ruby bin/crowdfund
+
+  ## Features
+  - Load players from CSV
+  - Points system (blam/w00t)
+  - Treasure trove
+  - Clumsy and beserker player
+email: lucioalec@gmail.com
+executables:
+- crowdfund
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/crowdfund
+- bin/projects.csv
+- lib/crowdfund/die.rb
+- lib/crowdfund/fund_request.rb
+- lib/crowdfund/fundable.rb
+- lib/crowdfund/funding_round.rb
+- lib/crowdfund/grant_project.rb
+- lib/crowdfund/matching_project.rb
+- lib/crowdfund/pledge.rb
+- lib/crowdfund/project.rb
+- spec/crowdfund/fund_request_spec.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/matching_project_spec.rb
+- spec/crowdfund/pledge_spec.rb
+- spec/crowdfund/project_spec.rb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Manage a fundraising program with a roll die
+test_files:
+- spec/crowdfund/fund_request_spec.rb
+- spec/crowdfund/grant_project_spec.rb
+- spec/crowdfund/matching_project_spec.rb
+- spec/crowdfund/pledge_spec.rb
+- spec/crowdfund/project_spec.rb