addresslogic 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+== 1.0.1
+
+* Changed inclusion method to use apply_addresslogic instead of include Addresslogic. This allows you to pass options and specify alternate fields.
+
+== 1.0.0
+
+* Initial release

data/{Manifest → Manifest.txt}

@@ -1,9 +1,11 @@
-init.rb
-lib/addresslogic/version.rb
-lib/addresslogic.rb
-Manifest
+CHANGELOG.rdoc
 MIT-LICENSE
-Rakefile
+Manifest.txt
 README.rdoc
+Rakefile
+init.rb
+lib/addresslogic.rb
+lib/addresslogic/version.rb
+rails/init.rb
 test/test_addresslogic.rb
 test/test_helper.rb

data/README.rdoc

@@ -34,12 +34,18 @@ As a gem:
 
 Or as a plugin
 
-  $ sudo script/plugin install url
+  $ sudo script/plugin install git://github.com/binarylogic/addresslogic.git
 
-Then ust include the AddressLogic module into any class of your choice. All that it assumes is that you have the street1, street2, city, state, zip, country (optional) methods.
+Then just include the AddressLogic module into any class of your choice. All that it assumes is that you have the street1, street2, city, state, zip, country (optional) methods.
 
   class Address
-    include Addresslogic
+    apply_addresslogic
+  end
+
+You can specify the fields too:
+
+  class Address
+    apply_addresslogic :fields => [:street1, :street2, :city, [:state, :zip], :country]
   end
 
 == Helpful links

data/Rakefile

@@ -1,13 +1,20 @@
-require 'rubygems'
+ENV['RDOCOPT'] = "-S -f html -T hanna"
+
+require "rubygems"
+require "hoe"
 require File.dirname(__FILE__) << "/lib/addresslogic/version"
-require 'echoe'
 
-Echoe.new 'addresslogic' do |p|
-  p.version = Addresslogic::Version::STRING
+Hoe.new("Addresslogic", Addresslogic::Version::STRING) do |p|
+  p.name = "addresslogic"
+  p.rubyforge_name = "addresslogic"
   p.author = "Ben Johnson of Binary Logic"
   p.email  = 'bjohnson@binarylogic.com'
-  p.project = 'addresslogic'
-  p.summary = "Tools for displaying addresses"
+  p.summary = "Easily display addresses."
+  p.description = "Easily display addresses."
   p.url = "http://github.com/binarylogic/addresslogic"
-  p.dependencies = %w(echoe)
+  p.history_file = "CHANGELOG.rdoc"
+  p.readme_file = "README.rdoc"
+  p.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc"]
+  p.remote_rdoc_dir = ''
+  p.test_globs = ["test/*/test_*.rb", "test/*_test.rb", "test/*/*_test.rb"]
 end

data/init.rb

@@ -1,2 +1 @@
-require "addresslogic/version"
-require "addresslogic"
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/addresslogic.rb

@@ -1,42 +1,86 @@
+require 'activerecord'
+
 # = Address Logic
 #
 # This is a simple module that you can include into any classm as long as it has a street1, street2, city, state, zip, and country (optional)
 # methods. Just include it into your class like so:
 #
 #   class Address
-#     include AddressLogic
+#     apply_addresslogic :fields => [:street1, :street2, :city, [:state, :zip], :country]
 #   end
 #
+# The above will return:
+#   ["Street1", "Street2", "City", "State Zip", "Country"]
+#
 # This adds a sigle method: address_parts. More on this method below...
 module Addresslogic
-  # Returns the parts of an address in an array. Example:
-  #
-  #   ["Street1", "Street2", "City, State, Zip", "Country"]
-  #
-  # This makes displaying addresses on your view pretty simple:
-  #
-  #   address.address_parts.join("<br />")
-  #
-  # === Options
-  #
-  # * <tt>only:</tt> fields you want included in the result
-  # * <tt>except:</tt> any fields you want excluded from the result
-  def address_parts(options = {})
-    options[:only] = [options[:only]] if options[:only] && !options[:only].is_a?(Array)
-    options[:except] = [options[:except]] if options[:except] && !options[:except].is_a?(Array)
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    attr_accessor :address_parts_fields
+    
+    def apply_addresslogic(args = {})
+      self.address_parts_fields = args[:fields] || [:street1, :street2, :city, [:state, :zip], :country]
+      include Addresslogic::InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    # Returns the parts of an address in an array. Example:
+    #
+    #   ["Street1", "Street2", "City", "State Zip", "Country"]
+    #
+    # This makes displaying addresses on your view pretty simple:
+    #
+    #   address.address_parts.join("<br />")
+    #
+    # === Options
+    #
+    # * <tt>only:</tt> fields you want included in the result
+    # * <tt>except:</tt> any fields you want excluded from the result
+    def address_parts(options = {})
+      options[:only] = [options[:only]] if options[:only] && !options[:only].is_a?(Array)
+      options[:except] = [options[:except]] if options[:except] && !options[:except].is_a?(Array)
     
-    parts = {}
-    [:street1, :street2, :city, :state, :zip, :country].each do |part|
-      next if !respond_to?(part)
-      value = send(part)
-      next if value.to_s.strip == "" || (options[:only] && !options[:only].include?(part)) || (options[:except] && options[:except].include?(part))
-      parts[part] = value
+      parts = []
+      address_parts_fields.each do |part|
+        if part.is_a?(Array)
+          # We only want to allow 2d arrays
+          subparts = []
+          part.flatten.each do |subpart|
+            next if !respond_to?(subpart)
+            value = send(subpart)
+            next if value.to_s.blank? || (options[:only] && !options[:only].include?(subpart)) || (options[:except] && options[:except].include?(subpart))
+            subparts << value
+          end
+          parts << subparts unless subparts.compact.empty?
+        else
+          next if !respond_to?(part)
+          value = send(part)
+          next if value.to_s.strip == "" || (options[:only] && !options[:only].include?(part)) || (options[:except] && options[:except].include?(part))
+          parts << value
+        end
+      end
+      
+      result = parts.collect do |part|
+        if part.is_a?(Array)
+          part.collect{|sub| sub.to_s.strip.blank? ? nil : sub}.join(" ")
+        else
+          part.to_s.strip.blank? ? nil : part
+        end
+      end
+      
+      return result.compact
     end
     
-    state_parts = [parts[:state], parts[:zip]].compact.join(" ")
-    state_parts = nil if state_parts.strip == ""
-    city_parts = [parts[:city], state_parts].compact.join(", ")
-    city_parts = nil if city_parts.strip == ""
-    [parts[:street1], parts[:street2], city_parts, parts[:country]].compact
+    private
+      def address_parts_fields
+        self.class.address_parts_fields
+      end
   end
-end
+end
+
+ActiveRecord::Base.send(:include, Addresslogic)

data/lib/addresslogic/version.rb

@@ -43,7 +43,7 @@ module Addresslogic
     end
 
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     TINY  = 0
 
     # The current version as a Version instance

data/rails/init.rb

@@ -0,0 +1,2 @@
+require "addresslogic/version"
+require "addresslogic"

data/test/test_addresslogic.rb

@@ -2,44 +2,40 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestAddresslogix < Test::Unit::TestCase
   def test_address_parts
-    assert_equal ["Street1", "Street2", "City, State 22933", "United States of America"], address.address_parts
+    assert_equal ["12 Fancy House", "Bond Street", "London W1 8AJ", "United Kingdom"], address.address_parts
     
     address.street2 = ""
-    assert_equal ["Street1", "City, State 22933", "United States of America"], address.address_parts
-    
-    address.state = ""
-    assert_equal ["Street1", "City, 22933", "United States of America"], address.address_parts
+    assert_equal ["12 Fancy House", "London W1 8AJ", "United Kingdom"], address.address_parts
     
     address.country = ""
-    assert_equal ["Street1", "City, 22933"], address.address_parts
+    assert_equal ["12 Fancy House", "London W1 8AJ"], address.address_parts
     
     address.city = ""
-    assert_equal ["Street1", "22933"], address.address_parts
+    assert_equal ["12 Fancy House", "W1 8AJ"], address.address_parts
     
     address.street1 = ""
-    assert_equal ["22933"], address.address_parts
+    assert_equal ["W1 8AJ"], address.address_parts
     
     address.zip = ""
     assert_equal [], address.address_parts
   end
   
   def test_options
-    assert_equal ["Street2"], address.address_parts(:only => :street2)
-    assert_equal ["Street1", "Street2"], address.address_parts(:only => [:street1, :street2])
-    assert_equal ["Street1", "City, State 22933", "United States of America"], address.address_parts(:except => :street2)
-    assert_equal ["City, State 22933", "United States of America"], address.address_parts(:except => [:street1, :street2])
+    assert_equal ["Bond Street"], address.address_parts(:only => :street2)
+    assert_equal ["12 Fancy House", "Bond Street"], address.address_parts(:only => [:street1, :street2])
+    assert_equal ["12 Fancy House", "London W1 8AJ", "United Kingdom"], address.address_parts(:except => :street2)
+    assert_equal ["London W1 8AJ", "United Kingdom"], address.address_parts(:except => [:street1, :street2])
   end
   
   private
     def address
       return @address if @address
       @address = Address.new
-      @address.street1 = "Street1"
-      @address.street2 = "Street2"
-      @address.city = "City"
-      @address.state = "State"
-      @address.zip = "22933"
-      @address.country = "United States of America"
+      @address.street1 = "12 Fancy House"
+      @address.street2 = "Bond Street"
+      @address.city = "London"
+      @address.zip = "W1 8AJ"
+      @address.country = "United Kingdom"
       @address
     end
 end

data/test/test_helper.rb

@@ -4,6 +4,7 @@ require "ruby-debug"
 require File.dirname(__FILE__) + "/../lib/addresslogic"
 
 class Address
-  attr_accessor :street1, :street2, :city, :state, :zip, :country
+  attr_accessor :street1, :street2, :city, :zip, :country
   include Addresslogic
+  apply_addresslogic :fields => [:street1, :street2, [:city, :zip], :country]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: addresslogic
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,58 +9,47 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-16 00:00:00 -05:00
+date: 2009-05-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: echoe
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
+  name: hoe
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.12.2
     version: 
-description: Tools for displaying addresses
+description: Easily display addresses.
 email: bjohnson@binarylogic.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- lib/addresslogic/version.rb
-- lib/addresslogic.rb
+- Manifest.txt
+- CHANGELOG.rdoc
 - README.rdoc
 files: 
-- init.rb
-- lib/addresslogic/version.rb
-- lib/addresslogic.rb
-- Manifest
+- CHANGELOG.rdoc
 - MIT-LICENSE
-- Rakefile
+- Manifest.txt
 - README.rdoc
+- Rakefile
+- init.rb
+- lib/addresslogic.rb
+- lib/addresslogic/version.rb
+- rails/init.rb
 - test/test_addresslogic.rb
 - test/test_helper.rb
-- addresslogic.gemspec
 has_rdoc: true
 homepage: http://github.com/binarylogic/addresslogic
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Addresslogic
 - --main
 - README.rdoc
 require_paths: 
@@ -75,15 +64,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
 rubyforge_project: addresslogic
-rubygems_version: 1.3.1
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
-summary: Tools for displaying addresses
-test_files: 
-- test/test_addresslogic.rb
-- test/test_helper.rb
+specification_version: 3
+summary: Easily display addresses.
+test_files: []
+

data/addresslogic.gemspec

@@ -1,38 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{addresslogic}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2009-01-16}
-  s.description = %q{Tools for displaying addresses}
-  s.email = %q{bjohnson@binarylogic.com}
-  s.extra_rdoc_files = ["lib/addresslogic/version.rb", "lib/addresslogic.rb", "README.rdoc"]
-  s.files = ["init.rb", "lib/addresslogic/version.rb", "lib/addresslogic.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "test/test_addresslogic.rb", "test/test_helper.rb", "addresslogic.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/binarylogic/addresslogic}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Addresslogic", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{addresslogic}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Tools for displaying addresses}
-  s.test_files = ["test/test_addresslogic.rb", "test/test_helper.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<echoe>, [">= 0"])
-      s.add_development_dependency(%q<echoe>, [">= 0"])
-    else
-      s.add_dependency(%q<echoe>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<echoe>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-  end
-end