log_book 0.0.1 → 0.1.1

data/.gitignore

@@ -15,4 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-db/*sqlite
+test/db/*sqlite

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p286

data/Gemfile

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

data/README.md

@@ -8,9 +8,16 @@ Add this line to your application's Gemfile:
 
     gem "log_book"
 
+As the Model should be loaded after ActiveReccord has established the connection you have to add this:
+
+    # config/application.rb
+    config.after_initialize do
+      require "log_book/event"
+    end
+
 ### Create the table
 
-    rails generate guinea_pig:migration
+    rails generate log_book:migration
     rake db:migrate
 
 ### ActsOnTaggableOn dependency
@@ -31,7 +38,7 @@ For example:
 ## ActiveRecord integration
 
     class MyModel < ActiveRecord::Base
-      log_book_log_book
+      log_book
     end
 
     MyModel.create!   # => LogBook created
@@ -43,6 +50,9 @@ If you want to include _who executes the action_ use the special attribute `log_
     my_model.log_book_historian = current_user
     my_model.save!
 
+## TODO
+
+
 ## Sate of the art
 
 Beta version but already used in production environments

data/lib/generators/log_book/migration_generator.rb

@@ -1,9 +1,9 @@
 require "rails/generators"
 
-class GuineaPig::MigrationGenerator < Rails::Generators::Base
+class LogBook::MigrationGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
-  desc "Generates migration for ABTest model"
+  desc "Generates migration for LogBook::Event model"
 
   def self.source_root
     File.join(File.dirname(__FILE__), "templates")
@@ -20,6 +20,6 @@ class GuineaPig::MigrationGenerator < Rails::Generators::Base
   end
 
   def copy_migration
-    migration_template "create_log_books.rb", "db/migrate/create_log_books.rb"
+    migration_template "create_log_book_events.rb", "db/migrate/create_log_book_events.rb"
   end
 end

data/lib/generators/log_book/templates/create_log_book_events.rb

@@ -5,13 +5,13 @@ class CreateLogBookEvents < ActiveRecord::Migration
       t.string :historian_type
       t.integer :historizable_id
       t.string :historizable_type
-      t.string :text, :null => false
+      t.text :text, :null => false
 
       t.timestamps
     end
   end
 
   def self.down
-    drop_table :log_books
+    drop_table :log_book_events
   end
 end

data/lib/log_book/event.rb

@@ -9,4 +9,6 @@ class LogBook::Event < ::ActiveRecord::Base
   belongs_to :historizable, :polymorphic => true
 
   validates :text, :presence => true
+
+  scope :by_recent, order("id desc")
 end

data/lib/log_book/plugin.rb

@@ -5,10 +5,13 @@ module LogBook::Plugin
   end
 
   module ClassMethods
-    def log_book
+
+    def log_book(opts = {})
       after_create :log_book_event_on_create
       after_update :log_book_event_on_update
-      after_destroy :log_book_event_on_destroy
+      before_destroy :log_book_event_on_destroy
+
+      has_many :log_book_events, :class_name => "LogBook::Event", :as => :historizable, :dependent => (opts[:dependent] || :nullify)
 
       attr_accessor :log_book_historian
     end
@@ -20,26 +23,15 @@ module LogBook::Plugin
     end
 
     def log_book_event_on_update
-      LogBook.updated(self.log_book_historian, self)
+      LogBook.updated(self.log_book_historian, self) unless changes.empty?
     end
 
     def log_book_event_on_destroy
       LogBook.destroyed(self.log_book_historian, self)
     end
-
-    def pretty_changes
-      result =
-        self.previous_changes.reject { |k,v| k == "updated_at" || k =~ /password/ || k == "perishable_token" || k == "persistence_token" }.map do |k,v|
-          old_value = v[0]
-          new_value = v[1]
-
-          old_value = old_value.to_s( :localdb ) if old_value.instance_of? ActiveSupport::TimeWithZone
-          new_value = new_value.to_s( :localdb ) if new_value.instance_of? ActiveSupport::TimeWithZone
-
-          "#{k}[#{old_value} -> #{new_value}]"
-        end.join( ", " )
-
-      result
-    end
   end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include LogBook::Plugin
 end

data/lib/log_book/utils.rb

@@ -0,0 +1,16 @@
+module LogBook::Utils
+  def self.pretty_changes(model)
+    result =
+      model.changes.reject { |k,v| k == "updated_at" || k =~ /password/ || k == "perishable_token" || k == "persistence_token" }.map do |k,v|
+        old_value = v[0]
+        new_value = v[1]
+
+        old_value = old_value.to_s( :localdb ) if old_value.instance_of? ActiveSupport::TimeWithZone
+        new_value = new_value.to_s( :localdb ) if new_value.instance_of? ActiveSupport::TimeWithZone
+
+        "#{k}[#{old_value} -> #{new_value}]"
+      end.join( ", " )
+
+    result
+  end
+end

data/lib/log_book/version.rb

@@ -1,3 +1,3 @@
 module LogBook
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/log_book.rb

@@ -1,9 +1,10 @@
 require "active_record"
+require "active_support/core_ext/module"
+require "protected_attributes"
 require "acts-as-taggable-on"
 require_relative "log_book/version"
-require_relative "log_book/event"
 require_relative "log_book/plugin"
-
+require_relative "log_book/utils"
 
 module LogBook
   OPERATIONS = {
@@ -26,20 +27,20 @@ module LogBook
     )
   end
 
+  private
+
   def self.created(historian, historizable)
     LogBook.event(historian, historizable, "#{historizable.class.name} created", LogBook::OPERATIONS[:create])
   end
 
   def self.updated(historian, historizable)
-    LogBook.event(historian, historizable, "#{historizable.class.name} updated [#{historizable.pretty_changes}]", LogBook::OPERATIONS[:update])
+    LogBook.event(historian, historizable, "#{historizable.class.name} updated [#{LogBook::Utils.pretty_changes(historizable)}]", LogBook::OPERATIONS[:update])
   end
 
   def self.destroyed(historian, historizable)
     LogBook.event(historian, historizable, "#{historizable.class.name} destroyed", LogBook::OPERATIONS[:destroy])
   end
 
-  private
-
   def self.scope_tag(historian)
     historian.class.name.underscore
   end
@@ -49,7 +50,3 @@ module LogBook
   end
 end
 
-ActiveSupport.on_load(:active_record) do
-  include LogBook::Plugin
-end
-

data/log_book.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rails", "~> 3.0"
-  spec.add_runtime_dependency "acts-as-taggable-on"
+  spec.add_runtime_dependency "rails", "~> 4.0.2"
+  spec.add_runtime_dependency "protected_attributes"
+  spec.add_runtime_dependency "acts-as-taggable-on", "2.4.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/log_book_test.rb

@@ -7,25 +7,86 @@ class LogBookTest < MiniTest::Unit::TestCase
     Item.destroy_all
 
     @user = User.create!(:name => "User Name")
-    @item = Item.create!(:title => "Item Title")
+    @item = Item.create!(:title => "Item Title", :log_book_historian => @user)
   end
 
-  def test_event_on_create
-    item = Item.new(:log_book_historian => @user)
-    LogBook.expects(:created).with(@user, item)
+  def test_event
+    assert_difference "LogBook::Event.count", 1 do
+      LogBook.event(@user, @item, "Item wadus", LogBook::OPERATIONS[:create])
+    end
+
+    log_book = LogBook::Event.last
+    assert_equal(@user, log_book.historian)
+    assert_equal(@item, log_book.historizable)
+    assert_equal("Item wadus", log_book.text)
+    assert_equal(["user", "item", "create"].sort, log_book.tag_list.sort)
+  end
+
+  def test_event_with_nils
+    assert_difference "LogBook::Event.count", 1 do
+      LogBook.event(nil, nil, "Item wadus", nil)
+    end
+
+    log_book = LogBook::Event.last
+    assert_equal(nil, log_book.historian)
+    assert_equal(nil, log_book.historizable)
+    assert_equal("Item wadus", log_book.text)
+    assert_equal([], log_book.tag_list)
+  end
+
+  def test_created
+    item = Item.new(:title => "Item Title")
+    item.log_book_historian = @user
+
+    LogBook.expects(:event).with(@user, item, "Item created", LogBook::OPERATIONS[:create])
+
     item.save!
   end
 
-  def test_event_on_update
-    @item.log_book_historian = @user
-    LogBook.expects(:updated).with(@user, @item)
-    @item.update_attributes(:title => "Other Title")
+  def test_updated
+    LogBook.expects(:event).with(@user, @item, "Item updated [title[Item Title -> Other Title]]", LogBook::OPERATIONS[:update])
+
+    @item.update_attributes!(:title => "Other Title")
+  end
+
+  def test_item_destroyed
+    LogBook.expects(:event).with(@user, @item, "Item destroyed", LogBook::OPERATIONS[:destroy])
+
+    @item.destroy
+  end
+
+  def test_has_many_log_book_events
+    LogBook::Event.destroy_all
+
+    log_book_event_1 = LogBook.event(@user, @item, "Item wadus", LogBook::OPERATIONS[:create])
+    log_book_event_2 = LogBook.event(@user, @item, "Item wadus", LogBook::OPERATIONS[:update])
+
+    @item.reload
+
+    assert_equal(2, @item.log_book_events.count)
+    assert_equal(log_book_event_1, @item.log_book_events.first)
+    assert_equal(log_book_event_2, @item.log_book_events.last)
   end
 
-  def test_event_on_destroy
-    @item.log_book_historian = @user
-    LogBook.expects(:destroyed).with(@user, @item)
+  def test_log_book_events_nullify_on_historizable_destroy
+    log_book_event = LogBook.event(@user, @item, "Item wadus", LogBook::OPERATIONS[:create])
+
     @item.destroy
+
+    log_book_event.reload
+
+    assert_equal(true, log_book_event.historizable_id.nil?)
+    assert_equal(true, log_book_event.historizable.nil?)
+    assert_equal("Item", log_book_event.historizable_type)
+  end
+
+  def test_log_book_events_destroy_on_historizable_destroy
+    item_with_opts = ItemWithOpts.new
+    log_book_event = LogBook.event(@user, item_with_opts, "Item wadus", LogBook::OPERATIONS[:create])
+
+    item_with_opts.destroy
+
+    assert_equal(false, LogBook::Event.exists?(log_book_event.id))
   end
 end
 

data/test/models.rb

@@ -3,4 +3,8 @@ end
 
 class Item < ActiveRecord::Base
   log_book
+end
+
+class ItemWithOpts < Item
+  log_book(:dependent => :destroy)
 end

data/test/plugin_test.rb

@@ -0,0 +1,31 @@
+require_relative "test_helper"
+
+class PluginTest < MiniTest::Unit::TestCase
+  def setup
+    LogBook::Event.destroy_all
+    User.destroy_all
+    Item.destroy_all
+
+    @user = User.create!(:name => "User Name")
+    @item = Item.create!(:title => "Item Title")
+  end
+
+  def test_event_on_create
+    item = Item.new(:log_book_historian => @user)
+    LogBook.expects(:created).with(@user, item)
+    item.save!
+  end
+
+  def test_event_on_update
+    @item.log_book_historian = @user
+    LogBook.expects(:updated).with(@user, @item)
+    @item.update_attributes(:title => "Other Title")
+  end
+
+  def test_event_on_destroy
+    @item.log_book_historian = @user
+    LogBook.expects(:destroyed).with(@user, @item)
+    @item.destroy
+  end
+end
+

data/test/test_helper.rb

@@ -1,9 +1,11 @@
 require "minitest/unit"
 require "minitest/autorun"
 require "mocha/setup"
-require "assert_difference"
 require "active_record"
+require "active_support/core_ext/module"
+require "assert_difference"
 require "acts-as-taggable-on"
+require_relative "../lib/log_book"
 
 FileUtils.rm("#{File.dirname(__FILE__)}/db/log_book.sqlite", :force => true)
 
@@ -12,11 +14,11 @@ ActiveRecord::Base.establish_connection(
   :database => "#{File.dirname(__FILE__)}/db/log_book.sqlite"
 )
 
+require_relative "../lib/log_book/event"
+
 require_relative "../lib/generators/log_book/templates/create_log_book_events"
 CreateLogBookEvents.up
 
-require_relative "../lib/log_book"
-
 load("#{File.dirname(__FILE__)}/schema.rb")
 load("#{File.dirname(__FILE__)}/models.rb")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_book
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70266156350280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70266156350280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
-  name: acts-as-taggable-on
-  requirement: &70266156349820 !ruby/object:Gem::Requirement
+  name: protected_attributes
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70266156349820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: acts-as-taggable-on
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70266156349260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +69,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70266156349260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70266156348840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266156348840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70266156348380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266156348380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70266156347940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266156347940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: assert_difference
-  requirement: &70266156347520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +133,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70266156347520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Storing an events log book
 email:
 - fguillen.mail@gmail.com
@@ -96,8 +147,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
-- .rvmrc.example
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,13 +157,13 @@ files:
 - lib/log_book.rb
 - lib/log_book/event.rb
 - lib/log_book/plugin.rb
+- lib/log_book/utils.rb
 - lib/log_book/version.rb
 - log_book.gemspec
 - test/db/.keep
-- test/db/log_book.sqlite
-- test/history_event_test.rb
 - test/log_book_test.rb
 - test/models.rb
+- test/plugin_test.rb
 - test/schema.rb
 - test/test_helper.rb
 homepage: https://github.com/fguillen/LogBook
@@ -137,15 +187,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Storing an events log book
 test_files:
 - test/db/.keep
-- test/db/log_book.sqlite
-- test/history_event_test.rb
 - test/log_book_test.rb
 - test/models.rb
+- test/plugin_test.rb
 - test/schema.rb
 - test/test_helper.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create 1.9.3-p286@log_book

data/.rvmrc.example

@@ -1 +0,0 @@
-rvm use --create 1.9.3-p286@log_book

data/test/history_event_test.rb

@@ -1,54 +0,0 @@
-require_relative "test_helper"
-
-class LogBookTest < MiniTest::Unit::TestCase
-  def setup
-    LogBook::Event.destroy_all
-    User.destroy_all
-    Item.destroy_all
-
-    @user = User.create!(:name => "User Name")
-    @item = Item.create!(:title => "Item Title")
-  end
-
-  def test_event
-    assert_difference "LogBook::Event.count", 1 do
-      LogBook.event(@user, @item, "Item wadus", LogBook::OPERATIONS[:create])
-    end
-
-    log_book = LogBook::Event.last
-    assert_equal(@user, log_book.historian)
-    assert_equal(@item, log_book.historizable)
-    assert_equal("Item wadus", log_book.text)
-    assert_equal(["user", "item", "create"].sort, log_book.tag_list.sort)
-  end
-
-  def test_event_with_nils
-    assert_difference "LogBook::Event.count", 1 do
-      LogBook.event(nil, nil, "Item wadus", nil)
-    end
-
-    log_book = LogBook::Event.last
-    assert_equal(nil, log_book.historian)
-    assert_equal(nil, log_book.historizable)
-    assert_equal("Item wadus", log_book.text)
-    assert_equal([], log_book.tag_list)
-  end
-
-  def test_created
-    LogBook.expects(:event).with("historian", @item, "Item created", LogBook::OPERATIONS[:create])
-    LogBook.created("historian", @item)
-  end
-
-  def test_updated
-    @item.update_attributes!(:title => "Other Title")
-
-    LogBook.expects(:event).with(@user, @item, "Item updated [title[Item Title -> Other Title]]", LogBook::OPERATIONS[:update])
-    LogBook.updated(@user, @item)
-  end
-
-  def test_item_destroyed
-    LogBook.expects(:event).with(@user, @item, "Item destroyed", LogBook::OPERATIONS[:destroy])
-    LogBook.destroyed(@user, @item)
-  end
-end
-