brewser 0.1.0

data/lib/brewser/model/recipe.rb

@@ -0,0 +1,50 @@
+module Brewser
+  class Recipe < Model
+    belongs_to :batch
+    
+    property :date_created, Date
+    property :name, String, :required => true
+    property :description, String, :length => 65535
+
+    property :type, String, :set => ['Ale', 'Lager', 'Wheat', 'Cider', 'Mead', 'Hybrid']
+    property :method, String, :set => ['Extract', 'Partial Mash', 'All Grain'], :required => true
+    
+    has 1, :style
+    validates_presence_of :style
+    
+    property :brewer, String
+    property :recipe_volume, Volume, :required => true
+    property :boil_volume, Volume, :required => true
+    property :boil_time, Time, :required => true
+    property :recipe_efficiency, Float
+    validates_presence_of :recipe_efficiency, :if => proc { |t| t.method != 'Extract' }
+
+    has n, :hops
+    has n, :fermentables
+    has n, :additives
+    has n, :yeasts
+    
+    has 1, :mash_schedule
+    has 1, :fermentation_schedule
+    has 1, :water_profile
+
+    property :asst_brewer, String
+    property :taste_notes, String, :length => 65535
+    property :taste_rating, Float
+    
+    property :estimated_og, Float
+    property :estimated_fg, Float
+    property :estimated_color, Float
+    property :estimated_ibu, Float
+    property :estimated_abv, Float
+    
+    property :source, String, :length => 65535
+    property :url, String, :length => 65535
+        
+    property :carbonation_level, Float
+  
+    validates_presence_of :mash_schedule, :if => proc { |t| t.method != 'Extract' }
+    
+  end
+
+end

data/lib/brewser/model/style.rb

@@ -0,0 +1,29 @@
+module Brewser 
+  class Style < Brewser::Model
+    belongs_to :recipe
+    
+    property :name, String, :required => true
+    property :category, String, :required => true
+    property :category_number, String, :required => true
+    property :style_letter, String, :required => true
+    property :style_guide, String, :required => true
+    property :type, String, :set => %w(Lager Ale Mead Wheat Mixed Cider)
+    property :og_min, Float
+    property :og_max, Float
+    property :fg_min, Float
+    property :fg_max, Float
+    property :ibu_min, Float
+    property :ibu_max, Float
+    property :color_min, Float
+    property :color_max, Float
+
+    property :carb_min, Float
+    property :carb_max, Float
+    property :abv_min, Float
+    property :abv_max, Float
+    property :notes, String, :length => 65535
+    property :profile, String, :length => 65535
+    property :ingredients, String, :length => 65535
+    property :examples, String, :length => 65535
+  end
+end

data/lib/brewser/model/units.rb

@@ -0,0 +1,102 @@
+require 'ruby-units'
+
+module Brewser::Model::Units
+  
+  class Units < DataMapper::Property::String
+    
+    # Declare this property as custom
+    def custom?
+      true
+    end
+
+    # Compare the values kind (mass, volume, etc) to the object classes kind_of
+    #
+    # @param [Unit] value value to be checked
+    # @return [Boolean] returns true if value is of the correct kind
+    def valid_kind?(value)
+      value.kind == kind_of
+    end
+
+    # 
+    def primitive?(value)
+      value.is_a?(Unit) && valid_kind?(value)
+    end
+
+    def load(value)
+      return if value.nil?
+      if !value.u.unitless?
+        raise(ArgumentError, "#{value.inspect} is not a #{kind_of}") unless value.u.kind == kind_of
+        value.u
+      else
+        "#{value} #{base_unit}".u
+      end
+    end
+
+    def dump(value)
+      return if value.nil?
+      value.u.to_s
+    end
+
+    def typecast_to_primitive(value)
+      load(value)
+    end
+  end
+
+  # Represents a weight. Default scale is kilograms, since that's what
+  # BeerXML uses. But can handle conversion/display of other units.
+  class Weight < Units
+    def kind_of
+      :mass
+    end
+    def base_unit
+      'kg'
+    end
+  end
+
+  # A volume, in liters.
+  class Volume < Units
+    def kind_of
+      :volume
+    end
+    def base_unit
+      'l'
+    end
+  end
+
+  class WeightOrVolume < Units
+    
+    def valid_kind?(value)
+      value.kind == :mass || value.kind == :volume
+    end
+    def base_unit
+    end
+  end
+  
+  # A temperature, in deg C.
+  class Temperature < Units
+    def kind_of
+      :temperature
+    end
+    def base_unit
+      'dC'
+    end
+  end
+
+  # A time, in minutes.
+  class Time < Units
+    def kind_of
+      :time
+    end
+    def base_unit
+      'min'
+    end
+  end
+
+  # Time, but in days.
+  class TimeInDays < Time
+    def base_unit
+      'days'
+    end
+  end
+
+end

data/lib/brewser/model/water_profile.rb

@@ -0,0 +1,16 @@
+module Brewser
+  class WaterProfile < Model    
+    belongs_to :recipe
+    
+    property :name, String, :required => true
+
+    property :calcium, Float, :required => true
+    property :magnesium, Float, :required => true
+    property :sodium, Float, :required => true
+    property :chloride, Float, :required => true
+    property :sulfates, Float, :required => true
+    property :bicarbonate, Float
+    property :alkalinity, Float
+    property :ph, Float
+  end
+end

data/lib/brewser/model/yeast.rb

@@ -0,0 +1,29 @@
+module Brewser
+  class Yeast < Model
+    belongs_to :recipe
+    
+    property :name, String, :required => true
+    property :description, String, :length => 65535
+    
+    property :type, String, :set => ['Ale', 'Lager', 'Wheat', 'Wine', 'Champagne'], :required => true
+
+    property :supplier, String
+    property :catalog, String
+    
+    property :min_temperature, Temperature
+    property :max_temperature, Temperature
+    property :flocculation, String, :set => ['Low', 'Medium', 'High', 'Very High']
+    property :attenuation, Float
+    property :best_for, String
+    property :max_reuse, Integer
+    
+    # Recipes
+    property :add_to_secondary?, Boolean
+    property :form, String, :set => ['Liquid', 'Dry', 'Slant', 'Culture'], :required => true
+    property :amount, WeightOrVolume, :required => true
+
+    # These are applicable only in Batches
+    property :times_cultured, Integer
+
+  end
+end

data/lib/brewser/ruby-units.rb

@@ -0,0 +1,31 @@
+require 'ruby-units'
+
+Unit.redefine!('celsius') do |celsius|
+  celsius.aliases  = %w{degC dC C celsius centigrade}
+end
+
+Unit.redefine!('fahrenheit') do |fahrenheit|
+  fahrenheit.aliases  = %w{degF dF F fahrenheit}
+end
+
+Unit.redefine!('gram') do |gram|
+  gram.aliases  = %w{g gm gram grams gramme grammes}
+end
+
+Unit.define('barrel') do |barrel|
+  barrel.definition = Unit('31 gal')
+  barrel.aliases    = %w{bbl bbls barrel barrels}
+end
+
+Unit.define('keg') do |keg|
+  keg.definition  = Unit('1/2 barrel')
+  keg.aliases     = %w{keg kegs}
+end
+
+# Add convienience method
+class Unit
+  # returns the scalar value convert to other units
+  def scalar_in(other)
+    to(other).scalar.to_f
+  end
+end

data/lib/brewser/version.rb

@@ -0,0 +1,3 @@
+module Brewser
+  VERSION = "0.1.0".freeze
+end

data/spec/basic_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "Basic spec" do
+  
+  it "should be able to identifiy json as BrewSON" do
+    Brewser.identify('{"test":"json"}').should == BrewSON
+  end
+  
+  it "should be able to identifiy xml as BeerXML" do
+    Brewser.identify(read_file('beerxmlv1/recipes.xml')).should == BeerXML
+  end
+  
+  it "should be able to identifiy xml as BeerXML2" do
+    Brewser.identify(read_file('beerxmlv2/belgian_white.xml')).should == BeerXML2
+  end
+  
+  it "should be able to identify text as ProMash Txt" do
+    Brewser.identify(read_file('promash/PumpkinAle.txt')).should == ProMashTxt
+  end
+  
+  it "should raise an error if it cannot identify content" do
+    Brewser.identify("Some unknown content").should == ProMashRec
+  end
+  
+  context "BeerXML v1" do
+    
+    it "should extract multiple recipes" do
+      recipes = Brewser.parse(read_file('beerxmlv1/recipes.xml'))
+      recipes.count.should == 4
+      recipes.first.class.should == BeerXML::Recipe
+    end
+    
+    it "should raise an error when encountered" do
+      lambda { Brewser.parse(read_file('beerxmlv1/broken.xml')) }.should raise_error
+    end
+  
+  end  
+end
+

data/spec/beerxml_spec.rb

@@ -0,0 +1,159 @@
+require "spec_helper"
+
+describe "BeerXML tests" do
+
+  context "BeerXML v1" do
+    
+    before :each do
+      @recipe = Brewser.parse(read_file('beerxmlv1/recipes.xml')).first
+    end
+    
+    it "should deserialize the base recipe data" do
+      @recipe.name.should == "Burton Ale"
+      @recipe.brewer.should == "Brad Smith"
+      @recipe.method.should == "All Grain"
+      @recipe.type.should == "Ale"
+      
+      @recipe.recipe_volume.class.should == Unit
+      @recipe.recipe_volume.kind.should == :volume
+      @recipe.recipe_volume.scalar_in('gal').should be_within(0.01).of(5)
+      
+      @recipe.boil_volume.class.should == Unit
+      @recipe.boil_volume.kind.should == :volume
+      @recipe.boil_volume.scalar_in('gal').should be_within(0.01).of(5.5)
+      
+      @recipe.boil_time.class.should == Unit
+      @recipe.boil_time.kind.should == :time
+      @recipe.boil_time.should == "60 min".u
+      
+      @recipe.recipe_efficiency.should == 72.0
+      
+      @recipe.estimated_og.should == 1.056
+      @recipe.estimated_fg.should == 1.015
+      @recipe.estimated_color.should == 7.0
+      @recipe.estimated_ibu.should == 32.4
+      @recipe.estimated_abv.should == 5.3
+    end
+    
+    it "should deserialize the hop data" do
+      @recipe.hops.count.should == 4
+      h=@recipe.hops[1]
+      h.name.should == "Northern Brewer"
+      h.origin.should == "Germany"
+      h.alpha_acids.should == 7.5
+      h.amount.should === "0.50 oz".u
+      h.added_when.should == "Boil"
+      h.time.should === "60 min".u
+      h.description.should_not be_nil
+      h.type.should == "Both"
+      h.form.should == "Pellet"
+      h.beta_acids.should == 4.0
+      h.storageability.should == 35.0
+    end
+    
+    it "should deserialize the fermentable data" do
+      @recipe.fermentables.count.should == 3
+      f=@recipe.fermentables[0]
+      f.name.should == "Pale Malt (2 Row) UK"
+      f.origin.should == "United Kingdom"
+      f.type.should == "Grain"
+      f.description.should_not be_nil
+      f.amount.should === "8 lb".u
+      f.potential.should == 1.036
+      f.color.should == 2.5
+      f.moisture.should == 4.0
+      f.diastatic_power.should == 45.0
+      f.protein.should == 10.1
+      f.late_addition.should == false
+      f.recommend_mash.should == false
+      f.max_in_batch.should == 100.0
+      f.ibu_gal_per_lb.should == 0.0
+    end
+    
+    it "should deserialize the additive data" do
+      @recipe.additives.count.should == 2
+      a=@recipe.additives[0]
+      a.name.should == "Irish Moss"
+      a.type.should == "Fining"
+      a.description.should_not be_nil
+      a.added_when.should == "Boil"
+      a.amount.should == "0.25 tsp".u
+      a.time.should == "10 min".u
+    end
+    
+    it "should deserialize the yeast data" do
+      @recipe.yeasts.count.should == 1
+      y=@recipe.yeasts.first
+      y.name.should == "Burton Ale"
+      y.type.should == "Ale"
+      y.form.should == "Liquid"
+      y.supplier.should == "White Labs"
+      y.catalog.should == "WLP023"
+      y.description.should_not be_nil
+      y.best_for.should_not be_nil
+      y.min_temperature.should == "68 dF".u
+      y.max_temperature.should == "73 dF".u
+      y.amount.should == "35 ml".u
+      y.add_to_secondary?.should == false
+      y.flocculation.should == "Medium"
+      y.attenuation.should == 72.0
+      y.max_reuse.should == 5
+      y.times_cultured.should == 0
+    end
+    
+    it "should deserialize the mash schedule data" do
+      m=@recipe.mash_schedule
+      m.name.should == "Single Infusion, Full Body"
+      m.grain_temp.should == "72 dF".u
+      m.sparge_temp.should == "168 dF".u
+    end
+    
+    it "should deserialize the mash step data" do
+      m=@recipe.mash_schedule
+      m.mash_steps.count.should == 2
+      s=m.mash_steps[0]
+      # @TODO Fix this
+      s.index.should == 1
+      s.name.should == "Mash In"
+      s.type.should == "Infusion"
+      s.description.should_not be_nil
+      s.rest_time.should == "45 min".u
+      s.rest_temperature.should == "70 dC".u
+      s.infusion_volume.should == "11.25 qt".u
+      s.infusion_temperature.should == "170.5 dF".u
+      s.water_to_grain_ratio.should == 1.25
+    end
+    
+    it "should deserialize the fermentation step data" do
+      f=@recipe.fermentation_schedule
+      f.fermentation_steps.count.should == 3
+      s=f.fermentation_steps[0]
+      s.index.should == 1
+      s.name.should == "Primary"
+      s.time.should == "4 days".u
+      s.temperature.should == "68 dF".u
+    end
+
+    it "should deserialize the water profile data" do
+      w=@recipe.water_profile
+      w.name.should == "Burton On Trent, UK"
+      w.description.should == "Distinctive pale ales strongly hopped.  Very hard water accentuates the hops flavor.\nExample: Bass Ale"
+      w.calcium.should == 295.0
+      w.bicarbonate.should == 300.0
+      w.sulfates.should == 725.0
+      w.chloride.should == 25.0
+      w.sodium.should == 55.0
+      w.magnesium.should == 45.0
+      w.ph.should ==8.0
+    end
+
+    it "should deserialize the style data" do
+      s=@recipe.style
+      s.name.should == "English Pale Ale"
+      s.category.should == "Bitter & English Pale Ale"
+      s.style_letter.should == "A"
+      s.style_guide.should == "BJCP 1999"
+      s.type.should == "Ale"
+    end
+  end
+end