model_log 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c5b94535e1a429a6ac7b6dafc2e47510de03323
+  data.tar.gz: 7896e41b1051182317fefd98715fedc4d3abeb57
+SHA512:
+  metadata.gz: 19cc97d0a43b4fae221c10a0721a07d3997f55cd281adbfd5a4ab7b95242fe0952ca17c5f42df02c7a69cf0538028adcd3f3e82c4ec13fdbe938f747741de18f
+  data.tar.gz: 398f192e6b454def32deaf84946feaa558fa58dcf6e23afaed294c446688a35dd26c78ebd923b5a35fb81de717c272f562552542cce6935ba2a3e967b0ee69fa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 462436208@qq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in model_log.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    model_log (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  model_log!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sunyudong
+
+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,65 @@
+# ModelLog
+
+User operation data saves log files and records user information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_log'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Simply call `model_log` on your models:
+
+```ruby
+class User < ActiveRecord::Base
+  model_log
+end
+```
+
+## Log Path
+
+The log is saved in the `log/` section of your rails app.
+
+The development environment file is called `model_log_development.log`.
+
+The product environment file is called `model_log_product.log`.
+
+## Current User Tracking
+
+If you're using ModelLog in a Rails application, all audited changes made within a request will automatically be attributed to the current user. By default, ModelLog uses the `current_passport` method in your controller.
+
+The username field default to `username`.
+
+To use a method other than `current_passport` and a field other than `username`, put the following in an initializer:
+
+```ruby
+# config/initializers/model_log.rb
+
+ModelLog.current_user_method = :current_user
+ModelLog.user_name_field = :name
+```
+
+## Other Settings
+
+If you have multiple platforms, and the tag data changes belong to that platform, put the following in an initializer:
+
+```ruby
+# config/initializers/model_log.rb
+
+ModelLog.platform = :CPM
+```
+
+## Gem Update
+
+If you want to update the gem, run:
+
+    $ bundle update model_log
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "model_log"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/model_log/class_methods/controllers.rb

@@ -0,0 +1,33 @@
+module ModelLog
+  module ClassMethods
+    module Controllers
+      def self.included(base)
+        base.class_eval do
+          extend Invoking
+          model_log_user_setting
+        end
+      end
+
+      module Invoking
+        def model_log_user_setting
+          before_action :set_current_passport
+          before_action :set_current_request
+        end
+      end
+
+      private
+
+        def set_current_passport
+          ModelLog::Passport.clear_current_passport!
+          ModelLog::Passport.current_passport = send(ModelLog.current_user_method)
+        end
+
+        def set_current_request
+          ModelLog::Request.clear_current_request!
+          ModelLog::Request.current_request = request
+        end
+    end
+  end
+end
+
+ActionController::Base.send(:include, ModelLog::ClassMethods::Controllers) if defined? ActionController::Base

data/lib/model_log/class_methods/models.rb

@@ -0,0 +1,101 @@
+module ModelLog
+  module ClassMethods
+    module Models
+      def self.included(base)
+        base.extend Invoking
+      end
+
+      module Invoking
+        def model_log
+          after_create :model_log_create
+          after_destroy :model_log_destroy
+          before_update :model_log_update
+        end
+      end
+
+      private
+
+        def model_log_create
+          write_log(self, :create)
+        end
+
+        def model_log_update
+          write_log(self, :update)
+        end
+
+        def model_log_destroy
+          write_log(self, :destroy)
+        end
+
+        def data_processing(field_name, field_data, **options)
+          if field_data.is_a? CarrierWave::Uploader::Base
+            return options[:index] == 0 ? get_uploader_filename(field_data.url) : send("#{field_name}_identifier")
+          elsif field_data.is_a? BigDecimal
+            return field_data.to_f
+          else
+            return field_data
+          end
+        end
+
+        def get_uploader_filename(path)
+          if path
+            rindex = path.rindex('/')
+            return path.slice(rindex+1, path.size-rindex-1)
+          end
+          return nil
+        end
+
+        def write_log(resource, type)
+          begin
+            passport = ModelLog::Passport.current_passport
+            request = ModelLog::Request.current_request
+            type = type.to_s
+            can_write = true
+            content_text = {}
+
+            if type == "update"
+              changes = resource.changes
+              changes.each do |key, values|
+                value_arr = []
+                values.each_with_index do |value, i|
+                  value_arr << data_processing(key, value, :index => i)
+                end
+                content_text.merge!(Hash[key, value_arr])
+              end
+
+              can_write = false if content_text.empty?
+            else
+              resource.class.content_columns.each do |column|
+                column_name = column.name
+                column_val = data_processing(column_name, resource.send(column_name))
+                content_text.merge!(Hash[column_name, column_val])
+              end
+            end
+
+            file_content = <<-EFO.strip_heredoc.gsub("\n", "\t")
+              #{request.try(:request_method)}
+              #{request.try(:url)}
+              #{request.try(:referer)}
+              #{request.try(:remote_ip)}
+              #{request.try(:user_agent)}
+              #{ModelLog.platform}
+              #{passport.try(:id)}
+              #{passport.try(ModelLog.user_name_field)}
+              #{type.to_s}
+              #{resource.class}
+              #{resource.id}
+              #{Time.now}
+              #{content_text}
+            EFO
+
+            ModelLog.info file_content if can_write
+          rescue => e
+            ModelLog.info e.message
+          end
+        end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ModelLog::ClassMethods::Models) if defined? ActiveRecord::Base
+

data/lib/model_log/passport.rb

@@ -0,0 +1,18 @@
+module ModelLog
+  module Passport
+    class << self
+      def current_passport
+        Thread.current[:passport]
+      end
+
+      def current_passport=(value)
+        Thread.current[:passport] = value
+      end
+
+      def clear_current_passport!
+        Thread.current[:passport] = nil
+      end
+    end
+  end
+end
+

data/lib/model_log/request.rb

@@ -0,0 +1,17 @@
+module ModelLog
+  module Request
+    class << self
+      def current_request
+        Thread.current[:request]
+      end
+
+      def current_request=(value)
+        Thread.current[:request] = value
+      end
+
+      def clear_current_request!
+        Thread.current[:request] = nil
+      end
+    end
+  end
+end

data/lib/model_log/version.rb

@@ -0,0 +1,3 @@
+module ModelLog
+  VERSION = "1.0.0"
+end

data/lib/model_log.rb

@@ -0,0 +1,22 @@
+require "model_log/version"
+require "model_log/passport"
+require "model_log/request"
+require "model_log/class_methods/models"
+require "model_log/class_methods/controllers"
+
+module ModelLog
+  class << self
+    attr_accessor :platform, :current_user_method, :user_name_field
+
+    def info(content)
+      content = content.chomp + "\n"
+      File.open("log/model_log_#{Rails.env}.log", "a+") do |output|
+        output.write(content)
+      end
+    end
+  end
+
+  @current_user_method = @current_user_method || :current_passport
+  @user_name_field = @user_name_field || :username
+end
+

data/model_log.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "model_log/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "model_log"
+  spec.version       = ModelLog::VERSION
+  spec.authors       = ["sunyudong"]
+  spec.email         = ["462436208@qq.com"]
+
+  spec.summary       = "The operation data holds the log file."
+  spec.description   = "User operation data saves log files and records user information."
+  spec.homepage      = "https://github.com/OrderSun/model_log"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: model_log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sunyudong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: User operation data saves log files and records user information.
+email:
+- 462436208@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/model_log.rb
+- lib/model_log/class_methods/controllers.rb
+- lib/model_log/class_methods/models.rb
+- lib/model_log/passport.rb
+- lib/model_log/request.rb
+- lib/model_log/version.rb
+- model_log.gemspec
+homepage: https://github.com/OrderSun/model_log
+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.14
+signing_key: 
+specification_version: 4
+summary: The operation data holds the log file.
+test_files: []