gravitheque 0.3.0 → 0.4.0

data/.travis.yml

@@ -5,7 +5,4 @@ rvm:
 
 script: bin/test
 
-env:
-  - JRUBY_OPTS="--1.9"
-
 bundler_args: --without development documentation mac

data/README.md

@@ -47,13 +47,35 @@ guard start --clear
 ```ruby
 require "calculators/alcohol"
 
-Calculate.alcohol_by_volume 12, 4
-Calculate.alcohol_by_volume 1.055, 1.012, :specific_gravity
-Calculate.alcohol_by_volume 16.4, 8.2, :brix
-
-Calculate.alcohol_by_weight 12, 4
-Calculate.alcohol_by_weight 1.055, 1.012, :specific_gravity
-Calculate.alcohol_by_weight 16.4, 8.2, :brix
+Calculate.alcohol_by_volume({
+  original: 12,
+  terminal: 4,
+})
+
+Calculate.alcohol_by_volume({
+  original: 1.055,
+  terminal: 1.012
+}, :specific_gravity)
+
+Calculate.alcohol_by_volume({
+  original: 16.4,
+  terminal: 8.2
+}, :brix)
+
+Calculate.alcohol_by_weight({
+  original: 12,
+  terminal: 4,
+})
+
+Calculate.alcohol_by_weight({
+  original: 1.055,
+  terminal: 1.012
+}, :specific_gravity)
+
+Calculate.alcohol_by_weight({
+  original: 16.4,
+  terminal: 8.2
+}, :brix)
 ```
 
 ### Calories
@@ -61,17 +83,50 @@ Calculate.alcohol_by_weight 16.4, 8.2, :brix
 ```ruby
 require "calculators/calories"
 
-Calculate.calories_from_alcohol 12, 4
-Calculate.calories_from_alcohol 1.055, 1.012, :specific_gravity
-Calculate.calories_from_alcohol 16.4, 8.2, :brix
-
-Calculate.calories_from_extract 12, 4
-Calculate.calories_from_extract 1.055, 1.012, :specific_gravity
-Calculate.calories_from_extract 16.4, 8.2, :brix
-
-Calculate.calories_per_serving 12, 4
-Calculate.calories_per_serving 1.055, 1.012, :specific_gravity
-Calculate.calories_per_serving 16.4, 8.2, :brix
+Calculate.calories_from_alcohol({
+  original: 12,
+  terminal: 4,
+})
+
+Calculate.calories_from_alcohol({
+  original: 1.055,
+  terminal: 1.012
+}, :specific_gravity)
+
+Calculate.calories_from_alcohol({
+  original: 16.4,
+  terminal: 8.2
+}, :brix)
+
+Calculate.calories_from_extract({
+  original: 12,
+  terminal: 4,
+})
+
+Calculate.calories_from_extract({
+  original: 1.055,
+  terminal: 1.012
+}, :specific_gravity)
+
+Calculate.calories_from_extract({
+  original: 16.4,
+  terminal: 8.2
+}, :brix)
+
+Calculate.calories_per_serving({
+  original: 12,
+  terminal: 4,
+})
+
+Calculate.calories_per_serving({
+  original: 1.055,
+  terminal: 1.012
+}, :specific_gravity)
+
+Calculate.calories_per_serving({
+  original: 16.4,
+  terminal: 8.2
+}, :brix)
 ```
 
 ### Hops
@@ -79,21 +134,92 @@ Calculate.calories_per_serving 16.4, 8.2, :brix
 ```ruby
 require "calculators/hops"
 
-Calculate.hop_utilization 15, 45
-Calculate.hop_utilization 1.055, 60, :specific_gravity
-Calculate.hop_utilization 12, 15, :brix
-
-Calculate.hop_mass_required({ :ibus => 50, :extract => 12, :at => 30, :alpha => 10, :volume => 20 })
-Calculate.hop_mass_required({ :ibus => 15, :extract => 14.5, :at => 15, :alpha => 3.2, :volume => 20 }, { :extract => :brix })
-Calculate.hop_mass_required({ :ibus => 100, :extract => 1.05, :at => 90, :alpha => 12.4, :volume => 10 }, { :extract => :specific_gravity, :volume => :gallons })
-
-Calculate.hopshot_required({ :ibus => 40, :extract => 18, :at => 60, :volume => 20 })
-Calculate.hopshot_required({ :ibus => 40, :extract => 14.5, :at => 60, :volume => 20 }, { :extract => :brix })
-Calculate.hopshot_required({ :ibus => 40, :extract => 1.085, :at => 60, :volume => 10.5 }, { :extract => :specific_gravity, :volume => :gallons })
-
-Calculate.ibus({ :extract => 15, :at => 60, :alpha => 6.5, :mass => 56, :volume => 20 })
-Calculate.ibus({ :extract => 18.5, :at => 60, :alpha => 6.5, :mass => 56, :volume => 20 }, { :extract => :brix })
-Calculate.ibus({ :extract => 1.055, :at => 60, :alpha => 6.5, :mass => 2, :volume => 5 }, { :extract => :specific_gravity, :mass => :ounces, :volume => :gallons })
+Calculate.hop_utilization({
+  extract: 15,
+  at: 45
+})
+
+Calculate.hop_utilization({
+  extract: 1.055,
+  at: 60
+}, :specific_gravity)
+
+Calculate.hop_utilization({
+  extract: 12,
+  at: 15
+}, :brix)
+
+Calculate.hop_mass_required({
+  alpha: 13.5,
+  at: 60,
+  extract: 16,
+  ibus: 25,
+  volume: 20
+})
+
+Calculate.hop_mass_required({
+  alpha: 3.2,
+  at: 15,
+  extract: 14.5,
+  ibus: 15,
+  volume: 20
+}, { extract: :brix })
+
+Calculate.hop_mass_required({
+  alpha: 12.4,
+  at: 90,
+  extract: 1.05,
+  ibus: 100,
+  volume: 10
+}, { extract: :specific_gravity, volume: :gallons })
+
+Calculate.hopshot_required({
+  alpha: 13.5,
+  at: 60,
+  extract: 16,
+  ibus: 25,
+  volume: 20
+})
+
+Calculate.hopshot_required({
+  alpha: 3.2,
+  at: 15,
+  extract: 14.5,
+  ibus: 15,
+  volume: 20
+}, { extract: :brix })
+
+Calculate.hopshot_required({
+  alpha: 12.4,
+  at: 90,
+  extract: 1.05,
+  ibus: 100,
+  volume: 10
+}, { extract: :specific_gravity, volume: :gallons })
+
+Calculate.ibus({
+  alpha: 12.4,
+  at: 90,
+  extract: 15,
+  mass: 56,
+  volume: 20
+})
+
+Calculate.ibus({
+  alpha: 6.5,
+  at: 60,
+  extract: 18.5,
+  mass: 30,
+  volume: 40
+}, { extract: :brix })
+
+Calculate.ibus({
+  alpha: 8,
+  at: 30,
+  extract: 1.055,
+  mass: 3,
+  volume: 5
+}, { extract: :specific_gravity, mass: :ounces, volume: :gallons })
 ```
 
 ### Mash
@@ -101,11 +227,33 @@ Calculate.ibus({ :extract => 1.055, :at => 60, :alpha => 6.5, :mass => 2, :volum
 ```ruby
 require "calculators/mash"
 
-Calculate.strike_temperature 1.5, 20, 75
-Calculate.strike_temperature 1.25, 65, 154, :us
-
-Calculate.infusion_volume 1, 40, 60, 3.6, 3.6
-Calculate.infusion_volume 1, 104, 140, 8, 8, :us
+Calculate.strike_temperature({
+  ratio: 1.5,
+  initial: 20,
+  target: 75
+})
+
+Calculate.strike_temperature({
+  ratio: 1.25,
+  initial: 65,
+  target: 154
+}, :us)
+
+Calculate.infusion_volume({
+  ratio: 1,
+  initial: 40,
+  target: 60,
+  mass: 3.6,
+  volume: 3.6
+})
+
+Calculate.infusion_volume({
+  ratio: 1,
+  initial: 104,
+  target: 140,
+  mass: 8,
+  volume: 8
+}, :us)
 ```
 
 ### Yeast
@@ -113,11 +261,30 @@ Calculate.infusion_volume 1, 104, 140, 8, 8, :us
 ```ruby
 require "calculators/yeast"
 
-Calculate.yeast_cells_required 16.5, 19
-Calculate.yeast_cells_required 15.75, 5.25, { :volume => :gallons }
-Calculate.yeast_cells_required 1.055, 55, { :extract => :specific_gravity }
-Calculate.yeast_cells_required 18, 20, { :type => :hybrid }
-Calculate.yeast_cells_required 21.5, 10.5, { :volume => :gallons, :extract => :brix, :type => :lager }
+Calculate.yeast_cells_required({
+  extract: 16.5,
+  volume: 19
+})
+
+Calculate.yeast_cells_required({
+  extract: 15.75,
+  volume: 5.25
+}, { volume: :gallons })
+
+Calculate.yeast_cells_required({
+  extract: 1.055,
+  volume: 55
+}, { extract: :specific_gravity })
+
+Calculate.yeast_cells_required({
+  extract: 18,
+  volume: 20
+}, { type: :hybrid })
+
+Calculate.yeast_cells_required({
+  extract: 21.5,
+  volume: 10.5
+}, { volume: :gallons, extract: :brix, type: :lager })
 ```
 
 ## Conversions

data/bin/test

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+system "clear" unless ENV["CI"]
+
 tests = Dir.glob "test/**/*.rb"
 tests.each { |test| require File.expand_path test }
 

data/gravitheque.gemspec

@@ -11,5 +11,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- test/*`.split("\n")
   gem.name          = "gravitheque"
   gem.require_paths = ["lib"]
-  gem.version       = "0.3.0"
+  gem.version       = "0.4.0"
 end

data/lib/calculators/alcohol.rb

@@ -3,34 +3,41 @@ require "conversions/extract"
 module Calculate
 
   # Calculates alcohol by weight given original and terminal extract levels.
-  # Set the `unit` option for extract levels that are not degrees Plato.
-  # Other supported units are `:specific_gravity` and `:brix`.
+  # Supported extract units are `:brix`, `:plato` and `:specific_gravity`. Default: `:plato`
   #
   # @example
-  #    Calculate.alcohol_by_weight 17.5, 3.2
-  #    Calculate.alcohol_by_weight 1.055, 1.010, :specific_gravity
-  #    Calculate.alcohol_by_weight 15.2, 7.8, :brix
+  #     Calculate.alcohol_by_weight({ original: 17.5, terminal: 3.2 })
   #
-  # @param [Float] original the original extract level
-  # @param [Float] terminal the terminal extract level
+  #     Calculate.alcohol_by_weight({
+  #       original: 1.055,
+  #       terminal: 1.010
+  #     }, :specific_gravity)
+  #
+  #     Calculate.alcohol_by_weight({
+  #       original: 15.2,
+  #       terminal: 7.8
+  #     }, :brix)
+  #
+  # @param [Hash] extract the original and terminal extract levels
   # @param [Symbol] unit the unit used to measure extract
   # @return [Float] the alcohol content by weight
-  def self.alcohol_by_weight original, terminal, unit = :plato
-    original = original.to_f
-    terminal = terminal.to_f
+  def self.alcohol_by_weight extract, units = :plato
+    original = extract[:original]
+    terminal = extract[:terminal]
 
-    unless unit == :plato
-      case unit
+    unless units == :plato
+      case units
       when :specific_gravity
-        original = Convert.specific_gravity_to_plato original
-        terminal = Convert.specific_gravity_to_plato terminal
+        original = Convert.specific_gravity_to_plato(extract[:original])
+        terminal = Convert.specific_gravity_to_plato(extract[:terminal])
       when :brix
-        og = Convert.brix_to_specific_gravity original
-        tg = Convert.terminal_brix_to_terminal_gravity original, terminal
-        original = Convert.specific_gravity_to_plato og
-        terminal = Convert.specific_gravity_to_plato tg
+        original = Convert.specific_gravity_to_plato(
+          Convert.brix_to_specific_gravity(extract[:original]))
+        terminal = Convert.specific_gravity_to_plato(
+          Convert.terminal_brix_to_terminal_gravity(
+            extract[:original], extract[:terminal]))
       else
-        raise ArgumentError, "#{unit} is not recogized as a unit of measure"
+        raise ArgumentError, "#{units} is an unknown unit of extract. Use :brix, :plato or :specific_gravity"
       end
     end
 
@@ -39,20 +46,26 @@ module Calculate
   end
 
   # Calculates alcohol by volume given original and terminal extract levels.
-  # Set the `unit` option for extract levels that are not degrees Plato.
-  # Other supported units are `:specific_gravity` and `:brix`.
+  # Supported extract units are `:brix`, `:plato` and `:specific_gravity`. Default: `:plato`
   #
   # @example
-  #    Calculate.alcohol_by_volume 17.5, 3.2
-  #    Calculate.alcohol_by_volume 1.055, 1.010, :specific_gravity
-  #    Calculate.alcohol_by_volume 15.2, 7.8, :brix
+  #     Calculate.alcohol_by_volume({ original: 17.5, terminal: 3.2 })
+  #
+  #     Calculate.alcohol_by_volume({
+  #       original: 1.055,
+  #       terminal: 1.010
+  #     }, :specific_gravity)
+  #
+  #     Calculate.alcohol_by_volume({
+  #       original: 15.2,
+  #       terminal: 7.8
+  #     }, :brix)
   #
-  # @param [Float] original the original extract level
-  # @param [Float] terminal the terminal extract level
+  # @param [Hash] extract the original and terminal extract levels
   # @param [Symbol] unit the unit used to measure extract
   # @return [Float] the alcohol content by volume
-  def self.alcohol_by_volume original, terminal, unit = :plato
-    ((alcohol_by_weight original, terminal, unit) / 0.793573).round 1
+  def self.alcohol_by_volume extract, units = :plato
+    ((alcohol_by_weight extract, units) / 0.793573).round 1
   end
 
 end

data/lib/calculators/calories.rb

@@ -3,32 +3,38 @@ require "conversions/extract"
 module Calculate
 
   # Calculates calories derived from alcohol content.
-  # Set the `unit` option for extract levels that are not degrees Plato.
-  # Other supported units are `:specific_gravity` and `:brix`.
+  # Supported extract units are `:brix`, `:plato` and `:specific_gravity`. Default: `:plato`
   #
   # @example
-  #    Calculate.calories_from_alcohol 17.5, 3.2
-  #    Calculate.calories_from_alcohol 1.055, 1.010, :specific_gravity
-  #    Calculate.calories_from_alcohol 15.2, 7.8, :brix
+  #    Calculate.calories_from_alcohol({ original: 17.5, terminal: 3.2 })
   #
-  # @param [Float] original the original extract level
-  # @param [Float] terminal the terminal extract level
+  #    Calculate.calories_from_alcohol({
+  #      original: 1.055,
+  #      terminal: 1.010
+  #    }, :specific_gravity)
+  #
+  #    Calculate.calories_from_alcohol({
+  #      original: 15.2,
+  #      terminal: 7.8
+  #    }, :brix)
+  #
+  # @param [Hash] extract the original and terminal extract levels
   # @param [Symbol] unit the unit used to measure extract
   # @return [Fixnum] the total calories from alcohol per 500ml
-  def self.calories_from_alcohol original, terminal, unit = :plato
-    original = original.to_f
-    terminal = terminal.to_f
+  def self.calories_from_alcohol extract, units = :plato
+    original = extract[:original]
+    terminal = extract[:terminal]
 
-    unless unit == :specific_gravity
-      case unit
+    unless units == :specific_gravity
+      case units
       when :brix
-        original = Convert.brix_to_specific_gravity original
-        terminal = Convert.terminal_brix_to_terminal_gravity original, terminal
+        original = Convert.brix_to_specific_gravity extract[:original]
+        terminal = Convert.terminal_brix_to_terminal_gravity extract[:original], extract[:terminal]
       when :plato
-        original = Convert.plato_to_specific_gravity original
-        terminal = Convert.plato_to_specific_gravity terminal
+        original = Convert.plato_to_specific_gravity extract[:original]
+        terminal = Convert.plato_to_specific_gravity extract[:terminal]
       else
-        raise ArgumentError, "#{unit} is not recogized as a unit of measure"
+        raise ArgumentError, "#{units} is an unknown unit of extract. Use :brix, :plato or :specific_gravity"
       end
     end
 
@@ -40,32 +46,38 @@ module Calculate
   end
 
   # Calculates calories derived from extract.
-  # Set the `unit` option for extract levels that are not degrees Plato.
-  # Other supported units are `:specific_gravity` and `:brix`.
+  # Supported extract units are `:brix`, `:plato` and `:specific_gravity`. Default: `:plato`
   #
   # @example
-  #    Calculate.calories_from_extract 17.5, 3.2
-  #    Calculate.calories_from_extract 1.055, 1.010, :specific_gravity
-  #    Calculate.calories_from_extract 15.2, 7.8, :brix
+  #     Calculate.calories_from_extract({ original: 17.5, terminal: 3.2 })
+  #
+  #     Calculate.calories_from_extract({
+  #       original: 1.055,
+  #       terminal: 1.010
+  #     }, :specific_gravity)
   #
-  # @param [Float] original the original extract level
-  # @param [Float] terminal the terminal extract level
+  #     Calculate.calories_from_extract({
+  #       original: 15.2,
+  #       terminal: 7.8
+  #     }, :brix)
+  #
+  # @param [Hash] extract the original and terminal extract levels
   # @param [Symbol] unit the unit used to measure extract
   # @return [Fixnum] the total calories from extract per 500ml
-  def self.calories_from_extract original, terminal, unit = :plato
-    original = original.to_f
-    terminal = terminal.to_f
+  def self.calories_from_extract extract, units = :plato
+    original = extract[:original]
+    terminal = extract[:terminal]
 
-    unless unit == :specific_gravity
-      case unit
+    unless units == :specific_gravity
+      case units
       when :brix
-        original = Convert.brix_to_specific_gravity original
-        terminal = Convert.terminal_brix_to_terminal_gravity original, terminal
+        original = Convert.brix_to_specific_gravity extract[:original]
+        terminal = Convert.terminal_brix_to_terminal_gravity extract[:original], extract[:terminal]
       when :plato
-        original = Convert.plato_to_specific_gravity original
-        terminal = Convert.plato_to_specific_gravity terminal
+        original = Convert.plato_to_specific_gravity extract[:original]
+        terminal = Convert.plato_to_specific_gravity extract[:terminal]
       else
-        raise ArgumentError, "#{unit} is not recogized as a unit of measure"
+        raise ArgumentError, "#{units} is an unknown unit of extract. Use :brix, :plato or :specific_gravity"
       end
     end
 
@@ -76,22 +88,28 @@ module Calculate
     (calories + (calories * 0.33)).round
   end
 
-  # Calculates total calories per serving.
-  # Set the `unit` option for extract levels that are not degrees Plato.
-  # Other supported units are `:specific_gravity` and `:brix`.
+  # Calculates calories per serving.
+  # Supported extract units are `:brix`, `:plato` and `:specific_gravity`. Default: `:plato`
   #
   # @example
-  #    Calculate.calories_per_serving 17.5, 3.2
-  #    Calculate.calories_per_serving 1.055, 1.010, :specific_gravity
-  #    Calculate.calories_per_serving 15.2, 7.8, :brix
+  #     Calculate.calories_per_serving({ original: 17.5, terminal: 3.2 })
+  #
+  #     Calculate.calories_per_serving({
+  #       original: 1.055,
+  #       terminal: 1.010
+  #     }, :specific_gravity)
+  #
+  #     Calculate.calories_per_serving({
+  #       original: 15.2,
+  #       terminal: 7.8
+  #     }, :brix)
   #
-  # @param [Float] original the original extract level
-  # @param [Float] terminal the terminal extract level
+  # @param [Hash] extract the original and terminal extract levels
   # @param [Symbol] unit the unit used to measure extract
   # @return [Fixnum] the total calories per 500ml
-  def self.calories_per_serving original, terminal, unit = :plato
-    (calories_from_alcohol original, terminal, unit) +
-    (calories_from_extract original, terminal, unit)
+  def self.calories_per_serving extract, units = :plato
+    (calories_from_alcohol extract, units) +
+    (calories_from_extract extract, units)
   end
 
 end