progress_bar_snapshot 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,6 +1,12 @@
 # CHANGELOG
 # ---
-# Version 0.0.1 First release
-# 
 #
+# Version 0.0.4 
+# * added capability to add multiple segments of "progress" into one progress bar.  
+#   For example it can show combined progress from 2 or more different sources. 
+# * error handling like filtering input for negative numbers
+#
+# Version 0.0.3 First release
+# 
+
 

data/README

@@ -4,19 +4,19 @@ A simple widget that generates progress bars in png format.  There are other way
 generate a progress bar with css, html and javascript.  However, if you have to 
 stick a progress bar in a pdf you probably need to stick it in as an image. 
 
-Requires the Rmagick library
+Rmagick gem required.
 
 == Example usage:
 
 In a stand alone script:
-
+  require 'rubygems'
   require 'progress_bar_snapshot'
 
-  pb = ProgressBarSnapshot.new(200, 50, 85.0)
-  pb.to_file("85percent.png")
+  pb = ProgressBarSnapshot.new(200, 50, [15.0, 25, 4.1, 2.9])
+  pb.to_file("47percent.png")
 
-This will generate a png file 200x50 called 85percent.png.  The progress bar would be
-85% full. 
+This will generate a png file 200x50 called 47percent.png.  Since the sum of
+15.0, 25, 4.1, 2.9 is 47 the progress bar would be 47% full. 
 
 In your rails app:
 
@@ -28,37 +28,52 @@ In your rails app:
     ...
     # define an action to render and send the png
     def progress_bar
+    
+      percentages = params[:percentages].split(",").collect { |p| p.to_f }
+     
       bar = ProgressBarSnapshot.new(
         params[:width].to_i, params[:height].to_i, 
-        params[:percentage].to_f)
-
+        percentages)
+    
       send_data bar.to_blob, :type => 'image/png', :disposition => 'inline', 
-                             :filename => "progress#{params[:percentage].to_i}.png"
+                             :filename => "progress.png"
     end
     
   In your view:
-     <%= progress_bar_png_tag('88.1', {
-       :width => 200, :height=> 20, :controller => 'my_something', :action => 'progress_bar'}) %>
+  <%= progress_bar_png_tag(
+        [12.4, 24,1, 25.6], 
+        ['#0398B3', '#E9C74B' ],
+        { :width      => 178,
+          :height     => 18,
+          :controller => 'my_something',
+          :action     => 'progress_bar' }
+  ) %>
 
 
 Customizable colors:
 
 These following parameters can be passed in to the progress bar snapshot constructor
 
-  :inner_border   # inner border of the progress bar default to "#CCCCCC",
-  :border_color   # outer border color defaults to "#666666", 
-  :progress_color # progress bar color defaults to "#B3D235",
-  :background     # color of unfilled portion of the progress bar, defaults to "white",
-  :font_family    # default font to "arial",
-  :font_color     # default color of the font "black",
+  :border_color    # outer border color, defaults to "#666666", 
+  :progress_colors # progress bar colors, defaults to alternating between 'skyblue', 'grey' ,'salmon',
+  :background      # color of unfilled portion of the progress bar, defaults to "white",
+  :font_family     # default font to "arial",
+  :font_color      # default color of the font "black",
 
 All the colors are passed straight to Rmagick, so they can be any color Rmagick supports.
 
 For example: 
 
-pb = ProgressBarSnapshot.new(200, 50, 35.1, :border_color => 'black', 
-   :progress_color => 'green', :font_color => 'white', :background => 'grey')
+pb = ProgressBarSnapshot.new(200, 50, [35.0, 25, 14.1, 12.9],
+      :progress_colors => ['blue', 'SteelBlue', 'skyblue', 'grey'],
+      :background => 'grey90')
+
+
+Multiple Segments:
 
+This release of progress bar can be instructed to generate "sausage links" segments of progress bars.
+You can pass it any number of percentages and their corresponding colors.  Each of these percentages
+would be drawn and their sum would be displayed on the progress bar. 
 
 == Authors, credits, blame, contact!
 

data/lib/progress_bar_snapshot.rb

@@ -5,9 +5,7 @@ require 'RMagick'
 
 A library for rendering the image of a progress bar.  
 
-Used to generate an progress bar images to a file or in RAILS apps.  There are easier ways to do progrss bars
-with css and html, but if you have to put the progress bar in a pdf or an email you might need to just
-render a picture instead. 
+Used to generate an progress bar images to a file or in RAILS apps.
 
 RMagick library required.
 
@@ -17,7 +15,6 @@ Xiaoke Zhang
 
 ==General Usage and Defaults
 
-
 ==License
 
 Licensed under the MIT license.
@@ -26,22 +23,23 @@ Licensed under the MIT license.
 
 class ProgressBarSnapshot
 
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
   
-  def initialize (width, height, percentage, theme = {})
-    @width           = width
-    @height          = height
-    @percentage      = percentage
+  def initialize (width, height, percentages, theme = {})
+    @width                     = [width, 0].max
+    @height                    = [height, 0].max
+    @percentages_segments      = percentages.select{|p| p >= 0}
+
+    # default theme if none was passed in
     @default_theme   = {
-      :inner_border   => "#CCCCCC",
       :border_color   => "#666666", 
-      :progress_color => "skyblue",
+      :progress_colors => ["skyblue", 'grey' ,'salmon'],
       :background     => "white",
       :font_family    => "arial",
       :font_color     => "black",
       :border_width   => 1
     }
-    @default_theme.update(theme)
+    @default_theme.update(theme)    
   end
   
   def to_blob(format = 'png')
@@ -55,15 +53,24 @@ class ProgressBarSnapshot
   end
   
   def render
+    # new image
     canvas = Magick::ImageList.new
     canvas.new_image(@width, @height)
  
+    # make a new draw object
     progress_bar = draw_bar
-    draw_inner_progress(progress_bar) if ((1.0..100.0).include?(@percentage))
+    # make a new text object
     text = draw_percentage_text
-    
+
+    # progress bar
+    total_percentage = [@percentages_segments.inject{|sum, n| sum + n}, 100].min
+    draw_inner_progress(progress_bar) if ((1.0..100.0).include?(total_percentage))
+
+    # draw the progress bar on canvas
     progress_bar.draw(canvas)
-    text.annotate(canvas, 0,0,0,0, "#{@percentage.to_i}%")
+    
+    # draw the percentage number on the progress bar
+    text.annotate(canvas, 0,0,0,0, "#{total_percentage.to_i}%")
 
     canvas
   end
@@ -87,15 +94,31 @@ class ProgressBarSnapshot
 
   def draw_inner_progress(progress_bar)
     brush_size = @default_theme[:border_width]
-
-    inner_x = [((@width - 2*brush_size) * @percentage /100.0).to_i, brush_size].max
-    inner_y = @height - 2*brush_size
-    progress_bar.stroke(@default_theme[:inner_border])
-    progress_bar.fill(@default_theme[:progress_color])
-
-    brush_size = @default_theme[:border_width]
-    progress_bar.stroke_width(brush_size)
-    progress_bar.rectangle(brush_size, brush_size, inner_x , inner_y)
+    bottom_y = @height - 2 * brush_size
+    top_y = brush_size
+    max_inner_width = @width - 2 * brush_size
+    
+    last_x = brush_size
+    @percentages_segments.each_with_index do |segment, index|
+      # no point drawing if it's increases 0 pixels
+      next if (segment == 0)
+      next if (last_x >= max_inner_width )
+      
+      x_increment = [((@width - 2 * brush_size) * segment /100.0).to_i, brush_size].max
+      
+      # no bleeding over the edge for inner progress bar
+      next_x = [last_x + x_increment, max_inner_width].min
+      
+      # sets up for drawing the box
+      color = get_color(index)
+      progress_bar.fill(color)
+      progress_bar.stroke(color)
+      progress_bar.stroke_width(brush_size)
+
+      # add the rectangle to the draw object
+      progress_bar.rectangle(last_x, top_y, next_x, bottom_y)
+      last_x = next_x
+    end
   end
 
   def draw_percentage_text
@@ -106,4 +129,10 @@ class ProgressBarSnapshot
     text.fill = @default_theme[:font_color]
     text
   end
+  
+  def get_color(index)
+    # alternate between the progress colors in case # of percentages 
+    # segements is greater than the number of colors given
+    @default_theme[:progress_colors][index % @default_theme[:progress_colors].size]
+  end
 end

data/lib/progress_bar_snapshot_helper.rb

@@ -5,15 +5,16 @@
 
 module ProgressBarSnapshotHelper
 
-  def progress_bar_png_tag(percent, opts = {})
+  def progress_bar_png_tag(percent, colors, opts = {})
     url = { 
-      :percentage => percent 
+      :percentages => percent.join(","),
+      :colors => colors.join(","),
     }
 
     options = url.merge(opts)
 
     # extra html attributes for the image tag
-    attributes = %(class="#{options[:class] || 'progressbar'}" alt="#{percent.round}%" )
+    attributes = %(class="#{options[:class] || 'progressbar'}" alt="#{percent.sum.round}%" )
     attributes << %(title="#{options[:title]}" ) if options[:title]
 
     %(<img src="#{ url_for options }" #{attributes}/>)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: progress_bar_snapshot
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2008-03-27 00:00:00 -07:00
+  version: 0.0.4
+date: 2008-05-09 00:00:00 -07:00
 summary: Generates png images of progress bars
 require_paths: 
 - lib