china_regions 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65852eef10a092038e498c3f7eec696ad6c2598072839bf3edafbc96d52579c6
-  data.tar.gz: '0169f567da375fd7d4e9713fe6004991ab01b34ee0a8e4fb61f33284ee96d296'
+  metadata.gz: 3c8df7cd52e1ba2259ae5f84635fc7319c8ac993b22d148ed1f9bf8fbf89598a
+  data.tar.gz: 2c5eddaad1e5dba0dadfe7e41fd6c4a65ad2c0fd2ae6b530080d8992cb9205ba
 SHA512:
-  metadata.gz: 639f67a31cf88385fec479e174e5d25999c8ee2f4e61fdac1fdf31e08012aefbfa8d5c32c40c97989dcad9629085ff656804f06d3c4931818e0158a07dd70f76
-  data.tar.gz: 903e20a4be9c05635e05117ace6e8e429b44d50be7938c02d7708631c4462a20c1f8a04e846a3e9cc54ccbdf8886ef1b2b0f325d8847a53d7c78ed89fd35ed47
+  metadata.gz: 329fb0afdf5363cd5c2b5a8bdbed0dc3cc1ba006914090e591d4a2e9b69e8f526c5acd98ad4aebb5317875379cd0609c1fc6b1da58f30cfbe94fdf393aa709ca
+  data.tar.gz: 9255c6956892d177069482849d08b056e4653bf47eecf189a8cf26da61d873d5b87f6d7f86163a8407f757e1357eb6b925389bf9022a922ba88092804d3ce2a5

data/.gitignore

@@ -3,6 +3,9 @@
 .DS_Store
 .ruby-version
 .rvmrc
+
 Gemfile.lock
+
 pkg/*
-doc
+doc/
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0
+  - 3.0.0
+  - 3.0.1
 
 before_install:
   - gem install bundler

data/Rakefile

@@ -1,4 +1,7 @@
-#!/usr/bin/env rake
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/models/city.rb

@@ -10,7 +10,7 @@ class City < ApplicationRecord
 
   # Relationships
   belongs_to :province, counter_cache: true
-  delegate :name, to: :province
+  delegate :name, to: :province, prefix: true
 
   has_many :districts, dependent: :destroy
 

data/app/models/district.rb

@@ -9,19 +9,19 @@ class District < ApplicationRecord
 
   # Relationships
   belongs_to :city, counter_cache: true
-  delegate :name, to: :city
+  delegate :name, to: :city, prefix: true
 
   # Filters
   scope :for_city, ->(city_id) { where(city_id: city_id) }
 
-  def full_name
-    [province.name, city_name, name].compact.join(' - ')
-  end
-
   def province
     city.province
   end
 
+  def full_name
+    [province.name, city_name, name].compact.join(' - ')
+  end
+
   def short_name
     @short_name ||= name.gsub(/区|县|市|自治县/, '')
   end

data/app/models/province.rb

@@ -10,4 +10,7 @@ class Province < ApplicationRecord
   # Relationships
   has_many :cities, dependent: :destroy
   has_many :districts, through: :cities
+
+  # Filter by name
+  scope :filter_by, ->(fname) { where(["name_en = :name or name = :name", name: fname]) }
 end

data/china_regions.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'ruby-pinyin'
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop'
 end

data/config/locales/{en.yml → china_regions.en.yml}

@@ -10,18 +10,23 @@ en:
     attributes:
       province:
         name: Name
+        code: Code
         name_en: English Name
         name_abbr: Short Name
+        cities_count: Cities Count
       city:
-        name: Nam
+        name: Name
         province_id: Province
         province: Province
         name_en: English Name
         name_abbr: Short Name
         level: Level
+        code: Code
+        districts_count: Districts Count
       district:
         name: Name
         city_id: City
         city: City
         name_en: English Name
         name_abbr: Short Name
+        code: Code

data/config/locales/{zh.yml → china_regions.zh.yml}

@@ -10,8 +10,10 @@ zh:
     attributes:
       province:
         name: 名称
+        code: 编码
         name_en: 拼音
         name_abbr: 简称
+        cities_count: 城市数
       city:
         name: 名称
         province_id: 省份
@@ -19,9 +21,12 @@ zh:
         name_en: 拼音
         name_abbr: 简称
         level: 等级
+        code: 编码
+        districts_count: 地区数
       district:
         name: 名称
         city_id: 城市
         city: 城市
         name_en: 拼音
         name_abbr: 简称
+        code: 编码

data/lib/china_regions/helpers/form_helper.rb

@@ -1,11 +1,10 @@
-
 # frozen_string_literal: true
 
 module ChinaRegions
   module Helpers
     module FormHelper
-      def region_select(object_name, methods, options = {}, html_options = {})
-        output = ''
+      def region_select(object_name, fields, options = {}, html_options = {})
+        output = []
 
         preselected_choices = setup_regions_options(options)
 
@@ -15,54 +14,56 @@ module ChinaRegions
 
         dropdown_prefix = options[:prefix] ? options[:prefix].to_s + '_' : ''
 
-        if Array == methods
-          methods.each_with_index do |method, index|
-            if region_klass = method.to_s.classify.safe_constantize
-              choices = fetch_choices(region_klass, method, preselected_choices, index)
-              choices = prioritize_choices(options[:priority][method], choices) if options[:priority].try(:[], method)
+        if fields.is_a?(Array)
+          fields.each_with_index do |field, field_index|
+            if region_klass = field.to_s.classify.safe_constantize
+              choices = fetch_choices(region_klass, field, preselected_choices, field_index)
+              choices = prioritize_choices(options[:priority][field], choices) if options[:priority].try(:[], field)
 
-              next_method = methods.at(index + 1)
+              next_method = fields.at(field_index + 1)
 
-              set_prompt(method, options, region_klass)
-              set_html_options(object_name, method, html_options, next_method, dropdown_prefix)
+              set_prompt(field, options, region_klass)
+              set_html_options(object_name, field, html_options, next_method, dropdown_prefix)
 
-              if options[:default] && options[:default][method]
-                options[:selected] = options[:default][method] if options[:default][method]
+              if options[:default] && options[:default][field]
+                options[:selected] = options[:default][field] if options[:default][field]
               end
 
-              output << select(object_name, "#{dropdown_prefix}#{method}_id", choices, options, html_options)
+              output << select(object_name, "#{dropdown_prefix}#{field}_id", choices, options, html_options)
             else
-              raise "Method '#{method}' is not a vaild attribute of #{object_name}"
+              raise "Method '#{field}' is not a vaild attribute of #{object_name}"
             end
           end
         else
-          inner_methods = if methods.to_s.include?('_id')
-            inner_methods = methods
-            methods = methods.to_s.gsub(/(_id)$/, '')
+          inner_methods = if fields.to_s.include?('_id')
+            inner_methods = fields
+            fields = fields.to_s.gsub(/(_id)$/, '')
             inner_methods
           else
-            (methods.to_s + '_id').to_sym
+            (fields.to_s + '_id').to_sym
           end
 
-          if region_klass = methods.to_s.classify.safe_constantize
+          if region_klass = fields.to_s.classify.safe_constantize
             options[:prompt] = region_prompt(region_klass)
+            options[:selected] = preselected_choices[:province_id] if fields == :province && preselected_choices[:province_id]
 
-            options[:selected] = preselected_choices[:province_id] if methods == :province && preselected_choices[:province_id]
-
-            output << select(object_name, inner_methods, region_klass.where(nil).collect { |p| [p.name, p.id] }, options = options, html_options = html_options)
+            output << select(object_name, inner_methods, region_options(region_klass), options: options, html_options: html_options)
           else
-            raise "Method '#{method}' is not a vaild attribute of #{object_name}"
+            raise "Method '#{fields}' is not a vaild attribute of #{object_name}"
           end
         end
-        output.html_safe
+        output.join.html_safe
       end
 
       private
       def fetch_choices(region_klass, method, preselected_choices, index)
         return preselected_choices[method] if preselected_choices[method]
-        return [] unless index.zero?
 
-        region_klass.where(nil).collect { |p| [p.name, p.id] }
+        index.zero? ? region_options(region_klass) : []
+      end
+
+      def region_options(region_klass)
+        @region_options ||= region_klass.where(nil).collect { |p| [p.name, p.id] }
       end
 
       def prioritize_choices(priorities, choices)
@@ -89,10 +90,10 @@ module ChinaRegions
       def setup_regions_options(options)
         return {} unless options[:default] && options[:default][:province]
 
-        # TODO: Add validator to check if the passed province, city or district exists within the models
+        # Add validator to check if the passed province, city or district exists within the models
         province_id = get_province_id(options[:default][:province])
-        cities = City.where(province_id: province_id)
-        districts = District.where(city_id: cities)
+        cities = City.for_province(province_id)
+        districts = District.for_city(city_id: cities)
 
         {
           province_id: province_id,
@@ -111,7 +112,8 @@ module ChinaRegions
 
       def get_province_id(province)
         return province if province.to_s =~ /\A[0-9]*\z/
-        Province.where('name_en = ? OR name = ?', province.downcase, province).first.id
+
+        Province.filter(province.downcase).first.id
       end
 
       def set_html_options(object_name, method, html_options, next_region, prefix)

data/lib/china_regions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChinaRegions
-  VERSION = '1.0.3'
+  VERSION = '1.0.8'
 end

data/lib/generators/china_regions/install_generator.rb

@@ -14,7 +14,7 @@ module ChinaRegions
     def copy_locales
       %w[en zh].each do |locale|
         config_file = "config/locales/regions.#{locale}.yml"
-        copy_file "../../../../config/locales/#{locale}.yml", config_file unless File.exist?(config_file)
+        copy_file "../../../../config/locales/china_regions.#{locale}.yml", config_file unless File.exist?(config_file)
       end
     end
 

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'coveralls'
+Coveralls.wear!
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: china_regions
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.8
 platform: ruby
 authors:
 - Encore Shao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -97,14 +111,13 @@ dependencies:
 description: China Regions is a Ruby on rails interface
 email:
 - encore.shao@gmail.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -117,11 +130,9 @@ files:
 - app/models/city.rb
 - app/models/district.rb
 - app/models/province.rb
-- bin/console
-- bin/setup
 - china_regions.gemspec
-- config/locales/en.yml
-- config/locales/zh.yml
+- config/locales/china_regions.en.yml
+- config/locales/china_regions.zh.yml
 - config/routes.rb
 - lib/china_regions.rb
 - lib/china_regions/engine.rb
@@ -131,11 +142,12 @@ files:
 - lib/generators/china_regions/regions_generator.rb
 - lib/generators/china_regions/templates/migration.rb
 - lib/tasks/china_regions.rake
+- spec/spec_helper.rb
 homepage: https://github.com/encoreshao/china_regions
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,8 +163,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Rails 4+ version of dropdowns for all provinces, cities, and districts in
   China.
-test_files: []
+test_files:
+- spec/spec_helper.rb

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'china_regions'
-
-# If you use this, don't forget to add pry to your Gemfile!
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-bundle install