territorial 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e573e03b8e959ce4df6d159fda7c10887774737c
+  data.tar.gz: dfadce601cf3df79f5f6657481b7cd600edc935e
+SHA512:
+  metadata.gz: 32e958a58c5b4c3f841b3ab6ada2ce46fc32128a72e1c07095bcfbfb4be07ceba6190f61cd31681fcd32694abbdf2d5c5e59a65d769edbb35b7afaa012a39dd3
+  data.tar.gz: 15bebdfbf50eff44c8aa8920b48a7a19c87b4da46b5ab0b8a0ba1919dab4fd84e9b41dcb3b6e920445aa162f6dd9cab695417c24c8497718bd94be75059274a7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0
+  - 1.9.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in territorial.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 tape.tv AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Territorial
+
+If you have to work with lists of ISO 3166-1 alpha-2 country codes that
+sometimes include fake codes that should be expanded to a longer list, e.g.
+'EU', or if you have to deal with lists of territory metadata like 'EU -FR'
+then territorial will help. It defines some commonly seen default expansion
+codes, and allows you to correctly expand a string like 'EU -FR' into an
+array of 2-letter country codes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'territorial'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install territorial
+
+## Usage
+
+Basic region expansion is very simple:
+
+```ruby
+Territorial.expand(:GSA)
+# => ['DE', 'CH', 'AT']
+
+Territorial.expand(['GSA', EFTA'])
+# => ['DE', 'CH', 'AT', 'NO', 'LI', 'IS']
+```
+
+Available regions:
+
+* `GSA` - Germany, Switzerland, Austria
+* `EU` - European Union
+* `EFTA` - European Free Trade Association
+* `WW` - Worldwide
+
+You can instantiate a Territorial instance directly with your own extra regions
+defined, or override the defaults:
+
+```ruby
+t = Territorial.new(Anglophone: ['GB', 'US', 'CA', 'AU', 'NZ', 'ZA'])
+t.expand(:Anglophone)
+# => ['GB', 'US', 'CA', 'AU', 'NZ', 'ZA']
+```
+
+You can also parse strings listing territories and regions:
+
+```ruby
+t = Territorial.new
+t.parse('GSA -DE')
+# => ['AT', 'CH']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/territorial/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "territorial"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/territorial.rb

@@ -0,0 +1,144 @@
+require 'territorial/version'
+require 'set'
+
+# Expand regional territory shorthand codes to ISO 3166-1 alpha-2 codes and
+# parse lists of string codes like <tt>"EU -FR"</tt>
+class Territorial
+  # The default region expansions. EL and UK are European Union variants of the
+  # ISO codes GR and GB respectively.
+  EXPANSIONS = {
+    'GSA' => %w{DE CH AT},
+    'EU' => %w{
+      BE BG CZ DK DE EE IE GR ES FR HR IT CY LV LT LU HU MT NL AT PL PT RO SI
+      SK FI SE GB
+    },
+    'EFTA' => %w{CH NO LI IS},
+    'WW' => %w{
+      AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ
+      BM BT BO BQ BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC
+      CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK
+      FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT
+      HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW
+      KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX
+      FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK
+      PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS
+      SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH
+      SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU
+      VE VN VG VI WF EH YE ZM ZW
+    },
+    'EL' => %w{GR},
+    'UK' => %w{GB}
+  }
+
+  # expand regions from shorthand codes to arrays of ISO codes
+  # @return [<String>] the expanded ISO codes
+  def self.expand(*regions)
+    new.expand(*regions)
+  end
+
+  # @param extra_expansions [Hash] optional Hash of additional expansions
+  def initialize(extra_expansions = {}, bounds = [])
+    @extra_expansions = Hash[extra_expansions.map { |key, values|
+      [normalize_territory(key), normalize_territories(values)]
+    }]
+    if bounds.empty?
+      @bounds = nil
+    else
+      @bounds = expanded_set(normalize_territories(bounds))
+    end
+  end
+
+  # expand regions from shorthand codes to arrays of ISO codes
+  # @return [<String>] the expanded ISO codes
+  def expand(*regions)
+    regions = normalize_territories(regions.flatten)
+    expanded_set(regions).to_a
+  end
+
+  # Parse strings like 'EU -GB' or 'EU +RU' to fully expanded arrays of ISO
+  # codes. Expandable codes (i.e. EU) will be expanded, codes with a `-` prefix
+  # will be removed from the result and codes with a `+` prefix, or with no
+  # prefix will be added to the result. 
+  # @param territory_list [String] the list of territories (and modifiers) as a string
+  # @return [<String>] the expanded ISO codes
+  def territories(territory_list)
+    parser = Parser.new(territory_list)
+    allowed = expanded_set(parser.accept)
+    rejected = expanded_set(parser.reject)
+    (allowed - rejected).to_a
+  end
+
+  private
+
+  def normalize_territory(territory_string)
+    territory_string.to_s.upcase
+  end
+
+  def normalize_territories(territory_strings)
+    territory_strings.map { |ts| normalize_territory(ts) }
+  end
+
+  def expansions
+    @expansions ||= EXPANSIONS.merge(@extra_expansions)
+  end
+
+  def expansion_regions
+    expansions.keys
+  end
+
+  def expandable?(region)
+    expansions.has_key?(region.to_s)
+  end
+
+  def constrained(territories)
+    return territories if @bounds.nil?
+    territories & @bounds
+  end
+
+  def expanded_set(regions)
+    territories = Set.new
+    already_expanded = Set.new
+
+    expand_set(territories, regions, already_expanded)
+    constrained(territories)
+  end
+
+  def expand_set(territories, regions, already_expanded)
+    regions.inject(territories) do |territories, region|
+      if expandable?(region) && !already_expanded.include?(region)
+        territories.merge(expand_set(territories, expansions[region], already_expanded << region))
+      else
+        territories << region
+      end
+    end
+  end
+
+  class Parser
+    TOKEN = /([+-]?)([a-z]+)(?:\s|$)/i
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    def tokens
+      @tokens ||= input.scan(TOKEN)
+    end
+
+    def accept
+      @accept ||= tokens.reject { |prefix, code|
+        prefix == '-'
+      }.map { |prefix, code|
+        code
+      }
+    end
+
+    def reject
+      @reject ||= tokens.select { |prefix, code|
+        prefix == '-'
+      }.map { |prefix, code|
+        code
+      }
+    end
+  end
+end

data/lib/territorial/version.rb

@@ -0,0 +1,3 @@
+class Territorial
+  VERSION = "0.4.0"
+end

data/territorial.gemspec

@@ -0,0 +1,32 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'territorial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "territorial"
+  spec.version       = Territorial::VERSION
+  spec.authors       = ["Christof Dorner", "Matt Patterson"]
+  spec.email         = ["christof@chdorner.com", "matt@reprocessed.org"]
+
+  spec.summary       = %q{Work with lists of country codes and shorthand regions ('EU')}
+  spec.description   = <<-EOD
+If you have to work with lists of ISO 3166-1 alpha-2 country codes that
+sometimes include fake codes that should be expanded to a longer list, e.g.
+'EU', or if you have to deal with lists of territory metadata like 'EU -FR'
+then territorial will help. It defines some commonly seen default expansion
+codes, and allows you to correctly expand a string like 'EU -FR' into an
+array of 2-letter country codes
+  EOD
+  spec.homepage      = "https://github.com/tape-tv/territorial"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: territorial
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Christof Dorner
+- Matt Patterson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: |
+  If you have to work with lists of ISO 3166-1 alpha-2 country codes that
+  sometimes include fake codes that should be expanded to a longer list, e.g.
+  'EU', or if you have to deal with lists of territory metadata like 'EU -FR'
+  then territorial will help. It defines some commonly seen default expansion
+  codes, and allows you to correctly expand a string like 'EU -FR' into an
+  array of 2-letter country codes
+email:
+- christof@chdorner.com
+- matt@reprocessed.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/territorial.rb
+- lib/territorial/version.rb
+- territorial.gemspec
+homepage: https://github.com/tape-tv/territorial
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Work with lists of country codes and shorthand regions ('EU')
+test_files: []
+has_rdoc: