brewser 0.1.0 → 0.2.0

data/README.md

@@ -3,7 +3,7 @@ brewser
 
 Brewser is a ruby library for parsing and generating serialized brewing data
 
-Currently brewser is very early in development but will eventually support the following input formats:
+Currently brewser is early in development but will eventually support the following input formats:
 * [BeerXML (v1, v2)](http://beerxml.org)
 * BrewSON - Brewser Recipe and Batches in JSON
 * [ProMash (.rec and text exports)](http://www.promash.com)
@@ -11,3 +11,27 @@ Currently brewser is very early in development but will eventually support the f
 Input files are deserialized into a common object model for consumption.  Brewser supports these output formats:
 * BeerXML
 * BrewSON
+
+# Status
+
+Currently, brewser can import BeerXML v1, ProMash .rec files as well as ProMash Recipe Reports (Text files).  Each
+file format contains different levels of details.  As a result there is no uniformity amongst the various format.  BeerXML v1
+is at this time the most complete serialized format.  
+
+# Installation
+
+Just add brewser to your Gemfile
+
+    gem 'brewser'
+  
+and run bundle install
+
+# Using 
+
+Brewser will attempt to identify the input file by content and delegate processing to the correct engine.  ProMash .rec files are not easy to identify, as a result this is the last engine attempted and it will try to decode any file you give it.  This is likely to result in garbage if the file is not a properly formatted .rec file.
+
+To load a BeerXML v1 file:
+
+    Brewser.parse(File.read("samples/beerxmlv1/recipes.xml"))
+    
+This will return an array of BeerXML::Recipe objects.

data/lib/brewser/engines/beerxml.rb

@@ -18,8 +18,8 @@ class BeerXML < Brewser::Engine
           ("BeerXML::#{inner.node_name.downcase.camelcase}".constantize).from_xml(inner)
         end
         return cleanup(objects)
-     # rescue
-     #   raise Error, "BeerXML engine encountered an issue and can not continue"
+     rescue
+       raise Error, "BeerXML engine encountered an issue and can not continue"
       end
     end
     
@@ -117,7 +117,6 @@ class BeerXML::Fermentable < Brewser::Fermentable
   def cleanup
     self.amount = display_amount.present? ? display_amount.u : "#{uncast_amount} kg".u
     self.potential = uncast_potential.present? ? uncast_potential.to_f : 1+(46*(yield_percent/100))/1000
-    self.ppg = (potential-1)*1000
   end
   
 end

data/lib/brewser/engines/beerxml2.rb

@@ -10,9 +10,7 @@ class BeerXML2 < Brewser::Engine
     end
 
     def deserialize(string_or_io)
-     results = parse_xml(string_or_io)
-     puts results.inspect
-     return results
+      parse_xml(string_or_io)
     end
     
     def serialize(brewser_model)

data/lib/brewser/engines/brewson.rb

@@ -7,10 +7,19 @@ class BrewSON < Brewser::Engine
     end
   
     def deserialize(string_or_io)
+       begin
+         JSON.parse(string_or_io)
+      rescue
+        raise Error, "BrewSON engine encountered an issue and can not continue"
+       end
     end
     
     def serialize(brewser_model)
-      brewser_model.deep_json
+       begin
+         JSON.generate(brewser_model)
+      rescue
+        raise Error, "BrewSON engine encountered an issue and can not continue"
+       end
     end
     
   end

data/lib/brewser/engines/promash_rec.rb

@@ -32,7 +32,8 @@ class ProMashRec < Brewser::Engine
       float :humulene
       float :caryphylene
       int8 :type
-      int8 :form
+      bit4 :form
+      bit4 :unknown
       float :storage_factor
       string :taste_notes, :length => 155, :trim_padding => true
       string :origin, :length => 55, :trim_padding => true
@@ -110,26 +111,29 @@ class ProMashRec < Brewser::Engine
       skip length: 8
     end
     
-    class MashStep < RecEntry
-      string :name, :length => 255, :trim_padding => true
-      int8 :type
-      int32 :start_temp
-      int32 :stop_temp
-      int32 :step_temp
-      int32 :rest_time
-      int32 :step_time
-      float :thickness
-      float :amount
-      skip length: 8
-    end
-    
-    class MashSchedule < RecEntry
-      int32 :_steps_count
-      int32 :grain_temp
-      skip length: 4
-      array :mash_steps, :type => :mash_step, :read_until => lambda { index == 50 }
-      string :name, :length => 256, :trim_padding => true
-    end
+    # class MashStep < RecEntry
+    #   string :name, :length => 255, :trim_padding => true
+    #   int8 :type
+    #   int32 :start_temp
+    #   int32 :stop_temp
+    #   int32 :step_temp
+    #   int32 :rest_time
+    #   int32 :step_time
+    #   float :thickness
+    #   float :amount
+    #   skip length: 8
+    # end
+    # 
+    # class MashSchedule < RecEntry
+    #   count_bytes_remaining :bytes_remaining
+    #   string :skipped, :length => lambda { bytes_remaining - 14888 }
+    #   int32 :_steps_count
+    #   int32 :grain_temp
+    #   skip length: 4
+    #   array :mash_steps, :type => :mash_step, :read_until => lambda { index == 50 }
+    #   string :name, :length => 255, :trim_padding => true
+    #   int8 :end_byte
+    # end
     
     class SimpleSchedule < RecEntry
       int32 :num_steps
@@ -194,9 +198,9 @@ class ProMashRec < Brewser::Engine
       yeast :yeast
       water_profile :water_profile
       simple_schedule :simple_schedule
-      string :notes, :length => 4029, :trim_padding => true
-      string :awards, :length => 3693, :trim_padding => true
-      mash_schedule :mash_schedule
+      string :notes, :length => 4028, :trim_padding => true
+      string :awards, :length => 2096, :trim_padding => true
+      #mash_schedule :mash_schedule
     end
   end
   
@@ -206,7 +210,7 @@ end
 class ProMashRec::Hop < Brewser::Hop
 
   @@hop_types = {0 => "Both", 1 => "Bittering", 2 => "Aroma"}
-  @@hop_forms = {1 => "Whole", 3 => "Whole",  21 => "Pellet", 23 => "Pellet", 11 => "Plug"}
+  @@hop_forms = {0 => "Whole", 1 => "Plug", 2 => "Pellet"}
   
   # Pellet 21, 23
   def from_promash(hop,time)
@@ -282,7 +286,7 @@ end
 class ProMashRec::Yeast < Brewser::Yeast
 
   def from_promash(y)
-    self.name = y.name.split("\x00")[0]
+    self.name = y.name.split("\x00")[0].strip
     self.supplier = y.supplier
     self.catalog = y.catalog
     self.attenuation = (y.aa_high + y.aa_low)/2
@@ -297,6 +301,8 @@ end
 
 class ProMashRec::MashStep < Brewser::MashStep
   
+  @@step_types = { 0 => "Infusion", 1 => "Direct", 2 => "Decoction" }
+  
   def from_simple(idx, name, rest_temp, rest_time)
     self.index = idx
     self.name = name
@@ -306,11 +312,29 @@ class ProMashRec::MashStep < Brewser::MashStep
     return self
   end
   
+  def from_promash(step,idx=nil)
+    self.name = step.name
+    self.index = idx
+    self.type = @@step_types[step.type]
+    self.ramp_time = "#{step.step_time} min".u
+    self.rest_temperature = "#{step.start_temp} dF".u
+    self.rest_time = "#{step.rest_time} min".u
+    self.infusion_temperature = "#{step.step_temp} dF".u unless step.step_temp.blank?
+    self.infusion_amount = "#{step.amount} qts".u unless step.amount.blank?
+    
+    return self
+  end
+
 end
 
 class ProMashRec::MashSchedule < Brewser::MashSchedule
   
   def from_promash(mash)
+    self.name = mash.name
+    self.grain_temp = "#{mash.grain_temp} dF".u
+    mash.steps.each do |step, idx|
+      self.mash_steps.push ProMashRec::MashStep.new.from_promash(step,idx)
+    end
     
     return self
   end
@@ -410,14 +434,10 @@ class ProMashRec::Recipe < Brewser::Recipe
     end
     self.yeasts.push ProMashRec::Yeast.new.from_promash(rec.yeast)
     self.water_profile = ProMashRec::WaterProfile.new.from_promash(rec.water_profile)
-    if rec.simple_schedule.num_steps > 0
-      self.mash_schedule = ProMashRec::SimpleSchedule.new.from_promash(rec.simple_schedule)
-    else
-      self.mash_schedule = ProMashRec::MashSchedule.new.from_promash(rec.mash_schedule)
-    end
+    self.mash_schedule = ProMashRec::SimpleSchedule.new.from_promash(rec.simple_schedule)
     self.description = rec.notes
     self.type = self.style.type
-    #puts rec.snapshot
+
     return self
   end
 

data/lib/brewser/model/additive.rb

@@ -10,5 +10,31 @@ module Brewser
     property :amount, WeightOrVolume, :required => true
 
     property :use_for, String
+    
+    def self.json_create(o)
+      a = self.new
+      a.name = o['name']
+      a.description = o['description']
+      a.type = o['type']
+      a.added_when = o['added_when']
+      a.time = o['time'].u unless o['time'].blank?
+      a.amount = o['amount'].u unless o['amount'].blank?
+      a.use_for = o['use_for']
+
+      return a
+    end
+    
+    def as_json(options={})
+      {
+        JSON.create_id => "Brewser::Additive",
+        'name' => name, 
+        'description' => description, 
+        'type' => type, 
+        'added_when' => added_when, 
+        'time' => time.to_s, 'amount' => amount.to_s, 
+        'use_for' => use_for
+      }
+    end
+    
   end
 end

data/lib/brewser/model/base.rb

@@ -1,8 +1,11 @@
 module Brewser
-    
+      
   class Model
     require 'dm-core'
     require 'dm-validations'
+    require 'dm-serializer'
+
+    require "msgpack"
     require 'active_support/inflector'
     
     include DataMapper::Resource
@@ -14,21 +17,6 @@ module Brewser
     def self.auto_migrate_down!(rep);end
     def self.auto_migrate_up!(rep);end
     def self.auto_upgrade!(rep);end
-        
-    def deep_json
-      h = {}
-      instance_variables.each do |e|
-        key = e[1..-1]
-        next if ["roxml_references", "_persistence_state", "_key"].include? key
-        o = instance_variable_get e.to_sym
-        h[key] = (o.respond_to? :deep_json) ? o.deep_json : o;
-      end
-      h
-    end
-    
-    def to_json *a
-      deep_json.to_json *a
-    end
     
     def as_brewson
       BrewSON.serialize(self)

data/lib/brewser/model/fermentable.rb

@@ -10,7 +10,6 @@ module Brewser
     property :type, String, :set => ['Grain', 'Sugar', 'Extract', 'Dry Extract', 'Adjunct'], :required => true
     property :yield_percent, Float
     property :potential, Float, :required => true
-    property :ppg, Integer
     
     property :color, Float, :required => true
 
@@ -24,5 +23,47 @@ module Brewser
     property :max_in_batch, Float
     property :recommend_mash?, Boolean
     property :ibu_gal_per_lb, Float
+    
+    def ppg
+      return 0 if potential.blank?
+      (potential-1)*1000
+    end
+    
+    def self.json_create(o)
+      a = self.new
+      a.name = o['name']
+      a.origin = o['origin']
+      a.supplier = o['supplier']
+      a.description = o['description']      
+      a.type = o['type']
+      a.potential = o['potential']
+      a.color = o['color']
+      a.amount = o['amount'].u unless o['amount'].blank?
+      a.late_addition = o['added_late']
+      a.coarse_fine_diff = o['coarse_fine_diff']
+      a.moisture = o['moisture']
+      a.diastatic_power = o['diastatic_power']
+      a.protein = o['protein']
+      a.max_in_batch = o['max_in_batch']
+      a.origin = o['origin']
+      a.recommend_mash = o['recommend_mash']
+      a.ibu_gal_per_lb = o['ibu_gal_per_lb']
+
+      return a
+    end
+    
+    def as_json(options={})
+      {
+        JSON.create_id => "Brewser::Fermentable",
+        'name' => name, 'origin' => origin, 
+        'supplier' => supplier, 'description' => description,
+        'type' => type, 'ppg' => ppg, 'potential' => potential, 
+        'color' => color, 'amount' => amount.to_s, 'added_late' => late_addition?, 
+        'coarse_fine_diff' => coarse_fine_diff, 'moisture' => moisture, 
+        'diastatic_power' => diastatic_power, 'protein' => protein, 'max_in_batch' => max_in_batch, 
+        'recommend_mash' => recommend_mash?, 'ibu_gal_per_lb' => ibu_gal_per_lb
+      }
+    end
+      
   end
 end

data/lib/brewser/model/fermentation_schedule.rb

@@ -3,5 +3,22 @@ module Brewser
     belongs_to :recipe
     
     has n, :fermentation_steps
+    
+    def self.json_create(o)
+      a = self.new
+      o['fermentation_steps'].each do |step|
+        a.fermentation_steps.push step
+      end unless o['fermentation_steps'].nil?
+
+      return a
+    end
+    
+    def as_json(options={})
+      {
+        JSON.create_id => "Brewser::FermentationSchedule",
+        'fermentation_steps' => fermentation_steps.to_a
+      }
+    end
+    
   end
 end

data/lib/brewser/model/fermentation_steps.rb

@@ -8,5 +8,26 @@ module Brewser
     property :index, Integer
     property :time, TimeInDays
     property :temperature, Temperature
+    
+    def self.json_create(o)
+      a = self.new
+      a.name = o['name']
+      a.purpose = o['purpose']
+      a.index = o['index']
+      a.time = o['time'].u unless o['time'].blank?
+      a.temperature = o['temperature'].u unless o['temperature'].blank?
+
+      return a
+    end
+    
+    def as_json(options={})
+      {
+        JSON.create_id=> "Brewser::FermentationStep",
+        'name' => name, 'purpose' => purpose,
+        'index' => index, 
+        'time' => time.to_s, 'temperature' => temperature.to_s
+      }
+    end
+    
   end
 end

data/lib/brewser/model/hop.rb

@@ -23,5 +23,49 @@ module Brewser
     property :myrcene, Float
     property :farnsene, Float
     property :total_oil, Float
+    
+    def self.json_create(o)
+      a = self.new
+      a.name = o['name']
+      a.origin = o['origin']
+      a.description = o['description']
+      a.type = o['type']
+      a.alpha_acids = o['alpha_acids']
+      a.beta_acids = o['beta_acids']
+      a.added_when = o['added_when']
+      a.time = o['time'].u unless o['time'].blank?
+      a.amount = o['amount'].u unless o['amount'].blank?
+      a.form = o['form']
+      a.storageability = o['storageability']
+      a.substitutes = o['substitutes']
+      a.humulene = o['humulene']
+      a.caryophyllene = o['caryophyllene']
+      a.cohumulone = o['cohumulone']
+      a.myrcene = o['myrcene']
+      a.farnsene = o['farnsene']
+      a.total_oil = o['total_oil']
+      
+      return a
+    end
+    
+    def as_json(options={})
+      {
+        JSON.create_id=> "Brewser::Hop",
+        'name' => name, 
+        'origin' => origin,
+        'description' => description, 
+        'type' => type, 
+        'alpha_acids' => alpha_acids, 
+        'beta_acids' => beta_acids, 
+        'added_when' => added_when, 
+        'time' => time.to_s, 'amount' => amount.to_s, 
+        'form' => form, 'storageability' => storageability, 
+        'substitutes' => substitutes, 
+        'humulene' => humulene, 'caryophyllene' => caryophyllene,
+        'cohumulone' => cohumulone, 'myrcene' => myrcene, 
+        'farnsene' => farnsene, 'total_oil' => total_oil
+      }
+    end
+      
   end
 end