effective_addresses 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41c69251c76730e7fe6cf466b4d892e39cdc9569
-  data.tar.gz: 9561541536799e5f8f4d3fab9a8f23390c9d45d5
+  metadata.gz: 1e67a2c4ca21e0c16b9d61346e05f3533ba09b31
+  data.tar.gz: 659e413366e47d7c3c8b2469c8c0887f7cbade9a
 SHA512:
-  metadata.gz: f135e6e8b0d6512f62df507af47590ca7b7aa2ab9a1960337afac042809b94099c025731542b698c342c9fd4c0f3eacc4e3041a1b5a33fbcfabae9160a6f0a14
-  data.tar.gz: 4e49543e8691690ac0978dc2ae5b15dd0427c6450769f2660f0b7c4c982e9addb856495918c4b5d9c4173b68a3d01145e2d22868422671a769ed893ab838eb06
+  metadata.gz: 23c02018590042e590c457e702a9178cbbdd34b9f90bfb92bf610e9519cb9067f9212af07d77e4c0aec1ef8f1b9f91010b45c709e1fa890b1b6b4e066ced7025
+  data.tar.gz: ba069457c8055a65af00fc91fdd77a3a5a55cd54737d211262e38bbaad0551147fe012665bc78122c29799b6eb70ed90a46106a2d7c00335aadd37a1d9960924

data/README.md

@@ -165,7 +165,13 @@ The actual permitted parameters are:
 
 ### Form Helpers
 
-Use the helper in a Formtastic or SimpleForm form to quickly create the address fields.  This example is in HAML:
+Use the helper in a Formtastic or SimpleForm form to quickly create the address fields. Currently only supports Formtastic and SimpleForm.
+                                                                                       
+When you select a country from the select input an AJAX GET request will be made to `effective_addresses.address_subregions_path` (`/addresses/subregions/:country_code`) 
+which populates the province/state dropdown with the selected country's states or provinces.
+
+
+#### Formtastic
 
 ```ruby
 = semantic_form_for @user do |f|
@@ -173,7 +179,11 @@ Use the helper in a Formtastic or SimpleForm form to quickly create the address
   = effective_address_fields(f, :billing_address)
 
   = f.action :submit
+```
 
+#### SimpleForm
+
+```ruby
 = simple_form_for @user do |f|
   %h3 Billing Address
   = effective_address_fields(f, :billing_address)
@@ -181,9 +191,57 @@ Use the helper in a Formtastic or SimpleForm form to quickly create the address
   = f.submit 'Save'
 ```
 
-Currently only supports Formtastic and SimpleForm.
+#### Field Ordering
+You may choose to order fields different than the default, such as putting the country first.  You can do so with the `:field_order` option, for example:
+```ruby
+= simple_form_for @user do |f|
+  %h3 Billing Address
+  = effective_address_fields(f, :billing_address, :field_order => [:country_code, :full_name, :address1, :address2, :city, :state_code, :postal_code])
+
+  = f.submit 'Save'
+```
 
-When you select a country from the select input an AJAX GET request will be made to `effective_addresses.address_subregions_path` (`/addresses/subregions/:country_code`) which populates the province/state dropdown with the selected country's states or provinces.
+## Geocoder option
+
+Effective addresses has an optional integration with [Geocoder](https://github.com/alexreisner/geocoder).  At it's simplest, this provides preselection and prefill of `country`, `state`, `city`, and `postal_code` based on the user's IP address. See [Geocoder](https://github.com/alexreisner/geocoder) for
+a complete list of possibilities.
+
+### Installation and Setup
+
+```ruby
+gem 'geocoder'
+```
+
+Add `config/initializer/geocoder.rb`, below is a sample:
+
+```ruby
+Geocoder.configure(
+    # geocoding options
+
+    # IP address geocoding service (see below for supported options):
+    #    https://github.com/alexreisner/geocoder#ip-address-services
+    ip_lookup: :telize,
+    cache: Rails.cache,
+    cache_prefix: 'geocoder:'
+)
+
+# Provide a hardcoded ip of 1.2.3.4 when in developmnt/test and the ip address resolves as localhost
+if %w(development test).include? Rails.env
+  module Geocoder
+    module Request
+      def geocoder_spoofable_ip_with_localhost_override
+        ip_candidate = geocoder_spoofable_ip_without_localhost_override
+        if ip_candidate == '127.0.0.1'
+          '1.2.3.4'
+        else
+          ip_candidate
+        end
+      end
+      alias_method_chain :geocoder_spoofable_ip, :localhost_override
+    end
+  end
+end
+```
 
 
 ## License

data/app/assets/javascripts/effective_addresses/address_fields.js.coffee

@@ -1,9 +1,15 @@
 $(document).on 'change', "select[data-effective-address-country]", (event) ->
   country_code = $(this).val()
   uuid = $(this).data('effective-address-country')
+  form = $(this).closest('form')
 
+  # clear postal_code and city values on country change
+  form.find("input[data-effective-address-postal-code='#{uuid}']").val('')
+  form.find("input[data-effective-address-city='#{uuid}']").val('')
+
+  # load state options
   url = "/addresses/subregions/#{country_code}"
-  state_select = $(this).closest('form').find("select[data-effective-address-state='#{uuid}']").first()
+  state_select = form.find("select[data-effective-address-state='#{uuid}']").first()
 
   if country_code.length == 0
     state_select.prop('disabled', true).addClass('disabled').parent('.form-group').addClass('disabled')

data/app/helpers/effective_addresses_helper.rb

@@ -1,6 +1,8 @@
 require 'carmen-rails'
 
 module EffectiveAddressesHelper
+  @@use_geocoder = defined?(Geocoder)
+
   def effective_address_fields(form, method = 'billing', options = {})
     method = (method.to_s.include?('_address') ? method.to_s : "#{method}_address")
 
@@ -8,13 +10,9 @@ module EffectiveAddressesHelper
     use_full_name = form.object._validators[method.to_sym].any? { |v| v.kind_of?(EffectiveAddressFullNamePresenceValidator) }
 
     address = form.object.send(method) || form.object.addresses.build(:category => method.to_s.gsub('_address', ''))
+    effective_address_pre_select(address) if address.new_record?
 
-    if address.new_record? && EffectiveAddresses.pre_selected_country.present?
-      address.country = EffectiveAddresses.pre_selected_country
-      address.state = EffectiveAddresses.pre_selected_state if (address.country.present? && EffectiveAddresses.pre_selected_state.present?)
-    end
-
-    opts = {:required => required, :use_full_name => use_full_name}.merge(options).merge({:f => form, :address => address, :method => method})
+    opts = {:required => required, :use_full_name => use_full_name, :field_order => [:full_name, :address1, :address2, :city, :country_code, :state_code, :postal_code]}.merge(options).merge({:f => form, :address => address, :method => method})
 
     if form.class.name == 'SimpleForm::FormBuilder'
       render :partial => 'effective/addresses/address_fields_simple_form', :locals => opts
@@ -25,6 +23,19 @@ module EffectiveAddressesHelper
     end
   end
 
+  def effective_address_pre_select(address)
+    if EffectiveAddresses.pre_selected_country.present?
+      address.country = EffectiveAddresses.pre_selected_country
+      address.state = EffectiveAddresses.pre_selected_state if (result[0].present? && EffectiveAddresses.pre_selected_state.present?)
+    elsif @@use_geocoder && request.location.present?
+      data = request.location.data
+      address.country = data['country_code']
+      address.state = data['region_code']
+      address.postal_code = data['postal_code']
+      address.city = data['city']
+    end
+  end
+
   def region_options_for_simple_form_select(regions = nil)
     if regions.present?
       countries = regions

data/app/models/effective/address.rb

@@ -9,23 +9,7 @@ module Effective
 
     belongs_to :addressable, :polymorphic => true, :touch => true
 
-    structure do
-      category        :string, :validates => [:presence]
-
-      full_name       :string
-
-      address1        :string, :validates => [:presence]
-      address2        :string
-
-      city            :string, :validates => [:presence]
-
-      state_code      :string
-      country_code    :string, :validates => [:presence]
-
-      postal_code     :string, :validates => [:presence]
-
-      timestamps
-    end
+    validates_presence_of :category, :address1, :city, :country_code, :postal_code
 
     validates_presence_of :state_code, :if => Proc.new { |address| address.country_code.blank? || Carmen::Country.coded(address.country_code).try(:subregions).present? }
 

data/app/views/effective/addresses/_address_fields_formtastic.html.haml

@@ -5,28 +5,41 @@
   - if ((f.object.errors.include?(method) && !f.object.errors.include?(:addresses)) rescue false)
     - fa.object.errors.add(:address1, f.object.errors[method].first)
 
-  - if use_full_name || fa.object.errors.include?(:full_name)
-    = fa.input :full_name, :required => true, :label => 'Full name', :placeholder => 'Full name'
-
-  = fa.input :address1, :placeholder => 'Address', :label => "Address 1"
-  = fa.input :address2, :label => 'Address 2'
-  = fa.input :city, :placeholder => 'City'
-  = fa.input :country_code,
-    :as => :select,
-    :label => 'Country',
-    :prompt => 'Country...',
-    :collection => region_options_for_select(EffectiveAddresses.country_codes == :all ? Carmen::Country.all : Carmen::Country.all.select{ |c| EffectiveAddresses.country_codes.include?(c.code) rescue true}, fa.object.country_code, :priority => EffectiveAddresses.country_codes_priority),
-    :input_html => { 'data-effective-address-country' => uuid }
-
-  - if fa.object.country_code.present?
-    = fa.input :state_code, :as => :select, :label => 'Province / State',
-      :collection => region_options_for_select(Carmen::Country.coded(fa.object.country_code).subregions, fa.object.state_code),
-      :prompt => 'please select a country',
-      :input_html => { 'data-effective-address-state' => uuid }
-  - else
-    = fa.input :state_code, :as => :select, :label => 'Province / State',
-      :collection => [],
-      :prompt => 'please select a country',
-      :input_html => {:disabled => 'disabled', 'data-effective-address-state' => uuid}
-
-  = fa.input :postal_code, :label => 'Postal / Zip code', :placeholder => 'Postal / Zip code'
+  - field_order.each do |field|
+
+    - case field
+      - when :full_name
+        - if use_full_name || fa.object.errors.include?(:full_name)
+          = fa.input :full_name, :required => true, :label => 'Full name', :placeholder => 'Full name'
+
+      - when :address1
+        = fa.input :address1, :placeholder => 'Address', :label => "Address 1"
+
+      - when :address2
+        = fa.input :address2, :label => 'Address 2'
+
+      - when :city
+        = fa.input :city, :placeholder => 'City'
+
+      - when :country_code
+        = fa.input :country_code,
+          :as => :select,
+          :label => 'Country',
+          :prompt => 'Country...',
+          :collection => region_options_for_select(EffectiveAddresses.country_codes == :all ? Carmen::Country.all : Carmen::Country.all.select{ |c| EffectiveAddresses.country_codes.include?(c.code) rescue true}, fa.object.country_code, :priority => EffectiveAddresses.country_codes_priority),
+          :input_html => { 'data-effective-address-country' => uuid }
+
+      - when :state_code
+        - if fa.object.country_code.present?
+          = fa.input :state_code, :as => :select, :label => 'Province / State',
+            :collection => region_options_for_select(Carmen::Country.coded(fa.object.country_code).subregions, fa.object.state_code),
+            :prompt => 'please select a country',
+            :input_html => { 'data-effective-address-state' => uuid }
+        - else
+          = fa.input :state_code, :as => :select, :label => 'Province / State',
+            :collection => [],
+            :prompt => 'please select a country',
+            :input_html => {:disabled => 'disabled', 'data-effective-address-state' => uuid}
+
+      - when :postal_code
+        = fa.input :postal_code, :label => 'Postal / Zip code', :placeholder => 'Postal / Zip code'

data/app/views/effective/addresses/_address_fields_simple_form.html.haml

@@ -5,19 +5,30 @@
   - if ((f.object.errors.include?(method) && !f.object.errors.include?(:addresses)) rescue false)
     - fa.object.errors.add(:address1, f.object.errors[method].first)
 
-  - if use_full_name || fa.object.errors.include?(:full_name)
-    = fa.input :full_name, :required => required
+  - field_order.each do |field|
 
+    - case field
+      - when :full_name
+        - if use_full_name || fa.object.errors.include?(:full_name)
+          = fa.input :full_name, :required => required
 
-  = fa.input :address1, :required => required
-  = fa.input :address2
-  = fa.input :city, :required => required
+      - when :address1
+        = fa.input :address1, :required => required
 
-  = fa.input :country_code, :as => :select, :collection => region_options_for_simple_form_select(), :input_html => {'data-effective-address-country' => uuid}, :required => required
+      - when :address2
+        = fa.input :address2
 
-  - if fa.object.try(:country_code).present?
-    = fa.input :state_code, :as => :select, :collection => region_options_for_simple_form_select(Carmen::Country.coded(fa.object.country_code).subregions), :input_html => {'data-effective-address-state' => uuid}, :required => required
-  - else
-    = fa.input :state_code, :as => :select, :disabled => true, :collection => [], :input_html => { 'data-effective-address-state' => uuid }, :required => required
+      - when :city
+        = fa.input :city, :input_html => { 'data-effective-address-city' => uuid }, :required => required
 
-  = fa.input :postal_code, :required => required
+      - when :country_code
+        = fa.input :country_code, :as => :select, :collection => region_options_for_simple_form_select(), :input_html => {'data-effective-address-country' => uuid}, :required => required
+
+      - when :state_code
+        - if fa.object.try(:country_code).present?
+          = fa.input :state_code, :as => :select, :collection => region_options_for_simple_form_select(Carmen::Country.coded(fa.object.country_code).subregions), :input_html => {'data-effective-address-state' => uuid}, :required => required
+        - else
+          = fa.input :state_code, :as => :select, :disabled => true, :collection => [], :input_html => { 'data-effective-address-state' => uuid }, :required => required
+
+      - when :postal_code
+        = fa.input :postal_code, :input_html => { 'data-effective-address-postal-code' => uuid }, :required => required

data/lib/effective_addresses.rb

@@ -1,6 +1,5 @@
 require "effective_addresses/engine"
 require "effective_addresses/version"
-require 'migrant'     # Required for rspec to run properly
 
 module EffectiveAddresses
 

data/lib/effective_addresses/version.rb

@@ -1,3 +1,3 @@
 module EffectiveAddresses
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/generators/templates/effective_addresses.rb

@@ -13,13 +13,15 @@ EffectiveAddresses.setup do |config|
   # Select these countries ontop of the others
   config.country_codes_priority = ['US', 'CA'] # nil for no priority countries
 
-  # Preselect this country on any new address forms
-  # Valid values are: country code, country name, or nil
+  # Force this country to be preselected on any new address forms.
+  # Valid values are: country code, country name, or nil.
+  # Leave nil if using Geocoder for IP based discovery.
   config.pre_selected_country = nil
 
-  # Preselect this state on any new address forms
+  # Force this state to be preselected on any new address forms.
   # Must also define pre_selected_country for this to take affect
-  # Valid values are: state code, state name, or nil
+  # Valid values are: state code, state name, or nil.
+  # Leave nil if using Geocoder for IP based discovery.
   config.pre_selected_state = nil
 
   # Validate that the postal/zip code format is correct for these countries

data/spec/dummy/app/models/user.rb

@@ -1,24 +1,24 @@
 class User < ActiveRecord::Base
-  structure do
-    # Devise attributes
-    encrypted_password      :string
-    reset_password_token    :string
-    reset_password_sent_at  :datetime
-    remember_created_at     :datetime
-    confirmation_sent_at    :datetime
-    confirmed_at            :datetime
-    confirmation_token      :string
-    unconfirmed_email       :string
-    sign_in_count           :integer, :default => 0
-    current_sign_in_at      :datetime
-    last_sign_in_at         :datetime
-    current_sign_in_ip      :string
-    last_sign_in_ip         :string
-
-    email                   :string
-    first_name              :string
-    last_name               :string
-
-    timestamps
-  end
+  # structure do
+  #   # Devise attributes
+  #   encrypted_password      :string
+  #   reset_password_token    :string
+  #   reset_password_sent_at  :datetime
+  #   remember_created_at     :datetime
+  #   confirmation_sent_at    :datetime
+  #   confirmed_at            :datetime
+  #   confirmation_token      :string
+  #   unconfirmed_email       :string
+  #   sign_in_count           :integer, :default => 0
+  #   current_sign_in_at      :datetime
+  #   last_sign_in_at         :datetime
+  #   current_sign_in_ip      :string
+  #   last_sign_in_ip         :string
+  #
+  #   email                   :string
+  #   first_name              :string
+  #   last_name               :string
+  #
+  #   timestamps
+  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_addresses
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: migrant
-  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement