has_logs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0516f9656458af72a2042060e87ae6a7252fad6
-  data.tar.gz: 1eb28b3e1cd5e84184191c4711a5df7f5466ece0
+  metadata.gz: 684408e9337f822cc71662e3ec453f2835bb90cc
+  data.tar.gz: fbb2ae959fc6a35956192512ce4173b760dfce63
 SHA512:
-  metadata.gz: 162d25cbbf867d35ec009e726eb9b0ce7da855eceef0fba95df3338bcd058ae89e8e40ae1d62f21108c855fbeab1627b0c4e31ada17fbd7692eab8048c15107e
-  data.tar.gz: aaffb45bcedd6103e14444d172d4dd59a336a0468ebcd33952b7f2a9c62efaa125b60b510aa9588bb1c9f35e9ae373adb90085a7320e5e3188649abd72b54ef0
+  metadata.gz: a5703d9075b5e7776ec7aea6908ee1f956af467ce79571f562146d60f3d9386a989552830e3ef7ccdc228a8fa923d0a8a25e2b69dd6219a0520e3a0e6077385d
+  data.tar.gz: c4f60a6f250708a0f8d9de94864a663c56c40219fb9746bf994c16029aad66c10f2ff009f2c0c2e2e2bfe41bc421dd200d7f421e1ece6f71b994df028485d5cb

data/.travis.yml

@@ -1,5 +1,19 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.1.9
+  - 2.2.5
   - 2.3.1
+gemfile:
+  - gemfiles/activerecord_4.2.5.gemfile
+  - gemfiles/activerecord_5.0.0.gemfile
+matrix:
+  exclude:
+  - rvm: 2.1.9
+    gemfile: gemfiles/activerecord_5.0.0.gemfile
+  - rvm: 2.2.5
+    gemfile: gemfiles/activerecord_5.0.0.gemfile
+  - rvm: 2.3.1
+    gemfile: gemfiles/activerecord_4.2.5.gemfile
 before_install: gem install bundler -v 1.12.5
+script: "bundle exec rspec"

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "activerecord-4.2.5" do
+  gem "activesupport", "4.2.5"
+  gem "activerecord", "4.2.5"
+end
+
+appraise "activerecord-5.0.0" do
+  gem "activesupport", "5.0.0"
+  gem "activerecord", "5.0.0"
+end

data/README.md

@@ -1,8 +1,8 @@
 # HasLogs
 
-Logging your ActiveRecord model, and supply useful methods.
+[![Build Status](https://travis-ci.org/isuke/has_logs.svg?branch=master)](https://travis-ci.org/isuke/has_logs)
 
-TODO: Delete this and the text above, and describe your gem
+Logging your ActiveRecord model, and supply useful methods.
 
 ## Installation
 
@@ -48,7 +48,7 @@ class CreateAllTables < ActiveRecord::Migration
 end
 ```
 
-## Model Class
+### Model Class
 
 ```ruby
 class Article < ActiveRecord::Base
@@ -60,7 +60,7 @@ class ArticleLog < ActiveRecord::Base
 end
 ```
 
-## Usage Examples
+### Usage Examples
 
 ```ruby
 article = Article.create(title: 'test1', content: 'demo1', public: false)
@@ -88,6 +88,173 @@ article.latest_log.prev
 => #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">
 ```
 
+#### Originator Methods
+
+| Methods       | Describe            |
+| ------------- | ------------------- |
+| logs          | get the log list    |
+| latest_log    | get the latest log  |
+| oldest_log    | get the oldest log  |
+
+#### Log Methods
+
+| Methods       | Describe                 |
+| ------------- | ------------------------ |
+| originator    | get the originator model |
+| next          | get a next log           |
+| prev          | get a prev log           |
+
+## Other Naming Example
+
+### Migration
+
+```ruby
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.timestamps
+    end
+
+    create_table(:user_histories) do |t|
+      t.integer :user_id, null: false
+      t.string :name, null: false
+      t.datetime :created_at
+    end
+    add_index :user_logs,  :user_id
+    add_index :user_logs, [:user_id, :created_at], unique: true
+  end
+end
+```
+
+### Model Class
+
+```ruby
+class User < ActiveRecord::Base
+  has_logs_as 'UserHistory'
+end
+
+class UserHistory < ActiveRecord::Base
+  act_as_log_of 'User'
+end
+```
+
+## Duplicate Type Example
+
+### Migration
+
+```ruby
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:tasks) do |t|
+      t.string :name, null: false
+      t.timestamps
+    end
+    create_table(:task_logs) do |t|
+      t.integer :task_id, null: false
+      t.string :name, null: false
+      t.datetime :created_at
+    end
+    add_index :task_logs,  :task_id
+    add_index :task_logs, [:task_id, :created_at], unique: true
+  end
+end
+```
+
+### Model Class
+
+```ruby
+class Task < ActiveRecord::Base
+  has_logs have_type: :duplicate
+end
+class TaskLog < ActiveRecord::Base
+  act_as_log
+end
+```
+
+### Usage Examples
+
+```
+task  = Task.create(name: 'name1')
+task.attributes = { name: 'name2' } ; task.save!
+task.attributes = { name: 'name3' } ; task.save!
+
+Task.all
+=>
++----+-------+
+| id | name  |
++----+-------+
+|  1 | name3 |
++----+-------+
+
+TaskLog.all
+=>
++----+---------+-------+
+| id | task_id | name  |
++----+---------+-------+
+|  1 |       1 | name1 |
+|  2 |       1 | name2 |
+|  3 |       1 | name3 |
++----+---------+-------+
+```
+
+## Mutual Type Example
+
+### Migration
+
+```ruby
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:posts) do |t|
+      t.string :name, null: false
+      t.timestamps
+    end
+    create_table(:post_logs) do |t|
+      t.integer :post_id, null: false
+      t.string :name, null: false
+      t.datetime :created_at
+    end
+    add_index :post_logs,  :post_id
+    add_index :post_logs, [:post_id, :created_at], unique: true
+  end
+end
+```
+
+### Model Class
+
+```ruby
+class Post < ActiveRecord::Base
+  has_logs have_type: :mutual
+end
+class PostLog < ActiveRecord::Base
+  act_as_log
+end
+```
+
+### Usage Examples
+
+```
+post  = Post.create(name: 'name1')
+post.attributes = { name: 'name2' } ; post.save!
+post.attributes = { name: 'name3' } ; post.save!
+
+Post.all
+=>
++----+-------+
+| id | name  |
++----+-------+
+|  1 | name3 |
++----+-------+
+
+PostLog.all
+=>
++----+---------+-------+
+| id | post_id | name  |
++----+---------+-------+
+|  1 |       1 | name1 |
+|  2 |       1 | name2 |
++----+---------+-------+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/gemfiles/activerecord_4.2.5.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.2.5"
+gem "activerecord", "4.2.5"
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.2.5.gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: ../
+  specs:
+    has_logs (0.5.0)
+      activerecord (> 3.0)
+      activesupport (> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.3)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.9.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.2.5)
+  activesupport (= 4.2.5)
+  appraisal (~> 2.1)
+  bundler (~> 1.12)
+  has_logs!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.2)
+  shoulda (~> 3.5)
+  sqlite3 (~> 1.0)
+
+BUNDLED WITH
+   1.12.5

data/gemfiles/activerecord_5.0.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "5.0.0"
+gem "activerecord", "5.0.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_5.0.0.gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: ../
+  specs:
+    has_logs (0.5.0)
+      activerecord (> 3.0)
+      activesupport (> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activerecord (5.0.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      arel (~> 7.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.0)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    minitest (5.9.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.0.0)
+  activesupport (= 5.0.0)
+  appraisal (~> 2.1)
+  bundler (~> 1.12)
+  has_logs!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.2)
+  shoulda (~> 3.5)
+  sqlite3 (~> 1.0)
+
+BUNDLED WITH
+   1.12.5

data/has_logs.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "shoulda", "~> 3.5"
   spec.add_development_dependency "sqlite3", "~> 1.0"
+  spec.add_development_dependency "appraisal", "~> 2.1"
 end

data/lib/has_logs/has_logs.rb

@@ -13,31 +13,37 @@ module HasLogs
         return if self.included_modules.include?(HasLogs::InstanceMethods)
         include HasLogs::InstanceMethods
 
-        cattr_accessor :log_class_name, :log_foreign_key, :log_table_name, :logging_attrs
+        cattr_accessor :have_type, :log_class_name, :log_foreign_key, :log_table_name, :logging_attrs
+
+        self.have_type = options.delete(:have_type) || :default
 
         self.log_class_name  = options[:class_name]  || "#{self.name}Log"
         self.log_foreign_key = options[:foreign_key] || "#{self.name}Id".underscore
 
-        self.logging_attrs = (log_class.column_names - [log_class.primary_key, "#{self.name}Id".underscore, 'created_at'])
+        self.logging_attrs = (log_class.column_names - [log_class.primary_key, "#{self.name}Id".underscore, 'created_at', 'updated_at'])
 
         class_eval do
           has_many :logs, options.merge(class_name: log_class_name, foreign_key: log_foreign_key)
-          after_find   :set_attrs
-          after_create :create_log
-          after_update :create_log
+          after_find   :set_attrs if %i(default).include? have_type
+          before_create :create_log
+          before_update :create_log
 
-          logging_attrs.each do |attr|
-            attr_accessor attr
-            define_method "#{attr}?" do
-              public_send(:attr).present?
-            end
-          end
+          define_attrs(logging_attrs) if %i(default).include? have_type
         end
       end
 
       def log_class
         log_class_name.constantize
       end
+
+      def define_attrs(attrs)
+        attrs.each do |attr|
+          attr_accessor attr
+          define_method "#{attr}?" do
+            public_send(:attr).present?
+          end
+        end
+      end
     end
 
     module InstanceMethods
@@ -50,11 +56,14 @@ module HasLogs
       end
 
       def create_log
+        return if self.class.have_type == :mutual && self.new_record?
+
         values = {}
         self.class.logging_attrs.each do |attr|
-          values[attr] = send(attr)
+          values[attr] = (self.class.have_type == :mutual ? send("#{attr}_was") : send(attr))
         end
         logs.build(values).save
+        return
       end
 
       def set_attrs

data/lib/has_logs/version.rb

@@ -1,3 +1,3 @@
 module HasLogs
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_logs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - isuke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,30 +84,30 @@ dependencies:
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Logging your ActiveRecord model, and supply useful methods.
 email:
 - isuke770@gmail.com
@@ -132,6 +146,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -139,6 +154,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/activerecord_4.2.5.gemfile
+- gemfiles/activerecord_4.2.5.gemfile.lock
+- gemfiles/activerecord_5.0.0.gemfile
+- gemfiles/activerecord_5.0.0.gemfile.lock
 - has_logs.gemspec
 - lib/has_logs.rb
 - lib/has_logs/act_as_log.rb