biggs 0.5.1 → 0.7.0

checksums.yaml

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

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1", "3.2", ruby-head]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # 'bundle install' and cache gems
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run: bundle exec rake

data/CHANGES.md

@@ -1,5 +1,14 @@
 ### dev
 
+### 0.7.0 / 2023-12-01
+
+* Added formatter option: remove_empty_lines
+
+### 0.6.0 / 2022-04-08
+
+* Remove not only trailing but also leading newline from formatted address
+* Biggs::Concern Allow passing false as field to add blank string
+
 ### 0.5.1 / 2022-04-08
 
 * Biggs::Extractor: small refactorings + don't delete options

data/README.md

@@ -8,15 +8,17 @@ As a ruby gem:
 
 ### Standalone usage
 
-    f = Biggs::Formatter.new
-
-    f.format("de", # <= ISO alpha 2 code
-      :recipient  => "Yolk Sebastian Munz & Julia Soergel GbR",
-      :street     => "Musterallee 12", # <= street + house number
-      :city       => "Ausgedacht",
-      :zip        => 12345,
-      :state      => "Nowhere" # <= state/province/region
-    )
+```ruby
+f = Biggs::Formatter.new
+
+f.format("de", # <= ISO alpha 2 code
+  :recipient  => "Yolk Sebastian Munz & Julia Soergel GbR",
+  :street     => "Musterallee 12", # <= street + house number
+  :city       => "Ausgedacht",
+  :zip        => 12345,
+  :state      => "Nowhere" # <= state/province/region
+)
+```
 
 returns
 
@@ -29,7 +31,9 @@ At the moment Biggs::Formatter.new accepts only one option:
 
 *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")
+```ruby
+Biggs::Formatter.new(blank_country_on: "de")
+```
 
 With the data from the above example this would return:
 
@@ -37,43 +41,51 @@ With the data from the above example this would return:
     Musterallee 12
     12345 Ausgedacht"
 
-### Usage with Rails and ActiveRecord
+### Usage with Class
 
-    Address < ActiveRecord::Base
-      include Biggs
+```ruby
+class Address
+  include Biggs
 
-      biggs :postal_address
-    end
+  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').
 
 You can customize the method-names biggs will use by passing in a hash of options:
 
-    Address < ActiveRecord::Base
-      include Biggs
+```ruby
+class Address
+  include Biggs
 
-      biggs :postal_address,
-            :zip => :postal_code,
-            :country => :country_code,
-            :street => Proc.new {|address| "#{address.street} #{address.house_number}" }
-    end
+  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 even pass in a array of symbols:
 
-    Address < ActiveRecord::Base
-      include Biggs
+```ruby
+class Address
+  include Biggs
 
-      biggs :postal_address,
-            :recipient => [:company_name, :person_name]
-    end
+  biggs :postal_address,
+        :recipient => [:company_name, :person_name]
+end
+```
 
 This will call the methods company_name and person_name on your address-instance, remove any blank returned values and join the rest by a line break.
 
 To access the formatted address string, simply call the provided method on an address instance:
 
-    Address.find(1).postal_address
+```ruby
+Address.new.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.
 
@@ -149,4 +161,4 @@ biggs knows how to format addresses of over 60 different countries. If you are m
 
 biggs is tested to behave well with ActiveSupport 3 to 7
 
-Copyright (c) 2009-2022 Yolk Sebastian Munz & Julia Soergel GbR
+Copyright (c) 2009-2023 mite GmbH

data/country_names.yml

@@ -50,6 +50,7 @@ co: Colombia
 cr: Costa Rica
 cu: Cuba
 cv: Cape Verde
+cw: Curaçao
 cx: Christmas Island
 cy: Cyprus
 cz: Czech Republic
@@ -239,6 +240,7 @@ vn: Vietnam
 vu: Vanuatu
 wf: Wallis and Futuna
 ws: Samoa
+xk: Kosovo
 ye: Yemen
 yt: Mayotte
 za: South Africa

data/formats.yml

@@ -68,6 +68,11 @@ cn: |-
     {{street}}
     {{zip}} {{city}} {{state}}
     {{country}}
+cw: |-
+    {{recipient}}
+    {{street}}
+    {{zip}} {{city}}
+    {{country}}
 cz: |-
     {{recipient}}
     {{street}}
@@ -343,6 +348,11 @@ us: |-
     {{street}}
     {{city}} {{state}} {{zip}}
     {{country}}
+xk: |-
+    {{recipient}}
+    {{street}}
+    {{zip}} {{city}}
+    {{country}}
 ye: |-
     {{recipient}}
     {{street}}

data/lib/biggs/extractor.rb

@@ -2,7 +2,7 @@ module Biggs
   class Extractor
     def initialize(options)
       @value_methods = Biggs::Formatter::FIELDS.reduce({}) do |methods, field|
-        methods[field] = options[field] if options[field]
+        methods[field] = options[field] if options[field] || options[field] == false
         methods
       end
     end
@@ -15,6 +15,8 @@ module Biggs
     end
 
     def get_value(instance, field)
+      return if @value_methods[field] == false
+
       key = @value_methods[field] || field
 
       case key

data/lib/biggs/formatter.rb

@@ -6,6 +6,7 @@ module Biggs
 
     def initialize(options={})
       @blank_country_on = [options[:blank_country_on]].compact.flatten.map{|s| s.to_s.downcase}
+      @remove_empty_lines = !!options[:remove_empty_lines]
     end
 
     def format(iso_code, values={})
@@ -19,7 +20,8 @@ module Biggs
         format_string.gsub!(/\{\{#{key}\}\}/, (values[key] || "").to_s)
       end
       format_string.gsub!(/\{\{country\}\}/, country_name)
-      format_string.gsub(/\n$/, "")
+      format_string.gsub!(/\n(\s+)?\n/, "\n") if @remove_empty_lines
+      format_string.strip
     end
 
     attr_accessor :blank_country_on, :default_country_without_state, :default_country_with_state

data/lib/biggs/version.rb

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

data/lib/biggs.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'active_support/core_ext'
 require 'biggs/format'
 require 'biggs/formatter'
 require 'biggs/concern'

data/spec/unit/biggs_spec.rb

@@ -4,33 +4,33 @@ FAKE_ATTR_WITH_STATE = {:state => "STATE", :city => "CITY", :zip => 12345, :stre
 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 of America")
   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
-  
+
   it "should format to no(rwegian) format" do
     @biggs.format('no', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\n12345 CITY\nNorway")
   end
@@ -38,43 +38,56 @@ describe Biggs::Formatter, "with defaults" do
   it "should format to NC format" do
     @biggs.format('nc', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\n12345 CITY\nNew Caledonia")
   end
-  
+
   it "should use country name if Country is known but format not" do
     @biggs.format('af', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY\nAfghanistan")
   end
-  
+
   it "should use ISO Code if Country is unknown" do
     @biggs.format('xx', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\n12345 CITY\nxx")
   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
+
+  describe "remove_empty_lines" do
+    before { @biggs = Biggs::Formatter.new(:remove_empty_lines => true) }
+
+
+    it "should remove empty lines" do
+      @biggs.format('gb', FAKE_ATTR_WO_STATE).should eql("MR. X\nSTREET\nCITY\n12345\nUnited Kingdom")
+    end
+
+    it "should format normally without empty lines" do
+      @biggs.format('gb', FAKE_ATTR_WITH_STATE).should eql("MR. X\nSTREET\nCITY\nSTATE\n12345\nUnited Kingdom")
+    end
+
   end
-  
-end
+end

data/spec/unit/concern_spec.rb

@@ -75,14 +75,11 @@ end
 class FooBarMultiple < BaseClass
   biggs :postal_address_one
   biggs :postal_address_two,
-        country: :alt_country
-
-  def alt_country
-    "Alt country"
-  end
+        country: false,
+        recipient: false
 end
 
-describe "ActiveRecord Class" do
+describe "Extended Class" do
 
   it "should include Biggs::Concern" do
     FooBar.included_modules.should be_include(Biggs::Concern)
@@ -97,7 +94,7 @@ describe "ActiveRecord Class" do
   end
 end
 
-describe "ActiveRecord Instance" do
+describe "Extended Class Instance" do
 
   describe "Empty" do
     it "should not have postal_address method" do
@@ -156,7 +153,7 @@ describe "ActiveRecord Instance" do
     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")
+      FooBarMultiple.new.postal_address_two.should eql("STREET\nCITY STATE ZIP")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biggs
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Sebastian Munz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rvmrc"
 - CHANGES.md
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: biggs is a small ruby gem/rails plugin for formatting postal addresses from