pro_monitor 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'rails', '~> 3.2.12'
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.2"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.12)
+      actionpack (= 3.2.12)
+      mail (~> 2.4.4)
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.7)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.12)
+      actionmailer (= 3.2.12)
+      actionpack (= 3.2.12)
+      activerecord (= 3.2.12)
+      activeresource (= 3.2.12)
+      activesupport (= 3.2.12)
+      bundler (~> 1.0)
+      railties (= 3.2.12)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.5)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.36)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.2)
+  jeweler (~> 1.8.4)
+  rails (~> 3.2.12)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Mack Talcott
+
+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,19 @@
+= pro_monitor
+
+Description goes here.
+
+== Contributing to pro_monitor
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Mack Talcott. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pro_monitor"
+  gem.homepage = "http://github.com/mtalcott/pro_monitor"
+  gem.license = "MIT"
+  gem.summary = %Q{An easily customizable way to monitor, aggregate, and format ActiveRecord model changes for auditing.}
+  gem.description = %Q{An easily customizable way to monitor, aggregate, and format ActiveRecord model changes for auditing.}
+  gem.email = "mtalcott@promantek.com"
+  gem.authors = ["Mack Talcott"]
+
+  # Dependencies
+  gem.add_dependency "rails", "~> 3.2.12"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pro_monitor.rb

@@ -0,0 +1,48 @@
+require "rubygems"
+require "bundler/setup"
+require "rails"
+
+class ProMonitor
+
+  # class_attribute :current_aggregation
+
+  def self.aggregate_changes(options = {})
+    previous_aggregation = self.current_aggregation
+    self.current_aggregation = aggregation = ProMonitor::Aggregation.new
+    begin
+      yield
+    ensure
+      self.current_aggregation = previous_aggregation
+    end
+    aggregation
+  end
+
+  def self.publish_changes(aggregation)
+    ProMonitor::Publisher.new(aggregation).publish
+  end
+
+  def self.aggregate_and_publish
+    aggregation = aggregate_changes do
+      yield
+    end
+    publish_changes(aggregation)
+    aggregation
+  end
+
+  def aggregating?
+    !!current_aggregation
+  end
+
+  def self.config
+    @config ||= ProMonitor::Config.new
+  end
+
+  def self.configure
+    yield(self.config) if block_given?
+  end
+
+  def self.logger
+    Rails.logger
+  end
+
+end

data/lib/pro_monitor/aggregation.rb

@@ -0,0 +1,8 @@
+class ProMonitor::Aggregation < Array
+
+  def <<(thing)
+    ProMonitor.logger.info "Aggregating #{thing.inspect}"
+    super
+  end
+
+end

data/lib/pro_monitor/change.rb

@@ -0,0 +1,110 @@
+class ProMonitor::Change
+
+  def initialize(action, model)
+    @action, @model = action, model
+  end
+
+  [:create, :update, :destroy].each do |action|
+    define_method "#{action}?" do
+      self.action == action
+    end
+  end
+
+  def action
+    @action.to_sym
+  end
+
+  def changes
+    model.changes.with_indifferent_access
+  end
+
+  def model_type
+    model.class.name
+  end
+
+  def model_name
+    ProMonitor.config.name_attributes.each do |name_attribute|
+      return model.send(name_attribute) if model.respond_to?(name_attribute)
+    end
+    model.id.to_s
+  end
+
+  def changes
+    model.previous_changes.symbolize_keys
+  end
+
+  def changed_attribute_names
+    changes.keys
+  end
+
+  def description
+    "#{pretty_model_type} #{model_name} #{pretty_action}"
+  end
+
+  def details
+    return update_details if update?
+  end
+
+  def update_details
+    changes.map do |attribute_name, values|
+      attribute_update_details(attribute_name, values)
+    end
+  end
+
+  def attribute_update_details(attribute_name, values)
+    i18n_args = {
+      attribute_name: pretty_attribute_name(attribute_name),
+      from: pretty_attribute(attribute_name, values.first),
+      to: pretty_attribute(attribute_name, values.last),
+      scope: :pro_monitor
+    }
+    i18n(:attribute_change, i18n_args)
+  end
+
+  def model_name_i18n_key
+    model_type.underscore
+  end
+
+  def pretty_model_type
+    i18n(model_name_i18n_key, default: model_name_i18n_key.humanize)
+  end
+
+  def date_format
+    '%m/%d/%Y'
+  end
+
+  def time_format
+    '%m/%d/%Y %I:%M:%S %p'
+  end
+
+  def pretty_attribute(attribute_name, value)
+    if value.is_a?(Date)
+      I18n.l(value, format: date_format)
+    elsif value.is_a?(DateTime)
+      I18n.l(value, format: time_format)
+    else
+      value.to_s
+    end
+  end
+
+  def pretty_attribute_name(attribute_name)
+    i18n(attribute_name, default: attribute_name.humanize)
+  end
+
+  def default_pretty_action
+    case action
+      when :create then "created"
+      when :update then "updated"
+      when :destroy then "deleted"
+    end
+  end
+
+  def pretty_action
+    i18n(action, default: default_pretty_action)
+  end
+
+  def i18n(key, options = {})
+    I18n.t(key, options)
+  end
+
+end

data/lib/pro_monitor/config.rb

@@ -0,0 +1,24 @@
+class ProMonitor::Config
+
+  attr_writer :name_attributes, :description_output, :monitored_models, :load
+
+  def name_attributes
+    [:name, :title]
+  end
+
+  # :html, :text
+  def description_output
+    @description_output || :html
+  end
+
+  # ['User']
+  def monitored_models
+    @monitored_models || []
+  end
+
+  # ['UserChange', 'ReviewSetChange']
+  def load
+    @load || []
+  end
+
+end

data/lib/pro_monitor/observer.rb

@@ -0,0 +1,25 @@
+class ProMonitor::Observer < ActiveRecord::Observer
+
+  observe :user, :review_set, :contact, :employee_plan, :appraisal, :review
+
+  def after_create(model)
+    handle_action(:create, model)
+  end
+
+  def after_update(model)
+    handle_action(:update, model)
+  end
+
+  def after_destroy(model)
+    handle_action(:destroy, model)
+  end
+
+  private
+
+  def handle_action(action, model)
+    return unless ProMonitor.aggregating?
+    change = ProMonitor::Change.new(action, model)
+    ProMonitor.current_aggregation << change
+  end
+
+end

data/lib/pro_monitor/publisher.rb

@@ -0,0 +1,13 @@
+class ProMonitor::Publisher
+
+  attr_reader :changes
+
+  def initialize(changes)
+    @changes = changes
+  end
+
+  def publish
+    ProMonitor.logger.info "Publishing #{changes}"
+  end
+
+end

data/pro_monitor.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "pro_monitor"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mack Talcott"]
+  s.date = "2013-03-09"
+  s.description = "An easily customizable way to monitor, aggregate, and format ActiveRecord model changes for auditing."
+  s.email = "mtalcott@promantek.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/pro_monitor.rb",
+    "lib/pro_monitor/aggregation.rb",
+    "lib/pro_monitor/change.rb",
+    "lib/pro_monitor/config.rb",
+    "lib/pro_monitor/observer.rb",
+    "lib/pro_monitor/publisher.rb",
+    "pro_monitor.gemspec",
+    "spec/pro_monitor_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/mtalcott/pro_monitor"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "An easily customizable way to monitor, aggregate, and format ActiveRecord model changes for auditing."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.2.12"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, ["~> 3.2.12"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.2.12"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rails>, ["~> 3.2.12"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.2.12"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rails>, ["~> 3.2.12"])
+  end
+end
+

data/spec/pro_monitor_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ProMonitor" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'pro_monitor'
+
+require 'simplecov'
+SimpleCov.start 'rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: pro_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mack Talcott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+description: An easily customizable way to monitor, aggregate, and format ActiveRecord
+  model changes for auditing.
+email: mtalcott@promantek.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pro_monitor.rb
+- lib/pro_monitor/aggregation.rb
+- lib/pro_monitor/change.rb
+- lib/pro_monitor/config.rb
+- lib/pro_monitor/observer.rb
+- lib/pro_monitor/publisher.rb
+- pro_monitor.gemspec
+- spec/pro_monitor_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mtalcott/pro_monitor
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3921483793008849252
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An easily customizable way to monitor, aggregate, and format ActiveRecord
+  model changes for auditing.
+test_files: []