worldly 0.0.1

data/lib/worldly/country.rb

@@ -0,0 +1,159 @@
+module Worldly
+  class Country
+    Data = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'data/countries.yml')) || {}
+
+    attr_reader :data, :code
+
+    def initialize(code)
+      @code = code.to_s.upcase
+      @data = symbolize_keys(Data[@code])
+    end
+
+    def name
+      @data[:name]
+    end
+
+    def alpha2
+      @data[:alpha2]
+    end
+
+    def alpha3
+      @data[:alpha3]
+    end
+
+    def country_code
+      @data[:country_code]
+    end
+
+    def address_format
+      @data[:address_format] || "{{address1}}\n{{address2}}\n{{city}}\n{{country}}"
+    end
+
+    def all_fields
+      [:address1, :address2, :country] + fields.keys
+    end
+
+    # Generate an address for printing based on the countries address format.
+    # attributes = {address1: '12 hey St', address2: '', locality:'Homeville', postcode: 'AHZ 312' }
+    # sending country = 'AU'. If added the country name will be excluded from address
+    def to_print(attributes, sending_country=nil)
+      # don't add country if sending from country
+      unless sending_country.to_s.upcase == @code
+        attributes.merge!({ country: name})
+      end
+      print = address_format.dup
+      all_fields.each do |f|
+        print.gsub!("{{#{f}}}", format_values(f, attributes[f].to_s) )
+      end
+      print.squeeze(' ')
+      .gsub(/\A\s+\n|\n\s+|\s+\n\s+\Z/, "\n")
+      .squeeze("\n")
+      .strip
+    end
+
+    def has_field?(f)
+      fields.key?(f)
+    end
+
+    def required_fields
+      fields.select{|k,v| v[:required] }
+    end
+
+    def fields
+      @fields ||= build_fields
+    end
+
+    def region_options
+      regions.to_a.map{|r| [ r[1], r[0] ] }
+    end
+
+    def regions?
+      @has_regions ||= File.exist?(region_file_path)
+    end
+
+    def has_regions?(f)
+      f == :region && regions?
+    end
+
+    def regions
+      @regions ||= (regions? ? YAML.load_file(region_file_path) : {})
+    end
+
+    class << self
+
+      def new(code)
+        if self.exists?(code)
+          super
+        end
+      end
+
+      def exists?(code)
+        Data.key?(code.to_s.upcase)
+      end
+
+      def all
+        Data.map{ |country, data| [data['name'], country] }.sort
+      end
+
+      def [](code)
+        self.new(code.to_s.upcase)
+      end
+    end
+
+    private
+
+    def region_file_path
+      File.join(File.dirname(__FILE__), '..', "data/regions/#{@code}.yml")
+    end
+
+    def symbolize_keys(hash)
+      hash.inject({}){|result, (key, value)|
+        new_key = case key
+                  when String then key.to_sym
+                  else key
+                  end
+        new_value = case value
+                    when Hash then symbolize_keys(value)
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      }
+    end
+    # Format a value e.g :region, 'NY'
+    # apply any formatting rules
+    #  - if rule fullname included change the region to it's full name - New York
+    def format_values(field, value)
+      value.to_s.strip!
+      if !fields.key?(field) || fields[field][:format].nil?
+        return value
+      end
+      rules = fields[field][:format].dup
+      # use fullname rather than abbreviated
+      # fullname rule must be applied first!
+      if rules.delete('fullname') && regions[value]
+        value = regions[value]
+      end
+      # formatting
+      rules.each do |rule|
+        case rule
+        when 'upcase'
+          value.upcase!
+        end
+      end
+      value
+    end
+
+    # all fields are required by default unless otherwise stated
+    def build_fields
+      if @data.key?(:fields)
+        @data[:fields].each do |k,v|
+          v[:required] = true unless v.key?(:required)
+        end
+      else
+        {city: {label:'City', required: true} }
+      end
+    end
+
+  end
+end

data/lib/worldly/version.rb

@@ -0,0 +1,3 @@
+module Worldly
+  VERSION = "0.0.1"
+end

data/lib/worldly.rb

@@ -0,0 +1,3 @@
+require "worldly/version"
+require 'yaml'
+require 'worldly/country'

data/worldly.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'worldly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "worldly"
+  spec.version       = Worldly::VERSION
+  spec.authors       = ["Daniel Lewis"]
+  spec.email         = ["webmaster@adventistmedia.org.au"]
+  spec.summary       = %q{Country address formatting and telephone information}
+  spec.description   = %q{Get country address formatting rules and local fields for forms. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: worldly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: 'Get country address formatting rules and local fields for forms. '
+email:
+- webmaster@adventistmedia.org.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.gitignore
+- lib/data/countries.yml
+- lib/data/regions/AD.yml
+- lib/data/regions/AE.yml
+- lib/data/regions/AF.yml
+- lib/data/regions/AG.yml
+- lib/data/regions/AL.yml
+- lib/data/regions/AM.yml
+- lib/data/regions/AO.yml
+- lib/data/regions/AR.yml
+- lib/data/regions/AT.yml
+- lib/data/regions/AU.yml
+- lib/data/regions/AZ.yml
+- lib/data/regions/BA.yml
+- lib/data/regions/BB.yml
+- lib/data/regions/BD.yml
+- lib/data/regions/BE.yml
+- lib/data/regions/BF.yml
+- lib/data/regions/BG.yml
+- lib/data/regions/BH.yml
+- lib/data/regions/BI.yml
+- lib/data/regions/BJ.yml
+- lib/data/regions/BN.yml
+- lib/data/regions/BO.yml
+- lib/data/regions/BQ.yml
+- lib/data/regions/BR.yml
+- lib/data/regions/BS.yml
+- lib/data/regions/BT.yml
+- lib/data/regions/BW.yml
+- lib/data/regions/BY.yml
+- lib/data/regions/BZ.yml
+- lib/data/regions/CA.yml
+- lib/data/regions/CD.yml
+- lib/data/regions/CF.yml
+- lib/data/regions/CG.yml
+- lib/data/regions/CH.yml
+- lib/data/regions/CI.yml
+- lib/data/regions/CL.yml
+- lib/data/regions/CM.yml
+- lib/data/regions/CN.yml
+- lib/data/regions/CO.yml
+- lib/data/regions/CR.yml
+- lib/data/regions/CU.yml
+- lib/data/regions/CV.yml
+- lib/data/regions/CY.yml
+- lib/data/regions/CZ.yml
+- lib/data/regions/DE.yml
+- lib/data/regions/DJ.yml
+- lib/data/regions/DK.yml
+- lib/data/regions/DM.yml
+- lib/data/regions/DO.yml
+- lib/data/regions/DZ.yml
+- lib/data/regions/EC.yml
+- lib/data/regions/EE.yml
+- lib/data/regions/EG.yml
+- lib/data/regions/EH.yml
+- lib/data/regions/ER.yml
+- lib/data/regions/ES.yml
+- lib/data/regions/ET.yml
+- lib/data/regions/FI.yml
+- lib/data/regions/FJ.yml
+- lib/data/regions/FM.yml
+- lib/data/regions/FR.yml
+- lib/data/regions/GA.yml
+- lib/data/regions/GB.yml
+- lib/data/regions/GD.yml
+- lib/data/regions/GE.yml
+- lib/data/regions/GH.yml
+- lib/data/regions/GM.yml
+- lib/data/regions/GN.yml
+- lib/data/regions/GQ.yml
+- lib/data/regions/GR.yml
+- lib/data/regions/GT.yml
+- lib/data/regions/GU.yml
+- lib/data/regions/GW.yml
+- lib/data/regions/GY.yml
+- lib/data/regions/HN.yml
+- lib/data/regions/HR.yml
+- lib/data/regions/HT.yml
+- lib/data/regions/HU.yml
+- lib/data/regions/IE.yml
+- lib/data/regions/IL.yml
+- lib/data/regions/IN.yml
+- lib/data/regions/IQ.yml
+- lib/data/regions/IR.yml
+- lib/data/regions/IS.yml
+- lib/data/regions/IT.yml
+- lib/data/regions/JM.yml
+- lib/data/regions/JO.yml
+- lib/data/regions/JP.yml
+- lib/data/regions/KE.yml
+- lib/data/regions/KG.yml
+- lib/data/regions/KH.yml
+- lib/data/regions/KI.yml
+- lib/data/regions/KM.yml
+- lib/data/regions/KN.yml
+- lib/data/regions/KP.yml
+- lib/data/regions/KR.yml
+- lib/data/regions/KW.yml
+- lib/data/regions/KZ.yml
+- lib/data/regions/Ky.yml
+- lib/data/regions/LA.yml
+- lib/data/regions/LB.yml
+- lib/data/regions/LI.yml
+- lib/data/regions/LK.yml
+- lib/data/regions/LR.yml
+- lib/data/regions/LS.yml
+- lib/data/regions/LT.yml
+- lib/data/regions/LU.yml
+- lib/data/regions/LV.yml
+- lib/data/regions/LY.yml
+- lib/data/regions/MA.yml
+- lib/data/regions/MD.yml
+- lib/data/regions/ME.yml
+- lib/data/regions/MG.yml
+- lib/data/regions/MH.yml
+- lib/data/regions/ML.yml
+- lib/data/regions/MM.yml
+- lib/data/regions/MN.yml
+- lib/data/regions/MR.yml
+- lib/data/regions/MT.yml
+- lib/data/regions/MU.yml
+- lib/data/regions/MV.yml
+- lib/data/regions/MW.yml
+- lib/data/regions/MX.yml
+- lib/data/regions/MY.yml
+- lib/data/regions/MZ.yml
+- lib/data/regions/NA.yml
+- lib/data/regions/NE.yml
+- lib/data/regions/NG.yml
+- lib/data/regions/NI.yml
+- lib/data/regions/NL.yml
+- lib/data/regions/NO.yml
+- lib/data/regions/NP.yml
+- lib/data/regions/NR.yml
+- lib/data/regions/OM.yml
+- lib/data/regions/PA.yml
+- lib/data/regions/PE.yml
+- lib/data/regions/PG.yml
+- lib/data/regions/PH.yml
+- lib/data/regions/PK.yml
+- lib/data/regions/PL.yml
+- lib/data/regions/PT.yml
+- lib/data/regions/PW.yml
+- lib/data/regions/PY.yml
+- lib/data/regions/QA.yml
+- lib/data/regions/RO.yml
+- lib/data/regions/RS.yml
+- lib/data/regions/RU.yml
+- lib/data/regions/RW.yml
+- lib/data/regions/SA.yml
+- lib/data/regions/SB.yml
+- lib/data/regions/SC.yml
+- lib/data/regions/SD.yml
+- lib/data/regions/SG.yml
+- lib/data/regions/SH.yml
+- lib/data/regions/SI.yml
+- lib/data/regions/SK.yml
+- lib/data/regions/SL.yml
+- lib/data/regions/SM.yml
+- lib/data/regions/SN.yml
+- lib/data/regions/SO.yml
+- lib/data/regions/SR.yml
+- lib/data/regions/ST.yml
+- lib/data/regions/SV.yml
+- lib/data/regions/SY.yml
+- lib/data/regions/SZ.yml
+- lib/data/regions/TD.yml
+- lib/data/regions/TF.yml
+- lib/data/regions/TG.yml
+- lib/data/regions/TH.yml
+- lib/data/regions/TL.yml
+- lib/data/regions/TM.yml
+- lib/data/regions/TN.yml
+- lib/data/regions/TO.yml
+- lib/data/regions/TR.yml
+- lib/data/regions/TT.yml
+- lib/data/regions/TV.yml
+- lib/data/regions/TW.yml
+- lib/data/regions/TZ.yml
+- lib/data/regions/Tj.yml
+- lib/data/regions/UA.yml
+- lib/data/regions/UG.yml
+- lib/data/regions/UM.yml
+- lib/data/regions/US.yml
+- lib/data/regions/UY.yml
+- lib/data/regions/UZ.yml
+- lib/data/regions/VC.yml
+- lib/data/regions/VE.yml
+- lib/data/regions/VN.yml
+- lib/data/regions/VU.yml
+- lib/data/regions/YE.yml
+- lib/data/regions/ZA.yml
+- lib/data/regions/ZM.yml
+- lib/data/regions/ZW.yml
+- lib/worldly.rb
+- lib/worldly/country.rb
+- lib/worldly/version.rb
+- worldly.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Country address formatting and telephone information
+test_files: []