footprintable 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5acf753ef41fff92e1b4c38a032fba4ecd4b98b6
+  data.tar.gz: 13c9482803c0617dcd0d083f0fc1e7bbc51b2603
+SHA512:
+  metadata.gz: 3991b2e6e2077c77e22c9988ef3e977feeecb3d1dadd3865ccf176b2d802ad205936d4b609907e575174e2372bc77c51aa6864f65edf1ea6bb6e24223029423c
+  data.tar.gz: 4c6dc7a43b695040e8ad403bdf6fa848854dd0761d7ebd356469a0addc63e5edc346856129b167ad98896b126778e6c62c85fbf53827f60d629c0e05e3b8fadf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 mars
+
+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,72 @@
+# Footprintable
+track model columns change
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'footprintable', github: 'rails-gems/footprintable'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+创建`model`
+```
+rails g model footprint before:text after:text action:string trackable:references{polymorphic} actorable:references{polymorphic}
+```
+
+添加代码到`footprint.rb`
+```
+serialize :before, JSON
+serialize :after, JSON
+```
+
+* trackable, 追踪的对象（改变的model）
+* actorable，导致对象改变的对象，比如操作者, 如果为空，默认为trackable本身
+
+actorable 赋值当前操作者举例
+```
+# in controler
+around_action :set_thread_footprint_actor
+def set_thread_footprint_actor
+  Footprintable::Current.actor = current_user
+  yield
+ensure
+  # to address the thread variable leak issues in Puma/Thin webserver
+  Footprintable::Current.actor = nil
+end
+```
+
+需要追踪的model添加如下代码
+```
+include Footprintable
+has_footprints(options) 
+```
+options, default: {}
+* :on, after_commit actions, default: [:create, :update, :destroy]
+* :except, 不需要记录的字段, default: [:updated_at, :created_at]
+* :extract, 只需要记录的字段, default: [], 空指记录所有字段
+
+`except`，`extract`的关系: `（changed_columns & extract） - except`
+
+### fragment
+```
+def has_footprints options = {}
+  # 触发时间
+  options[:on]   ||= [:create, :update]
+  # 摘取字段 [] => 所有字段
+  options[:extract] ||= []
+  # 排除字段
+  options[:except] ||= [:updated_at, :created_at]
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Footprintable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/footprintable.rb

@@ -0,0 +1,15 @@
+require 'footprintable/class_methods'
+require 'footprintable/instance_methods'
+require 'footprintable/current'
+module Footprintable
+
+  def self.included(klass)
+    klass.class_eval do
+      has_many :footprints, as: :trackable
+      class_attribute :footprint_options
+    end
+    klass.send :extend, ClassMethods
+    klass.send :include, InstanceMethods
+  end
+
+end

data/lib/footprintable/class_methods.rb

@@ -0,0 +1,21 @@
+# except，extract的关系: (changed_columns & extract) - except
+module Footprintable
+  module ClassMethods
+    def has_footprints options = {}
+      # 触发时间
+      options[:on]   ||= [:create, :update, :destroy]
+      # 摘取字段 [] => 所有字段
+      options[:extract] ||= []
+      # 排除字段
+      options[:except] ||= [:updated_at, :created_at]
+      self.footprint_options = options
+      setup_callbacks_from_options(options[:on])
+    end
+
+    def setup_callbacks_from_options options_on = []
+      options_on.each do |action|
+        after_commit ->(obj) { obj.create_footprint action }, on: action
+      end
+    end
+  end
+end

data/lib/footprintable/current.rb

@@ -0,0 +1,8 @@
+require 'active_support/core_ext/module/attribute_accessors_per_thread'
+module Footprintable
+  # rails 5
+  # 当前线程导致数据改变的触发对象
+  module Current
+    thread_mattr_accessor :actor
+  end
+end

data/lib/footprintable/instance_methods.rb

@@ -0,0 +1,20 @@
+require 'footprintable/current'
+module Footprintable
+  module InstanceMethods
+    def create_footprint action
+      attrs_changed = previous_changes
+      return if attrs_changed.empty?
+      attrs_changed = attrs_changed.except *self.class.footprint_options[:except]
+      attrs_changed = attrs_changed.extract! *self.class.footprint_options[:extract] if self.class.footprint_options[:extract].present?
+
+      attrs_before  = {}
+      attrs_after = {}
+
+      attrs_changed.each do |k, v|
+        attrs_before.store(k, v.first) unless v.first.nil?
+        attrs_after.store(k, v.last)  unless v.last.nil?
+      end
+      self.footprints.model.new(before: attrs_before, after: attrs_after, action: action, trackable: self, actorable: Current.actor).save(validate: false)
+    end
+  end
+end

data/lib/footprintable/version.rb

@@ -0,0 +1,3 @@
+module Footprintable
+  VERSION = '0.1.2'
+end

data/lib/tasks/footprintable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :footprintable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: footprintable
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- mars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: track model column change.
+email:
+- 578595193@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/footprintable.rb
+- lib/footprintable/class_methods.rb
+- lib/footprintable/current.rb
+- lib/footprintable/instance_methods.rb
+- lib/footprintable/version.rb
+- lib/tasks/footprintable_tasks.rake
+homepage: https://github.com/wuyuedefeng/footprintable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: track model column change.
+test_files: []