accessorize 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Rafter
+
+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,72 @@
+= Accessorize
+
+Log all data access for your ActiveRecord models
+
+== How does it work?
+
+Sometimes you need to keep rigid logs of who created, updated and even accessed 
+the data in your database. Accessorize simplifies the process by allowing you to 
+register observers for your models declaratively in one place. Each ovbserver
+will save access events to a single table "accessors" which stores the user that 
+is accessing the record, the type of access (create, update, view, destroy) and 
+the id of the record that was accessed.
+
+== Performance
+
+Because accessorize record view level access events it can become very slow. You
+should only enable it for heavily controlled models. For example, if you have an
+index page that lists all patients in your database in a table, a new access
+event is created for every row. Think of the children. 
+
+== Make it work
+
+First you need to install the gem (hosted on Gemcutter):
+
+  sudo gem install accessorize
+
+Then you need to run the generator in your project:
+
+  /my/cool/rails/app $ accessorize
+  
+Then you need to edit the accessorize.rb file in config/initializers. You can 
+control the automatic accessor and meta methods:
+
+  Accessorize.configure do |config|
+    config.accessor = :current_user # default
+    config.meta = :current_meta # default
+  end
+
+Accessorize uses these settings when your model is accessed from a controller. 
+When logging the "accessor_id", it will by default grab the id current_user from 
+the application controller. You can change which method is called and replace it 
+with something custom. 
+
+The meta information has no specific use. It could be used to store the users
+IP address, the current action or route, or really anything you like. Again,
+accessorize will by default try to access the current_meta method on the 
+application controller. You can define this method or point it to something 
+else. If the method does not exist, the meta attribute will be nil for the 
+record.
+
+If you are not saving from a controller you can simply set these values to 
+whatever you like:
+
+  Accessorize::Extension.accessor = 101
+  SomeAccessorizedModel.first
+  Accessorize::Accessor.last.accessor 
+  # => 101
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Rafter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "accessorize"
+    gem.summary = %Q{Log all data access for your ActiveRecord models}
+    gem.description = %Q{Sometimes you need to keep rigid logs of who created, updated and even accessed the data in your database. Accessorize simplifies the process.}
+    gem.email = "jeff@socialrange.org"
+    gem.homepage = "http://github.com/jeffrafter/accessorize"
+    gem.authors = ["Jeff Rafter"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.files = FileList["[A-Z]*", "{generators,lib,rails}/**/*", "test/accessorize_test.rb"] 
+    gem.test_files = FileList["test/accessorize_test.rb"] 
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test => ["generator:cleanup", "generator:accessorize"]) do |task|
+  task.libs << "lib" << "test" << "test/rails/test"
+  task.pattern = "test/**/*_test.rb"
+  task.verbose = true
+end  
+
+namespace :test do
+  Rake::TestTask.new(:database => ["generator:cleanup", "generator:database", "generator:accessorize"]) do |task|
+    task.libs << "lib" << "test"
+    task.pattern = "test/**/*_test.rb"
+    task.verbose = true
+  end  
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+generators = %w(accessorize)
+
+namespace :generator do
+  desc "Cleans up the test app before running the generator"
+  task :cleanup do  
+    FileUtils.rm_rf("test/rails")
+    system "cd test && rails rails"
+
+    # I don't like testing performance!
+    FileUtils.rm_rf("test/rails/test/performance")
+
+    system "echo \"\" >> test/rails/config/environments/test.rb"
+    system "echo \"config.gem 'thoughtbot-shoulda', :lib => 'shoulda'\" >> test/rails/config/environments/test.rb"
+    system "echo \"config.gem 'thoughtbot-factory_girl', :lib => 'factory_girl'\" >> test/rails/config/environments/test.rb"
+
+    # Make a thing
+    system "cd test/rails && ./script/generate scaffold thing name:string mood:string"
+
+    FileUtils.mkdir_p("test/rails/vendor/plugins")
+    accessorize_root = File.expand_path(File.dirname(__FILE__))
+    system("ln -s #{accessorize_root} test/rails/vendor/plugins/accessorize")
+  end
+  
+  desc "Prepares the application with an alternate database" 
+  task :database do
+    puts "==  Configuring the database =================================================="
+    system "cp config/database.yml.sample test/rails/config/database.yml"
+    system "cd test/rails && rake db:migrate:reset"
+  end
+
+  desc "Run the accessorize generator"
+  task :accessorize do
+    system "cd test/rails && ./script/generate accessorize && rake db:migrate db:test:prepare"
+  end
+  
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "accessorize #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/accessorize/accessorize_generator.rb

@@ -0,0 +1,9 @@
+class AccessorizeGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', File.join('db', 'migrate'), :migration_file_name => 'create_accessors' 
+      m.directory File.join('config', 'initializers')
+      m.template 'initializer.rb', File.join('config', 'initializers', 'accessorize.rb')
+    end
+  end
+end

data/generators/accessorize/templates/initializer.rb

@@ -0,0 +1,4 @@
+Accessorize.configure do |config|
+  # Specify the objects that you want to observe with accessorize
+  #   config.observe :patients, :visits, :encounters
+end

data/generators/accessorize/templates/migration.rb

@@ -0,0 +1,25 @@
+class CreateAccessors < ActiveRecord::Migration
+  def self.up
+    create_table :accessors do |t|
+      t.integer :accessor_id
+      t.integer :reference_id
+      t.string  :reference_type
+      t.string  :event
+      t.string  :tag
+      t.text    :meta 
+      t.timestamps
+    end
+ 
+    change_table :accessors do |t|
+      t.index [:reference_id, :reference_type]
+      t.index :accessor_id
+      t.index :event
+      t.index :tag
+      t.index :created_at
+    end
+  end
+ 
+  def self.down
+    drop_table :accessors
+  end
+end

data/lib/accessorize.rb

@@ -0,0 +1,10 @@
+require 'accessorize/accessor'
+require 'accessorize/base'
+require 'accessorize/config'
+require 'accessorize/extension'
+
+module Accessorize
+  def self.configure
+    yield Accessorize::Config
+  end
+end

data/lib/accessorize/accessor.rb

@@ -0,0 +1,4 @@
+module Accessorize
+  class Accessor < ActiveRecord::Base
+  end
+end

data/lib/accessorize/base.rb

@@ -0,0 +1,48 @@
+module Accessorize
+  module Base
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+    
+    module ClassMethods
+      def accessorize
+        send :include, InstanceMethods
+        has_many :accessors, :class_name => 'Accessorize::Accessor', :foreign_key => :reference_id, :conditions => {:reference_type => self.class_name.tableize}
+        after_create :create_access
+        after_update :update_access
+        after_destroy :destroy_access        
+      end
+    end
+    
+    module InstanceMethods
+      def create_access
+        create_accessor('create')
+      end
+
+      def update_access
+        create_accessor('update')
+      end
+
+      def destroy_access
+        create_accessor('destroy')
+      end
+      
+      # This method is a performance killer and we are not expecting the base
+      # model to define it. If it is defined, this will replace it. In general
+      # if you want to define an additional after_find, call accessorize, then
+      # alias_method_chain the after_find.
+      def after_find
+        create_accessor('view')
+      end
+      
+      def create_accessor(event)
+        accessors.create(:event => event,
+          :reference_type => self.class.name.tableize,
+          :accessor_id => Accessorize::Extension.accessor,
+          :meta => Accessorize::Extension.meta)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Accessorize::Base

data/lib/accessorize/config.rb

@@ -0,0 +1,8 @@
+module Accessorize
+  class Config
+    @@meta = :current_meta
+    @@accessor = :current_user
+    cattr_accessor :meta
+    cattr_accessor :accessor
+  end
+end

data/lib/accessorize/extension.rb

@@ -0,0 +1,36 @@
+module Accessorize
+  module Extension
+    @@meta = nil
+    @@accessor = nil
+    
+    def self.included(base)
+      base.before_filter :set_extension_points
+    end
+   
+    def self.meta
+      @@meta.respond_to?(:call) ? @@meta.call : @@meta
+    end
+   
+    def self.accessor
+      @@accessor.respond_to?(:call) ? @@accessor.call : @@accessor
+    end
+   
+    def self.meta=(value)
+      @@meta = value
+    end
+   
+    def self.accessor=(value)
+      @@accessor = value
+    end
+   
+    private
+   
+    def set_extension_points
+      @@meta = lambda { self.send(Accessorize::Config.meta) rescue nil }
+      @@accessor = lambda { self.send(Accessorize::Config.accessor).id rescue nil }
+    end
+  end
+end
+
+ 
+ActionController::Base.send :include, Accessorize::Extension

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'accessorize')

data/test/accessorize_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+# Not really sure when to do this :)
+Thing.accessorize
+Struct.new("User", :id)
+
+class ApplicationController < ActionController::Base
+  def current_user
+    Struct::User.new(87)
+  end
+  
+  def current_meta
+    "Spilled milk"
+  end  
+end
+
+class AccessorizeTest < ActiveSupport::TestCase
+  should "create an accessor record when creating a thing" do
+    assert_difference 'Accessorize::Accessor.count', 1 do
+      Thing.create
+    end
+  end
+
+  should "create an accessor record when updating a thing" do
+    thing = Thing.create
+    assert_difference 'Accessorize::Accessor.count', 1 do
+      thing.update_attributes(:mood => 'Hasslehoffish')
+    end
+  end
+  
+  should "create an accessor record when destroying a thing" do
+    thing = Thing.create
+    assert_difference 'Accessorize::Accessor.count', 1 do
+      thing.destroy
+    end
+  end
+  
+  should "create an accessor record when viewing a thing" do
+    thing = Thing.create
+    assert_difference 'Accessorize::Accessor.count', 1 do
+      mood = Thing.last.mood
+    end
+  end
+
+  should "set the accessor to the current user" do
+    Accessorize::Extension.accessor = 42
+    thing = Thing.create
+    assert_equal 42, Accessorize::Accessor.last.accessor_id
+  end
+
+  should "set the meta to the current meta" do
+    Accessorize::Extension.meta = "We were in the middle of tea"
+    thing = Thing.create
+    assert_equal "We were in the middle of tea", Accessorize::Accessor.last.meta
+  end  
+end
+
+class ThingsControllerTest < ActionController::TestCase
+  test "should set the accessor to the current user" do
+    get :show, :id => things(:one).to_param
+    assert_response :success
+    assert_equal 87, Accessorize::Accessor.last.accessor_id
+  end
+
+  test "should set the meta to the current meta" do
+    get :show, :id => things(:one).to_param
+    assert_response :success
+    assert_equal "Spilled milk", Accessorize::Accessor.last.meta
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: accessorize
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Sometimes you need to keep rigid logs of who created, updated and even accessed the data in your database. Accessorize simplifies the process.
+email: jeff@socialrange.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/accessorize/accessorize_generator.rb
+- generators/accessorize/templates/initializer.rb
+- generators/accessorize/templates/migration.rb
+- lib/accessorize.rb
+- lib/accessorize/accessor.rb
+- lib/accessorize/base.rb
+- lib/accessorize/config.rb
+- lib/accessorize/extension.rb
+- rails/init.rb
+- test/accessorize_test.rb
+has_rdoc: true
+homepage: http://github.com/jeffrafter/accessorize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Log all data access for your ActiveRecord models
+test_files: 
+- test/accessorize_test.rb