mooktakim-addresslogic 1.0.1

data/MIT-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/Manifest

@@ -0,0 +1,9 @@
+init.rb
+lib/addresslogic/version.rb
+lib/addresslogic.rb
+MIT-LICENSE
+Rakefile
+README.rdoc
+test/addresslogic_tests.rb
+test/test_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,50 @@
+= 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
+
+As a gem:
+
+  $ sudo gem install addresslogic
+
+Or as a plugin
+
+  $ sudo script/plugin install url
+
+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.
+
+  class Address
+    include Addresslogic
+  end
+
+== Helpful links
+
+*	<b>Documentation:</b> http://addresslogic.rubyforge.org
+
+
+Copyright (c) 2009 Ben Johnson of [Binary Logic](http://www.binarylogic.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require File.dirname(__FILE__) << "/lib/addresslogic/version"
+require 'echoe'
+
+Echoe.new 'addresslogic' do |p|
+  p.version = Addresslogic::Version::STRING
+  p.author = "Ben Johnson of Binary Logic"
+  p.email  = 'bjohnson@binarylogic.com'
+  p.project = 'addresslogic'
+  p.summary = "Tools for displaying addresses"
+  p.url = "http://github.com/binarylogic/addresslogic"
+  p.dependencies = %w(echoe)
+end

data/addresslogic.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{addresslogic}
+  s.version = "1.0.1"
+
+  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

data/init.rb

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

data/lib/addresslogic.rb

@@ -0,0 +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
+#     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 = {})
+      # Is there a better way to do this??
+      class_eval <<-RUBY
+        def address_parts_fields
+          #{args[:fields].inspect}
+        end
+      RUBY
+      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 = []
+      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
+  end
+end
+
+ActiveRecord::Base.send(:include, Addresslogic)

data/lib/addresslogic/version.rb

@@ -0,0 +1,56 @@
+module Addresslogic
+  # = Version
+  #
+  # A class for describing the current version of a library. The version
+  # consists of three parts: the +major+ number, the +minor+ number, and the
+  # +tiny+ (or +patch+) number.
+  class Version
+    
+    include Comparable
+  
+    # A convenience method for instantiating a new Version instance with the
+    # given +major+, +minor+, and +tiny+ components.
+    def self.[](major, minor, tiny)
+      new(major, minor, tiny)
+    end
+
+    attr_reader :major, :minor, :tiny
+
+    # Create a new Version object with the given components.
+    def initialize(major, minor, tiny)
+      @major, @minor, @tiny = major, minor, tiny
+    end
+
+    # Compare this version to the given +version+ object.
+    def <=>(version)
+      to_i <=> version.to_i
+    end
+
+    # Converts this version object to a string, where each of the three
+    # version components are joined by the '.' character. E.g., 2.0.0.
+    def to_s
+      @to_s ||= [@major, @minor, @tiny].join(".")
+    end
+
+    # Converts this version to a canonical integer that may be compared
+    # against other version objects.
+    def to_i
+      @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+    end
+    
+    def to_a
+      [@major, @minor, @tiny]
+    end
+
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    # The current version as a Version instance
+    CURRENT = new(MAJOR, MINOR, TINY)
+    # The current version as a String
+    STRING = CURRENT.to_s
+    
+  end
+  
+end

data/test/test_addresslogic.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestAddresslogix < Test::Unit::TestCase
+  def test_address_parts
+    assert_equal ["12 Fancy House", "Bond Street", "London W1 8AJ", "United Kingdom"], address.address_parts
+    
+    address.street2 = ""
+    assert_equal ["12 Fancy House", "London W1 8AJ", "United Kingdom"], address.address_parts
+    
+    address.country = ""
+    assert_equal ["12 Fancy House", "London W1 8AJ"], address.address_parts
+    
+    address.city = ""
+    assert_equal ["12 Fancy House", "W1 8AJ"], address.address_parts
+    
+    address.street1 = ""
+    assert_equal ["W1 8AJ"], address.address_parts
+    
+    address.postcode = ""
+    assert_equal [], address.address_parts
+  end
+  
+  def test_options
+    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 = "12 Fancy House"
+      @address.street2 = "Bond Street"
+      @address.city = "London"
+      @address.postcode = "W1 8AJ"
+      @address.country = "United Kingdom"
+      @address
+    end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mooktakim-addresslogic
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08: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
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Tools for displaying addresses
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/addresslogic/version.rb
+- lib/addresslogic.rb
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/binarylogic/addresslogic
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Addresslogic
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: addresslogic
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Tools for displaying addresses
+test_files: 
+- test/test_addresslogic.rb
+- test/test_helper.rb