biggs 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01c45617723b2d38b705c737fedf6bd560e9211c1ef834272cd9c4fd8f09814
-  data.tar.gz: 63763d95d695fe3078517c2f1e4cc80246dec8a53e6e8191c69fd71feb49d222
+  metadata.gz: 72743e6a2efe86f4e3954f6783380627afa89d944c0f23eb8f5e05ae271c24aa
+  data.tar.gz: eadb5928335ad7a9dfe362fcfa3bf7bc6b156ad0a0051c046c680c39188cd020
 SHA512:
-  metadata.gz: 891ec94ea1236687a03296b4904740b5b28f391bc5de769ad5d78d6f9cb4fd3225399823c60e1de18145706b29940d0cea0a556cc1ec2b5f0a4a832645c14f92
-  data.tar.gz: 10383285215245585fca93d53377804c759beb43484f333421e7874768455dfbdb47b117885c466708a45f1501a0d410890c725ae0871db6c476553ac63b2205
+  metadata.gz: 5deb05a75009544a7439169f7fb12bacff1ec3643b51b9715f44eb0866961dee09138ceb87702c8d1977b4643f41531be85646fd0bd91b551030b5855ff0c8a2
+  data.tar.gz: 17bc4a86075d4c56b3128d0a1d209f06446ca9437095cdb921393179d6335a3559b30524ee4d11e9ba8da747900859e95370748cc8c627d88d1e81ddc1f2ced3

data/CHANGES.md

@@ -1,5 +1,22 @@
 ### dev
 
+### 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
+
+### 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

data/README.md

@@ -37,10 +37,10 @@ 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::ActiveRecordAdapter
+    class Address
+      include Biggs
 
       biggs :postal_address
     end
@@ -49,8 +49,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::ActiveRecordAdapter
+    class Address
+      include Biggs
 
       biggs :postal_address,
             :zip => :postal_code,
@@ -62,8 +62,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::ActiveRecordAdapter
+    class Address
+      include Biggs
 
       biggs :postal_address,
             :recipient => [:company_name, :person_name]
@@ -73,7 +73,7 @@ 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
+    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.
 
@@ -147,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 to 7
+biggs is tested to behave well with ActiveSupport 3 to 7
 
 Copyright (c) 2009-2022 Yolk Sebastian Munz & Julia Soergel GbR

data/biggs.gemspec

@@ -19,7 +19,7 @@ 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',       '>= 3.0'
   s.add_development_dependency 'rspec-its'

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,38 @@
+module Biggs
+  class Extractor
+    def initialize(options)
+      @value_methods = Biggs::Formatter::FIELDS.reduce({}) do |methods, field|
+        methods[field] = options[field] if options[field] || options[field] == false
+        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)
+      return if @value_methods[field] == false
+
+      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$/, "")
+      format_string.strip
     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.4.0"
+  VERSION = "0.6.0"
 end

data/lib/biggs.rb

@@ -1,19 +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
+  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
 
-    def country_names
-      @@country_names ||= YAML.load_file(File.join(File.dirname(__FILE__), '..', 'country_names.yml')) || {}
-    end
-  end
-end
+  extend ActiveSupport::Concern
 
-if defined?(ActiveRecord) and defined?(ActiveRecord::Base) and !ActiveRecord::Base.respond_to?(:biggs_formatter)
-  require 'biggs/activerecord'
+  included do
+    include Biggs::Concern
+  end
 end

data/spec/spec_helper.rb

@@ -5,16 +5,6 @@ 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,9 +1,7 @@
-require 'rubygems'
-require 'active_record'
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
-class BaseTable < ActiveRecord::Base
-  include Biggs::ActiveRecordAdapter
+class BaseClass
+  include Biggs
 
   Biggs::Formatter::FIELDS.each do |field|
     define_method(field) do
@@ -12,13 +10,13 @@ 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
 
@@ -31,7 +29,7 @@ class FooBarCustomFields < BaseTable
   end
 end
 
-class FooBarCustomBlankDECountry < BaseTable
+class FooBarCustomBlankDECountry < BaseClass
   biggs :postal_address, :blank_country_on => "de"
 
   def country
@@ -39,11 +37,11 @@ class FooBarCustomBlankDECountry < BaseTable
   end
 end
 
-class FooBarCustomMethod < BaseTable
+class FooBarCustomMethod < BaseClass
   biggs :my_postal_address_method
 end
 
-class FooBarCustomProc < BaseTable
+class FooBarCustomProc < BaseClass
   biggs :postal_address,
         :country => Proc.new {|it| it.method_accessed_from_proc + "XX"},
         :state => Proc.new {|it| it.state.downcase }
@@ -53,7 +51,7 @@ class FooBarCustomProc < BaseTable
   end
 end
 
-class FooBarCustomArray < BaseTable
+class FooBarCustomArray < BaseClass
   biggs :postal_address,
         :street => [:address_1, :address_empty, :address_nil, :address_2]
 
@@ -74,20 +72,17 @@ class FooBarCustomArray < BaseTable
   end
 end
 
-class FooBarMultiple < BaseTable
+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::ActiveRecordAdapter" do
-    FooBar.included_modules.should be_include(Biggs::ActiveRecordAdapter)
+  it "should include Biggs::Concern" do
+    FooBar.included_modules.should be_include(Biggs::Concern)
   end
 
   it "should set class value biggs_config" do
@@ -99,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
@@ -158,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biggs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sebastian Munz
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,13 +100,14 @@ 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: []
@@ -133,6 +134,6 @@ summary: biggs is a small ruby gem/rails plugin for formatting postal addresses
   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,64 +0,0 @@
-require 'active_support/core_ext/class/attribute'
-
-module Biggs
-  module ActiveRecordAdapter
-    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
-          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_config = self.biggs_config.dup
-
-        self.biggs_config[method_name] = {
-          instance: Biggs::Formatter.new(options),
-          value_methods: value_methods
-        }
-      end
-    end
-
-    module Helpers
-      def self.biggs_values(instance, value_methods)
-        values = {}
-        (Biggs::Formatter::FIELDS - [:country]).each do |field|
-          values[field] = self.biggs_get_value(instance, field, value_methods)
-        end
-        values
-      end
-
-      def self.biggs_get_value(instance, field, value_methods)
-        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
-end