carmen-country 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e13a40ba9088741f10e7be6b32012be83b10b8d
+  data.tar.gz: efb23fabeab8b2525aa2b5fb77279e835e2cc6c2
+SHA512:
+  metadata.gz: 4519a20e5f973d8e38f908b896079ef3e724071e56af26af0498cb3c88ce38b6436f7ac9bdf1d657fbb49bfad34329727f6c26fae94201d927d9fdd26a43485a
+  data.tar.gz: a349e380dbad21785d122467557d6fbbf977a8e1c0a5dfacaccbefee7ee428003011b2a2779fa88bb25d03c2d3f82f82e8e6a15c43130fa0459d8c8b12138670

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Nilesh Patil 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/Rakefile

@@ -0,0 +1,18 @@
+require "rubygems"
+require 'bundler/setup'
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Default: run unit tests.'
+task :default => :test

data/lib/carmen-rails.rb

@@ -0,0 +1,19 @@
+require 'carmen'
+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,254 @@
+module ActionView
+  module Helpers
+    module FormOptionsHelper
+
+      # Generate select and subregion option tags for the given object and method. A
+      # common use of this would be to allow users to select a state subregion within
+      # a given country.
+      #
+      # object       - The model object to generate the select for
+      # method       - The attribute on the object
+      # parent_region_or_code - An instance of Carmen::Region or a 2-character
+      #                         country code.
+      # options      - Other options pertaining to option tag generation. See
+      #                `region_options_for_select`.
+      # html_options - Options to use when generating the select tag- class,
+      #                id, etc.
+      #
+      # Uses region_options_for_select to generate the list of option tags.
+      #
+      # Example:
+      #
+      #   subregion_select(@object, :region, {priority: ['US', 'CA']}, class: 'region')
+      #
+      # 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 = instance_tag(object, method, self, options)
+        tag.to_region_select_tag(parent_region, options, html_options)
+      end
+
+      # Generate select and country option tags for the given object and method. A
+      # common use of this would be to allow users to select a state subregion within
+      # a given country.
+      #
+      # object       - The model object to generate the select for
+      # method       - The attribute on the object
+      # options      - Other options pertaining to option tag generation. See
+      #                `region_options_for_select`.
+      # 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.
+      #
+      # Example:
+      #
+      #   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, 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 = instance_tag(object, method, self, options)
+        tag.to_region_select_tag(Carmen::World.instance, options, html_options)
+      end
+
+      # Generate option tags for a collection of regions.
+      #
+      # regions  - An array or Carmen::RegionCollection containing Carmen::Regions
+      # selected - the code of the region that should be selected
+      # options  - The hash of options used to customize the output (default: {}):
+      #
+      # To use priority regions (which are included in a special section at the
+      # top of the list), provide an array of region codes at the :priority
+      # option:
+      #
+      #   region_options_for_select(@region.subregions, 'US', priority: ['US', 'CA'])
+      #
+      # Returns an `html_safe` string containing option tags.
+      def region_options_for_select(regions, selected=nil, options={})
+        options.stringify_keys!
+        priority_region_codes = options['priority'] || []
+        region_options = ""
+
+        unless priority_region_codes.empty?
+          unless regions.respond_to?(:coded)
+            regions = Carmen::RegionCollection.new(regions)
+          end
+
+          priority_regions = priority_region_codes.map do |code|
+            region = regions.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>"
+
+            # 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
+
+        main_options = regions.map { |r| [r.name, r.code] }
+        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
+
+      # Generate select and country option tags with the provided name. A
+      # common use of this would be to allow users to select a country name
+      # inside a web form.
+      #
+      # name         - The name attribute for the select element.
+      # options      - Other options pertaining to option tag generation. See
+      #                `region_options_for_select`.
+      # 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.
+      #
+      # Example:
+      #
+      #   country_select_tag('country_code', {priority: ['US', 'CA']}, class: 'region')
+      #
+      # Returns an `html_safe` string containing the HTML for a select element.
+      def country_select_tag(name, value, options={})
+        subregion_select_tag(name, value, Carmen::World.instance, options)
+      end
+
+      # Generate select and subregion option tags for the given object and method. A
+      # common use of this would be to allow users to select a state subregion within
+      # a given country.
+      #
+      # name         - The name attribute for the select element.
+      # parent_region_or_code - An instance of Carmen::Region or a 2-character
+      #                         country code.
+      # options      - Other options pertaining to option tag generation. See
+      #                `region_options_for_select`.
+      # 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.
+      #
+      # Example:
+      #
+      #   subregion_select_tag('state_code', 'US', {priority: ['US', 'CA']}, class: 'region')
+      #
+      # Returns an `html_safe` string containing the HTML for a select element.
+      def subregion_select_tag(name, value, parent_region_or_code, options = {}, html_options = {})
+        options.stringify_keys!
+        parent_region = determine_parent(parent_region_or_code)
+        opts = region_options_for_select(parent_region.subregions, value, options)
+        html_options = {"name" => name,
+                        "id" => sanitize_to_id(name)}.update(html_options.stringify_keys)
+        content_tag(:select, opts, html_options)
+      end
+
+      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
+          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
+
+    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
+
+    class FormBuilder
+      # Generate select and country option tags with the provided name. A
+      # common use of this would be to allow users to select a country name inside a
+      # web form.
+      #
+      # See `FormOptionsHelper::country_select` for more information.
+      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
+      # common use of this would be to allow users to select a state subregion within
+      # 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, objectify_options(options), @default_options.merge(html_options))
+      end
+    end
+
+  end
+end

data/lib/carmen/rails/version.rb

@@ -0,0 +1,5 @@
+module Carmen
+  module Rails
+    VERSION = "1.0.1"
+  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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: carmen-country
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nilesh Patil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: carmens
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides country_select and subregion_select form helpers.
+email:
+- nileshpatil47@yahoo.com
+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/tasks/carmen-rails_tasks.rake
+homepage: http://github.com/nileshpatil47/carmen-rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails adapter for Carmen
+test_files: []