country_state_select 3.2.0 → 4.0.0

data/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "country_state_select",
+  "version": "4.0.0",
+  "description": "Dependency-free Country/State/City cascading select fields, with an optional Stimulus controller. JS companion to the country_state_select Ruby gem.",
+  "type": "module",
+  "main": "app/javascript/country_state_select/country_state_select.js",
+  "module": "app/javascript/country_state_select/country_state_select.js",
+  "exports": {
+    ".": "./app/javascript/country_state_select/country_state_select.js",
+    "./controller": "./app/javascript/country_state_select/controller.js"
+  },
+  "files": [
+    "app/javascript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arvindvyas/Country-State-Select.git"
+  },
+  "homepage": "https://github.com/arvindvyas/Country-State-Select",
+  "bugs": "https://github.com/arvindvyas/Country-State-Select/issues",
+  "keywords": [
+    "rails",
+    "country",
+    "state",
+    "city",
+    "select",
+    "stimulus",
+    "hotwire"
+  ],
+  "author": "Arvind Vyas",
+  "license": "MIT",
+  "peerDependencies": {
+    "@hotwired/stimulus": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@hotwired/stimulus": {
+      "optional": true
+    }
+  }
+}

data/spec/country_state_select_spec.rb

@@ -164,9 +164,9 @@ describe CountryStateSelect do
       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 cities for that state/country' do
       method_call = CountryStateSelect.collect_cities('', '')
-      expect(method_call).to eq(nil)
+      expect(method_call).to eq([])
     end
   end
 end

data/spec/lib/country_state_select/configuration_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CountryStateSelect::Configuration do
+  describe '#data_source_instance' do
+    it 'defaults to the CityState adapter' do
+      expect(CountryStateSelect.configuration.data_source_instance).to be_a(CountryStateSelect::DataSources::CityState)
+    end
+
+    it 'memoizes the instance across calls' do
+      config = CountryStateSelect::Configuration.new
+
+      expect(config.data_source_instance).to equal(config.data_source_instance)
+    end
+
+    it 'rebuilds the instance when the data source is reassigned' do
+      config = CountryStateSelect::Configuration.new
+      first = config.data_source_instance
+
+      config.data_source = :city_state
+      expect(config.data_source_instance).not_to equal(first)
+    end
+
+    it 'raises for an unknown symbol data source' do
+      config = CountryStateSelect::Configuration.new
+      config.data_source = :not_a_real_source
+
+      expect { config.data_source_instance }.to raise_error(ArgumentError)
+    end
+
+    it 'accepts a custom adapter object directly' do
+      custom = Class.new(CountryStateSelect::DataSources::Base) do
+        def countries = { US: 'United States' }
+      end.new
+      config = CountryStateSelect::Configuration.new
+      config.data_source = custom
+
+      expect(config.data_source_instance).to equal(custom)
+    end
+  end
+
+  describe 'defaults' do
+    it 'has sane defaults for a fresh configuration' do
+      config = CountryStateSelect::Configuration.new
+
+      expect(config.priority_countries).to eq([])
+      expect(config.flags).to be(false)
+      expect(config.dial_codes).to be(false)
+      expect(config.localize_names).to be(false)
+      expect(config.cache_duration).to eq(86_400)
+      expect(config.draw_routes).to be(true)
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the shared configuration and persists changes' do
+      CountryStateSelect.configure { |c| c.priority_countries = %w[US] }
+
+      expect(CountryStateSelect.configuration.priority_countries).to eq(%w[US])
+    end
+  end
+end

data/spec/lib/country_state_select/country_metadata_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CountryStateSelect::CountryMetadata do
+  describe '.flag' do
+    it 'converts a two-letter ISO code into its regional indicator flag emoji' do
+      expect(described_class.flag(:US)).to eq("\u{1F1FA}\u{1F1F8}")
+      expect(described_class.flag('IN')).to eq("\u{1F1EE}\u{1F1F3}")
+    end
+
+    it 'returns nil for a non two-letter code' do
+      expect(described_class.flag('USA')).to be_nil
+    end
+  end
+
+  describe '.decorate' do
+    after { CountryStateSelect.reset_configuration! }
+
+    it 'returns the plain name when flags and dial_codes are both off' do
+      expect(described_class.decorate(:US, 'United States')).to eq('United States')
+    end
+
+    it 'prepends the flag when configured' do
+      CountryStateSelect.configure { |c| c.flags = true }
+
+      expect(described_class.decorate(:US, 'United States')).to start_with("\u{1F1FA}\u{1F1F8}")
+    end
+
+    it 'appends the dial code when configured' do
+      CountryStateSelect.configure { |c| c.dial_codes = true }
+
+      expect(described_class.decorate(:US, 'United States')).to eq('United States (+1)')
+    end
+
+    it 'combines flag and dial code when both are configured' do
+      CountryStateSelect.configure { |c| c.flags = true; c.dial_codes = true }
+
+      expect(described_class.decorate(:US, 'United States')).to eq("\u{1F1FA}\u{1F1F8} United States (+1)")
+    end
+  end
+end

data/spec/lib/country_state_select/filtering_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'CountryStateSelect only/except/priority filtering' do
+  after { CountryStateSelect.reset_configuration! }
+
+  describe '.countries_collection' do
+    it 'restricts to only the given codes when passed explicitly' do
+      result = CountryStateSelect.countries_collection(only: %w[US IN])
+
+      expect(result.map(&:last)).to contain_exactly(:US, :IN)
+    end
+
+    it 'excludes the given codes when passed explicitly' do
+      result = CountryStateSelect.countries_collection(except: %w[US])
+
+      expect(result.map(&:last)).not_to include(:US)
+    end
+
+    it 'moves priority codes to the front, in the given order' do
+      result = CountryStateSelect.countries_collection(priority: %w[IN US])
+
+      expect(result.first(2).map(&:last)).to eq(%i[IN US])
+    end
+
+    it 'reads only/except/priority from global configuration when not passed explicitly' do
+      CountryStateSelect.configure do |c|
+        c.only_countries = %w[US IN GB]
+        c.priority_countries = %w[GB]
+      end
+
+      result = CountryStateSelect.countries_collection
+
+      expect(result.first.last).to eq(:GB)
+      expect(result.map(&:last)).to contain_exactly(:US, :IN, :GB)
+    end
+
+    it 'lets a per-call override win over global configuration' do
+      CountryStateSelect.configure { |c| c.only_countries = %w[US] }
+
+      result = CountryStateSelect.countries_collection(only: %w[IN])
+
+      expect(result.map(&:last)).to contain_exactly(:IN)
+    end
+  end
+
+  describe '.collect_states / .raw_states' do
+    it 'returns [name, code] pairs from collect_states and [code, name] from raw_states' do
+      labeled = CountryStateSelect.collect_states('US')
+      raw = CountryStateSelect.raw_states('US')
+
+      expect(labeled.first).to eq(raw.first.reverse)
+    end
+
+    it 'applies only/except/priority the same way as countries' do
+      result = CountryStateSelect.collect_states('US', only: %w[CA NY])
+
+      expect(result.map(&:last)).to contain_exactly(:CA, :NY)
+    end
+  end
+
+  describe '.countries_except' do
+    it 'is equivalent to countries_collection(except: ...)' do
+      expect(CountryStateSelect.countries_except('US')).to eq(CountryStateSelect.countries_collection(except: ['US']))
+    end
+  end
+end

data/spec/lib/country_state_select/localization_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CountryStateSelect::Localization do
+  after do
+    CountryStateSelect.reset_configuration!
+    I18n.backend.reload!
+  end
+
+  describe '.country_name' do
+    it 'returns the English name unchanged when localize_names is off' do
+      expect(described_class.country_name(:FR, 'France')).to eq('France')
+    end
+
+    context 'when localize_names is on' do
+      before { CountryStateSelect.configure { |c| c.localize_names = true } }
+
+      it 'falls back to the English name when no translation is available' do
+        expect(described_class.country_name(:FR, 'France')).to eq('France')
+      end
+
+      it 'uses a country_state_select.countries.<CODE> I18n key when present' do
+        I18n.backend.store_translations(:en, country_state_select: { countries: { FR: 'La France' } })
+
+        expect(described_class.country_name(:FR, 'France')).to eq('La France')
+      end
+    end
+  end
+end

data/spec/requests/business_form_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'FormBuilder integration (via the dummy Business form)', type: :request do
+  describe 'GET /businesses/new' do
+    it 'renders a country select and blank state/city text fields' do
+      get '/businesses/new'
+
+      expect(response.body).to match(/<select[^>]*id="business_country"/)
+      expect(response.body).to include('United States')
+      expect(response.body).to match(/<input[^>]*type="text"[^>]*id="business_state"/)
+      expect(response.body).to match(/<input[^>]*type="text"[^>]*id="business_city"/)
+    end
+
+    it 'stamps the Stimulus target data attributes' do
+      get '/businesses/new'
+
+      expect(response.body).to include('data-country-state-select-target="country"')
+      expect(response.body).to include('data-country-state-select-target="state"')
+      expect(response.body).to include('data-country-state-select-target="city"')
+    end
+  end
+
+  describe 'GET /businesses/:id/edit' do
+    let(:business) { Business.create!(name: 'Golden Gate Cafe', country: 'US', state: 'CA', city: 'San Francisco') }
+
+    it 'renders state and city as populated selects with the saved value selected' do
+      get "/businesses/#{business.id}/edit"
+
+      expect(response.body).to match(/<select[^>]*id="business_state"/)
+      expect(response.body).to match(/<option selected="selected" value="CA">California<\/option>/)
+
+      expect(response.body).to match(/<select[^>]*id="business_city"/)
+      expect(response.body).to match(/<option selected="selected" value="San Francisco">San Francisco<\/option>/)
+    end
+  end
+end

data/spec/requests/lookups_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'CountryStateSelect lookup endpoints', type: :request do
+  describe 'GET /find_states' do
+    it 'returns raw [code, name] pairs for the given country' do
+      get '/find_states', params: { country_id: 'US' }, as: :json
+
+      expect(response).to have_http_status(:ok)
+      body = JSON.parse(response.body)
+      expect(body).to include(%w[CA California])
+    end
+
+    it 'returns an empty array for a country with no states' do
+      get '/find_states', params: { country_id: 'MF' }, as: :json
+
+      expect(JSON.parse(response.body)).to eq([])
+    end
+
+    it 'sets Cache-Control based on the configured cache_duration' do
+      CountryStateSelect.configure { |c| c.cache_duration = 3600 }
+
+      get '/find_states', params: { country_id: 'US' }, as: :json
+
+      expect(response.headers['Cache-Control']).to include('max-age=3600')
+      expect(response.headers['ETag']).to be_present
+    end
+
+    it 'does not mark the response public when cache_duration is disabled' do
+      CountryStateSelect.configure { |c| c.cache_duration = nil }
+
+      get '/find_states', params: { country_id: 'US' }, as: :json
+
+      expect(response.headers['Cache-Control']).not_to include('public')
+    end
+
+    it 'returns 304 on a conditional request with a matching ETag' do
+      get '/find_states', params: { country_id: 'US' }, as: :json
+      etag = response.headers['ETag']
+
+      get '/find_states', params: { country_id: 'US' }, headers: { 'If-None-Match' => etag }, as: :json
+
+      expect(response).to have_http_status(:not_modified)
+    end
+
+    it 'applies only/except/priority filtering configured on the data source' do
+      CountryStateSelect.configure { |c| c.priority_countries = [] }
+
+      get '/find_states', params: { country_id: 'US' }, as: :json
+      codes = JSON.parse(response.body).map(&:first)
+
+      expect(codes).to include('CA', 'NY')
+      expect(codes).not_to include('COUNTRY_ISO_CODE')
+    end
+  end
+
+  describe 'GET /find_cities' do
+    it 'returns city names for the given state and country' do
+      get '/find_cities', params: { state_id: 'mp', country_id: 'in' }, as: :json
+
+      expect(response).to have_http_status(:ok)
+      expect(JSON.parse(response.body)).to be_an(Array)
+    end
+
+    it 'returns an empty array when state_id is blank' do
+      get '/find_cities', params: { state_id: '', country_id: 'us' }, as: :json
+
+      expect(JSON.parse(response.body)).to eq([])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
-require 'rails'
-require 'active_record'
-require 'country_state_select'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__)
+require 'rspec/rails'
+
+ActiveRecord::Migration.maintain_test_schema!
 
 RSpec.configure do |config|
-  # add configuration here
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+
+  config.after do
+    CountryStateSelect.reset_configuration!
+  end
 end

data/vendor/assets/javascript/country_state_select.js.erb

@@ -1,3 +1,8 @@
+// DEPRECATED (jQuery + Chosen): kept for backward compatibility with apps
+// already requiring this file. New apps should use the dependency-free
+// build instead — see vendor/assets/javascript/country_state_select_vanilla.js
+// (Sprockets) or the npm package / Stimulus controller (importmap, esbuild,
+// webpack). This file will be removed in a future major version.
 function CountryStateSelect(options) {
 
   var state_id = options['state_id'];
@@ -10,6 +15,8 @@ function CountryStateSelect(options) {
   var city_name = $('#' + city_id).attr('name');
   var city_class = $('#' + city_id).attr('class');
 
+  var hasCityField = typeof city_name !== "undefined";
+
   return statesDropdown();
 
   // ====== ***** METHODS ***** ===================================================================== //
@@ -23,11 +30,18 @@ function CountryStateSelect(options) {
       return findStates($(this).val());
     });
 
+    // Bind the city lookup ONCE via event delegation. The state <select> is
+    // swapped out by replaceWith() on every country change, so a directly-bound
+    // handler would be lost (the old code re-bound it on every build, stacking
+    // duplicate listeners and firing multiple AJAX calls per change).
+    if (hasCityField) {
+      citiesDropdown();
+    }
   }
 
   function citiesDropdown() {
-     $("#" + state_id).change(function () {
-      return findCities($("#" + state_id).val(),$("#" + country_id).val());
+    $(document).on('change', '#' + state_id, function () {
+      return findCities($("#" + state_id).val(), $("#" + country_id).val());
     });
   }
 
@@ -74,6 +88,12 @@ function CountryStateSelect(options) {
     return options.hasOwnProperty("chosen_ui") && options['chosen_ui'];
   }
 
+  // Escape values before interpolating them into markup so names containing
+  // quotes, angle brackets or ampersands can't break the option or inject HTML.
+  function escapeHtml(value){
+    return $('<div>').text(value == null ? '' : value).html();
+  }
+
   function findStates(id) {
 
     //Remove all Chosen from existing fields
@@ -83,7 +103,7 @@ function CountryStateSelect(options) {
     //Perform AJAX request to get the data; on success, build the dropdown
     $.ajax({
       url: "/find_states",
-      type: 'post',
+      type: 'get',
       dataType: 'json',
       cache: false,
       data: {country_id: id},
@@ -99,8 +119,7 @@ function CountryStateSelect(options) {
     //Perform AJAX request to get the data; on success, build the dropdown
     $.ajax({
       url: "/find_cities",
-      type: 'post',
-
+      type: 'get',
       dataType: 'json',
       cache: false,
       data: {
@@ -113,33 +132,27 @@ function CountryStateSelect(options) {
 
   //Build the HTML for our dropdown menus
   function buildStatesDropdown(data) {
+    var html;
 
     if (data.length === 0) {
-      html = '<input id="' + state_id + '" name="' + state_name + '" class="' + state_class + '" type="text"  type="text" value="" >';
+      html = '<input id="' + state_id + '" name="' + state_name + '" class="' + state_class + '" type="text" value="" >';
     } else {
       html = '<select id="' + state_id + '" name="' + state_name + '" class="' + state_class + '" >';
-      html += '<option>'+ find_select_option_text('state') +'</option>'
+      html += '<option>' + escapeHtml(find_select_option_text('state')) + '</option>';
 
-      for (i = 0; i < data.length; i++) {
-        html += '<option value='+data[i][0]+'>' + data[i][1] + '</option>';
+      for (var i = 0; i < data.length; i++) {
+        html += '<option value="' + escapeHtml(data[i][0]) + '">' + escapeHtml(data[i][1]) + '</option>';
       }
 
       html += '</select>';
     }
 
-
     $('#' + state_id).replaceWith(html);
 
     //This has to happen AFTER we've replaced the dropdown or text
     if (data.length > 0) {
       addChosenToState();
     }
-
-    // [142] FIXME # Is there any other way to call city method , it is adding change method in every state change 
-    if(typeof city_name !== "undefined" ){
-      citiesDropdown();
-    };
-
   }
 
   function find_select_option_text(type){
@@ -152,14 +165,15 @@ function CountryStateSelect(options) {
   }
 
   function buildCitiesDropdown(data) {
+    var html;
 
     if (data.length === 0) {
-      html = '<input id="' + city_id + '" name="' + city_name + '" class="' + city_class + '" type="text"  type="text" value="" >';
+      html = '<input id="' + city_id + '" name="' + city_name + '" class="' + city_class + '" type="text" value="" >';
     } else {
       html = '<select id="' + city_id + '" name="' + city_name + '" class="' + city_class + '" >';
-      html += '<option>'+ find_select_option_text('city') +'</option>'
-      for (i = 0; i < data.length; i++) {
-        html += '<option>' + data[i] + '</option>';
+      html += '<option>' + escapeHtml(find_select_option_text('city')) + '</option>';
+      for (var i = 0; i < data.length; i++) {
+        html += '<option>' + escapeHtml(data[i]) + '</option>';
       }
 
       html += '</select>';
@@ -174,4 +188,4 @@ function CountryStateSelect(options) {
 
   }
 
-}
+}