chilean_cities 1.0.0

data/spec/lib/chilean_cities/factory_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe ChileanCities::Factory do
+
+  let(:subject) { subject = ChileanCities::Factory.instance }
+
+  it 'class is a kind of Singleton', private: true do
+    expect(ChileanCities::Factory).to respond_to :instance
+  end
+
+  it 'responds to :generate!', public: true do
+    expect(subject).to respond_to :generate!
+  end
+
+  describe '#generate!', public: true do
+
+    it 'generates Comuna, Provincia and Region objects from the data' do
+      expect(subject.generate!).to eq({ comunas_count: 346, provincias_count: 54, regiones_count: 15 })
+    end
+
+    describe 'generates a collection of' do
+
+      it 'valid Regiones instances' do
+        subject.regiones.each do |region|
+          expect(region).to be_valid
+        end
+        subject.generate!
+      end
+
+      it 'valid Provincias instances' do
+        subject.provincias.each do |provincia|
+          expect(provincia).to be_valid
+        end
+        subject.generate!
+      end
+
+      it 'valid Comunas instances' do
+        subject.comunas.first.valid?
+        subject.comunas.each do |comuna|
+          expect(comuna).to be_valid
+        end
+        subject.generate!
+      end
+    end
+  end
+end

data/spec/lib/chilean_cities/provincia_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe ChileanCities::Provincia do
+
+  describe 'provides a Schema.org interface', public: true do
+    it_behaves_like 'an AdministrativeArea'
+  end
+
+  it_behaves_like 'a list of ChileanCities::Comuna'
+
+  it_behaves_like 'part of a ChileanCities::Region'
+
+  # validations
+
+  it 'has a valid factory', private: true do
+    expect(FactoryGirl.build(:provincia)).to be_valid
+  end
+
+  it 'requires a name', private: true do
+    expect(FactoryGirl.build(:provincia, name: nil)).not_to be_valid
+  end
+
+  describe '#comunas', data: true, private: true do
+
+    it 'returns a list of ChileanCities::Comuna' do
+      chile = ChileanCities::Factory.instance
+      chile.generate!
+
+      subject = chile.provincias.sample
+
+      expect(subject.comunas).not_to be_empty
+      expect(subject.comunas.sample).to be_instance_of ChileanCities::Comuna
+    end
+  end
+
+  describe '#region', data: true, private: true do
+
+    it 'returns a ChileanCities::Region' do
+      chile = ChileanCities::Factory.instance
+      chile.generate!
+
+      subject = chile.provincias.sample
+      expect(subject.region).not_to be_nil
+      expect(subject.region).to be_instance_of ChileanCities::Region
+    end
+  end
+
+  describe '#contained_in', data: true, private: true do
+
+    it 'returns a ChileanCities::Region' do
+      chile = ChileanCities::Factory.instance
+      chile.generate!
+
+      subject = chile.provincias.sample
+      expect(subject.contained_in).not_to be_nil
+      expect(subject.contained_in).to be_instance_of ChileanCities::Region
+    end
+  end
+end

data/spec/lib/chilean_cities/region_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe ChileanCities::Region do
+
+  describe 'provides a Schema.org interface', public: true do
+    it_behaves_like 'a State'
+  end
+
+  it 'responds to :iso_3166_2', public: true do
+    expect(subject).to respond_to :iso_3166_2
+  end
+
+  it_behaves_like 'a list of ChileanCities::Provincia'
+
+  # validations
+
+  it 'has a valid factory', private: true do
+    expect(FactoryGirl.build(:region)).to be_valid
+  end
+
+  it 'requires a name', private: true do
+    expect(FactoryGirl.build(:region, name: nil)).not_to be_valid
+  end
+
+  it 'requires an ISO 3166-2:CL code', private: true do
+    # see https://en.wikipedia.org/wiki/ISO_3166-2:CL
+    expect(FactoryGirl.build(:region, iso_3166_2: nil)).not_to be_valid
+  end
+
+  it 'requires iso_3166_2 to be a valid ISO 3166-2:CL code', private: true do
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CP-AN')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CL-AND')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CL_AN')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CLAN')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CL-AN')).to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'CL-A2')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'ACL-AN')).not_to be_valid
+    expect(FactoryGirl.build(:region, iso_3166_2: 'AL-AN')).not_to be_valid
+  end
+
+  describe '#provincias', data: true, private: true do
+
+    it 'returns a list of ChileanCities::Provincia' do
+      chile = ChileanCities::Factory.instance
+      chile.generate!
+
+      subject = chile.regiones.sample
+
+      expect(subject.provincias).not_to be_empty
+      expect(subject.provincias.sample).to be_instance_of ChileanCities::Provincia
+    end
+  end
+
+  describe '#comunas', data: true, private: true do
+
+    it 'returns a list of ChileanCities::Comuna' do
+      chile = ChileanCities::Factory.instance
+      chile.generate!
+
+      subject = chile.regiones.sample
+
+      expect(subject.comunas).not_to be_empty
+      expect(subject.comunas.sample).to be_instance_of ChileanCities::Comuna
+    end
+  end
+end

data/spec/lib/chilean_cities_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ChileanCities do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'chilean_cities'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f; puts f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # make sure the deprecated RSpec 2 syntax is not used
+  config.raise_errors_for_deprecations!
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,18 @@
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  Dir["#{File.dirname(__FILE__)}/../factories/**/*.rb"].each {|f| require f}
+
+  # check_factories_validity!
+  # see https://github.com/thoughtbot/factory_girl/blob/v4.5.0/GETTING_STARTED.md
+  #
+  # factories_to_lint = FactoryGirl.factories.reject do |factory|
+  #   factory.name =~ /^invalid_/
+  # end
+  #
+  # config.before(:suite) do
+  #   FactoryGirl.lint factories_to_lint
+  # end
+end

data/spec/support/schemas/README.md

@@ -0,0 +1,13 @@
+Schema.org Specifications
+=========================
+
+
+These specifications allow to enforce the implementation of schemas (see [schema.org][schema]).
+
+Schema properties are optional, for that reason, those specs are not meant to describe the full schemas. Instead, they describe the aspects of the schemas which we believe our own objects should be able to provide and allow to ensure those objects do provide them.
+
+ **Based on** the `1.93 sdo-stantz (2015-02-04)` [Schema.org][releases] release.
+
+
+  [schema]: http://schema.org
+  [releases]: http://schema.org/docs/releases.html

data/spec/support/schemas/spec_for_administrative_area_interface.rb

@@ -0,0 +1,6 @@
+RSpec.shared_examples 'an AdministrativeArea' do
+
+  let(:administrative_area) { described_class.new() }
+
+  it_behaves_like 'a Place'
+end

data/spec/support/schemas/spec_for_city_interface.rb

@@ -0,0 +1,6 @@
+RSpec.shared_examples 'a City' do
+
+  let(:place) { described_class.new() }
+
+  it_behaves_like 'an AdministrativeArea'
+end

data/spec/support/schemas/spec_for_place_interface.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples 'a Place' do
+
+  let(:place) { described_class.new() }
+
+  it_behaves_like 'a Thing'
+
+  it 'responds to :contained_in', public: true do
+    expect(place).to respond_to :contained_in
+  end
+
+  it 'responds to :has_map', public: true do
+    expect(place).to respond_to :has_map
+  end
+end

data/spec/support/schemas/spec_for_state_interface.rb

@@ -0,0 +1,6 @@
+RSpec.shared_examples 'a State' do
+
+  let(:place) { described_class.new() }
+
+  it_behaves_like 'an AdministrativeArea'
+end

data/spec/support/schemas/spec_for_thing_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'a Thing' do
+
+  let(:thing) { described_class.new() }
+
+  it 'responds to :name', public: true do
+    expect(thing).to respond_to :name
+  end
+end

data/spec/support/spec_for_list_of_comunas_interface.rb

@@ -0,0 +1,22 @@
+RSpec.shared_examples 'a list of ChileanCities::Comuna' do
+
+  let(:comunas_list) { described_class.new() }
+
+  it 'responds to #comunas', public: true do
+    expect(comunas_list).to respond_to :comunas
+  end
+
+  it 'responds to #append_comuna', private: true do
+    expect(comunas_list).to respond_to :append_comuna
+  end
+
+  describe '#append_comuna', private: true do
+
+    it 'appends the comuna to the comunas list if not already present' do
+      comuna = FactoryGirl.build(:comuna)
+      expect{ comunas_list.append_comuna(comuna) }.to change{
+        comunas_list.comunas
+      }.from([]).to([comuna])
+    end
+  end
+end

data/spec/support/spec_for_list_of_provincias_interface.rb

@@ -0,0 +1,24 @@
+RSpec.shared_examples 'a list of ChileanCities::Provincia' do
+
+  let(:provincias_list) { described_class.new() }
+
+  it_behaves_like 'a list of ChileanCities::Comuna'
+
+  it 'responds to #provincias', public: true do
+    expect(provincias_list).to respond_to :provincias
+  end
+
+  it 'responds to #append_provincia', private: true do
+    expect(provincias_list).to respond_to :append_provincia
+  end
+
+  describe '#append_provincia', private: true do
+
+    it 'appends the provincia to the provincias list if not already present' do
+      provincia = FactoryGirl.build(:provincia)
+      expect{ provincias_list.append_provincia(provincia) }.to change{
+        provincias_list.provincias
+      }.from([]).to([provincia])
+    end
+  end
+end

data/spec/support/spec_for_part_of_provincia_interface.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples 'part of a ChileanCities::Provincia' do
+
+  let(:part_of_provincia) { described_class.new() }
+
+  it_behaves_like 'part of a ChileanCities::Region'
+
+  it 'responds to #provincia', public: true do
+    expect(part_of_provincia).to respond_to :provincia
+  end
+
+  it 'responds to #provincia=', private: true do
+    expect(part_of_provincia).to respond_to :provincia=
+  end
+end

data/spec/support/spec_for_part_of_region_interface.rb

@@ -0,0 +1,12 @@
+RSpec.shared_examples 'part of a ChileanCities::Region' do
+
+  let(:part_of_region) { described_class.new() }
+
+  it 'responds to #region', public: true do
+    expect(part_of_region).to respond_to :region
+  end
+
+  it 'responds to #region=', private: true do
+    expect(part_of_region).to respond_to :region=
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: chilean_cities
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gonzalo Bulnes Guilpain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: A ruby implementation of the Chilean 'comunas'.
+email:
+- gon.bulnes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chilean_cities.rb
+- lib/chilean_cities/comuna.rb
+- lib/chilean_cities/comunas_list.rb
+- lib/chilean_cities/factory.rb
+- lib/chilean_cities/provincia.rb
+- lib/chilean_cities/provincia_part.rb
+- lib/chilean_cities/provincias_list.rb
+- lib/chilean_cities/region.rb
+- lib/chilean_cities/region_part.rb
+- lib/chilean_cities/version.rb
+- lib/schemas/place.rb
+- lib/schemas/thing.rb
+- spec/factories/comunas.rb
+- spec/factories/provincias.rb
+- spec/factories/regiones.rb
+- spec/lib/chilean_cities/comuna_spec.rb
+- spec/lib/chilean_cities/factory_spec.rb
+- spec/lib/chilean_cities/provincia_spec.rb
+- spec/lib/chilean_cities/region_spec.rb
+- spec/lib/chilean_cities_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_girl.rb
+- spec/support/schemas/README.md
+- spec/support/schemas/spec_for_administrative_area_interface.rb
+- spec/support/schemas/spec_for_city_interface.rb
+- spec/support/schemas/spec_for_place_interface.rb
+- spec/support/schemas/spec_for_state_interface.rb
+- spec/support/schemas/spec_for_thing_interface.rb
+- spec/support/spec_for_list_of_comunas_interface.rb
+- spec/support/spec_for_list_of_provincias_interface.rb
+- spec/support/spec_for_part_of_provincia_interface.rb
+- spec/support/spec_for_part_of_region_interface.rb
+homepage: https://github.com/gonzalo-bulnes/chilean_cities
+licenses:
+- GPL-3.0
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a Ruby representation of the Chilean 'comunas' as described by the
+  Subsecretaría de Desarrollo Regional y Administrativo.
+test_files:
+- spec/spec_helper.rb
+- spec/support/spec_for_list_of_provincias_interface.rb
+- spec/support/spec_for_part_of_provincia_interface.rb
+- spec/support/schemas/spec_for_place_interface.rb
+- spec/support/schemas/spec_for_thing_interface.rb
+- spec/support/schemas/README.md
+- spec/support/schemas/spec_for_city_interface.rb
+- spec/support/schemas/spec_for_administrative_area_interface.rb
+- spec/support/schemas/spec_for_state_interface.rb
+- spec/support/spec_for_list_of_comunas_interface.rb
+- spec/support/spec_for_part_of_region_interface.rb
+- spec/support/factory_girl.rb
+- spec/factories/regiones.rb
+- spec/factories/comunas.rb
+- spec/factories/provincias.rb
+- spec/lib/chilean_cities/comuna_spec.rb
+- spec/lib/chilean_cities/factory_spec.rb
+- spec/lib/chilean_cities/provincia_spec.rb
+- spec/lib/chilean_cities/region_spec.rb
+- spec/lib/chilean_cities_spec.rb