biggs 0.3.3 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b305ad58e72593f21215121377ae70f2d17bd29a2d61f3265230f44c9e0c3092
+  data.tar.gz: 34566de6851e95ebc713110a6822498fa9da24c5fed7e158a7f53676ce11ce51
+SHA512:
+  metadata.gz: 34c29129d47a847e79e81793724f57a06ad89955004f240f154c491cb5bb7a35c68d49d7af52e9c66c609fae7335c5b2d7733f515287d7f7f68145e86665c845
+  data.tar.gz: 577f6f7d55229a2f5c3e6a9b0b4d5dd5badb488551da4ec6eadf8189ac6dd1ab4ab9ef56e176c2308fd9dd7eff29db9a8698157279a1cb4976e814bb7053e4f8

data/CHANGES.md

@@ -1,5 +1,22 @@
 ### dev
 
+### 0.5.1 / 2022-04-08
+
+* Biggs::Extractor: small refactorings + don't delete options
+
+### 0.5.0 / 2022-04-08
+
+* Refactored Biggs::Concern to use Biggs::Extractor
+* Removed activerecord dependency and use only activesupport instead
+* Renamed Biggs::ActiveRecordAdapter to Biggs::Concern, include with 'include Biggs'
+* Optimization: Added Biggs::Formatter::FIELDS_WO_COUNTRY
+* Moved Biggs.formats and Biggs.country_names to Constants Biggs::FORMATS & Biggs::COUNTRY_NAMES
+
+### 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))

data/README.md

@@ -4,11 +4,7 @@ biggs is a small ruby gem/rails plugin for formatting postal addresses from over
 
 As a ruby gem:
 
-    sudo gem install 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
 
@@ -16,34 +12,36 @@ If your rather prefer to install it as a plugin for rails, from your application
 
     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
+      :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).
+*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_county_on => "de")
+    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
+
       biggs :postal_address
     end
 
@@ -52,6 +50,8 @@ This adds the method postal_address to your Address-model, and assumes the prese
 You can customize the method-names biggs will use by passing in a hash of options:
 
     Address < ActiveRecord::Base
+      include Biggs
+
       biggs :postal_address,
             :zip => :postal_code,
             :country => :country_code,
@@ -63,6 +63,8 @@ You can pass in a symbol to let biggs call a different method on your Address-mo
 You can even pass in a array of symbols:
 
     Address < ActiveRecord::Base
+      include Biggs
+
       biggs :postal_address,
             :recipient => [:company_name, :person_name]
     end
@@ -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, 3.1, 3.2 and 4.0
+biggs is tested to behave well with ActiveSupport 3 to 7
 
-Copyright (c) 2009-2013 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 'activesupport',            '>= 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/concern.rb

@@ -0,0 +1,34 @@
+require 'active_support'
+require 'active_support/core_ext/class/attribute'
+require 'biggs/extractor'
+require 'biggs/formatter'
+
+module Biggs
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :biggs_config, default: {}
+    end
+
+    class_methods do
+      def biggs(method_name=:postal_address, options={})
+        self.define_method(method_name) do
+          formatter = self.biggs_config[method_name][:formatter]
+          extractor = self.biggs_config[method_name][:extractor]
+          formatter.format(
+            extractor.get_value(self, :country),
+            extractor.get_values(self)
+          )
+        end
+
+        self.biggs_config = self.biggs_config.dup
+
+        self.biggs_config[method_name] = {
+          formatter: Biggs::Formatter.new(options),
+          extractor: Biggs::Extractor.new(options)
+        }
+      end
+    end
+  end
+end

data/lib/biggs/extractor.rb

@@ -0,0 +1,36 @@
+module Biggs
+  class Extractor
+    def initialize(options)
+      @value_methods = Biggs::Formatter::FIELDS.reduce({}) do |methods, field|
+        methods[field] = options[field] if options[field]
+        methods
+      end
+    end
+
+    def get_values(instance)
+      Biggs::Formatter::FIELDS_WO_COUNTRY.inject({}) do |values, field|
+        values[field] = get_value(instance, field)
+        values
+      end
+    end
+
+    def get_value(instance, field)
+      key = @value_methods[field] || field
+
+      case key
+      when Symbol
+        instance.send(key.to_sym)
+      when Proc
+        key.call(instance).to_s
+      when Array
+        if key.all?{|it| it.is_a?(Symbol) }
+          key.map{|method| instance.send(method) }.reject(&:blank?).join("\n")
+        else
+          raise "Biggs: Can't handle #{field} type Array with non-symbolic entries"
+        end
+      else
+        raise "Biggs: Can't handle #{field} type #{key.class}"
+      end
+    end
+  end
+end

data/lib/biggs/format.rb

@@ -4,8 +4,8 @@ module Biggs
 
     def initialize(iso_code)
       @iso_code = iso_code.to_s.downcase
-      @country_name = Biggs.country_names[@iso_code]
-      @format_string = Biggs.formats[@iso_code]
+      @country_name = Biggs::COUNTRY_NAMES[@iso_code]
+      @format_string = Biggs::FORMATS[@iso_code]
     end
 
     class << self
@@ -20,4 +20,4 @@ module Biggs
       end
     end
   end
-end
+end

data/lib/biggs/formatter.rb

@@ -1,12 +1,13 @@
 module Biggs
   class Formatter
-    
-    FIELDS = [:recipient, :street, :city, :state, :zip, :country]
-    
+
+    FIELDS_WO_COUNTRY = [:recipient, :street, :city, :state, :zip].freeze
+    FIELDS = (FIELDS_WO_COUNTRY + [:country]).freeze
+
     def initialize(options={})
       @blank_country_on = [options[:blank_country_on]].compact.flatten.map{|s| s.to_s.downcase}
     end
-  
+
     def format(iso_code, values={})
       values.symbolize_keys! if values.respond_to?(:symbolize_keys!)
 
@@ -14,22 +15,22 @@ module Biggs
       format_string = (format.format_string || default_format_string(values[:state])).dup.to_s
       country_name = blank_country_on.include?(format.iso_code) ? "" : format.country_name || format.iso_code
 
-      (FIELDS - [:country]).each do |key|
+      FIELDS_WO_COUNTRY.each do |key|
         format_string.gsub!(/\{\{#{key}\}\}/, (values[key] || "").to_s)
       end
       format_string.gsub!(/\{\{country\}\}/, country_name)
       format_string.gsub(/\n$/, "")
     end
-  
+
     attr_accessor :blank_country_on, :default_country_without_state, :default_country_with_state
-  
+
     private
-    
+
     def default_format_string(state)
       state && state != "" ?
-        Biggs.formats[default_country_with_state || "us"] :
-        Biggs.formats[default_country_without_state || "fr"]
+        Biggs::FORMATS[default_country_with_state || "us"] :
+        Biggs::FORMATS[default_country_without_state || "fr"]
     end
   end
-  
-end
+
+end

data/lib/biggs/version.rb

@@ -1,3 +1,3 @@
 module Biggs
-  VERSION = "0.3.3"
-end
+  VERSION = "0.5.1"
+end

data/lib/biggs.rb

@@ -1,20 +1,16 @@
+require 'active_support'
 require 'biggs/format'
 require 'biggs/formatter'
+require 'biggs/concern'
 require 'yaml'
 
 module Biggs
-  class << self
-    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
+  FORMATS = (YAML.load_file(File.join(File.dirname(__FILE__), '..', 'formats.yml')) || {}).freeze
+  COUNTRY_NAMES = (YAML.load_file(File.join(File.dirname(__FILE__), '..', 'country_names.yml')) || {}).freeze
+
+  extend ActiveSupport::Concern
+
+  included do
+    include Biggs::Concern
   end
 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

data/spec/spec_helper.rb

@@ -1,15 +1,10 @@
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'rubygems'
 require 'rspec'
+require 'rspec/its'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'biggs')
 require 'logger'
 
-ActiveRecord::Base.logger = Logger.new('/tmp/biggs.log')
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => '/tmp/biggs.sqlite')
-ActiveRecord::Migration.verbose = false
-
-ActiveRecord::Schema.define do
-  create_table :base_tables, :force => true do |table|
-    table.string :name
-  end
-end
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end

data/spec/unit/{activerecord_spec.rb → concern_spec.rb}

@@ -1,8 +1,8 @@
-require 'rubygems'
-require 'active_record'
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
-class BaseTable < ActiveRecord::Base
+class BaseClass
+  include Biggs
+
   Biggs::Formatter::FIELDS.each do |field|
     define_method(field) do
       field == :country ? "us" : field.to_s.upcase
@@ -10,101 +10,106 @@ class BaseTable < ActiveRecord::Base
   end
 end
 
-class FooBarEmpty < BaseTable;end
+class FooBarEmpty < BaseClass;end
 
-class FooBar < BaseTable
+class FooBar < BaseClass
   biggs :postal_address
 end
 
-class FooBarCustomFields < BaseTable
+class FooBarCustomFields < BaseClass
   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 < BaseTable
+class FooBarCustomBlankDECountry < BaseClass
   biggs :postal_address, :blank_country_on => "de"
-  
+
   def country
     "DE"
   end
 end
 
-class FooBarCustomMethod < BaseTable
+class FooBarCustomMethod < BaseClass
   biggs :my_postal_address_method
 end
 
-class FooBarCustomProc < BaseTable
-  biggs :postal_address, 
-        :country => Proc.new {|it| it.method_accessed_from_proc + "XX"}, 
+class FooBarCustomProc < BaseClass
+  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,  
+class FooBarCustomArray < BaseClass
+  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)
+class FooBarMultiple < BaseClass
+  biggs :postal_address_one
+  biggs :postal_address_two,
+        country: :alt_country
+
+  def alt_country
+    "Alt country"
   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
+
+describe "ActiveRecord Class" do
+
+  it "should include Biggs::Concern" do
+    FooBar.included_modules.should be_include(Biggs::Concern)
   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 +126,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,80 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: biggs
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.3
+  version: 0.5.1
 platform: ruby
 authors:
 - Sebastian Munz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    none: false
-  name: activerecord
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
-    none: false
-  name: rspec
+        version: '3.0'
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
-    none: false
+        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: 1.3.5
-    none: false
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
-    none: false
 description: biggs is a small ruby gem/rails plugin for formatting postal addresses
   from over 60 countries.
 email:
@@ -83,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rvmrc"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -95,41 +100,40 @@ files:
 - formats.yml
 - init.rb
 - lib/biggs.rb
-- lib/biggs/activerecord.rb
+- lib/biggs/concern.rb
+- lib/biggs/extractor.rb
 - lib/biggs/format.rb
 - lib/biggs/formatter.rb
 - lib/biggs/version.rb
 - spec/spec_helper.rb
-- spec/unit/activerecord_spec.rb
 - spec/unit/biggs_spec.rb
+- spec/unit/concern_spec.rb
 - 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
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
-rubyforge_project: biggs
-rubygems_version: 1.8.23
-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:
 - spec/spec_helper.rb
-- spec/unit/activerecord_spec.rb
 - spec/unit/biggs_spec.rb
+- spec/unit/concern_spec.rb
 - spec/unit/format_spec.rb

data/lib/biggs/activerecord.rb

@@ -1,68 +0,0 @@
-require 'active_support/core_ext/class/attribute'
-
-module Biggs
-  module ActiveRecordAdapter
-    
-    def self.included(base)
-      base.extend(InitialClassMethods)
-    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)
-
-        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)
-      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
-        values = {}
-        (Biggs::Formatter::FIELDS - [:country]).each do |field|
-          values[field] = biggs_get_value(field)
-        end
-        values
-      end
-      
-      def biggs_get_value(field)
-        key = self.class.biggs_value_methods[field.to_sym] || field.to_sym
-        
-        case key
-        when Symbol
-          self.send(key.to_sym)
-        when Proc
-          key.call(self).to_s
-        when Array
-          if key.all?{|it| it.is_a?(Symbol) }
-            key.map{|method| self.send(method) }.reject(&:blank?).join("\n")
-          else
-            raise "Biggs: Can't handle #{field} type Array with non-symbolic entries"
-          end
-        else
-          raise "Biggs: Can't handle #{field} type #{key.class}"
-        end
-      end
-    end
-  end
-end