wfl_simple_activity 0.1.9 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb07938e75e645aa72551e8626b37338fc2e9f5a1b0201c941246d53390aee43
-  data.tar.gz: 907f485b24a088d0e76c3e8ada74cffc1e6ff5065f9508ea4c59350f3b8d5625
+  metadata.gz: 673204e78ec26a69f4061a1664732d6f7d328501eba76f9afad2b001daac95cd
+  data.tar.gz: 6b6bc9d45fde533189b74e3266060133fd38c932d4428b8295d7fbd00845e321
 SHA512:
-  metadata.gz: 056fbcc244291f2c74335ea5f52b052bcca3af940a0d9912c265a65e81a0ac89b35c35d7889e337dbb321a0720af54813941c68cb0e6402e1f98d67b927bed9a
-  data.tar.gz: 52f1cf876b6926c0aeb6d9c92cbbed65eaf7daa596b982e67216d75ed3ff562d165f9221f0c34b4a1f42e0bb6475b00d5d3f0967d467bc3135b004e661cd33dd
+  metadata.gz: 8063e654ee7ad4031d5bf6f36bc6a7a595f2afab471bfaa92bf3ef4facb03390c7c2200b8c6706470721671f93d93a7694a1e508f8e7775e46fb9ad42550b023
+  data.tar.gz: d069374db2aa1951128d4348a4fea53590287c155bb2d23ba05240c56d61f99c9702a6b07bff20bc16f644bf85bb0c68b2ea73549ddfe79b38603961e4b5d0ec

data/README.md

@@ -1,10 +1,8 @@
 # WflSimpleActivity
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wfl_simple_activity`. To experiment with that code, run `bin/console` for an interactive prompt.
+一个用以记录用户数据操作日志的Gem
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+## 安装
 
 Add this line to your application's Gemfile:
 
@@ -20,16 +18,31 @@ Or install it yourself as:
 
     $ gem install wfl_simple_activity
 
-## Usage
+## 用法
 
     $ rails g wfl_simple_activity:install
     $ rake db:migrate
 
-## Development
+## 开发
+
+#### 单表记录
+* 执行上面两步之后,在需要记录数据变更的Model中 `include WflActivity` ,这样便会记录该Model的数据变更日志,在
+    数据发生变化,将会创建 `activity`, 在项目中可以通过 `model_name.activities` 或者 `PublicActivity::Activity.where(condition)`来获取活动日志
+
+#### 关联表记录 或者 其余特殊情况
+
+* 如果需要在关联模型数据发生变更时记录当前模型的`activity`,需要自行在关联的模型中通过`model_name.create_activity key: 'article.commented_on', owner: current_user, recipient: recipientm`来创建`activity`,create_activity方法参数可参考 [PublicActivity::Common#create_activity](https://rubydoc.info/gems/public_activity/PublicActivity/Common:create_activity)
+
+#### 注意事项
+
+* 生成的migration文件中需自行migration版本指定对应的版本
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* 如果需要记录current_user 或者 调用其他在controller中的方法,需要在 `application_controller.rb`中 `include PublicActivity::StoreController`
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* 自行获取 controller 上下文: 
+    ```ruby 
+    PublicActivity.get_controller 
+    ```
 
 ## Contributing
 

data/lib/generators/wfl_simple_activity/install_generator.rb

@@ -20,7 +20,7 @@ module WflSimpleActivity
       end
 
       def copy_common_activity
-        copy_file "common_activity.rb", "app/models/common_activity.rb"
+        copy_file "wfl_activity.rb", "app/models/concerns/wfl_activity.rb"
       end
 
       def copy_activity_model

data/lib/generators/wfl_simple_activity/templates/wfl_activity.rb

@@ -0,0 +1,27 @@
+module WflActivity
+  extend ActiveSupport::Concern
+  included do |base|
+    include PublicActivity::Model
+    tracked(
+      owner: proc { |controller, model| controller&.current_user }, 
+      model_changes: proc {|controller, model|  model.changes},
+      recipient: proc { |controller, model| model }, 
+      params: {
+        request_params: proc {|controller, model| controller&.params&.to_h}
+      }
+    )
+
+    # 如果不需要删除记录
+    # has_many :activities, as: :trackable, class_name: 'PublicActivity::Activity', dependent: :destroy
+    
+    after_rollback proc {
+      # 由于after_rollback是ActiveRecord自带的回调,并不支持获取controller,所以需要借助PublicActivity
+      controller = PublicActivity.get_controller
+      if self.id.blank?
+        PublicActivity::Activity.create key: "#{self.class.name.underscore}.failed", owner: controller&.current_user, parameters: controller&.params&.to_h, model_changes: self.changes
+      else
+        self.create_activity key: "#{self.class.name.underscore}.failed", owner: User.find(Thread.current[:user_id]), recipient: self
+      end
+    }
+  end
+end

data/lib/wfl_simple_activity/version.rb

@@ -1,3 +1,3 @@
 module WflSimpleActivity
-  VERSION = "0.1.9"
+  VERSION = "0.1.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wfl_simple_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.15
 platform: ruby
 authors:
 - longhaoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_activity
@@ -67,8 +67,8 @@ files:
 - bin/setup
 - lib/generators/wfl_simple_activity/install_generator.rb
 - lib/generators/wfl_simple_activity/templates/activity.rb
-- lib/generators/wfl_simple_activity/templates/common_activity.rb
 - lib/generators/wfl_simple_activity/templates/create_activities.rb
+- lib/generators/wfl_simple_activity/templates/wfl_activity.rb
 - lib/wfl_simple_activity.rb
 - lib/wfl_simple_activity/common_activity.rb
 - lib/wfl_simple_activity/version.rb

data/lib/generators/wfl_simple_activity/templates/common_activity.rb

@@ -1,14 +0,0 @@
-module CommonActivity
-  extend ActiveSupport::Concern
-  included do |base|
-    include PublicActivity::Model
-    tracked(
-      owner: proc { |controller, model| controller&.current_user }, 
-      model_changes: proc {|controller, model|  model.changes},
-      recipient: proc { |controller, model| model }, 
-      params: {
-        request_params: proc {|controller, model| controller&.params&.to_h}
-      }
-    )
-  end
-end