biggs 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e01c45617723b2d38b705c737fedf6bd560e9211c1ef834272cd9c4fd8f09814
+  data.tar.gz: 63763d95d695fe3078517c2f1e4cc80246dec8a53e6e8191c69fd71feb49d222
+SHA512:
+  metadata.gz: 891ec94ea1236687a03296b4904740b5b28f391bc5de769ad5d78d6f9cb4fd3225399823c60e1de18145706b29940d0cea0a556cc1ec2b5f0a4a832645c14f92
+  data.tar.gz: 10383285215245585fca93d53377804c759beb43484f333421e7874768455dfbdb47b117885c466708a45f1501a0d410890c725ae0871db6c476553ac63b2205

data/.gitignore

@@ -1,2 +1,3 @@
 biggs-*.*.*.gem
-Gemfile.lock
+Gemfile.lock
+.rbenv-*

data/CHANGES.md

@@ -1,5 +1,18 @@
 ### dev
 
+### 0.4.0 / 2022-04-08
+
+* [BREAKING]: Do not include to ActiveRecord::Base per default, use 'include Biggs::ActiveRecordAdapter' in your classes
+* Allow multiple biggs methods per class
+
+### 0.3.3 / 2013-05-06
+
+* Added support for Rails 4 (by [mdemare](https://github.com/mdemare))
+
+### 0.3.2 / 2013-02-19
+
+* Fixed warning in Biggs::Format
+
 ### 0.3.1 / 2012-08-02
 
 * Fixed LI format
@@ -35,8 +48,8 @@
 
 ### 0.1.3 / 2009-3-6
 
-* Correct japanese address format. [hiroshi]
-* Fixed docs for current API. [hiroshi]
+* Correct japanese address format. (by [hiroshi](https://github.com/hiroshi))
+* Fixed docs for current API. (by [hiroshi](https://github.com/hiroshi))
 
 ### 0.1.2 / 2009-3-4
 

data/README.md

@@ -3,67 +3,69 @@ biggs is a small ruby gem/rails plugin for formatting postal addresses from over
 ### Install
 
 As a ruby gem:
-   
-    sudo gem install yolk-biggs
-   
-If your rather prefer to install it as a plugin for rails, from your application directory simply run:
-   
-    script/plugin install git://github.com/yolk/biggs.git
+
+    gem install biggs
 
 ### Standalone usage
-    
+
     f = Biggs::Formatter.new
-    
+
     f.format("de", # <= ISO alpha 2 code
-      :recipient  => "Yolk Sebastian Munz & Julia Soergel GbR", 
-      :street     => "Adalbertstr. 11", # <= street + house number
-      :city       => "Berlin",
-      :zip        => 10999,
-      :state      => "Berlin" # <= state/province/region
+      :recipient  => "Yolk Sebastian Munz & Julia Soergel GbR",
+      :street     => "Musterallee 12", # <= street + house number
+      :city       => "Ausgedacht",
+      :zip        => 12345,
+      :state      => "Nowhere" # <= state/province/region
     )
 
 returns
-   
+
     "Yolk Sebastian Munz & Julia Soergel GbR
-    Adalbertstr. 11
-    10999 Berlin
+    Musterallee 12
+    12345 Ausgedacht
     Germany"
 
 At the moment Biggs::Formatter.new accepts only one option:
 
-*blank_county_on* ISO alpha 2 code (single string or array) of countries the formatter should skip the line "country" (for national shipping).
-   
-    Biggs::Formatter.new(:blank_county_on => "de")
-   
+*blank_country_on* ISO alpha 2 code (single string or array) of countries the formatter should skip the line "country" (for national shipping).
+
+    Biggs::Formatter.new(blank_country_on: "de")
+
 With the data from the above example this would return:
 
     "Yolk Sebastian Munz & Julia Soergel GbR
-    Adalbertstr. 11
-    10999 Berlin"
+    Musterallee 12
+    12345 Ausgedacht"
 
 ### Usage with Rails and ActiveRecord
 
     Address < ActiveRecord::Base
+      include Biggs::ActiveRecordAdapter
+
       biggs :postal_address
     end
-   
-This adds the method postal_address to your Address-model, and assumes the presence of the methods/columns recipient, street, city, zip, state, and country to get the address data. Country should return the ISO-code (e.g. 'us', 'fr', 'de'). 
+
+This adds the method postal_address to your Address-model, and assumes the presence of the methods/columns recipient, street, city, zip, state, and country to get the address data. Country should return the ISO-code (e.g. 'us', 'fr', 'de').
 
 You can customize the method-names biggs will use by passing in a hash of options:
-   
+
     Address < ActiveRecord::Base
-      biggs :postal_address, 
+      include Biggs::ActiveRecordAdapter
+
+      biggs :postal_address,
             :zip => :postal_code,
             :country => :country_code,
             :street => Proc.new {|address| "#{address.street} #{address.house_number}" }
     end
-   
-You can pass in a symbol to let biggs call a different method on your Address-model, or a Proc-object to create your data on the fly. 
+
+You can pass in a symbol to let biggs call a different method on your Address-model, or a Proc-object to create your data on the fly.
 
 You can even pass in a array of symbols:
 
     Address < ActiveRecord::Base
-      biggs :postal_address, 
+      include Biggs::ActiveRecordAdapter
+
+      biggs :postal_address,
             :recipient => [:company_name, :person_name]
     end
 
@@ -72,9 +74,9 @@ This will call the methods company_name and person_name on your address-instance
 To access the formatted address string, simply call the provided method on an address instance:
 
     Address.find(1).postal_address
-   
+
 If you pass in a ISO alpha 2 code as :country that is not supported by biggs, it will choose the US-format for addresses with an state specified, and the french/german format for addresses without an state.
-   
+
 ### Supported countries
 
 biggs knows how to format addresses of over 60 different countries. If you are missing one or find an misstake, feel free to let us know, fork this repository and commit your additions.
@@ -145,6 +147,6 @@ biggs knows how to format addresses of over 60 different countries. If you are m
 * United States of America
 * Yemen
 
-biggs is tested to behave well with Rails 3.0
+biggs is tested to behave well with Rails 3 to 7
 
-Copyright (c) 2009-2012 Yolk Sebastian Munz & Julia Soergel GbR
+Copyright (c) 2009-2022 Yolk Sebastian Munz & Julia Soergel GbR

data/biggs.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activerecord',            '~> 3.0'
+  s.add_dependency 'activerecord',            '>= 3.0'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec',       '>= 2.4.0'
+  s.add_development_dependency 'rspec',       '>= 3.0'
+  s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'sqlite3',     '>= 1.3.5'
 end
 

data/lib/biggs/activerecord.rb

@@ -2,60 +2,56 @@ require 'active_support/core_ext/class/attribute'
 
 module Biggs
   module ActiveRecordAdapter
-    
-    def self.included(base)
-      base.extend(InitialClassMethods)
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :biggs_config, default: {}
     end
-    
-    module InitialClassMethods
-      def biggs(method_name=nil, options={})
-        self.class_attribute :biggs_value_methods
-        self.class_attribute :biggs_instance
 
-        self.send(:include, Biggs::ActiveRecordAdapter::InstanceMethods)
-        alias_method(method_name || :postal_address, :biggs_postal_address)
+    class_methods do
+      def biggs(method_name=:postal_address, options={})
+        self.define_method(method_name) do
+          value_methods = self.biggs_config[method_name][:value_methods]
+          self.biggs_config[method_name][:instance].format(
+            Helpers.biggs_get_value(self, :country, value_methods),
+            Helpers.biggs_values(self, value_methods)
+          )
+        end
 
         value_methods = {}
         Biggs::Formatter::FIELDS.each do |field|
           value_methods[field] = options.delete(field) if options[field]
         end
-        
-        self.biggs_value_methods = value_methods
-        self.biggs_instance = Biggs::Formatter.new(options)
+
+        self.biggs_config = self.biggs_config.dup
+
+        self.biggs_config[method_name] = {
+          instance: Biggs::Formatter.new(options),
+          value_methods: value_methods
+        }
       end
     end
-    
-    module InstanceMethods
-      
-      def biggs_postal_address
-        self.class.biggs_instance.format(biggs_country, biggs_values)
-      end
-    
-      private
-    
-      def biggs_country
-        biggs_get_value(:country)
-      end
-    
-      def biggs_values
+
+    module Helpers
+      def self.biggs_values(instance, value_methods)
         values = {}
         (Biggs::Formatter::FIELDS - [:country]).each do |field|
-          values[field] = biggs_get_value(field)
+          values[field] = self.biggs_get_value(instance, field, value_methods)
         end
         values
       end
-      
-      def biggs_get_value(field)
-        key = self.class.biggs_value_methods[field.to_sym] || field.to_sym
-        
+
+      def self.biggs_get_value(instance, field, value_methods)
+        key = value_methods[field] || field
+
         case key
         when Symbol
-          self.send(key.to_sym)
+          instance.send(key.to_sym)
         when Proc
-          key.call(self).to_s
+          key.call(instance).to_s
         when Array
           if key.all?{|it| it.is_a?(Symbol) }
-            key.map{|method| self.send(method) }.reject(&:blank?).join("\n")
+            key.map{|method| instance.send(method) }.reject(&:blank?).join("\n")
           else
             raise "Biggs: Can't handle #{field} type Array with non-symbolic entries"
           end
@@ -65,4 +61,4 @@ module Biggs
       end
     end
   end
-end
+end

data/lib/biggs/format.rb

@@ -1,22 +1,20 @@
 module Biggs
   class Format
     attr_reader :country_name, :iso_code, :format_string
-    
-    DEFAULT_WITH_STATE = 
-    
+
     def initialize(iso_code)
       @iso_code = iso_code.to_s.downcase
       @country_name = Biggs.country_names[@iso_code]
       @format_string = Biggs.formats[@iso_code]
     end
-    
+
     class << self
       def find(iso_code)
         entries_cache[iso_code] ||= new(iso_code)
       end
-      
+
       private
-      
+
       def entries_cache
         @entries_cache ||= {}
       end

data/lib/biggs/version.rb

@@ -1,3 +1,3 @@
 module Biggs
-  VERSION = "0.3.1"
-end
+  VERSION = "0.4.0"
+end

data/lib/biggs.rb

@@ -7,7 +7,7 @@ module Biggs
     def formats
       @@formats ||= YAML.load_file(File.join(File.dirname(__FILE__), '..', 'formats.yml')) || {}
     end
-    
+
     def country_names
       @@country_names ||= YAML.load_file(File.join(File.dirname(__FILE__), '..', 'country_names.yml')) || {}
     end
@@ -16,5 +16,4 @@ end
 
 if defined?(ActiveRecord) and defined?(ActiveRecord::Base) and !ActiveRecord::Base.respond_to?(:biggs_formatter)
   require 'biggs/activerecord'
-  ActiveRecord::Base.send :include, Biggs::ActiveRecordAdapter
-end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'rubygems'
 require 'rspec'
+require 'rspec/its'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'biggs')
 require 'logger'
 
@@ -12,4 +13,8 @@ ActiveRecord::Schema.define do
   create_table :base_tables, :force => true do |table|
     table.string :name
   end
-end
+end
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end

data/spec/unit/activerecord_spec.rb

@@ -3,6 +3,8 @@ require 'active_record'
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 class BaseTable < ActiveRecord::Base
+  include Biggs::ActiveRecordAdapter
+
   Biggs::Formatter::FIELDS.each do |field|
     define_method(field) do
       field == :country ? "us" : field.to_s.upcase
@@ -19,11 +21,11 @@ end
 class FooBarCustomFields < BaseTable
   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
@@ -31,7 +33,7 @@ end
 
 class FooBarCustomBlankDECountry < BaseTable
   biggs :postal_address, :blank_country_on => "de"
-  
+
   def country
     "DE"
   end
@@ -42,69 +44,74 @@ class FooBarCustomMethod < BaseTable
 end
 
 class FooBarCustomProc < BaseTable
-  biggs :postal_address, 
-        :country => Proc.new {|it| it.method_accessed_from_proc + "XX"}, 
+  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 < BaseTable
-  biggs :postal_address,  
+  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
 
+class FooBarMultiple < BaseTable
+  biggs :postal_address_one
+  biggs :postal_address_two,
+        country: :alt_country
+
+  def alt_country
+    "Alt country"
+  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)
+
+  it "should set class value biggs_config" do
+    FooBar.class_eval("biggs_config").should be_is_a(Hash)
   end
-  
+
   it "should respond to biggs" do
     FooBar.should be_respond_to(:biggs)
   end
 end
 
 describe "ActiveRecord Instance" do
-  
+
   describe "Empty" do
     it "should not have postal_address method" do
       FooBarEmpty.new.should_not be_respond_to(:postal_address)
     end
   end
-  
+
   describe "Standard" do
     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 of America")
     end
@@ -121,27 +128,38 @@ describe "ActiveRecord Instance" do
       FooBarCustomBlankDECountry.new.postal_address.should eql("RECIPIENT\nSTREET\nZIP CITY")
     end
   end
-  
+
   describe "Customized Method name" do
     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 of America")
     end
   end
-  
+
   describe "Customized Proc as Param" do
     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
     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 of America")
     end
   end
 
-end
+  describe "Multiple" do
+
+    it "should return postal_address on postal_address_one" do
+      FooBarMultiple.new.postal_address_one.should eql("RECIPIENT\nSTREET\nCITY STATE ZIP\nUnited States of America")
+    end
+
+    it "should return postal_address with alt country on postal_address_two" do
+      FooBarMultiple.new.postal_address_two.should eql("RECIPIENT\nSTREET\nCITY STATE ZIP\nalt country")
+    end
+  end
+
+end

metadata

@@ -1,78 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: biggs
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Sebastian Munz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
 description: biggs is a small ruby gem/rails plugin for formatting postal addresses
@@ -83,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rvmrc"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -105,33 +110,25 @@ files:
 - spec/unit/format_spec.rb
 homepage: https://github.com/yolk/biggs
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -746915506577537361
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -746915506577537361
 requirements: []
-rubyforge_project: biggs
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
 summary: biggs is a small ruby gem/rails plugin for formatting postal addresses from
   over 60 countries.
 test_files: