carmen-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60e0203dc4406464bdc96cb694b3105a01550a0c
+  data.tar.gz: 95ab17dade0f5108f8af0ca057680fa94a32e9a2
+SHA512:
+  metadata.gz: bbab683e09c64fae6072bc309ab380c347d8da0d1af11255d222b91db3306fdb202bfa44ab8d788dd828af4f83f242716b2d8ab4a3f15e923827d99836d9206d
+  data.tar.gz: 9e3e3669fbfd86d85c0c51f6e87852971523c883a865107fa5633c723335299367d98f7d5320e0218d5c205afaeb93b21351a576b5f32068849f34c25e41a81a

data/README.md

@@ -4,25 +4,41 @@ carmen-rails is a Rails 3 plugin that supplies two new form helper methods:
 `country_select` and `subregion_select`. It uses
 [carmen](http://github.com/jim/carmen) as its source of geographic data.
 
+## Requirements
+
+carmen-rails requires Ruby 1.9.2 or greater.
+
 ## Installation
 
 Just add carmen-rails to your Gemfile:
 
 ```ruby
-gem 'carmen-rails', '~> 1.0.0.beta3'
+gem 'carmen-rails', '~> 1.0.0'
 ```
-
 ## Usage
 
 ```erb
 <%= form_for(@order) do |f| %>
   <div class="field">
     <%= f.label :country_code %><br />
-    <%= f.country_select :country_code, {priority: %w(US CA)}, prompt: 'Please select a country' %>
+    <%= f.country_select :country_code, {priority: %w(US CA), prompt: 'Please select a country'} %>
   </div>
 <% end %>
 ```
 
+#### SimpleForm
+Pass the object to the country_select helper. This ensures the persisted country is selected when the form is rendered. 
+
+```erb
+<%= simple_form_for @user do |f| %>
+  <%= f.input :country_code do %>
+    <%= f.country_select :country_code, {object: f.object, prompt: 'Country'} %>
+  <% end %>
+<% end %>
+```
+
+Passing the object is necessary when using nested form fields with Formtastic.
+
 ## How do I only display a subset of countries/regions?
 
 Carmen had a concept of excluded countries in the old days, where you could
@@ -59,4 +75,4 @@ should be done inside `config/application.rb`:
 
 ``` ruby
 config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-```
+```

data/Rakefile

@@ -1,19 +1,18 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
+require "rubygems"
+require 'bundler/setup'
 
+require 'rake'
 require 'rake/testtask'
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new(:spec) do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.libs << 'spec'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = false
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
 end
 
-task :default => :spec
+desc 'Default: run unit tests.'
+task :default => :test

data/lib/carmen/rails/action_view/form_helper.rb

@@ -15,7 +15,7 @@ module ActionView
       # html_options - Options to use when generating the select tag- class,
       #                id, etc.
       #
-      # Uses region_options_or_select to generate the list of option tags.
+      # Uses region_options_for_select to generate the list of option tags.
       #
       # Example:
       #
@@ -24,7 +24,7 @@ module ActionView
       # Returns an `html_safe` string containing the HTML for a select element.
       def subregion_select(object, method, parent_region_or_code, options={}, html_options={})
         parent_region = determine_parent(parent_region_or_code)
-        tag = InstanceTag.new(object, method, self, options.delete(:object))
+        tag = instance_tag(object, method, self, options)
         tag.to_region_select_tag(parent_region, options, html_options)
       end
 
@@ -51,18 +51,16 @@ module ActionView
       #   country_select(@object, :region, ['US', 'CA'], class: region)
       #
       # Returns an `html_safe` string containing the HTML for a select element.
-      def country_select(object, method, *args)
-
-        # These contortions are to provide API-compatibility
-        priority_countries = args.shift if args.first.is_a?(Array)
-        options, html_options = args
-
-        options ||= {}
-        options[:priority] = priority_countries if priority_countries
-
-        html_options ||= {}
+      def country_select(object, method, priorities_or_options = {}, options_or_html_options = {}, html_options = {})
+        if priorities_or_options.is_a? Array
+          options = options_or_html_options
+          options[:priority] = priorities_or_options
+        else
+          options = priorities_or_options
+          html_options = options_or_html_options
+        end
 
-        tag = InstanceTag.new(object, method, self)
+        tag = instance_tag(object, method, self, options)
         tag.to_region_select_tag(Carmen::World.instance, options, html_options)
       end
 
@@ -96,6 +94,11 @@ module ActionView
           unless priority_regions.empty?
             region_options += options_for_select(priority_regions, selected)
             region_options += "<option disabled>-------------</option>"
+
+            # If a priority region is selected, don't select it again in the main list.
+            # This prevents some browsers from selecting the second occurance of this region,
+            # which makes it difficult to select an alternative priority region.
+            selected = nil if priority_region_codes.include?(selected)
           end
         end
 
@@ -158,6 +161,15 @@ module ActionView
 
       private
 
+      def instance_tag(object_name, method_name, template_object, options = {})
+        if Rails::VERSION::MAJOR == 3
+          InstanceTag.new(object_name, method_name, template_object, options.delete(:object))
+        else
+          ActionView::Helpers::Tags::Base.new(object_name, method_name, template_object, options || {})
+        end
+      end
+
+
       def determine_parent(parent_region_or_code)
         case parent_region_or_code
         when String
@@ -172,14 +184,41 @@ module ActionView
       end
     end
 
-    class InstanceTag
-      def to_region_select_tag(parent_region, options = {}, html_options = {})
-        html_options = html_options.stringify_keys
-        add_default_name_and_id(html_options)
-        priority_regions = options[:priority] || []
-        value = value(object)
-        opts = add_options(region_options_for_select(parent_region.subregions, value, :priority => priority_regions), options, value)
-        content_tag("select", opts, html_options)
+    if Rails::VERSION::MAJOR == 3
+      class InstanceTag
+        def to_region_select_tag(parent_region, options = {}, html_options = {})
+          html_options = html_options.stringify_keys
+          add_default_name_and_id(html_options)
+          priority_regions = options[:priority] || []
+          value = options[:selected] ? options[:selected] : value(object)
+          opts = add_options(region_options_for_select(parent_region.subregions, value, :priority => priority_regions), options, value)
+          content_tag("select", opts, html_options)
+        end
+      end
+    end
+
+    if Rails::VERSION::MAJOR == 4
+      module Tags
+        class Base
+          def to_region_select_tag(parent_region, options = {}, html_options = {})
+            html_options = html_options.stringify_keys
+            add_default_name_and_id(html_options)
+            options[:include_blank] ||= true unless options[:prompt] || select_not_required?(html_options)
+
+            value = options[:selected] ? options[:selected] : value(object)
+            priority_regions = options[:priority] || []
+            opts = add_options(region_options_for_select(parent_region.subregions, value, 
+                                                        :priority => priority_regions), 
+                               options, value)
+            select = content_tag("select", opts, html_options)
+            if html_options["multiple"] && options.fetch(:include_hidden, true)
+              tag("input", :disabled => html_options["disabled"], :name => html_options["name"], 
+                           :type => "hidden", :value => "") + select
+            else
+              select
+            end
+          end
+        end
       end
     end
 
@@ -189,8 +228,16 @@ module ActionView
       # web form.
       #
       # See `FormOptionsHelper::country_select` for more information.
-      def country_select(method, *args)
-        @template.country_select(@object_name, method, *args)
+      def country_select(method, priorities_or_options = {}, options_or_html_options = {}, html_options = {})
+        if priorities_or_options.is_a? Array
+          options = options_or_html_options
+          options[:priority] = priorities_or_options
+        else
+          options = priorities_or_options
+          html_options = options_or_html_options
+        end
+
+        @template.country_select(@object_name, method, objectify_options(options), @default_options.merge(html_options))
       end
 
       # Generate select and subregion option tags with the provided name. A
@@ -198,8 +245,8 @@ module ActionView
       # a given country.
       #
       # See `FormOptionsHelper::subregion_select` for more information.
-      def subregion_select(method, parent_region_or_code, *args)
-        @template.subregion_select(@object_name, method, parent_region_or_code, *args)
+      def subregion_select(method, parent_region_or_code, options = {}, html_options = {})
+        @template.subregion_select(@object_name, method, parent_region_or_code, objectify_options(options), @default_options.merge(html_options))
       end
     end
 

data/lib/carmen/rails/version.rb

@@ -1,5 +1,5 @@
 module Carmen
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,49 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: carmen-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Jim Benton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-20 00:00:00.000000000Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2160706040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160706040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: carmen
-  requirement: &2160704840 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160704840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2160677320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160677320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides country_select and subregion_select form helpers.
 email:
 - jim@autonomousmachine.com
@@ -51,39 +59,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/carmen-rails.rb
 - lib/carmen/rails/action_view/form_helper.rb
 - lib/carmen/rails/version.rb
-- lib/carmen-rails.rb
 - lib/tasks/carmen-rails_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
-- spec/carmen/action_view/helpers/form_helper_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/jim/carmen-rails
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails adapter for Carmen
-test_files:
-- spec/carmen/action_view/helpers/form_helper_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/carmen/action_view/helpers/form_helper_spec.rb

@@ -1,241 +0,0 @@
-require 'spec_helper'
-
-class CarmenViewHelperTest < MiniTest::Unit::TestCase
-  include ActionView::Helpers::FormOptionsHelper
-  include ActionView::Helpers::FormTagHelper
-  include ActionDispatch::Assertions::SelectorAssertions
-
-  def setup
-    @object = OpenStruct.new
-    def @object.to_s; 'object'; end
-  end
-
-  def response_from_page
-    HTML::Document.new(@html).root
-  end
-
-  def test_basic_country_select
-    html = country_select(@object, :country_code)
-    expected = <<-HTML
-      <select id="object_country_code" name="object[country_code]">
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_country_selected_value
-    @object.country_code = 'OC'
-    @html = country_select(@object, :country_code)
-    assert_select('option[selected="selected"][value="OC"]')
-  end
-
-  def test_basic_country_select_tag
-    html = country_select_tag('attribute_name', nil)
-    expected = <<-HTML
-      <select id="attribute_name" name="attribute_name">
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_country_select_tag_with_prompt
-    html = country_select_tag('attribute_name', nil, :prompt => 'Please Select')
-    expected = <<-HTML
-      <select id="attribute_name" name="attribute_name">
-        <option value="">Please Select</option>
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-  def test_country_tag_selected_value
-    @html = country_select_tag(:country_code, 'OC')
-    assert_select('option[selected="selected"][value="OC"]')
-  end
-
-  def test_priority_country_select
-    html = country_select(@object, :country_code, :priority => ['ES'])
-    expected = <<-HTML
-      <select id="object_country_code" name="object[country_code]">
-        <option value="ES">Eastasia</option>
-        <option disabled>-------------</option>
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_priority_country_select_deprecated_api
-    html = country_select(@object, :country_code, ['ES'], {})
-    expected = <<-HTML
-      <select id="object_country_code" name="object[country_code]">
-        <option value="ES">Eastasia</option>
-        <option disabled>-------------</option>
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_basic_subregion_select
-    oceania = Carmen::Country.coded('OC')
-    expected = <<-HTML
-      <select id="object_subregion_code" name="object[subregion_code]">
-        <option value="AO">Airstrip One</option>
-      </select>
-    HTML
-
-    html = subregion_select(@object, :subregion_code, oceania)
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_subregion_select_using_parent_code
-    expected = <<-HTML
-      <select id="object_subregion_code" name="object[subregion_code]">
-        <option value="AO">Airstrip One</option>
-      </select>
-    HTML
-
-    html = subregion_select(@object, :subregion_code, 'OC')
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_subregion_select_using_parent_code_array
-    expected = <<-HTML
-      <select id="object_subregion_code" name="object[subregion_code]">
-        <option value="LO">London</option>
-      </select>
-    HTML
-
-    html = subregion_select(@object, :subregion_code, ['OC', 'AO'])
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_subregion_selected_value
-    @object.subregion_code = 'AO'
-    oceania = Carmen::Country.coded('OC')
-
-    @html = subregion_select(@object, :subregion_code, oceania)
-
-    assert_select('option[selected="selected"][value="AO"]')
-  end
-
-  def test_basic_subregion_select_tag
-    oceania = Carmen::Country.coded('OC')
-    expected = <<-HTML
-      <select id="subregion_code" name="subregion_code">
-        <option value="AO">Airstrip One</option>
-      </select>
-    HTML
-
-    html = subregion_select_tag(:subregion_code, nil, oceania)
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_subregion_select_tag_with_priority
-    oceania = Carmen::Country.coded('OC')
-    expected = <<-HTML
-      <select id="subregion_code" name="subregion_code">
-        <option value="AO">Airstrip One</option>
-        <option disabled>-------------</option>
-        <option value="AO">Airstrip One</option>
-      </select>
-    HTML
-
-    html = subregion_select_tag(:subregion_code, nil, oceania, :priority => ['AO'])
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_subregion_select_tag_with_prompt
-    oceania = Carmen::Country.coded('OC')
-    expected = <<-HTML
-      <select id="subregion_code" name="subregion_code">
-        <option value="">Please select</option>
-        <option value="AO">Airstrip One</option>
-      </select>
-    HTML
-
-    html = subregion_select_tag(:subregion_code, nil, oceania, :prompt => 'Please select')
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_region_options_for_select
-    regions = Carmen::Country.all
-    expected = <<-HTML
-      <option value="ES">Eastasia</option>
-      <option value="EU">Eurasia</option>
-      <option value="OC" selected="selected">Oceania</option>
-    HTML
-    html = region_options_for_select(regions, 'OC')
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_region_options_for_select_with_array_of_regions_and_priority
-    regions = [Carmen::Country.coded('ES'), Carmen::Country.coded('EU')]
-    expected = <<-HTML
-      <option value="ES">Eastasia</option>
-      <option disabled>-------------</option>
-      <option value="ES">Eastasia</option>
-      <option value="EU">Eurasia</option>
-    HTML
-    html = region_options_for_select(regions, nil, :priority => ['ES'])
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_form_builder_country_select
-    form = ActionView::Helpers::FormBuilder.new(:object, @object, self, {}, lambda{})
-
-    html = form.country_select('attribute_name')
-    expected = <<-HTML
-      <select id="object_attribute_name" name="object[attribute_name]">
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-
-  def test_form_builder_country_select_deprecated_api
-    form = ActionView::Helpers::FormBuilder.new(:object, @object, self, {}, lambda{})
-
-    html = form.country_select('attribute_name', ['ES'])
-    expected = <<-HTML
-      <select id="object_attribute_name" name="object[attribute_name]">
-        <option value="ES">Eastasia</option>
-        <option disabled>-------------</option>
-        <option value="ES">Eastasia</option>
-        <option value="EU">Eurasia</option>
-        <option value="OC">Oceania</option>
-      </select>
-    HTML
-
-    assert_equal_markup(expected, html)
-  end
-end

data/spec/spec_helper.rb

@@ -1,36 +0,0 @@
-lib_path = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib_path)
-
-require 'minitest/spec'
-require 'minitest/autorun'
-
-require 'action_view/test_case'
-
-require 'rails'
-require 'carmen-rails'
-require 'ostruct'
-
-MiniTest::Spec.register_spec_type(/.*/, ActionView::TestCase)
-
-Carmen.clear_data_paths
-Carmen.append_data_path(Carmen.root_path + 'spec_data/data')
-
-locale_path = Carmen.root_path + 'spec_data/locale'
-Carmen.i18n_backend = Carmen::I18n::Simple.new(locale_path)
-
-class MiniTest::Unit::TestCase
-  def assert_equal_markup(expected, actual, message=nil)
-    assert_equal(clean_markup(expected), clean_markup(actual), message)
-  end
-
-  private
-
-  def clean_markup(markup)
-    markup.
-      gsub(/\s+/, ' ').    # cleanup whitespace
-      gsub(/>\s/, '>').    # kill space after tags
-      gsub(/\s</, '<').    # space before tags
-      gsub(/\s\/>/, '/>'). # space inside self-closing tags
-      strip
-  end
-end