pot_of_coffee 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05089f2f5028931efeef8f99a977f53aa21944cf
-  data.tar.gz: 4013f9a0776ec654aefb93b4a1db160b1788d3da
+  metadata.gz: 1e503ba1518e82bcf7fd871dde109f4a5f99242e
+  data.tar.gz: 5186eeac0b0ae2b32fde7ce0139094d9250c3510
 SHA512:
-  metadata.gz: 2c1adc9f7a15d11e5865281e60ae48c987ab227a514ea549aacbc5496a3a8024d54bc771009bb1570f527aadafe1d4182e36a46dd4022e0c378de581ec2de392
-  data.tar.gz: bf637452cd89bbd69779c27b8ba4a6bc0b3d1a62d88c38d48f827f3841d0e3e42131b60b4322fa215dd1a2b6aee0cd4047b88e2fee5c531bca18196dfb5b9bf4
+  metadata.gz: c6271c15b0634d0939aedcaa3ac5c2e8e07c022fd11723c39f522049ee06aedf2ab5bcc0acf7a515fcab70bee85a74cc108c4c8804e651940b2ee8bff6d62285
+  data.tar.gz: 06317f89de83f904fd91f6dce1c968aa970ee8350b8e4a44b6a2dd032e70e4d6bf15140d05fb8898496610b3eb25c85fa624a3ecf48b106fde352661bc571f4c

data/README.md

@@ -24,26 +24,47 @@ Or install it yourself as:
 ## Usage
 
 ### CLI
-```ruby
-pot_of_coffee # "To make 12 cups of normal coffee, use 8.1 tbsp of grounds."
-pot_of_coffee --strength strong # "To make 12 cups of strong coffee, use 10.5 tbsp of grounds."
-pot_of_coffee --quantity 11 --strength blagg  # "Sorry: coffee strength must be strong, normal, or weak"
-pot_of_coffee --units metric #To make 12 cups of coffee, use 63.6 g of grounds."
+```bash
+$ pot_of_coffee
+Cups desired: 12
+Brew strength: medium
+Grounds needed: 8.1 tbsp
+
+$ pot_of_coffee --strength=strong
+Cups desired: 12
+Brew strength: strong
+Grounds needed: 10.5 tbsp
+
+$ pot_of_coffee --strength=blagg
+Sorry: coffee strength must be strong, medium, or mild
+
+$ pot_of_coffee --units=metric
+Cups desired: 12
+Brew strength: medium
+Grounds needed: 63.6 g
+
 ```
 
 ### Ruby
 ```ruby
 require 'pot_of_coffee'
 
-pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 12, strength: 'weak')
+pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 12, strength: 'mild')
 pot_of_coffee.amount # 6.0
-pot_of_coffee.instructions # 'To make 12 cups of normal coffee, use 6.0 tbsp of grounds.'
+pot_of_coffee.instructions
+#=> Cups desired: 12
+#=> Brew strength: mild
+#=> Grounds needed: 6.0 tbsp
+
 
 # Metric units
 
-pot_of_coffee = PotOfCoffee::Brewer.new(units: PotOfCoffee::MetricUnit.new)
+pot_of_coffee = PotOfCoffee::Brewer.new(units: PotOfCoffee::Units::Metric.new)
 pot_of_coffee.amount # 63.6
-pot_of_coffee.instructions # 'To make 12 cups of normal coffee, use 63.6 g of grounds.'
+pot_of_coffee.instructions
+#=> Cups desired: 12
+#=> Brew strength: medium
+#=> Grounds needed: 63.6 g
 ```
 
 ## Using your own units
@@ -52,7 +73,7 @@ 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.
+I chose to provide three keys: `:strong`, `:medium`, and `:mild`, but you can use whatever you'd like.
 
 ### Example
 ```ruby
@@ -70,19 +91,21 @@ class CorgeUnit
   def table
     {
       strong: 3900,
-      normal: 200,
-      weak: 100
+      medium: 200,
+      mild: 100
     }
   end
 end
 
-pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 3, strength: :weak, units: CorgeUnit.new)
+pot_of_coffee = PotOfCoffee::Brewer.new(quantity: 3, strength: :mild, units: CorgeUnit.new)
 pot_of_coffee.amount # 300
 ```
 
 ## Tests
 
-Clone the repo and run `rake test`.
+* Fork/clone the repo
+* `bundle install`
+* `bundle exec rspec`
 
 ## Contributing
 

data/bin/console

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+
+require 'pry'
+require 'pot_of_coffee'
+
+Pry.start

data/bin/pot_of_coffee

@@ -5,7 +5,7 @@ require 'pot_of_coffee'
 
 options = {
   quantity: 12,
-  strength: :normal,
+  strength: :medium,
   units: PotOfCoffee::Units::Imperial.new
 }
 
@@ -16,27 +16,27 @@ OptionParser.new do |opts|
     options[:quantity] = v
   end
 
-  opts.on('-s', '--strength [STRENGTH]', String, 'Strength of your coffee (normal, strong, weak)') do |v|
+  opts.on('-s', '--strength [STRENGTH]', String, 'Strength of your coffee (medium, strong, mild)') do |v|
     options[:strength] = v.to_sym
   end
 
   opts.on('-u', '--units [UNITS]', 'Units for your coffee brew (imperial, metric)') do |v|
     options[:units] = case v
-      when 'metric'
-        PotOfCoffee::Units::Metric.new
-      when 'imperial'
-        PotOfCoffee::Units::Imperial.new
-      else
-        puts "#{v} is not 'imperial' or 'metric'"
-        exit
+                      when 'metric'
+                        PotOfCoffee::Units::Metric.new
+                      when 'imperial'
+                        PotOfCoffee::Units::Imperial.new
+                      else
+                        puts "#{v} is not 'imperial' or 'metric'"
+                        exit
       end
   end
 
-  opts.on('-h', '--help', 'Display this screen' ) do
+  opts.on('-h', '--help', 'Display this screen') do
     puts opts
     exit
   end
 end.parse!
 
 pot_of_coffee = PotOfCoffee::Brewer.new(**options)
-puts pot_of_coffee.instructions
+puts pot_of_coffee.instructions

data/lib/pot_of_coffee/brewer.rb

@@ -0,0 +1,26 @@
+module PotOfCoffee
+  class Brewer
+    attr_reader :units, :quantity, :strength
+
+    def initialize(quantity: 12, strength: :medium, units: Units::Imperial.new)
+      fail NegativeNumberError unless quantity > 0
+      fail WrongStrengthError unless units.table.keys.include?(strength)
+
+      @quantity = quantity
+      @strength = strength
+      @units = units
+    end
+
+    def grounds
+      (quantity * units.table.fetch(strength)).round(2)
+    end
+
+    def instructions
+      <<~INSTRUCTIONS
+        Cups desired: #{quantity}
+        Brew strength: #{strength}
+        Grounds needed: #{grounds} #{units.abbreviation}
+      INSTRUCTIONS
+    end
+  end
+end

data/lib/pot_of_coffee/errors.rb

@@ -10,7 +10,7 @@ module PotOfCoffee
 
   class WrongStrengthError < CoffeeError
     def message
-      'Sorry: coffee strength must be strong, normal, or weak'
+      'Sorry: coffee strength must be strong, medium, or mild'
     end
   end
 end

data/lib/pot_of_coffee/units/imperial.rb

@@ -11,8 +11,8 @@ module PotOfCoffee
 
       def table
         {
-          weak: 0.5,
-          normal: 0.675,
+          mild: 0.5,
+          medium: 0.675,
           strong: 0.875,
         }
       end

data/lib/pot_of_coffee/units/metric.rb

@@ -11,8 +11,8 @@ module PotOfCoffee
 
       def table
         {
-          weak: 2,
-          normal: 4.16,
+          mild: 2,
+          medium: 4.16,
           strong: 5.3
         }
       end

data/lib/pot_of_coffee/version.rb

@@ -1,3 +1,3 @@
 module PotOfCoffee
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/pot_of_coffee.rb

@@ -1,28 +1,8 @@
+require 'pot_of_coffee/brewer'
 require 'pot_of_coffee/version'
 require 'pot_of_coffee/units'
 require 'pot_of_coffee/errors'
 
 module PotOfCoffee
-  class Brewer
-    attr_reader :units, :quantity, :strength
 
-    def initialize(quantity: 12, strength: :normal, units: Units::Imperial.new)
-      fail NegativeNumberError unless quantity > 0
-      fail WrongStrengthError unless units.table.keys.include?(strength)
-
-      @quantity = quantity
-      @strength = strength
-      @units = units
-      # rescue NegativeNumberError, WrongStrengthError => e
-      #   print e.message
-    end
-
-    def amount
-      (quantity * units.table.fetch(strength)).round(2)
-    end
-
-    def instructions
-      "To make #{quantity} cups of of #{strength} coffee, use #{amount} #{units.abbreviation} of grounds."
-    end
-  end
 end

data/pot_of_coffee.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.6.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
 end

data/spec/pot_of_coffee/brewer_spec.rb

@@ -3,9 +3,9 @@ RSpec.describe PotOfCoffee::Brewer do
     let(:pot_of_coffee) { PotOfCoffee::Brewer.new }
 
     it 'has correct properties and gives instructions' do
-      expect(pot_of_coffee.instructions).to eq('To make 12 cups of of normal coffee, use 8.1 tbsp of grounds.')
+      expect(pot_of_coffee.instructions).to eq("Cups desired: 12\nBrew strength: medium\nGrounds needed: 8.1 tbsp\n")
       expect(pot_of_coffee.quantity).to eq(12)
-      expect(pot_of_coffee.strength).to eq(:normal)
+      expect(pot_of_coffee.strength).to eq(:medium)
     end
   end
 
@@ -35,17 +35,16 @@ RSpec.describe PotOfCoffee::Brewer do
       def table
         {
           strong: 109109,
-          normal: 279.10,
-          weak: 100
+          medium: 279.10,
+          mild: 100
         }
       end
     end
 
-    let(:units) { WhateverUnit.new }
-    let(:pot_of_coffee) { PotOfCoffee::Brewer.new(units: units) }
+    let(:pot_of_coffee) { PotOfCoffee::Brewer.new(units: WhateverUnit.new) }
 
     it 'can provide your own units' do
-      expect(pot_of_coffee.instructions).to eq('To make 12 cups of of normal coffee, use 3349.2 gb of grounds.')
+      expect(pot_of_coffee.instructions).to eq("Cups desired: 12\nBrew strength: medium\nGrounds needed: 3349.2 gb\n")
     end
   end
 end

data/spec/pot_of_coffee/units_spec.rb

@@ -11,7 +11,7 @@ RSpec.shared_examples 'a correct unit' do
 
   describe '#table' do
     subject { units.table }
-    it { is_expected.to satisfy { |t| [:weak, :normal, :strong].each { |key| t.keys.include?(key) } } }
+    it { is_expected.to satisfy { |t| [:weak, :medium, :strong].each { |key| t.keys.include?(key) } } }
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pot_of_coffee
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dave Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 description: This is a small CLI app for calculating the brew strength for an automatic
   drip coffee maker. It can help keep coffee brews consistent.
 email:
@@ -67,8 +81,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - bin/pot_of_coffee
 - lib/pot_of_coffee.rb
+- lib/pot_of_coffee/brewer.rb
 - lib/pot_of_coffee/errors.rb
 - lib/pot_of_coffee/units.rb
 - lib/pot_of_coffee/units/imperial.rb
@@ -98,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Coffee brew strength calculator