rails_extend 1.0.0 → 1.0.1

data/lib/rails_extend/active_record/extend.rb

@@ -0,0 +1,200 @@
+module RailsExtend::ActiveRecord
+  module Extend
+
+    def human_name
+      model_name.human
+    end
+
+    def subclasses_tree(tree = {}, node = self)
+      tree[node] ||= {}
+
+      node.subclasses.each do |subclass|
+        tree[node].merge! subclasses_tree(tree[node], subclass)
+      end
+
+      tree
+    end
+
+    def to_fixture
+      require 'rails/generators/test_unit/model/model_generator'
+
+      args = [
+        self.name.underscore
+      ]
+      cols = columns.reject(&->(i){ attributes_by_default.include?(i.name) }).map { |col| "#{col.name}:#{col.type}" }
+
+      generator = TestUnit::Generators::ModelGenerator.new(args + cols, destination_root: Rails.root, fixture: true)
+      generator.instance_variable_set :@source_paths, Array(RailsExtend::Engine.root.join('lib/templates', 'test_unit/model'))
+      generator.invoke_all
+    end
+
+    def com_column_names
+      column_names - attributes_by_default + attachment_reflections.keys
+    end
+
+    def column_attributes
+      columns.map do |column|
+        r = {
+          name: column.name.to_sym,
+          type: column.type
+        }
+        r.merge! null: column.null unless column.null
+        r.merge! default: column.default unless column.default.nil?
+        r.merge! comment: column.comment if column.comment.present?
+        r.merge! column.sql_type_metadata.instance_values.slice('limit', 'precision', 'scale').compact
+        r.symbolize_keys!
+      end
+    end
+
+    def attributes_by_model
+      cols = {}
+
+      attributes_to_define_after_schema_loads.each do |name, column|
+        r = {}
+        r.merge! type: column[0]
+
+        if r[:type].respond_to? :call
+          r.merge! type: r[:type].call(ActiveModel::Type::String.new)
+        end
+
+        if r[:type].respond_to?(:type)
+          r.merge! raw_type: r[:type].type
+        else
+          r.merge! raw_type: r[:type] # 兼容 rails 7 以下
+        end
+
+        case r[:type].class.name
+        when 'ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array'
+          r.merge! array: true
+        when 'ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Range'
+          r.merge! range: true
+        end
+
+        if r[:type].respond_to?(:options) && r[:type].options.present?
+          r.merge! r[:type].options
+        end
+
+        if Rails::VERSION::MAJOR >= 7 && !column[1].instance_of?(Object) # Rails 7, column[1] 为默认值
+          r.merge! default: column[1]
+        elsif Rails::VERSION::MAJOR < 7 # rails 7 以下, column[1] 为 options
+          r.merge! column[1]
+        end
+
+        cols.merge! name => r
+      end
+
+      cols
+    end
+
+    def migrate_attributes_by_model
+      cols = {}
+      attributes_by_model.each do |name, column|
+        r = {}
+        r.merge! column
+        r.merge! migrate_type: column[:raw_type]
+        r.symbolize_keys!
+
+        if r[:type].respond_to? :migrate_type
+          r.merge! migrate_type: r[:type].migrate_type
+        end
+
+        if r[:default].respond_to?(:call)
+          r.delete(:default)
+        end
+
+        if r[:array] && connection.adapter_name != 'PostgreSQL'
+          r.delete(:array)
+          r[:migrate_type] = :json
+          r.delete(:default) if r[:default].is_a? Array
+        end
+
+        if r[:migrate_type] == :json
+          if connection.adapter_name == 'PostgreSQL' # Postgres 替换 json 为 jsonb
+            r[:migrate_type] = :jsonb
+          else
+            r.delete(:default) # mysql 数据库不能接受 json 的默认值
+          end
+        end
+
+        if r[:migrate_type] == :jsonb && connection.adapter_name != 'PostgreSQL'
+          r[:migrate_type] == :json
+          r.delete(:default)
+        end
+
+        r.merge! attribute_options: r.slice(:limit, :precision, :scale, :null, :index, :array, :range, :size, :default, :comment).inject('') { |s, h| s << ", #{h[0]}: #{h[1].inspect}" }
+
+        cols.merge! name => r
+      end
+
+      cols
+    end
+
+    def migrate_attributes_by_db
+      return {} unless table_exists?
+      cols = {}
+
+      columns_hash.each do |name, column|
+        r = { type: column.type }
+        r.merge! migrate_type: r[:type]
+        r.merge! null: column.null unless column.null
+        r.merge! default: column.default unless column.default.nil?
+        r.merge! comment: column.comment if column.comment.present?
+        r.merge! column.sql_type_metadata.instance_values.slice('limit', 'precision', 'scale').compact
+        r.symbolize_keys!
+        r.merge! attribute_options: r.slice(:limit, :precision, :scale, :null, :index, :array, :size, :default, :comment).inject('') { |s, h| s << ", #{h[0]}: #{h[1].inspect}" }
+
+        cols.merge! name => r
+      end
+
+      cols
+    end
+
+    def attributes_by_default
+      if table_exists?
+        [primary_key] + all_timestamp_attributes_in_model
+      else
+        []
+      end
+    end
+
+    def attributes_by_belongs
+      results = {}
+
+      reflections.values.select(&->(reflection){ reflection.belongs_to? }).each do |reflection|
+        results.merge! reflection.foreign_key => {
+          input_type: :integer  # todo 考虑 foreign_key 不是自增 ID 的场景
+        }
+        results.merge! reflection.foreign_type => { input_type: :string } if reflection.foreign_type
+      end
+      results.except! *attributes_by_model.keys.map(&:to_s)
+
+      results
+    end
+
+    def references_by_model
+      results = {}
+      refs = reflections.values.select(&->(reflection){ reflection.belongs_to? })
+      refs.reject! { |reflection| reflection.foreign_key.to_s != "#{reflection.name}_id" }
+      refs.each do |ref|
+        r = { name: ref.name }
+        r.merge! polymorphic: true if ref.polymorphic?
+        r.merge! reference_options: r.slice(:polymorphic).inject('') { |s, h| s << ", #{h[0]}: #{h[1].inspect}" }
+        results[ref.foreign_key] = r unless results.key?(ref.foreign_key.to_sym)
+      end
+
+      results
+    end
+
+    def indexes_by_model
+      indexes = indexes_to_define_after_schema_loads
+      indexes.map! do |index|
+        index.merge! index_options: index.slice(:unique, :name).inject('') { |s, h| s << ", #{h[0]}: #{h[1].inspect}" }
+      end
+    end
+
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  extend RailsExtend::ActiveRecord::Extend
+end

data/lib/rails_extend/active_record/i18n.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveRecord
+  module I18n
+    extend ActiveSupport::Concern
+
+    included do
+      before_update :update_i18n_column
+    end
+
+    def update_i18n_column
+      str = []
+      self.changes.slice(*i18n_attributes).each do |key, _|
+        value = self.public_send("#{key}_before_type_cast")
+        str << "#{key} = #{key}::jsonb || '#{value.to_json}'::jsonb"
+      end
+      return if str.blank?
+      s = str.join(', ')
+      self.class.connection.execute "UPDATE #{self.class.table_name} SET #{s} WHERE id = #{self.id}"
+    end
+
+    def attributes_with_values_for_create(attribute_names)
+      r = super
+      r.slice(*i18n_attributes).each do |key, v|
+        r[key] = public_send "#{key}_before_type_cast"
+      end
+      r
+    end
+
+  end
+end

data/lib/rails_extend/active_record/include.rb

@@ -0,0 +1,29 @@
+module RailsExtend::ActiveRecord
+  module Include
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :indexes_to_define_after_schema_loads, instance_accessor: false, default: []
+    end
+
+    def error_text
+      errors.full_messages.join("\n")
+    end
+
+    def class_name
+      self.class.base_class.name
+    end
+
+    class_methods do
+      def index(name, **options)
+        h = { index: name, **options }
+        self.indexes_to_define_after_schema_loads = self.indexes_to_define_after_schema_loads + [h]
+      end
+    end
+
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  include RailsExtend::ActiveRecord::Include
+end

data/lib/rails_extend/active_record/taxon.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveRecord
+  module Taxon
+
+    def has_taxons(*columns)
+      columns.each do |column|
+        attribute "#{column}_ancestors", :taxon, outer: column
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          before_validation :sync_#{column}_id, if: -> { #{column}_ancestors_changed? }
+  
+          def sync_#{column}_id
+            _outer_id = Hash(#{column}_ancestors).values.compact.last
+            if _outer_id
+              self.#{column}_id = _outer_id
+            else
+              self.#{column}_id = nil
+            end
+          end
+        RUBY_EVAL
+      end
+    end
+
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  extend RailsExtend::ActiveRecord::Taxon
+end

data/lib/rails_extend/active_record/translation.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveRecord
+  module Translation
+
+    # name
+    # * store as jsonb in database;
+    # * read with i18n scope
+    def has_translations(*columns)
+      mattr_accessor :i18n_attributes
+      self.i18n_attributes = columns.map(&:to_s)
+      include RailsCom::I18n
+      columns.each do |column|
+        attribute column, :i18n
+
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+  
+          def #{column}=(value)
+            if value.is_a?(String)
+              super(::I18n.locale.to_s => value)
+            else
+              super
+            end
+          end
+
+        RUBY_EVAL
+      end
+
+    end
+
+    def _update_record(values, constraints)
+      values.except!(*i18n_attributes) if self.respond_to?(:i18n_attributes)
+      super
+    end
+
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  extend RailsExtend::ActiveRecord::Translation
+end

data/lib/rails_extend/active_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rails_extend/active_record/enum'
+require 'rails_extend/active_record/extend'
+require 'rails_extend/active_record/i18n'
+require 'rails_extend/active_record/include'
+require 'rails_extend/active_record/taxon'
+require 'rails_extend/active_record/translation'

data/lib/rails_extend/active_storage/attachment.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveStorage
+  module Attachment
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :name, :string, null: false
+    end
+
+  end
+end
+
+ActiveSupport.on_load(:active_storage_blob) do
+  ActiveStorage::Attachment.include RailsExtend::ActiveStorage::Attachment
+end

data/lib/rails_extend/active_storage/blob_prepend.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveStorage
+  module BlobPrepend
+
+    def self.prepended(klass)
+      klass.attribute :key, :string, null: false, index: { unique: true }
+      klass.attribute :filename, :string, null: false
+      klass.attribute :content_type, :string
+      klass.attribute :metadata, :json
+      klass.attribute :byte_size, :integer, null: false
+      klass.attribute :checksum, :string
+      klass.attribute :service_name, :string, null: false
+      klass.attribute :created_at, :datetime, null: false
+    end
+
+    def data_url
+      return @data_url if defined? @data_url
+      @data_url = "data:#{content_type};base64,#{Base64.encode64(download)}"
+    end
+
+    def duration
+      (metadata[:duration] || 0).to_f
+    end
+
+    def duration_str
+      rh = TimeHelper.exact_distance_time(duration)
+      "#{rh[:minute]}:#{rh[:second].to_s.rjust(2, '0')}"
+    end
+
+    def identify_later
+      ActiveStorage::IdentifyJob.perform_later(self)
+    end
+
+  end
+end
+
+ActiveSupport.on_load(:active_storage_blob) do
+  prepend RailsExtend::ActiveStorage::BlobPrepend
+end

data/lib/rails_extend/active_storage/variant.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsExtend::ActiveStorage
+  module Variant
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :variation_digest, :string, null: false
+    end
+
+  end
+end
+
+ActiveSupport.on_load(:active_storage_blob) do
+  ActiveStorage::VariantRecord.include RailsExtend::ActiveStorage::Variant
+end

data/lib/rails_extend/active_storage.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rails_extend/active_storage/blob_prepend'
+require 'rails_extend/active_storage/variant' if defined? ActiveStorage::VariantRecord
+require 'rails_extend/active_storage/attachment'

data/lib/rails_extend/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support/configurable'
+
+module RailsExtend #:nodoc:
+  include ActiveSupport::Configurable
+
+  configure do |config|
+    config.enum_key = ->(o, attribute){ "#{o.i18n_scope}.enum.#{o.base_class.model_name.i18n_key}.#{attribute}" }
+    config.help_key = ->(o, attribute){ "#{o.i18n_scope}.help.#{o.base_class.model_name.i18n_key}.#{attribute}" }
+    config.ignore_models = []
+    config.quiet_logs = [
+      '/rails/active_storage',
+      '/images',
+      '/@fs'
+    ]
+  end
+
+end

data/lib/rails_extend/core/array.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+class Array
+
+  #   arr = [1, 2, 3]
+  #   arr.ljust! 5, nil
+  #   # => [nil, nil, 1, 2, 3]
+  def ljust!(n, x)
+    return self if n < length
+    insert(0, *Array.new([0, n-length].max, x))
+  end
+
+  # fill an array with the given elements left;
+  #   arr = [1, 2, 3]
+  #   arr.rjust! 5, nil
+  #   # => [1, 2, 3, nil, nil]
+  def rjust!(n, x)
+    return self if n < length
+    fill(x, length...n)
+  end
+
+  ##
+  #   arr = [1, 2, 3]
+  #   arr.mjust!(5, nil)
+  #   # => [1, 2, nil, nil, 3]
+  def mjust!(n, x)
+    return self if n < length
+    insert((length / 2.0).ceil, *Array.new(n - length, x))
+  end
+
+  ##
+  # combine the same key hash like array
+  #   raw_data = [
+  #     { a: 1 },
+  #     { a: 2 },
+  #     { b: 2 },
+  #     { b: 2 }
+  #   ]
+  #   raw_data.to_combine_h
+  #   #=> { a: [1, 2], b: 2 }
+  def to_combine_h
+    self.inject({}) do |memo, obj|
+      memo.merge(obj) do |_, old_val, new_val|
+        v = (Array(old_val) + Array(new_val)).uniq
+        v.size > 1 ? v : v[0]
+      end
+    end
+  end
+
+  #
+  # raw_data = [
+  #   [:a, 1],
+  #   [:a, 2, 3],
+  #   [:b, 2]
+  # ]
+  # raw_data.to_array_h
+  # #=> [ { a: 1 }, { a: 2 }, { b: 2 } ]
+  def to_array_h
+    self.map { |x, y| { x => y } }
+  end
+
+  # 2D array to csv file
+  #   data = [
+  #     [1, 2],
+  #     [3, 4]
+  #   ]
+  #   data.to_csv_file
+  def to_csv_file(file = 'export.csv')
+    CSV.open(file, 'w') do |csv|
+      self.each { |ar| csv << ar }
+    end
+  end
+
+  # 比较两个数组忽略排序的情况下是否相等
+  def compare(other)
+    (self - other).empty? && (other - self).empty?
+  end
+
+end

data/lib/rails_extend/core/date.rb

@@ -0,0 +1,32 @@
+class Date
+
+  # Chinese custom after date
+  #   '2018-01-01'.to_date.contract_after(2.month) => '2018-02-31'
+  #   '2018-01-31'.to_date.contract_after(1.month) => '2018-02-28'
+  def contract_after(*afters, less: true)
+    parts = {}
+    # todo use inject or something
+    afters.each do |after|
+      parts.merge! after.parts
+    end
+    r = ActiveSupport::Duration.new(0, parts).after(self)
+
+    return r unless less
+
+    # if result day less than day, so
+    if (parts.keys & [:months, :years]).present?
+      r.day < day ? r : r - 1
+    else
+      r
+    end
+  end
+
+  def parts
+    {
+      year: year,
+      month: month,
+      day: day
+    }
+  end
+
+end

data/lib/rails_extend/core/duration.rb

@@ -0,0 +1,12 @@
+class ActiveSupport::Duration
+
+  def inspect
+    return "#{value} #{I18n.t('duration.seconds')}" if @parts.empty?
+
+    @parts.
+    sort_by { |unit,  _ | PARTS.index(unit) }.
+    map     { |unit, val| "#{val} #{val == 1 ? I18n.t('duration')[unit] : I18n.t('durations')[unit]}" }.
+    to_sentence(locale: I18n.locale)
+  end
+
+end

data/lib/rails_extend/core/hash.rb

@@ -0,0 +1,106 @@
+class Hash
+
+  def toggle(remove = true, other_hash)
+    dup.toggle!(remove, other_hash)
+  end
+
+  # a = {a: 1}
+  # a.toggle! a: 2
+  # => { a: [1, 2] }
+  # a.toggle! a: 3
+  # => { a: [1, 2, 3] }
+  def toggle!(remove = true, other_hash)
+    common_keys = self.keys & other_hash.keys
+    common_keys.each do |key|
+      if remove
+        removed = Array(self[key]) & Array(other_hash[key])
+      else
+        removed = []
+      end
+      added = Array(other_hash[key]) - Array(self[key])
+      self[key] = Array(self[key]) - removed + added
+      if self[key].empty?
+        self.delete(key)
+      elsif self[key].size == 1
+        self[key] = self[key][0]
+      end
+    end
+    other_hash.except! *common_keys
+    self.merge! other_hash
+    self
+  end
+
+  def diff_toggle(remove = true, other_hash)
+    removed = {}
+    added = {}
+    o = other_hash.extract!(*(self.keys & other_hash.keys))
+
+    if remove
+      removed.merge! o.common_basic(self)
+    end
+    added.merge! o.diff_remove(self)
+    added.merge! other_hash
+
+    [removed, added]
+  end
+
+  # a = { a:1, b: 2 }
+  # a.diff_remove { a: [1,2] }
+  # => removes: { b: 2 }
+  def diff_remove(other_hash, diff = {})
+    (keys | other_hash.keys).each do |key|
+      if self[key] != other_hash[key]
+        if self[key].is_a?(Hash) && other_hash[key].is_a?(Hash)
+          diff[key] = self[key].diff_remove(other_hash[key])
+        elsif self[key].is_a?(Array) && other_hash[key].is_a?(Array)
+          diff[key] = self[key] - other_hash[key]
+        elsif other_hash[key].is_a?(NilClass)
+          diff[key] = self[key]
+        end
+      end
+    end
+
+    diff
+  end
+
+  # a = { a:1, b: 2 }
+  # a.diff_add { a: [1,2] }
+  # => adds: { b: 2 }
+  def diff_add(other_hash)
+    other_hash.diff_remove(self)
+  end
+
+  def diff_changes(other_hash)
+    [diff_remove(other_hash), diff_add(other_hash)]
+  end
+
+  def common_basic(h = {}, other_hash)
+    each do |key, value|
+      v = Array(value) & Array(other_hash[key])
+      if v.size > 1
+        h[key] = v
+      elsif v.size == 1
+        h[key] = v[0]
+      elsif v.empty?
+        h.delete(key)
+      end
+    end
+    h
+  end
+
+  # 遍历出一个 hash 的根节点
+  def leaves
+    r = []
+
+    values.each do |value|
+      if value.is_a?(Hash)
+        r += value.leaves
+      else
+        r << value
+      end
+    end
+
+    r
+  end
+
+end

data/lib/rails_extend/core/module.rb

@@ -0,0 +1,7 @@
+class Module
+
+  def root_module
+    name.split('::')[0].constantize
+  end
+
+end

data/lib/rails_extend/core/nil.rb

@@ -0,0 +1,11 @@
+class NilClass
+
+  def to_d
+    BigDecimal(0)
+  end
+  
+  def to_sym
+    to_s.to_sym
+  end
+
+end