country_state_select 3.0.0 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c7cc9e30bebe46054458ff4145604012db5eeba
-  data.tar.gz: f378530aece9b4763fdfec46e6963c29ae3a038e
+SHA256:
+  metadata.gz: e19a1973258042a873d741682f8b4fa4eadfe1191cc988bc4bb8efa1785fd108
+  data.tar.gz: e68fdf8aa8c862cc844337862e00646bc71727c607ec38fcc27d947246a9ffc9
 SHA512:
-  metadata.gz: 49807b5fe4c87a700b8f45eac6fbafbcdf7bab75beec9c94b70afaf7750074d5a1cd41e8aede34b20b119ec79bbbaabee7aa878763b3c789370e5df3690ad831
-  data.tar.gz: ccd794e1caf34f5ab5ac01910cd055e6f88c2ea348dd297bfdb177dd10fde1466282e032e4277c2959439fc814286b3ae27f775d12d68ba5cd80f6e2538e31fb
+  metadata.gz: 4807a8138b62e598471aa6edc0f32e78a8c84fa47b9f79fbcc551af5a755fad6347e1cead2a0d201f60c766c54b16a7c827f4f0c5fe118d08f52204052697a0a
+  data.tar.gz: 1ea10b63f82e6f4f94de47fffceaed21934a6ca01c78efbdc110a43e4c36d45a34f2dc2dfefcf828dbe9be19b2b8ccd7355ba557f80b73555e09bf2d9d7d6dca

data/.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install

data/.travis.yml

@@ -1,9 +1,12 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.2.0
+  - 2.5.0
+  - 2.6.5
+  - 3.0.0
+
 script:
   # ---if you written test cases then write commands here to run
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in country_state_select.gemspec

data/README.md

@@ -1,4 +1,8 @@
-##Country State Select [![Build Status](https://travis-ci.org/arvindvyas/Country-State-Select.svg?branch=master)](https://travis-ci.org/arvindvyas/Country-State-Select)  [![Code Climate](https://codeclimate.com/github/arvindvyas/Country-State-Select/badges/gpa.svg)](https://codeclimate.com/github/arvindvyas/Country-State-Select)
+## Country State Select 
+[![Build Status](https://travis-ci.org/arvindvyas/Country-State-Select.svg?branch=master)](https://travis-ci.org/arvindvyas/Country-State-Select)  
+[![Code Climate](https://codeclimate.com/github/arvindvyas/Country-State-Select/badges/gpa.svg)](https://codeclimate.com/github/arvindvyas/Country-State-Select)
+
+
 
 Country State Select is a library that provides an easy API to generate Country , State / Province  and City dropdowns for use in forms.
 
@@ -8,7 +12,10 @@ For instance, if a user chooses "United States of America" for a Country dropdow
 
 The data for Countries and States is populated by the excellent [city-state](https://github.com/loureirorg/city-state) gem. 
 
-#Getting Started
+# Demo
+  https://country-state-select.herokuapp.com
+
+# Getting Started
 
 Country State Select is released as a Ruby Gem and requires the Rails environment as well.
 
@@ -20,9 +27,13 @@ Then run
     
     bundle install
 
+# NOTE 
+In the latest version we have removed all the dependencies of js and you are feel free to use any js you can use predefine method to populate data
 
 Don't forget to restart your server after you install it.
-
+## Setup Gem
+if not autoloaded than please add in your application.js
+      //= require country_state_select
 
 ## chosen JavaScript assets
   The application makes use of the chosen-rails library for a better user experience.  This can be disabled if desired.  
@@ -50,11 +61,11 @@ Don't forget to restart your server after you install it.
 Implementation in a view is simple. 
 
 Just create a simple_form object like so:
-
-    <%= simple_form_for @form_object do |f| 
-      f.button :submit
-    end %>
-    
+```ruby
+<%= simple_form_for @form_object do |f| 
+  f.button :submit
+end %>
+```    
 Once your form object is created, add in fields for your user to select a Country and State / Province.      
 
 ## Country Field
@@ -86,18 +97,19 @@ Any options that are valid in simple_form field can be passed into the options h
 The magic of the library is the JavaScript that is performed on the fields.  This JavaScript needs to be included in order for the proper State / Provinces to be selected based upon your Country selection.  
 
 Add this JavaScript to the page that is loading your form:
-
-    $(document).on('ready page:load', function() {
-      return CountryStateSelect({
-        country_id: "country_field_id",
-        state_id: "state_field_id"
-      });
-    });
-
+```javascript
+$(document).on('ready page:load', function() {
+  return CountryStateSelect({
+    country_id: "country_field_id",
+    state_id: "state_field_id"
+  });
+});
+```
 If you are using CoffeeScript, use the following:
-
-    $(document).on 'ready page:load', ->
-        CountryStateSelect({ country_id: "country_field_id", state_id: "state_field_id" })
+```coffescript
+$(document).on 'ready page:load', ->
+    CountryStateSelect({ country_id: "country_field_id", state_id: "state_field_id" })
+ ```
 
 The country_id accepts the form ID for the country field.  The state_id accepts the form ID for the state field.
 
@@ -112,29 +124,32 @@ The ID being referred to is like the following in a select menu:
 The CountryStateSelect interface offers the option to turn the Chosen library on or off.  
 
 To turn it on, set it to true:
-
-    $(document).on('ready page:load', function() {
-      return CountryStateSelect({
-        chosen_ui: true,
-        ...
-        ...
-        ...
-      });
-    }); 
-
+```javascript
+$(document).on('ready page:load', function() {
+  return CountryStateSelect({
+    chosen_ui: true,
+    chosen_options: { 
+      disable_search_threshold: 10,
+      width: '95%'
+    },
+    ...
+    ...
+    ...
+  });
+}); 
+```
 To turn it off, set it to false:
-
-    $(document).on('ready page:load', function() {
-      return CountryStateSelect({
-        chosen_ui: false,
-        ...
-        ...
-        ...
-      });
-    });
-    
-
-##Contributing to Country State Select
-
+```javascript
+$(document).on('ready page:load', function() {
+  return CountryStateSelect({
+    chosen_ui: false,
+    ...
+    ...
+    ...
+  });
+});
+```    
+
+## Contributing
   Fork, fix, then send a pull request.
  

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/app/controllers/country_state_select/cscs_controller.rb

@@ -1,11 +1,13 @@
-#@author : Arvind Vyas
+# frozen_string_literal: true
+
+# @author : Arvind Vyas
 module CountryStateSelect
   class CscsController < ApplicationController
     def find_states
-      csc =   CS.states(params[:country_id])
+      csc = CS.states(params[:country_id])
 
-       respond_to do |format|
-         format.json { render :json => csc.to_a}
+      respond_to do |format|
+        format.json { render json: csc.to_a }
       end
     end
 
@@ -14,8 +16,8 @@ module CountryStateSelect
       cities = CS.cities(params[:state_id].to_sym, params[:country_id].to_sym)
 
       respond_to do |format|
-         format.json { render :json => cities.to_a}
+        format.json { render json: cities.to_a }
       end
     end
   end
-end
+end

data/config/routes.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
-  scope :module => "country_state_select" do
+  scope module: 'country_state_select' do
     post 'find_states' => 'cscs#find_states'
     post 'find_cities' => 'cscs#find_cities'
   end
-end
+end

data/country_state_select.gemspec

@@ -1,31 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'country_state_select/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "country_state_select"
+  spec.name          = 'country_state_select'
   spec.version       = CountryStateSelect::VERSION
-  spec.authors       = ["Arvind Vyas"]
-  spec.email         = ["arvindvyas07@gmail.com"]
-  spec.summary       = %q{Dynamically select Country and State.}
-  spec.description   = %q{Country State Select is a Ruby Gem that aims to make Country and State/Province selection a cinch in Ruby on Rails environments.}
-  spec.homepage      = "https://github.com/aldefouw/country_state_select.git"
-  spec.license       = "MIT"
+  spec.authors       = ['Arvind Vyas']
+  spec.email         = ['arvindvyas07@gmail.com']
+  spec.summary       = 'Dynamically select Country and State.'
+  spec.description   = 'Country State Select is a Ruby Gem that aims to make Country and State/Province selection a cinch in Ruby on Rails environments.'
+  spec.homepage      = 'https://github.com/arvindvyas/Country-State-Select'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec'
 
-  spec.add_runtime_dependency 'rails'
-  spec.add_runtime_dependency 'simple_form', "~> 3.2"
-  spec.add_runtime_dependency 'chosen-rails', "~> 1.4"
-  spec.add_runtime_dependency 'compass-rails', '~> 2.0.4'
   spec.add_runtime_dependency 'city-state'
+  spec.add_runtime_dependency 'rails'
 end

data/lib/country_state_select.rb

@@ -1,57 +1,72 @@
-require "country_state_select/version"
-require "city-state"
-require "rails"
-require "sass-rails"
-require "compass-rails"
-require "chosen-rails"
-require "simple_form"
+# frozen_string_literal: true
 
-module CountryStateSelect
+require 'country_state_select/version'
+require 'city-state'
+require 'rails'
 
-  #Collect the Countries
+module CountryStateSelect
+  # Collect the Countries
   def self.countries_collection
-    CS.countries.except!(:COUNTRY_ISO_CODE).collect {|p| [ p[ 1], p[0] ] }.compact
+    CS.countries.except!(:COUNTRY_ISO_CODE).collect { |p| [p[1], p[0]] }.compact
   end
 
-  #Pass array of unwanted countries to get back all except those in the array
+  # Pass array of unwanted countries to get back all except those in the array
   def self.countries_except(*except)
-    countries_collection.collect { |c| c unless except.include?(c.second) }.compact
+    countries_collection.collect { |c| c unless except.include?(c[1]) }.compact
   end
 
-  #Return either the State (String) or States (Array)
+  # Return either the State (String) or States (Array)
   def self.states_collection(f, options)
     states = collect_states(f.object.send(options[:country]))
-    return f.object.send(options[:state]) if states.size == 0
+    return f.object.send(options[:state]) if states.empty?
+
     states
   end
 
-  #Return the collected States for a given Country
+  # Return either the City (String) or Cities (Array)
+  def self.cities_collection(f, options)
+    cities = collect_cities(f.object.send(options[:state]))
+  end
+
+  # Return the collected States for a given Country
   def self.collect_states(country)
-    CS.states(country).collect {|p| [ p[1], p[0] ] }.compact
+    CS.states(country).collect { |p| [p[1], p[0]] }.compact
   end
 
-  #Return the cities of given state and country
+  # Return the cities of given state and country
   def self.collect_cities(state_id = '', country_id = '')
+    return [] if state_id.nil? || country_id.nil?
+
     CS.cities(state_id.to_sym, country_id.to_sym)
   end
 
-  #Return a hash for use in the simple_form
+  # Return a hash for use in the simple_form
   def self.state_options(options)
     states = states_collection(options[:form], options[:field_names])
-    options = options.merge(collection: states)
-    options = options.merge(:as => :string) if states.class == String
-    options
+    options = merge_hash(options, states)
+  end
+
+  # Return a hash for use in the simple_form
+  def self.city_options(options)
+    cities =  cities_collection(options[:form], options[:field_names])
+    options = merge_hash(options, cities)
   end
 
+  # Create hash to use in the simple_form
+  def self.merge_hash(options, collections)
+    options = options.merge(collection: collections)
+    options = options.merge(as: :string) if collections.instance_of?(String)
+    options
+  end
 end
 
 case ::Rails.version.to_s
-  when /^4/
-    require 'country_state_select/engine'
-  when /^3\.[12]/
-    require 'country_state_select/engine3'
-  when /^3\.[0]/
-    require 'country_state_select/railtie'
-  else
-    raise 'Unsupported rails version'
+when /[4-6]/
+  require 'country_state_select/engine'
+when /^3\.[12]/
+  require 'country_state_select/engine3'
+when /^3\.0/
+  require 'country_state_select/railtie'
+else
+  raise 'Unsupported rails version'
 end

data/lib/country_state_select/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @author Sachin Singh
 
 module CountryStateSelect

data/lib/country_state_select/engine3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @author Sachin Singh
 
 module CountryStateSelect

data/lib/country_state_select/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @author Sachin Singh
 
 module CountryStateSelect

data/lib/country_state_select/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CountryStateSelect
-  VERSION = "3.0.0"
+  VERSION = '3.1.5'
 end

data/spec/country_state_select_spec.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CountryStateSelect do
-
   describe '#countries_collection' do
     it 'does not include :COUNTRY_ISO_CODE' do
-      expect(CountryStateSelect.countries_collection).not_to include([:COUNTRY_ISO_CODE=>"country_name"])
+      expect(CountryStateSelect.countries_collection).not_to include([COUNTRY_ISO_CODE: 'country_name'])
     end
 
-    it "returns an array" do
+    it 'returns an array' do
       method_call = CountryStateSelect.countries_collection
       expect(method_call.class).to eq(Array)
     end
 
-    it "returns the value first and the key second" do
+    it 'returns the value first and the key second' do
       method_call = CountryStateSelect.countries_collection
-      expect(method_call.first.first).to eq("Andorra")
-      expect(method_call.first.second).to eq(:AD)
+      expect(method_call[0][0]).to eq('Andorra')
+      expect(method_call[0][1]).to eq(:AD)
     end
   end
 
-  describe "#countries_except" do
-    let(:us) { ["United States", :US] }
-    let(:sm) { ["Saint Martin", :MF] }
-    let(:exceptions) {  [us, sm]  }
+  describe '#countries_except' do
+    let(:us) { ['United States', :US] }
+    let(:sm) { ['Saint Martin', :MF] }
+    let(:exceptions) { [us, sm] }
 
     it 'does include the United States ordinarily' do
       expect(CountryStateSelect.countries_except([])).to include(us)
@@ -36,17 +37,17 @@ describe CountryStateSelect do
       expect(CountryStateSelect.countries_except(exceptions)).not_to include(exceptions)
     end
 
-    it "returns the same result as #countries_collection if no exceptions are passed" do
-      expect(CountryStateSelect.countries_except()).to eq(CountryStateSelect.countries_collection)
+    it 'returns the same result as #countries_collection if no exceptions are passed' do
+      expect(CountryStateSelect.countries_except).to eq(CountryStateSelect.countries_collection)
     end
   end
 
   describe '#states_collection' do
-    let(:f) { double( object: { }  ) }
+    let(:f) { double(object: {}) }
     let(:options) { { country: 'country_field_name', state: 'state_field_name' } }
 
-    it "should return 51 elements when we query for the United States" do
-      expect(f.object).to receive(:country_field_name).and_return('US') #Set the form Country Field to US
+    it 'should return 51 elements when we query for the United States' do
+      expect(f.object).to receive(:country_field_name).and_return('US') # Set the form Country Field to US
 
       method_call = CountryStateSelect.states_collection(f, options)
 
@@ -54,8 +55,8 @@ describe CountryStateSelect do
       expect(method_call.size).to eq(51)
     end
 
-    it "should return a String when we query for Saint Martin" do
-      expect(f.object).to receive(:country_field_name).and_return('MF') #Set the form Country Field to MF for Saint Martin
+    it 'should return a String when we query for Saint Martin' do
+      expect(f.object).to receive(:country_field_name).and_return('MF') # Set the form Country Field to MF for Saint Martin
       expect(f.object).to receive(:state_field_name).and_return('')
 
       method_call = CountryStateSelect.states_collection(f, options)
@@ -65,27 +66,29 @@ describe CountryStateSelect do
     end
 
     it "should return the 'State from Form' if the Country requested returns no States" do
-      expect(f.object).to receive(:country_field_name).and_return('MF') #Set the form Country Field to MF for Saint Martin
+      expect(f.object).to receive(:country_field_name).and_return('MF') # Set the form Country Field to MF for Saint Martin
       expect(f.object).to receive(:state_field_name).and_return('State from Form')
 
       method_call = CountryStateSelect.states_collection(f, options)
 
-      expect(method_call).to eq("State from Form")
+      expect(method_call).to eq('State from Form')
     end
   end
 
   describe '#states_options' do
-    let(:f) { double( object: {} ) }
-    let(:options) { { form: f,  label: "State / Province", field_names: { :country => :country_field_name, :state => :state_field_name } } }
+    let(:f) { double(object: {}) }
+    let(:options) do
+      { form: f, label: 'State / Province', field_names: { country: :country_field_name, state: :state_field_name } }
+    end
 
-    it "should return a Hash" do
+    it 'should return a Hash' do
       expect(f.object).to receive(:country_field_name).and_return('US')
 
       method_call = CountryStateSelect.state_options(options)
       expect(method_call.class).to eq(Hash)
     end
 
-    it "should contain a key-value pair of as: => :string if no states are returned for the country" do
+    it 'should contain a key-value pair of as: => :string if no states are returned for the country' do
       expect(f.object).to receive(:country_field_name).and_return('MF')
       expect(f.object).to receive(:state_field_name).and_return('')
 
@@ -101,7 +104,7 @@ describe CountryStateSelect do
       expect(method_call).not_to have_key(:as)
     end
 
-    it "should have a label if one has been set" do
+    it 'should have a label if one has been set' do
       expect(f.object).to receive(:country_field_name).and_return('US')
 
       method_call = CountryStateSelect.state_options(options)
@@ -109,7 +112,7 @@ describe CountryStateSelect do
       expect(method_call[:label]).to eq(options[:label])
     end
 
-    it "should contain a collection of type Array if a country has states" do
+    it 'should contain a collection of type Array if a country has states' do
       expect(f.object).to receive(:country_field_name).and_return('US')
 
       method_call = CountryStateSelect.state_options(options)
@@ -117,7 +120,7 @@ describe CountryStateSelect do
       expect(method_call[:collection].class).to eq(Array)
     end
 
-    it "should contain a collection of type String if a country has no states" do
+    it 'should contain a collection of type String if a country has no states' do
       expect(f.object).to receive(:country_field_name).and_return('MF')
       expect(f.object).to receive(:state_field_name).and_return('')
 
@@ -128,45 +131,42 @@ describe CountryStateSelect do
   end
 
   describe '#collect_states' do
-    it "returns an array" do
+    it 'returns an array' do
       method_call = CountryStateSelect.collect_states('US')
       expect(method_call.class).to eq(Array)
     end
 
-    it "returns the diffrent value for the key and value" do
+    it 'returns the diffrent value for the key and value' do
       method_call = CountryStateSelect.collect_states('US')
-      expect(method_call.first.first).not_to eq(method_call.first.second)
+      expect(method_call[0][0]).not_to eq(method_call[0][1])
     end
 
-    it "returns the value part of the key-value pair" do
+    it 'returns the value part of the key-value pair' do
       method_call = CountryStateSelect.collect_states('US')
-      expect(method_call.first.first).to eq("Alaska")
+      expect(method_call.first.first).to eq('Alaska')
     end
 
-    it "returns an empty array if there are no states in that Country" do
+    it 'returns an empty array if there are no states in that Country' do
       method_call = CountryStateSelect.collect_states('MF')
       expect(method_call).to eq([])
     end
   end
 
   describe '#collect_cities' do
-
-    it "returns an array" do
+    it 'returns an array' do
       method_call = CountryStateSelect.collect_cities(:mp, :in)
       expect(method_call.class).to eq(Array)
     end
 
-    it "it should return same value if city is not duplicate with state with out sending country" do
+    it 'it should return same value if city is not duplicate with state with out sending country' do
       city_without_country = CountryStateSelect.collect_cities(:mp, '')
       city_with_country = CountryStateSelect.collect_cities(:mp, :in)
       expect(city_without_country).to eq(city_with_country)
     end
 
-
-    it "returns an empty array if there are no states in that Country" do
+    it 'returns an empty array if there are no states in that Country' do
       method_call = CountryStateSelect.collect_cities('', '')
-      expect(method_call).to eq([])
+      expect(method_call).to eq(nil)
     end
   end
-
-end
+end