whereabouts 0.5.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem 'activesupport', '>= 2.3.5'
+gem 'activerecord', '>= 3.0.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 2.3.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.6.2'
+  gem 'rcov', '>= 0'
+  gem 'sqlite3'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Nicholas Fine
+
+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.markdown

@@ -0,0 +1,51 @@
+Whereabouts
+===========
+
+Whereabouts is a Rails plugin that generates a polymorphic address model
+to be associated to ActiveRecord models. 
+
+To install on Rails 3.x add this to your Gemfile  
+    gem 'whereabouts'
+
+Generate the base address class and migration
+    rails g address
+
+Run migrations  
+    rake db:migrate
+
+
+Examples
+=======
+
+    # Basic use:  
+    class Thing < ActiveRecord::Base
+      has_whereabouts
+    end
+
+    t = Thing.new
+    t.build_address
+
+    # Multiple addresses on same model:  
+    class Foo < ActiveRecord::Base
+      has_whereabouts :shipping_address
+      has_whereabouts :mailing_address
+    end
+     
+    f = Foo.new
+    f.build_shipping_address
+    f.build_mailing_address
+
+Contributing to whereabouts
+=========
+ 
+  * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+  * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+  * Fork the project
+  * Start a feature/bugfix branch
+  * Commit and push until you are happy with your contribution
+  * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright (c) 2011 [Nicholas Fine](http://ndfine.com), released under the MIT license  
+v0.2.0
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "whereabouts"
+  gem.homepage = "http://github.com/yrgoldteeth/whereabouts"
+  gem.license = "MIT"
+  gem.summary = %q{Whereabouts - has_whereabouts :address}
+  gem.description = %q{Rails plugin for adding associated addresses to Active Record Models}
+  gem.email = "nicholas.fine@gmail.com"
+  gem.authors = ["Nicholas Fine"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "whereabouts #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/lib/generators/address/USAGE

@@ -0,0 +1,6 @@
+Description:
+  Copies address.rb to app/models/.
+  Copies create_address.rb to db/migrate.
+
+Examples:
+  'rails generate address'

data/lib/generators/address/address_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/migration'
+
+class AddressGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  class << self
+    def source_root
+      @whereabouts_source_root ||= File.expand_path('../templates', __FILE__)
+    end
+
+    def next_migration_number path
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+  end
+
+  def create_model_file
+    template 'address.rb', 'app/models/address.rb'
+    migration_template 'create_addresses.rb', 'db/migrate/create_addresses.rb'
+  end
+end

data/lib/generators/address/templates/address.rb

@@ -0,0 +1,11 @@
+class Address < ActiveRecord::Base
+  belongs_to :addressable, :polymorphic => true
+  ZIP_REGEX   = /^\d{5}([\-]\d{4})?$/
+
+  validates_format_of :zip, :with => ZIP_REGEX, :message => 'is invalid'
+
+  def geocode_address
+    "#{line1}, #{city} #{state} #{zip}"
+  end
+end
+

data/lib/generators/address/templates/create_addresses.rb

@@ -0,0 +1,24 @@
+class CreateAddresses < ActiveRecord::Migration
+  def self.up
+    create_table :addresses do |t|
+      t.string :line1
+      t.string :line2
+      t.string :city
+      t.string :state
+      t.string :zip
+      t.string :type
+      t.float  :latitude
+      t.float  :longitude
+      t.references :addressable, :polymorphic => true
+      t.timestamps
+    end
+
+    add_index :addresses, :addressable_type
+    add_index :addresses, :addressable_id
+    add_index :addresses, :type
+  end
+
+  def self.down
+    drop_table :addresses
+  end
+end

data/lib/whereabouts.rb

@@ -0,0 +1,11 @@
+# Whereabouts
+require 'whereabouts_methods'
+module Whereabouts
+  module Rails
+    class Railtie < ::Rails::Railtie
+      unless File.exist?('app/models/address.rb')
+        puts 'NOTICE: Please run rails generate address for whereabouts gem'
+      end
+    end
+  end
+end

data/lib/whereabouts_methods.rb

@@ -0,0 +1,119 @@
+# **Whereabouts** is a Rails plugin that generates a polymorphic, inheritable
+# Address model.  Install it as a Rails plugin (Rails 3.x+ required)  
+#
+#     rails plugin install http://github.com/yrgoldteeth/whereabouts.git
+#
+# The most simple use case creates a has_one relationship with
+# a generic Address: 
+#
+#     class Foo < ActiveRecord::Base
+#       has_whereabouts
+#     end
+#     
+#     f = Foo.new
+#     f.build_address
+#
+# Also, a model can have any number of different inherited types of Addresses,
+# i.e. shipping address and mailing address  
+#
+#     class Foo < ActiveRecord::Base
+#       has_whereabouts :shipping
+#       has_whereabouts :mailing
+#     end
+#     
+#     f = Foo.new
+#     f.build_shipping
+#     f.build_mailing
+#
+# If you have the [Ruby Geocoder](http://www.rubygeocoder.com) specified in
+# your project's Gemfile, adding {:geocode => true} to the has_whereabouts
+# definition will automatically geocode and populate the latitude and
+# longitude fields for the record.
+#
+#     class Foo < ActiveRecord::Base
+#       has_whereabouts :shipping, {:geocode => true}
+#     end
+#
+# You can see the source on [github](https://github.com/yrgoldteeth/whereabouts), and
+# this page was generated with the wonderful
+# [rocco](http://rtomayko.github.com/rocco/) documentation generator.  
+
+# Hey, that's [me](http://ndfine.com)
+module Yrgoldteeth
+  # **Whereabouts**
+  module Has
+    module Whereabouts
+
+      # Extend the ClassMethods module
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # **ClassMethods**
+      module ClassMethods
+        # Accepts a symbol that will define the inherited 
+        # type of Address.  Defaults to the parent class.
+        def has_whereabouts klass=:address, options={}
+          # extend Address with class name if not defined.
+          unless Class.constants.include?(klass.to_s.camelize.to_sym)
+            create_address_class(klass.to_s.camelize)
+          end
+          
+          # Set the has_one relationship and accepts_nested_attributes_for.  
+          has_one klass, :as => :addressable, :dependent => :destroy
+          accepts_nested_attributes_for klass
+
+          # Define a singleton on the class that returns an array
+          # that includes the address fields to validate presence of 
+          # or an empty array
+          validate_singleton = "#{klass.to_s}_whereabouts_validate_fields".to_sym
+          if options[:validate] && options[:validate].is_a?(Array)
+            set_validators(klass, options[:validate])
+            define_singleton_method validate_singleton do options[:validate] end
+          else
+            define_singleton_method validate_singleton do [] end
+          end
+
+          # Check for geocode in options and confirm geocoder is defined.
+          # Also defines a singleton to return a boolean about geocoding.
+          geocode_singleton = "#{klass.to_s}_whereabouts_geocode?".to_sym
+          if options[:geocode] && options[:geocode] == true && defined?(Geocoder)
+            set_geocoding(klass)
+            define_singleton_method geocode_singleton do true end
+          else
+            define_singleton_method geocode_singleton do false end
+          end
+        end
+
+        # Sets validates_presence_of fields for the Address based on the 
+        # singleton method created on the Address addressable_type class.
+        def set_validators klass, fields=[]
+          _single = "#{klass.to_s}_whereabouts_validate_fields".to_sym
+          klass.to_s.camelize.constantize.class_eval do
+            fields.each do |f|
+              validates_presence_of f, :if => lambda {|a| a.addressable_type.constantize.send(_single).include?(f)}
+            end
+          end
+        end
+
+        # If defined, geocode the address.
+        def set_geocoding klass
+          _single = "#{klass.to_s}_whereabouts_geocode?".to_sym
+          klass.to_s.camelize.constantize.class_eval do
+            geocoded_by :geocode_address
+            after_validation :geocode, :if => lambda {|a| a.addressable_type.constantize.send(_single) && (a.new_record? || a.changed?)}
+          end
+        end
+
+        # Generate a new class using Address as the superclass.  
+        # Accepts a string defining the inherited type.
+        def create_address_class(class_name, &block)
+          klass = Class.new Address, &block
+          Object.const_set class_name, klass
+        end
+      end
+    end
+  end
+end
+# Include the modules into ActiveRecord::Base
+ActiveRecord::Base.send(:include, Yrgoldteeth::Has::Whereabouts)

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'whereabouts_methods'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# Build some dummy AR classes
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+def setup_test_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :addresses do |t|
+      t.string :line1
+      t.string :line2
+      t.string :city
+      t.string :state
+      t.string :zip
+      t.string :type
+      t.float  :latitude
+      t.float  :longitude
+      t.references :addressable, :polymorphic => true
+      t.timestamps
+    end
+    create_table :customers do |t|
+      t.timestamps
+    end
+    create_table :competitors do |t|
+      t.timestamps
+    end
+  end
+end
+
+def teardown_test_db
+  ActiveRecord::Base.connection.tables.each do |t|
+    ActiveRecord::Base.connection.drop_table(t)
+  end
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :addressable, :polymorphic => true
+end
+
+class Customer < ActiveRecord::Base
+  has_whereabouts :address
+  has_whereabouts :test_address, :validate => [:line1, :city, :state, :zip]
+end
+
+class Competitor < ActiveRecord::Base
+  has_whereabouts :test_address, :validate => [:city, :state, :zip]
+end
+
+RSpec.configure do |config|
+end

data/spec/whereabouts_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Whereabouts" do
+  before(:all){setup_test_db};after(:all){teardown_test_db}
+
+  describe 'AR model Customer has_whereabouts :address and has_whereabouts :test_address with validation fields' do
+
+    it 'sets a singleton method for address_whereabouts_validate_fields' do
+      Customer.singleton_methods.include?(:address_whereabouts_validate_fields).should be true
+    end
+
+    it 'sets a singleton method for test_address_whereabouts_validate_fields' do
+      Customer.singleton_methods.include?(:test_address_whereabouts_validate_fields).should be true
+    end
+
+    it 'sets a singleton method for address_whereabouts_geocode?' do
+      Customer.singleton_methods.include?(:address_whereabouts_geocode?).should be true
+    end
+
+    it 'sets a singleton method for test_address_whereabouts_geocode?' do
+      Customer.singleton_methods.include?(:test_address_whereabouts_geocode?).should be true
+    end
+
+    it 'returns [] on the singleton method if no list of attributes is sent for the :validate options' do
+      Customer.address_whereabouts_validate_fields.should == []
+    end
+
+    it 'returns true on the singleton method if a list of attributes is sent for the :validate options' do
+      Customer.test_address_whereabouts_validate_fields.should == [:line1, :city, :state, :zip]
+    end
+  end
+
+  describe 'multiple AR models have the same whereabouts name with different validations' do
+    before do
+      address = {:city => 'Birmingham', :state => 'AL', :zip => '35205'}
+      @competitor_test = Competitor.new.build_test_address(address)
+      @customer_test   = Customer.new.build_test_address(address)
+    end
+
+    it 'validates correctly' do
+      @competitor_test.valid?.should be true
+      @customer_test.valid?.should be false
+    end
+  end
+
+end

data/whereabouts.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{whereabouts}
+  s.version = "0.5.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nicholas Fine"]
+  s.date = %q{2011-06-16}
+  s.description = %q{Rails plugin for adding associated addresses to Active Record Models}
+  s.email = %q{nicholas.fine@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "MIT-LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/address/USAGE",
+    "lib/generators/address/address_generator.rb",
+    "lib/generators/address/templates/address.rb",
+    "lib/generators/address/templates/create_addresses.rb",
+    "lib/whereabouts.rb",
+    "lib/whereabouts_methods.rb",
+    "spec/spec_helper.rb",
+    "spec/whereabouts_spec.rb",
+    "whereabouts.gemspec"
+  ]
+  s.homepage = %q{http://github.com/yrgoldteeth/whereabouts}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Whereabouts - has_whereabouts :address}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: whereabouts
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Nicholas Fine
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Rails plugin for adding associated addresses to Active Record Models
+email: nicholas.fine@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/generators/address/USAGE
+- lib/generators/address/address_generator.rb
+- lib/generators/address/templates/address.rb
+- lib/generators/address/templates/create_addresses.rb
+- lib/whereabouts.rb
+- lib/whereabouts_methods.rb
+- spec/spec_helper.rb
+- spec/whereabouts_spec.rb
+- whereabouts.gemspec
+has_rdoc: true
+homepage: http://github.com/yrgoldteeth/whereabouts
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 927639709
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Whereabouts - has_whereabouts :address
+test_files: []
+