model_log 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f536ddd5bcec92fad2368e4e637fd678620ca82cfe38438cbdc434a36c6da913
-  data.tar.gz: 7a597e5c6e17e43da418c1b5c3e37bdb733e8b0f1b6e1af35c73fd00c4598130
+  metadata.gz: a91de84ee8086e12de0c20d29185423e70bae67dce1817914bd61ff25ba49430
+  data.tar.gz: 5f4673b8501238e256fa379ec279dc626372eef84d17c860054854401ea533e8
 SHA512:
-  metadata.gz: f564bfb542098de5b2aedeb67de68db8d6ccbe6077a05e657d44dd39f6ac5bfc1f75a8efeeb78a27e51e1418981bd403ba8edab4e9605413a523c36b671f54a0
-  data.tar.gz: 6b1780b79d240b9edcfd0e05777f20f5bba2d6295e5a0b3b8801ac069ab5919bd54fa15ceb06dfc05080c3a145ad5fb6cc7296a98efad15dfa8a3e1f6d56cbad
+  metadata.gz: 71b7b4458b7de39674a4e435cd202c8b6d5a24083bd2c6ae97e85e35c6d351cd9453db66758404bc2896141fb041b62dedfd5db23cccb23463c77bd02d09a444
+  data.tar.gz: c615dd14cd292bd9755110ffc13fbab8a11080617a490cef0232084581d3ce6488a4e935b4a20553d9faaa879fa4afe135d6f841b511b7146059c62bc2eef9b4

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -6,8 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/spec/
-/.rspec
 /Gemfile.lock
 
 # rspec failure tracking

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -48,7 +48,7 @@ To use a method other than `current_user` and an identity field other than `id`,
 ModelLog.configure do |config|
   config.current_user_method    = :current_manager     # default: :current_user
   config.identity_field         = :username            # default: :id
-  config.separator              = ' '                  # default: "\t"
+  config.separator              = "\t"                 # default: ' '
   config.logger_datetime_format = '%Y-%m-%d %H:%M:%S'
 end
 ```
@@ -111,4 +111,4 @@ end
 
 ## Copyright
 
-Copyright (c) 2018- jk-sun. See LICENSE.tet for further details.
+Copyright (c) 2018- jk-sun. See LICENSE.txt for further details.

data/Rakefile

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

data/lib/model_log.rb

@@ -1,17 +1,30 @@
-require "model_log/version"
-require "model_log/config"
-require "model_log/store"
-require "model_log/controller"
-require "model_log/modeller"
-require "model_log/logger"
-require "model_log/context"
-require "model_log/log/initializer"
-require "model_log/log/content"
-require "model_log/log/processor"
-require "model_log/helpers/context"
-require "model_log/default/formatter"
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+
+require 'model_log/version'
 
 module ModelLog
+  extend ActiveSupport::Autoload
+
+  autoload :Config,  'model_log/config'
+  autoload :Store,   'model_log/store'
+  autoload :Logger,  'model_log/logger'
+  autoload :Context, 'model_log/context'
+
+  module Log
+    autoload :Initializer, 'model_log/log/initializer'
+    autoload :Content,     'model_log/log/content'
+    autoload :Processor,   'model_log/log/processor'
+  end
+
+  module Default
+    autoload :Formatter, 'model_log/default/formatter'
+  end
+
+  module Helpers
+    autoload :Context, 'model_log/helpers/context'
+  end
+
   class << self
     def configure
       yield config
@@ -26,7 +39,7 @@ module ModelLog
     end
 
     def requester
-      Store.current_requester
+      Store.requester
     end
 
     def requester_exist?
@@ -40,6 +53,12 @@ module ModelLog
     def current_user_exist?
       !!current_user
     end
+
+    def version
+      VERSION::STRING
+    end
   end
 end
 
+require 'model_log/controller'
+require 'model_log/modeller'

data/lib/model_log/config.rb

@@ -6,7 +6,7 @@ module ModelLog
     def initialize
       @current_user_method ||= :current_user
       @identity_field      ||= :id
-      @separator           ||= "\t"
+      @separator           ||= ' '
       @formatter           ||= Default::Formatter
       @logger_level        ||= Logger::INFO  # DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
     end

data/lib/model_log/context.rb

@@ -1,13 +1,11 @@
 module ModelLog
-  module Log
-    class Context
-      def initialize(context)
-        @context = context
-      end
+  class Context
+    def initialize(context)
+      @context = context
+    end
 
-      def to_struct
-        Struct.new(*@context.keys).new(*@context.values)
-      end
+    def to_struct
+      Struct.new(*@context.keys).new(*@context.values)
     end
   end
 end

data/lib/model_log/controller.rb

@@ -10,25 +10,25 @@ module ModelLog
     module ClassMethods
       def set_model_log_stroe
         if ::Rails::VERSION::MAJOR > 3
-          before_action :set_current_user
-          before_action :set_current_requester
+          before_action :set_model_log_current_user
+          before_action :set_model_log_requester
         else
-          before_filter :set_current_user
-          before_filter :set_current_requester
+          before_filter :set_model_log_current_user
+          before_filter :set_model_log_requester
         end
       end
     end
 
     private
 
-    def set_current_user
+    def set_model_log_current_user
       Store.clear_current_user!
       Store.current_user = send(ModelLog.config.current_user_method) rescue nil
     end
 
-    def set_current_requester
-      Store.clear_current_requester!
-      Store.current_requester = request.is_a?(ActionDispatch::Request) && request rescue nil
+    def set_model_log_requester
+      Store.clear_requester!
+      Store.requester = request.is_a?(ActionDispatch::Request) && request rescue nil
     end
   end
 end

data/lib/model_log/log/content.rb

@@ -18,9 +18,9 @@ module ModelLog
         Context.new(
           current_user: ModelLog.current_user,
           requester: ModelLog.requester,
-          action: @action,
-          resource: @resource,
-          changes: Processor.new(@resource, @action).data
+          action: action,
+          resource: resource,
+          changes: Processor.new(resource, action).data
         ).to_struct
       end
     end

data/lib/model_log/log/initializer.rb

@@ -1,21 +1,31 @@
 module ModelLog
   module Log
     module Initializer
-      # {
-      #   resource:     object_active_record,
-      #   action:       create|update|destroy,
-      # }
+      attr_reader :resource, :changes, :attributes, :changed_attributes, :action
+
+      # params
+      # resource: object_active_record
+      # action:   create|update|destroy
       def initialize(resource, action)
-        @resource = resource
-        @action = action
+        @action             = action
         verify_action!
+
+        @resource           = resource
+        @changes            = resource.changes
+        @changed_attributes = resource.changed_attributes
+        @attributes         = resource.attributes
+        @is_changed         = resource.changed?
+      end
+
+      def changd?
+        @is_changed
       end
 
       private
 
       def verify_action!
-        unless %i(create destroy update).include? @action
-          raise StandardError, "invalid action given #{@action}"
+        unless %i(create destroy update).include? action
+          raise StandardError, "invalid action given #{action}"
         end
       end
     end

data/lib/model_log/log/processor.rb

@@ -4,7 +4,7 @@ module ModelLog
       include Initializer
 
       def data
-        case @action
+        case action
         when :create
           created_data
         when :update
@@ -16,22 +16,17 @@ module ModelLog
 
       private
 
-      def default_data
-        @resource.changes
+      def saved_data
+        changes
       end
 
-      def created_data
-        # key => value
-        @resource.class.content_columns.map do |column|
-          [column.name, @resource.send(column.name)]
-        end.to_h
-      end
-
-      alias_method :destroyed_data, :created_data
+      alias_method :created_data, :saved_data
+      alias_method :updated_data, :saved_data
 
-      def updated_data
-        # key => [before, after]
-        default_data
+      def destroyed_data
+        data = attributes
+        data = data.merge(changed_attributes) if changd?
+        data.map { |attr, value| [attr, [value, nil]] }.to_h
       end
     end
   end

data/lib/model_log/logger.rb

@@ -9,6 +9,12 @@ module ModelLog
       self
     end
 
+    %i(debug info warn error fatal unknown).each do |method|
+      define_method method do |msg|
+        super(msg) if msg.present?
+      end
+    end
+
     private
 
     def level

data/lib/model_log/modeller.rb

@@ -6,9 +6,9 @@ module ModelLog
 
     module ClassMethods
       def model_log
-        after_create :model_log_create
-        after_destroy :model_log_destroy
+        before_create :model_log_create
         before_update :model_log_update
+        after_destroy :model_log_destroy
       end
     end
 
@@ -27,19 +27,10 @@ module ModelLog
     end
 
     def model_log_write(resource, action)
-      # ModelLog.logger.debug resource.changes
-      # update changes is not empty
-      # create and destroy changes is empty
-      if log_content(resource, action)
-        ModelLog.logger.info log_content(resource, action)
-      end
+      ModelLog.logger.info Log::Content.new(resource, action, ModelLog.config.formatter).content
     rescue => ex
       ModelLog.logger.error "#{ex.class}: #{ex.message}"
     end
-
-    def log_content(resource, action)
-      @log_content ||= Log::Content.new(resource, action, ModelLog.config.formatter).content
-    end
   end
 end
 

data/lib/model_log/store.rb

@@ -33,15 +33,15 @@ module ModelLog
         delete :current_user
       end
 
-      def current_requester
+      def requester
         read :requester
       end
 
-      def current_requester=(obj_request)
-        write :requester, obj_request
+      def requester=(request)
+        write :requester, request
       end
 
-      def clear_current_requester!
+      def clear_requester!
         delete :requester
       end
     end

data/lib/model_log/version.rb

@@ -1,3 +1,16 @@
 module ModelLog
-  VERSION = "2.0.0"
+  module VERSION
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 1
+
+    # Set PRE to nil unless it's a pre-release (beta, rc, etc.)
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze
+
+    def self.to_s
+      STRING
+    end
+  end
 end

data/model_log.gemspec

@@ -4,7 +4,7 @@ require "model_log/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "model_log"
-  spec.version       = ModelLog::VERSION
+  spec.version       = ModelLog::VERSION::STRING
   spec.authors       = ["jk-sun"]
   spec.email         = ["jk-sun@qq.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_log
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - jk-sun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,7 +32,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile