acts_as_monitor 0.0.2 → 0.0.9

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 0.1.0 ToDo
+- BugFixing
+
+0.0.9 (May 28, 2012)
 - Ajax to have warning and error list clicking on icon
 
-0.0.2 (May 23, 2011)
-- Working copy
+0.0.2 (May 23, 2012)
+- first working copy
 
-0.0.1 (May 23, 2011)
+0.0.1 (May 23, 2012)
 - First deploy not working

data/README.md

@@ -57,8 +57,30 @@ You can now check the status of your model using the following code:
     
 You can use the monitor_tag helper to view a red/green/yellow rapresentation:
     #app/views/users/index.html.erb
+    <%= monitor_tag_js %>     #Creates hidden div and load css and javascript
     ...
     <%= monitor_tag(@user) %>
+    
+Clicking to Icon you receive via Ajax the full error/warning list
+
+## Internationalization
+You can localize the output modifing the acts_as_monitor.it.yml, or cloning for the language you prefear.
+Name of models is retrived via human_name, so yuo have to localize the ActiveRecord to change names:
+    it:
+      activerecord:
+        models:
+          your_model_name: Your Model Name
+          
+          namespace:
+            namespaced_model_name: Your Namespaced Model Name
+
+## Personalization
+Feel free to modify the fololwing files to change layouts and text :
+- public/stylesheets/acts_as_monitor.css
+- config/locales/act_as_monitor.it.yml
+
+If you need a deeper personalization you can try to overload app/views/acts_as_monitor/monitors/show.html.erb
+conaining the page template for the error/warning list
 
 ## Contributing
 

data/app/controllers/acts_as_monitor/monitors_controller.rb

@@ -0,0 +1,18 @@
+module ActsAsMonitor
+  class MonitorsController < ::ApplicationController
+    
+    def show
+      @monitor = eval(params[:class_name]).find(params[:id]) if monitor_valid?(params)
+      Rails::logger.info("MonitorsController @monitor=#{@monitor.inspect}")
+      respond_to do |format|
+        format.js do
+          view = render_to_string "show"
+          #render :json => {"text" => @status.status}
+          render :json => {"text" => view}
+        end
+        format.html
+      end
+    end
+
+  end    
+end

data/app/helpers/acts_as_monitor_helper.rb

@@ -0,0 +1,25 @@
+module ActsAsMonitorHelper
+  def monitor_tag(object)
+    raise ActsAsMonitor::MissingMethod unless object.respond_to?(:status_flag)
+    status = object.status_flag
+    icon = I18n.t(status, :scope => "acts_as_monitor.icons", 
+                                                 :default => "acts_as_monitor_#{status.to_s}.png")
+    image_tag icon, :alt => I18n.t("alt_image_#{status.to_s}", :scope => "acts_as_monitor.icons", 
+                                                 :default => status.to_s.capitalize),
+                    :class => "acts_as_monitor_icon_#{status.to_s}",
+                    'data-class' => object.class.name, 'data-id' => object.id
+  end
+
+  def monitor_tag_js()
+    content_tag(:div, "/#{Rails.root.to_s.split('/').last}", :id => 'acts_as_monitor_status_window') +
+    javascript_include_tag("acts_as_monitor_javascript.js") + 
+    stylesheet_link_tag('acts_as_monitor.css')
+  end
+
+  def monitor_valid?(params)
+    return false if params[:id].blank? || params[:class_name].blank?
+    Rails::logger.info  eval(params[:class_name]).instance_methods.include?("status")
+    return false unless eval(params[:class_name]).instance_methods.include?("status")    
+    true
+  end
+end

data/app/views/acts_as_monitor/monitors/show.html.erb

@@ -0,0 +1,26 @@
+<% if @monitor %>
+  <fieldset class='acts_as_monitor_status_window'>
+    <legend class='acts_as_monitor_status_window'><%= @monitor.class.human_name %></legend>
+    <% @status = @monitor.status %>
+    <% @li_scope = "acts_as_monitor.messages.#{@monitor.class.name.underscore.gsub('/','_')}"%>
+    <% unless @status[:error].blank? %>
+      <h3 class="acts_as_monitor_errors_title"><%=I18n.t(:errors, :scope => "acts_as_monitor.messages") %></h3>
+      <ul class="acts_as_monitor_list_errors">
+      <%@status[:error].each do |error| %>
+        <li class= "acts_as_monitor_list_errors"><%=I18n.t(error, :scope=> @li_scope, :default => error.to_s) %></li>
+      <% end %>
+      </ul>
+    <% end %>
+    <% unless @status[:warn].blank? %>
+      <h3 class="acts_as_monitor_warnings_title"><%=I18n.t(:warnings, :scope => "acts_as_monitor.messages") %></h3>
+      <ul class="acts_as_monitor_list_warnings">
+      <%@status[:warn].each do |warn| %>
+        <li class="acts_as_monitor_list_warnings"><%=I18n.t(warn, :scope=> @li_scope, :default => warn.to_s) %></li>
+      <% end %>
+      </ul>
+    <% end %>
+<% else %>
+  <p><%= I18n.t(:missing_method, :scope=> "acts_as_monitor.errors", :default => "Add acts_as_monitor to monitored Class") %></p>
+<% end %>
+
+

data/config/routes.rb

@@ -1,4 +1,6 @@
 # CURRENT FILE :: config/routes.rb
 Rails.application.routes.draw do
-  get "monitor" => "acts_as_monitor/monitor#index", :as => :acts_as_monitor
+   namespace :acts_as_monitor do
+    resources :monitors, :only =>[:show]
+  end
 end

data/lib/acts_as_monitor/engine.rb

@@ -1,15 +1,28 @@
 module ActsAsMonitor
   class Engine < Rails::Engine
-    initialize "team_page.load_app_instance_data" do |app|
-      TeamPage.setup do |config|
-        config.app_root = app.root
+#    initialize "acts_as_monitor.load_app_instance_data" do |app|
+#      ActsAsMonitor.setup do |config|
+#        config.app_root = app.root
+#      end
+#    end
+#    
+#    initialize "acts_as_monitor.load_static_assets" do |app|
+#      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+#    end
+#  
+    #Includes models, controllers, helpers, config/routes.rb, config/locales/*, tasks in lib/tasks/*
+    engine_name :acts_as_monitor
+
+    initializer 'acts_as_monitor.helper' do |app|
+      #ActionView::Base.send :include, ActsAsMonitorHelper
+      ActiveSupport.on_load(:action_controller) do
+        include ActsAsMonitorHelper
       end
+      ActiveSupport.on_load(:action_view) do
+        include ActsAsMonitorHelper
+      end
+      
     end
-    
-    initialize "team_page.load_static_assets" do |app|
-      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
-    end
-  
   end
   
 end

data/lib/acts_as_monitor/monitor.rb

@@ -47,7 +47,7 @@ module ActsAsMonitor
         out = {:warn => [], :error => []}
         methods = self.private_methods.map{|m| m.match(search) }.compact
         methods.each do |method|
-          out[method[1].to_sym] << method[0].to_sym if send(method[0])
+          out[method[1].to_sym] << method[0].gsub("?","").to_sym if send(method[0])
         end
         out
       end

data/lib/acts_as_monitor/version.rb

@@ -1,3 +1,3 @@
 module ActsAsMonitor
-  VERSION = "0.0.2"
+  VERSION = "0.0.9"
 end

data/lib/acts_as_monitor.rb

@@ -1,15 +1,15 @@
-require "acts_as_monitor/version"
-require "acts_as_monitor/monitor"
-require File.dirname(__FILE__) + '/../app/helpers/monitor_helper'
+require "active_support/dependencies"
 
 module ActsAsMonitor
-  class MissingMethod < StandardError
-    def message
-      I18n.t(:missing_method, :scope => "acts_as_monitor.errors", :default => "Add acts_as_monitor to your class")
-    end
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
   end
-  
-  #Include my Helper to ActionView (as they where in application_helper)
-  ActionView::Base.send :include, ActsAsMonitor::Helper
 
 end
+
+require "acts_as_monitor/engine"
+#require "acts_as_monitor/version"
+require "acts_as_monitor/monitor"
+require "acts_as_monitor/exceptions"

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

@@ -1,31 +1,39 @@
 require 'rails/generators'
 module ActsAsMonitor
-    class InstallGenerator < Rails::Generators::Base
-      desc "Install generator for ActsAsMonitor gem"
-      source_root File.expand_path("../templates", __FILE__)
+  class InstallGenerator < Rails::Generators::Base
+    desc "Install generator for ActsAsMonitor gem"
+    source_root File.expand_path("../templates", __FILE__)
       
-      def copy_icons
-        icons = ["acts_as_monitor_green.png", "acts_as_monitor_red.png", "acts_as_monitor_yellow.png"]
-        icons.each do |icon| 
-          destination = "public/images/" + icon
-          copy_file icon, destination
-        end
-      end
-      
-      def copy_locales
-        file = "acts_as_monitor.it.yml"
-        destination = "config/locales/" + file
-          copy_file file, destination
-        end
-      end
-      
-      def print_usage
-        usage = <<-START
-        Add acts_as_monitor to model to monitor
-        Add a private method warn_*? and error_*? to define warning and error status
-        Use monitor_tag(model_instance) in your view
-        START
-        puts(usage)
+    def copy_icons
+      icons = ["acts_as_monitor_green.png", "acts_as_monitor_red.png", "acts_as_monitor_yellow.png", "acts_as_monitor_loading.gif"]
+      icons.each do |icon| 
+        destination = "public/images/" + icon
+        copy_file icon, destination
       end
+    end
       
+    def copy_locales
+      file = "acts_as_monitor.it.yml"
+      destination = "config/locales/" + file
+      copy_file file, destination
+    end
+    
+    def copy_javascripts
+      copy_file "acts_as_monitor_javascript.js", "public/javascripts/acts_as_monitor_javascript.js"
+    end
+
+    def copy_stylesheet
+      copy_file "acts_as_monitor.css", "public/stylesheets/acts_as_monitor.css"
+    end
+
+
+    def print_usage
+      usage = <<-START
+      Add acts_as_monitor to model to monitor
+      Add a private method warn_*? and error_*? to define warning and error status
+      Use monitor_tag(model_instance) in your view
+      START
+      puts(usage)
+    end
+  end      
 end

data/lib/generators/acts_as_monitor/install/templates/acts_as_monitor.css

@@ -0,0 +1,48 @@
+.acts_as_monitor_status_window{
+  background-color: #F2F2F2;
+  border: solid black 1px;
+  opacity: 0.9;
+  width: 150px;
+}
+
+.acts_as_monitor_status_window legend{
+  opacity: 1.0;
+  background-color: #F2F2F2;
+  padding-left: 5px;
+  padding-right: 5px;
+  margin-left: 5px;
+  margin-right: 10px;
+  
+}
+
+.acts_as_monitor_status_window h3.acts_as_monitor_errors_title{
+  font-weight: normal;
+  background-color: red;
+  text-align: center;
+  padding-left: 5px;
+  padding-right: 5px;
+  padding-top: 3px;
+  padding-bottom: 3px;
+}
+
+.acts_as_monitor_status_window h3.acts_as_monitor_warnings_title{
+  font-weight: normal;
+  background-color: #FACC2E;
+  text-align: center;
+  padding-left: 5px;
+  padding-right: 5px;
+  padding-top: 3px;
+  padding-bottom: 3px;
+}
+
+.acts_as_monitor_status_window ul{
+  margin-left: 10px;
+}
+
+li.acts_as_monitor_list_errors{
+  list-style-image: url('../images/acts_as_monitor_red.png');
+}
+
+li.acts_as_monitor_list_warnings{
+  list-style-image: url('../images/acts_as_monitor_yellow.png');
+}

data/lib/generators/acts_as_monitor/install/templates/acts_as_monitor.it.yml

@@ -6,4 +6,11 @@ it:
       green: acts_as_monitor_green.png
       alt_image: "Clicca per visualizzare i dettagli"
     errors:
-      missing_method: "Aggiungi acts_as_monitor alla classe da monitorare"
+      missing_method: "Aggiungi acts_as_monitor alla classe da monitorare"
+    messages:
+      errors: Errori
+      warnings: Avvisi
+      #test_clas:                     #class name (TestClass)
+        #warn_test: "Warning Test"    #warning method name
+        #error_test: "Error Test"     #error method name
+      #myspace_test_class:            #class name (Myspace::TestClass)

data/lib/generators/acts_as_monitor/install/templates/acts_as_monitor_javascript.js

@@ -0,0 +1,78 @@
+document.observe('dom:loaded', function()
+{
+  var application_root ='';
+  create_status_window();
+  //alert(application_root);
+
+  function create_status_window() {
+    /*new Insertion.Bottom(
+      document.body, 
+      "<div id='acts_as_monitor_status_window'><%= Rails.root %></div>"
+    );*/
+    var status_window = $('acts_as_monitor_status_window');
+    Position.absolutize(status_window);
+    status_window.observe('click', function(ev) {status_window.fade(); });
+    status_window.hide();
+    //The helper provide the Rails.root inside the created div...
+    application_root = status_window.innerHTML;
+  }
+
+  var handle_monitor = function(ev)
+  {
+    var id = ev.target.getAttribute('data-id');
+    var image = ev.target.src;
+    new Ajax.Request(application_root + '/acts_as_monitor/monitors/'+ id +'.js', 
+    {
+      method: 'get',
+      evalJSON: 'force',
+      parameters: {
+        class_name: ev.target.getAttribute('data-class')
+      },
+      onLoading: function(response){
+        ev.target.src = application_root + '/images/acts_as_monitor_loading.gif';
+      },
+      onSuccess: function(response){
+        var rsp = response.responseJSON;
+        ev.target.src = image;
+        create_popup(rsp.text,ev.target);
+      },
+      onFailure: function(response) 
+      {
+        alert('Failure ' + response.status);
+      }
+    });
+  }
+
+  //Create popup with information
+  function create_popup(text,target)
+  {
+    //alert(text);
+    var status_window = $('acts_as_monitor_status_window');
+    status_window.update(text);
+    Position.clone(target,
+      status_window, {
+        offsetLeft: 20
+      });
+    new Effect.Appear(status_window);
+    //alert("Fatto");
+  }
+
+  //$$('.acts_as_monitor_icon_red .acts_as_monitor_icon_yellow .acts_as_monitor_icon_green') 
+  var pulsate_forever = function(elem) {
+    new Effect.Pulsate(elem, {
+      //afterFinish: function(o) { new Effect.Pulsate(o.element, o.options); }
+      duration: 600,
+      pulses: 1500
+    });
+  }
+  $$('.acts_as_monitor_icon_red').each(function(elmt)
+    {
+    elmt.observe('click', handle_monitor);
+    pulsate_forever(elmt);
+    }); 
+  
+  $$('.acts_as_monitor_icon_yellow').each(function(elmt)
+    {
+    elmt.observe('click', handle_monitor);
+    }); 
+});

data/test/acts_as_monitor_helper_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class ActsAsMonitorHelperTest < ActionView::TestCase
+  test "monitor_tag return image" do
+    @test_class = TestClass.new
+    @image = image_tag("acts_as_monitor_#{@test_class.status_flag.to_s}.png" , :alt => "Click to view details")
+    assert monitor_tag(@test_class) == @image , "fail monitor tag :#{monitor_tag(TestClass.new)}"
+  end
+  
+  test "monitor_tag Rise exception" do
+    assert_raise ActsAsMonitor::MissingMethod do
+      monitor_tag(TestClassNoMonitor.new)
+    end
+  end
+end
+

data/test/{units/acts_as_monitor_test.rb → acts_as_monitor_test.rb}

@@ -1,9 +1,6 @@
 require 'test_helper'
 
 class ActsAsMonitorTest < ActiveSupport::TestCase
-  include ActionView::Helpers
-  include ActsAsMonitor::Helper
-    
   test "Methods exists!" do
     @test_class = TestClass.new
     assert TestClass.respond_to?(:acts_as_monitor), "acts_as_monitor missing!"
@@ -19,34 +16,20 @@ class ActsAsMonitorTest < ActiveSupport::TestCase
   
   test "Status warn" do
     @test_class = TestClass.new(:warn => true)
-    assert @test_class.status == {:warn => [:warn_test? ], :error => []} , "Error: #{@test_class.status.inspect}"
+    assert @test_class.status == {:warn => [:warn_test ], :error => []} , "Error: #{@test_class.status.inspect}"
     assert @test_class.status_flag == :yellow , "Error: #{@test_class.status_flag.inspect}"
   end
   
   test "Status error" do
     @test_class = TestClass.new(:error => true)
-    assert @test_class.status == {:warn => [], :error => [:error_test? ]}, "Error: #{@test_class.status.inspect}"
+    assert @test_class.status == {:warn => [], :error => [:error_test ]}, "Error: #{@test_class.status.inspect}"
     assert @test_class.status_flag == :red , "Error: #{@test_class.status_flag.inspect}"
   end
   
   test "Status error & warn " do
     @test_class = TestClass.new(:error => true, :warn => true)
-    assert @test_class.status == {:warn => [:warn_test? ], :error => [:error_test? ]}, "Error: #{@test_class.status.inspect}"
+    assert @test_class.status == {:warn => [:warn_test ], :error => [:error_test ]}, "Error: #{@test_class.status.inspect}"
     assert @test_class.status_flag == :red , "Error: #{@test_class.status_flag.inspect}"
   end
   
-  test "monitor_tag return image" do
-    @test_class = TestClass.new
-    @image = image_tag("acts_as_monitor_#{@test_class.status_flag.to_s}.png" , :alt => "Click to view details")
-    assert monitor_tag(@test_class) == @image , "fail monitor tag :#{monitor_tag(TestClass.new)}"
-  end
-  
-  test "monitor_tag Rise exception" do
-    assert_raise ActsAsMonitor::MissingMethod do
-      monitor_tag(TestClassNoMonitor.new)
-    end
-  end
-  
-    
-  
 end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/homes_controller.rb

@@ -0,0 +1,4 @@
+class HomesController < ApplicationController
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/homes_helper.rb

@@ -0,0 +1,2 @@
+module HomesHelper
+end

data/test/dummy/app/models/test_class.rb

@@ -0,0 +1,33 @@
+class TestClass < ActiveRecord::Base
+  acts_as_monitor
+  attr_accessor :warn, :error
+  
+  after_initialize do
+    @warn ||= false
+    @error ||= false
+  end
+  
+  
+  private
+  
+  def warn_test?
+    @warn
+  end
+  
+  def error_test?
+    @error
+  end
+
+  def warn_paperino?
+    return true if self.name == 'Paperino'
+  end
+
+  def error_pippo?
+    return true if self.name == 'Pippo'
+  end
+
+  def error_id?
+    return true if self.id == 1
+  end
+  
+end

data/test/dummy/app/models/test_class_no_monitor.rb

@@ -0,0 +1,2 @@
+class TestClassNoMonitor 
+end

data/test/dummy/app/views/homes/index.html.erb

@@ -0,0 +1,8 @@
+<p>Home Page</p>
+<%= javascript_include_tag :defaults %>
+<%= monitor_tag_js %>
+<ul>
+<% TestClass.all.each do |u| %>
+<li><p><%= u.name %></p><p><%= u.status_flag %></p><%=monitor_tag(u) %></li>
+<% end %>
+</ul>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "acts_as_monitor"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!