activemodel_object_info 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fbb93d73230b877ddef2d140e3735c97b4bbf10f03273401f4be77f5540dbdd
+  data.tar.gz: a758c1d6b7623810b01f0379d700e4e70d7ecc8d0c013c86592be06cae68b1eb
+SHA512:
+  metadata.gz: ea99c0ec6222036125acf0143a51832c70d4146f4b9b7f5e70277405d92f5819fc1d9d389ee9063d1f6b7998d06eebe873a9f465783873f7b50168dfbea6e960
+  data.tar.gz: 8fc1a83c8c641f97de5b188dbeddeb89f7be52524074d95a515546606bff1a08ab38e244296249aebd3d8bca9f4311ad5108af788c97710030ff04e9cfa1a4ea

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,76 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'examples/**/*'
+  NewCops: enable
+
+# 弱ruby版本的gem，所有目前不需要检测ruby版本
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: false
+Layout/LineLength:
+  Max: 400
+
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 200
+# 块的最大长度，因为API文件中会通过块包含通用路由，所以这里放大一些。
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*_spec.rb'
+Metrics/BlockNesting:
+  Max: 5
+Metrics/ClassLength:
+  Max: 600
+Metrics/MethodLength:
+  Enabled: true
+  Max: 100
+# 保持和 Class 的长度一致。对于一些纯设定类仅300行并不够，600行以上需要拆分。
+Metrics/ModuleLength:
+  Max: 600
+Metrics/PerceivedComplexity:
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 50
+
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: false
+Style/HashTransformValues:
+  Enabled: false
+Style/Next:
+  MinBodyLength: 4
+Style/IfInsideElse:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/RaiseArgs:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.ruby-gemset

@@ -0,0 +1 @@
+activerecord-object-info

data/.ruby-version

@@ -0,0 +1 @@
+2.6.7

data/CHANGELOG

@@ -0,0 +1 @@
+First Version

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 sherlock.ma@rccchina.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 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activemodel-object-info.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    activemodel_object_info (0.1.6)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.1)
+      activesupport (= 5.2.4.1)
+    activerecord (5.2.4.1)
+      activemodel (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      arel (>= 9.0)
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.1)
+    concurrent-ruby (1.1.5)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel_object_info!
+  bundler
+  rake (~> 10.0)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Shiner
+
+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,43 @@
+# Activemodel::Object::Info
+
+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/activemodel/object/info`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activemodel-object-info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel-object-info
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activemodel-object-info. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activemodel::Object::Info project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activemodel-object-info/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/activemodel_object_info.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activemodel_object_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activemodel_object_info'
+  spec.version       = ActivemodelObjectInfo::Version::VERSION
+  spec.authors       = ['shiner']
+  spec.email         = ['shiner527@hotmail.com']
+
+  spec.summary       = 'Build a hash based on active record attributes.'
+  spec.description   = 'Build a hash based on active record attributes.'
+  spec.homepage      = 'https://github.com/shiner527/activemodel-object-info'
+  spec.license       = 'MIT'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/shiner527/activemodel-object-info.git'
+  spec.metadata['changelog_uri'] = 'https://github.com/shiner527/activemodel-object-info/CHANGELOG'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel/object/info"
+
+# 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/activemodel_object_info.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'activemodel_object_info/extend'
+require 'activemodel_object_info/version'
+require 'activemodel_object_info/base'
+require 'activemodel_object_info/table_definition'
+require 'activemodel_object_info/deleted_operation'
+
+#
+# 扩展模组。
+#
+# @author shiner527 <shiner527@hotmail.com>
+#
+module ActivemodelObjectInfo
+end

data/lib/activemodel_object_info/base.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ActivemodelObjectInfo
+  #
+  # 通用的设置操作项相关的模型方法和处理。
+  #
+  # @author shiner527 <shiner527@hotmail.com>
+  #
+  module Base
+    #
+    # 对象信息输出。主要返回给前端一个可用的散列（会被转化为JSON格式）格式的信息并传递给前端。
+    #
+    # @param [Hash] options 设置选项
+    # @option options [Array<Symbol, Hash>] :attributes 具体每一项输出的设置数组。每个元素既可以是标识符实例也可以是一个散列实例。
+    #  如果是标识符实例，则表示输出该属性。如果是一个散列实例，则按照散列中的设定值去生成对应的内容。
+    # @option options [Array<Symbol>] :only 给出具体可以用来输出的字段属性名数组。
+    #
+    # @return [Hash] 返回的处理过的该对象的信息散列。
+    #
+    def instance_info(**options)
+      # puts "ARGS: #{args}, OPTIONS: #{options}"
+      # 参考默认的 options
+      options = "#{self.class}::INSTANCE_INFO".safe_constantize || {} if options.blank?
+      result = {}
+      # 仅包含的字段
+      only_attributes = (options[:only] || []).map(&:to_sym)
+      # 要排除的字段
+      # 默认不包含 :deleted, :deleted_by 和 :deleted_at 三个字段
+      default_deleted_column = ::Constants::Base::TABLE_COLUMN_DELETE_COLUMN rescue 'deleted'
+      default_except_attrs = [
+        default_deleted_column,
+        "#{default_deleted_column}_by",
+        "#{default_deleted_column}_at",
+      ]
+      except_attributes = (options[:except] || default_except_attrs).map(&:to_sym)
+      # 字段的具体属性设置
+      attribute_configs = options[:attributes] || []
+      # 计算要输出的参数名称
+      output_attributes = attribute_names.map(&:to_sym)
+      output_attributes &= only_attributes if only_attributes.present?
+      output_attributes -= except_attributes
+
+      # puts "Excepts: #{except_attributes}, Only: #{only_attributes}, Output: #{output_attributes}"
+      # 这里保证了要引入的类中含有 attributes 方法，且为 Hash 类型
+      attribute_configs.each do |attr_config|
+        # 如果设置项单纯是字符串或者标识符的情况
+        if [::String, ::Symbol].any? { |attr_class| attr_config.is_a?(attr_class) }
+          attribute_name = attr_config.to_sym
+          current_attr_config = {}
+        elsif attr_config.is_a?(::Hash) # 如果设置项为一个散列
+          current_attr_config = attr_config.deep_symbolize_keys
+          attribute_name = current_attr_config[:name]
+        else # 如果不是指定的类型，则跳过进行下一项
+          next
+        end
+        # 输出的参数名称，如果用户给出了 as 指定，优先用用户给定的，否则默认用属性名
+        raw_name = current_attr_config[:as].present? ? current_attr_config[:as].to_sym : attribute_name
+        # 过滤器输出字段，如果给定了一个块，则使用用户指定的，否则默认为没有过滤器
+        filter = current_attr_config[:filter]
+
+        # 获取真正对应的属性的名称和其值
+        k = raw_name
+        # 当类型为抽象类时，是不会有对应的方法和属性的，因此直接设置为 nil 并期待之后的 filter 等规则来生成实际值。
+        v = current_attr_config[:type] == :abstract ? nil : __send__(k)
+
+        # puts "instance attributes #{k}: #{v}(#{v.class.name})"
+        # 如果不是要输出的字段则跳过，或者如果不是给出type设置项为 :method 或者 :abstract 也跳过。
+        next unless output_attributes.include?(k) || %i[abstract method].include?(current_attr_config[:type])
+
+        # 赋值。如果有过滤器，优先使用过滤器
+        if filter.present?
+          result[attribute_name] = case filter
+                                   when ::Proc
+                                     instance_exec(v, &filter)
+                                   when ::Symbol
+                                     __send__(filter)
+                                   else
+                                     filter
+                                   end
+        # 如果值是时间类别的字段，默认转换为时间日期格式的字符串
+        elsif [::Date, ::Time, ::DateTime].any? { |time_class| v.is_a?(time_class) }
+          # 时间日期格式设定，优先使用当前字段自定义，否则使用通用自定义，最后使用默认格式
+          attribute_format = current_attr_config[:format].present? ? current_attr_config[:format] : options[:datetime_format]
+          result[attribute_name] = if attribute_format.to_s == 'standard' # 会被转换为标准时间日期格式
+                                     v
+                                   elsif attribute_format.present? # 按照设定的 format_date 方法的格式
+                                     v.format_date(attribute_format.to_sym)
+                                   else # 默认使用 'yyyy-MM-dd hh:mm:ss' 的格式
+                                     v.format_date(:full)
+                                   end
+        else # 其他值类型默认赋值自己
+          result[attribute_name] = v
+        end
+      end
+
+      # 过滤第一层键名为符号并返回
+      result.symbolize_keys!
+    end
+  end
+end

data/lib/activemodel_object_info/deleted_operation.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ActivemodelObjectInfo
+  #
+  # 用来进行和删除操作相关的数据库模型的功能模组。主要结合了使用 +:deleted+ 字段标识数据软删除的功能。
+  #
+  # @author shiner527 <shiner527@hotmail.com>
+  #
+  module DeletedOperation
+    extend ::ActiveSupport::Concern
+
+    # 当被 include 关键字引入后的处理
+    included do |_|
+      # 定义好默认的删除查询语句
+      deleted_field = ::Constants::Base::TABLE_COLUMN_DELETE_COLUMN
+      deleted_value_valid = ::Constants::Base::TABLE_COLUMN_DELETE_VALID
+      default_scope { where(deleted_field.to_sym => deleted_value_valid) }
+
+      # 通用的删除过程
+      define_method(:delete_block) do |**options|
+        # 处理可选项参数
+        options[:refresh_updated] = options[:refresh_updated].nil? ? false : options[:refresh_updated]
+
+        # 必须要传递操作的用户ID信息
+        raise ArgumentError, 'Must give user id!' if options[:user_id].blank?
+
+        # 获取更新人字段，删除人字段
+        updated_by_field = (options[:updated_by_field] || "#{::Constants::Base::TABLE_COLUMN_UPDATED_COLUMN}_by").to_sym
+        deleted_by_field = (options[:deleted_by_field] || "#{::Constants::Base::TABLE_COLUMN_DELETE_COLUMN}_by").to_sym
+        deleted_at_field = (options[:deleted_at_field] || "#{::Constants::Base::TABLE_COLUMN_DELETE_COLUMN}_at").to_sym
+        # 设置删除状态为已失效
+        __send__("#{deleted_field}=", ::Constants::Base::TABLE_COLUMN_DELETE_INVALID)
+        # 设置删除人、删除时间和更新人
+        __send__("#{deleted_by_field}=", options[:user_id]) if respond_to?(deleted_by_field)
+        __send__("#{deleted_at_field}=", Time.now.localtime) if respond_to?(deleted_at_field)
+        __send__("#{updated_by_field}=", options[:user_id]) if respond_to?(updated_by_field)
+      end
+
+      # 定义删除方法，但是不覆盖 ActiveRecord 的同名方法。
+      define_method(:soft_delete) do |**options|
+        opts = options.deep_symbolize_keys
+        delete_block(**opts)
+        # 根据设置决定是否刷更新时间
+        save(touch: opts[:refresh_updated])
+      end
+
+      # 定义删除方法，区别为最终调用 save! 方法更新数据，所以遇到异常会抛出异常
+      define_method(:soft_delete!) do |**options|
+        opts = options.deep_symbolize_keys
+        delete_block(**opts)
+        # 根据设置决定是否刷更新时间
+        save!(touch: opts[:refresh_updated])
+      end
+    end
+  end
+end

data/lib/activemodel_object_info/extend.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# 加载扩展
+::Dir.glob('extends/**/*.rb').sort.each do |filename|
+  require_relative filename
+end

data/lib/activemodel_object_info/extends/ruby_generals.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+#
+# 时间类型相关类通用实例方法定义模块。
+#
+# @author shiner527 <shiner527@hotmail.com>
+#
+module TimeInstance
+  #
+  # 时间格式化为指定的字符串。
+  #
+  # @param [Symbol] type 指定需要转换的具体格式。默认为 +:date+ 类型的格式。
+  #
+  # @return [String] 返回转换后的字符串。
+  #
+  def format_date(type = :date)
+    case type
+    when :full
+      strftime('%Y-%m-%d %H:%M:%S')
+    when :min
+      strftime('%Y-%m-%d %H:%M')
+    when :date
+      strftime('%Y-%m-%d')
+    when :year
+      strftime('%Y')
+    end
+  end
+end
+
+#
+# 扩展 Date 类
+#
+class Date
+  include ::TimeInstance
+end
+
+#
+# 扩展 Time 类
+#
+class Time
+  include ::TimeInstance
+end
+
+#
+# 扩展 DateTime 类
+#
+class DateTime
+  include ::TimeInstance
+end
+
+#
+# 扩展 Array 类
+#
+class Array
+  #
+  # 找到数组中为空的元素，并将去掉空元素的结果返回为一个新数组。空的定义由 +blank?+ 方法确定。本方法<b>不会改变</b>数组自身。
+  #
+  # @return [Array] 返回不包含空元素的数组作为结果。
+  #
+  def compact_blank
+    result = []
+    each { |item| result << item unless item.blank? }
+    result
+  end
+
+  #
+  # 去掉空元素并将去掉后的数组作为结果返回。空的定义由 +blank?+ 方法确定。本方法<b>会改变</b>数组自身。
+  #
+  # @return [Array] 返回不包含空元素的数组作为结果。
+  #
+  def compact_blank!
+    delete_if(&:blank?)
+  end
+end
+
+#
+# 扩展 Array 类
+#
+class Hash
+  #
+  # 找到散列中键值对的值为空的元素，并将去掉这样的键值对的结果返回为一个新散列。空的定义由 +blank?+ 方法确定。本方法<b>不会改变</b>散列自身。
+  #
+  # @return [Array] 返回不包含键值对中值为空元素的散列作为结果。
+  #
+  def compact_blank
+    result = {}
+    each { |k, v| result[k] = v unless v.blank? }
+    result
+  end
+
+  #
+  # 去掉散列中键值对的值为空的键值对，并将去掉后的散列作为结果返回。空的定义由 +blank?+ 方法确定。本方法<b>会改变</b>散列自身。
+  #
+  # @return [Array] 返回不包含键值对中值为空元素的散列作为结果。
+  #
+  def compact_blank!
+    delete_if { |_k, v| v.blank? }
+  end
+end

data/lib/activemodel_object_info/table_definition.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module ActivemodelObjectInfo
+  #
+  # 重新扩展一些方法，用来方便在创建迁移文件的时候进行一些通用类的设定。
+  #
+  # @author shiner527 <shiner527@hotmail.com>
+  #
+  module TableDefinition
+    #
+    # 生成操作相关的字段。包含操作人、操作时间等信息。
+    #
+    # @param [Symbol, String] fields 要生成的操作字段的名称。可以是字符串也可以是符号格式。相当于实际的前缀，会根据后续设置选项决定生成的字段内容。
+    # @param [Hash] options 具体的设置选项，详见选项介绍。
+    #
+    # @option options [String] :operator_prefix 操作人字段前缀，默认为 +nil+ 。
+    # @option options [String] :operator_suffix 操作人字段后缀，默认为 +'_by'+ 。
+    # @option options [Boolean] :with_operator 是否生成用来记录对应操作的操作人信息，默认为 +true+ 。
+    #  如果允许生成的话，会生成 <em><prefix></em><em><operation></em><em><suffix></em> 字段，默认为 <b>bigint</b> 类型。
+    #
+    #  * <em><prefix></em>: 前缀，由可选参数 <b>:operator_prefix</b> 提供，如果没有的话则使用默认值。
+    #  * <em><operation></em>: 字段本体名称，即参数 <b>fields</b> 中给出的具体每个字段的名称本体。
+    #  * <em><suffix></em>: 后缀，由可选参数 <b>:operator_suffix</b> 提供，如果没有的话则使用默认值。
+    #
+    # @option options [String] :timestamp_prefix 操作时间字段前缀，默认为 +nil+ 。
+    # @option options [String] :timestamp_suffix 操作时间字段后缀，默认为 +'_at'+ 。
+    # @option options [Boolean] :with_timestamp 是否生成用来记录对应操作的时间戳信息，默认为 +true+ 。
+    #  如果允许生成的话，会生成 <em><prefix></em><em><operation></em><em><suffix></em> 字段，默认为 <b>datetime</b> 类型。
+    #
+    #  * <em><prefix></em>: 前缀，由可选参数 <b>:timestamp_prefix</b> 提供，如果没有的话则使用默认值。
+    #  * <em><operation></em>: 字段本体名称，即参数 <b>fields</b> 中给出的具体每个字段的名称本体。
+    #  * <em><suffix></em>: 后缀，由可选参数 <b>:timestamp_suffix</b> 提供，如果没有的话则使用默认值。
+    #
+    # @example
+    #  operation_columns(:create, with_operator: true, operator_prefix: 'my_', operator_suffix: '_user')
+    #  # => 会生成名为 'my_create_user' 的字段用来记录创建人信息。
+    #
+    def operation_columns(*fields, **options)
+      # puts "operation_columns(#{fields}, #{options})"
+      # 初始化设置选项
+      with_operator = options[:with_operator].nil? ? true : options[:with_operator]
+      with_timestamp = options[:with_timestamp].nil? ? true : options[:with_timestamp]
+      operator_prefix = options[:operator_prefix]
+      operator_suffix = options[:operator_suffix] || '_by'
+      timestamp_prefix = options[:timestamp_prefix]
+      timestamp_suffix = options[:timestamp_suffix] || '_at'
+      # 依照每个字段进行设置
+      fields.each do |field|
+        # 如果要生成操作人信息
+        if with_operator
+          operator_column_name = operator_prefix.to_s + field.to_s + operator_suffix.to_s
+          column(operator_column_name, :bigint, index: true, comment: '操作人') if operator_column_name.present?
+        end
+        # 如果要生成操作时间戳信息
+        if with_timestamp
+          timestamp_column_name = timestamp_prefix.to_s + field.to_s + timestamp_suffix.to_s
+          column(timestamp_column_name, :datetime, comment: '操作时间戳') if timestamp_column_name.present?
+        end
+      end
+    end
+
+    #
+    # 生成对应操作的字段，包括操作人和操作时间戳，均使用默认设置。
+    #
+    # @param [Symbol, String] operations 对应的操作。默认会给出 +:created+ 、 +:updated+ 和 +:deleted+ 三个操作名。
+    #  如果参数中的给出操作名含有 +:deleted+ 或者 +'deleted'+ 时，还会生成默认名称为 <b>deleted</b> 整形数字段，用来标识当前记录是否被删除。
+    #  这里该字段的名称由常量 {Constants::Base::TABLE_COLUMN_DELETE_COLUMN} 设定。
+    #  默认值为可用的记录标记值。由常量 {Constants::Base::TABLE_COLUMN_DELETE_DEFAULT} 设定。
+    #
+    def generate_operations(*operations)
+      # puts "generate_operations(#{operations})"
+      action_fields = operations
+      # 默认只有创建、更新和删除相关的字段
+      if action_fields.empty?
+        action_fields = [
+          ::Constants::Base::TABLE_COLUMN_CREATED_COLUMN,
+          ::Constants::Base::TABLE_COLUMN_UPDATED_COLUMN,
+          ::Constants::Base::TABLE_COLUMN_DELETE_COLUMN,
+        ]
+      end
+      action_fields.each do |operation|
+        column(::Constants::Base::TABLE_COLUMN_DELETE_COLUMN, :integer, default: ::Constants::Base::TABLE_COLUMN_DELETE_DEFAULT, comment: '删除标记') if operation.to_sym == :deleted
+        operation_columns(operation)
+      end
+    end
+  end
+end

data/lib/activemodel_object_info/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActivemodelObjectInfo
+  module Version
+    VERSION = '0.1.6'
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: activemodel_object_info
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- shiner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Build a hash based on active record attributes.
+email:
+- shiner527@hotmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- activemodel_object_info.gemspec
+- bin/console
+- bin/setup
+- lib/activemodel_object_info.rb
+- lib/activemodel_object_info/base.rb
+- lib/activemodel_object_info/deleted_operation.rb
+- lib/activemodel_object_info/extend.rb
+- lib/activemodel_object_info/extends/ruby_generals.rb
+- lib/activemodel_object_info/table_definition.rb
+- lib/activemodel_object_info/version.rb
+homepage: https://github.com/shiner527/activemodel-object-info
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shiner527/activemodel-object-info
+  source_code_uri: https://github.com/shiner527/activemodel-object-info.git
+  changelog_uri: https://github.com/shiner527/activemodel-object-info/CHANGELOG
+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: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Build a hash based on active record attributes.
+test_files: []