yolk-biggs 0.1.3 → 0.1.4

data/CHANGES.textile

@@ -1,3 +1,12 @@
+h3. biggs 0.1.4 - 2009-5-21
+
+* Fixed Specs
+
+h3. biggs 0.1.3 - 2009-3-6
+
+* Correct japanese address format. [hiroshi]
+* Fixed docs for current API. [hiroshi]
+
 h3. biggs 0.1.2 - 2009-3-4
 
 * Values can now be specified by an array of symbols.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yolk Sebastian Munz & Julia Soergel GbR
+
+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/Rakefile

@@ -0,0 +1,22 @@
+task :default => [:spec]
+ 
+$gem_name = "biggs"
+ 
+desc "Run specs"
+task :spec do
+  sh "spec spec/* --format specdoc --color"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = $gem_name
+    s.summary = "biggs is a small ruby gem/rails plugin for formatting postal addresses from over 60 countries."
+    s.email = "sebastian@yo.lk"
+    s.homepage = "http://github.com/yolk/biggs"
+    s.description = s.summary
+    s.authors = ["Sebastian Munz"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 1
-:patch: 3
+:patch: 4
 :major: 0

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'biggs')

data/spec/unit/activerecord_spec.rb

@@ -0,0 +1,201 @@
+require 'rubygems'
+require 'active_record'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+# A dummy class for mocking the activerecord connection class
+class Connection;end
+
+# StandardMethods for Address
+module BiggsStandardMethods
+  Biggs::Formatter::FIELDS.each do |field|
+    define_method(field) do
+      field == :country ? "us" : field.to_s.upcase
+    end
+  end
+end
+
+class FooBarEmpty < ActiveRecord::Base
+  include BiggsStandardMethods
+end
+
+class FooBar < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :postal_address
+end
+
+class FooBarCustomFields < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :postal_address, :country => :my_custom_country_method,
+                  :city => :my_custom_city_method
+  
+  def my_custom_country_method
+    "de"
+  end
+  
+  def my_custom_city_method
+    "Hamburg"
+  end
+end
+
+class FooBarCustomBlankDECountry < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :postal_address, :blank_country_on => "de"
+  
+  def country
+    "DE"
+  end
+end
+
+class FooBarCustomMethod < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :my_postal_address_method
+end
+
+class FooBarCustomProc < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :postal_address, 
+        :country => Proc.new {|it| it.method_accessed_from_proc + "XX"}, 
+        :state => Proc.new {|it| it.state.downcase }
+  
+  def method_accessed_from_proc
+    "DE"
+  end
+end
+
+class FooBarCustomArray < ActiveRecord::Base
+  include BiggsStandardMethods
+  
+  biggs :postal_address,  
+        :street => [:address_1, :address_empty, :address_nil, :address_2]
+  
+  def address_1
+    "Address line 1"
+  end
+  
+  def address_2
+    "Address line 2"
+  end
+  
+  def address_empty
+    ""
+  end
+  
+  def address_nil
+    nil
+  end
+end
+
+
+describe "ActiveRecord Class" do
+  
+  it "should include Biggs::ActiveRecordAdapter" do
+    FooBar.included_modules.should be_include(Biggs::ActiveRecordAdapter)
+  end
+  
+  it "should set class value biggs_value_methods" do
+    FooBar.class_eval("biggs_value_methods").should be_is_a(Hash)
+    FooBar.class_eval("biggs_value_methods").size.should be_zero
+  end
+  
+  it "should set class value biggs_instance" do
+    FooBar.class_eval("biggs_instance").should be_is_a(Biggs::Formatter)
+  end
+  
+  it "should respond to biggs" do
+    FooBar.should be_respond_to(:biggs)
+  end
+end
+
+describe "ActiveRecord Instance" do
+  
+  describe "Empty" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarEmpty.stub!(:connection).and_return(connection)
+    end
+  
+    it "should not have postal_address method" do
+      FooBarEmpty.new.should_not be_respond_to(:postal_address)
+    end
+  end
+  
+  describe "Standard" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBar.stub!(:connection).and_return(connection)
+    end
+  
+    it "should have postal_address method" do
+      FooBar.new.should be_respond_to(:postal_address)
+    end
+  
+    it "should return postal_address on postal_address" do
+      FooBar.new.postal_address.should eql("RECIPIENT\nSTREET\nCITY STATE ZIP\nUnited States")
+    end
+  end
+
+  describe "Customized Fields" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarCustomFields.stub!(:connection).and_return(connection)
+    end
+  
+    it "should return address from custom fields on postal_address" do
+      FooBarCustomFields.new.postal_address.should eql("RECIPIENT\nSTREET\nZIP Hamburg\nGermany")
+    end
+  end
+
+  describe "Customized Blank DE Country" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarCustomBlankDECountry.stub!(:connection).and_return(connection)
+    end
+  
+    it "should return address wo country on postal_address" do
+      FooBarCustomBlankDECountry.new.postal_address.should eql("RECIPIENT\nSTREET\nZIP CITY")
+    end
+  end
+  
+  describe "Customized Method name" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarCustomMethod.stub!(:connection).and_return(connection)
+    end
+  
+    it "should have my_postal_address_method" do
+      FooBarCustomMethod.new.should be_respond_to(:my_postal_address_method)
+    end
+    
+    it "should return formatted address on my_postal_address_method" do
+      FooBarCustomMethod.new.my_postal_address_method.should eql("RECIPIENT\nSTREET\nCITY STATE ZIP\nUnited States")
+    end
+  end
+  
+  describe "Customized Proc as Param" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarCustomProc.stub!(:connection).and_return(connection)
+    end
+    
+    it "should return formatted address for unknown-country DEXX" do
+      FooBarCustomProc.new.postal_address.should eql("RECIPIENT\nSTREET\nCITY state ZIP\ndexx")
+    end
+  end
+  
+  describe "Customized array of symbols" do
+    before(:each) do
+      connection = mock(Connection, :columns => [])
+      FooBarCustomArray.stub!(:connection).and_return(connection)
+    end
+    
+    it "should return formatted address with two lines for street" do
+      FooBarCustomArray.new.postal_address.should eql("RECIPIENT\nAddress line 1\nAddress line 2\nCITY STATE ZIP\nUnited States")
+    end
+  end
+
+end

data/spec/unit/biggs_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+FAKE_ATTR_WITH_STATE = {:state => "STATE", :city => "CITY", :zip => 12345, :street => "STREET", :recipient => "MR. X"}
+FAKE_ATTR_WO_STATE = {:city => "CITY", :zip => 12345, :street => "STREET", :recipient => "MR. X"}
+
+describe Biggs::Formatter, "with defaults" do
+  
+  before { @biggs = Biggs::Formatter.new }
+  
+  it "should format to us format" do
+    @biggs.format('us', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\nCITY STATE 12345\nUnited States")
+  end
+  
+  it "should format to de format" do
+    @biggs.format('de', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\n12345 CITY\nGermany")
+  end
+  
+  it "should format to british format" do
+    @biggs.format('gb', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\nCITY\nSTATE\n12345\nUnited Kingdom")
+  end
+  
+  it "should format to fr format" do
+    @biggs.format('fr', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY\nFrance")
+  end
+  
+  it "should format to fr format if country_code unknown and there is no STATE given" do
+    @biggs.format('unknown', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY\nunknown")
+  end
+  
+  it "should format to us format if country_code unknown and there is no STATE given" do
+    @biggs.format('unknown', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\nCITY STATE 12345\nunknown")
+  end
+  
+end
+
+describe Biggs, "with options" do
+  
+  describe "blank_country_on de" do
+    before { @biggs = Biggs::Formatter.new(:blank_country_on => 'de') }
+    
+    it "should have blank country in 'de' address" do
+      @biggs.format('de', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY")
+    end
+    
+    it "should have country in 'fr' address" do
+      @biggs.format('fr', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY\nFrance")
+    end
+    
+  end
+  
+  describe "blank_country_on multiple (US,de)" do
+    before { @biggs = Biggs::Formatter.new(:blank_country_on => ['US', "de"]) }
+    
+    it "should have blank country in 'us' address" do
+      @biggs.format('us', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\nCITY STATE 12345")
+    end
+    
+    it "should have country in 'fr' address" do
+      @biggs.format('fr', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\n12345 CITY\nFrance")
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yolk-biggs
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-06 00:00:00 -08:00
+date: 2009-05-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,21 +19,25 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.textile
 files: 
 - CHANGES.textile
+- LICENSE
 - README.textile
+- Rakefile
 - VERSION.yml
-- lib/biggs
+- lib/biggs.rb
 - lib/biggs/activerecord.rb
 - lib/biggs/formatter.rb
-- lib/biggs.rb
+- spec/spec_helper.rb
+- spec/unit/activerecord_spec.rb
+- spec/unit/biggs_spec.rb
 has_rdoc: true
 homepage: http://github.com/yolk/biggs
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -56,5 +60,7 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: biggs is a small ruby gem/rails plugin for formatting postal addresses from over 60 countries.
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/activerecord_spec.rb
+- spec/unit/biggs_spec.rb