progress_bar_snapshot 0.0.3

data/CHANGELOG

@@ -0,0 +1,6 @@
+# CHANGELOG
+# ---
+# Version 0.0.1 First release
+# 
+#
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,66 @@
+= ProgressbarSnapshot
+
+A simple widget that generates progress bars in png format.  There are other ways to
+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
+
+== Example usage:
+
+In a stand alone script:
+
+  require 'progress_bar_snapshot'
+
+  pb = ProgressBarSnapshot.new(200, 50, 85.0)
+  pb.to_file("85percent.png")
+
+This will generate a png file 200x50 called 85percent.png.  The progress bar would be
+85% full. 
+
+In your rails app:
+
+  In your controller:
+    require 'progress_bar_snapshot'
+    ...
+    class MySomethingController < ApplicationController
+       helper :progress_bar_snapshot
+    ...
+    # define an action to render and send the png
+    def progress_bar
+      bar = ProgressBarSnapshot.new(
+        params[:width].to_i, params[:height].to_i, 
+        params[:percentage].to_f)
+
+      send_data bar.to_blob, :type => 'image/png', :disposition => 'inline', 
+                             :filename => "progress#{params[:percentage].to_i}.png"
+    end
+    
+  In your view:
+     <%= progress_bar_png_tag('88.1', {
+       :width => 200, :height=> 20, :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",
+
+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')
+
+
+== Authors, credits, blame, contact!
+
+  xiaoke@microplace.com
+  julio@microplace.com

data/lib/progress_bar_snapshot.rb

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'RMagick'
+
+=begin rdoc
+
+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. 
+
+RMagick library required.
+
+==Authors
+
+Xiaoke Zhang
+
+==General Usage and Defaults
+
+
+==License
+
+Licensed under the MIT license.
+
+=end
+
+class ProgressBarSnapshot
+
+  VERSION = '0.0.3'
+  
+  def initialize (width, height, percentage, theme = {})
+    @width           = width
+    @height          = height
+    @percentage      = percentage
+    @default_theme   = {
+      :inner_border   => "#CCCCCC",
+      :border_color   => "#666666", 
+      :progress_color => "skyblue",
+      :background     => "white",
+      :font_family    => "arial",
+      :font_color     => "black",
+      :border_width   => 1
+    }
+    @default_theme.update(theme)
+  end
+  
+  def to_blob(format = 'png')
+    image = render
+    image.format = format
+    image.to_blob {self.depth = 8}
+  end
+  
+  def to_file(filename)
+    render.write(filename) {self.depth = 8}
+  end
+  
+  def render
+    canvas = Magick::ImageList.new
+    canvas.new_image(@width, @height)
+ 
+    progress_bar = draw_bar
+    draw_inner_progress(progress_bar) if ((1.0..100.0).include?(@percentage))
+    text = draw_percentage_text
+    
+    progress_bar.draw(canvas)
+    text.annotate(canvas, 0,0,0,0, "#{@percentage.to_i}%")
+
+    canvas
+  end
+  
+  private
+  
+  def draw_bar
+    progress_bar = Magick::Draw.new
+
+    progress_bar.stroke(@default_theme[:border_color])
+    progress_bar.fill(@default_theme[:background])
+    # progress_bar.stroke_opacity(1)
+
+    brush_size = @default_theme[:border_width]
+    progress_bar.stroke_width(brush_size)
+    # outer border
+    progress_bar.rectangle(0, 0, @width - brush_size, @height - brush_size)
+
+    progress_bar
+  end
+
+  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)
+  end
+
+  def draw_percentage_text
+    text = Magick::Draw.new
+    text.font_family = @default_theme[:font_family]
+    text.pointsize = (@height * 0.7).to_i
+    text.gravity = Magick::CenterGravity
+    text.fill = @default_theme[:font_color]
+    text
+  end
+end

data/lib/progress_bar_snapshot_helper.rb

@@ -0,0 +1,22 @@
+# Provides a tag for embedding progress bar snapshots in your views
+
+# need a controler action to actually do the image generation and sending of the 
+# image blob.  See README for examples. 
+
+module ProgressBarSnapshotHelper
+
+  def progress_bar_png_tag(percent, opts = {})
+    url = { 
+      :percentage => percent 
+    }
+
+    options = url.merge(opts)
+
+    # extra html attributes for the image tag
+    attributes = %(class="#{options[:class] || 'progressbar'}" alt="#{percent.round}%" )
+    attributes << %(title="#{options[:title]}" ) if options[:title]
+
+    %(<img src="#{ url_for options }" #{attributes}/>)
+  end
+
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+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
+summary: Generates png images of progress bars
+require_paths: 
+- lib
+email: xiaoke@microplace.com
+homepage: 
+rubyforge_project: 
+description: Generats png images of progress bars, useful for web pages or use in pdf files.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Xiaoke Zhang
+files: 
+- README
+- CHANGELOG
+- MIT-LICENSE
+- lib/progress_bar_snapshot.rb
+- lib/progress_bar_snapshot_helper.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+