pot_of_coffee 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c737bb79b74044f92383833c7640131dcfa03522
-  data.tar.gz: 9792a23a844be2faf6fe460fb9e3f809084e0716
+  metadata.gz: 59a334e469e37a0e133e778526d8a8b38ef395da
+  data.tar.gz: 461e37e68c299d442826130f84d1079f9577184c
 SHA512:
-  metadata.gz: 1fe29369cce46158e413f3d40c99caf3890bedba7e0008b1e621c3bb20dfbfa8638bcf2626780d0f6a5f4ef8228888ba120b14fd5c95ba041eb6633798ce81f8
-  data.tar.gz: bddb3be88b3adfcc9dc0db2cc84b8e89324a89201992c62d526ddfba3e513ca0a1429c8632c3be234341232f1d54455dd19240c0de120daa2306c406d46a1cf3
+  metadata.gz: 84cb6d8a8e2a5559369f59d06a4b92c9d804f3219bcc117c8c89d8cec5aac4acfba105f7a251dc28aa86cb83ce2b471e7b033d2625be205169086f06af66821f
+  data.tar.gz: c89fe94927ddce0d9604b44a427dc45be34c10c4dcaa521760e5b86dd75e2caadee92291822ad65b1854a6d0d4f43512d935ef4ff66df0d6768b1bed2e466640

data/README.md

@@ -32,6 +32,10 @@ pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 12, strength: 'weak')
 pot_of_coffee.scoops # 6.0
 ```
 
+## Tests
+
+Clone the repo and run `rake test`. The test coverage is *very basic*.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/pot_of_coffee/fork )

data/bin/pot_of_coffee

@@ -7,5 +7,9 @@ unless ARGV[0] && ARGV[1]
   exit 1
 end
 
-pot_of_coffee = PotOfCoffee::Brewer.new(quantity: ARGV[0], strength: ARGV[1])
-puts "Number of scoops needed: #{pot_of_coffee.scoops}"
+quantity = ARGV[0].to_i
+strength = ARGV[1].to_sym
+units = PotOfCoffee::MetricUnit.new
+
+pot_of_coffee = PotOfCoffee::Brewer.new(quantity: quantity, strength: strength, units: units)
+puts pot_of_coffee.instructions

data/lib/pot_of_coffee.rb

@@ -1,38 +1,45 @@
 require 'pot_of_coffee/version'
+require 'pot_of_coffee/units'
+require 'pot_of_coffee/errors'
+require 'forwardable'
 
 module PotOfCoffee
   class Brewer
-    # Magic numbers omg
-    RATIOS = {
-      weak: 0.5,
-      normal: 0.675,
-      extra: 0.875,
-      turbo: 1,
-      starbucks: 2, # This is really how strong Starbucks expects someone to brew their coffe
-      wtf: 3.8
-    }
+    extend Forwardable
+    attr_reader :units
 
-    attr_reader :ratios, :strength, :quantity
+    def_delegator :@units, :table, :ratios
 
-    def initialize(quantity: 12, strength: :normal)
-      @quantity = quantity.to_i
-      @strength = strength.to_sym
-      @scoops = scoops
+    def initialize(args = {})
+      @quantity = args[:quantity] || 12
+      @strength = args[:strength] || :normal
+      @units = args[:units] || ImperialUnit.new
     end
 
-    def ratios
-      @ratios = RATIOS
+    def quantity
+      if @quantity > 0
+        @quantity
+      else
+        raise NegativeNumberError
+      end
     end
 
-    def self.ratios
-      RATIOS
+    def strength
+      if ratios.include?(@strength.to_sym)
+        @strength
+      else
+        raise WrongStrengthError
+      end
     end
 
-    def scoops
+    def amount
       (quantity * ratios.fetch(strength)).round(2)
-    rescue KeyError
-      "I don't know how to make '#{strength}' strength coffee, sorry. Available options are #{ratios.keys.join(', ')}"
     end
 
+    def instructions
+      "To make #{quantity} cups of of #{strength} coffee, use #{amount} #{units.abbreviation} of grounds."
+    rescue NegativeNumberError, WrongStrengthError => e
+      print e.message
+    end
   end
-end
+end

data/lib/pot_of_coffee/errors.rb

@@ -0,0 +1,16 @@
+module PotOfCoffee
+  class CoffeeError < StandardError
+  end
+
+  class NegativeNumberError < CoffeeError
+    def message
+      'Sorry: coffee quantity must be greater than 0'
+    end
+  end
+
+  class WrongStrengthError < CoffeeError
+    def message
+      'Sorry: coffee strength must be strong, normal, or weak'
+    end
+  end
+end

data/lib/pot_of_coffee/units.rb

@@ -0,0 +1,43 @@
+module PotOfCoffee
+  class Unit
+    def name; raise NotImplementedError; end
+    def abbreviation; raise NotImplementedError; end
+    def table; raise NotImplementedError; end
+  end
+
+  class ImperialUnit < Unit
+    def name
+      'tablespoon'
+    end
+
+    def abbreviation
+      'tbsp'
+    end
+
+    def table
+      {
+        weak: 0.5,
+        normal: 0.675,
+        strong: 0.875,
+      }
+    end
+  end
+
+  class MetricUnit < Unit
+    def name
+      'gram'
+    end
+
+    def abbreviation
+      'g'
+    end
+
+    def table
+      {
+        weak: 12,
+        normal: 20,
+        strong: 28,
+      }
+    end
+  end
+end

data/lib/pot_of_coffee/version.rb

@@ -1,3 +1,3 @@
 module PotOfCoffee
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'pot_of_coffee'

data/test/test_brewer.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestBrewer < Minitest::Test
+  def test_gives_instructions_with_no_arguments
+    @pot_of_coffee = PotOfCoffee::Brewer.new
+    assert_equal @pot_of_coffee.instructions, "To make 12 cups of of normal coffee, use 8.1 tbsp of grounds."
+  end
+
+  def test_has_correct_properties_when_created_with_no_arguments
+    @pot_of_coffee = PotOfCoffee::Brewer.new
+    assert_equal @pot_of_coffee.quantity, 12
+    assert_equal @pot_of_coffee.strength, :normal
+  end
+
+  def test_quantity_must_be_positive
+    @pot_of_coffee = PotOfCoffee::Brewer.new(quantity: -1)
+    assert_raises PotOfCoffee::NegativeNumberError do
+      @pot_of_coffee.quantity
+    end
+  end
+
+  def test_strength_must_be_strong_normal_or_weak
+    @pot_of_coffee = PotOfCoffee::Brewer.new(quantity: rand(24), strength: :ultra)
+    assert_raises PotOfCoffee::WrongStrengthError do
+      @pot_of_coffee.strength
+    end
+  end
+end

data/test/test_units.rb

@@ -0,0 +1,21 @@
+require 'helper'
+require 'whatever_unit'
+
+class TestUnits < Minitest::Test
+  def test_can_use_metric_units
+    @pot_of_coffee = PotOfCoffee::Brewer.new(units: PotOfCoffee::MetricUnit.new)
+    assert_equal @pot_of_coffee.instructions, 'To make 12 cups of of normal coffee, use 240.0 g of grounds.'
+  end
+
+  def test_can_provide_your_own_units
+    @pot_of_coffee = PotOfCoffee::Brewer.new(units: WhateverUnit.new)
+    assert_equal @pot_of_coffee.instructions, 'To make 12 cups of of normal coffee, use 3349.2 gb of grounds.'
+  end
+
+  def test_units_must_respond_to_correct_things
+    @whatever_unit = WhateverUnit.new
+    assert_respond_to @whatever_unit, :name
+    assert_respond_to @whatever_unit, :abbreviation
+    assert_respond_to @whatever_unit, :table
+  end
+end

data/test/whatever_unit.rb

@@ -0,0 +1,17 @@
+class WhateverUnit
+  def name
+    'grably'
+  end
+
+  def abbreviation
+    'gb'
+  end
+
+  def table
+    {
+      strong: 109109,
+      normal: 279.10,
+      weak: 100
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pot_of_coffee
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Dave Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,9 +68,14 @@ files:
 - Rakefile
 - bin/pot_of_coffee
 - lib/pot_of_coffee.rb
+- lib/pot_of_coffee/errors.rb
+- lib/pot_of_coffee/units.rb
 - lib/pot_of_coffee/version.rb
 - pot_of_coffee.gemspec
-- test/test_pot_of_coffee.rb
+- test/helper.rb
+- test/test_brewer.rb
+- test/test_units.rb
+- test/whatever_unit.rb
 homepage: http://daveshaffer.co/coffee
 licenses:
 - MIT
@@ -91,9 +96,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Coffee brew strength calculator
 test_files:
-- test/test_pot_of_coffee.rb
+- test/helper.rb
+- test/test_brewer.rb
+- test/test_units.rb
+- test/whatever_unit.rb

data/test/test_pot_of_coffee.rb

@@ -1,26 +0,0 @@
-require 'minitest/autorun' # Because testing should happen
-require 'minitest/pride' # Because testing should be fabulous
-require 'pot_of_coffee'
-
-class PotOfCoffeeTest < Minitest::Test
-  def setup
-    options = { quantity: rand(24), strength: PotOfCoffee::Brewer.ratios.keys.sample }
-    @pot_of_coffee = PotOfCoffee::Brewer.new(options)
-  end
-
-  def test_ratios
-    assert_kind_of Hash, PotOfCoffee::Brewer.ratios
-  end
-
-  def test_strength
-    assert_includes @pot_of_coffee.ratios, @pot_of_coffee.strength
-  end
-
-  def test_quantity
-    assert_kind_of Integer, @pot_of_coffee.quantity
-  end
-
-  def test_scoops
-    assert_kind_of Float, @pot_of_coffee.scoops
-  end
-end