RubyGems - bread_calculator - Versions diffs - 0.3.0 → 0.4.0 - Mend

bread_calculator 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/README.md +25 -13
data/bin/bread-calc +13 -9
data/bread_calculator.gemspec +2 -2
data/lib/bread_calculator.rb +153 -51
data/spec/bread_calculator_spec.rb +14 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6959568a142ec9660ea66a80839a34762e0282ee
-  data.tar.gz: 4b89277648b629fd0920eab943eadffa56d6e01f
+  metadata.gz: 53aef8e8a052ec183a4f4121445c1daa1d15319b
+  data.tar.gz: 2c9b6a67fd14f71f0a3cddbfe2e73aa028dbbe9b
 SHA512:
-  metadata.gz: c6bb8d52aa6d48efbaf602ac3d56c85ed5ad71f30e0723cf681f77c3204671356b0e5093ca2f2865ea7d48b43acdc9b97a19dcf9463fc036c8427035340566a4
-  data.tar.gz: e541c41118bb3086b7b7789a973feb6942b90aa7c3e0cf65768f7df1701c5e124789a55c036b530792bff3a603a89f098dedcfc50506ded7f3bc1a239d357277
+  metadata.gz: 72f6258f4ed7b8884e85af325a4c1e5161a433be5e5bb460e80c7530e329aca0e778f143d4becd26059fbc64f08bb45e97001b0c227684734bac1f4427f171bc
+  data.tar.gz: ed81a8f9cff34616d3c2c4199ebaea6b97b2ae44d23441a3bc478effbac1183e4c5e0b4d51a5ce0c95c7bfc059663a3395d7c732536042b9a4c6138b83eb1d8b

data/README.md CHANGED Viewed

@@ -98,22 +98,30 @@ can by scaled up or down.</p>
 <p style="margin-left:11%; margin-top: 1em"><b>--help</b>
-print this help</p>
+Print a brief usage message.</p>
 <p style="margin-left:11%; margin-top: 1em"><b>--summary</b>
-print a baker&rsquo;s percentage summary</p>
+Print all baker&rsquo;s percentages of the recipe.
+Over-rides <b>--scale-by</b></p>
 <p style="margin-left:11%; margin-top: 1em"><b>--html</b>
-print recipe as html.</p>
+Print recipe as html. Over-rides <b>--weight</b> or
+<b>--to.</b></p>
 <p style="margin-left:11%; margin-top: 1em"><b>--weight</b>
-print the weight</p>
+Print the weight of the recipe. Over-rides <b>--html</b> or
+<b>--to.</b></p>
+<p style="margin-left:11%; margin-top: 1em"><b>--to
+WEIGHT</b> Regenerate the recipe or summary to <b>WEIGHT</b>
+total weight. Over-rides <b>--html</b> or
+<b>--weight.</b></p>
 <p style="margin-left:11%; margin-top: 1em"><b>--scale-by
-FACTOR</b> regenerate the recipe, scaling up or down by
-FACTOR</p>
+FACTOR.</b> Regenerate the recipe, scaling up or down by
+<b>FACTOR</b> Over-rides <b>--summary.</b></p>
 <h2>EXAMPLES
 <a name="EXAMPLES"></a>
@@ -121,7 +129,11 @@ FACTOR</p>
 <p style="margin-left:11%; margin-top: 1em"><b>bread-calc
---summary sample.recipe</b></p>
+--summary sample.recipe</b> summarize a recipe</p>
+<p style="margin-left:11%; margin-top: 1em"><b>bread-calc
+--scale-by .5 sample.recipe | bread-calc --html
+&gt;sample.html</b> halve a recipe and render as html</p>
 <h2>FORMATS
 <a name="FORMATS"></a>
@@ -129,7 +141,7 @@ FACTOR</p>
 <p style="margin-left:11%; margin-top: 1em">The recipe
-format consists of a metadata prelude, and steps.</p>
+format consists of a metadata prelude followed by steps.</p>
 <p style="margin-left:11%; margin-top: 1em">In prelude
 lines, anything before a colon is considered to be the name
@@ -152,14 +164,14 @@ itself.</p>
 <p style="margin-left:11%; margin-top: 1em"><b>bread-calc</b>
-will attempt to guess at the type of ingredient, but you can
-always force it by including one of the words
+makes a crude attempt to guess at the type of ingredient,
+but you can always force it by including one of the words
 &rsquo;flour&rsquo;, &rsquo;liquid&rsquo;, or
 &rsquo;additive&rsquo; in the line.</p>
 <p style="margin-left:11%; margin-top: 1em">Here is a brief
-example (note that github displays the indenting
-incorrectly):</p>
+example (note that if you are reading this on github, you
+won&rsquo;t see the indenting):</p>
 <p style="margin-left:17%; margin-top: 1em">name: imaginary
 bread <br>
@@ -195,7 +207,7 @@ cheerfully assumed that all units are grams.</p>
 <p style="margin-left:11%; margin-top: 1em">It is undefined
 how &rsquo;liquid flour additive&rsquo; is parsed, but
-don&rsquo;t expect anything good.</p>
+don&rsquo;t expect anything sensible.</p>
 <h2>LICENSE
 <a name="LICENSE"></a>

data/bin/bread-calc CHANGED Viewed

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-require 'bread_calculator'
 #require  "#{File.dirname(__FILE__)}/../lib/bread_calculator"
+require 'bread_calculator'
 def htm_header
   puts '<head>'
@@ -17,29 +17,31 @@ where OPTIONS are any of:
   --summary
   --html
   --weight
+  --recipe
   --scale-by FACTOR
 Install the man page, or go to
 https://github.com/nbirnel/bread-calculator
-for more detailed information.
+for more detailed and up-to-date information.
 EOF
   exit status
 end
-@get = 'r'
 @help = nil
+@opt = ['r']
 loop { case ARGV[0]
   when /--help/     then             @help = 'help'     ;  ARGV.shift; break
-  when /--summary/  then             @get  = 'r.summary';  ARGV.shift
-  when /--html/     then             @get  = 'r.to_html';  ARGV.shift
-  when /--weight/   then             @get  = 'r.weight';   ARGV.shift
     #.to_f protects against 'no .<digit> floating literal anymore' for .33
-  when /--scale-by/ then ARGV.shift; @get  = "r.scale_by #{ARGV.shift.to_f}"
+  when /--scale-by/ then ARGV.shift; @opt[1]  = "scale_by(#{ARGV.shift.to_f})"
+  when /--summary/  then             @opt[1]  = 'summary';  ARGV.shift
+  when /--html/     then             @opt[2]  = 'to_html';  ARGV.shift
+  when /--weight/   then             @opt[2]  = 'weight';   ARGV.shift
+  when /--to/       then ARGV.shift; @opt[2]  = "recipe(#{ARGV.shift.to_f})"
   when /--/ then ARGV.shift; break
   when /^-/ then help 1
   else break
@@ -47,8 +49,10 @@ end; }
 help if @help
+@method_chain = @opt.select{|e| e if e}.join('.')
 parser = BreadCalculator::Parser.new
 r = parser.parse ARGF.file
-htm_header if @get.include? 'html'
-puts eval("#{@get}")
+htm_header if @method_chain.include? 'to_html'
+puts eval("#{@method_chain}")

data/bread_calculator.gemspec CHANGED Viewed

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'bread_calculator'
-  s.version     = '0.3.0'
-  s.date        = '2014-03-11'
+  s.version     = '0.4.0'
+  s.date        = '2014-03-13'
   s.summary     = "calculate baker's percentages"
   s.description = "a gem and command-line wrapper to generate baker's
                    percentages from a bread recipe"

data/lib/bread_calculator.rb CHANGED Viewed

@@ -1,3 +1,18 @@
+##
+# round +number+ depending on it's magnitude
+def human_round number, base_precision = 0
+    #FIXME there is an algorithm for this. What is it?
+    precision = base_precision
+    if number < 10
+      precision = base_precision + 1
+    end
+    if number < 1
+      precision = base_precision + 2
+    end
+    f_number = sprintf "%.#{precision}f", number
+end
 ##
 # Classes for manipulating bread recipes and baker's percentages
@@ -5,6 +20,9 @@ module BreadCalculator
   require 'cgi'
+  ##
+  # Make a reasonably precise representation of +number+
   ##
   # This class represents an ingredient in a Recipe
@@ -19,7 +37,7 @@ module BreadCalculator
     # +:liquids+, or +:additives+.
     def initialize name, info={}
-      @units = 'grams'
+      #@units = 'grams'
       @name = name
       @info = info
       info.each do |k,v|
@@ -30,7 +48,7 @@ module BreadCalculator
     ##
     # Returns a new Ingredient, scaled from current instance by +ratio+
-    def scale_by ratio
+    def scale_by ratio, units=self.units
       scaled = Hash.new
       self.info.each do |k, v|
         scaled[k] = v
@@ -38,21 +56,30 @@ module BreadCalculator
       end
       Ingredient.new(self.name, scaled)
     end
+    #FIXME refactor scale_by and as_bp
+    ##
+    # Returns a new unitless Ingredient as a baker's percentage of +bp_100+
+    def as_bp bp_100
+      info = self.info.reject{|k,v| k == :units}
+      scaled = Hash.new
+      info.each do |k, v|
+        scaled[k] = v
+        scaled[k] = v / bp_100.to_f  if k == :quantity
+      end
+      Ingredient.new(self.name, scaled)
+    end
     ##
     # Print a nice text version of Ingredient
-    def to_s
+    def to_s summary=nil
+      q = summary ? "#{human_round(@quantity*100).to_s}%" : human_round(@quantity)
       #FIXME check for existance
-      precision = 0
-      if @quantity < 10
-        precision = 1
-      end
-      if @quantity < 1
-        precision = 2
-      end
-      f_quantity = sprintf "%.#{precision}f", @quantity
-      "\t#{f_quantity} #{@units} #{@name}\n"
+      "\t#{q} #{@units} #{@name}\n"
     end
     ##
@@ -87,6 +114,7 @@ module BreadCalculator
     ##
     # Sets +Step.techniques+ to +args+, and defines +Step.ingredients+
     def techniques= args
       @techniques = args
       @ingredients = args.select{|arg| arg.is_a? Ingredient}
@@ -95,10 +123,10 @@ module BreadCalculator
     ##
     # Print a nice text version of Step
-    def to_s
+    def to_s summary=nil
       out = ''
       self.techniques.each do |t|
-        tmp =  t.is_a?(Ingredient) ? t.to_s : "#{t.chomp}\n"
+        tmp =  t.is_a?(Ingredient) ? t.to_s(summary) : "#{t.chomp}\n"
         out << tmp
       end
       out << "\n"
@@ -117,10 +145,19 @@ module BreadCalculator
       out << "\n</p>\n"
       out
     end
   end
   ##
   # This class represents a recipe.
+  #
+  # Runtime-generated methods:
+  #
+  #     total_flours
+  #     total_liquids
+  #     total_additives
+  #
+  # return totals of their respective types
   class Recipe
     attr_reader :steps, :metadata
@@ -132,7 +169,7 @@ module BreadCalculator
     # Other likely keys are:
     # <tt>:prep_time, :total_time, :notes, :history, :serves, :makes,
     # :attribution</tt>.
     def initialize metadata, steps
       @metadata = metadata
       @steps    = steps
@@ -162,6 +199,7 @@ module BreadCalculator
     #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|
@@ -192,7 +230,7 @@ module BreadCalculator
     def scale_by ratio
       new_steps = self.steps.map do |s|
-        step_args =  s.techniques.map do |t|
+        step_args = s.techniques.map do |t|
           t.is_a?(Ingredient) ? t.scale_by(ratio) : t
         end
         Step.new step_args
@@ -205,16 +243,19 @@ module BreadCalculator
     # Returns a Summary
     def summary
-      types = Hash.new
+      new_meta = self.metadata
       [:flours, :liquids, :additives].each do |s|
-        types["total_#{s}"] = self.bakers_percent eval("self.total_#{s}")
+        new_meta["total_#{s}"] = eval "self.bakers_percent self.total_#{s}"
       end
-      l_ingredients = Hash.new
-      self.ingredients.map do |i|
-        l_ingredients[i.name] = self.bakers_percent i.quantity
+      new_steps = self.steps.map do |s|
+        step_args = s.techniques.map do |t|
+          t.is_a?(Ingredient) ? t.as_bp(self.bakers_percent_100) : t
+        end
+        Step.new step_args
       end
-      Summary.new types, l_ingredients
+      Summary.new new_meta, new_steps
     end
     ##
@@ -242,6 +283,67 @@ module BreadCalculator
   end
+  ##
+  # This class represents a summary of a Recipe - like a Recipe, but:
+  #
+  # Ingredients will be unitless
+  # and the quantities expressed in baker's percentages,
+  #
+  # Metadata will include baker's percentages of
+  # flours, liquids, and additives.
+  class Summary < Recipe
+    def initialize metadata, steps
+      super
+    end
+    def weight
+      nil
+    end
+    def summary
+      self
+    end
+    def to_s
+      #FIXME this should be calling super somehow
+      out = ''
+      self.metadata.each do |k,v|
+        nv =  k.to_s =~ /^total_/ ? "#{human_round(v*100).to_s}%" : v
+        out << "#{k}: #{nv}\n"
+      end
+      out << "--------------------\n"
+      self.steps.each{|s| out << s.to_s(:summary)}
+      out
+    end
+    def to_html
+      #FIXME obviously inadequate
+      super
+    end
+    def recipe weight, units='grams'
+      new_metadata = self.metadata.reject{|k,v| k.to_s =~ /^total_/}
+      totals = self.metadata.select{|k,v| k.to_s =~ /^total_/}
+      all_totals = totals.values.inject(:+).to_f
+      new_bp_100 = weight / all_totals
+      new_steps = self.steps.map do |s|
+        step_args = s.techniques.map do |t|
+          t.is_a?(Ingredient) ? t.scale_by(new_bp_100, units) : t
+        end
+        Step.new step_args
+      end
+      Recipe.new new_metadata, new_steps
+    end
+  end
   ##
   # This class converts a nearly free-form text file to a Recipe
@@ -263,7 +365,35 @@ module BreadCalculator
     ##
     # Parse text from IO object +input+. It is the caller's responsibility to
     # open and close the +input+ correctly.
+    #
+    # text recipes consist of a metadata prelude followed by steps.
+    #
+    # In prelude lines,
+    # anything before a colon is considered to be the name of a metadata field;
+    # anything after the colon is a value to populate.
+    # Lines without colons are continuations of the 'notes' field.
+    # I suggest having at least a 'name' field.
+    #
+    # A line starting with a hyphen ends the prelude and starts the first step.
+    #
+    # Each step is delimited by one or more blank lines.
+    #
+    # Any line in a step starting with a space or a blank is an ingredient,
+    # consisting of quantity, units, and the ingredient itself.
+    #
+    # A brief sample:
+    #
+    #     name: imaginary bread
+    #     notes: This is a silly fake bread recipe
+    #     makes: 1 bad loaf
+    #     This line will become part of the notes
+    #     ---------------------
+    #     Mix:
+    #       500 g flour
+    #       300 g water
+    #
+    #     Bake at 375°
     def parse input
       while line = input.gets
@@ -337,32 +467,4 @@ module BreadCalculator
   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 CHANGED Viewed

@@ -17,6 +17,7 @@ describe BreadCalculator do
     @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]
+    @summary = @recipe.summary
   end
   describe BreadCalculator::Ingredient do
@@ -49,7 +50,7 @@ describe BreadCalculator do
     end
     it 'generates a baker\'s percentage summary' do
-      @recipe.summary.is_a?(BreadCalculator::Summary).should be_true
+      @summary.is_a?(BreadCalculator::Summary).should be_true
     end
     it 'scales' do
@@ -68,6 +69,18 @@ describe BreadCalculator do
   end
+  describe BreadCalculator::Summary do
+    before do
+      @new_recipe = @summary.recipe(1000, 'g')
+    end
+    it 'generates a Recipe' do
+      @new_recipe.is_a?(BreadCalculator::Recipe).should be_true
+      @new_recipe.weight.should == 1000
+    end
+  end
   describe BreadCalculator::Parser do
     before do
       @parser = BreadCalculator::Parser.new

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bread_calculator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Noah Birnel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies: []
 description: |-
   a gem and command-line wrapper to generate baker's