acts_as_status_bar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: e014a866d94cae0d40e0213e112f422d9a8f92704d3d86058aff626af8a4a47cc423d454e9ebe9fd0a2757947b73f19551210ede0e5b40d3fe253cda43d4cdb7
+  metadata.gz: 0cc5d160cd7c16ba3a8eb27d10a42dd7016e09f935a3fd1af1bb5901c83a0c64f72f0b7d7bac10b3fd87748eab2743a7936cd3f254aad0c525f483f60edb7952
+SHA1: 
+  data.tar.gz: b75fea836e04252a07fc4452c03d305a98f60770
+  metadata.gz: e7d40def19450dca0731002d4740182cf735c71a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+1.0.0 (October 24, 2013 )
+- Deploy working copy
+
+0.0.1 (2013-02-07)
+- Starting project

data/Gemfile

@@ -0,0 +1,20 @@
+#You can add lacal gems with
+# gem "my_gem", :path => "/home/www/gems/my_gem"
+#you must remove the path in production or if you change server and replace with:
+# git "git@10.2.252.240:my_gem.git"
+
+source "http://rubygems.org"
+
+gem  'rails', '~>3.0.15'
+gem 'mysql2', '< 0.3'
+
+group :development, :test do
+  gem "ruby-debug"
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+  gem "single_test"
+  gem "rspec-rails", "~> 2.0"
+end
+
+gemspec
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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 PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL 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.rdoc

@@ -0,0 +1,141 @@
+=ActsAsStatusBar
+ActsAsStatusBar adds status bar functionality to your ActiveRecord Models.
+I tried to keep it very simple, but powerful enough to be very useful.
+
+You will need Prototype to run your gem.
+
+==Setup
+Add this line to your application's Gemfile:
+ gem 'acts_as_status_bar'
+
+then execute:
+ $ bundle install
+
+or install it yourself as:
+ $ sudo gem install acts_as_status_bar
+
+install addon:
+ $ rails g acts_as_status_bar:install
+
+==Usage
+Let's imagine you have a Home model, with a controller and a view...
+
+In your model: 
+ #app/models/home.rb
+ class Home < ActiveRecord::Base
+ 	acts_as_status_bar
+  
+	def my_very_long_task_needing_a_status_bar
+		status_bar_init
+		status_bar.max=10000
+		status_bar.message="My very long task..."
+			10000.times do
+				status_bar.inc
+			end
+		end
+	end
+
+In your controller:
+ #app/controllers/homes_controller.erb
+ def create
+	@home = Home.new(params[:home])
+	status_bar_init(@home) do
+		@home.save!
+  end
+ end
+
+In your view:
+ #app/views/home/index.html.erb 
+ <%= status_bar_for(@home) %>
+
+ <%= form_for(@home) do |f| %>
+	...
+	<%= f.hidden_field :status_bar_id %>
+	<%= f.submit :onclick => 'status_bar_init()' %>
+ <% end %>
+ 
+Please note that the status_bar_for helper MUST be before the form_for with the hidden field.
+(The helper creates the bar id, but form_for copies the object so it is not possibile to update by reference...)
+
+Or, if you don't have an object,
+
+<%= status_bar_tag %>
+<%=link_tag "MyLink", my_url, :onclick => 'status_bar_init()' %>
+
+==Functions
+StatusBar uses an external store (PStore) to archive progress data, so all you need to use it
+is the id of the status bar you are using.
+
+This id is stored in your model status_bar_id attribute.
+
+You need to pass it back to your controller's "create" actions using an hidden field.
+
+When you call status_bar_init from your model the status_bar_id is valorized, so your status_bar
+is created, with the same id of your js.
+
+Only one id is passed and the magic is done!
+
+There are some functions you can use in your model to customize the behavior of the bar.
+===Basic
+* status_bar_init
+	 Initializes the bar using the id in status_bar_id, or creates a new one if not defined.
+* status_bar.inc(value=1)
+	 Increments counter by 1 or by value.
+*	status_bar.dec(value=1)
+	 Decrements counter by 1 or by value.
+* status_bar.max=(value)
+	 Sets the max value, that, once reached, stops the bar.
+* status_bar.message=(value)
+	 Set the message in the first line of the bar: you can use it to display dynamic messages
+	 during the process.
+* status_bar.delete
+   Deletes the current status bar.
+   Do not forget it or you will be submerged of useless inactive status bars...
+	
+===Advanced
+* status_bar.progress=(value)
+   Default value is : %q<["#{current}/#{max} (#{percent}%) tempo stimato #{finish_in}", "#{percent}", "#{message}"]>
+   The string is evaluated and passed to the js as xml.
+ You can customize the first and the last fields, while the second (percentage) is used for the visual bar and to
+ stop the bar when 100 is reached.
+ You can see the code to get the usable fields.
+* status_bar.add_field(:field)
+   Adds a new field to the status bar, you can use to store data or to customize the output.
+   New methods are created dinamically to access your new field:
+ * inc_field
+ * dec_field
+ * field=(value)
+ * field
+* ActsAsStatusBar::StatusBar.delete_all
+   Deletes all bars stored.
+* ActsAsStatusBar::StatusBar.all
+	 Return all active status bars.
+* ActsAsStatusBar::StatusBar.valid?(id)
+	 Checks if the id passed corresponds to a valid status bar.
+==Administration
+Some times you will need to maintain the status bar storage.
+
+You can link to acts_as_status_bar_status_bar_index_path .
+
+The controller lets you check and delete stored status bars.
+
+You can access the bar info pointing to acts_as_status_bar_status_bar_path(id) or,
+if you need a more structured info, to acts_as_status_bar_status_bar(id, :format => :xml)
+
+==Styling
+You can change the bar style in the acts_as_status_bar.css .
+
+==Whislist
+* finding time to create tests...
+
+==Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Added some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+==Thanks
+
+*	Michele Ferretti, who created the original AjaxProgressBar (http://www.blackbirdblog.it/blog/archivio/2006/03/09/ajax-progress-bar/)

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'acts_as_status_bar'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/app/controllers/acts_as_status_bar/status_bar_controller.rb

@@ -0,0 +1,29 @@
+module ActsAsStatusBar
+  class StatusBarController < ::ApplicationController
+    def index
+      @status_bars=ActsAsStatusBar::StatusBar.all
+    end
+    
+    def show
+      @status_bar = ActsAsStatusBar::StatusBar.new(:id => params[:id], :create => false)
+      respond_to do |format|
+        format.html
+        format.xml {render :inline => @status_bar.to_xml}
+      end 
+#    rescue => e
+#      flash[:alert] = e.message
+#      redirect_to :action => 'show', :controller => 'status_bar'
+    end
+    
+    def destroy
+      @status_bar = ActsAsStatusBar::StatusBar.new(:id => params[:id], :create => false)
+      @status_bar.delete
+      redirect_to :action => "index"
+    end
+    
+    def destroy_all
+      ActsAsStatusBar::StatusBar.delete_all
+      redirect_to :action => "index"
+    end
+  end
+end

data/app/helpers/acts_as_status_bar_helper.rb

@@ -0,0 +1,105 @@
+module ActsAsStatusBarHelper
+  #Use it in your views to activate status bars.
+  #You can put it everywhere in your view, you only need to pass it your object.
+  #
+  #The only other thing you need to do is to add an :onclick => 'status_bar_init()'
+  #to the button/link that activates the bar:
+  #
+  # => <%= f.submit :onclick => 'status_bar_init()' %>
+  #
+  #You can access to the admin page via the helper:
+  # => acts_as_status_bar_status_bar_index_path
+  
+  #Use it if you don't have an object.
+  #Id is passed to the controller via session[:acts_as_status_bar][:id]
+  #and can be retrieved using status_bar_id(params) in your controller
+  # => #app/views/home/index.html.erb
+  # => <%= status_bar_tag %>
+  # => <%= link_to 'my_link', my_link_action_path, :onclick => 'status_bar_init()' %>
+  #
+  # => #app/controllers/homes_controller.erb
+  # => def action
+  # =>  @home = Home.new
+  # =>  @home.status_bar_id = status_bar_id(params)
+  # =>  @home.do_what_I_need
+  # =>  @home.status_bar.delete
+  # => end
+  def status_bar_tag(frequency = nil)
+    status_bar = ActsAsStatusBar::StatusBar.new
+    frequency = frequency || status_bar.frequency
+    url = acts_as_status_bar_status_bar_path(status_bar.id, :format => :xml)
+    session[:acts_as_status_bar]={:id => status_bar.id}
+    _status_bar_init(frequency, url)
+  end
+  
+  #Use it with status_bar or status_bar_tag in the controller to initialize and then destroy the bar.
+  # => @home = Home.find(params[:id])
+  # => status_bar_init(@home) do
+  #     @home.destroy
+  # => end
+  #
+  #It returns the value of status_bar.delete, a hash with parameters of the last update.
+  #You can use it to display info like process duration, object updated, ...
+  # 
+  def status_bar_init(object, &block)
+    object.status_bar_id ||= status_bar_id(params)
+    object.status_bar_init
+    bar = object.status_bar
+    yield block
+    bar.delete
+  end
+  
+  #Use it if you have an object and a form to pass parameters to the controller.
+  #The helper populates object.status_bar_id, and you need an hidden field in your form
+  #to pass the id to your object in the controller:
+  # => #app/views/home/index.html.erb
+  # => <%= status_bar_for(@home) %>
+  # => <%= form_for(@home) do |f| %>
+  # =>  ...
+  # =>  <%= f.hidden_field :status_bar_id %>
+  # =>  <%= f.submit :onclick => 'status_bar_init()' %>
+  # => <% end %>
+  def status_bar_for(object,frequnecy = nil)
+    object.status_bar_init
+    url = acts_as_status_bar_status_bar_path(object.status_bar_id, :format => :xml)
+    frequency = frequency || object.status_bar.frequency
+    _status_bar_init(frequency, url)
+  end
+  
+  private
+  
+  #Used to retrieve id from params in controller
+  def status_bar_id(params)
+    session[:acts_as_status_bar].try(:fetch, :id)
+  end
+  
+  #Initialize the status bar
+  def _status_bar_init(frequency, url)
+    stylesheet_link_tag('acts_as_status_bar')+
+    content_tag(:div, :id => "acts-as-status-bar-container", :align => 'center') do
+      content_tag(:p, '...', :id => 'acts-as-status-bar-message') +
+      content_tag(:p, '...', :id => 'acts-as-status-bar-value') +
+      content_tag(:div,
+        content_tag(:div,'', :id => "acts-as-status-bar"),
+        :id => "acts-as-status-bar-progress-bar", :align => 'left'
+      )
+    end +
+    javascript_include_tag("acts_as_status_bar_javascript") +
+    javascript_tag(%Q[
+      function status_bar_init(){
+        var progress = new ActsAsStatusBar(
+          'acts-as-status-bar-container',
+          'acts-as-status-bar-message', 
+          'acts-as-status-bar-value',
+          'acts-as-status-bar-progress-bar',
+          'acts-as-status-bar', {
+          frequency: #{frequency},
+          total: 100,
+          url: "#{url}"
+        });
+        progress.start();
+      }
+    ])
+  end
+end
+

data/app/models/acts_as_status_bar/status_bar.rb

@@ -0,0 +1,260 @@
+require 'pstore'
+
+module ActsAsStatusBar
+  #StatusBar is used to support a dynamic status bar, with values, percentage, timing and messages.
+  #==Usage
+  #
+  #It is possible to instantiate the bar with additional fields, passed as a list of arguments and their relative default values.
+  #new(:id => nil, )
+  class StatusBar
+    include ActionView::Helpers::DateHelper
+    
+    #Update frequency in seconds
+    FREQUENCY = 10
+    #Default End value
+    MAX = 100
+    #Default storage path
+    FILE = "db/acts_as_status_bar.store"
+    #Default status bar output when progress is finished
+    XML = %q<["Completato", 100, ""]>
+    
+    # ==CLASS Methods
+    class<<self
+      #Start Public Class Methods
+      #NO BAR is created using Class Methods
+      
+      #Delete all bars
+      def delete_all
+        store = new
+        store.send :_delete_all
+      end
+      
+
+      #Check if the bar is valid
+      def valid?(id)
+        store = new
+        store.send(:ids).include?(id.to_i)
+      end
+      
+      #It returns all active bars
+      #===Format
+      # {id1 => {:max, :current, ...}
+      #  id2 => {:max, :current, ...}
+      # }
+      def all
+        store = new
+        store.send :_all
+      end
+      
+      #to_s
+      def to_s
+        store = new
+        opt = []
+        store.send(:_options).each_key.map{|k| opt << ":#{k}" }
+        "#{store.class.name}(#{opt.join(', ')})"
+      end
+      
+      # Start Private Class Methods
+      private
+      
+    end
+    
+    # ==INSTANCE Methods
+    
+    #Initialize the bar
+    #===Options
+    #*  no_options        #Initialize the bar with a new id and don't store defaults
+    #*  :id => id         #Initialize the bar with a specific id and store defaults if new_record?
+    #*  :create => false  #Initialize the bar with a specific id (if present), without storing defaults
+    def initialize(*args)
+      @options = {  :max => MAX, 
+                    :current => 0, 
+                    :start_at => nil, 
+                    :current_at => 0.0, 
+                    :message => "",
+                    :progress => %q<["#{current}/#{max} (#{percent}%) tempo stimato #{finish_in}", "#{percent}", "#{message}"]> }
+      @options.merge!(args.extract_options!)
+      @id = @options.delete(:id)
+      #id usually comes from params, so it must be sure it is converted to int
+      @id = @id.to_i if @id
+      @store = PStore.new(FILE)
+      _init_bar if @id
+    end
+    
+    #Add a new field to the bar and store default value
+    #(Store Data)
+    def add_field(field, default=nil)
+      _define_method(field.to_sym) unless @options[field.to_sym]
+      send("#{field.to_sym}=", default)
+    end
+    
+    #Get or create an id
+    def id
+      @id ||= Time.now.utc.to_i
+    end
+    
+    #Check if the bar is new or already existent
+    def valid?
+      ids.include?(@id)
+    end
+
+    #Destroy the bar and return its last values
+    def delete
+      out = _delete(id) if @store
+      @id = nil
+      @store = nil
+      out
+    end
+    
+    def percent
+      #mylog("percent = #{max.inspect}")
+      unless  !valid? || max == 0
+        #raise CustomError::InvalidBar if !valid? || max == 0
+        (current.to_i * 100 / max.to_i).to_i 
+      end             
+    end
+    
+    #Decrement current value
+    def dec(value=1)
+      inc(value*-1)
+    end
+    
+    #Increment current value and set start_at at current time (if not set yet)
+    def inc(value=1) 
+      if valid?
+        #raise CustomError::InvalidBar unless valid?
+        _set(:start_at, Time.now.to_f) unless _get(:start_at)
+        _set(:current_at, Time.now.to_f)
+        inc_value = _inc(:current,value)
+        mylog("inc inc_value: #{inc_value}")
+        inc_value
+      end   
+    end
+    
+    #Return default frequency value, if not passed in the helper
+    def frequency
+      FREQUENCY
+    end
+    
+    #Return estimated completion time
+    def finish_in 
+      if valid?
+        #raise CustomError::InvalidBar unless valid?
+        remaining_time = (current_at.to_f - start_at.to_f)*(max.to_f/current.to_f - 1.0) if current.to_i > 0
+        remaining_time ? distance_of_time_in_words(remaining_time) : "non disponibile"      
+      end
+    end                                                                                        
+    
+    
+    #Return current value in xml in a format compatible with the status bar
+    def to_xml
+      val = valid? ? eval(progress) : eval(XML)
+      Hash['value', val[0], 'percent', val[1], 'message', val[2]].to_xml
+    end
+     
+    private
+    
+    #Initialize the bar, store defaults and dinamycally create methods
+    def _init_bar
+      unless @options.delete(:create)
+        _store_defaults
+        _define_methods
+      end
+    end
+    
+    #Return all ids
+    def ids
+      @store.transaction {@store.roots}
+    end
+    
+    #Delete the bar marked with a specific id
+    def _delete(i)
+      out ={}
+      @store.transaction {out = @store.delete(i)}
+      out
+    end
+    
+    #Delete all bars
+    def _delete_all
+      ids.each {|i| _delete(i)}
+    end
+    
+    #Return all status bars
+    def _all
+      out = {}
+      ids.each {|i| @store.transaction(true) {out[i] = @store[i]}}
+      out
+    end
+    
+
+    #Increment a value
+    #It also works with strings
+    def _inc(key,value)
+      _set(key, (_get(key) || 0) + value)
+    end
+    
+    #Decrement a value
+    #inc_ key, value*-1 was not used so that it can also work with strings
+    #[Not implemented yet... It would be a nice thing to add in the future...]
+    def _dec(key,value)
+      _set(key, (_get(key) || 0) - value)
+    end
+    
+    #Save a value
+    def _set(key,value)
+      @store.transaction {@store[@id][key] = value}
+    end
+    
+    #Retrieve a value
+    def _get(key)
+      @store.transaction(true) {@store[@id][key]}
+    end
+    
+    #Return options
+    def _options
+      @options
+    end
+    
+    #Store default values if the bar is not created yet
+    def _store_defaults
+      @store.transaction {@store[@id]= @options} unless valid?
+    end
+
+    #Build accessor methods for every bar's attribute
+    def _define_methods
+      @store.transaction(true){@store[@id]}.each_key do |method|
+        _define_method(method)
+      end
+    end
+    
+    #Build acessors for a specific attribute
+    #===Accessors
+    #*  inc_attribute(value=1)
+    #*  dec_attribute(value=1)
+    #*  attribute
+    #*  attribute=(value)
+    def _define_method(method)
+      #Getters
+      self.class.send(:define_method, method) do
+        _get method.to_sym
+      end
+
+      #Setters
+      self.class.send(:define_method, "#{method.to_s}=") do |value|
+        _set method, value
+      end
+
+      #Incrementer
+      self.class.send(:define_method, "inc_#{method.to_s}") do |*args|
+        value = args.first || 1
+        _inc method, value
+      end
+
+      #Decrementer
+      self.class.send(:define_method, "dec_#{method.to_s}") do |*args|
+        value = args.first || 1
+        _dec method, value
+      end
+    end
+  end
+end

data/app/views/acts_as_status_bar/status_bar/index.html.erb

@@ -0,0 +1,18 @@
+<html>
+	<body>
+		<h1>Active Status Bars</h1>
+		<% @status_bars.each do |k,v|%>
+			<li><%=link_to	'Delete',
+				 			acts_as_status_bar_status_bar_path(k),
+							:method => :delete
+				%>
+				<%= k %>:
+				<%= v.inspect %>
+			</li>
+		<% end %>
+		<%=link_to 'Delete All',
+					destroy_all_acts_as_status_bar_status_bar_index_path,
+					:method => :delete
+		%>
+	</body>
+</html>

data/app/views/acts_as_status_bar/status_bar/show.html.erb

@@ -0,0 +1,5 @@
+<html>
+	<body>
+		<p>STATUS_BAR:<%= @status_bar.inspect %></p>
+	</body>
+</html>

data/config/initializers/acts_as_status_bar.rb

@@ -0,0 +1,4 @@
+#Il caricamento dellce costanti, poich� dipende dalla classe Enumeration, definita dall'applicazione Rails
+#non pu� essere fatto nell'engine in quanto Rails.root non � definito....
+require "acts_as_status_bar/constant" if File.exists?("acts_as_status_bar/constant.rb")
+require "acts_as_status_bar/exceptions" if File.exists?("acts_as_status_bar/exceptions.rb")

data/config/locales/custom_errors.it.yml

@@ -0,0 +1,4 @@
+it:
+  ActsAsStatusBar:
+    CustomError:
+      InvalidBar: "Progress Bar non valida!"

data/config/locales/links.it.yml

@@ -0,0 +1,7 @@
+it:
+  shared:
+    links:
+      # admin::acts_as_statusBar
+      acts_as_status_bar_status_bar_index: "Status Bar"
+      
+      

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+   namespace :acts_as_status_bar do
+     resources :status_bar, :only =>[:index, :show, :destroy] do
+ 	     delete 'destroy_all', :on => :collection
+ 	   end
+  end
+end

data/lib/acts_as_status_bar.rb

@@ -0,0 +1,7 @@
+module ActsAsStatusBar
+end
+
+require "acts_as_status_bar/engine"
+require "acts_as_status_bar/exceptions"
+require "acts_as_status_bar/status_bar_base"
+

data/lib/acts_as_status_bar/engine.rb

@@ -0,0 +1,19 @@
+module ActsAsStatusBar
+  class Engine < Rails::Engine
+    
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+
+    initializer 'acts_as_status_bar.helper' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include ActsAsStatusBarHelper
+      end
+      ActiveSupport.on_load(:action_view) do
+        include ActsAsStatusBarHelper
+      end
+     
+    end
+  end
+  
+end
+
+#Add ere require to specific file or gem used

data/lib/acts_as_status_bar/exceptions.rb

@@ -0,0 +1,18 @@
+#Localize messages in it.CustomError.MyError
+module ActsAsStatusBar
+  class CustomError < StandardError
+    def initialize(*args)
+        @options = args.extract_options!
+        super
+    end
+      
+    def message
+      @options.merge!({:default => "Error : #{@options.inspect}"})
+      I18n.t("#{self.class.name.gsub(/::/,'.')}", @options )
+    end
+    
+    class InvalidBar < CustomError; end
+    
+  end 
+end
+

data/lib/acts_as_status_bar/status_bar_base.rb

@@ -0,0 +1,62 @@
+module ActsAsStatusBar
+  module StatusBarBase
+    def self.included(base) # :nodoc:
+      base.send :extend, ClassMethods
+    end
+    
+    # Class methods for the mixin
+    module ClassMethods
+      # Defines the class method to inject monitor methods
+      #
+      #==Example
+      # class MyModel < ActiveRecord::Base
+      #   acts_as_status_bar
+      #   ...
+      #   private
+      #
+      #   def warn_test?
+      #     whatever you want that returns true in a warning condition
+      #   end
+      #
+      #   def error_test?
+      #     whatever you want that returns true in an error condition
+      #   end
+      def acts_as_status_bar(options={})
+        attr_accessor :status_bar_id
+        attr_accessor :status_bar
+        extend ActsAsStatusBar::StatusBarBase::SingletonMethods
+        include ActsAsStatusBar::StatusBarBase::InstanceMethods
+      end
+      
+    
+    end
+    
+    # Singleton methods for the mixin
+    module SingletonMethods
+      
+    end
+    
+    #Instance methods for the mixin
+    module InstanceMethods
+      
+      def status_bar_init
+        self.status_bar = ActsAsStatusBar::StatusBar.new(:id => self.status_bar_id)
+        self.status_bar_id = self.status_bar.id
+      end
+      
+      def status_bar=(sb)
+        @status_bar = sb
+        @status_bar_id = sb.id
+      end
+      
+      private
+      
+    end
+    
+
+  end
+  
+end
+
+require 'active_record'
+ActiveRecord::Base.send :include, ActsAsStatusBar::StatusBarBase

data/lib/acts_as_status_bar/version.rb

@@ -0,0 +1,4 @@
+module ActsAsStatusBar
+  VERSION = "1.0.0"
+end
+

data/lib/generators/acts_as_status_bar/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+module ActsAsStatusBar
+  class InstallGenerator < Rails::Generators::Base
+    desc "Install generator for ActsAsStatusBar gem"
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def copy_config
+      directory "."
+    end
+    
+    #def copy_public
+    #  directory "public"
+    #end
+    
+  end      
+end
+

data/lib/generators/acts_as_status_bar/install/templates/public/javascripts/acts_as_status_bar_javascript.js

@@ -0,0 +1,66 @@
+//ActsAsStatusBar
+
+var instanceNo = 0;
+var ActsAsStatusBar = Class.create();
+ActsAsStatusBar.prototype = {
+	initialize: function(progressBarContainerElementId,progressBarMessageId,progressBarValueId,progressBarElementId, barElementId, initProperties){
+		this.progressBarContainerElement = document.getElementById(progressBarContainerElementId);
+		this.progressMessage = document.getElementById(progressBarMessageId);
+		this.progressValue = document.getElementById(progressBarValueId);
+		this.progressBarElement = document.getElementById(progressBarElementId);
+		this.barElement = document.getElementById(barElementId);
+		if( initProperties != null ){
+			this.frequency = initProperties["frequency"];
+			this.url = initProperties["url"];
+			this.total = initProperties["total"];
+		}else{ this.frequency = 2; }
+		this.value = 1;
+		this.display_value = "";
+		this.display_message = "";
+		this.isFinish = false;
+		this.repaint();
+		this.id = "AjaxProgressBar"+ instanceNo++;
+		window[this.id] = this;
+	},
+	setValue: function(value){ this.value = value; this.repaint(); },
+	
+	setDisplayValue: function(display_value, display_message){
+		 this.display_value = display_value;
+		 this.display_message = display_message; 
+		 this.repaint();
+ 	},
+	
+	//Update div content on the page
+	repaint: function(){
+		if( this.value >= 0 && this.value <= 100 ){
+			this.barElement.style.width = this.value +"%";
+			this.progressValue.innerHTML = this.display_value;
+			this.progressMessage.innerHTML = this.display_message;
+		}
+	},
+	start: function(){ this.progressBarContainerElement.style.visibility = 'visible'; this.update(); },
+	update: function(){
+		var upThis = this;
+		var ajax = new Ajax.Request(this.url, {
+			method: "get",
+			onSuccess: function(res){ upThis.updateSuccess(res); },
+			onFailure: function(res){ alert("Error: "+ res.status +" "+ res.statusText);}
+		});
+		if(!this.isFinish )
+		{
+			setTimeout("window."+ this.id +".update()", this.frequency*1000);
+		}
+		else
+		{
+			this.progressBarContainerElement.style.visibility = 'hidden';
+		}
+	},
+	updateSuccess: function(res){
+		var value = res.responseXML.getElementsByTagName("value")[0].firstChild.nodeValue;
+		var message = res.responseXML.getElementsByTagName("message")[0].firstChild.nodeValue;
+		var percent = parseInt(res.responseXML.getElementsByTagName("percent")[0].firstChild.nodeValue);
+		this.setValue(percent);
+		this.setDisplayValue(value,message);
+		this.isFinish = percent == 100;
+	}
+}

data/lib/generators/acts_as_status_bar/install/templates/public/stylesheets/acts_as_status_bar.css

@@ -0,0 +1,33 @@
+/* Progress_bar  ============================================================== */
+#acts-as-status-bar-container {
+	width: 500px;
+	height: 70px;
+	background-position: right center;
+	position:absolute;
+	left:30%;
+	top:45%;
+	z-index:10;
+	visibility:hidden;
+	margin:0;
+	padding:10px;
+	background:#EAEBD8;
+	border:3px solid #5970B2;
+}
+#acts-as-status-bar-message {
+	
+}
+#acts-as-status-bar-value {
+	
+}
+#acts-as-status-bar-progress-bar {
+	width: 400px;
+	height: 19px;
+	background: url(../images/acts_as_status_bar_background.gif);
+	background-position: right center;
+}
+#acts-as-status-bar {
+	background: url(../images/acts_as_status_bar_foreground.gif);
+  	background-position: right center;
+	width: 0%;
+	height: 100%;
+}

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_status_bar
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrea Bignozzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.15
+  name: rails
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  name: mysql2
+  prerelease: false
+  requirement: *id002
+description: Rails StatusBar with ActiveRecord integration, permits dynamic custom output from your model
+email: 
+- skylord73@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/acts_as_status_bar/status_bar_controller.rb
+- app/helpers/acts_as_status_bar_helper.rb
+- app/models/acts_as_status_bar/status_bar.rb
+- app/views/acts_as_status_bar/status_bar/index.html.erb
+- app/views/acts_as_status_bar/status_bar/show.html.erb
+- lib/acts_as_status_bar/engine.rb
+- lib/acts_as_status_bar/exceptions.rb
+- lib/acts_as_status_bar/status_bar_base.rb
+- lib/acts_as_status_bar/version.rb
+- lib/acts_as_status_bar.rb
+- lib/generators/acts_as_status_bar/install/install_generator.rb
+- lib/generators/acts_as_status_bar/install/templates/public/images/acts_as_status_bar_background.gif
+- lib/generators/acts_as_status_bar/install/templates/public/images/acts_as_status_bar_foreground.gif
+- lib/generators/acts_as_status_bar/install/templates/public/javascripts/acts_as_status_bar_javascript.js
+- lib/generators/acts_as_status_bar/install/templates/public/stylesheets/acts_as_status_bar.css
+- config/initializers/acts_as_status_bar.rb
+- config/locales/custom_errors.it.yml
+- config/locales/links.it.yml
+- config/routes.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+- CHANGELOG.md
+homepage: 
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.10
+signing_key: 
+specification_version: 4
+summary: Rails StatusBar with ActiveRecord integration
+test_files: []
+