direct_address 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+*.yml
+*.log
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Nelson
+
+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.rdoc

@@ -0,0 +1,87 @@
+= direct_address
+
+Direct Address provides a rails app with simple address features. This is a streamlined implementation of address functionality. Direct Address provides you with address, country, and region classes. It also provides a generator which generates the necessary javascript and rake tasks to implement properly. You'll also get form helpers to easily implement Direct Address in your views. A rake task is provided that allows up to date country and region information to be downloaded from geoname.org.
+
+== Installation
+
+Add direct_address to your environment.rb
+
+ config.gem 'direct_address'
+ 
+Then install the gem:
+ 
+ rake gems:install
+ 
+After you've installed the gem, you'll need to generate your classes, javascript, and rake task.
+
+ script/generate direct_address
+ 
+Once that's complete, migrate your database
+
+ rake db:migrate
+ 
+Now you're ready to download up-to-date country and region information from geoname.org
+
+ rake direct_address:pull
+ 
+<b>This will take a few minutes and should be done on a decent connection.</b>
+
+== Usage
+
+Once you've run the generators there's not much you need to do. You can utilize the classes as they are or you can use the acts_as_addressable option. To use acts_as_addressable, include it in your class like this:
+
+ class User < ActiveRecord::Base
+  acts_as_addressable
+ end
+ 
+By doing this you are giving the user a single address. One thing to note is that the generator didn't create an addresses_controller or add any routes regarding addresses. By default, it is expected that the address form will be nested in the parent form. For this reason, the accepts_nested_attributes_for and attr_accessors are included in acts_as_addressable. If you'd like to implement things differently, create a controller and implement your models to your liking.
+
+== Form Helpers
+
+By including Direct Address in your project you've added a few form helpers. Their implementation is very easy. You can either use it within a form_for like this:
+
+ <% form_for @user do |user_form| %>
+  ...
+  <% user_form.fields_for :address do |address_form| %>
+   ...
+   <%= address_form.country_select %>
+   ...
+  <% end %>
+  ...
+ <% end %>
+
+Or you can use it via a tag helper like this:
+
+ <%= country_select_tag 'user[account]' %>
+ 
+Either way produces the same exact thing. Take note that this does require loading at least prototype *beforehand* and the country_select file before the page load is complete. If you do like to defer the loading of extra scripts, feel free to do so with country_select. The setup doesn't occur until the window.onload event is fired. An example load order would be:
+
+ <script type="text/javascript" src="javascripts/prototype.js"></script>
+ 
+ POINT A
+ 
+ ...
+ <% form... %>
+  <%= f.country_select %>
+ <% end %>
+ ...
+ 
+ POINT B
+
+Where the following call could be at either POINT A or POINT B:
+
+ <script type="text/javascript" src="javascripts/country_select.js"></script>
+ 
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mike Nelson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "direct_address"
+    gem.summary = "short summary"
+    gem.description = "long summary"
+    gem.email = "mn@mcaddie.com"
+    gem.homepage = "http://github.com/mnelson/direct_address"
+    gem.authors = ["Mike Nelson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "direct_address #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/direct_address.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{direct_address}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Nelson"]
+  s.date = %q{2010-02-17}
+  s.description = %q{long summary}
+  s.email = %q{mn@mcaddie.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "direct_address-0.0.2.gem",
+     "direct_address.gemspec",
+     "generators/direct_address/direct_address_generator.rb",
+     "generators/direct_address/templates/controllers/regions_controller.rb",
+     "generators/direct_address/templates/js/country_select.js",
+     "generators/direct_address/templates/migrations/direct_address_migration.rb",
+     "generators/direct_address/templates/models/address.rb",
+     "generators/direct_address/templates/models/country.rb",
+     "generators/direct_address/templates/models/region.rb",
+     "generators/direct_address/templates/tasks/harvest.rake",
+     "generators/direct_address/templates/views/index.json.erb",
+     "lib/direct_address.rb",
+     "lib/direct_address/acts_as_addressable.rb",
+     "lib/direct_address/form_builder.rb",
+     "lib/direct_address/form_helper.rb",
+     "lib/direct_address/harvester/extend_string.rb",
+     "lib/direct_address/harvester/geoname.rb",
+     "spec/database.yml",
+     "spec/debug.log",
+     "spec/direct_address_spec.rb",
+     "spec/model/user.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mnelson/direct_address}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{short summary}
+  s.test_files = [
+    "spec/direct_address_spec.rb",
+     "spec/model/user.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/generators/direct_address/direct_address_generator.rb

@@ -0,0 +1,24 @@
+class DirectAddressGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+			
+			m.file "js/country_select.js", "public/javascripts/country_select.js"
+			
+			m.directory "app/views/regions"
+			m.file "views/index.json.erb", "app/views/regions/index.json.erb"
+			
+			m.file "controllers/regions_controller.rb", "app/controllers/regions_controller.rb"
+			
+			%w(address country region).each do |model|
+				m.file "models/#{model}.rb", "app/models/#{model}.rb"
+			end
+			
+			m.route_resources :regions
+			
+			m.migration_template "migrations/direct_address_migration.rb", "db/migrate", {:migration_file_name => "direct_address_migration"}
+			
+			m.file "tasks/harvest.rake", "lib/tasks/direct_address_harvest.rake"
+			
+		end
+	end
+end

data/generators/direct_address/templates/controllers/regions_controller.rb

@@ -0,0 +1,10 @@
+class RegionsController < ApplicationController
+  
+	def index
+    @regions = params[:country_id] && Region.by_country(params[:country_id])
+    respond_to do |format|
+			format.json
+    end
+  end
+
+end

data/generators/direct_address/templates/js/country_select.js

@@ -0,0 +1,33 @@
+if(typeof(Prototype) != 'undefined'){
+  
+  CountrySelect = Class.create({
+  	initialize : function(args){
+  		this.country_select = $(args['country_select_id']);
+  		this.region_select = $(args['region_select_id']);
+  		this.country_select.observe('change', this.update_regions.bind(this));
+  	},
+  	update_regions : function(event){
+  		this.region_select.selectedIndex = -1;
+  		var country_id = this.selected_country()[0];
+  		new Ajax.Request('/regions.json?country_id=' + country_id, {method : 'get', onComplete : function(transport){
+  			var regions = transport.responseJSON;
+  			this.populate_regions(regions);
+  		}.bind(this)});
+  	},
+  	selected_country : function(){
+  		var elem = this.country_select.childElements()[this.country_select.selectedIndex];
+  		return [elem.value, elem.innerHTML]
+  	},
+  	populate_regions : function(regions){
+  		var html = ['<option value="">Select a Region</option>', regions.collect(function(region){ 
+  			return '<option value="' + region.id + '">' + region.name + '</option>';
+  		})].flatten().join('');
+  		this.region_select.update(html);
+  		if(regions.length == 0)
+  			this.region_select.hide();
+  		else
+  			this.region_select.show();
+  	}
+  });
+
+} else { try{ console.log('Prototype must be preloaded for country_select.js to work properly.'); } catch (e) {}}

data/generators/direct_address/templates/migrations/direct_address_migration.rb

@@ -0,0 +1,39 @@
+class DirectAddressMigration < ActiveRecord::Migration
+  def self.up
+    create_table :regions do |t|
+			t.references :country
+			t.string :name
+			t.timestamps
+		end
+		
+		add_index :regions, :country_id
+		
+		create_table :addresses do |t|
+		  t.references :addressable, :polymorphic => true, :null => false
+      t.references :country
+      t.references :region
+      t.string :street1
+      t.string :street2
+      t.string :city
+      t.string :postal
+      t.timestamps
+    end
+
+    add_index :addresses, [:addressable_id, :addressable_type]
+    add_index :addresses, [:country_id]
+    add_index :addresses, [:region_id]
+
+		create_table :countries do |t|
+		  t.string :abbreviation
+		  t.string :name
+		  t.timestamps
+		end
+		
+  end
+
+  def self.down
+    drop_table :regions
+		drop_table :countries
+		drop_table :addresses
+  end
+end

data/generators/direct_address/templates/models/address.rb

@@ -0,0 +1,24 @@
+class Address < ActiveRecord::Base
+	
+	belongs_to :addressable, :polymorphic => true
+	belongs_to :country
+	belongs_to :region
+	
+	
+	def single_line
+		multiline.join(', ')
+	end
+	
+	def multiline
+		[street1, street2, [city, region_name, postal].compact.join(' '), country_abbrev].compact.collect{|s| s.length > 0 && s}
+	end
+	
+	def region_name
+		self.region && self.region.name || nil
+	end
+	
+	def country_abbrev
+		self.country && self.country.abbrev || nil
+	end
+	
+end

data/generators/direct_address/templates/models/country.rb

@@ -0,0 +1,18 @@
+class Country < ActiveRecord::Base
+	
+	has_many :regions
+	
+	validates_presence_of :abbreviation, :name
+	validates_length_of :abbreviation, :is => 2
+	alias_attribute :abbrev, :abbreviation
+
+	default_scope :order => 'name ASC'
+	
+	before_create :format_abbreviation
+	
+private
+
+	def format_abbreviation
+		self.abbreviation = self.abbreviation.upcase
+	end
+end

data/generators/direct_address/templates/models/region.rb

@@ -0,0 +1,9 @@
+class Region < ActiveRecord::Base
+	
+	belongs_to :country
+	validates_presence_of :name, :country
+	
+	default_scope :order => 'name ASC'
+	
+	named_scope :by_country, lambda {|country| country && (country.is_a?(Country) && (country = country.id) || true) && {:conditions => ['country_id = ?', country]} || {}}
+end

data/generators/direct_address/templates/tasks/harvest.rake

@@ -0,0 +1,13 @@
+
+begin 
+	require File.dirname(__FILE__) + '/../../config/environment.rb'
+
+	namespace :direct_address do
+		desc "pulls up to date country and region data from geonames.org"
+  	task :pull do
+			Geoname.retrieve_to_db
+		end
+	end
+rescue
+	puts "Direct address harvester not properly installed"
+end

data/generators/direct_address/templates/views/index.json.erb

@@ -0,0 +1 @@
+<%= @regions.collect{|region| {:id => region.id, :name => region.name}}.to_json %>

data/lib/direct_address/acts_as_addressable.rb

@@ -0,0 +1,20 @@
+module Direct
+	module Address
+		
+		def self.included(base)
+			base.extend ::Direct::Address::ClassMethods
+		end
+		
+		module ClassMethods
+			
+			def acts_as_addressable
+				has_one :address, :as => :addressable
+				accepts_nested_attributes_for :address
+				attr_accessible :address_attributes
+			end
+		end
+		
+	end
+end
+
+::ActiveRecord::Base.send(:include, ::Direct::Address)

data/lib/direct_address/form_builder.rb

@@ -0,0 +1,25 @@
+module ActionView
+	module Helpers
+		module CountryAndRegion
+			
+			def self.included(base)
+				base.class_eval do
+					include ActionView::Helpers::CountryAndRegion::InstanceMethods
+				end
+			end
+		
+			module InstanceMethods
+				def country_select
+					@countries ||= Country.all
+					sanitized_object_id = self.object_name.split('[').collect{|s| (s = s.gsub(']','')) && s.size > 0 && s || nil}.compact.join('_')
+					html = self.select(:country_id, ([['Select a Country', nil]] + @countries.collect{|country| [country.name, country.id]}))
+					html << self.select(:region_id, ([['Select a Region', nil]] + (self.object && self.object.country && self.object.country.regions.collect{|region| [region.name, region.id]} || [])))
+					html << "<script type=\"text/javascript\">if(typeof(Prototype) != 'undefined'){Element.observe(window, 'load', function(){if(typeof(CountrySelect) == 'undefined'){try{console.log('country_select.js not loaded.');} catch (e) {};return;};new CountrySelect({country_select_id : '#{sanitized_object_id}_country_id', region_select_id : '#{sanitized_object_id}_region_id'})});}else{document.getElementById('#{sanitized_object_id}_country_id').style.display = 'none';document.getElementById('#{sanitized_object_id}_region_id').style.display = 'none';}</script>"
+					html
+				end
+			end
+		end
+	end
+end
+
+::ActionView::Helpers::FormBuilder.send :include, ActionView::Helpers::CountryAndRegion

data/lib/direct_address/form_helper.rb

@@ -0,0 +1,30 @@
+
+module ActionView
+	module Helpers
+		module CountryAndRegionHelper
+			
+			def self.included(base)
+				base.class_eval do
+					include ActionView::Helpers::CountryAndRegionHelper::InstanceMethods
+				end
+			end
+			
+			module InstanceMethods
+				def country_select_tag(object_string, country_id = nil, region_id = nil)
+					object_string = object_string.to_s
+					object_id = object_string.split('[').collect{|s| (s = s.gsub(']','')) && s.size > 0 && s || nil}.compact.join('_')
+					@countries ||= Country.all
+					@regions = !country_id.nil? && Region.by_country(country_id) || [] 
+					country_options = options_for_select([['Select a Country', nil]] + @countries.collect{|country| [country.name, country.id]}, country_id)
+					region_options = options_for_select([['Select a Region', nil]] + @regions.collect{|region| [region.name, region.id]}, region_id)
+					html = select_tag("#{object_string}[country_id]", country_options, :id => "#{object_id}_country_id")
+					html << select_tag("#{object_string}[region_id]", region_options, :id => "#{object_id}_region_id")
+					html << "<script type=\"text/javascript\">if(typeof(Prototype) != 'undefined'){Element.observe(window, 'load', function(){if(typeof(CountrySelect) == 'undefined'){try{console.log('country_select.js not loaded.');} catch (e) {};return;};new CountrySelect({country_select_id : '#{object_id}_country_id', region_select_id : '#{object_id}_region_id'});});}else{document.getElementById('#{object_id}_country_id').style.display = 'none';document.getElementById('#{object_id}_region_id').style.display = 'none';}</script>"
+					html
+				end
+			end
+			
+		end
+	end
+end
+::ActionView::Base.send :include, ActionView::Helpers::CountryAndRegionHelper

data/lib/direct_address/harvester/extend_string.rb

@@ -0,0 +1,85 @@
+# RemoveAccents version 1.0.3 (c) 2008-2009 Solutions Informatiques Techniconseils inc.
+# 
+# This module adds 2 methods to the string class. 
+# Up-to-date version and documentation available at:
+#
+# http://www.techniconseils.ca/en/scripts-remove-accents-ruby.php
+#
+# This script is available under the following license :
+# Creative Commons Attribution-Share Alike 2.5.
+#
+# See full license and details at :
+# http://creativecommons.org/licenses/by-sa/2.5/ca/
+#
+# Version history:
+#   * 1.0.3 : July 23 2009
+#               Corrected some incorrect character codes. Source is now wikipedia at:
+#                 http://en.wikipedia.org/wiki/ISO/IEC_8859-1#Related_character_maps
+#               Thanks to Raimon Fernandez for pointing out the incorrect codes.
+#   * 1.0.2 : October 29 2008
+#               Slightly optimized version of urlize - Jonathan Grenier (jgrenier@techniconseils.ca)
+#   * 1.0.1 : October 29 2008
+#               First public revision - Jonathan Grenier (jgrenier@techniconseils.ca)
+#
+
+class String
+  # The extended characters map used by removeaccents. The accented characters 
+  # are coded here using their numerical equivalent to sidestep encoding issues.
+  # These correspond to ISO-8859-1 encoding.
+  ACCENTS_MAPPING = {
+    'E' => [200,201,202,203],
+    'e' => [232,233,234,235],
+    'A' => [192,193,194,195,196,197],
+    'a' => [224,225,226,227,228,229,230],
+    'C' => [199],
+    'c' => [231],
+    'O' => [210,211,212,213,214,216],
+    'o' => [242,243,244,245,246,248],
+    'I' => [204,205,206,207],
+    'i' => [236,237,238,239],
+    'U' => [217,218,219,220],
+    'u' => [249,250,251,252],
+    'N' => [209],
+    'n' => [241],
+    'Y' => [221],
+    'y' => [253,255],
+    'AE' => [306],
+    'ae' => [346],
+    'OE' => [188],
+    'oe' => [189]
+  }
+  
+  
+  # Remove the accents from the string. Uses String::ACCENTS_MAPPING as the source map.
+  def removeaccents    
+    str = String.new(self)
+    String::ACCENTS_MAPPING.each {|letter,accents|
+      packed = accents.pack('U*')
+      rxp = Regexp.new("[#{packed}]", nil, 'U')
+      str.gsub!(rxp, letter)
+    }
+    
+    str
+  end
+  
+  
+  # Convert a string to a format suitable for a URL without ever using escaped characters.
+  # It calls strip, removeaccents, downcase (optional) then removes the spaces (optional)
+  # and finally removes any characters matching the default regexp (/[^-_A-Za-z0-9]/).
+  #
+  # Options
+  #
+  # * :downcase => call downcase on the string (defaults to true)
+  # * :convert_spaces => Convert space to underscore (defaults to false)
+  # * :regexp => The regexp matching characters that will be converting to an empty string (defaults to /[^-_A-Za-z0-9]/)
+  def urlize(options = {})
+    options[:downcase] ||= true
+    options[:convert_spaces] ||= false
+    options[:regexp] ||= /[^-_A-Za-z0-9]/
+    
+    str = self.strip.removeaccents
+    str.downcase! if options[:downcase]
+    str.gsub!(/\ /,'_') if options[:convert_spaces]
+    str.gsub(options[:regexp], '')
+  end
+end