china_region_fu 0.0.6 → 0.1.0

data/lib/tasks/{region.rake → china_region_fu_tasks.rake}

@@ -1,21 +1,15 @@
 require 'httparty'
 
-namespace :region do
-
-  desc 'Install china region fu'
-  task :install do
-    Rake::Task['china_region_fu_engine:install:migrations'].invoke
-    Rake::Task['db:migrate'].invoke
-    Rake::Task['region:download'].invoke
-    Rake::Task['region:import'].invoke
-  end
+namespace :china_region_fu do
+  desc 'Setup china region fu'
+  task setup: ['china_region_fu:install:migrations', 'db:migrate', 'china_region_fu:download', 'china_region_fu:import']
 
   desc 'Download regions.yml from https://raw.github.com/Xuhao/china_region_data/master/regions.yml'
   task :download do
     begin
       remote_url = 'https://raw.github.com/Xuhao/china_region_data/master/regions.yml'
       puts 'Downloading ...'
-      File.open(Rails.root.join('config', 'regions.yml'), 'wb') { |f| f.write(HTTParty.get(remote_url).body)}
+      File.open(Rails.root.join('config', 'regions.yml'), 'wb') { |f| f.write(HTTParty.get(remote_url).body) }
       puts "Done! File located at: \e[32mconfig/regions.yml\e[0m"
     rescue
       puts "\e[31mWarnning!!!\e[0m"
@@ -26,14 +20,14 @@ namespace :region do
     end
   end
 
-  desc "Import region data to database from config/regions.yml"
-  task :import => :environment do
+  desc 'Import region data to database from config/regions.yml'
+  task import: :environment do
     puts 'Importing ...'
     file_path = Rails.root.join('config', 'regions.yml')
     regions = File.open(file_path) { |file| YAML.load(file) }
     cleanup_regins
     load_to_db(regions)
-    puts "Regions import done!"
+    puts 'Regions import done!'
   end
 
   def cleanup_regins
@@ -56,4 +50,4 @@ namespace :region do
     end
   end
 
-end
+end

data/spec/china_region_fu_spec.rb

@@ -1,9 +1,5 @@
-require 'spec_helper'
-
 describe ChinaRegionFu do
-
-  it 'should have a version number' do
-    ChinaRegionFu::VERSION.should_not be_nil
+  it 'has a version number' do
+    expect(ChinaRegionFu::VERSION).not_to be nil
   end
-
-end
+end

data/spec/helpers/helpers_spec.rb

@@ -0,0 +1,113 @@
+require 'action_view'
+require 'china_region_fu/helpers/helpers'
+
+RSpec.shared_examples 'render region select correctly' do |invalid_proc, single_proc, multi_proc|
+  context 'when pass invalid regions' do
+    it 'raise error' do
+      expect { invalid_proc.call }.to raise_error(ChinaRegionFu::InvalidFieldError)
+    end
+  end
+
+  context 'when pass one region' do
+    it 'return one select tag wrapped by a div' do
+      output = single_proc.call
+      expect(output).to start_with('<div class="input region province_id"><select')
+      expect(output).to include('china-region-select')
+      expect(output).to include('data-region-name="province_id"')
+      expect(output).to include('value="16">河南省</option>')
+      expect(output).not_to include('data-sub-region')
+    end
+  end
+
+  context 'when pass multiple regions' do
+    it 'return multiple select tags' do
+      output = multi_proc.call
+      expect(output).to start_with('<div class="input region province_id"><select')
+      expect(output).to include('<div class="input region city_id"><select')
+      expect(output).to include('<div class="input region district_id"><select')
+      expect(output).to include('data-region-name="province_id"')
+      expect(output).to include('data-region-name="city_id"')
+      expect(output).to include('data-region-name="district_id"')
+      expect(output).to include('data-sub-region="city_id"')
+      expect(output).to include('data-sub-region="district_id"')
+    end
+  end
+end
+
+RSpec.describe ChinaRegionFu::Helpers do
+  describe ChinaRegionFu::Helpers::FormHelper do
+    view = ActionView::Base.new
+    view.extend(ChinaRegionFu::Helpers::FormHelper)
+
+    describe '#region_select_tag' do
+      include_examples(
+        'render region select correctly',
+        ->() { view.region_select_tag(:invalid_region) },
+        ->() { view.region_select_tag(:province_id) },
+        ->() { view.region_select_tag([:province_id, :city_id, :district_id]) }
+      )
+    end
+
+    describe '#region_select' do
+      include_examples(
+        'render region select correctly',
+        ->() { view.region_select(:address, :invalid_region) },
+        ->() { view.region_select(:address, :province_id) },
+        ->() { view.region_select(:address, [:province_id, :city_id, :district_id]) }
+      )
+
+      it 'act as a objet field' do
+        output = view.region_select(:address, [:province_id, :city_id, :district_id])
+        expect(output).to include('name="address[province_id]"')
+        expect(output).to include('name="address[city_id]"')
+        expect(output).to include('name="address[district_id]"')
+        expect(output).to include('id="address_province_id"')
+        expect(output).to include('id="address_city_id"')
+        expect(output).to include('id="address_district_id"')
+      end
+    end
+  end
+
+  describe ChinaRegionFu::Helpers::FormBuilder do
+    template = ActionView::Base.new
+    template.extend(ChinaRegionFu::Helpers::FormHelper)
+
+    context 'build form for object with region' do
+      view = ActionView::Helpers::FormBuilder.new('address', Address.new(province_id: 16, city_id: 166, district_id: 1513), template, {})
+      view.extend(ChinaRegionFu::Helpers::FormBuilder)
+
+      include_examples(
+        'render region select correctly',
+        ->() { view.region_select(:invalid_region) },
+        ->() { view.region_select(:province_id) },
+        ->() { view.region_select([:province_id, :city_id, :district_id]) }
+      )
+
+      it 'set correct value for each region field' do
+        output = view.region_select([:province_id, :city_id, :district_id])
+        expect(output).to include('<option selected="selected" value="16">河南省</option>')
+        expect(output).to include('<option selected="selected" value="166">信阳市</option>')
+        expect(output).to include('<option selected="selected" value="1513">商城县</option>')
+      end
+    end
+
+    context 'build form for object without region' do
+      view = ActionView::Helpers::FormBuilder.new('address', Address.new, template, {})
+      view.extend(ChinaRegionFu::Helpers::FormBuilder)
+
+      include_examples(
+        'render region select correctly',
+        ->() { view.region_select(:invalid_region) },
+        ->() { view.region_select(:province_id) },
+        ->() { view.region_select([:province_id, :city_id, :district_id]) }
+      )
+
+      it 'fill options for first region field' do
+        output = view.region_select([:province_id, :city_id, :district_id])
+        expect(output).to include('<option value="16">河南省</option>')
+      end
+    end
+
+  end
+
+end

data/spec/helpers/utils_spec.rb

@@ -0,0 +1,87 @@
+require 'china_region_fu/helpers/utils'
+
+RSpec.describe ChinaRegionFu::Utils do
+  let(:proxy) { Class.new { extend ChinaRegionFu::Utils } }
+
+  describe '#china_region_fu_js' do
+    it 'return trusted Javascript snippet' do
+      js = proxy.china_region_fu_js
+      expect(js).to match(/^\s*<script type="text\/javascript">/)
+      expect(js).to match(/<script type="text\/javascript">\s*/)
+    end
+  end
+
+  describe '#append_html_class_option' do
+    context 'when option not have key `:class`' do
+      let (:html_options) { {} }
+      it 'append china-region-select to `:class` option' do
+        new_html_options = proxy.append_html_class_option(html_options)
+        expect(new_html_options[:class]).to eq(' china-region-select')
+        expect(html_options[:class]).to be_nil
+      end
+    end
+
+    context 'when option have key `:class`' do
+      let (:html_options) { { class: 'some class' } }
+      it 'append china-region-select to `:class` option' do
+        new_html_options = proxy.append_html_class_option(html_options)
+        expect(new_html_options[:class]).to eq('some class china-region-select')
+        expect(html_options[:class]).to eq('some class')
+      end
+    end
+  end
+
+  describe '#append_html_data_option' do
+    context 'when `sub_region` be passed' do
+      let(:origin_html_options) { {} }
+      let(:html_options) { proxy.append_html_data_option('province_id', 'city_id', origin_html_options) }
+      it 'append `sub_region` to options[:data][:sub_region]' do
+        expect(html_options[:data]).to eq(region_name: 'province_id', sub_region: 'city_id')
+        expect(origin_html_options).to eq({})
+      end
+    end
+
+    context 'when `sub_region` not be passed' do
+      let(:origin_html_options) { {} }
+      let(:html_options) { proxy.append_html_data_option('province_id', nil, origin_html_options) }
+      it 'append `sub_region` to options[:data][:sub_region]' do
+        expect(html_options[:data]).to eq(region_name: 'province_id')
+        expect(origin_html_options).to eq({})
+      end
+    end
+  end
+
+  describe '#append_html_options' do
+    context 'when `sub_region` be passed' do
+      let(:origin_html_options) { {} }
+      let(:html_options) { proxy.append_html_options('province_id', 'city_id', origin_html_options) }
+
+      it 'append css class and data' do
+        expect(html_options[:data]).to eq(region_name: 'province_id', sub_region: 'city_id')
+        expect(html_options[:class]).to eq(' china-region-select')
+        expect(origin_html_options).to eq({})
+      end
+    end
+
+    context 'when `sub_region` not be passed' do
+      let(:origin_html_options) { { class: 'some class' } }
+      let(:html_options) { proxy.append_html_options('province_id', nil, origin_html_options) }
+      it 'append `sub_region` to options[:data][:sub_region]' do
+        expect(html_options[:data]).to eq(region_name: 'province_id')
+        expect(html_options[:class]).to eq('some class china-region-select')
+        expect(origin_html_options).to eq(class: 'some class')
+      end
+    end
+  end
+
+  describe '#append_prompt' do
+    let(:options) { { include_blank: false, province_prompt: 'select province', city_prompt: 'select city', district_prompt: 'select district' } }
+
+    it 'extract promp for passed region' do
+      expect(proxy.append_prompt('province', options)).to eq(include_blank: false, prompt: 'select province')
+      expect(proxy.append_prompt('city_id', options)).to eq(include_blank: false, prompt: 'select city')
+      expect(proxy.append_prompt('district', options)).to eq(include_blank: false, prompt: 'select district')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,2 +1,7 @@
+require 'pry-byebug'
+require 'codacy-coverage'
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'china_region_fu'
+require 'china_region_fu'
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
+Codacy::Reporter.start

data/spec/support/models.rb

@@ -0,0 +1,39 @@
+require 'ostruct'
+
+module ActiveRecord
+  class Base < ::OpenStruct; end
+end
+
+class Address < ActiveRecord::Base; end
+
+MockModel = Struct.new(:id, :name, :pinyin, :pinyin_abbr, :short_name) do
+  def self.pluck(*args)
+    []
+  end
+
+  def self.where(*args)
+    self
+  end
+end
+
+class Province < MockModel
+  def self.pluck(*args)
+    [['河南省', 16]]
+  end
+end
+
+class City < MockModel
+  attr_accessor :province_id, :level, :zip_code
+
+  def self.pluck(*args)
+    [['信阳市', 166]]
+  end
+end
+
+class District < MockModel
+  attr_accessor :city_id
+
+  def self.pluck(*args)
+    [['商城县', 1513]]
+  end
+end

metadata

@@ -1,133 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: china_region_fu
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Xuhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !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'
+        version: '10.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: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: China region Ruby on rails interface
+        version: 0.14.0
+description: china_region_fu provides simple helpers to get an HTML select list of
+  countries, cities and districts.
 email:
 - xuhao@rubyfans.com
-executables: []
+executables:
+- console
+- rspec
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE
+- LICENSE.txt
+- README.en.md
 - README.md
 - Rakefile
 - app/controllers/china_region_fu/fetch_options_controller.rb
 - app/models/city.rb
 - app/models/district.rb
 - app/models/province.rb
+- bin/console
+- bin/rspec
+- bin/setup
 - china_region_fu.gemspec
 - config/routes.rb
 - db/migrate/20111111111111_create_china_region_tables.rb
 - lib/china_region_fu.rb
 - lib/china_region_fu/engine.rb
-- lib/china_region_fu/exceptions.rb
+- lib/china_region_fu/errors.rb
 - lib/china_region_fu/helpers/formtastic.rb
 - lib/china_region_fu/helpers/helpers.rb
 - lib/china_region_fu/helpers/simple_form.rb
-- lib/china_region_fu/helpers/utilities.rb
+- lib/china_region_fu/helpers/utils.rb
 - lib/china_region_fu/version.rb
 - lib/generators/china_region_fu/models/USAGE
 - lib/generators/china_region_fu/models/models_generator.rb
-- lib/tasks/region.rake
+- lib/tasks/china_region_fu_tasks.rake
 - spec/china_region_fu_spec.rb
+- spec/helpers/helpers_spec.rb
+- spec/helpers/utils_spec.rb
 - spec/spec_helper.rb
+- spec/support/models.rb
 homepage: https://github.com/Xuhao/china_region_fu
 licenses:
 - MIT
@@ -138,20 +123,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: China region Ruby on rails interface
+summary: china_region_fu provides simple helpers to get an HTML select list of countries,
+  cities and districts.
 test_files:
 - spec/china_region_fu_spec.rb
+- spec/helpers/helpers_spec.rb
+- spec/helpers/utils_spec.rb
 - spec/spec_helper.rb
+- spec/support/models.rb