pot_of_coffee 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59a334e469e37a0e133e778526d8a8b38ef395da
-  data.tar.gz: 461e37e68c299d442826130f84d1079f9577184c
+  metadata.gz: 2965ddf1855b70dfef81fef85011fb6fe8708254
+  data.tar.gz: b9473aa3e867606b624238975d91174282cdb688
 SHA512:
-  metadata.gz: 84cb6d8a8e2a5559369f59d06a4b92c9d804f3219bcc117c8c89d8cec5aac4acfba105f7a251dc28aa86cb83ce2b471e7b033d2625be205169086f06af66821f
-  data.tar.gz: c89fe94927ddce0d9604b44a427dc45be34c10c4dcaa521760e5b86dd75e2caadee92291822ad65b1854a6d0d4f43512d935ef4ff66df0d6768b1bed2e466640
+  metadata.gz: 839c853825208c76183555682bf19ddb10739ee52cd5fc383e72d3fec769d2f076e76d263adc7e6bfa70131d71bc76a19523886e10152ec14e6aa746e7a9a7e0
+  data.tar.gz: 3a4ea38cec9c59373db2c20a06e67869786314e1a28aadd4d7a39561e0480a94a4afce60986bcbe94ba037e4747de584914a75cefce8edbe3b553f3eba82ecdb

data/README.md

@@ -1,6 +1,9 @@
 # PotOfCoffee
 
-This is a command line coffee brew calculator. Enter the number of cups you want and the strength. I use it to maintain intra-office harmony.
+This is a command line coffee brew calculator.
+Enter the number of cups you want and the strength.
+It can also be used in your own code, and you can supply your own units for grounds if you don't want to use tablespoons.
+I use it to maintain intra-office harmony.
 
 ## Installation
 
@@ -22,19 +25,62 @@ Or install it yourself as:
 
 ### CLI
 ```ruby
-pot_of_coffee 12 normal # "Number of scoops needed: 8.1"
-pot_of_coffee 12 blagg  # "I don't know how to make 'blagg' strength coffee, sorry. Available options are weak, normal, extra, turbo, starbucks, wtf"
+pot_of_coffee 12 normal # "To make 12 cups of coffee, use 8.1 tbsp of grounds."
+pot_of_coffee 12 blagg  # "Sorry: coffee strength must be strong, normal, or weak"
 ```
 
-### Rails
+### Ruby
 ```ruby
+require 'pot_of_coffee'
+
 pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 12, strength: 'weak')
-pot_of_coffee.scoops # 6.0
+pot_of_coffee.amount # 6.0
+pot_of_coffee.instructions # 'To make 12 cups of normal strength coffee, use 6.0 tbsp of grounds.'
+
+# Metric units
+
+pot_of_coffee = PotOfCoffee::Brewer.new(units: PotOfCoffee::MetricUnit.new)
+pot_of_coffee.amount # 63.6
+pot_of_coffee.instructions # 'To make 12 cups of normal strength coffee, use 63.6 g of grounds.'
+```
+
+## Using your own units
+If you want to use a different set of units or different ratios, you can do so quite simply.
+Just supply an object that responds to `name`, `abbreviation`, and `table`.
+`name` and `abbreviation` must be strings.
+`name` is not used at the moment, but it may be in the future.
+`table` must be a hash.
+I chose to provide three keys: `:strong`, `:normal`, and `:weak`, but you can use whatever you'd like.
+
+### Example
+```ruby
+require 'pot_of_coffee'
+
+class CorgeUnit
+  def name
+    'corge'
+  end
+
+  def abbreviation
+    'cg'
+  end
+
+  def table
+    {
+      strong: 3900,
+      normal: 200,
+      weak: 100
+    }
+  end
+end
+
+pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 3, strength: :weak, units: CorgeUnit.new)
+pot_of_coffee.amount # 300
 ```
 
 ## Tests
 
-Clone the repo and run `rake test`. The test coverage is *very basic*.
+Clone the repo and run `rake test`.
 
 ## Contributing
 

data/lib/pot_of_coffee/units.rb

@@ -34,9 +34,9 @@ module PotOfCoffee
 
     def table
       {
-        weak: 12,
-        normal: 20,
-        strong: 28,
+        weak: 3,
+        normal: 5.3,
+        strong: 10.6
       }
     end
   end

data/lib/pot_of_coffee/version.rb

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

data/test/test_units.rb

@@ -4,7 +4,7 @@ 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.'
+    assert_equal @pot_of_coffee.instructions, 'To make 12 cups of of normal coffee, use 63.6 g of grounds.'
   end
 
   def test_can_provide_your_own_units

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pot_of_coffee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Dave Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler