logisticed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3c3fe85b4c2c2975df8b5cd4870b555b85871a27b1599bde1e11a5139a039b8
+  data.tar.gz: 4ada53766738c01f2acc507e0ad3dad86b0e074b9f032d157dd2992205220cfc
+SHA512:
+  metadata.gz: 38f274ccd8522f277a272f1b3c0c45cdcc4b1e2ec9bfbf02241ce887f395049fa41b2a42c4358cf8122126e3008017b2f9224ec4e625db9e4550a2400678a766
+  data.tar.gz: 5c5ae24ab9b8572cfffa83b28e5c039e6c9085158899e052f7c4b8c6d1b3b40ade8af3cc9245c9c3c2a4d6d9f775d09a002f158f17b42d02b2054ed3ed7755cb

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "logisticed"
+  ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logisticed.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    logisticed (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  logisticed!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,79 @@
+# Logisticed
+轻松记录每条记录状态变更时的操作时间以及操作人
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logisticed'
+```
+
+Then, from your Rails app directory, create the `logistics` table:
+```bash
+$ rake logisticed_migration:install:migrations
+$ rails db:migrate
+```
+## Usage
+
+你只需要告诉 `logisticed` 需要监听什么字段， 并且被修改为什么值的时候就行了。
+
+```ruby
+class Page < ActiveRecord::Base
+  logisticed :status, values: [:active, :archived]
+end
+
+他将会为你提供 `active_at`、 `active_by`、 `archived_at`、 `archived_by` 这几个方法，为你提供某个状态最近的操作历史
+```
+
+如果在 model 中定义了枚举类型的字段，也可以在定义枚举的下面直接添加 `logisticed`，他会自动为你监听枚举的所有值，同时 logisticed 支持 `only` 和 `except` 这两个参数
+
+```ruby
+class Page < ActiveRecord::Base
+  enum status: [:draft, :active, :archived]
+	logisticed :status, only: [:active, :archived]
+end
+```
+
+现在就已经可以监听所有的操作人和操作时间等信息了
+```ruby
+class PagesController < ApplicationController
+	def create
+		current_user # => #<User name: 'sss'>
+		@page = Page.first # => #<Page status: 'draft'>
+		@page.active!
+		@active_at # => 2021-01-22 17:15:13 +0800
+		@active_by # => #<User name: 'sss'>
+	end
+end
+```
+
+当然你也可以使用 `@page.logistics` 得到 @page 这条记录的所有变更流程，也可以使用 `@page.active_logistics` 得到状态变为 active 的所有变更流程
+
+除此之外你也可以使用 `as_user` 制定某个用户成为操作人员
+
+```ruby
+class PagesController < ApplicationController
+	def create
+		current_user # => #<User name: 'sss'>
+		user = User.last # => #<User name: 'smx'>
+		Logisticed::Logistic.as_user(user) do
+			@page = Page.first # => #<Page status: 'draft'>
+			@page.active!
+			@active_at # => 2021-01-22 17:15:13 +0800
+			@active_by # => #<User name: 'smx'>
+		end
+	end
+end
+```
+# setting
+
+```ruby
+# config/initializers/logisticed.rb
+
+Logisticed.config do |config|
+	config.current_user_method                = :authenticated_user
+	# if your table primary_key type is uuid
+	config.logisticed_source_id_column_type   = :uuid
+	config.logisticed_operator_id_column_type = :uuid
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logisticed"
+
+# 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/db/migrate/1_create_logistics_migration.rb

@@ -0,0 +1,24 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class CreateLogisticsMigration < ActiveRecord::Migration[4.2]; end
+else
+  class CreateLogisticsMigration < ActiveRecord::Migration; end
+end
+CreateLogisticsMigration.class_eval do
+  def self.up
+    create_table Logisticed.logisticed_table do |t|
+      t.string :source_type
+      t.send(Logisticed.logisticed_source_id_column_type, :source_id)
+      t.string :operator_type
+      t.send(Logisticed.logisticed_operator_id_column_type, :operator_id)
+      t.string :value
+      t.string :remote_ip
+      t.string :request_uuid
+      t.datetime :created_at, null: false
+    end
+    add_index Logisticed.logisticed_table, [:source_type, :source_id], name: 'logisticed_source_index'
+  end
+
+  def self.down
+    drop_table Logisticed.logisticed_table
+  end
+end

data/lib/logisticed.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'logisticed/version'
+
+module Logisticed
+  class Migration < Rails::Engine; end
+  class Error < StandardError; end
+  extend ActiveSupport::Autoload
+  class << self
+    attr_accessor :logisticed_table, :logisticed_source_id_column_type, :logisticed_operator_id_column_type, :current_user_method
+    def config
+      yield(self)
+    end
+
+    def logistic_class
+      @logistic_class ||= Logistic
+    end
+
+    def store
+      Thread.current[:logisticed_store] ||= {}
+    end
+  end
+
+  @current_user_method                = :current_user
+  @logisticed_table                   = :logistics
+  @logisticed_source_id_column_type   = :integer
+  @logisticed_operator_id_column_type = :integer
+end
+require 'logisticed/logistic'
+require 'logisticed/logisticer'
+::ActiveRecord::Base.include Logisticed::Logisticer
+require 'logisticed/sweeper'
+
+ActiveSupport.on_load(:active_record) do
+  include Logisticed
+end

data/lib/logisticed/logistic.rb

@@ -0,0 +1,23 @@
+module Logisticed
+  class Logistic < ::ActiveRecord::Base
+    belongs_to :source, polymorphic: true
+    belongs_to :operator, polymorphic: true
+    before_create :set_logistic_user
+
+    def self.as_user(user)
+      last_logisticed_user = ::Logisticed.store[:logisticed_user]
+      ::Logisticed.store[:logisticed_user] = user
+      yield
+    ensure
+      ::Logisticed.store[:logisticed_user] = last_logisticed_user
+    end
+
+    private
+
+    def set_logistic_user
+      self.operator ||= ::Logisticed.store[:logisticed_user] # from .as_user
+      self.operator ||= ::Logisticed.store[:current_user].try!(:call) # from Sweeper
+      nil # prevent stopping callback chains
+    end
+  end
+end

data/lib/logisticed/logisticer.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Logisticed
+  module Logisticer
+    extend ActiveSupport::Concern
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def logisticed(attr, options = {})
+        struct = ListenerStruct.new(self, attr, options)
+        has_many :logistics, -> { order(created_at: :asc) },
+                 as: :source, class_name: Logisticed.logistic_class.name,
+                 inverse_of: :source
+
+        has_one :logistic, -> { order(created_at: :asc) },
+                as: :source, class_name: Logisticed.logistic_class.name,
+                inverse_of: :source
+
+        struct.normalize_values.each do |value|
+          has_many "#{value}_logistics".to_sym, -> { where(value: value).order(created_at: :asc) }, as: :source, class_name: Logisticed.logistic_class.name, inverse_of: :source
+        end
+
+        after_commit do
+          if new_value = send("#{attr}_previous_change")&.last.presence
+            execute_method_name = "#{attr}_change_to_#{new_value}"
+            send(execute_method_name) if respond_to?(execute_method_name)
+          end
+        end
+
+        class_eval do
+          def value_change_by(value)
+            logistics.where(value: value).last
+          end
+
+          struct.normalize_values.each do |value|
+            define_method "#{value}_at" do
+              value_change_by(value)&.created_at
+            end
+
+            define_method "#{value}_by" do
+              value_change_by(value)&.operator
+            end
+
+            define_method "#{attr}_change_to_#{value}" do
+              logistics.create(value: value)
+            end
+          end
+        end
+      end
+    end
+
+    class ListenerStruct
+      class ArgumentError < StandardError; end
+      extend Forwardable
+      attr_reader :klass, :column, :options, :values
+      def initialize(klass, column, options)
+        @klass   = klass
+        @column  = column.to_s
+        @options = options
+        @values  = options[:values]
+      end
+
+      def normalize_values
+        @normalize_values ||= \
+          if options[:only].present?
+            (column_enum_values & options[:only]).uniq
+          elsif options[:except].present?
+            (column_enum_values - options[:only]).uniq
+          else
+            column_enum_values
+          end
+      end
+
+      private
+
+      def column_enum_values
+        @column_enum_values ||= begin
+          if values.present?
+            case values
+            when Hash
+              values.keys.map(&:to_s)
+            when Array
+              values
+            else
+              raise ArgumentError, 'values must be Array or Hash'
+            end
+          else
+            klass.send(column.pluralize).keys.map(&:to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logisticed/sweeper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Logisticed
+  class Sweeper
+    STORED_DATA = {
+      current_remote_address: :remote_ip,
+      current_request_uuid: :request_uuid,
+      current_user: :current_user
+    }
+
+    delegate :store, to: ::Logisticed
+
+    def around(controller)
+      self.controller = controller
+      # set store[:current_remote_address], store[:current_request_uuid], store[:current_user]
+      STORED_DATA.each { |k, m| store[k] = send(m) }
+      yield
+    ensure
+      self.controller = nil
+      STORED_DATA.keys.each { |k| store.delete(k) }
+    end
+
+    def current_user
+      lambda do
+        if controller.respond_to?(Logisticed.current_user_method, true)
+          controller.send(Logisticed.current_user_method)
+        end
+      end
+    end
+
+    def controller
+      store[:current_controller]
+    end
+
+    def controller=(value)
+      store[:current_controller] = value
+    end
+
+    def remote_ip
+      controller.try(:request).try(:remote_ip)
+    end
+
+    def request_uuid
+      controller.try(:request).try(:uuid)
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  if defined?(ActionController::Base)
+    # Logisticed::Sweeper.new 的目的是保证每次访问一个action时都是一个单独的线程
+    ActionController::Base.around_action Logisticed::Sweeper.new
+  end
+  if defined?(ActionController::API)
+    ActionController::API.around_action Logisticed::Sweeper.new
+  end
+end

data/lib/logisticed/version.rb

@@ -0,0 +1,3 @@
+module Logisticed
+  VERSION = "0.1.0"
+end

data/logisticed.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/logisticed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logisticed"
+  spec.version       = Logisticed::VERSION
+  spec.authors       = ["sumingxuan"]
+  spec.email         = ["1154621382@qq.com"]
+
+  spec.summary       = %q{simple manage business change datas}
+  spec.description   = %q{轻松的管理你的业务变更的操作人和操作时间}
+  spec.homepage      = "https://github.com/SuMingXuan/logisticed"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: logisticed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sumingxuan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-22 00:00:00.000000000 Z
+dependencies: []
+description: 轻松的管理你的业务变更的操作人和操作时间
+email:
+- 1154621382@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/migrate/1_create_logistics_migration.rb
+- lib/logisticed.rb
+- lib/logisticed/logistic.rb
+- lib/logisticed/logisticer.rb
+- lib/logisticed/sweeper.rb
+- lib/logisticed/version.rb
+- logisticed.gemspec
+homepage: https://github.com/SuMingXuan/logisticed
+licenses: []
+metadata:
+  homepage_uri: https://github.com/SuMingXuan/logisticed
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: simple manage business change datas
+test_files: []