effective_addresses 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Code and Effect Inc.
+
+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,151 @@
+# Effective Addresses
+
+Provides helper methods for dealing with a has_many :addresses relationship as a single method.
+Such as @user.billing_address and @user.billing_address=
+
+Includes full validations for addresses with multiple categories.
+
+Includes a formtastic helper method to create/update the address of a parent object.
+Uses the Carmen gem so when a Country is selected, an AJAX request populates the State/Province fields as appropriate.
+
+Rails >= 3.2.x, Ruby >= 1.9.x.  Has not been tested/developed for Rails4.
+
+## Getting Started
+
+Add to your Gemfile:
+
+```ruby
+gem 'effective_addresses'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_addresses:install
+```
+
+The generator will install an initializer which describes all configuration options and creates a database migration.
+
+If you want to tweak the table name (to use something other than the default 'addresses'), manually adjust both the configuration file and the migration now.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+If you'd like to use the form helper method, require the javascript in your application.js
+
+```ruby
+//= require effective_addresses
+```
+
+
+## Usage
+
+### Model
+
+To use without any validations, just add the mixin to your existing model:
+
+```ruby
+class User
+  acts_as_addressable
+end
+```
+
+This adds the following getters, along with the setters:
+
+```ruby
+@user.address
+@user.billing_address
+@user.shipping_address
+@user.primary_address
+@user.secondary_address
+```
+
+You can also define validations as follows:
+
+```ruby
+class User
+  acts_as_addressable :require_billing => true, :require_shipping => true
+end
+```
+
+This means when a User is created, it will not be valid unless a billing_address and shipping_address exist and are valid.
+
+### Multiple Addresses
+
+Everytime an address is changed, an additional address record is created.  The latest address will always be returned by:
+
+```ruby
+@user.billing_address
+```
+
+You can find all past addresses (including the current one) by:
+
+```ruby
+@user.billing_addresses
+```
+
+### Form Helper
+
+Use the helper in a formtastic form to quickly create the address fields 'f.inputs'.  This example is in HAML:
+
+```ruby
+= semantic_form_for @user do |f|
+  = f.inputs :name => "Your Information" do
+    = f.input :email
+    = f.input :name
+
+  = effective_address_fields(f, :category => 'billing') # 'shipping', 'primary', 'secondary'
+
+  = f.action :submit
+```
+
+Currently only supports Formtastic.
+
+Assuming the javascript has been properly required (as above), when you select a country from the dropdown
+an AJAX GET request will be made to '/effective/address/subregions/:country_code' and populate the state dropdown with the appropriate states or provinces
+
+
+## License
+
+MIT License.  Copyright Code and Effect Inc. http://www.codeandeffect.com
+
+You are not granted rights or licenses to the trademarks of Code and Effect
+
+## Notes
+
+This is a work in progress gem.  It needs smarter validations, dynamic methods and google maps integration
+
+### Testing
+
+The test suite for this gem is unfortunately not yet complete.
+
+Run tests by:
+
+```ruby
+rake spec
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# Our tasks
+load 'lib/tasks/effective_addresses_tasks.rake'
+
+# Testing tasks
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/effective_addresses.js

@@ -0,0 +1 @@
+//= require_tree ./effective_addresses

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

@@ -0,0 +1,13 @@
+$(document).on 'change', "select[data-behavior='address-country']", (event) ->
+  country_code = $(this).val()
+
+  url = "/effective/address/subregions/#{country_code}"
+  state_select = $(this).parent().parent().find("li > select[data-behavior='address-state']").first()
+
+  if country_code.length == 0
+    state_select.attr('disabled', 'disabled')
+    state_select.html('<option value="">please select a country</option>')
+  else
+    state_select.removeAttr('disabled')
+    state_select.find('option').first().text('loading...')
+    state_select.load(url)

data/app/controllers/effective/addresses_controller.rb

@@ -0,0 +1,16 @@
+module Effective
+  class AddressesController < ApplicationController
+    skip_authorization_check if defined?(CanCan)
+    respond_to :json
+
+    def subregions
+      country_code = params[:country_code]
+
+      if country_code.present?
+        render :partial => 'effective/addresses/subregions', :locals => {:country_code => country_code}
+      else
+        render :text => '', :status => :unprocessable_entity
+      end
+    end
+  end
+end

data/app/helpers/effective_addresses_helper.rb

@@ -0,0 +1,27 @@
+require 'carmen-rails'
+
+module EffectiveAddressesHelper
+  def effective_address_fields(form, options = {})
+    opts = {:f => form, :category => 'address', :skip_full_name => false}.merge(options)
+
+    case opts[:category]
+    when 'shipping'
+      opts[:name] = 'Shipping Address'
+      opts[:method] = :shipping_address
+    when 'billing'
+      opts[:name] = 'Billing Address'
+      opts[:method] = :billing_address
+    when 'primary'
+      opts[:name] = 'Primary Address'
+      opts[:method] = :primary_address
+    when 'secondary'
+      opts[:name] = 'Secondary Address'
+      opts[:method] = :secondary_address
+    else
+      opts[:name] = 'Address'
+      opts[:method] = :address
+    end
+
+    render :partial => 'effective/addresses/address_fields', :locals => opts
+  end
+end

data/app/models/concerns/acts_as_addressable.rb

@@ -0,0 +1,107 @@
+# ActsAsAddressable
+#
+# This module creates .billing_address, .shipping_address and .address methods
+# it tricks a has_many relationship into singleton methods
+#
+# Mark your model with 'acts_as_addressable'
+#
+# there are no additional migrations needed for this module to work.
+#
+# By default, addresses are NOT required
+#
+# If you want to validate presence, please mark your model
+# acts_as_addressable :require_billing => true, :require_address => true, :require_shipping => true
+#
+# Please see app/views/admin/users/_form.html.haml for an example of how to use this in a formtastic form
+#
+
+module ActsAsAddressable
+  extend ActiveSupport::Concern
+
+  module ActiveRecord
+    def acts_as_addressable(options = {})
+      @acts_as_addressable_opts = {:require_shipping => false, :require_billing => false, :require_primary => false, :require_secondary => false, :require_address => false}.merge(options)
+      include ::ActsAsAddressable
+    end
+  end
+
+  included do
+    has_many :addresses, :as => :addressable, :class_name => "Effective::Address", :dependent => :delete_all
+
+    validates_with BillingAddressValidator if @acts_as_addressable_opts[:require_billing]
+  end
+
+  module ClassMethods
+  end
+
+  def single_addresses
+    addresses.select { |address| address.category == 'address' }
+  end
+
+  def address
+    single_addresses.last
+  end
+
+  def address=(address_atts)
+    add = (address_atts.kind_of?(Effective::Address) ? address_atts.dup : Effective::Address.new(address_atts))
+    add.category = 'address'
+    addresses << add if !add.empty? and !(add == address)
+  end
+
+  def shipping_addresses
+    addresses.select { |address| address.category == 'shipping' }
+  end
+
+  def shipping_address
+    shipping_addresses.last
+  end
+
+  def shipping_address=(address_atts)
+    add = (address_atts.kind_of?(Effective::Address) ? address_atts.dup : Effective::Address.new(address_atts))
+    add.category = 'shipping'
+    addresses << add if !add.empty? and !(add == shipping_address)
+  end
+
+  def billing_addresses
+    addresses.select { |address| address.category == 'billing' }
+  end
+
+  def billing_address
+    billing_addresses.last
+  end
+
+  def billing_address=(address_atts)
+    add = (address_atts.kind_of?(Effective::Address) ? address_atts.dup : Effective::Address.new(address_atts))
+    add.category = 'billing'
+    addresses << add if !add.empty? and !(add == billing_address)
+  end
+
+  def primary_addresses
+    addresses.select { |address| address.category == 'primary' }
+  end
+
+  def primary_address
+    primary_addresses.last
+  end
+
+  def primary_address=(address_atts)
+    add = (address_atts.kind_of?(Effective::Address) ? address_atts.dup : Effective::Address.new(address_atts))
+    add.category = 'primary'
+    addresses << add if !add.empty? and !(add == primary_address)
+  end
+
+  def secondary_addresses
+    addresses.select { |address| address.category == 'secondary' }
+  end
+
+  def secondary_address
+    secondary_addresses.last
+  end
+
+  def secondary_address=(address_atts)
+    add = (address_atts.kind_of?(Effective::Address) ? address_atts.dup : Effective::Address.new(address_atts))
+    add.category = 'secondary'
+    addresses << add if !add.empty? and !(add == secondary_address)
+  end
+end
+

data/app/models/effective/address.rb

@@ -0,0 +1,93 @@
+require 'carmen'
+
+module Effective
+  class Address < ActiveRecord::Base
+    self.table_name = EffectiveAddresses.addresses_table_name.to_s
+
+    belongs_to :addressable, :polymorphic => true, :touch => true
+
+    structure do
+      category        :string, :validates => [:presence, :inclusion => { :in => %w(billing shipping primary secondary address)}]
+
+      full_name       :string, :validates => [:presence]
+      address1        :string, :validates => [:presence]
+      address2        :string
+      city            :string, :validates => [:presence]
+      state_code      :string, :validates => [:presence]
+      country_code    :string, :validates => [:presence]
+      postal_code     :string, :validates => [:presence]
+      timestamps
+    end
+
+    default_scope order(:updated_at)
+
+    scope :billing_addresses, -> { where(:category => 'billing') }
+    scope :shipping_addresses, -> { where(:category => 'shipping') }
+
+    def first_name
+      full_name.split(' ').first rescue full_name
+    end
+
+    def last_name
+      full_name.gsub(first_name, '').strip rescue full_name
+    end
+
+    def country
+      Carmen::Country.coded(country_code).name rescue ''
+    end
+
+    def state
+      Carmen::Country.coded(country_code).subregions.coded(state_code).name rescue ''
+    end
+
+    def province
+      Carmen::Country.coded(country_code).subregions.coded(state_code).name rescue ''
+    end
+
+    def country=(country_string)
+      value = Carmen::Country.named(country_string) || Carmen::Country.coded(country_string.try(:upcase))
+      self.country_code = value.code if value.present?
+    end
+
+    def state=(state_string)
+      if country.present?
+        value = Carmen::Country.coded(country_code).subregions.named(state_string) || Carmen::Country.coded(country_code).subregions.coded(state_string.try(:upcase))
+        self.state_code = value.code if value.present?
+      else
+        Rails.logger.info 'No country set.  Try calling country= before state='
+        puts 'No country set.  Try calling country= before state='
+      end
+    end
+
+    def postal_code_looks_canadian?
+      postal_code.gsub(/ /, '').strip.match(/^\D{1}\d{1}\D{1}\-?\d{1}\D{1}\d{1}$/).present? rescue false # Matches T5T2T1 or T5T-2T1
+    end
+
+    def ==(other_address)
+      self_attrs = self.attributes
+      other_attrs = other_address.respond_to?(:attributes) ? other_address.attributes : {}
+
+      [self_attrs, other_attrs].each { |attrs| attrs.except!('id', 'created_at', 'updated_at', 'addressable_type', 'addressable_id', 'address2') }
+
+      self_attrs == other_attrs
+    end
+
+    # An address may be set with a category but nothing else
+    # This is considered empty
+    def empty?
+      !full_name.present? and !address1.present? and !address2.present? and !city.present? and !state_code.present? and !country_code.present? and !postal_code.present?
+    end
+
+    def to_s
+      output = "#{full_name}\n"
+      output += "#{address1}\n"
+      output += "#{address2}\n" if address2.present?
+      output += "#{city}, #{state}\n"
+      output += "#{country}, #{postal_code}"
+    end
+
+    def to_html
+      to_s.gsub(/\n/, '<br>').html_safe
+    end
+  end
+end