best_boy 2.0.3 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 052c16860b6631958848facca1874befa90c03ea
+  data.tar.gz: 691c93a312656f98fc39db8f253fb39acfb3be22
+SHA512:
+  metadata.gz: ef3642b2d03a4399f348563be130118bf95e1da1eb0b8f990b2a6bdfbe3d9fad714205a1f16e9136233092c07d524656529b1ba9eaa45a76685d0389796d6c55
+  data.tar.gz: 3b7ad04877352de616c77193bd897947e4bf374d818d7850089febfa344a76f7ac38ca018e3b322889897443be8e549a2dc4f22dfde7bcfdcd3344273576aee7

data/README.md

@@ -10,7 +10,7 @@ A simple event driven logging for ActiveRecord models.
 What does this gem do?
 ----------------------
 
-best_boy logs "create" and "delete" events as well as custom events triggered in controller actions. It uses an own polimorphic database table to log each event.
+best_boy logs "create" and "delete" events as well as custom events triggered by controller actions. It uses its own polymorphic database table to log each event.
 At the moment, best_boy only provides support for ActiveRecord models.
 
 
@@ -59,6 +59,17 @@ Run the migration
     rake db:migrate
 
 
+Changelog
+---------
+#### 2.1.0
+* Code cleanup - now compatible with RSpec 3 syntax
+* Support a "dry-run" test mode
+* Reduce public methods added by `BestBoy::Eventable` ([#4](https://github.com/Absolventa/best_boy/issues/4))
+* Remove mass-assignments that could cause problems with the protected_attributes gem [#8](https://github.com/Absolventa/best_boy/issues/8)
+* Do not expose mixed-in controller method ([#9](https://github.com/Absolventa/best_boy/issues/9)))
+* Avoid potential callbacks for callbacks switch ([#10](https://github.com/Absolventa/best_boy/issues/10))
+
+
 Update in Version 2
 --------------------------------
 
@@ -107,6 +118,24 @@ This will log custom events for a object and a event phrase. You can specify thi
 
 If no Object is given, it will raise an exception as well as if no event is provided.
 
+#### Test mode
+
+BestBoy features a sandbox mode for your testing environment from version 2.1 onward. It will prevent the creation of BestBoy records. Activate it in your spec_helper.rb or test_helper.rb globally:
+
+    BestBoy.test_mode = true
+
+If you want to test your BestBoy integration, you can run your code like this:
+
+    BestBoy.in_real_mode do
+      # your expectations / asserts
+    end
+
+Conversely, you can also sandbox a specific code block:
+
+    BestBoy.in_test_mode do
+      # database will be spared
+    end
+
 
 BestBoyEvent table
 ------------------
@@ -165,25 +194,23 @@ beginning of Feb 1st, 2010 up to now.
 
 Budget some time for this task, since it can take long if your BestBoyEvent table has grown very big.
 
-Used gems and resource
-----------------------
-[Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4
-
-[Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style
-
-[Winston Teo Yong Wei](https://github.com/winston/google_visualr) Google_Visualr in its version 2.1.2
+Used gems and resources
+-----------------------
+* [Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4
+* [Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style
+* [Winston Teo Yong Wei](https://github.com/winston/google_visualr) Google_Visualr in its version 2.1.2
 
 
 Contributors in alphabetic order
 --------------------------------
-@cseydel
-@danscho
-@neumanrq
+* [carpodaster](https://github.com/carpodaster)
+* [cseydel](https://github.com/cseydel)
+* [danscho](https://github.com/danscho)
+* [neumannrq](https://github.com/neumannrq)
 
 Thanks
 ------
-We are extremely grateful to everyone contributing to this project.
-Big thanks to each contributor on Impressionist. This gem helped me a long way to get here in modelling and creating a gem.
+We ♥ PRs – thanks to everyone contributing to this project. Big thanks to each contributor on Impressionist. This gem helped me ([cseydel](https://github.com/cseydel)) a long way to get here in modelling and creating a gem.
 
 
-See LICENSE.txt for details on licenses.
+See [LICENSE.txt](https://raw.github.com/Absolventa/best_boy/master/LICENSE.txt) for usage and licensing details.

data/lib/best_boy.rb

@@ -1,20 +1,40 @@
 require "best_boy/engine.rb"
 
 module BestBoy
-  # Define ORM
-  mattr_accessor :precompile_assets, :orm, :base_controller, :before_filter,
-                 :skip_before_filter, :skip_after_filter, :custom_redirect
-
-  @@precompile_assets = false
-  @@orm = :active_record
-  @@base_controller = "ApplicationController"
-  @@before_filter = nil
+  mattr_accessor :base_controller, :before_filter, :custom_redirect, :orm,
+    :precompile_assets, :skip_after_filter, :skip_before_filter, :test_mode
+
+  @@base_controller    = "ApplicationController"
+  @@before_filter      = nil
+  @@custom_redirect    = nil
+  @@orm                = :active_record
+  @@precompile_assets  = false
+  @@skip_after_filter  = nil
   @@skip_before_filter = nil
-  @@skip_after_filter = nil
-  @@custom_redirect = nil
+  @@test_mode          = false
 
   # Load configuration from initializer
   def self.setup
     yield self
   end
+
+  def self.in_test_mode(&block)
+    execute_with_test_mode_set_to(true, &block)
+  end
+
+  def self.in_real_mode(&block)
+    execute_with_test_mode_set_to(false, &block)
+  end
+
+  private
+
+  def self.execute_with_test_mode_set_to(test_mode, &block)
+    Mutex.new.synchronize do
+      test_mode_before = self.test_mode
+      self.test_mode = test_mode
+      block.call if block.present?
+      self.test_mode = test_mode_before
+    end
+  end
+
 end

data/lib/best_boy/controllers/best_boy_controller.rb

@@ -1,11 +1,9 @@
 module BestBoyController
   module InstanceMethods
+    protected
+
     def best_boy_event(obj, event, source = nil)
-      if obj.respond_to?("eventable?")
-        obj.trigger_best_boy_event(event, source)
-      else
-        raise "#{obj.class.to_s} is not a best_boy eventable!"
-      end
+      obj.trigger_best_boy_event(event, source)
     end
   end
-end
+end

data/lib/best_boy/engine.rb

@@ -5,7 +5,7 @@ require "google_visualr"
 module BestBoy
   class Engine < ::Rails::Engine
 
-    initializer 'best_boy.assets', :group => :all do |app|
+    initializer 'best_boy.assets', group: :all do |app|
       initializer_path = "#{Rails.root}/config/initializers/best_boy.rb"
       require initializer_path if File.exist? initializer_path
 
@@ -16,10 +16,11 @@ module BestBoy
 
     initializer 'best_boy.model' do |app|
       if BestBoy.orm == :active_record
+        require "best_boy/models/active_record/best_boy/obeys_test_mode.rb"
         require "best_boy/models/active_record/best_boy_event.rb"
         require "best_boy/models/active_record/best_boy/eventable.rb"
-        require "best_boy/models/active_record/best_boy_day_report.rb"
-        require "best_boy/models/active_record/best_boy_month_report.rb"
+        require "best_boy/models/active_record/best_boy/day_report.rb"
+        require "best_boy/models/active_record/best_boy/month_report.rb"
         ActiveRecord::Base.send(:include, BestBoy::Eventable)
       else
         raise "Sorry, best_boy actually only supports ActiveRecord ORM."

data/lib/best_boy/models/active_record/{best_boy_day_report.rb → best_boy/day_report.rb}

@@ -1,6 +1,8 @@
 module BestBoy
   class DayReport < ActiveRecord::Base
 
+    include BestBoy::ObeysTestMode
+
     # db configuration
     #
     #

data/lib/best_boy/models/active_record/best_boy/eventable.rb

@@ -3,19 +3,18 @@ module BestBoy
     extend ActiveSupport::Concern
 
     module ClassMethods
-      attr_accessor :disable_callbacks
-      @disable_callbacks = nil
+      attr_accessor :best_boy_disable_callbacks
 
       def has_a_best_boy(options={})
         # constants
         #
         #
-        @disable_callbacks = options[:disable_callbacks]
+        self.best_boy_disable_callbacks = options[:disable_callbacks]
 
         # associations
         #
         #
-        has_many :best_boy_events, :as => :owner, :dependent => :nullify
+        has_many :best_boy_events, as: :owner, dependent: :nullify
 
         # callbacks
         #
@@ -23,16 +22,14 @@ module BestBoy
         after_create :trigger_create_event
         after_destroy :trigger_destroy_event
       end
-
-      def best_boy_disable_callbacks
-        @disable_callbacks
-      end
     end
 
-    def eventable?
-      true
+    def trigger_best_boy_event type, source = nil
+      create_best_boy_event_with_type(type, source)
     end
 
+    private
+
     def trigger_create_event
       return if self.class.best_boy_disable_callbacks
       create_best_boy_event_with_type "create"
@@ -43,14 +40,13 @@ module BestBoy
       create_best_boy_event_with_type "destroy"
     end
 
-    def trigger_best_boy_event type, source = nil
-      create_best_boy_event_with_type(type, source)
-    end
-
     def create_best_boy_event_with_type type, source = nil
       raise "nil event is not allowed" if type.blank?
-      best_boy_event = BestBoyEvent.new(:event => type, :event_source => source)
-      best_boy_event.owner = self
+      best_boy_event = BestBoyEvent.new do |bbe|
+        bbe.event        = type
+        bbe.event_source = source
+        bbe.owner        = self
+      end
       best_boy_event.save
       report type, source
     end

data/lib/best_boy/models/active_record/{best_boy_month_report.rb → best_boy/month_report.rb}

@@ -1,6 +1,8 @@
 module BestBoy
   class MonthReport < ActiveRecord::Base
 
+    include BestBoy::ObeysTestMode
+
     # db configuration
     #
     #

data/lib/best_boy/models/active_record/best_boy/obeys_test_mode.rb

@@ -0,0 +1,11 @@
+module BestBoy
+  module ObeysTestMode
+    def save(*args)
+      BestBoy.test_mode || super
+    end
+
+    def save!(*args)
+      BestBoy.test_mode || super
+    end
+  end
+end

data/lib/best_boy/models/active_record/best_boy_event.rb

@@ -1,14 +1,16 @@
 class BestBoyEvent < ActiveRecord::Base
 
+  include BestBoy::ObeysTestMode
+
   # associations
   #
   #
-  belongs_to :owner, :polymorphic => true
+  belongs_to :owner, polymorphic: true
 
   # validations
   #
   #
-  validates :event, :presence => true
+  validates :event, presence: true
 
   # scopes
   #

data/lib/best_boy/version.rb

@@ -1,3 +1,3 @@
 module BestBoy
-  VERSION = "2.0.3"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: best_boy
 version: !ruby/object:Gem::Version
-  version: 2.0.3
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - Christoph Seydel, Robin Neumann, Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,39 +41,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: google_visualr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,39 +97,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
   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: kaminari
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -150,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -162,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
 - app/assets/images/best_boy/glyphicons-halflings-white.png
 - app/assets/images/best_boy/glyphicons-halflings.png
 - app/assets/javascripts/best_boy/best_boy.js
@@ -181,14 +150,15 @@ files:
 - app/views/layouts/best_boy_backend.html.erb
 - config/initializers/will_paginate.rb
 - config/routes.rb
+- lib/best_boy.rb
 - lib/best_boy/controllers/best_boy_controller.rb
 - lib/best_boy/engine.rb
+- lib/best_boy/models/active_record/best_boy/day_report.rb
 - lib/best_boy/models/active_record/best_boy/eventable.rb
-- lib/best_boy/models/active_record/best_boy_day_report.rb
+- lib/best_boy/models/active_record/best_boy/month_report.rb
+- lib/best_boy/models/active_record/best_boy/obeys_test_mode.rb
 - lib/best_boy/models/active_record/best_boy_event.rb
-- lib/best_boy/models/active_record/best_boy_month_report.rb
 - lib/best_boy/version.rb
-- lib/best_boy.rb
 - lib/generators/active_record/best_boy_generator.rb
 - lib/generators/active_record/templates/add_event_source_to_best_boy_events_table.rb
 - lib/generators/active_record/templates/create_best_boy_events_table.rb
@@ -201,31 +171,28 @@ files:
 - lib/generators/templates/bootstrap/glyphicons-halflings-white.png
 - lib/generators/templates/bootstrap/glyphicons-halflings.png
 - lib/tasks/recover_report_history.rake
-- Rakefile
-- README.md
 homepage: https://github.com/absolventa/best_boy
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a simple event driven logging for models
 test_files: []