notifiably_audited 0.0.1 → 0.0.2

data/lib/audited/rspec_matchers.rb

@@ -0,0 +1,173 @@
+module Audited
+  module RspecMatchers
+    # Ensure that the model is audited.
+    #
+    # Options:
+    # * <tt>associated_with</tt> - tests that the audit makes use of the associated_with option
+    # * <tt>only</tt> - tests that the audit makes use of the only option *Overrides <tt>except</tt> option*
+    # * <tt>except</tt> - tests that the audit makes use of the except option
+    # * <tt>requires_comment</tt> - if specified, then the audit must require comments through the <tt>audit_comment</tt> attribute
+    # * <tt>on</tt> - tests that the audit makes use of the on option with specified parameters
+    #
+    # Example:
+    #   it { should be_audited }
+    #   it { should be_audited.associated_with(:user) }
+    #   it { should be_audited.only(:field_name) }
+    #   it { should be_audited.except(:password) }
+    #   it { should be_audited.requires_comment }
+    #   it { should be_audited.on(:create).associated_with(:user).except(:password) }
+    #
+    def be_audited
+      AuditMatcher.new
+    end
+
+    # Ensure that the model has associated audits
+    #
+    # Example:
+    #   it { should have_associated_audits }
+    #
+    def have_associated_audits
+      AssociatedAuditMatcher.new
+    end
+
+    class AuditMatcher # :nodoc:
+      def initialize
+        @options = {}
+      end
+
+      def associated_with(model)
+        @options[:associated_with] = model
+        self
+      end
+
+      def only(*fields)
+        @options[:only] = fields.flatten
+        self
+      end
+
+      def except(*fields)
+        @options[:except] = fields.flatten
+        self
+      end
+
+      def requires_comment
+        @options[:comment_required] = true
+        self
+      end
+
+      def on(*actions)
+        @options[:on] = actions.flatten
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject
+        auditing_enabled? &&
+          associated_with_model? &&
+          records_changes_to_specified_fields? &&
+          comment_required_valid?
+      end
+
+      def failure_message
+        "Expected #{@expectation}"
+      end
+
+      def negative_failure_message
+        "Did not expect #{@expectation}"
+      end
+
+      def description
+        description = "audited"
+        description += " associated with #{@options[:associated_with]}" if @options.key?(:associated_with)
+        description += " only => #{@options[:only].join ', '}"          if @options.key?(:only)
+        description += " except => #{@options[:except].join(', ')}"     if @options.key?(:except)
+        description += " requires audit_comment"                        if @options.key?(:comment_required)
+
+        description
+      end
+
+      protected
+
+      def expects(message)
+        @expectation = message
+      end
+
+      def auditing_enabled?
+        expects "#{model_class} to be audited"
+        model_class.respond_to?(:auditing_enabled) && model_class.auditing_enabled
+      end
+
+      def model_class
+        @subject.class
+      end
+
+      def associated_with_model?
+        expects "#{model_class} to record audits to associated model #{@options[:associated_with]}"
+        model_class.audit_associated_with == @options[:associated_with]
+      end
+
+      def records_changes_to_specified_fields?
+        if @options[:only] || @options[:except]
+          if @options[:only]
+            except = model_class.column_names - @options[:only].map(&:to_s)
+          else
+            except = model_class.default_ignored_attributes + Audited.ignored_attributes
+            except |= @options[:except].collect(&:to_s) if @options[:except]
+          end
+
+          expects "non audited columns (#{model_class.non_audited_columns.inspect}) to match (#{expect})"
+          model_class.non_audited_columns =~ except
+        else
+          true
+        end
+      end
+
+      def comment_required_valid?
+        if @options[:comment_required]
+          @subject.audit_comment = nil
+
+          expects "to be invalid when audit_comment is not specified"
+          @subject.valid? == false && @subject.errors.key?(:audit_comment)
+        else
+          true
+        end
+      end
+    end
+
+    class AssociatedAuditMatcher # :nodoc:
+      def matches?(subject)
+        @subject = subject
+
+        association_exists?
+      end
+
+      def failure_message
+        "Expected #{model_class} to have associated audits"
+      end
+
+      def negative_failure_message
+        "Expected #{model_class} to not have associated audits"
+      end
+
+      def description
+        "has associated audits"
+      end
+
+      protected
+
+      def model_class
+        @subject.class
+      end
+
+      def reflection
+        model_class.reflect_on_association(:associated_audits)
+      end
+
+      def association_exists?
+        (!reflection.nil?) &&
+          reflection.macro == :has_many &&
+          reflection.options[:class_name] == Audited.audit_class.name
+      end
+    end
+  end
+end

data/lib/audited/sweeper.rb

@@ -0,0 +1,51 @@
+module Audited
+  class Sweeper < ActiveModel::Observer
+    observe Audited.audit_class
+
+    def before(controller)
+      self.controller = controller
+      true
+    end
+
+    def after(controller)
+      self.controller = nil
+    end
+
+    def before_create(audit)
+      audit.user ||= current_user
+      audit.remote_address = controller.try(:request).try(:ip)
+    end
+
+    def current_user
+      controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true)
+    end
+
+    def add_observer!(klass)
+      super
+      define_callback(klass)
+    end
+
+    def define_callback(klass)
+      observer = self
+      callback_meth = :"_notify_audited_sweeper"
+      klass.send(:define_method, callback_meth) do
+        observer.update(:before_create, self)
+      end
+      klass.send(:before_create, callback_meth)
+    end
+
+    def controller
+      ::Audited.store[:current_controller]
+    end
+
+    def controller=(value)
+      ::Audited.store[:current_controller] = value
+    end
+  end
+end
+
+if defined?(ActionController) and defined?(ActionController::Base)
+  ActionController::Base.class_eval do
+    around_filter Audited::Sweeper.instance
+  end
+end

data/notifiably_audited.gemspec

@@ -1,30 +1,23 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-#require 'notifiably_audited/version'
+require 'notifiably_audited/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "notifiably_audited"
   spec.version       = NotifiablyAudited::VERSION
-  spec.authors       = ["senthil kumar"]
-  spec.email         = ["senthilkumar.hce@gmail.com"]
-  spec.summary       = %q{It audits and notifies}
-  spec.description   = %q{TODO}
+  spec.authors       = ["TODO: Write your name"]
+  spec.email         = ["TODO: Write your email address"]
+  spec.summary       = %q{TODO: Write a short summary. Required.}
+  spec.description   = %q{TODO: Write a longer description. Optional.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  gem.add_development_dependency 'activerecord', '~> 3.0'
-  gem.add_development_dependency 'appraisal', '~> 0.4'
-  gem.add_development_dependency 'bson_ext', '~> 1.6'
-  gem.add_development_dependency 'mongo_mapper', '~> 0.11'
-  gem.add_development_dependency 'rails', '~> 3.0'
-  gem.add_development_dependency 'rspec-rails', '~> 2.0'
-  gem.add_development_dependency 'sqlite3', '~> 1.0'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.files         = `git ls-files`.split($\).reject{|f| f =~ /(lib\/audited\-|adapters|generators)/ }
-  gem.test_files    = gem.files.grep(/^spec\//)
-  gem.require_paths = ['lib']
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
 end
-
-
-

data/spec/audited_spec_helpers.rb

@@ -0,0 +1,31 @@
+module AuditedSpecHelpers
+
+  def create_user(use_mongo = false, attrs = {})
+    klass = use_mongo ? Models::MongoMapper::User : Models::ActiveRecord::User
+    klass.create({:name => 'Brandon', :username => 'brandon', :password => 'password'}.merge(attrs))
+  end
+
+  def create_versions(n = 2, use_mongo = false)
+    klass = use_mongo ? Models::MongoMapper::User : Models::ActiveRecord::User
+
+    klass.create(:name => 'Foobar 1').tap do |u|
+      (n - 1).times do |i|
+        u.update_attribute :name, "Foobar #{i + 2}"
+      end
+      u.reload
+    end
+  end
+
+  def create_active_record_user(attrs = {})
+    create_user(false, attrs)
+  end
+
+  def create_mongo_user(attrs = {})
+    create_user(true, attrs)
+  end
+
+  def create_mongo_versions(n = 2)
+    create_versions(n, true)
+  end
+
+end

data/spec/rails_app/config/application.rb

@@ -0,0 +1,5 @@
+module RailsApp
+  class Application < Rails::Application
+    config.root = File.expand_path('../../', __FILE__)
+  end
+end

data/spec/rails_app/config/database.yml

@@ -0,0 +1,24 @@
+sqlite3mem: &SQLITE3MEM
+  adapter: sqlite3
+  database: ":memory:"
+
+sqlite3: &SQLITE
+  adapter: sqlite3
+  database: audited_test.sqlite3.db
+
+postgresql: &POSTGRES
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: audited_test
+  min_messages: ERROR
+
+mysql: &MYSQL
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: audited_test
+
+test:
+  <<: *<%= ENV['DB'] || 'SQLITE3MEM' %>

data/spec/rails_app/config/environment.rb

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

data/spec/rails_app/config/environments/development.rb

@@ -0,0 +1,19 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+end

data/spec/rails_app/config/environments/production.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+end

data/spec/rails_app/config/environments/test.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  config.action_dispatch.show_exceptions = false
+
+  config.active_support.deprecation = :stderr
+end

data/spec/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!

data/spec/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,2 @@
+ActiveSupport::Inflector.inflections do |inflect|
+end

data/spec/rails_app/config/initializers/secret_token.rb

@@ -0,0 +1,2 @@
+Rails.application.config.secret_token = 'ea942c41850d502f2c8283e26bdc57829f471bb18224ddff0a192c4f32cdf6cb5aa0d82b3a7a7adbeb640c4b06f3aa1cd5f098162d8240f669b39d6b49680571'
+Rails.application.config.session_store :cookie_store, :key => "_my_app"