widgeo 0.0.2

data/lib/widgeo.rb

@@ -0,0 +1,14 @@
+require "widgeo/version"
+require "widgeo/collection"
+require "widgeo/model"
+require "widgeo/continent"
+require "widgeo/territory"
+
+module Widgeo
+
+  require "yaml"
+
+  class UndefinedDatasetError < StandardError; end
+  class UndefinedFieldError < StandardError; end
+
+end

data/lib/widgeo/collection.rb

@@ -0,0 +1,40 @@
+module Widgeo
+
+  module Collection
+
+    # Set/Get the dataset file name
+    def dataset_file file_name = nil
+
+      @dataset_file ||= file_name
+
+    end
+
+    # Return the dataset
+    def dataset
+
+      # Raise an exception if the dataset file has not been set on the class
+      raise UndefinedDatasetError unless dataset_file
+
+      @dataset ||= YAML.load_file(
+        File.join(File.dirname(__FILE__), "../", "data", "#{dataset_file}.yml")
+      )
+
+    end
+
+    # Find an item by an attribute
+    def find_by attribute, value
+
+      all.detect { |continent| continent.send(attribute) == value }
+
+    end
+
+    # Parse full list and memoize it
+    def all
+
+      @all ||= dataset.map { |item| self.new item }
+
+    end
+
+  end
+
+end

data/lib/widgeo/continent.rb

@@ -0,0 +1,14 @@
+module Widgeo
+
+  class Continent
+
+    extend Widgeo::Collection
+    include Widgeo::Model
+
+    attr_reader :name, :alpha_2
+
+    dataset_file :continents
+
+  end
+
+end

data/lib/widgeo/model.rb

@@ -0,0 +1,21 @@
+module Widgeo
+
+  module Model
+
+    # Set attributes on the instance
+    def initialize properties
+
+      properties.each { |name, value|
+
+        # Raise an exception if we don't have a getter for the property
+        raise UndefinedFieldError unless respond_to? name
+
+        instance_variable_set("@#{name}", value)
+
+      }
+
+    end
+
+  end
+
+end

data/lib/widgeo/territory.rb

@@ -0,0 +1,21 @@
+module Widgeo
+
+  class Territory
+
+    extend Widgeo::Collection
+    include Widgeo::Model
+
+    attr_reader :name, :long_name, :alpha_2, :continent_alpha_2
+
+    dataset_file :territories
+
+    # Load an instance of the continent
+    def continent
+
+      Continent.find_by :alpha_2, continent_alpha_2
+
+    end
+
+  end
+
+end

data/lib/widgeo/version.rb

@@ -0,0 +1,3 @@
+module Widgeo
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "widgeo"

data/spec/widgeo/continent_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Widgeo::Continent do
+
+  CONTINENT_COUNT = 7
+  INVALID_CONTINENT = { bad_field: "BAD FIELD" }
+  CONTINENT_ALPHA = "EU"
+  VALID_CONTINENT = { name: "Beatland", alpha_2: "BE" }
+  CONTINENT_FIELDS = [:name, :alpha_2]
+
+  subject { Widgeo::Continent.new VALID_CONTINENT }
+
+  it { is_expected.to respond_to *CONTINENT_FIELDS }
+
+  context "given an invalid dataset" do
+
+    subject { -> { Widgeo::Continent.new INVALID_CONTINENT } }
+
+    it { is_expected.to raise_error Widgeo::UndefinedFieldError }
+
+  end
+
+  describe ".find_by" do
+
+    subject(:continent) { Widgeo::Continent.find_by :alpha_2, CONTINENT_ALPHA }
+
+    it { expect(continent).to be_kind_of Widgeo::Continent }
+    it { expect(continent.alpha_2).to eq CONTINENT_ALPHA }
+
+  end
+
+  describe ".all" do
+
+    subject(:continents) { Widgeo::Continent.all }
+
+    it { expect(continents).to be_kind_of Array }
+    it { expect(continents.size).to be CONTINENT_COUNT }
+    it { expect(continents.first).to be_kind_of Widgeo::Continent }
+
+  end
+
+end

data/spec/widgeo/territory_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Widgeo::Territory do
+
+  TERRITORY_COUNT = 254
+  INVALID_TERRITORY = { bad_field: "BAD FIELD" }
+  TERRITORY_ALPHA = "GB"
+  PARENT_CONTINENT_ALPHA = "EU"
+
+  VALID_TERRITORY = {
+    name: "Beatland", long_name: "Peoples republic of Beatland",
+    alpha_2: "BE", continent_alpha_2: "EU"
+  }
+
+  TERRITORY_FIELDS = [:name, :long_name, :alpha_2, :continent_alpha_2]
+
+  subject { Widgeo::Territory.new VALID_TERRITORY }
+
+  it { is_expected.to respond_to *TERRITORY_FIELDS }
+
+  context "given an invalid dataset" do
+
+    subject { -> { Widgeo::Territory.new INVALID_TERRITORY } }
+
+    it { is_expected.to raise_error Widgeo::UndefinedFieldError }
+
+  end
+
+  describe "#continent" do
+
+    subject (:continent) {
+      Widgeo::Territory.find_by(:alpha_2, TERRITORY_ALPHA).continent
+    }
+
+    it { expect(continent).to be_kind_of Widgeo::Continent }
+    it { expect(continent.alpha_2).to eq PARENT_CONTINENT_ALPHA }
+
+  end
+
+  describe ".find_by" do
+
+    subject(:territory) { Widgeo::Territory.find_by :alpha_2, TERRITORY_ALPHA }
+
+    it { expect(territory).to be_kind_of Widgeo::Territory }
+    it { expect(territory.alpha_2).to eq TERRITORY_ALPHA }
+
+  end
+
+  describe ".all" do
+
+    subject(:territories) { Widgeo::Territory.all }
+
+    it { expect(territories).to be_kind_of Array }
+    it { expect(territories.size).to be TERRITORY_COUNT }
+    it { expect(territories.first).to be_kind_of Widgeo::Territory }
+
+  end
+
+end

data/widgeo.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'widgeo/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "widgeo"
+  spec.version       = Widgeo::VERSION
+  spec.authors       = ["Chris G"]
+  spec.email         = ["chris@abstraktion.co.uk"]
+  spec.summary       = "Provides easy access to the worlds territories and their continents."
+  spec.description   = "Listing and filtering of continents and territories. Includes short names, long names and alpha codes, following the ISO 3166 standard."
+  spec.homepage      = "https://github.com/BeatrootApp/Widgeo"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec", "~> 3.1"
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: widgeo
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris G
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Listing and filtering of continents and territories. Includes short names,
+  long names and alpha codes, following the ISO 3166 standard.
+email:
+- chris@abstraktion.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/data/continents.yml
+- lib/data/territories.yml
+- lib/widgeo.rb
+- lib/widgeo/collection.rb
+- lib/widgeo/continent.rb
+- lib/widgeo/model.rb
+- lib/widgeo/territory.rb
+- lib/widgeo/version.rb
+- spec/spec_helper.rb
+- spec/widgeo/continent_spec.rb
+- spec/widgeo/territory_spec.rb
+- widgeo.gemspec
+homepage: https://github.com/BeatrootApp/Widgeo
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides easy access to the worlds territories and their continents.
+test_files:
+- spec/spec_helper.rb
+- spec/widgeo/continent_spec.rb
+- spec/widgeo/territory_spec.rb