gravitheque 0.4.0 → 0.5.0

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 1.9.2
   - 1.9.3
   - jruby-head
   - rbx-19mode

data/Gemfile

@@ -1,13 +1,14 @@
 source :rubygems
 
 group :development do
-  gem "guard-minitest"
+  gem "guard-minitest-decisiv"
   gem "guard-yard"
 end
 
 group :documentation do
   gem "github-markup"
-  gem "redcarpet", "~> 1.0"
+  gem "redcarpet"
+  gem "yard", :platforms => [:mri, :jruby], :group => :test
 end
 
 group :mac do
@@ -16,6 +17,8 @@ group :mac do
 end
 
 group :test do
+  gem "minitest"
+  gem "reek"
+  gem "ruby2ruby", "~> 1.2.0" # Reek needs the older version
   gem "simplecov", :platforms => [:mri, :jruby]
-  gem "yard", :platforms => [:mri, :jruby]
 end

data/Guardfile

@@ -1,7 +1,7 @@
 guard "minitest" do
-  watch(%r|^test/(.*)\/test_(.*)\.rb|)
-  watch(%r|^lib/(.*)\/(.*)\.rb|)        { |m| "test/#{m[1]}/test_#{m[2]}.rb" }
-  watch(%r|^test/test_helper\.rb|)      { "test" }
+  watch(%r|^test/test_(.*)\.rb|)
+  watch(%r|^lib/(.*)\.rb|) { |m| "test/test_#{m[1]}.rb" }
+  watch(%r|^test/helper\.rb|) { "test" }
 end
 
 guard "yard" do

data/README.md

@@ -6,7 +6,8 @@ application are particularly useful right now.**
 A collection of [open source][oss] tools for brewers. It can be used as
 a [web application][web], interactively through IRB or as a [library][lib] to
 build your own brewing application. For use as a library refer to the full
-[documentation][doc].
+[documentation][doc]. Submit bug reports and feature requests to the
+[issue tracker][iss].
 
 ## Installation
 
@@ -14,11 +15,13 @@ build your own brewing application. For use as a library refer to the full
 gem install gravitheque
 ```
 
-To use the Gravitheque library nothing more than a compatible Ruby 1.9.3
+To use the Gravitheque library nothing more than a compatible Ruby 1.9
 implementation is required. It may work on older and newer versions but only by
-coincidence; refer to the [build logs][trv] to see which Rubies are supported.
+coincidence; refer to the [build logs][tci] to see which Rubies are supported.
 
-### Development
+## Development
+
+**If you plan to send pull requests please work in a branch**.
 
 ```bash
 git clone git://github.com/johnmuhl/gravitheque.git
@@ -34,319 +37,15 @@ bundle install
 # bundle install --without mac
 ```
 
-Now use [Guard][grd] to run tests and update documentation automatically.
+Now use Guard to run tests and update documentation automatically.
 
 ```bash
 guard start --clear
 ```
 
-## Calculators
-
-### Alcohol
-
-```ruby
-require "calculators/alcohol"
-
-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
-
-```ruby
-require "calculators/calories"
-
-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
-
-```ruby
-require "calculators/hops"
-
-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
-
-```ruby
-require "calculators/mash"
-
-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
-
-```ruby
-require "calculators/yeast"
-
-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
-
-### Extract
-
-```ruby
-require "conversions/extract"
-
-Convert.brix_to_specific_gravity 14.2
-
-Convert.terminal_brix_to_terminal_gravity 16.2, 7.8
-
-Convert.plato_to_specific_gravity 16
-
-Convert.specific_gravity_to_plato 1.055
-
-Convert.specific_gravity_to_temperature_corrected_gravity 1.045, 160
-Convert.specific_gravity_to_temperature_corrected_gravity 1.028, 50, :celsius
-```
-
-### Mass
-
-```ruby
-require "conversions/mass"
-
-Convert.grams_to_ounces 30
-
-Convert.ounces_to_grams 3
-
-Convert.kilograms_to_pounds 15
-
-Convert.pounds_to_kilograms 8
-```
-
-### Temperature
-
-```ruby
-require "conversions/temperature"
-
-Convert.celsius_to_fahrenheit 25
-
-Convert.farhenheit_to_celsius 154
-```
-
-### Volumes
-
-```ruby
-require "conversions/volumes"
-
-Convert.gallons_to_liters 8
-
-Convert.liters_to_gallons 23
-
-Convert.liters_to_quarts 5
-
-Convert.quarts_to_liters 11
-```
-
 [doc]: http://rubydoc.info/gems/gravitheque
-[grd]: https://github.com/guard/guard
+[iss]: https://github.com/johnmuhl/gravitheque/issues
 [lib]: http://rubygems.org/gems/gravitheque
 [oss]: https://github.com/johnmuhl/gravitheque
-[trv]: http://travis-ci.org/johnmuhl/gravitheque
+[tci]: http://travis-ci.org/johnmuhl/gravitheque
 [web]: http://gravitheque.herokuapp.com/

data/bin/test

@@ -2,7 +2,44 @@
 
 system "clear" unless ENV["CI"]
 
-tests = Dir.glob "test/**/*.rb"
+unless RUBY_ENGINE == "rbx"
+  # No Coverage module on Rubinius
+  require "simplecov"
+
+  class SimpleCov::Formatter::NoHTMLFormatter
+    def format result
+      puts "\n#{result.covered_percent.round}% test coverage"
+    end
+  end
+
+  SimpleCov.start do
+    @formatter = ENV["CI"] ? SimpleCov::Formatter::NoHTMLFormatter :
+                             SimpleCov::Formatter::HTMLFormatter
+  end
+
+  # YARD crashes on Rubinius
+  yard_stats = `yard stats --list-undoc 2>&1`
+  if yard_stats =~ /100.00%/
+    puts "100% documentation coverage\n\n"
+  else
+    puts yard_stats
+  end
+end
+
+# SimpleCov requires you load it before your code
+require "./test/helper"
+
+tests = Dir.glob "test/test_*.rb"
 tests.each { |test| require File.expand_path test }
 
 MiniTest::Unit.autorun
+
+unless RUBY_ENGINE == "jruby"
+  # Reek throws weird errors on JRuby
+  reek_stats = `reek --quiet lib/**`
+  if reek_stats.empty?
+    puts "100% reek free\n\n"
+  else
+    puts "#{reek_stats}\n"
+  end
+end

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.4.0"
+  gem.version       = "0.5.0"
 end

data/lib/alcohol.rb

@@ -0,0 +1,35 @@
+# Calculate the alcohol content of beer
+module Alcohol
+
+  # Calculates alcohol by weight
+  #
+  # @note
+  #     Extract must be measured in Plato
+  #
+  # @example
+  #     Alcohol.by_weight 15, 3
+  #
+  # @param [Float] original original Plato
+  # @param [Float] terminal terminal Plato
+  # @return [Float] alcohol content by weight
+  def self.by_weight original, terminal
+    ((original - ((0.1808 * original) + (0.8192 * terminal))) /
+     (2.0665 - (0.010665 * original))).round 1
+  end
+
+  # Calculates alcohol by volume
+  #
+  # @note
+  #     Extract must be measured in Plato
+  #
+  # @example
+  #     Alcohol.by_volume 17.5, 3.2
+  #
+  # @param [Float] original original Plato
+  # @param [Float] terminal terminal Plato
+  # @return [Float] alcohol content by volume
+  def self.by_volume original, terminal
+    ((by_weight original, terminal) / 0.793573).round 1
+  end
+
+end