acts_as_monitor 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.svn
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_monitor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,69 @@
+# ActsAsMonitor
+
+Provide a way to monitor the status of a model.
+The health of the model is checked by private method, defined by user
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_monitor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_monitor
+    
+Copy icons and other files
+
+    rails g acts_as_monitor:install
+
+## Usage
+    #app/models/user.rb
+    class User < ActiveRecord::Base
+      acts_as_monitor
+    
+      ... your code ...
+    
+      private
+    
+      def warn_stange?
+        ... do some checks and return true or false
+        true
+      end
+    
+      def warn_not_now?
+        ... do some checks and return true or false
+        false
+      end
+    
+      def error_terrible?
+        ... do some checks and return true or false
+        true
+      end
+    end
+
+You can now check the status of your model using the following code:
+    @user = User.new
+    
+    @user.status
+    > {:warn => [:warn_strange?], :error => [:error_terrible?]}
+    
+    @user.status_flag
+    > :red
+    
+You can use the monitor_tag helper to view a red/green/yellow rapresentation:
+    #app/views/users/index.html.erb
+    ...
+    <%= monitor_tag(@user) %>
+
+## 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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+#~ RSpec::Core::RakeTask.new
+
+#~ task :default => :spec
+#~ task :test => :spec
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+end

data/acts_as_monitor.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_monitor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrea Bignozzi"]
+  gem.email         = ["skylord73@gmail.com"]
+  gem.description   = %q{Monitor model via private methods warn_*? and error_*?}
+  gem.summary       = %q{Monitor models }
+
+  gem.files               = `git ls-files`.split($\)
+  gem.executables     = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files        = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name              = "acts_as_monitor"
+  gem.require_paths   = ["lib"]
+  gem.version           = ActsAsMonitor::VERSION
+  
+  gem.add_dependency "rails", "3.0.9"
+  
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  
+end

data/app/controllers/acts_as_monitor/monitor_controller.rb

@@ -0,0 +1,7 @@
+module ActsAsMonitor
+  class MonitorController < ::ApplicationController
+    
+    def index
+    end
+    
+end

data/app/helpers/monitor_helper.rb

@@ -0,0 +1,11 @@
+module ActsAsMonitor
+  module Helper
+    def monitor_tag(object)
+      raise ActsAsMonitor::MissingMethod unless object.respond_to?(:status_flag)
+      icon = I18n.t(object.status_flag, :scope => "acts_as_monitor.icons", 
+                                                   :default => "acts_as_monitor_#{object.status_flag.to_s}.png")
+      image_tag icon, :alt => I18n.t(:alt_image, :scope => "acts_as_monitor.icons", 
+                                                   :default => "Click to view details")
+    end
+  end
+end

data/app/views/acts_as_monitor/indext.html.erb

@@ -0,0 +1 @@
+<p>My engine page</p>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# CURRENT FILE :: config/routes.rb
+Rails.application.routes.draw do
+  get "monitor" => "acts_as_monitor/monitor#index", :as => :acts_as_monitor
+end

data/lib/acts_as_monitor.rb

@@ -0,0 +1,15 @@
+require "acts_as_monitor/version"
+require "acts_as_monitor/monitor"
+require File.dirname(__FILE__) + '/../app/helpers/monitor_helper'
+
+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
+  end
+  
+  #Include my Helper to ActionView (as they where in application_helper)
+  ActionView::Base.send :include, ActsAsMonitor::Helper
+
+end

data/lib/acts_as_monitor/engine.rb

@@ -0,0 +1,15 @@
+module ActsAsMonitor
+  class Engine < Rails::Engine
+    initialize "team_page.load_app_instance_data" do |app|
+      TeamPage.setup do |config|
+        config.app_root = app.root
+      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/exceptions.rb

@@ -0,0 +1,9 @@
+#Defines Custom Exceptions
+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
+  end
+end

data/lib/acts_as_monitor/monitor.rb

@@ -0,0 +1,74 @@
+module ActsAsMonitor
+  module Monitor
+    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_monitor
+      #   ...
+      #   private
+      #
+      #   def warn_test?
+      #     whatever you want that return true in a warning condition
+      #   end
+      #
+      #   def error_test?
+      #     whatever you want that return true in an error condition
+      #   end
+      def acts_as_monitor(options={})
+        #~ cattr_accessor :xlsx_i18n, :xlsx_columns
+        #~ self.xlsx_i18n = options.delete(:i18n) || false
+        #~ self.xlsx_columns = options.delete(:columns) || self.column_names.map { |c| c = c.to_sym }
+        extend ActsAsMonitor::Monitor::SingletonMethods
+        include ActsAsMonitor::Monitor::InstanceMethods
+      end
+      
+    
+    end
+    
+    # Singleton methods for the mixin
+    module SingletonMethods
+    end
+    
+    #Instance methods for the mixin
+    module InstanceMethods
+      #Used to have full status description
+      #
+      # {:wan => [wan_name1?, ...], :error => [error_name1?...]}
+      #where warn_name1? and error_name1? are private instance method defined in the monitored model
+      def status
+        search = /^(warn|error)_.*\?/
+        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])
+        end
+        out
+      end
+      
+      #Used to have a quick status of the model 
+      #*  :red => Errors
+      #*  :yellow => Warnings
+      #*  :green => Nornal status
+      def status_flag
+        st = status
+        return :red unless st[:error].blank?
+        return :yellow unless st[:warn].blank?
+        return :green
+      end
+    end
+    
+
+  end
+  
+end
+
+require 'active_record'
+ActiveRecord::Base.send :include, ActsAsMonitor::Monitor
+

data/lib/acts_as_monitor/version.rb

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

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

@@ -0,0 +1,31 @@
+require 'rails/generators'
+module ActsAsMonitor
+    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)
+      end
+      
+end

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

@@ -0,0 +1,9 @@
+it:
+  acts_as_monitor:
+    icons:
+      red: acts_as_monitor_red.png
+      yellow: acts_as_monitor_yellow.png
+      green: acts_as_monitor_green.png
+      alt_image: "Clicca per visualizzare i dettagli"
+    errors:
+      missing_method: "Aggiungi acts_as_monitor alla classe da monitorare"

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: test/acts_as_monitor.sqlite3.db

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'active_record'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_view/test_case'
+require 'acts_as_monitor'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config['sqlite3'])
+
+ActiveRecord::Schema.define(:version => 0) do
+    begin
+    drop_table :test_classes, :force => true
+    rescue
+      #dont really care if the tables are not dropped
+    end
+
+    create_table(:test_classes, :force => true) do |t|
+      t.string :name
+    end
+
+  end
+  
+class TestClassNoMonitor 
+end
+
+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
+  
+end

data/test/units/acts_as_monitor_test.rb

@@ -0,0 +1,52 @@
+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!"
+    assert @test_class.respond_to?(:status), "status missing!"
+    assert @test_class.respond_to?(:status_flag), "status_flag missing!"
+  end
+  
+  test "Status ok" do
+    @test_class = TestClass.new()
+    assert @test_class.status == {:warn => [], :error => []} , "Error: #{@test_class.status.inspect}"
+    assert @test_class.status_flag == :green , "Error: #{@test_class.status_flag.inspect}"
+  end
+  
+  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_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_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_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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_monitor
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Andrea Bignozzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 0
+        - 9
+        version: 3.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Monitor model via private methods warn_*? and error_*?
+email: 
+- skylord73@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_monitor.gemspec
+- app/controllers/acts_as_monitor/monitor_controller.rb
+- app/helpers/monitor_helper.rb
+- app/views/acts_as_monitor/indext.html.erb
+- config/routes.rb
+- lib/acts_as_monitor.rb
+- lib/acts_as_monitor/engine.rb
+- lib/acts_as_monitor/exceptions.rb
+- lib/acts_as_monitor/monitor.rb
+- lib/acts_as_monitor/version.rb
+- lib/generators/acts_as_monitor/install/install_generator.rb
+- lib/generators/acts_as_monitor/install/templates/acts_as_monitor.it.yml
+- lib/generators/acts_as_monitor/install/templates/acts_as_monitor_green.png
+- lib/generators/acts_as_monitor/install/templates/acts_as_monitor_red.png
+- lib/generators/acts_as_monitor/install/templates/acts_as_monitor_yellow.png
+- test/acts_as_monitor.sqlite3.db
+- test/database.yml
+- test/test_helper.rb
+- test/units/acts_as_monitor_test.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Monitor models
+test_files: 
+- test/acts_as_monitor.sqlite3.db
+- test/database.yml
+- test/test_helper.rb
+- test/units/acts_as_monitor_test.rb