bread_calculator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a454bc456276e0bac262c1f2bca15af7fb9c2687
+  data.tar.gz: 2c7578cc8609953f1391bede4fa2b9ca864013c2
+SHA512:
+  metadata.gz: acce0ad69d786710cb19cccb1f152615e1ba2605ee354d9a825678b4bdbf12a85e2ff967edc9b10529887b34bc2fc800d3212c329716c109014d351e16df7f2e
+  data.tar.gz: 20fcd4a6426ae2091cfae4b77aa545247258b0669faf8710542500475ee954d67cef348e7af29c7504c7640a5973f37962f5699802da96b84c35621a330f1700

data/README.md

@@ -0,0 +1,22 @@
+bread-calculator
+---------
+
+A ruby gem to calculate baker's percentages
+
+Installation
+---------
+
+
+Inspiration and History
+---------
+
+License
+---------
+© 2014 Noah Birnel
+BSD license
+
+
+
+
+
+

data/bin/bread-calculator

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'bread_calculator'
+
+@format = 'r'
+
+loop { case ARGV[0]
+  when /-summary/  then             @format = 'r.summary'; ARGV.shift; break
+  when /-weight/   then             @format = 'r.weight';  ARGV.shift; break
+  when /-scale-by/ then ARGV.shift; @format = "r.scale_by #{ARGV.shift}"; break
+  when /--/ then ARGV.shift; break
+  when /^-/ then usage("Unknown option: #{ARGV[0].inspect}")
+  else break
+end; }
+
+ARGV.each do |arg|
+  parser = BreadCalculator::Parser.new arg
+  r = parser.parse(arg)
+  puts eval("#{@format}")
+end

data/bread_calculator.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'bread_calculator'
+  s.version     = '0.0.0'
+  s.date        = '2014-02-28'
+  s.summary     = "calculate baker's percentages"
+  s.description = "a gem and command-line wrapper to generate baker's
+                   percentages from a bread recipe"
+  s.authors     = ['Noah Birnel']
+  s.email       = 'nbirnel@gmail.com'
+  s.homepage    = 'http://github.com/nbirnel/bread-calculator'
+  s.files       = ['README.md', 'bread_calculator.gemspec', 'lib/bread_calculator.rb', 'spec/bread_calculator_spec.rb', 'bin/bread-calculator']
+  s.has_rdoc    = true
+  s.executables = ['bread-calculator']
+  s.license     = 'DWTFYW'
+end

data/lib/bread_calculator.rb

@@ -0,0 +1,316 @@
+##
+# Classes for manipulating bread recipes and baker's percentages
+
+module BreadCalculator
+
+  ##
+  # This class represents an ingredient in a Recipe
+
+  class Ingredient
+    attr_accessor :info, :name, :quantity, :units, :type
+
+    ##
+    # Creates a new ingredient +name+, with the optional qualities +info+.
+    #
+    # +info+ should usually contain <tt>:quantity, :units, :type</tt>.
+    # +:type+, in the context of bakers' percentage, would be +:flours+, 
+    # +:liquids+, or +:additives+.
+    
+    def initialize name, info={}
+      @units = 'grams'
+      @name = name
+      @info = info
+      info.each do |k,v| 
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    ##
+    # Returns a new Ingredient, scaled from current instance by +ratio+
+    
+    def scale_by ratio
+      scaled = Hash.new
+      self.info.each do |k, v|
+        scaled[k] = v
+        scaled[k] = v*ratio  if k == :quantity
+      end
+      Ingredient.new(self.name, scaled)
+    end
+    
+    ##
+    # Print a nice text version of Ingredient
+    
+    def to_s
+      #FIXME check for existance
+      "\t#{@quantity} #{@units} #{@name}\n"
+    end
+  end
+
+  ## 
+  # This class represents a discrete step in a Recipe.
+
+  class Step
+    attr_reader :techniques, :ingredients
+
+    ##
+    # Creates a new step with the the optional array +techniques+,
+    # which consists of  ministep strings, and +Ingredients+.
+    #
+    # This is intended to read something like:
+    # <tt>"Mix:", @flour, @water, "thoroughly."</tt>
+    #
+    # or:
+    #
+    # <tt>"Serve forth."</tt>
+    
+    def initialize *args
+      self.techniques = args.flatten
+    end
+
+    ##
+    # Sets +Step.techniques+ to +args+, and defines +Step.ingredients+
+    def techniques= args
+      @techniques = args
+      @ingredients = args.select{|arg| arg.is_a? Ingredient}
+    end
+    
+    ##
+    # Print a nice text version of Step
+    
+    def to_s
+      out = ''
+      self.techniques.each do |t| 
+        tmp =  t.is_a?(Ingredient) ? t.to_s : "#{t.chomp}\n"
+        out << tmp
+      end
+      out << "\n"
+      out
+    end
+  end
+
+  ##
+  # This class represents a recipe.
+
+  class Recipe
+    attr_reader :steps, :metadata
+    
+    ##
+    # Creates a new Recipe with hash +metadata+ and array of Steps +steps+
+    #
+    # +metadata+ is freeform, but most likely should include +:name+.
+    # Other likely keys are: 
+    # <tt>:prep_time, :total_time, :notes, :history, :serves, :makes,
+    # :attribution</tt>.
+    
+    def initialize metadata, steps
+      @metadata = metadata
+      @steps    = steps
+      @ingredients = self.ingredients
+    end
+
+    ##
+    # Returns an array of all Ingredients in Recipe
+    
+    def ingredients
+      a = Array.new
+      self.steps.each do |step|
+        step.ingredients.each do |ing|
+          a << ing
+        end
+      end
+      a
+    end
+
+    ##
+    # Returns the total weight of Ingredients in Recipe
+    
+    def weight
+      self.ingredients.map{|i| i.quantity}.reduce(:+)
+    end
+
+    #FIXME make this a method_missing so we can add new types on the fly
+    #RENÉE - 'end.' is weird or no?
+    #FIXME how do I get this into rdoc?
+    [:flours, :liquids, :additives].each do |s|
+      define_method("total_#{s}") do
+        instance_variable_get("@ingredients").select{|i| i.type == s}.map do |i|
+          i.quantity
+        end.reduce(:+)
+      end
+    end
+
+    alias_method 'bakers_percent_100', 'total_flours'
+
+    ##
+    # Returns the baker's percentage of a weight
+    
+    def bakers_percent weight
+      weight / bakers_percent_100.to_f
+    end
+
+    ##
+    # Returns a Formula
+    
+    def bakers_percent_formula
+      ratio = 100.0 / self.total_flours
+      self.scale_by ratio
+    end
+    
+    ## 
+    # Returns new Recipe scaled by +ratio+
+
+    def scale_by ratio
+      new_steps = self.steps.map do |s| 
+        step_args =  s.techniques.map do |t| 
+          t.is_a?(Ingredient) ? t.scale_by(ratio) : t
+        end
+        Step.new step_args
+      end
+
+      Recipe.new self.metadata, new_steps
+    end
+
+    ##
+    # Returns a Summary
+    
+    def summary
+      types = Hash.new
+      [:flours, :liquids, :additives].each do |s|
+        types["total_#{s}"] = self.bakers_percent eval("self.total_#{s}")
+      end
+      
+      l_ingredients = Hash.new
+      self.ingredients.map do |i|
+        l_ingredients[i.name] = self.bakers_percent i.quantity
+      end
+      Summary.new types, l_ingredients
+    end
+
+    ##
+    # Print a nice text version of Recipe
+    
+    def to_s
+      out = ''
+      self.metadata.each{|k,v| out << "#{k}: #{v}\n"}
+      out << "--------------------\n"
+      self.steps.each{|s| out << s.to_s }
+      out
+    end
+
+  end
+
+  ##
+  # This class converts a nearly free-form text file to a Recipe
+  
+  class Parser
+
+    ##
+    # Create a new parser for Recipe +name+.
+    
+    def initialize name
+      @name = name
+
+      @i = 0
+      @args = @steps = []
+      @steps[0] = BreadCalculator::Step.new
+
+      @in_prelude = true
+      @prelude = ''
+    end
+
+    ##
+    # Parse our text
+    
+    def parse input
+
+      IO.foreach(input) do |line|
+        new_step         && next if line =~ /(^-)|(^\s*$)/
+        @prelude << line && next if @in_prelude
+
+        @args << preprocess(line.chomp)
+      end   
+
+      close_step
+      # because we made a spurious one to begin with
+      @steps.shift
+      metadata = {
+        :name  => @name,
+        :notes => @prelude,
+      }
+
+      Recipe.new metadata, @steps
+    end
+
+    private
+
+    def new_step
+      @in_prelude = false
+      close_step
+
+      @args = []
+      @i += 1
+      @steps[@i] = BreadCalculator::Step.new
+    end
+
+    def close_step
+      @steps[@i].techniques = @args
+    end
+
+    def preprocess line
+      ing_regex = /^\s+((?<qty>[0-9.]+\s*)(?<units>g)?\s+)?(?<item>.*)/
+      h = Hash.new
+      if ing_regex =~ line 
+        match = Regexp.last_match
+        h[:quantity] = match[:qty].strip.to_f
+        h[:units]    = match[:units]
+        ingredient   = match[:item].strip
+
+        #FIXME refactor
+        h[:type] = :additives #if it doesn't match anything else
+        h[:type] = :flours    if ingredient =~ /flour/
+        h[:type] = :flours    if ingredient =~ /meal/
+        h[:type] = :liquids   if ingredient =~ /liquid/
+        h[:type] = :liquids   if ingredient =~ /water/
+        h[:type] = :liquids   if ingredient =~ /egg/
+        h[:type] = :liquids   if ingredient =~ /mashed/
+        h[:type] = :liquids   if ingredient =~ /milk/
+        h[:type] = :additives if ingredient =~ /dry/
+        h[:type] = :additives if ingredient =~ /powdered/
+
+        ing = BreadCalculator::Ingredient.new ingredient, h
+      else
+        line.strip
+      end
+    end
+
+  end
+
+  ##
+  # This class represents a summary of a Recipe - no Steps or units, just
+  # baker's percentages of each ingredient, and a prelude of baker's 
+  # percentages for flours, liquids, and additives.
+
+  class Summary
+    attr_accessor :types, :ingredients
+
+    ##
+    # Create a new Summary of +types+ and +ingredients+
+
+    def initialize types, ingredients
+      @types = types
+      @ingredients = ingredients
+    end
+
+    ##
+    # Print it nicely
+    
+    def to_s
+      out = ''
+      self.types.each{|k,v| out << "#{k}: #{v}\n"}
+      out << "--------------------\n"
+      self.ingredients.each{|k,v| out << "#{k}: #{v}\n"}
+      out
+    end
+  end
+
+end

data/spec/bread_calculator_spec.rb

@@ -0,0 +1,84 @@
+require  "#{File.dirname(__FILE__)}/../lib/bread_calculator"
+
+describe BreadCalculator do
+  before do
+    @ww      = BreadCalculator::Ingredient.new "whole wheat flour", :quantity => 300, :units => 'grams', :type=>:flours
+    @ap      = BreadCalculator::Ingredient.new "all purpose flour", :quantity => 700, :units => 'grams', :type=>:flours
+    @water   = BreadCalculator::Ingredient.new "water", :quantity => 550, :units => 'grams', :type=>:liquids
+    @egg     = BreadCalculator::Ingredient.new "egg", :quantity => 40, :units => 'grams', :type=>:liquids
+    @milk    = BreadCalculator::Ingredient.new "dry milk", :quantity => 40, :units => 'grams', :type=>:additives
+    @raisins = BreadCalculator::Ingredient.new "raisins", :quantity => 50, :units => 'grams', :type=>:additives
+    @yeast   = BreadCalculator::Ingredient.new "yeast", :quantity => 20, :units => 'grams', :type=>:additives
+    @proof   = BreadCalculator::Step.new 'Rehydrate', @yeast
+    @wet     = BreadCalculator::Step.new 'in', @water, @egg
+    @dry     = BreadCalculator::Step.new 'Mix together:', @ww, @ap, @milk, 'in  a large bowl'
+    @mix     = BreadCalculator::Step.new 'Combine wet and dry ingredients with', @raisins
+    @bake    = BreadCalculator::Step.new 'Form a loaf, rise for 2 hours, Bake at 375° for 45 minutes.'
+    @meta    = {:notes => 'nice sandwich bread'}
+    @recipe  = BreadCalculator::Recipe.new @meta, [@proof, @wet, @dry, @mix, @bake]
+  end
+
+  describe BreadCalculator::Ingredient do
+    it 'has a quantity' do
+      @ww.quantity = 100
+    end
+  end
+
+  describe BreadCalculator::Step do
+    it 'can be called without arguments' do
+      BreadCalculator::Step.new
+    end
+  end
+
+  describe BreadCalculator::Recipe do
+    it 'lists all ingredients and quantities' do
+      @recipe.ingredients.length.should eq 7
+    end
+
+    it 'displays total weight' do
+      @recipe.weight.should eq 1700
+    end
+
+    it 'displays total liquids' do
+      @recipe.total_liquids.should eq 590
+    end
+
+    it 'pretty prints' do
+      pending
+      @recipe.to_s.is_a?(String).should be_true
+    end
+
+    it 'generates a baker\'s percentage summary' do
+      @recipe.summary.is_a?(BreadCalculator::Summary).should be_true
+    end
+
+    it 'scales' do
+      @scaled = @recipe.scale_by(2)
+      ( @scaled.weight == @recipe.weight * 2.0 ).should be_true
+    end
+
+    it 'generates a baker\'s percentage formula' do
+      @recipe.bakers_percent_formula.is_a?(BreadCalculator::Recipe).should be_true
+      @recipe.bakers_percent_formula.total_flours.should eq 100.0
+    end
+
+  end
+
+  describe BreadCalculator::Parser do
+    before do
+      @sample = "#{File.dirname(__FILE__)}/../sample/sandwich-bread.recipe"
+      @parser = BreadCalculator::Parser.new 'Sandwich Bread'
+      @r = @parser.parse "#{@sample}"
+    end
+
+    it 'gets a recipe from a text file' do
+      @r.is_a?(BreadCalculator::Recipe).should be_true
+    end
+
+    it 'gets a recipe from a standard in' do
+      pending
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: bread_calculator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Noah Birnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-28 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  a gem and command-line wrapper to generate baker's
+                     percentages from a bread recipe
+email: nbirnel@gmail.com
+executables:
+- bread-calculator
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bread_calculator.gemspec
+- lib/bread_calculator.rb
+- spec/bread_calculator_spec.rb
+- bin/bread-calculator
+homepage: http://github.com/nbirnel/bread-calculator
+licenses:
+- DWTFYW
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: calculate baker's percentages
+test_files: []