beerxml 0.0.2 → 0.3.0

data/beerxml.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.add_dependency "nokogiri", "~> 1.4"
   s.add_dependency "dm-core", "~> 1.0"
   s.add_dependency "dm-validations", "~> 1.0"
-  s.add_dependency "dm-types", "~> 1.0"
 
   s.add_development_dependency "rspec", "~> 2.5"
   s.add_development_dependency "autotest-standalone"

data/lib/beerxml.rb

@@ -1,5 +1,4 @@
 require 'dm-core'
-require 'dm-types'
 require 'dm-validations'
 require 'nokogiri'
 

data/lib/beerxml/fermentable.rb

@@ -1,6 +1,6 @@
 class Beerxml::Fermentable < Beerxml::Model
   property :name, String, :required => true
-  property :type, Enum['Grain', 'Sugar', 'Extract', 'Dry Extract', 'Adjunct'], :required => true
+  property :type, String, :set => ['Grain', 'Sugar', 'Extract', 'Dry Extract', 'Adjunct'], :required => true
   property :amount, Weight, :required => true
   property :yield, Float, :required => true
   property :color, Float, :required => true
@@ -21,6 +21,10 @@ class Beerxml::Fermentable < Beerxml::Model
   property :id, Serial
   belongs_to :recipe, :required => false
 
+  def ppg=(ppg)
+    self.yield = Beerxml.round((ppg / 46.214) / 0.01, 2)
+  end
+
   def ppg
     # potential is (yield * 0.001 + 1)
     (self.yield * 0.01) * 46.214
@@ -31,4 +35,8 @@ class Beerxml::Fermentable < Beerxml::Model
     total *= (efficiency * 0.01) unless efficiency.nil? || type != 'Grain'
     total
   end
+
+  def total_color
+    amount.in_pounds.to_f * color
+  end
 end

data/lib/beerxml/hop.rb

@@ -2,12 +2,12 @@ class Beerxml::Hop < Beerxml::Model
   property :name, String, :required => true
   property :alpha, Float, :required => true
   property :amount, Weight, :required => true
-  property :use, Enum['Boil', 'Dry Hop', 'Mash', 'First Wort', 'Aroma'], :required => true
+  property :use, String, :set => ['Boil', 'Dry Hop', 'Mash', 'First Wort', 'Aroma'], :required => true
   property :time, Time, :required => true
 
   property :notes, String, :length => 65535
-  property :type, Enum[nil, 'Bittering', 'Aroma', 'Both']
-  property :form, Enum[nil, 'Pellet', 'Plug', 'Leaf']
+  property :type, String, :set => ['Bittering', 'Aroma', 'Both']
+  property :form, String, :set => ['Pellet', 'Plug', 'Leaf']
   property :beta, Float
   property :hsi, Float
   property :origin, String, :length => 512

data/lib/beerxml/model.rb

@@ -43,13 +43,10 @@ class Beerxml::Model
       read_xml_field(node, property.name.to_s)
     end
     # load any has-many relationships with other beerxml models
-    relationships.each do |name, rel|
-      child_model = rel.child_model
-      next unless child_model.ancestors.include?(Beerxml::Model)
-
+    each_beerxml_relationship do |rel|
       # look for the plural element in the children of this node
       # e.g., for Hop, see if there's any HOPS element.
-      (node>child_model.beerxml_plural_name).each do |child_wrapper_node|
+      (node>rel.child_model.beerxml_plural_name).each do |child_wrapper_node|
         collection = Beerxml::Model.collection_from_xml(child_wrapper_node)
         self.send(rel.name).concat(collection)
       end
@@ -83,9 +80,16 @@ class Beerxml::Model
     attributes.each do |attr, val|
       next if attr.to_s.match(/id\z/) || val.nil?
       x = Nokogiri::XML::Node.new(self.class.xml_attr_name(attr), parent)
-      x.content = val # TODO: data types
+      x.content = self.class.properties[attr].dump(val)
       node.add_child(x)
     end
+    each_beerxml_relationship do |rel|
+      objs = self.send(rel.name)
+      next if objs.empty?
+      sub_node = Nokogiri::XML::Node.new(rel.child_model.beerxml_plural_name, node)
+      node.add_child(sub_node)
+      objs.each { |o| o.to_beerxml(sub_node) }
+    end
     parent.add_child(node)
     parent
   end
@@ -97,7 +101,18 @@ class Beerxml::Model
   def self.xml_attr_name(name)
     name.to_s.upcase
   end
+
+  def beerxml_relationships
+    []
+  end
+
+  def each_beerxml_relationship
+    relationships.each do |name, rel|
+      next unless beerxml_relationships.include?(rel.name)
+      yield rel
+    end
+  end
 end
 
-%w(hop recipe fermentable).
+%w(hop recipe fermentable yeast).
   each { |f| require "beerxml/#{f}" }

data/lib/beerxml/properties.rb

@@ -8,10 +8,14 @@ module Beerxml::Properties
       true
     end
 
+    def primitive?(value)
+      value.is_a?(Beerxml::Unit) && value.type == unit_type
+    end
+
     def load(value)
       return if value.nil?
       if value.is_a?(Beerxml::Unit)
-        raise(ArgumentError, 'Weight required') unless value.type == unit_type
+        raise(ArgumentError, "#{value.inspect} is not a #{unit_type}") unless value.type == unit_type
         value
       else
         U(value, base_unit)

data/lib/beerxml/recipe.rb

@@ -2,7 +2,7 @@ class Beerxml::Recipe < Beerxml::Model
   include DataMapper::Resource
 
   property :name, String, :required => true
-  property :type, Enum['Extract', 'Partial Mash', 'All Grain'], :required => true
+  property :type, String, :set => ['Extract', 'Partial Mash', 'All Grain'], :required => true
   # has 1, :style, :required => true
   property :brewer, String, :required => true
   property :batch_size, Volume, :required => true
@@ -14,9 +14,13 @@ class Beerxml::Recipe < Beerxml::Model
   has n, :hops
   has n, :fermentables
   # has n, :miscs
-  # has n, :yeasts
+  has n, :yeasts
   # has n, :waters
 
+  def beerxml_relationships
+    [:hops, :fermentables, :miscs, :yeasts, :waters]
+  end
+
   property :asst_brewer, String
   property :notes, String, :length => 65535
   property :taste_notes, String, :length => 65535
@@ -47,7 +51,7 @@ class Beerxml::Recipe < Beerxml::Model
   property :id, Serial
 
   def tinseth
-    Beerxml.round(hops.select { |h| h.use == 'Boil' }.inject(0) { |v, h| v + h.tinseth(og, batch_size) }, 1)
+    Beerxml.round(hops.select { |h| h.use == 'Boil' }.inject(0) { |v, h| v + h.tinseth(calculate_og, batch_size) }, 1)
   end
   alias_method :ibus, :tinseth
 
@@ -56,4 +60,14 @@ class Beerxml::Recipe < Beerxml::Model
     og = 1 + ((total_ppg / batch_size.in_gallons.to_f) * 0.001)
     Beerxml.round(og, 3)
   end
+
+  def calculate_fg
+    og = calculate_og
+    Beerxml.round(og - ((og - 1) * yeasts.first.attenuation * 0.01), 3)
+  end
+
+  def color
+    color = fermentables.inject(0) { |v, f| v + f.total_color }
+    Beerxml.round(1.4922 * ((color / batch_size.in_gallons.to_f) ** 0.6859), 1)
+  end
 end

data/lib/beerxml/unit.rb

@@ -96,25 +96,10 @@ class Unit
     end
   end
 
-  # todo: remove this, to_beerxml is using it (and incorrectly at that)
-  def to_s
-    to_f.to_s
-  end
-
   def inspect
     "[#{to_f} #{unit}]"
   end
 
-  def *(rhs)
-    if rhs.is_a?(Numeric)
-      ret = Unit.new(self.to_f * rhs, self.unit)
-    elsif rhs.is_a?(Unit) && rhs.type == type
-      ret = Unit.new(self.to_f * rhs.to(self.unit).to_f, self.unit)
-    else
-      super
-    end
-  end
-
   # Assumes earth gravity ;)
   module Weight
     def self.included(k)

data/lib/beerxml/version.rb

@@ -1,3 +1,3 @@
 module Beerxml
-  VERSION = "0.0.2"
+  VERSION = "0.3.0"
 end

data/lib/beerxml/yeast.rb

@@ -0,0 +1,26 @@
+class Beerxml::Yeast < Beerxml::Model
+  include DataMapper::Resource
+
+  property :name, String, :required => true
+  property :type, String, :set => ['Ale', 'Lager', 'Wheat', 'Wine', 'Champagne'], :required => true
+  property :form, String, :set => ['Liquid', 'Dry', 'Slant', 'Culture'], :required => true
+  # TODO: sheesh... this can be a Weight instead, if amount_is_weight
+  property :amount, Volume, :required => true
+
+  property :amount_is_weight, Boolean
+  property :laboratory, String
+  property :product_id, String
+  property :min_temperature, Temperature
+  property :max_temperature, Temperature
+  property :flocculation, String, :set => ['Low', 'Medium', 'High', 'Very High']
+  property :attenuation, Float
+  property :notes, String, :length => 65535
+  property :best_for, String
+  property :times_cultured, Integer
+  property :max_reuse, Integer
+  property :add_to_secondary, Boolean
+
+  # these are not used in the xml
+  property :id, Serial
+  belongs_to :recipe, :required => false
+end

data/spec/dumping_spec.rb

@@ -0,0 +1,37 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe "dumping" do
+  describe "sanity checks" do
+    it "should dump hops" do
+      model = Beerxml::Hop.new({
+        :name => 'Northern Brewer',
+        :origin => 'Germany',
+        :alpha => 8.5,
+        :amount => 0.0,
+        :use => 'Boil',
+        :time => 0.0,
+        :notes => %{Also called Hallertauer Northern Brewers
+  Use for: Bittering and finishing both ales and lagers of all kinds
+  Aroma: Fine, dry, clean bittering hop.  Unique flavor.
+  Substitute: Hallertauer Mittelfrueh, Hallertauer
+  Examples: Anchor Steam, Old Peculiar, },
+        :type => 'Both',
+        :form => 'Pellet',
+        :beta => 4.0,
+        :hsi => 35.0,
+      })
+      model.should be_valid
+      xml = model.to_beerxml.root
+      (xml>'NAME').text.should == 'Northern Brewer'
+      (xml>'ORIGIN').text.should == 'Germany'
+      (xml>'ALPHA').text.should == '8.5'
+      (xml>'AMOUNT').text.should == '0.0'
+      (xml>'USE').text.should == 'Boil'
+      (xml>'TIME').text.should == '0.0'
+      (xml>'TYPE').text.should == 'Both'
+      (xml>'FORM').text.should == 'Pellet'
+      (xml>'BETA').text.should == '4.0'
+      (xml>'HSI').text.should == '35.0'
+    end
+  end
+end

data/spec/full_stack_spec.rb

@@ -0,0 +1,106 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+include Beerxml
+
+describe "Centennial Blonde" do
+  before(:each) do
+    # http://www.homebrewtalk.com/f66/centennial-blonde-simple-4-all-grain-5-10-gall-42841/
+    @recipe = Recipe.new(:name => 'Centennial Blonde',
+                         :type => 'All Grain',
+                         :brewer => 'BierMuncher',
+                         :batch_size => 5.5.gallons,
+                         :boil_size => 6.75.gallons,
+                         :boil_time => 60.minutes,
+                         :efficiency => 70.0)
+    @recipe.hops << Hop.new(:name => 'Centennial',
+                            :alpha => 9.5,
+                            :amount => 0.25.oz,
+                            :use => 'Boil',
+                            :time => 55)
+    @recipe.hops << Hop.new(:name => 'Centennial',
+                            :alpha => 9.5,
+                            :amount => 0.25.oz,
+                            :use => 'Boil',
+                            :time => 35)
+    @recipe.hops << Hop.new(:name => 'Cascade',
+                            :alpha => 7.8,
+                            :amount => 0.25.oz,
+                            :use => 'Boil',
+                            :time => 20)
+    @recipe.hops << Hop.new(:name => 'Cascade',
+                            :alpha => 7.8,
+                            :amount => 0.25.oz,
+                            :use => 'Boil',
+                            :time => 5)
+    @recipe.fermentables << Fermentable.new(:name => 'Pale Malt (2 Row)',
+                                            :type => 'Grain',
+                                            :amount => 7.pounds,
+                                            :ppg => 37,
+                                            :color => 2)
+    @recipe.fermentables << Fermentable.new(:name => 'Cara-Pils',
+                                            :type => 'Grain',
+                                            :amount => 0.75.lb,
+                                            :ppg => 33,
+                                            :color => 2)
+    @recipe.fermentables << Fermentable.new(:name => 'Crystal 10L',
+                                            :type => 'Grain',
+                                            :amount => 0.5.pounds,
+                                            :ppg => 35,
+                                            :color => 10)
+    @recipe.fermentables << Fermentable.new(:name => 'Vienna',
+                                            :type => 'Grain',
+                                            :amount => U(0.5, 'lb'),
+                                            :ppg => 35,
+                                            :color => 4)
+    @recipe.yeasts << Yeast.new(:name => 'Nottingham',
+                                :type => 'Ale',
+                                :form => 'Dry',
+                                :amount => 0.2.liters,
+                                :attenuation => 75)
+    @recipe.should be_valid
+  end
+
+  it "should calculate basic stats" do
+    @recipe.ibus.round.should == 20
+    @recipe.calculate_og.should == 1.041
+    @recipe.calculate_fg.should == 1.010
+    @recipe.color == 3.9
+  end
+
+  it "should survive the serialization round trip" do
+    xml = Nokogiri::XML(@recipe.to_xml)
+    r2 = Recipe.new.from_xml(xml.root)
+    r2.should be_valid
+    r2.attributes.should == @recipe.attributes
+    r2.each_beerxml_relationship do |rel|
+      r2.send(rel.name).map(&:attributes).should == @recipe.send(rel.name).map(&:attributes)
+    end
+  end
+
+  it "should calculate basic stats for the extract version" do
+    @extract = Recipe.new(:name => 'Centennial Blonde',
+                          :type => 'Extract',
+                          :brewer => 'BierMuncher',
+                          :batch_size => U(5.5, 'gallons'),
+                          :boil_size => U(6.75, 'gallons'),
+                          :boil_time => U(60, 'minutes'),
+                          :efficiency => 70.0)
+    @extract.hops.concat @recipe.hops
+    @extract.yeasts.concat @recipe.yeasts
+    @extract.fermentables << Fermentable.new(:name => 'Extra Light DME',
+                                            :type => 'Dry Extract',
+                                            :amount => U(5, 'lb'),
+                                            :ppg => 43,
+                                            :color => 3)
+    @extract.fermentables << Fermentable.new(:name => 'Cara-Pils',
+                                             :type => 'Grain',
+                                             :amount => U(1, 'lb'),
+                                             :ppg => 33,
+                                             :color => 2)
+    @extract.should be_valid
+    @extract.ibus.round.should == 20
+    @extract.calculate_og.should == 1.043
+    @extract.calculate_fg.should == 1.011
+    @extract.color == 3.2
+  end
+end

data/spec/parsing_spec.rb

@@ -1,6 +1,6 @@
 require "#{File.dirname(__FILE__)}/spec_helper"
 
-describe "beerxml.com examples" do
+describe "parsing" do
   it "should parse the first recipe and its hops" do
     recipe = Beerxml::Recipe.new.from_xml(read_xml("recipes").root.children[1])
 
@@ -101,6 +101,26 @@ Examples: Anchor Steam, Old Peculiar, },
         :hsi => 35.0,
       })
     end
+    it "should parse yeasts" do
+      check_parse(Beerxml::Yeast, "yeast", 3, {
+        :name => 'European Ale',
+        :type => 'Ale',
+        :form => 'Liquid',
+        :amount => 0.035,
+        :amount_is_weight => false,
+        :laboratory => 'White Labs',
+        :product_id => 'WLP011',
+        :min_temperature => 18.3,
+        :max_temperature => 21.1,
+        :flocculation => 'Medium',
+        :attenuation => 67.5,
+        :notes => "Malty, Northern European ale yeast.  Low ester production, low sulfer, gives a clean profile.  Low attenuation contributes to malty taste.",
+        :best_for => "Alt, Kolsch, malty English Ales, Fruit beers",
+        :max_reuse => 5,
+        :times_cultured => 0,
+        :add_to_secondary => false,
+      })
+    end
     it "should parse recipes" do
       recipe = check_parse(Beerxml::Recipe, "recipes", 3, {
         :name => 'Dry Stout',

data/spec/recipes_spec.rb

@@ -4,7 +4,7 @@ describe Beerxml::Recipe do
   it "should calculate IBUs using the tinseth method" do
     recipe = Beerxml::Recipe.new.from_xml(read_xml("recipes").root.children[1])
     recipe.should be_valid
-    recipe.ibus.round.should == 32
+    recipe.ibus.round.should == 31
   end
 
   it "should calculate the OG for an all grain batch" do
@@ -12,4 +12,10 @@ describe Beerxml::Recipe do
     recipe.should be_valid
     recipe.calculate_og.should == 1.056
   end
+
+  it "should calculate the FG for an all grain batch" do
+    recipe = Beerxml::Recipe.new.from_xml(read_xml("recipes").root.children[1])
+    recipe.should be_valid
+    recipe.calculate_fg.should == 1.016
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'beerxml'
 
 require 'rspec'
 
+Beerxml::Unit.apply_to_numeric!
+
 RSpec.configure do |c|
   def filename(example)
     "examples/beerxml.com/#{example}.xml"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: beerxml
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: 
   segments: 
   - 0
+  - 3
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brian Palmer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -07:00
+date: 2011-03-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,25 +63,10 @@ dependencies:
         version: "1.0"
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: dm-types
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -92,11 +77,11 @@ dependencies:
         - 5
         version: "2.5"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: autotest-standalone
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -106,11 +91,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: autotest-growl
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -120,11 +105,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -134,11 +119,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id008
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -148,7 +133,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id009
+  version_requirements: *id008
 description: |-
   Library for parsing and generating beerxml (http://www.beerxml.com/).
   More than that, this library also contains various methods for doing calculations on beer ingredients and recipes, among other helpers.
@@ -185,6 +170,9 @@ files:
 - lib/beerxml/recipe.rb
 - lib/beerxml/unit.rb
 - lib/beerxml/version.rb
+- lib/beerxml/yeast.rb
+- spec/dumping_spec.rb
+- spec/full_stack_spec.rb
 - spec/hops_spec.rb
 - spec/parsing_spec.rb
 - spec/recipes_spec.rb
@@ -225,6 +213,8 @@ signing_key:
 specification_version: 3
 summary: Library for parsing and generating beerxml (http://www.beerxml.com/)
 test_files: 
+- spec/dumping_spec.rb
+- spec/full_stack_spec.rb
 - spec/hops_spec.rb
 - spec/parsing_spec.rb
 - spec/recipes_spec.rb