carmen-rails 1.0.0.beta1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Jim Benton and contributors
+
+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/README.md

@@ -0,0 +1,31 @@
+# carmen-rails
+
+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.
+
+## Installation
+
+Just add carmen-rails to your Gemfile:
+
+```ruby
+gem 'carmen-rails', '1.0.0.pre'
+```
+
+## 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' %>
+  </div>
+<% end %>
+```
+
+More docs coming soon.
+
+### Demo app
+
+There is a [live demo app](http://carmen-rails-demo.herokuapp.com) that shows
+carmen-rails in action.

data/Rakefile

@@ -0,0 +1,19 @@
+#!/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 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :spec

data/lib/carmen-rails.rb

@@ -0,0 +1,18 @@
+require 'carmen/rails/action_view/form_helper'
+require 'carmen/rails/version'
+
+module Carmen
+  module Rails
+    class Railtie < ::Rails::Railtie
+      # Add Carmen's locale paths to the Rails backend
+      paths = Carmen.i18n_backend.locale_paths.map { |path|
+        Dir[path + '**/*.yml']
+      }.flatten.compact
+      Carmen.i18n_backend = ::I18n
+      config.i18n.load_path += paths
+
+      # Enable fallbacks so that missing translations use the default locale
+      config.i18n.fallbacks = true
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module ActionView
+  module Helpers
+    module FormOptionsHelper
+
+      # Return select and subregion option tags for the given object and method.
+      #
+      # Uses region_options_or_select to generate the list of option tags.
+      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.to_region_select_tag(parent_region, options, html_options)
+      end
+
+      # Return select and country option tags for the given object and method.
+      #
+      # Uses region_options_or_select to generate the list of option tags.
+      def country_select(object, method, options={}, html_options = {})
+        InstanceTag.new(object, method, self, options.delete(:object)).to_region_select_tag(Carmen::World.instance, options, html_options)
+      end
+
+      def region_options_for_select(parent_region, selected = nil, priority_region_codes)
+        region_options = ""
+
+        unless priority_region_codes.empty?
+          priority_regions = priority_region_codes.map do |code|
+            region = parent_region.subregions.coded(code)
+            [region.name, region.code] if region
+          end.compact
+          unless priority_regions.empty?
+            region_options += options_for_select(priority_regions, selected)
+            region_options += "<option disabled>-------------</option>"
+          end
+        end
+
+        main_options = parent_region.subregions.map { |r| [r.name, r.code] }
+        region_options += options_for_select(main_options, selected)
+        region_options.html_safe
+      end
+
+      # Return select tag with the name provided containing country option
+      # tags.
+      #
+      # Uses region_options_or_select to generate the list of option tags.
+      def country_select_tag(name, value, options={})
+        subregion_select_tag(name, value, Carmen::World.instance, options)
+      end
+      #
+      # Return select tag with the name provided containing subregion option
+      # tags.
+      #
+      # Uses region_options_or_select to generate the list of option tags.
+      def subregion_select_tag(name, value, parent_region_or_code, options = {})
+        options.stringify_keys!
+        parent_region = determine_parent(parent_region_or_code)
+        priority_regions = options.delete(:priority) || []
+        opts = region_options_for_select(parent_region, value, priority_regions)
+        html_options = {"name" => name,
+                        "id" => sanitize_to_id(name)}.update(options.stringify_keys)
+        content_tag(:select, opts, html_options)
+      end
+
+      private
+
+      def determine_parent(parent_region_or_code)
+        case parent_region_or_code
+        when String
+          Carmen::Country.coded(parent_region_or_code)
+        when Array
+          parent_region_or_code.inject(Carmen::World.instance) { |parent, next_code|
+            parent.subregions.coded(next_code)
+          }
+        else
+          parent_region_or_code
+        end
+      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, value, priority_regions), options, value)
+        content_tag("select", opts, html_options)
+      end
+    end
+
+    class FormBuilder
+      def country_select(method, options = {}, html_options = {})
+        @template.country_select(@object_name, method,
+                                 options.merge(:object => @object), html_options)
+      end
+
+      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)
+      end
+    end
+
+  end
+end

data/lib/carmen/rails/version.rb

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

data/lib/tasks/carmen-rails_tasks.rake

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

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

@@ -0,0 +1,123 @@
+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="OC">Oceania</option>
+        <option value="EU">Eurasia</option>
+        <option value="ES">Eastasia</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="OC">Oceania</option>
+        <option value="EU">Eurasia</option>
+        <option value="ES">Eastasia</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="OC">Oceania</option>
+        <option value="EU">Eurasia</option>
+        <option value="ES">Eastasia</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
+    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 method_missing(method, *args)
+    fail "method_missing #{method}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+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'
+require 'carmen-rails'
+require 'ostruct'
+
+require 'yaml'
+YAML::ENGINE.yamler = 'syck'
+
+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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: carmen-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- Jim Benton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70334482920600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334482920600
+- !ruby/object:Gem::Dependency
+  name: carmen
+  requirement: &70334482920100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334482920100
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70334482919680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70334482919680
+description: Provides country_select and subregion_select form helpers.
+email:
+- jim@autonomousmachine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rails adapter for Carmen
+test_files:
+- spec/carmen/action_view/helpers/form_helper_spec.rb
+- spec/spec_helper.rb