log_book 0.0.1 → 0.6.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eeea49aa6e73b24e651d354848d74e5cab562bc9fd4cfa41179824249ee3bdba
+  data.tar.gz: e2ba899bdb4ec534d3f97ce6164c2c7e62ff0b9667f1396917f09803e8f74fa3
+SHA512:
+  metadata.gz: 6313ed2fa0546d058d45930675dd0c77b11602a5beb5365d024c90adfd96eda90ee80887ec3ea1d1eb975cb1eb2948e544d8b869f28ab576779b2a5a9fe7bb9e
+  data.tar.gz: f3d02963f53897fcd2347054f4ea29ccd48a9319839921ccbb5c51b190db72ee1155fb7cf78eee471a93621f3a1dc805ea08d8fc19e3699d0a8796981fb33961

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -15,4 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-db/*sqlite
+test/db/*sqlite

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.5.1
+
+matrix:
+  fast_finish: true
+  allow_failures:
+  - rvm: 2.5.1

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/Gemfile.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: .
+  specs:
+    log_book (0.5.2)
+      acts-as-taggable-on (>= 8.0)
+      rails (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    acts-as-taggable-on (8.1.0)
+      activerecord (>= 5.0, < 6.2)
+    assert_difference (1.0.0)
+      activesupport (>= 3.0.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.6.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    mocha (1.13.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  assert_difference (~> 1.0)
+  bundler (>= 2.0)
+  log_book!
+  minitest (>= 5.1)
+  mocha (~> 1.13)
+  rake (>= 0.13)
+  sqlite3 (~> 1.0)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -8,14 +8,22 @@ 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
 
     rails generate acts_as_taggable_on:migration
+    # rake acts_as_taggable_on_engine:install:migrations # for version '~> 4.0' or superior
     rake db:migrate
 
 ## Usage
@@ -31,7 +39,7 @@ For example:
 ## ActiveRecord integration
 
     class MyModel < ActiveRecord::Base
-      log_book_log_book
+      log_book
     end
 
     MyModel.create!   # => LogBook created
@@ -43,6 +51,47 @@ If you want to include _who executes the action_ use the special attribute `log_
     my_model.log_book_historian = current_user
     my_model.save!
 
+If you want to _mute_ a model change:
+
+    my_model.log_book_mute = true
+    my_model.save! # No LogBook::Event will be generated
+
+If you want to _mute_ LogBook globally:
+
+    LogBook.mute = true
+    my_model.save! # No LogBook::Event will be generated
+
+If you want to _ignore_ some fields from the changes Event:
+
+    class MyModel < ActiveRecord::Base
+      log_book :ignore => [:my_counter]
+    end
+
+    my_model.update_atttibtes!(:my_counter => 9) # No LogBook::Event will be generated
+
+If you want _LogBook::Events_ to be destroyed on _Model_ destroy:
+
+    class MyModel < ActiveRecord::Base
+      log_book :dependent => :destroy
+    end
+
+In other case the _LogBook::Events_ will remain after _Model_ destroyed.
+
+## Rails Integration
+
+Check this example project to see how LogBook is integrated:
+
+- [Skeleton](https://github.com/fguillen/Skeleton)
+
+## TODO
+
+Use block configuration instead of `model.log_book_historian` do something like:
+
+    LogBook.conf(:log_book_historian => user) do
+      model.save!
+    end
+
+
 ## 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

@@ -1,17 +1,20 @@
-class CreateLogBookEvents < ActiveRecord::Migration
+class CreateLogBookEvents < ActiveRecord::Migration[4.2]
   def self.up
     create_table :log_book_events do |t|
       t.integer :historian_id
       t.string :historian_type
       t.integer :historizable_id
       t.string :historizable_type
-      t.string :text, :null => false
+      t.text :differences, :limit => 16777215 # mediumtext
 
-      t.timestamps
+      t.timestamps :null => false
     end
+
+    add_index :log_book_events, [:historizable_id, :historizable_type, :created_at], :name => "index_log_book_events_on_historizable_and_created_at"
+    add_index :log_book_events, [:created_at]
   end
 
   def self.down
-    drop_table :log_books
+    drop_table :log_book_events
   end
-end
+end

data/lib/log_book/event.rb

@@ -1,12 +1,12 @@
 class LogBook::Event < ::ActiveRecord::Base
   self.table_name = "log_book_events"
 
-  attr_accessible :historian, :historizable, :text, :tag_list
-
   acts_as_taggable
 
-  belongs_to :historian, :polymorphic => true
+  belongs_to :historian, :polymorphic => true, :optional => true
   belongs_to :historizable, :polymorphic => true
 
-  validates :text, :presence => true
+  scope :by_recent, -> { order("id desc") }
+
+  serialize :differences, JSON
 end

data/lib/log_book/plugin.rb

@@ -5,41 +5,44 @@ 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
+      attr_accessor :log_book_mute
+      cattr_accessor :log_book_options
+
+      self.log_book_options = opts
+      self.log_book_options[:ignore] ||= []
+      self.log_book_options[:ignore] << :updated_at # ignoring noisy field
     end
   end
 
   module InstanceMethods
     def log_book_event_on_create
-      LogBook.created(self.log_book_historian, self)
+      LogBook.created(self.log_book_historian, self) if !self.log_book_mute
     end
 
     def log_book_event_on_update
-      LogBook.updated(self.log_book_historian, self)
+      # TODO: this line of code is duplicated
+      if ActiveRecord::VERSION::STRING.to_f >= 5.1
+        clean_changes = saved_changes.select { |k,v| !self.log_book_options[:ignore].include? k.to_sym }
+      else
+        clean_changes = changes.select { |k,v| !self.log_book_options[:ignore].include? k.to_sym }
+      end
+      LogBook.updated(self.log_book_historian, self) if !clean_changes.empty? and !self.log_book_mute
     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
+      LogBook.destroyed(self.log_book_historian, self) if !self.log_book_mute
     end
   end
-end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include LogBook::Plugin
+end

data/lib/log_book/utils.rb

@@ -0,0 +1,27 @@
+module LogBook::Utils
+  def self.pretty_changes(model)
+    # TODO: this line of code is duplicated
+    if ActiveRecord::VERSION::STRING.to_f >= 5.1
+      clean_changes = model.saved_changes.select { |k,v| !model.log_book_options[:ignore].include? k.to_sym }
+    else
+      clean_changes = model.changes.select { |k,v| !model.log_book_options[:ignore].include? k.to_sym }
+    end
+
+    result =
+      clean_changes.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
+
+        {
+          "key" => k,
+          "before" => old_value,
+          "after" => new_value
+        }
+      end
+
+    result
+  end
+end

data/lib/log_book/version.rb

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

data/lib/log_book.rb

@@ -1,9 +1,9 @@
 require "active_record"
+require "active_support/core_ext/module"
 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 = {
@@ -12,7 +12,11 @@ module LogBook
     :destroy => "destroy"
   }
 
-  def self.event(historian, historizable, text, tag_list)
+  @@muted = false
+
+  def self.event(historian, historizable, differences, tag_list)
+    return if @@muted
+
     tag_list_composed = []
     tag_list_composed << scope_tag(historian)   if historian
     tag_list_composed << kind_tag(historizable) if historizable
@@ -21,25 +25,33 @@ module LogBook
     LogBook::Event.create!(
       :historian => historian,
       :historizable => historizable,
-      :text => text,
+      :differences => differences,
       :tag_list => tag_list_composed
     )
   end
 
+  def self.muted=(value)
+    @@muted = value
+  end
+
+  def self.muted
+    @@muted
+  end
+
+  private
+
   def self.created(historian, historizable)
-    LogBook.event(historian, historizable, "#{historizable.class.name} created", LogBook::OPERATIONS[:create])
+    LogBook.event(historian, historizable, nil, 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, 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])
+    LogBook.event(historian, historizable, nil, LogBook::OPERATIONS[:destroy])
   end
 
-  private
-
   def self.scope_tag(historian)
     historian.class.name.underscore
   end
@@ -48,8 +60,3 @@ module LogBook
     historizable.class.name.underscore
   end
 end
-
-ActiveSupport.on_load(:active_record) do
-  include LogBook::Plugin
-end
-

data/log_book.gemspec

@@ -18,12 +18,13 @@ 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", "~> 6.0"
+  spec.add_runtime_dependency "acts-as-taggable-on", ">= 8.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "assert_difference"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", ">= 0.13"
+  spec.add_development_dependency "mocha", "~> 1.13"
+  spec.add_development_dependency "sqlite3", "~> 1.0"
+  spec.add_development_dependency "assert_difference", "~> 1.0"
+  spec.add_development_dependency "minitest", ">= 5.1"
 end

data/test/log_book_test.rb

@@ -1,31 +1,149 @@
 require_relative "test_helper"
 
-class LogBookTest < MiniTest::Unit::TestCase
+class LogBookTest < MiniTest::Test
   def setup
     LogBook::Event.destroy_all
     User.destroy_all
     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, ["DIFFERENCE"], LogBook::OPERATIONS[:create])
+    end
+
+    log_book_event = LogBook::Event.last
+    assert_equal(@user, log_book_event.historian)
+    assert_equal(@item, log_book_event.historizable)
+    assert_equal(["DIFFERENCE"], log_book_event.differences)
+    assert_equal(["user", "item", "create"].sort, log_book_event.tag_list.sort)
+  end
+
+  def test_event_with_nils
+    assert_difference "LogBook::Event.count", 1 do
+      LogBook.event(nil, nil, ["DIFFERENCE"], nil)
+    end
+
+    log_book_event = LogBook::Event.last
+    assert_nil(log_book_event.historian)
+    assert_nil(log_book_event.historizable)
+    assert_equal(["DIFFERENCE"], log_book_event.differences)
+    assert_equal([], log_book_event.tag_list)
+  end
+
+  def test_created
+    item = Item.new(:title => "Item Title")
+    item.log_book_historian = @user
+
+    LogBook.expects(:event).with(@user, item, nil, 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_created_when_muted
+    item = Item.new(:title => "Item Title")
+    item.log_book_mute = true
+
+    LogBook.expects(:event).never
+
+    item.save!
   end
 
-  def test_event_on_destroy
-    @item.log_book_historian = @user
-    LogBook.expects(:destroyed).with(@user, @item)
+  def test_updated
+    differences = [
+      {
+        "key" => "title",
+        "before" => "Item Title",
+        "after" => "Other Title"
+      }
+    ]
+
+    LogBook.expects(:event).with(@user, @item, differences, LogBook::OPERATIONS[:update])
+
+    @item.update!(:title => "Other Title")
+  end
+
+  def test_updated_when_muted
+    LogBook.expects(:event).never
+
+    @item.log_book_mute = true
+    @item.update!(:title => "Other Title")
+  end
+
+  def test_updated_with_ignore_fields
+    differences = [
+      {
+        "key" => "title",
+        "before" => "Item Title",
+        "after" => "Other Title"
+      }
+    ]
+
+    item_with_opts = ItemWithOpts.create!(:title => "Item Title", :my_counter => 0)
+    LogBook.expects(:event).with(@user, item_with_opts, differences, LogBook::OPERATIONS[:update])
+
+    item_with_opts.log_book_historian = @user
+    item_with_opts.update!(:title => "Other Title", :my_counter => 10)
+  end
+
+  def test_item_destroyed
+    LogBook.expects(:event).with(@user, @item, nil, LogBook::OPERATIONS[:destroy])
+
     @item.destroy
   end
-end
 
+  def test_item_destroyed_when_muted
+    LogBook.expects(:event).never
+
+    @item.log_book_mute = true
+    @item.destroy
+  end
+
+  def test_has_many_log_book_events
+    LogBook::Event.destroy_all
+
+    log_book_event_1 = LogBook.event(@user, @item, nil, LogBook::OPERATIONS[:create])
+    log_book_event_2 = LogBook.event(@user, @item, nil, 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_log_book_events_nullify_on_historizable_destroy
+    log_book_event = LogBook.event(@user, @item, nil, 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(true, log_book_event.historizable_type.nil?)
+  end
+
+  def test_log_book_events_destroy_on_historizable_destroy
+    item_with_opts = ItemWithOpts.new
+    log_book_event = LogBook.event(@user, item_with_opts, nil, LogBook::OPERATIONS[:create])
+
+    item_with_opts.destroy
+
+    assert_equal(false, LogBook::Event.exists?(log_book_event.id))
+  end
+
+  def test_created_when_global_muted
+    item = Item.new(:title => "Item Title")
+    LogBook.muted = true
+
+    LogBook::Event.expects(:create!).never
+
+    item.save!
+
+    LogBook.muted = false
+  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, :ignore => [:my_counter])
 end

data/test/plugin_test.rb

@@ -0,0 +1,30 @@
+require_relative "test_helper"
+
+class PluginTest < MiniTest::Test
+  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!(: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/schema.rb

@@ -5,20 +5,28 @@ ActiveRecord::Schema.define :version => 0 do
 
   create_table :items, :force => true do |t|
     t.string :title
+    t.integer :my_counter
   end
 
   # acts-as-taggable-on
-  # https://github.com/mbleigh/acts-as-taggable-on/blob/master/lib/generators/acts_as_taggable_on/migration/templates/active_record/migration.rb
-  create_table :tags do |t|
+  # https://github.com/mbleigh/acts-as-taggable-on/blob/6e1837762f0d60edc9b6c2d92b5a9435f404173f/spec/internal/db/schema.rb
+  create_table :tags, force: true do |t|
     t.string :name
+    t.integer :taggings_count, default: 0
+    t.string :type
   end
+  add_index 'tags', ['name'], name: 'index_tags_on_name', unique: true
 
-  create_table :taggings do |t|
+  create_table :taggings, force: true do |t|
     t.references :tag
-    t.references :taggable, :polymorphic => true
-    t.references :tagger, :polymorphic => true
-    t.string :context, :limit => 128
+    t.references :taggable, polymorphic: true
+    t.references :tagger, polymorphic: true
+    t.string :context, limit: 128
 
     t.datetime :created_at
   end
+
+  add_index 'taggings',
+            ['tag_id', 'taggable_id', 'taggable_type', 'context', 'tagger_id', 'tagger_type'],
+            unique: true, name: 'taggings_idx'
 end

data/test/test_helper.rb

@@ -1,10 +1,15 @@
-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 "minitest/unit"
+require "minitest/autorun"
+require "mocha/mini_test"
+
+require_relative "../lib/log_book"
+
 FileUtils.rm("#{File.dirname(__FILE__)}/db/log_book.sqlite", :force => true)
 
 ActiveRecord::Base.establish_connection(
@@ -12,15 +17,15 @@ 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")
 
-class MiniTest::Unit::TestCase
+class MiniTest::Test
   include AssertDifference
   FIXTURES = File.expand_path("#{File.dirname(__FILE__)}/fixtures")
 end

metadata

@@ -1,93 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: log_book
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.6.3
 platform: ruby
 authors:
 - Fernando Guillen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2021-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70266156350280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70266156350280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: acts-as-taggable-on
-  requirement: &70266156349820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70266156349820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70266156349260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70266156349260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70266156348840 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
-  version_requirements: *70266156348840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70266156348380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
   type: :development
   prerelease: false
-  version_requirements: *70266156348380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70266156347940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70266156347940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: assert_difference
-  requirement: &70266156347520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
   type: :development
   prerelease: false
-  version_requirements: *70266156347520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
 description: Storing an events log book
 email:
 - fguillen.mail@gmail.com
@@ -95,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .rvmrc.example
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -107,45 +141,42 @@ 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
 licenses:
 - MIT
-post_install_message: 
+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.15
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
 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
-