subdivision_select 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a1349ca5beb57364c00b30deb474507f3028b52
+  data.tar.gz: 3d9a9f3a9c9563a82304e2da6027406804f0ff19
+SHA512:
+  metadata.gz: 6c07ad1a726098873117fcea8d39f60528460c9b3dca69c6d5ba52ab37a0dfab4504bb1c70efa231be05441db81b744bcf1aa8aed333a02768f93507afce5d73
+  data.tar.gz: 32022822f36eccc0c00807cb26084847ac9351a74c103e494b71af8538b2152a589172072db39ae8c24135b7693c97d87b2567868ee0dc1a123cca9fd8fedac5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Sean Collins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "SubdivisionSelect"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+Bundler::GemHelper.install_tasks
+
+task default: "app:spec"

data/app/assets/javascripts/subdivision_select.js

@@ -0,0 +1,68 @@
+var SubdivisionSelect = (function() {
+  function SubdivisionSelect(element) {
+    this._countrySelect = element;
+    this._subdivisionSelect = $(element).
+      closest("form").
+      find(SubdivisionSelect.subdivisionSelector);
+  };
+
+  SubdivisionSelect.subdivisionSelector = "select.subdivision-selector";
+  SubdivisionSelect.countrySelector = "select[id$=country]";
+
+  SubdivisionSelect.init = function () {
+    var klass = this;
+
+    return $(klass.countrySelector).each(function() {
+      return new klass(this).init();
+    });
+  };
+
+  SubdivisionSelect.prototype.init = function() {
+    var self = this;
+
+    $(this._countrySelect).change(function() {
+      $.ajax( {
+        url: "/subdivisions",
+        data: { country_code: $(this).val() }
+      }).success(function(newSubdivisions) {
+        self._clearSubdivisionSelect();
+        self._updateSubdivisionSelect(newSubdivisions);
+      });
+    });
+  };
+
+  SubdivisionSelect.prototype._updateSubdivisionSelect = function(newSubdivisions) {
+    var self = this;
+    var isEmpty = $.isEmptyObject(newSubdivisions);
+
+    $.each(newSubdivisions, function(alpha2, name) {
+      self._subdivisionSelect.append($("<option></option>").attr("value", alpha2).text(name));
+    });
+
+    // Disable the select if there are no newSubdivisions (and un-do that once there are some)
+    self._subdivisionSelect.prop("disabled", isEmpty);
+
+    // If there are none, make it say "none"
+    if (isEmpty) {
+      self._subdivisionSelect.append($("<option></option>").text("none"));
+    }
+  };
+
+  // Not only empty the select, but:
+  // if the first element is blank, add a blank element before all others
+  SubdivisionSelect.prototype._clearSubdivisionSelect = function() {
+    var includeBlank = this._subdivisionSelect.children().first().text() === "";
+
+    this._subdivisionSelect.empty();
+
+    if (includeBlank) {
+      this._subdivisionSelect.append($("<option></option>"));
+    }
+  };
+
+  return SubdivisionSelect;
+})();
+
+$(function() {
+  SubdivisionSelect.init();
+});

data/app/assets/stylesheets/subdivision_select/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/subdivision_select/subdivisions_controller.rb

@@ -0,0 +1,7 @@
+module SubdivisionSelect
+  class SubdivisionsController < ApplicationController
+    def get
+      render json: SubdivisionsHelper::get_subdivisions(params[:country_code])
+    end
+  end
+end

data/app/helpers/subdivision_select/subdivisions_helper.rb

@@ -0,0 +1,20 @@
+module SubdivisionSelect
+  module SubdivisionsHelper
+    def self.get_subdivisions(alpha2)
+      # The countries gem returns a hash, where:
+      # the keys are the ISO 3166-2 subdivision two letter codes
+      # and the value is a hash with two key/values:
+      # - "name" is the most popular/most correct name
+      # - "names" is an array of all the names
+      if Country[alpha2].nil?
+        {}
+      else
+        Country[alpha2].subdivisions.map { |k, v| [k, v["name"]] }.to_h
+      end
+    end
+
+    def self.get_subdivisions_for_select(alpha2)
+      get_subdivisions(alpha2).invert.to_a
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+SubdivisionSelect::Engine.routes.draw do
+  get "/", to: "subdivisions#get"
+end

data/lib/subdivision_select.rb

@@ -0,0 +1,4 @@
+require "subdivision_select/engine"
+
+module SubdivisionSelect
+end

data/lib/subdivision_select/engine.rb

@@ -0,0 +1,21 @@
+require "subdivision_select/subdivision_select_helper"
+
+module SubdivisionSelect
+  class Engine < ::Rails::Engine
+    isolate_namespace SubdivisionSelect
+
+    require "jquery-rails"
+    # "country_select" requires "countries", but it's separated here because:
+    #   - `countries` is used directly
+    #   - `country_select` is so users don't have to add country_select to their
+    #                      Gemfile, since it's required
+    # (so we could have just included the latter, but this is more clear)
+    require "countries"
+    require "country_select"
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+  end
+end

data/lib/subdivision_select/subdivision_select_helper.rb

@@ -0,0 +1,32 @@
+module ActionView
+  module Helpers
+    class FormBuilder
+      def subdivision_select(method, country_or_options = {}, options = {}, html_options = {})
+        # Shift args, if necessary
+        if Hash === country_or_options
+          html_options = options
+          options = country_or_options
+        else
+          country = country_or_options
+        end
+
+        # Add class (that JS uses)
+        if html_options["class"].present?
+          html_options["class"] += " subdivision-selector"
+        else
+          html_options["class"] = "subdivision-selector"
+        end
+
+        Tags::Select.new(
+          @object_name,
+          method,
+          self,
+          SubdivisionSelect::SubdivisionsHelper::get_subdivisions_for_select(country),
+          options,
+          html_options
+        ).render
+      end
+    end
+
+  end
+end

data/lib/subdivision_select/version.rb

@@ -0,0 +1,3 @@
+module SubdivisionSelect
+  VERSION = "0.0.1"
+end

data/lib/tasks/subdivision_select_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :subdivision_select do
+#   # Task goes here
+# end

data/spec/controllers/subdivision_select/subdivisions_controller_spec.rb

@@ -0,0 +1,22 @@
+require "rails_helper"
+
+module SubdivisionSelect
+  RSpec.describe SubdivisionsController, type: :controller do
+    routes { SubdivisionSelect::Engine.routes }
+
+    describe "GET #get" do
+      it "returns http success in JSON, when correct param supplied" do
+        get :get, country_code: "IE"
+        expect(response).to have_http_status(:success)
+        expect(response.content_type).to eq("application/json")
+      end
+
+      it "returns http success in JSON, w/o correct param supplied" do
+        get :get
+        expect(response).to have_http_status(:success)
+        expect(response.content_type).to eq("application/json")
+      end
+
+    end
+  end
+end

data/spec/helpers/subdivision_select/subdivisions_helper_spec.rb

@@ -0,0 +1,27 @@
+require "rails_helper"
+
+# Specs in this file have access to a helper object that includes
+# the SubdivisionsHelper. For example:
+#
+# describe SubdivisionsHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       expect(helper.concat_strings("this","that")).to eq("this that")
+#     end
+#   end
+# end
+module SubdivisionSelect
+  RSpec.describe SubdivisionsHelper, type: :helper do
+    it "gets subdivisions for Germany" do
+      expect(SubdivisionsHelper::get_subdivisions("DE")["BE"]).to eq("Berlin")
+      expect(SubdivisionsHelper::get_subdivisions("DE").count).to eq(16)
+    end
+
+    # TODO: actually check if a select would be correct
+    it "gets subdivisions_for_select for Germany" do
+      german_states = SubdivisionsHelper::get_subdivisions("DE")
+      for_select = SubdivisionsHelper::get_subdivisions_for_select("DE")
+      expect(for_select).to eq(german_states.invert.to_a)
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,53 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= "test"
+require "spec_helper"
+require File.expand_path("../../spec/test_app/config/environment", __FILE__)
+require "rspec/rails"
+require "capybara/rails"
+require "capybara/rspec"
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+# This file was generated by the `rails generate rspec:install` command.
+# Conventionally, all specs live under a `spec` directory, which RSpec adds to
+# the `$LOAD_PATH`. The generated `.rspec` file contains `--require spec_helper`
+# which will cause this file to always be loaded, without a need to explicitly
+# require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# 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
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow 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.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3
+  #   config.disable_monkey_patching!
+  #
+  #   # 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