binarylogic-addresslogic 1.1.2

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.swp
+*.log
+*.sqlite3
+pkg/*
+coverage/*
+doc/*
+benchmarks/*
+

data/CHANGELOG.rdoc

@@ -0,0 +1,15 @@
+== 1.1.2
+
+* Update defaults to use changes in 1.1.1
+
+== 1.1.1
+
+* Clean up code to use recursion and allow fields to be specified like: [:street1, :street2, [:city, [:state, :zip]], :country]. Which is the standard american way of displaying address. Which looks like: [street1, street2, "#{city}, #{state} #{zip}", country]
+
+== 1.1.0
+
+* 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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Johnson of Binary Logic (binarylogic.com)
+
+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,60 @@
+= Address Logic
+
+This is a simple library that takes away the annoyances of displaying addresses in a view. Since various parts of an address can sometimes be optional, such as "street2", displaying addresses was not fun:
+
+  # some HAML view
+  = address.street1
+  %br
+  - if !address.street2.blank?
+    = address.street2
+    %br
+  == #{address.city}, #{address.state} #{address.zip}
+  %br
+  = address.country
+
+That's just ugly. Instead, you can do this with Address Logic:
+
+  = address.address_parts.join("<br />")
+
+Or, what about a single line address?
+
+  = address.address_parts.join(", ")
+
+Maybe you only want city and state:
+
+  = address.address_parts(:only => [:city, :state]).join(", ")
+
+Granted the above is probably easier without using AddressLogic, but it will purge any blank items in the address, so if city or state are optional then it would be cleaner to use AddressLogic.
+
+== Install and use
+
+Install from rubyforge
+
+  $ sudo gem install addresslogic
+
+Install from github:
+
+  $ sudo gem install binarylogic-addresslogic
+
+Or as a plugin
+
+  $ sudo script/plugin install git://github.com/binarylogic/addresslogic.git
+
+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
+    apply_addresslogic
+  end
+
+You can specify the fields too:
+
+  class Address
+    apply_addresslogic :fields => [:street1, :street2, :city, [:state, :zip], :country]
+  end
+
+== Helpful links
+
+*	<b>Documentation:</b> http://rdoc.info/projects/binarylogic/addresslogic
+
+
+Copyright (c) 2009 Ben Johnson of [Binary Logic](http://www.binarylogic.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "addresslogic"
+    gem.summary = "Creates a meaningful array of address parts for easy displaying."
+    gem.email = "bjohnson@binarylogic.com"
+    gem.homepage = "http://github.com/binarylogic/addresslogic"
+    gem.authors = ["Ben Johnson of Binary Logic"]
+    gem.rubyforge_project = "addresslogic"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    desc "Release gem to RubyForge"
+    task :release => ["rubyforge:release:gem"]
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/init.rb

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

data/lib/addresslogic.rb

@@ -0,0 +1,77 @@
+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
+#     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
+  
+  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(*args)
+      options = args.extract_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)
+      fields = args[0] || address_parts_fields
+      level = args[1] || 0
+      
+      parts = []
+      fields.each do |field|
+        if field.is_a?(Array)
+          has_sub_array = field.find { |item| item.is_a?(Array) }
+          separator = has_sub_array ? ", " : " "
+          sub_parts = address_parts(field, level + 1, options).join(separator)
+          next if sub_parts.blank?
+          parts << sub_parts
+        else
+          next if !respond_to?(field)
+          value = send(field)
+          next if value.to_s.strip == "" || (options[:only] && !options[:only].include?(field)) || (options[:except] && options[:except].include?(field))
+          parts << value
+        end
+      end
+      
+      parts
+    end
+    
+    private
+      def address_parts_fields
+        self.class.address_parts_fields
+      end
+  end
+end
+
+ActiveRecord::Base.send(:include, Addresslogic)

data/rails/init.rb

@@ -0,0 +1 @@
+require "addresslogic"

data/test/addresslogic_test.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestAddresslogic < Test::Unit::TestCase
+  def test_uk_uk_address_parts
+    assert_equal ["12 Fancy House", "Bond Street", "London W1 8AJ", "United Kingdom"], uk_address.address_parts
+    
+    uk_address.street2 = ""
+    assert_equal ["12 Fancy House", "London W1 8AJ", "United Kingdom"], uk_address.address_parts
+    
+    uk_address.country = ""
+    assert_equal ["12 Fancy House", "London W1 8AJ"], uk_address.address_parts
+    
+    uk_address.city = ""
+    assert_equal ["12 Fancy House", "W1 8AJ"], uk_address.address_parts
+    
+    uk_address.street1 = ""
+    assert_equal ["W1 8AJ"], uk_address.address_parts
+    
+    uk_address.zip = ""
+    assert_equal [], uk_address.address_parts
+  end
+  
+  def test_american_address_parts
+    assert_equal ["12 Fancy House", "Bond Street", "Tampa, Florida 45334", "United States"], american_address.address_parts
+    
+    american_address.street2 = ""
+    assert_equal ["12 Fancy House", "Tampa, Florida 45334", "United States"], american_address.address_parts
+    
+    american_address.country = ""
+    assert_equal ["12 Fancy House", "Tampa, Florida 45334"], american_address.address_parts
+    
+    american_address.city = ""
+    assert_equal ["12 Fancy House", "Florida 45334"], american_address.address_parts
+    
+    american_address.state = ""
+    assert_equal ["12 Fancy House", "45334"], american_address.address_parts
+
+    american_address.street1 = ""
+    assert_equal ["45334"], american_address.address_parts
+    
+    american_address.zip = ""
+    assert_equal [], american_address.address_parts
+  end
+  
+  def test_options
+    assert_equal ["Bond Street"], uk_address.address_parts(:only => :street2)
+    assert_equal ["12 Fancy House", "Bond Street"], uk_address.address_parts(:only => [:street1, :street2])
+    assert_equal ["12 Fancy House", "London W1 8AJ", "United Kingdom"], uk_address.address_parts(:except => :street2)
+    assert_equal ["London W1 8AJ", "United Kingdom"], uk_address.address_parts(:except => [:street1, :street2])
+  end
+  
+  private
+    def uk_address
+      return @uk_address if @uk_address
+      @uk_address = UKAddress.new
+      @uk_address.street1 = "12 Fancy House"
+      @uk_address.street2 = "Bond Street"
+      @uk_address.city = "London"
+      @uk_address.zip = "W1 8AJ"
+      @uk_address.country = "United Kingdom"
+      @uk_address
+    end
+    
+    def american_address
+      return @american_address if @american_address
+      @american_address = AmericanAddress.new
+      @american_address.street1 = "12 Fancy House"
+      @american_address.street2 = "Bond Street"
+      @american_address.city = "Tampa"
+      @american_address.zip = "45334"
+      @american_address.state = "Florida"
+      @american_address.country = "United States"
+      @american_address
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require "test/unit"
+require "rubygems"
+require "ruby-debug"
+require File.dirname(__FILE__) + "/../lib/addresslogic"
+
+class UKAddress
+  attr_accessor :street1, :street2, :city, :zip, :country
+  include Addresslogic
+  apply_addresslogic :fields => [:street1, :street2, [:city, :zip], :country]
+end
+
+class AmericanAddress
+  attr_accessor :street1, :street2, :city, :state, :zip, :country
+  include Addresslogic
+  apply_addresslogic :fields => [:street1, :street2, [:city, [:state, :zip]], :country]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: binarylogic-addresslogic
+version: !ruby/object:Gem::Version 
+  version: 1.1.2
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/addresslogic.rb
+- rails/init.rb
+- test/addresslogic_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/binarylogic/addresslogic
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: addresslogic
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Creates a meaningful array of address parts for easy displaying.
+test_files: 
+- test/addresslogic_test.rb
+- test/test_helper.rb