rails_extend 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44da1bf70eac9a513d304650420ecde6fa0b5c0f9704cab8b9fd25c37adbe2aa
-  data.tar.gz: 5a3f14a91bfa7d658a5b711f39dafc5b74e6c7e04c6fbf4b2f144e7d80cfc33f
+  metadata.gz: 14d1782a27b364e822118d37e190402e57785f1d797da73ac4307b94534caeea
+  data.tar.gz: 6f65c751e6b69b1093f53b7c4b646b14a0b9d5df70ac8feefba7cb718affebf8
 SHA512:
-  metadata.gz: 7b0f5e3e417104b54cea02b470fe876bed7fe700af15229a0e0f9a71357b6bb60a8220d5019036e22ca802469bf478e3dbe9cb8bc64a05e91d0682a9e6196835
-  data.tar.gz: d33802bafb444a11f8966eca5c96ccc390816d8b83820a89729dd203d5de574a364eff48a1d6406f76491dfc4b91754deb4086fe59e5021a2582ad81d6ce42e6
+  metadata.gz: 527e0bedcc3e428fa42d9b6a7cec61a0948f486d48708e4b2066552ab144bf2d52fb0f20fcb6f763fc952ea8070db36d9b8c759905939e3c796fa4354bc91bfc
+  data.tar.gz: 916b0e47282b51940ab35aff249d54122530e13b2f155dee4e0de52b7d83c4a18d236ce1321eea3bf08ddebfe29f6096100887c89a395c020e6822feb0750c6b

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021-Present Mingyuan Qin <mingyuan0715@foxmail.com>
+
+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,46 @@
+# RailsExtend
+
+[![测试](https://github.com/work-design/rails_extend/actions/workflows/test.yml/badge.svg)](https://github.com/work-design/rails_extend/actions/workflows/test.yml)
+[![Docker构建](https://github.com/work-design/rails_extend/actions/workflows/cd.yml/badge.svg)](https://github.com/work-design/rails_extend/actions/workflows/cd.yml)
+[![Gem](https://github.com/work-design/rails_extend/actions/workflows/gempush.yml/badge.svg)](https://github.com/work-design/rails_extend/actions/workflows/gempush.yml)
+
+Rails 通用基础库，对 Rails 的各个组件进行了扩展。
+
+## 功能模块
+* Ruby 核心类扩展，[链接](lib/rails_extend/core)
+* Rails 核心类扩展
+  * ActiveStorage：[链接](lib/rails_com/active_storage) 
+    * 通过 url 同步文件；
+    * 将文件复制到镜像服务器；
+* Rails 元信息: 
+  * [Model](lib/rails_extend/models.rb)
+  * [Routes / Controllers](lib/rails_extend/routes)
+
+## 支持 enum
+```yaml
+# zh.yml
+activerecord:
+  enum:
+    notification:
+      receiver_type:
+        User: 全体用户
+        Member: 成员
+```
+
+```ruby
+t.select :receiver_type, options_for_select(Notification.options_i18n(:receiver_type))
+```
+
+* Override
+```yaml
+activerecord:
+  enum:
+    notification:
+      receiver_type:
+        User: 全体用户
+        Member: # remain this blank
+```
+
+
+## 版权
+遵循 [MIT](https://opensource.org/licenses/MIT) 协议

data/config/locales/en.datetime.yml

@@ -0,0 +1,17 @@
+en:
+  durations:
+    years: years
+    months: months
+    weeks: weeks
+    days: days
+    hours: hours
+    minutes: minutes
+    seconds: seconds
+  duration:
+    years: year
+    months: month
+    weeks: week
+    days: day
+    hours: hour
+    minutes: minute
+    seconds: second

data/config/locales/zh.datetime.yml

@@ -0,0 +1,145 @@
+zh:
+  date:
+    formats:
+      default: '%Y-%m-%d'
+      short: '%b %d'
+      long: '%B %d, %Y'
+    day_names: [星期天, 星期一, 星期二, 星期三, 星期四, 星期五, 星期六]
+    abbr_day_names: [周日, 周一, 周二, 周三, 周四, 周五, 周六]
+    month_names: [~, 一月份, 二月份, 三月份, 四月份, 五月份, 六月份, 七月份, 八月份, 九月份, 十月份, 十一月, 十二月]
+    abbr_month_names: [~, 一月, 二月, 三月, 四月, 五月, 六月, 七月, 八月, 九月, 十月, 十一月, 十二月]
+    week_day:
+      monday:
+        name: 星期一
+        abbr: 周一
+      tuesday:
+        name: 星期二
+        abbr: 周二
+      wednesday:
+        name: 星期三
+        abbr: 周三
+      thursday:
+        name: 星期四
+        abbr: 周四
+      friday:
+        name: 星期五
+        abbr: 周五
+      saturday:
+        name: 星期六
+        abbr: 周六
+      sunday:
+        name: 星期日
+        abbr: 周日
+    month_day:
+      january:
+        name: 一月份
+        abbr: 一月
+      february:
+        name: 二月份
+        abbr: 二月
+      march:
+        name: 三月份
+        abbr: 三月
+      april:
+        name: 四月份
+        abbr: 四月
+      may:
+        name: 五月份
+        abbr: 五月
+      june:
+        name: 六月份
+        abbr: 六月
+      july:
+        name: 七月份
+        abbr: 七月
+      august:
+        name: 八月份
+        abbr: 八月
+      september:
+        name: 九月份
+        abbr: 九月
+      october:
+        name: 十月份
+        abbr: 十月
+      november:
+        name: 十一月份
+        abbr: 十一月
+      december:
+        name: 十二月份
+        abbr: 十二月
+    order:
+      - 年
+      - 月
+      - 天
+    distance_in_words:
+      zero: 今天
+      one: 明天
+      two: 后天
+      three: 大后天
+      other: '%{count} 天后'
+  time:
+    formats:
+      default: '%a, %d %b %Y %H:%M:%S %z'
+      short: '%d %b %H:%M'
+      long: '%B %d, %Y %H:%M'
+    am: 上午
+    pm: 下午
+  datetime:
+    distance_in_words:
+      half_a_minute: 半分钟
+      less_than_x_seconds:
+        one: 不到1秒
+        other: '不到%{count}秒'
+      x_seconds:
+        one: 1秒
+        other: '%{count}秒'
+      less_than_x_minutes:
+        one: 不到1分钟
+        other: '不到%{count}分钟'
+      x_minutes:
+        one: 1分钟
+        other: '%{count}分钟'
+      about_x_hours:
+        one: 1小时
+        other: '%{count}小时'
+      x_days:
+        one: 1天
+        other: '%{count}天'
+      about_x_months:
+        one: 1个月
+        other: '%{count}个月'
+      x_months:
+        one: 1个月
+        other: '%{count} months'
+      about_x_years:
+        one: 1年
+        other: '%{count} years'
+      over_x_years:
+        one: '超过1年'
+        other: '%{count} 年'
+      almost_x_years:
+        one:  'almost 1 year'
+        other: 'almost %{count} years'
+    prompts:
+      year: 年
+      month: 月
+      day: 日
+      hour: 小时
+      minute: 分钟
+      second: 秒
+  durations:
+    years: 年
+    months: 个月
+    weeks: 个周
+    days: 天
+    hours: 小时
+    minutes: 分钟
+    seconds: 秒
+  duration:
+    years: 年
+    months: 月
+    weeks: 周
+    days: 天
+    hours: 小时
+    minutes: 分钟
+    seconds: 秒

data/config/locales/zh.support.yml

@@ -0,0 +1,52 @@
+zh:
+  number:
+    human:
+      format:
+        # These five are to override number.format and are optional
+        # separator:
+        delimiter: ""
+        precision: 0
+        significant: false
+        strip_insignificant_zeros: false
+      # Used in number_to_human_size()
+      storage_units:
+        # Storage units output formatting.
+        # %u is the storage unit, %n is the number (default: 2 MB)
+        format: "%n %u"
+        units:
+          byte:
+            one: 字节
+            other: 字节
+          kb: KB
+          mb: MB
+          gb: GB
+          tb: TB
+          pb: PB
+          eb: EB
+      # Used in NumberHelper.number_to_human()
+      decimal_units:
+        format: "%n %u"
+        units:
+          femto: Quadrillionth
+          pico: Trillionth
+          nano: Billionth
+          micro: Millionth
+          mili: Thousandth
+          centi: 分
+          deci: 角
+          unit: ""
+          ten:
+            one: 拾
+            other: 拾
+          hundred: 佰
+          thousand: 仟
+          ten_thousand: 万
+          million: 佰万
+          billion: Billion
+          trillion: Trillion
+          quadrillion: Quadrillion
+  support:
+    array:
+      words_connector: ' '
+      two_words_connector: ' '
+      last_word_connector: ' '

data/lib/generators/rails_extend/ignore_generator.rb

@@ -0,0 +1,27 @@
+module RailsExtend
+  module Generators
+    class IgnoreGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      attr_reader :ignore_models
+
+      def copy_initializer_file
+        puts "#{'*-' * 40}"
+        Models.ignore_models.each do |count, models|
+          puts "#{count.to_s.rjust(2, ' ')}: #{models.inspect}"
+        end
+        puts "#{'*-' * 40}"
+
+        limit = args[0].to_i
+        @ignore_models = Models.ignore_models.select(&->(k, v){ k <= limit })
+
+        template 'initializer.rb', 'config/initializers/rails_extend.rb'
+      end
+
+      def show_readme
+        if behavior == :invoke
+          readme 'README.md'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_extend/migrations_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# bin/rails g rails_com:migrations
+require 'rails/generators/active_record/migration'
+
+class RailsExtend::MigrationsGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+  attr_reader :tables
+
+  def create_migration_file
+    file_name = "extend_migration_#{file_index}"
+
+    RailsExtend::Models.db_tables_hash.each do |mig_paths, tables|
+      next if tables.blank?
+      @tables = tables
+      path = Array(mig_paths)[0]
+      migration_template 'migration.rb', File.join(path, "#{file_name}.rb")
+    end
+  end
+
+  def file_index
+    ups = ActiveRecord::Base.connection.migration_context.migrations_status.select do |status, version, name|
+      status == 'up' && name.start_with?('Extend migration ')
+    end
+    if ups.present?
+      index = ups[-1][-1].delete_prefix 'Extend migration '
+      index.to_i + 1
+    else
+      1
+    end
+  end
+
+end

data/lib/generators/rails_extend/remove_table_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# bin/rails g rails_com:rename_module new old
+require 'rails/generators/active_record/migration'
+
+class RailsExtend::RemoveTableGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+  attr_reader :tables
+
+  def create_migration_file
+    @tables = RailsExtend::Models.unbound_tables
+    file_name = "extend_remove_table_#{file_index}"
+
+    migration_template 'remove_table.rb', File.join(db_migrate_path, "#{file_name}.rb")
+  end
+
+  def file_index
+    ups = ActiveRecord::Base.connection.migration_context.migrations_status.select do |status, version, name|
+      status == 'up' && name.start_with?('Extend remove table ')
+    end
+    if ups.present?
+      index = ups[-1][-1].delete_prefix 'Extend remove table '
+      index.to_i + 1
+    else
+      1
+    end
+  end
+
+end

data/lib/generators/rails_extend/rename_module_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# bin/rails g rails_com:rename_module new old
+require 'rails/generators/active_record/migration'
+
+class RailsExtend::RenameModuleGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+  attr_reader :tables
+
+  def create_migration_file
+    @tables = RailsExtend::Models.migrate_modules_hash.invert
+    file_name = "extend_rename_module_#{file_index}"
+
+    migration_template 'rename_module.rb', File.join(db_migrate_path, "#{file_name}.rb")
+  end
+
+  def file_index
+    ups = ActiveRecord::Base.connection.migration_context.migrations_status.select do |status, version, name|
+      status == 'up' && name.start_with?('Extend rename module ')
+    end
+    if ups.present?
+      index = ups[-1][-1].delete_prefix 'Extend rename module '
+      index.to_i + 1
+    else
+      1
+    end
+  end
+
+end

data/lib/generators/rails_extend/templates/README.md

@@ -0,0 +1,2 @@
+
+已创建配置文件: config/initializers/rails_extend.rb, 忽略自动 migration 的 model 。

data/lib/generators/rails_extend/templates/initializer.rb.tt

@@ -0,0 +1,10 @@
+RailsExtend.configure do |config|
+  config.ignore_models = [
+  <%- ignore_models.each do |count, models| -%>
+    # 已定义 <%= count %> 个 attribute
+  <%- models.each do |model| -%>
+    '<%= model %>',
+  <%- end -%>
+  <%- end -%>
+  ]
+end

data/lib/generators/rails_extend/templates/migration.rb.tt

@@ -0,0 +1,35 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+
+  def change
+<% tables.each do |table_name, attributes| -%>
+
+  <%- if attributes[:table_exists] -%>
+  <%- attributes[:add_references].each do |reference, options| -%>
+    add_belongs_to :<%= table_name %>, :<%= options[:name] %><%= options[:reference_options] %>
+  <%- end -%>
+  <%- attributes[:add_attributes].each do |attribute, options| -%>
+    add_column :<%= table_name %>, :<%= attribute %>, :<%= options[:migrate_type] %><%= options[:attribute_options] %>
+  <%- end -%>
+  <%- attributes[:remove_attributes].each do |attribute, options| -%>
+    remove_column :<%= table_name %>, :<%= attribute %>, :<%= options[:migrate_type] %><%= options[:attribute_options] %>
+  <%- end -%>
+  <%- else -%>
+    create_table :<%= table_name %> do |t|
+    <%- attributes[:add_references].each do |reference, options| -%>
+      t.belongs_to :<%= options[:name] %><%= options[:reference_options] %>
+    <%- end -%>
+    <%- attributes[:add_attributes].each do |attribute, options| -%>
+      t.<%= options[:migrate_type] %> :<%= attribute %><%= options[:attribute_options] %>
+    <%- end -%>
+    <%- if attributes[:timestamps].blank? -%>
+      t.timestamps
+    <%- end -%>
+    <%- attributes[:indexes].each do |index| -%>
+      t.index <%= index[:index].inspect %><%= index[:index_options] %>
+    <%- end -%>
+    end
+  <%- end -%>
+<%- end -%>
+  end
+
+end

data/lib/generators/rails_extend/templates/remove_table.rb.tt

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+
+  def change
+  <%- tables.each do |table| -%>
+    drop_table :<%= table %>
+  <%- end -%>
+  end
+
+end

data/lib/generators/rails_extend/templates/rename_module.rb.tt

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+
+  def change
+  <%- tables.each do |old_name, new_name| -%>
+    rename_table :<%= old_name %>, :<%= new_name %>
+  <%- end -%>
+  end
+
+end

data/lib/rails_extend/active_model/type_value.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveModel
+  module TypeValue
+    attr_reader :options
+
+    # 让 attribute 方法支持更多选项
+    def initialize(precision: nil, limit: nil, scale: nil, **options)
+      @options = options
+      super(precision: precision, limit: scale, scale: limit)
+    end
+
+    def input_type
+      type
+    end
+
+    def migrate_type
+      return type if type
+      return subtype.type if respond_to?(:subtype) && subtype.type
+      :string
+    end
+
+  end
+end
+
+ActiveModel::Type::Value.prepend RailsExtend::ActiveModel::TypeValue

data/lib/rails_extend/active_model.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rails_extend/active_model/type_value'

data/lib/rails_extend/active_record/enum.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveRecord
+  module Enum
+
+    def options_i18n(attribute)
+      h = ::I18n.t enum_key(attribute), default: {}
+      h.compact!
+
+      if h.is_a?(Hash) && h.present?
+        return h.invert
+      end
+
+      if h.blank?
+        name = attribute.to_s.pluralize
+        if respond_to?(name)
+          enum_hash = public_send(name)
+          h = enum_hash.keys.map { |i| [i.humanize, i] }.to_h
+        end
+      end
+
+      h
+    end
+
+    def help_i18n(attribute)
+      return nil if attribute.blank?
+      help_key = RailsExtend.config.help_key.call(self, attribute)
+      ::I18n.t help_key, default: nil
+    end
+
+    def enum_i18n(attribute, value)
+      h = ::I18n.t enum_key(attribute), default: {}
+      h.compact!
+
+      v = nil
+      if h.is_a?(Hash)
+        v = h[value] ? h[value] : h[value.to_s.to_sym]
+      end
+
+      if v.nil? && value.blank?
+        v = value.to_s
+      end
+
+      if v.nil?
+        v = human_attribute_name(value)
+      end
+
+      v
+    end
+
+    def enum_key(attribute)
+      RailsExtend.config.enum_key.call(self, attribute)
+    end
+
+    def self.extended(mod)
+      mod.attribute_method_suffix '_i18n'
+
+      mod.class_exec do
+        def attribute_i18n(attr)
+          if [:json, :jsonb].include? self.class.columns_hash[attr]&.type
+            send(attr)&.transform_keys! { |key| self.class.human_attribute_name(key) }
+          else
+            self.class.enum_i18n attr, send(attr)
+          end
+        end
+      end
+    end
+
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  extend RailsExtend::ActiveRecord::Enum
+end