widgeo 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e2aa0a07dfb5675efc75c797d1e22e17a458af98
-  data.tar.gz: 61928468ade60db782e26dafc8a25166aabd27e2
+SHA256:
+  metadata.gz: 75b0f3149f3e737c6196fcef3d49c3c006c64ba09efeb2ee1470957339d45fdf
+  data.tar.gz: 0c5d3ecd23769a697ff07317b39e758ddd27b8beff2bd5f1f3224f2e9619a065
 SHA512:
-  metadata.gz: 91f8f6728d144742ae282532f2ea8388bc383b0f26f719e108494b5039aaa0150649e7f6e27ab27a66e8fec96dbd9f9542499d317899b508d2d00823d7f1f5b4
-  data.tar.gz: 6a4988c7d7b2d54e6768bbd1a2a613ef949a86e86b2d66d683ff07b276eb01280ba95238901ed8e911bb8052eacbe7afb47353c336e9437c9f9ef88ea45900f0
+  metadata.gz: a8381e432e2c16b88b37c974039fe9cac523ecf79e2ca853be975cae6296a394e798ab0d6ef25de450119c7ce8fe619e6b3e1492969095a2b27d66814e0a6bf9
+  data.tar.gz: d83b75e37671765a5c32c49cda425ee794598a7655ec99dcefcc4a23024ce8f2eb0e3f4a41c9089a671e5348d3da6de8b69f93e0f09d8316c4dc122e885a9984

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+
+Naming/VariableNumber:
+  AllowedIdentifiers:
+    - alpha_2
+    - continent_alpha_2
+
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+    - "spec/**/*"
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in widgeo.gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Chris G
+Copyright (c) 2015 Chris Garrett
 
 MIT License
 

data/README.md

@@ -6,7 +6,7 @@ Widgeo provides easy access to the worlds territories and their continents.
 
 Include Widgeo in your Gemfile, `gem "widgeo", require: true` and run `bundle install`.
 
-#### #all
+#### .all
 
 Provides a list of all items.
 
@@ -18,7 +18,15 @@ and all territories:
 
 `territories = Widgeo::Territory.all`
 
-#### #find_by
+#### .filter_by
+
+Allows for filtering a list of items.
+
+For a filtered list of territories in the EU:
+
+`territories = Widgeo::Territories.filter_by continent_alpha_2: "EU"`
+
+#### .find_by
 
 Provides a single item matching a specified property and value.
 

data/Rakefile

@@ -1,10 +1,10 @@
-require "rspec/core/rake_task"
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-
-  task.rspec_opts = ["--color"]
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
 end
 
-task :default => :spec
+task default: :spec

data/lib/widgeo/collection.rb

@@ -1,40 +1,43 @@
-module Widgeo
+# frozen_string_literal: true
 
+module Widgeo
+  # Methods for working with collection of entities
   module Collection
-
     # Set/Get the dataset file name
-    def dataset_file file_name = nil
-
+    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")
+        File.join(File.dirname(__FILE__), '../', 'data', "#{dataset_file}.yml")
       )
+    end
 
+    # Does the item match the requested attributes?
+    def matches?(item, attributes)
+      attributes.map do |attribute, value|
+        item.send(attribute) == value
+      end.flatten == [true]
     end
 
-    # Find an item by an attribute
-    def find_by attribute, value
+    # Filter the items by a combination of values
+    def filter_by(attributes)
+      all.select { |item| matches? item, attributes }
+    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 }
-
+      @all ||= dataset.map { |item| new item }
     end
-
   end
-
 end

data/lib/widgeo/continent.rb

@@ -1,14 +1,13 @@
-module Widgeo
+# frozen_string_literal: true
 
+module Widgeo
+  # Working with continents
   class Continent
-
     extend Widgeo::Collection
     include Widgeo::Model
 
     attr_reader :name, :alpha_2
 
     dataset_file :continents
-
   end
-
 end

data/lib/widgeo/model.rb

@@ -1,21 +1,16 @@
-module Widgeo
+# frozen_string_literal: true
 
+module Widgeo
+  # Work with an entity
   module Model
-
     # Set attributes on the instance
-    def initialize properties
-
-      properties.each { |name, value|
-
+    def initialize(properties)
+      properties.each do |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)
-
-      }
-
+        instance_variable_set(:"@#{name}", value)
+      end
     end
-
   end
-
 end

data/lib/widgeo/territory.rb

@@ -1,7 +1,8 @@
-module Widgeo
+# frozen_string_literal: true
 
+module Widgeo
+  # Working with territories
   class Territory
-
     extend Widgeo::Collection
     include Widgeo::Model
 
@@ -11,11 +12,7 @@ module Widgeo
 
     # Load an instance of the continent
     def continent
-
       Continent.find_by :alpha_2, continent_alpha_2
-
     end
-
   end
-
 end

data/lib/widgeo/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Widgeo
-  VERSION = "0.0.2"
+  VERSION = '0.0.4'
 end

data/lib/widgeo.rb

@@ -1,14 +1,15 @@
-require "widgeo/version"
-require "widgeo/collection"
-require "widgeo/model"
-require "widgeo/continent"
-require "widgeo/territory"
+# frozen_string_literal: true
 
-module Widgeo
+require 'widgeo/version'
+require 'widgeo/collection'
+require 'widgeo/model'
+require 'widgeo/continent'
+require 'widgeo/territory'
 
-  require "yaml"
+# Provides territory and continent utilities for ruby
+module Widgeo
+  require 'yaml'
 
   class UndefinedDatasetError < StandardError; end
   class UndefinedFieldError < StandardError; end
-
 end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
-require "widgeo"
+# frozen_string_literal: true
+
+require 'widgeo'

data/spec/widgeo/continent_spec.rb

@@ -1,42 +1,36 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe Widgeo::Continent do
+require 'spec_helper'
 
-  CONTINENT_COUNT = 7
-  INVALID_CONTINENT = { bad_field: "BAD FIELD" }
-  CONTINENT_ALPHA = "EU"
-  VALID_CONTINENT = { name: "Beatland", alpha_2: "BE" }
-  CONTINENT_FIELDS = [:name, :alpha_2]
+CONTINENT_COUNT = 7
+INVALID_CONTINENT = { bad_field: 'BAD FIELD' }.freeze
+CONTINENT_ALPHA = 'EU'
+VALID_CONTINENT = { name: 'Beatland', alpha_2: 'BE' }.freeze
+CONTINENT_FIELDS = %i[name alpha_2].freeze
 
+describe Widgeo::Continent do
   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 }
+  it { is_expected.to respond_to(*CONTINENT_FIELDS) }
 
+  context 'given an invalid dataset' do
+    it 'raises UndefinedFieldError' do
+      expect { Widgeo::Continent.new INVALID_CONTINENT }.to raise_error Widgeo::UndefinedFieldError
+    end
   end
 
-  describe ".find_by" do
-
+  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
-
+  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

@@ -1,59 +1,62 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe Widgeo::Territory do
+require 'spec_helper'
 
-  TERRITORY_COUNT = 254
-  INVALID_TERRITORY = { bad_field: "BAD FIELD" }
-  TERRITORY_ALPHA = "GB"
-  PARENT_CONTINENT_ALPHA = "EU"
+TERRITORY_COUNT = 254
+INVALID_TERRITORY = { bad_field: 'BAD FIELD' }.freeze
+TERRITORY_ALPHA = 'GB'
+EU_TERRITORY_COUNT = 50
+PARENT_CONTINENT_ALPHA = 'EU'
 
-  VALID_TERRITORY = {
-    name: "Beatland", long_name: "Peoples republic of Beatland",
-    alpha_2: "BE", continent_alpha_2: "EU"
-  }
+VALID_TERRITORY = {
+  name: 'Beatland', long_name: 'Peoples republic of Beatland',
+  alpha_2: 'BE', continent_alpha_2: 'EU'
+}.freeze
 
-  TERRITORY_FIELDS = [:name, :long_name, :alpha_2, :continent_alpha_2]
+TERRITORY_FIELDS = %i[name long_name alpha_2 continent_alpha_2].freeze
 
+describe Widgeo::Territory do
   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 }
+  it { is_expected.to respond_to(*TERRITORY_FIELDS) }
 
+  context 'given an invalid dataset' do
+    it 'raises UndefinedFieldError' do
+      expect { Widgeo::Territory.new INVALID_TERRITORY }.to raise_error Widgeo::UndefinedFieldError
+    end
   end
 
-  describe "#continent" do
-
-    subject (:continent) {
+  describe '#continent' do
+    subject(:continent) do
       Widgeo::Territory.find_by(:alpha_2, TERRITORY_ALPHA).continent
-    }
+    end
 
     it { expect(continent).to be_kind_of Widgeo::Continent }
     it { expect(continent.alpha_2).to eq PARENT_CONTINENT_ALPHA }
-
   end
 
-  describe ".find_by" do
-
+  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
+  describe '.filter_by' do
+    subject(:territories) do
+      Widgeo::Territory.filter_by continent_alpha_2: PARENT_CONTINENT_ALPHA
+    end
+
+    it { expect(territories).to be_kind_of Array }
+    it { expect(territories.size).to be EU_TERRITORY_COUNT }
+    it { expect(territories.first).to be_kind_of Widgeo::Territory }
+  end
 
+  describe '.all' do
     subject(:territories) { Widgeo::Territory.all }
 
-    it { expect(territories).to be_kind_of Array }
+    it { expect(territories).to be_a_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

@@ -1,27 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'widgeo/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.name = 'widgeo'
+  spec.version = Widgeo::VERSION
+  spec.authors = ['Chris Garrett']
+  spec.email = ['chris@hyperlaunch.com']
+  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.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.homepage = 'https://github.com/hyperlaunch/widgeo'
+  spec.license = 'MIT'
 
-  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop', '~> 1.67'
+  spec.add_development_dependency 'ruby-lsp', '~> 0.20.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: widgeo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
-- Chris G
-autorequire: 
+- Chris Garrett
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2024-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,15 +52,44 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.67'
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.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
+- chris@hyperlaunch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -77,11 +106,12 @@ files:
 - spec/widgeo/continent_spec.rb
 - spec/widgeo/territory_spec.rb
 - widgeo.gemspec
-homepage: https://github.com/BeatrootApp/Widgeo
+homepage: https://github.com/hyperlaunch/widgeo
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,19 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.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: 
+rubygems_version: 3.5.16
+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
+test_files: []