rails_dictionary 0.2.7 → 0.3.pre.rc1

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.pre.rc1
 platform: ruby
 authors:
 - Raykin Lee
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
 description: Rails plugin for mapping static data of web application to Dictionary
   class
 email:
@@ -35,29 +49,25 @@ files:
 - ".gitignore"
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
-- README.rdoc
+- README.v2.0.rdoc
 - Rakefile
+- Readme.md
 - lib/rails_dictionary.rb
-- lib/rails_dictionary/active_record_extension.rb
-- lib/rails_dictionary/acts_as_dict_slave.rb
-- lib/rails_dictionary/acts_as_dict_type.rb
-- lib/rails_dictionary/acts_as_dictionary.rb
-- lib/rails_dictionary/array_core_ext.rb
+- lib/rails_dictionary/models/active_record_extension.rb
+- lib/rails_dictionary/models/acts_as_dict_consumer.rb
+- lib/rails_dictionary/models/acts_as_dictionary.rb
 - lib/rails_dictionary/version.rb
 - lib/tasks/dicts.rake
-- pkg/rails_dictionary-0.2.2.gem
-- pkg/rails_dictionary-0.2.3.gem
 - rails_dictionary.gemspec
-- spec/fake_app.rb
-- spec/init_models.rb
-- spec/rails_dictionary_spec.rb
-- spec/spec_helper.rb
+- test/acts_as_consumer_test.rb
+- test/fake_app.rb
+- test/lookup_test.rb
+- test/rails_dictionary_test.rb
+- test/test_helper.rb
 homepage: https://github.com/raykin/rails_dictionary
-licenses:
-- MIT
+licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,19 +75,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubyforge_project: rails_dictionary
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: dictionary data for web application
-test_files:
-- spec/fake_app.rb
-- spec/init_models.rb
-- spec/rails_dictionary_spec.rb
-- spec/spec_helper.rb
+test_files: []
+has_rdoc: 

data/Gemfile.lock

@@ -1,243 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails_dictionary (0.2.6)
-      rails (< 8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-      zeitwerk (~> 2.6)
-    actionmailbox (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      activejob (= 7.2.1.2)
-      activerecord (= 7.2.1.2)
-      activestorage (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      mail (>= 2.8.0)
-    actionmailer (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      actionview (= 7.2.1.2)
-      activejob (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      mail (>= 2.8.0)
-      rails-dom-testing (~> 2.2)
-    actionpack (7.2.1.2)
-      actionview (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      nokogiri (>= 1.8.5)
-      racc
-      rack (>= 2.2.4, < 3.2)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actiontext (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      activerecord (= 7.2.1.2)
-      activestorage (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.2.1.2)
-      activesupport (= 7.2.1.2)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (7.2.1.2)
-      activesupport (= 7.2.1.2)
-      globalid (>= 0.3.6)
-    activemodel (7.2.1.2)
-      activesupport (= 7.2.1.2)
-    activerecord (7.2.1.2)
-      activemodel (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      timeout (>= 0.4.0)
-    activestorage (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      activejob (= 7.2.1.2)
-      activerecord (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      marcel (~> 1.0)
-    activesupport (7.2.1.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    builder (3.3.0)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    crass (1.0.6)
-    date (3.3.4)
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    erubi (1.13.0)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.6)
-      concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.14.1)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    logger (1.6.1)
-    loofah (2.23.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.4)
-    mini_mime (1.1.5)
-    minitest (5.25.1)
-    net-imap (0.5.0)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.2)
-      timeout
-    net-smtp (0.5.0)
-      net-protocol
-    nio4r (2.7.3)
-    nokogiri (1.16.7-aarch64-linux)
-      racc (~> 1.4)
-    nokogiri (1.16.7-arm-linux)
-      racc (~> 1.4)
-    nokogiri (1.16.7-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86-linux)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
-      racc (~> 1.4)
-    psych (5.1.2)
-      stringio
-    racc (1.8.1)
-    rack (3.1.8)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rackup (2.1.0)
-      rack (>= 3)
-      webrick (~> 1.8)
-    rails (7.2.1.2)
-      actioncable (= 7.2.1.2)
-      actionmailbox (= 7.2.1.2)
-      actionmailer (= 7.2.1.2)
-      actionpack (= 7.2.1.2)
-      actiontext (= 7.2.1.2)
-      actionview (= 7.2.1.2)
-      activejob (= 7.2.1.2)
-      activemodel (= 7.2.1.2)
-      activerecord (= 7.2.1.2)
-      activestorage (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      bundler (>= 1.15.0)
-      railties (= 7.2.1.2)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.2.1.2)
-      actionpack (= 7.2.1.2)
-      activesupport (= 7.2.1.2)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
-    rake (13.2.1)
-    rdoc (6.7.0)
-      psych (>= 4.0.0)
-    reline (0.5.10)
-      io-console (~> 0.5)
-    rspec-core (3.13.2)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-rails (7.0.1)
-      actionpack (>= 7.0)
-      activesupport (>= 7.0)
-      railties (>= 7.0)
-      rspec-core (~> 3.13)
-      rspec-expectations (~> 3.13)
-      rspec-mocks (~> 3.13)
-      rspec-support (~> 3.13)
-    rspec-support (3.13.1)
-    securerandom (0.3.1)
-    sqlite3 (2.1.1-aarch64-linux-gnu)
-    sqlite3 (2.1.1-aarch64-linux-musl)
-    sqlite3 (2.1.1-arm-linux-gnu)
-    sqlite3 (2.1.1-arm-linux-musl)
-    sqlite3 (2.1.1-arm64-darwin)
-    sqlite3 (2.1.1-x86-linux-gnu)
-    sqlite3 (2.1.1-x86-linux-musl)
-    sqlite3 (2.1.1-x86_64-darwin)
-    sqlite3 (2.1.1-x86_64-linux-gnu)
-    sqlite3 (2.1.1-x86_64-linux-musl)
-    stringio (3.1.1)
-    thor (1.3.2)
-    timeout (0.4.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    useragent (0.16.10)
-    webrick (1.8.2)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
-
-PLATFORMS
-  aarch64-linux
-  aarch64-linux-gnu
-  aarch64-linux-musl
-  arm-linux
-  arm-linux-gnu
-  arm-linux-musl
-  arm64-darwin
-  x86-linux
-  x86-linux-gnu
-  x86-linux-musl
-  x86_64-darwin
-  x86_64-linux
-  x86_64-linux-gnu
-  x86_64-linux-musl
-
-DEPENDENCIES
-  rails (< 8.0)
-  rails_dictionary!
-  rspec-rails (< 8)
-  sqlite3
-
-RUBY VERSION
-   ruby 3.3.5p100
-
-BUNDLED WITH
-   2.5.17

data/lib/rails_dictionary/active_record_extension.rb

@@ -1,48 +0,0 @@
-module RailsDictionary
-  module ActiveRecordExtension
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      # TODO: move macro define in each module file
-      # See Usage in readme.doc.
-      def acts_as_dict_type
-
-        has_many :dictionaries
-        validates_uniqueness_of :name
-        after_save :delete_all_caches
-        after_destroy :delete_all_caches
-
-        include RailsDictionary::ActsAsDictType
-      end
-
-      def acts_as_dictionary
-
-        belongs_to :dict_type
-        after_save :delete_dicts_cache
-        after_destroy :delete_dicts_cache
-        scope :dict_type_name_eq, ->(name) { joins(:dict_type).where({ "dict_types.name" => name }) }
-
-        include RailsDictionary::ActsAsDictionary
-      end
-
-      # Ex: acts_as_dict_slave :add => :category
-      # :except - remove dict mapping column
-      # :add - add dict mapping column
-      # :locale - add and initialize class attribute default_dict_locale
-      def acts_as_dict_slave(ops={})
-        include RailsDictionary::ActsAsDictSlave
-        class_attribute :default_dict_locale, :instance_writer => false
-        cattr_accessor :dict_mapping_columns, :instance_writer => false
-        self.default_dict_locale = ops[:locale] if ops[:locale]
-        self.dict_mapping_columns = dict_columns(ops)
-        unless dict_mapping_columns.nil?
-          add_dynamic_column_method
-        end
-      end
-
-      alias_method :acts_as_dict_consumer, :acts_as_dict_slave
-    end
-  end
-end

data/lib/rails_dictionary/acts_as_dict_slave.rb

@@ -1,85 +0,0 @@
-module RailsDictionary
-  module ActsAsDictSlave
-    extend ActiveSupport::Concern
-
-    class_methods do
-      # return columns that exist in DictType#tab_and_column
-      def columns_in_dict_type
-        if ActiveRecord::VERSION::STRING < '3.1'
-          DictType.tab_and_column[self.name.underscore.to_sym]
-        elsif ::DictType.table_exists?
-          DictType.tab_and_column[self.name.underscore.to_sym]
-        else
-          []
-        end
-      end
-
-      # columns which map to dictionary
-      def dict_columns(ops={})
-        conf = { except: nil, add: nil}
-        conf.update(ops)
-        cidt = columns_in_dict_type || []
-        cidt.delete(conf[:except])
-        case conf[:add]
-        when String
-          cidt.push(conf[:add])
-        when Array
-          cidt.push(*conf[:add])
-        else nil
-        end
-        cidt.uniq! || cidt
-      end
-
-      # add a belongs_to(Dictionary) association and a named_{column} method
-      def add_dynamic_column_method
-        dict_mapping_columns.each { |e| belongs_to "#{e}_dict".to_sym, class_name: "Dictionary", foreign_key: e.to_sym }
-        dict_mapping_columns.each { |ele| named_dict_value ele.to_sym }
-        dict_mapping_columns.each { |ele| dict_name_equal ele.to_sym }
-      end
-
-      # Generate dynamic instance method named_column to consumer model
-      # def named_city(locale=nil)
-      #   locale = locale.presence || default_dict_locale.presence || :en
-      #   locale = "name_#{locale}"
-      #   self.send(city_dict).try(:send,locale)
-      # end
-      # alias_method :city_name, :named_city
-      def named_dict_value(method_name)
-        belongs_to_name="#{method_name}_dict".to_sym
-        origin_method_name = method_name
-        method_name="named_#{method_name}"
-        define_method(method_name) do | locale=nil |
-          locale = locale.presence || default_dict_locale.presence || :en
-          locale = "name_#{locale}"
-          self.send(belongs_to_name).try(:send,locale)
-        end
-        alias_method "#{origin_method_name}_name".to_sym, method_name.to_sym
-      end
-
-      # Build dynamic method column_name= to the consumer model
-      #
-      # def city_name=(value, options = {})
-      #
-      #
-      # end
-      def dict_name_equal(colname)
-        method_name = "#{colname}_name="
-        belongs_to_name="#{colname}_dict".to_sym
-        define_method(method_name) do |value, options={}|
-          options.merge!(name_en: value)
-          dict_type_id = DictType.revert("#{self.class.table_name.singularize}_#{colname}")
-          options.merge!(dict_type_id: dict_type_id)
-          exist_dictionary = Dictionary.where(options)
-          if exist_dictionary.present?
-            exist_id = exist_dictionary.first.id
-          else
-            exist_id = send("create_#{belongs_to_name}!", options).id
-          end
-          send "#{colname}=", exist_id
-        end
-      end
-
-    end # END class_methods
-
-  end
-end

data/lib/rails_dictionary/acts_as_dict_type.rb

@@ -1,52 +0,0 @@
-module RailsDictionary
-  module ActsAsDictType
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.mattr_accessor :whole_types
-    end
-
-    module ClassMethods
-
-      def all_types
-        whole_types ||
-          self.whole_types = all.map(&:name).map(&:to_sym)
-      end
-
-      # short method to transfer id to name or name to id
-      # TODO: cache it
-      def revert(arg)
-        if arg.is_a?(String)
-          DictType.where(name: arg).first.try(:id)
-        elsif arg.is_a?(Integer)
-          DictType.where(id: arg).first.try(:name)
-        end
-      end
-
-      #
-      # Parse the name value to get which column and model(or table) are listed in DictType
-      #
-      # Programmer DOC:
-      #   There are two chooses to get subclass,one is subclasses the other is descendants,
-      #   I don't know which is better,but descendants contains subclass of subclass,it contains more.
-      #
-      #   Class like +Ckeditor::Asset+ transfer to "ckeditor/asset",but we can not naming method like that,
-      #   So it still not support, the solution may be simple,just make another convention to escape "/"
-      #
-      #   Seems this method did not need to be cached in production.
-      #   Because everyclass was cached before application was run.So after application was run, it never be run again.
-      # TODO:
-      #   To cache this method output need more skills on how to caculate ActiveRecord::Base.descendants
-      #   Temply remove the cache
-      #   And add test for this situation
-      def tab_and_column
-        all_model_class=ActiveRecord::Base.descendants.map(&:name).map(&:underscore)
-        all_types.map(&:to_s).extract_to_hash(all_model_class)
-      end
-    end
-
-    def delete_all_caches
-      self.whole_types = nil
-      return true
-    end
-  end
-end

data/lib/rails_dictionary/acts_as_dictionary.rb

@@ -1,82 +0,0 @@
-require "active_support/concern"
-
-module RailsDictionary
-  module ActsAsDictionary
-    extend ActiveSupport::Concern
-
-    class_methods do
-
-      # For rails3
-      # I thought it would be better to define a method in method_missing, Not just generate cache.
-      #   Cause cache can not store ActiveRecord
-      # Generate methods like Dictionary.student_city
-      #   Dictionary.student_city - a list of dictionary object which dict type is student_city
-      #   Dictionary.student_city(:locale => :zh) - a select format array which can be used
-      #   in view method select as choice params
-      # Programmer DOC && TODO:
-      #   rethink about the cache.
-      #   cache methods like Dictionary.student_city(:locale => :zh,:sort => :name_fr)
-      #   but not cache Dictionary.student_city, return it as relation
-      #
-      #   Remove nil noise,if listed_attr =[[nil, 201], [nil, 203], [nil, 202], ["Sciences", 200]]
-      #   the sort would be failed of ArgumentError: comparison of Array with Array failed
-      #   split this method ,make it more short and maintainance
-      def method_missing(method_id,options={})
-        if ::DictType.all_types.include? method_id
-          method_name=method_id.to_s.downcase
-          # TODO: If cache engine is failed, then the code will failed with null cant dup
-          Rails.cache.fetch("Dictionary.#{method_name}") { dict_type_name_eq(method_name).to_a }
-          listed_attr=Rails.cache.read("Dictionary.#{method_name}").dup  # Instance of ActiveRecord::Relation can not be dup?
-          build_scope_method(method_id)
-          if options.keys.include? :locale or options.keys.include? "locale"
-            locale="name_#{ options[:locale] }"
-            sort_block=sort_dicts(options)
-            listed_attr.sort!(&sort_block) if sort_block
-            listed_attr.map! { |a| [a.send(locale),a.id] }.reject! {|ele| ele.first.nil?}
-          end
-          listed_attr
-        else
-          super
-        end
-      end
-
-      # Override this method to get customed sort block
-      def sort_dicts(options)
-        if options.keys.include? :locale or options.keys.include? "locale"
-          locale="name_#{ options[:locale] }"
-          if options[:locale].to_sym == :zh
-            Proc.new { |a,b| a.send(locale).encode('GBK') <=> b.send(locale).encode('GBK') }
-          else
-            Proc.new { |a,b| a.send(locale).downcase <=> b.send(locale).downcase }
-          end
-        else
-          false
-        end
-      end
-
-      def respond_to?(name, include_private=false)
-        ::DictType.all_types.include?(name) || super
-      end
-
-      private
-
-      def build_scope_method(name)
-        scope_method_name = "scoped_#{name}".to_sym
-        unless respond_to? scope_method_name
-          define_singleton_method scope_method_name do
-            # see http://stackoverflow.com/questions/18198963/with-rails-4-model-scoped-is-deprecated-but-model-all-cant-replace-it
-            # for usage of where(nil)
-            dict_type_name_eq(name).where(nil)
-          end
-        end
-      end
-
-    end # End class_method
-
-    def delete_dicts_cache
-      method_name = ::DictType.revert(self.dict_type_id)
-      Rails.cache.delete("Dictionary.#{method_name}")
-      return true
-    end
-  end
-end

data/lib/rails_dictionary/array_core_ext.rb

@@ -1,13 +0,0 @@
-class Array
-  # Return a hash by compare two arrays
-  def extract_to_hash(keys_array)
-    ret_hash={}
-    keys_array.each {|ky| ret_hash[ky.to_sym]=[]}
-    self.each do |sf|
-      keys_array.each do |ky|
-        ret_hash[ky.to_sym] << sf.sub("#{ky}_","") if sf =~ Regexp.new("^#{ky}_")
-      end
-    end
-    ret_hash.reject { |k,v| v.blank? }
-  end
-end

data/spec/fake_app.rb

@@ -1,29 +0,0 @@
-# database
-ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
-
-if ActiveRecord::VERSION::MAJOR >= 5
-  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-else
-  ActiveRecord::Base.establish_connection(:test)
-end
-
-# config
-app = Class.new(Rails::Application)
-app.config.active_support.deprecation = :log
-app.config.eager_load = false
-app.initialize!
-
-#migrations
-class CreateAllTables < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
-  def self.up
-    create_table(:dict_types) {|t| t.string :name}
-    create_table(:dictionaries) {|t| t.string :name_en; t.string :name_zh ; t.string :name_fr ; t.integer :dict_type_id}
-    create_table(:students) {|t| t.string :email; t.integer :city; t.integer :school}
-  end
-
-  def self.down
-    drop_table :dict_types
-    drop_table :dictionaries
-    drop_table :students
-  end
-end

data/spec/init_models.rb

@@ -1,12 +0,0 @@
-class Dictionary < ActiveRecord::Base
-  acts_as_dictionary
-end
-
-class DictType < ActiveRecord::Base
-  acts_as_dict_type
-end
-
-# TODO: Here is a serious code loading issue. Student can't be load before DictType and Dictionary
-class Student < ActiveRecord::Base
-  acts_as_dict_slave
-end