kushojin 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b284f87c77853b11396c7b90b28ba80a237f19af
-  data.tar.gz: 29dfb5f5842aeb0735ce95c89ccd668da388c00f
+SHA256:
+  metadata.gz: 06f7c8d3b7b0fe28792b4c01bc6af184a25cca40b5c70ab0f2916acc3d696b6a
+  data.tar.gz: 59b0051cf2b0d30e5d6f468621fcb8719e35cc167eca2774cf638ff5a2cc97f6
 SHA512:
-  metadata.gz: da3383afe02b3227e110530c38cf3c70a0b37689f9bf1a2f96f910c621cebecbe528d2cf18ef9cdfe3cb9ce6401677a6a0da1bc15c78ba4e38d6ee568cda14dd
-  data.tar.gz: 3a7dad0856810d4069aa539c403bc9340f90f46aeced4818b84ebb0e5d45c3fdda1be60dbf1984a403ba974e6a51b674c7792a664cff5dffe9dd4a4cd1ee049d
+  metadata.gz: 90c9302c8beca1dcbefff47f30fe97713ce31e232480fcb2718817efa775d696745b9de15c0242330035ade1fc78a81ccd21129264adae27f503df35098f3e52
+  data.tar.gz: e7626085b763c4c2ec0ca83bd68da28c0fb4484eeada3ee56150d595720b60a38bef0e7601fac96268336efb9008acec7c2d52129ba2d24301460f060004db33

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   DisplayCopNames: true
   Exclude:
     - 'kushojin.gemspec'
@@ -16,12 +16,19 @@ Style/StringLiterals:
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/README.md

@@ -39,6 +39,50 @@ end
     $ curl -X POST -d "user[name]=bill&user[age]=20" http://localhost:3000/users
     # output: users.create {"event":"create","request_id":"4afd0731-dd25-4668-b769-2017dbdd3642","table_name":"users","id":1,"changes":{"name":[null,"bill"],"age":[null,20]}}
 
+Changes is recorded when the model is created, updated and destroyed.
+The `:only` option can be used same as filters of controller.
+
+```ruby
+class User < ApplicationRecord
+  record_changes only: [:create, :destroy]
+end
+```
+    $ curl -X POST -d "user[name]=bill&user[age]=20" http://localhost:3000/users
+    # output: users.create {"event":"create","request_id":"4afd0731-dd25-4668-b769-2017dbdd3642","table_name":"users","id":1,"changes":{"name":[null,"bill"],"age":[null,20]}}
+
+    $ curl -X PATCH -d "user[age]=21" http://localhost:3000/users/1
+    # no output
+
+Custom callback object can be used with `:callbacks` option.
+
+```ruby
+class CustomCallbacks
+  # Must respond to after_create, after_update, and before_destroy.
+  def after_create(record); end
+  def after_update(record); end
+  def before_destroy(record); end
+end
+
+class User < ApplicationRecord
+  record_changes callbacks: CustomCallbacks.new
+end
+```
+
+### Override
+
+You can override options of Recording changes in subclass.
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+  record_changes
+end
+
+class User < ApplicationRecord
+  record_changes only: [:create, :destroy]
+end
+```
+
 ## 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/kushojin.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", "~> 5.1"
   spec.add_dependency "fluent-logger"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rubocop"
 end

data/lib/kushojin/model_methods/callback.rb

@@ -4,12 +4,84 @@ module Kushojin
       RECORD_EVENTS = %i[before_destroy after_create after_update].freeze
 
       module ClassMethods
-        def record_changes
-          kushojin_callbacks = RecordChangesCallbacks.new
-          RECORD_EVENTS.each do |event|
+        def self.extended(klass)
+          klass.class_attribute :kushojin_callbacks, instance_accessor: false
+        end
+
+        # Record changes of the ActiveRecord model.
+        #
+        #   class User < ApplicationRecord
+        #     record_changes
+        #   end
+        #
+        # Changes is recorded when the model is created, updated and destroyed.
+        # The +:only+ option can be used same as filters of controller.
+        #
+        #   record_changes only: [:create, :destroy]
+        #
+        # Custom callback object can be used with +:callbacks+ option.
+        #
+        #   class CustomCallbacks
+        #     # Must respond to after_create, after_update, and before_destroy.
+        #     def after_create(record); end
+        #     def after_update(record); end
+        #     def before_destroy(record); end
+        #   end
+        #
+        #   class User < ApplicationRecord
+        #     record_changes callbacks: CustomCallbacks.new
+        #   end
+        #
+        # Both +:only+ and +:callbacks+ option can be overrided by subclass.
+        #
+        #   class ApplicationRecord < ActiveRecord::Base
+        #     self.abstract_class = true
+        #     record_changes
+        #   end
+        #
+        #   class User < ApplicationRecord
+        #     record_changes only: [:create, :destroy], callbacks: CustomCallbacks.new
+        #   end
+        #
+        # ===== Options
+        #
+        # * <tt>only</tt> - Records only for this event.
+        #   Support event is +:create+, +:update+, and +:destroy+.
+        # * <tt>callbacks</tt> - Use callback object instead of RecordChangesCallbacks.
+        #
+        def record_changes(only: [], callbacks: nil)
+          if kushojin_callbacks
+            remove_callbacks
+            self.kushojin_callbacks = callbacks if callbacks
+          else
+            self.kushojin_callbacks = callbacks || RecordChangesCallbacks.new
+          end
+
+          record_events = convert_to_record_events(only)
+          record_events.each do |event|
             public_send(event, kushojin_callbacks)
           end
         end
+
+        private
+
+        def remove_callbacks
+          kind_and_names =
+            RECORD_EVENTS.map { |event| event.to_s.split("_", 2).map(&:to_sym) }
+
+          kind_and_names.each do |kind, name|
+            skip_callback(name, kind, kushojin_callbacks, raise: false)
+          end
+        end
+
+        def convert_to_record_events(events) # :nodoc:
+          if events.empty?
+            RECORD_EVENTS
+          else
+            event_strs = Array(events).map(&:to_s)
+            RECORD_EVENTS.select { |event| event_strs.include?(event.to_s.sub(/^\w*_/, "")) }
+          end
+        end
       end
     end
   end

data/lib/kushojin/model_methods/record_changes_callbacks.rb

@@ -3,7 +3,7 @@ module Kushojin
     class RecordChangesCallbacks
       Callback::RECORD_EVENTS.each do |event|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{event}(model)                                                          # def after_create
+        def #{event}(model)                                                          # def after_create(model)
           Recorder.record(:#{event.to_s.split(/_/).last}, model) if Recorder.current #   Recorder.record(:create, model) if Recorder.current
         end                                                                          # end
         RUBY

data/lib/kushojin/version.rb

@@ -1,3 +1,3 @@
 module Kushojin
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kushojin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Loose coupling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -42,58 +42,58 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Detect changes of model attributes and send to outside.