carmen-rails 1.0.0.beta3 → 1.0.0

data/README.md

@@ -50,3 +50,13 @@ carmen-rails [have been thoroughly TomDoc'ed](https://github.com/jim/carmen-rail
 
 There is a [live demo app](http://carmen-rails-demo.herokuapp.com) that shows
 carmen-rails in action, and includes a [step-by-step setup guide](https://github.com/jim/carmen-demo-app#readme).
+
+## Configuration
+
+Using this library will automatically set Carmen to use [Rails' built-in I18n functionality](http://guides.rubyonrails.org/i18n.html). This means that changing
+some configuration should be done through Rails and not Carmen. For example, adding paths for additional locale files
+should be done inside `config/application.rb`:
+
+``` ruby
+config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+```

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

@@ -45,9 +45,24 @@ module ActionView
       #
       #   country_select(@object, :region, {priority: ['US', 'CA']}, class: 'region')
       #
+      # Note that in order to preserve compatibility with various existing
+      # libraries, an alternative API is supported but not recommended:
+      #
+      #   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, options={}, html_options={})
-        tag = InstanceTag.new(object, method, self, options.delete(:object))
+      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 ||= {}
+
+        tag = InstanceTag.new(object, method, self)
         tag.to_region_select_tag(Carmen::World.instance, options, html_options)
       end
 
@@ -85,7 +100,9 @@ module ActionView
         end
 
         main_options = regions.map { |r| [r.name, r.code] }
-        main_options.sort!{|a, b| a.first.unpack('U').to_s <=> b.first.unpack('U').to_s}
+        main_options.sort!{|a, b| a.first.to_s <=> b.first.to_s}
+        main_options.unshift [options['prompt'], ''] if options['prompt']
+
         region_options += options_for_select(main_options, selected)
         region_options.html_safe
       end
@@ -133,10 +150,9 @@ module ActionView
       def subregion_select_tag(name, value, parent_region_or_code, options = {}, html_options = {})
         options.stringify_keys!
         parent_region = determine_parent(parent_region_or_code)
-        priority_regions = options.delete(:priority) || []
-        opts = region_options_for_select(parent_region.subregions, value, :priority => priority_regions)
+        opts = region_options_for_select(parent_region.subregions, value, options)
         html_options = {"name" => name,
-                        "id" => sanitize_to_id(name)}.update(options.stringify_keys)
+                        "id" => sanitize_to_id(name)}.update(html_options.stringify_keys)
         content_tag(:select, opts, html_options)
       end
 
@@ -157,7 +173,7 @@ module ActionView
     end
 
     class InstanceTag
-      def to_region_select_tag(parent_region, options, html_options)
+      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] || []
@@ -173,9 +189,8 @@ module ActionView
       # web form.
       #
       # See `FormOptionsHelper::country_select` for more information.
-      def country_select(method, options = {}, html_options = {})
-        @template.country_select(@object_name, method,
-                                 options.merge(:object => @object), html_options)
+      def country_select(method, *args)
+        @template.country_select(@object_name, method, *args)
       end
 
       # Generate select and subregion option tags with the provided name. A
@@ -183,9 +198,8 @@ module ActionView
       # a given country.
       #
       # See `FormOptionsHelper::subregion_select` for more information.
-      def subregion_select(method, parent_region_or_code, options={}, html_options={})
-        @template.subregion_select(@object_name, method, parent_region_or_code,
-                                   options.merge(:object => @object), html_options)
+      def subregion_select(method, parent_region_or_code, *args)
+        @template.subregion_select(@object_name, method, parent_region_or_code, *args)
       end
     end
 

data/lib/carmen/rails/version.rb

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

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

@@ -46,13 +46,41 @@ class CarmenViewHelperTest < MiniTest::Unit::TestCase
     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']})
+    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>
@@ -112,7 +140,7 @@ class CarmenViewHelperTest < MiniTest::Unit::TestCase
     assert_select('option[selected="selected"][value="AO"]')
   end
 
-  def test_basic_subregion_select
+  def test_basic_subregion_select_tag
     oceania = Carmen::Country.coded('OC')
     expected = <<-HTML
       <select id="subregion_code" name="subregion_code">
@@ -125,6 +153,35 @@ class CarmenViewHelperTest < MiniTest::Unit::TestCase
     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
@@ -150,7 +207,35 @@ class CarmenViewHelperTest < MiniTest::Unit::TestCase
     assert_equal_markup(expected, html)
   end
 
-  def method_missing(method, *args)
-    fail "method_missing #{method}"
+  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

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: carmen-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Jim Benton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000Z
+date: 2013-04-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70153544790280 !ruby/object:Gem::Requirement
+  requirement: &2160706040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70153544790280
+  version_requirements: *2160706040
 - !ruby/object:Gem::Dependency
   name: carmen
-  requirement: &70153544786740 !ruby/object:Gem::Requirement
+  requirement: &2160704840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0.beta2
   type: :runtime
   prerelease: false
-  version_requirements: *70153544786740
+  version_requirements: *2160704840
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70153544785780 !ruby/object:Gem::Requirement
+  requirement: &2160677320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153544785780
+  version_requirements: *2160677320
 description: Provides country_select and subregion_select form helpers.
 email:
 - jim@autonomousmachine.com
@@ -75,12 +75,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Rails adapter for Carmen