effective_addresses 1.11.9 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c74b7f3991e34ac99e4401f365138341354d8a6264702205bd69a1d45b875f
-  data.tar.gz: 3f83e9909ccf051881bbeb1f7d2aaa357fead608eb554b2ddf3af3002cd5d963
+  metadata.gz: 8df8c437b4b141c75a36c2c0a985c0ca079d6c812135be17a8728899297e02f3
+  data.tar.gz: 8f048421f9546067c56acac40fd800b111ee3b185a80d14cfa0d2a9890705c11
 SHA512:
-  metadata.gz: 30cd86d88778f8aa624985ad7825340323790fe44a9d8897bbc8801c8d760c7d3e4acba07230c964b6716c2cc45ccb4782a236b136f0f323c723114241932337
-  data.tar.gz: f227681758c909193a8384d3aa44e08c2eef55ec92505437cca568250347ea99c5760d7d12ae8faa27ec302405543b6d87b9163053bac209f51b3c04b5960fae
+  metadata.gz: 666c4fa97777cc00b30429aa60edd72086dfbcceb5d1da7571cf0779209c4dba7b5ccf2ab5e53fe5afcf340541fed815ccc52bc2f3a260b5247c78234b0e42b0
+  data.tar.gz: 55afa8e4d582e70e1451bc572ecd54c43c95cfcba426e74fcb3e88f64006f9446f21f0ee45c091d17586f2c0a2f4a052dd9be46b6dedab5c8939ddf5defd7964

data/README.md

@@ -159,7 +159,7 @@ The actual permitted parameters are:
 
 ### Form Helpers
 
-Use the helper in a Formtastic or SimpleForm form to quickly create the address fields. Currently only supports Formtastic and SimpleForm.
+Use `effective_address_fields` with Effective FormBuilder, SimpleForm, or Formtastic to render address fields.
 
 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.
@@ -250,12 +250,10 @@ MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
 
 ## Testing
 
-The test suite for this gem is unfortunately not yet complete.
+Run the test suite from the gem root:
 
-Run tests by:
-
-```ruby
-rake spec
+```console
+bundle exec rake test
 ```
 
 ## Contributing

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

@@ -1,7 +1,7 @@
 loadSubregions = ($countrySelect, clearPostalCode = false) ->
   $.each $countrySelect, (index, countrySelector) ->
     $particularCountrySelect = $(countrySelector)
-    countryCode = $particularCountrySelect.val()
+    countryCode = $particularCountrySelect.val() || ''
     uuid = $particularCountrySelect.data('effective-address-country')
 
     $nestedFields = $particularCountrySelect.closest('.nested-fields')
@@ -16,34 +16,45 @@ loadSubregions = ($countrySelect, clearPostalCode = false) ->
     url = "/addresses/subregions/#{countryCode}"
     $stateSelect = $container.find("select[data-effective-address-state='#{uuid}']:first")
 
+    return unless $stateSelect.length
+    prompts = $stateSelect.data('effective-address-prompts') || {}
+    fallback = $stateSelect.data('input-js-options')?.placeholder || $stateSelect.find("option[value='']").text()
+
     if countryCode.length == 0
       $stateSelect.prop('disabled', true).addClass('disabled').parent('.form-group').addClass('disabled').find('label').addClass('disabled')
-      reinitialize($stateSelect, 'Please choose country first')
+      reinitialize($stateSelect, prompts.country_first || fallback)
     else
       $stateSelect.removeAttr('disabled').parent('.form-group').removeClass('disabled').find('.disabled').removeClass('disabled')
-      reinitialize($stateSelect, 'Loading...')
+      reinitialize($stateSelect, prompts.loading || fallback)
 
       $stateSelect.load url, ->
-        stateSelectAvailable = $(@).find('option:last').val().length > 0
+        stateSelectAvailable = ($(@).find('option:last').val() || '').length > 0
         if stateSelectAvailable
           $(@).prop('required', true)
           $(@).removeAttr('disabled')
-          reinitialize($stateSelect, 'Please choose', true)
+          reinitialize($stateSelect, prompts.choose || fallback, true)
         else
           $(@).removeAttr('required')
           $(@).prop('disabled', true)
-          reinitialize($stateSelect, 'None exist', true)
+          reinitialize($stateSelect, prompts.none || fallback, true)
 
 $(document).on 'change', 'select[data-effective-address-country]', -> loadSubregions($(@), true)
 
 reinitialize = ($stateSelect, placeholder, keepOptions = false) ->
   if $stateSelect.hasClass('effective_select') == false
-    $stateSelect.html("<option value=''>#{placeholder}</option>") unless keepOptions
+    $stateSelect.empty() unless keepOptions
+    $prompt = $stateSelect.find("option[value='']").first()
+    if $prompt.length
+      $prompt.text(placeholder)
+    else
+      $stateSelect.prepend($('<option>').val('').text(placeholder))
+    $stateSelect.val('')
     return
 
   $stateSelect.html('') unless keepOptions
+  $stateSelect.val('')
 
-  opts = $stateSelect.data('input-js-options')
+  opts = $stateSelect.data('input-js-options') || {}
   opts['placeholder'] = placeholder
   $stateSelect.data('input-js-options', opts)
 

data/app/controllers/effective/addresses_controller.rb

@@ -8,7 +8,7 @@ module Effective
       if @subregions.present?
         render partial: 'effective/addresses/subregions'
       else
-        render body: "<option value=''>None Available</option>"
+        render html: helpers.content_tag(:option, t('effective_addresses.placeholders.none'), value: '')
       end
     end
   end

data/app/helpers/effective_addresses_helper.rb

@@ -26,6 +26,18 @@ module EffectiveAddressesHelper
     end
   end
 
+  def effective_address_state_input_html(uuid)
+    {
+      'data-effective-address-state' => uuid,
+      'data-effective-address-prompts' => {
+        country_first: t('effective_addresses.placeholders.country_first'),
+        loading: t('effective_addresses.placeholders.loading'),
+        choose: t('effective_addresses.placeholders.choose'),
+        none: t('effective_addresses.placeholders.none')
+      }.to_json
+    }
+  end
+
   def effective_address_pre_select(address)
     if address.country.blank? && EffectiveAddresses.pre_selected_country.present?
       address.country = EffectiveAddresses.pre_selected_country

data/app/models/effective/address.rb

@@ -37,12 +37,12 @@ module Effective
     validates_format_of :postal_code, :with => POSTAL_CODE_CA,
       :if => proc { |address| Array(EffectiveAddresses.validate_postal_code_format).include?('CA') && address.country_code == 'CA' },
       :allow_blank => true,  # We're already checking for presence above
-      :message => 'is an invalid Canadian postal code'
+      :message => :invalid_canadian_postal_code
 
     validates_format_of :postal_code, :with => POSTAL_CODE_US,
       :if => proc { |address| Array(EffectiveAddresses.validate_postal_code_format).include?('US') && address.country_code == 'US' },
       :allow_blank => true,  # We're already checking for presence above
-      :message => 'is an invalid United States zip code'
+      :message => :invalid_us_zip_code
 
     scope :sorted, -> { order(:updated_at) }
     scope :billing, -> { where(:category => 'billing') }

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

@@ -11,7 +11,6 @@
 
   - if !skip_same_as_billing && fa.object.category == 'shipping' && f.object.respond_to?(:shipping_address_same_as_billing?)
     = fa.check_box :shipping_address_same_as_billing,
-      label: 'Shipping address is same as billing address',
       required: false,
       feedback: false,
       input_html: { checked: same_as_billing }
@@ -23,7 +22,7 @@
       wrapper: wrapper_options
 
   = fa.text_field :address1,
-    label: (local_assigns[:label] || method.to_s.titleize),
+    label: (local_assigns[:label] || f.object.class.human_attribute_name(method, default: method.to_s.titleize)),
     required: required,
     disabled: same_as_billing,
     wrapper: wrapper_options
@@ -50,10 +49,10 @@
   .row
     .col-md-4
       = fa.select :country_code, effective_address_regions_collection(resource: fa.object),
-        label: 'Country',
         required: required,
         disabled: same_as_billing,
         input_html: { 'data-effective-address-country' => uuid },
+        input_js: { placeholder: t('effective_addresses.prompts.select_country') },
         wrapper: wrapper_options
 
     .col-md-5
@@ -61,23 +60,21 @@
 
       - if subregions.present?
         = fa.select :state_code, effective_address_regions_collection(subregions),
-          label: 'State / Province',
           required: required,
           disabled: same_as_billing,
-          input_html: { 'data-effective-address-state' => uuid },
+          input_html: effective_address_state_input_html(uuid),
+          input_js: { placeholder: t('effective_addresses.placeholders.choose') },
           wrapper: wrapper_options
       - else
         = fa.select :state_code, [],
-          label: 'State / Province',
           required: required,
           disabled: true,
-          input_html: { 'data-effective-address-state' => uuid },
-          input_js: { placeholder: 'Please choose country first' },
+          input_html: effective_address_state_input_html(uuid),
+          input_js: { placeholder: t('effective_addresses.placeholders.country_first') },
           wrapper: wrapper_options
 
     .col-md-3
       = fa.text_field :postal_code,
-        label: 'Postal Code',
         required: required,
         disabled: same_as_billing,
         input_html: { 'data-effective-address-postal-code' => uuid },

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

@@ -10,10 +10,10 @@
     - case field
       - when :full_name
         - if local_assigns[:use_full_name] || EffectiveAddresses.use_full_name || fa.object.errors.include?(:full_name)
-          = fa.input :full_name, :required => true, :label => 'Full name', :placeholder => 'Full name'
+          = fa.input :full_name, :required => true, :placeholder => t('effective_addresses.placeholders.full_name')
 
       - when :address1
-        = fa.input :address1, :placeholder => 'Address', :label => "Address"
+        = fa.input :address1, :placeholder => t('effective_addresses.placeholders.address1'), :label => local_assigns[:label]
 
       - when :address2
         = fa.input :address2, :label => false
@@ -22,34 +22,31 @@
         = fa.input :address3, :label => false
 
       - when :city
-        = fa.input :city, :placeholder => 'City'
+        = fa.input :city, :placeholder => t('effective_addresses.placeholders.city')
 
       - when :country_code
         = fa.input :country_code,
           :as => (defined?(EffectiveFormInputs) ? :effective_select : :select),
-          :label => 'Country',
-          :prompt => 'Country...',
+          :prompt => t('effective_addresses.prompts.select_country'),
           :collection => options_for_select(effective_address_regions_collection()),
           :input_html => { 'data-effective-address-country' => uuid },
-          :input_js => { placeholder: 'Please choose' }
+          :input_js => { placeholder: t('effective_addresses.prompts.select_country') }
 
       - when :state_code
         - if fa.object.country_code.present?
           = fa.input :state_code,
             :as => (defined?(EffectiveFormInputs) ? :effective_select : :select),
-            :label => 'Province / State',
             :collection => options_for_select(effective_address_regions_collection(Carmen::Country.coded(fa.object.country_code).try(:subregions))),
-            :prompt => 'please select a country',
-            :input_html => { 'data-effective-address-state' => uuid },
-            :input_js => { :placeholder => 'Please choose' }
+            :prompt => t('effective_addresses.prompts.choose'),
+            :input_html => effective_address_state_input_html(uuid),
+            :input_js => { :placeholder => t('effective_addresses.placeholders.choose') }
         - else
           = fa.input :state_code,
             :as => (defined?(EffectiveFormInputs) ? :effective_select : :select),
-            :label => 'Province / State',
             :collection => [],
-            :prompt => 'please select a country',
-            :input_html => {:disabled => 'disabled', 'data-effective-address-state' => uuid},
-            :input_js => { :placeholder => 'Please choose country first' }
+            :prompt => t('effective_addresses.prompts.country_first'),
+            :input_html => effective_address_state_input_html(uuid).merge(disabled: 'disabled'),
+            :input_js => { :placeholder => t('effective_addresses.placeholders.country_first') }
 
       - when :postal_code
-        = fa.input :postal_code, :label => 'Postal / Zip code', :placeholder => 'Postal / Zip code'
+        = fa.input :postal_code, :placeholder => t('effective_addresses.placeholders.postal_code')

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

@@ -9,7 +9,6 @@
   - if fa.object.category == 'shipping' && f.object.respond_to?(:shipping_address_same_as_billing?)
     = fa.input :shipping_address_same_as_billing,
       as: :boolean,
-      label: 'Shipping address is same as billing address',
       required: false,
       input_html: { checked: shipping_address_same_as_billing }
 
@@ -19,13 +18,15 @@
       - when :full_name
         - if local_assigns[:use_full_name] || EffectiveAddresses.use_full_name || fa.object.errors.include?(:full_name)
           = fa.input :full_name,
+            placeholder: t('effective_addresses.placeholders.full_name'),
             required: required,
             disabled: shipping_address_same_as_billing,
             wrapper_html: { style: ('display: none;' if shipping_address_same_as_billing) }
 
       - when :address1
         = fa.input :address1,
-          label: 'Address',
+          label: local_assigns[:label],
+          placeholder: t('effective_addresses.placeholders.address1'),
           required: required,
           disabled: shipping_address_same_as_billing,
           wrapper_html: { style: ('display: none;' if shipping_address_same_as_billing) }
@@ -39,6 +40,7 @@
 
       - when :city
         = fa.input :city,
+          placeholder: t('effective_addresses.placeholders.city'),
           required: required,
           input_html: { 'data-effective-address-city' => uuid },
           disabled: shipping_address_same_as_billing,
@@ -49,6 +51,8 @@
           as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
           required: required,
           collection: effective_address_regions_collection(),
+          prompt: t('effective_addresses.prompts.select_country'),
+          input_js: { placeholder: t('effective_addresses.prompts.select_country') },
           input_html: {'data-effective-address-country' => uuid},
           disabled: shipping_address_same_as_billing,
           wrapper_html: { style: ('display: none;' if shipping_address_same_as_billing) }
@@ -59,9 +63,9 @@
             as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
             required: required,
             collection: effective_address_regions_collection(Carmen::Country.coded(fa.object.country_code).try(:subregions)),
-            prompt: 'Please choose',
-            input_html: {'data-effective-address-state' => uuid},
-            input_js: { placeholder: 'Please choose' },
+            prompt: t('effective_addresses.prompts.choose'),
+            input_html: effective_address_state_input_html(uuid),
+            input_js: { placeholder: t('effective_addresses.placeholders.choose') },
             disabled: shipping_address_same_as_billing,
             wrapper_html: { style: ('display: none;' if shipping_address_same_as_billing) }
         - else
@@ -69,14 +73,15 @@
             as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
             required: required,
             collection: [],
-            prompt: 'Please choose a country first',
-            input_html: { 'data-effective-address-state' => uuid },
-            input_js: { placeholder: 'Please choose country first' },
+            prompt: t('effective_addresses.prompts.country_first'),
+            input_html: effective_address_state_input_html(uuid),
+            input_js: { placeholder: t('effective_addresses.placeholders.country_first') },
             disabled: true,
             wrapper_html: { style: ('display: none;' if shipping_address_same_as_billing) }
 
       - when :postal_code
         = fa.input :postal_code,
+          placeholder: t('effective_addresses.placeholders.postal_code'),
           required: required,
           input_html: { 'data-effective-address-postal-code' => uuid },
           disabled: shipping_address_same_as_billing,

data/config/locales/effective_addresses.en.yml

@@ -0,0 +1,41 @@
+en:
+  activerecord:
+    models:
+      effective/address: Address
+    attributes:
+      effective/address:
+        full_name: Full name
+        address1: Address
+        address2: Address 2
+        address3: Address 3
+        city: City
+        country_code: Country
+        state_code: Province
+        postal_code: Postal Code
+        shipping_address_same_as_billing: Shipping address is the same as the billing address
+    errors:
+      models:
+        effective/address:
+          attributes:
+            postal_code:
+              invalid_canadian_postal_code: is an invalid Canadian postal code
+              invalid_us_zip_code: is an invalid United States zip code
+  attributes:
+    billing_address: Billing Address
+    shipping_address: Shipping Address
+    reference_address: Reference Address
+  effective_addresses:
+    placeholders:
+      full_name: Full name
+      address1: Address
+      city: City
+      postal_code: Postal Code
+      country_code: Country
+      choose: Select...
+      country_first: Select a country first...
+      loading: Loading...
+      none: None available
+    prompts:
+      choose: Select...
+      country_first: Select a country first...
+      select_country: Select a country...

data/config/locales/simple_form.en.yml

@@ -1,26 +1,13 @@
 en:
   simple_form:
-    labels:
-      defaults:
-        full_name: Full name
-        address1: Address 1
-        address2: Address 2
-        address3: Address 3
-        country_code: Country
-        state_code: Province / State
-        postal_code: Postal / Zip code
-
-#    hints:
-#      defaults:
-
     placeholders:
       defaults:
         full_name: Full name
         address1: Address
         city: City
-        postal_code: Postal / Zip code
+        postal_code: Postal Code
 
     prompts:
       defaults:
-        country_code: Choose country...
-        state_code: Please choose country first
+        country_code: Select a country...
+        state_code: Select a country first...

data/lib/effective_addresses/version.rb

@@ -1,3 +1,3 @@
 module EffectiveAddresses
-  VERSION = '1.11.9'.freeze
+  VERSION = '1.12.0'.freeze
 end

data/lib/validators/effective_address_full_name_presence_validator.rb

@@ -1,8 +1,8 @@
 class EffectiveAddressFullNamePresenceValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     if value.present? && !value.empty? && value.full_name.blank?
-      record.errors[attribute] << 'is invalid'
-      value.errors[:full_name] << "can't be blank"
+      record.errors.add(attribute, :invalid)
+      value.errors.add(:full_name, :blank)
     end
   end
 end

data/lib/validators/effective_address_valid_validator.rb

@@ -1,7 +1,7 @@
 class EffectiveAddressValidValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     if value.present? && !value.empty? && !value.valid?
-      record.errors[attribute] << 'is invalid'
+      record.errors.add(attribute, :invalid)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_addresses
 version: !ruby/object:Gem::Version
-  version: 1.11.9
+  version: 1.12.0
 platform: ruby
 authors:
 - Code and Effect
@@ -186,6 +186,7 @@ files:
 - app/views/effective/addresses/_simple_form.html.haml
 - app/views/effective/addresses/_subregions.html.haml
 - config/effective_addresses.rb
+- config/locales/effective_addresses.en.yml
 - config/locales/simple_form.en.yml
 - config/routes.rb
 - db/migrate/101_create_effective_addresses.rb