log_book 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+db/*sqlite

data/.rvmrc

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

data/.rvmrc.example

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Guillen
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# LogBook
+
+Storing an events log book.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "log_book"
+
+### Create the table
+
+    rails generate guinea_pig:migration
+    rake db:migrate
+
+### ActsOnTaggableOn dependency
+
+    rails generate acts_as_taggable_on:migration
+    rake db:migrate
+
+## Usage
+
+In any point:
+
+    LogBook.event(<who executes the action>, <over which object>, <text>, <list of tags>)
+
+For example:
+
+    LogBook.event(current_user, item, "Item canceled", [:purchase, :canceled])
+
+## ActiveRecord integration
+
+    class MyModel < ActiveRecord::Base
+      log_book_log_book
+    end
+
+    MyModel.create!   # => LogBook created
+    my_model.save!    # => LogBook created
+    my_model.destroy! # => LogBook created
+
+If you want to include _who executes the action_ use the special attribute `log_book_historian`:
+
+    my_model.log_book_historian = current_user
+    my_model.save!
+
+## Sate of the art
+
+Beta version but already used in production environments

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "."
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/generators/log_book/migration_generator.rb

@@ -0,0 +1,25 @@
+require "rails/generators"
+
+class GuineaPig::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Generates migration for ABTest model"
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), "templates")
+  end
+
+  def self.next_migration_number(dirname) #:nodoc:
+    migration_number_attempt = Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    if ActiveRecord::Base.timestamped_migrations && migration_number_attempt > current_migration_number(dirname).to_s
+      migration_number_attempt
+    else
+      serial_migration_number(dirname)
+    end
+  end
+
+  def copy_migration
+    migration_template "create_log_books.rb", "db/migrate/create_log_books.rb"
+  end
+end

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

@@ -0,0 +1,17 @@
+class CreateLogBookEvents < ActiveRecord::Migration
+  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.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :log_books
+  end
+end

data/lib/log_book/event.rb

@@ -0,0 +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 :historizable, :polymorphic => true
+
+  validates :text, :presence => true
+end

data/lib/log_book/plugin.rb

@@ -0,0 +1,45 @@
+module LogBook::Plugin
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  module ClassMethods
+    def log_book
+      after_create :log_book_event_on_create
+      after_update :log_book_event_on_update
+      after_destroy :log_book_event_on_destroy
+
+      attr_accessor :log_book_historian
+    end
+  end
+
+  module InstanceMethods
+    def log_book_event_on_create
+      LogBook.created(self.log_book_historian, self)
+    end
+
+    def log_book_event_on_update
+      LogBook.updated(self.log_book_historian, self)
+    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

data/lib/log_book/version.rb

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

data/lib/log_book.rb

@@ -0,0 +1,55 @@
+require "active_record"
+require "acts-as-taggable-on"
+require_relative "log_book/version"
+require_relative "log_book/event"
+require_relative "log_book/plugin"
+
+
+module LogBook
+  OPERATIONS = {
+    :create => "create",
+    :update => "update",
+    :destroy => "destroy"
+  }
+
+  def self.event(historian, historizable, text, tag_list)
+    tag_list_composed = []
+    tag_list_composed << scope_tag(historian)   if historian
+    tag_list_composed << kind_tag(historizable) if historizable
+    tag_list_composed += [tag_list].flatten     if tag_list
+
+    LogBook::Event.create!(
+      :historian => historian,
+      :historizable => historizable,
+      :text => text,
+      :tag_list => tag_list_composed
+    )
+  end
+
+  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])
+  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
+
+  def self.kind_tag(historizable)
+    historizable.class.name.underscore
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include LogBook::Plugin
+end
+

data/log_book.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_book/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_book"
+  spec.version       = LogBook::VERSION
+  spec.authors       = ["Fernando Guillen"]
+  spec.email         = ["fguillen.mail@gmail.com"]
+  spec.description   = "Storing an events log book"
+  spec.summary       = "Storing an events log book"
+  spec.homepage      = "https://github.com/fguillen/LogBook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_runtime_dependency "rails", "~> 3.0"
+  spec.add_runtime_dependency "acts-as-taggable-on"
+
+  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"
+end

data/test/history_event_test.rb

@@ -0,0 +1,54 @@
+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
+

data/test/log_book_test.rb

@@ -0,0 +1,31 @@
+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_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/models.rb

@@ -0,0 +1,6 @@
+class User < ActiveRecord::Base
+end
+
+class Item < ActiveRecord::Base
+  log_book
+end

data/test/schema.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :users, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :items, :force => true do |t|
+    t.string :title
+  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|
+    t.string :name
+  end
+
+  create_table :taggings do |t|
+    t.references :tag
+    t.references :taggable, :polymorphic => true
+    t.references :tagger, :polymorphic => true
+    t.string :context, :limit => 128
+
+    t.datetime :created_at
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "mocha/setup"
+require "assert_difference"
+require "active_record"
+require "acts-as-taggable-on"
+
+FileUtils.rm("#{File.dirname(__FILE__)}/db/log_book.sqlite", :force => true)
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => "#{File.dirname(__FILE__)}/db/log_book.sqlite"
+)
+
+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
+  include AssertDifference
+  FIXTURES = File.expand_path("#{File.dirname(__FILE__)}/fixtures")
+end
+

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: log_book
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70266156350280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266156350280
+- !ruby/object:Gem::Dependency
+  name: acts-as-taggable-on
+  requirement: &70266156349820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266156349820
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70266156349260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70266156349260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70266156348840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70266156348840
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70266156348380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70266156348380
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70266156347940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70266156347940
+- !ruby/object:Gem::Dependency
+  name: assert_difference
+  requirement: &70266156347520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70266156347520
+description: Storing an events log book
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .rvmrc.example
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/log_book/migration_generator.rb
+- lib/generators/log_book/templates/create_log_book_events.rb
+- lib/log_book.rb
+- lib/log_book/event.rb
+- lib/log_book/plugin.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/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/fguillen/LogBook
+licenses:
+- MIT
+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
+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/schema.rb
+- test/test_helper.rb