ibge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bb4210540e49df0ba3f713e8b414c58d4e7b422
+  data.tar.gz: 7dfaab976499b7e3ed845d4577450a29a1a90b8d
+SHA512:
+  metadata.gz: 3dd4c04e05bc163d669871436d886c4dc6f3c7a5c7cabf968cac1690dccd7c1e966b365409296ddb594e03ae42fdadaa6256da827be86c73861f55b6a35888a9
+  data.tar.gz: 9b34cfd88f22b2fa56671f5b91f37c47365c31a8652326a0a28535f1a11ec5c82b754a097f6a5025288726f162ac357ea6d4fb710595459a46d2b88f4a21ef4a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+script: "bundle exec rake spec"

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 ibge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno Arueira
+
+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,50 @@
+# Ibge
+
+[![Build Status](https://travis-ci.org/brunoarueira/ibge.svg?branch=master)](https://travis-ci.org/brunoarueira/ibge)
+[![Code Climate](https://codeclimate.com/github/brunoarueira/ibge/badges/gpa.svg)](https://codeclimate.com/github/brunoarueira/ibge)
+
+Unofficial gem with a bunch of data collected by IBGE. The data collected are responsibility of IBGE (Instituto Brasileiro de Geografia e Estatística, in english Brazilian Institute of Geography and Statistics) and this gem makes an integration with ruby more easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ibge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ibge
+
+## Usage
+
+For now, the gem supports 6 types of information: State (without abbreviation yet), Meso region, Micro region, Municipality, District and Sub district.
+
+To read any type, the readers has the same API like below:
+
+```ruby
+  # For state
+  Ibge::Reader::State.read #=> [{ code: '11', state_name: 'Rondônia' }, ... { code: '53', state_name: 'Distrito Federal' }]
+
+  # For municipality
+  Ibge::Reader::Municipality.read #=> [{:state_code=>"11", :meso_region_code=>"01", :micro_region_code=>"001", :code=>"00205", :full_code=>"1100205", :name=>"Porto Velho"},
+                                  #    ...,
+                                  #    {:state_code=>"53", :meso_region_code=>"01", :micro_region_code=>"001", :code=>"00108", :full_code=>"5300108", :name=>"Brasília"}]
+```
+
+## Maintainer
+
+- Bruno Arueira
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ibge/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/ibge.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ibge/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["Bruno Arueira"]
+  spec.email         = ["contato@brunoarueira.com"]
+  spec.description   = %q{Unofficial gem with a bunch of data collected by ibge}
+  spec.summary       = %q{Unofficial gem with a bunch of data collected by ibge}
+  spec.homepage      = "http://github.com/brunoarueira/ibge"
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.name          = "ibge"
+  spec.version       = Ibge::VERSION
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+
+  spec.add_dependency "spreadsheet", "~> 1.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.2.0"
+end

data/lib/ibge/reader/base.rb

@@ -0,0 +1,78 @@
+require 'spreadsheet'
+
+module Ibge
+  module Reader
+    class Base
+      class << self
+        attr_reader :defined_columns
+
+        def columns(columns = {})
+          @defined_columns = columns
+        end
+      end
+
+      attr_reader :filename
+
+      def self.read(options = {})
+        new(options).read
+      end
+
+      def initialize(options = {})
+        @filename = options.fetch(:filename, default_filename)
+      end
+
+      def read
+        transformed_rows = rows[1..-1].map do |row|
+          transform(row.compact.values_at(*column_range), column_range)
+        end
+
+        transformed_rows.uniq.sort_by { |hash| data_sort(hash) }
+      end
+
+      protected
+
+      def default_filename
+        File.join DATA_PATH, 'DTB_2014_subdistrito.xls'
+      end
+
+      def spreadsheet
+        @spreadsheet ||= Spreadsheet.open filename
+      end
+
+      def sheet
+        @selected_sheet ||= spreadsheet.worksheets.first
+      end
+
+      def rows
+        @rows ||= sheet.rows
+      end
+
+      def column_keys
+        self.class.defined_columns.keys.map(&:to_s).map(&:to_i)
+      end
+
+      def column_range
+        column_keys.compact.sort.uniq
+      end
+
+      def transform(row, column_range)
+        row.each_with_index.inject({}) do |item, (raw_data, index)|
+          column_index = column_range[index]
+
+          item.merge!(self.class.defined_columns[column_index.to_s.to_sym] => raw_data)
+        end
+      end
+
+      def data_sort(hash)
+        keys = hash.keys
+        order_values = []
+
+        (keys.length - 1).times.each do |index|
+          order_values << hash[keys[index]]
+        end
+
+        order_values
+      end
+    end
+  end
+end

data/lib/ibge/reader/district.rb

@@ -0,0 +1,13 @@
+module Ibge
+  module Reader
+    class District < Base
+      columns "0":  :state_code,
+              "2":  :meso_region_code,
+              "4":  :micro_region_code,
+              "6":  :municipality_code,
+              "9":  :code,
+              "10": :full_code,
+              "11": :name
+    end
+  end
+end

data/lib/ibge/reader/meso_region.rb

@@ -0,0 +1,9 @@
+module Ibge
+  module Reader
+    class MesoRegion < Base
+      columns "0": :state_code,
+              "2": :code,
+              "3": :name
+    end
+  end
+end

data/lib/ibge/reader/micro_region.rb

@@ -0,0 +1,10 @@
+module Ibge
+  module Reader
+    class MicroRegion < Base
+      columns "0": :state_code,
+              "2": :meso_region_code,
+              "4": :code,
+              "5": :name
+    end
+  end
+end

data/lib/ibge/reader/municipality.rb

@@ -0,0 +1,12 @@
+module Ibge
+  module Reader
+    class Municipality < Base
+      columns "0": :state_code,
+              "2": :meso_region_code,
+              "4": :micro_region_code,
+              "6": :code,
+              "7": :full_code,
+              "8": :name
+    end
+  end
+end

data/lib/ibge/reader/state.rb

@@ -0,0 +1,8 @@
+module Ibge
+  module Reader
+    class State < Base
+      columns "0": :code,
+              "1": :state_name
+    end
+  end
+end

data/lib/ibge/reader/sub_district.rb

@@ -0,0 +1,14 @@
+module Ibge
+  module Reader
+    class SubDistrict < Base
+      columns "0":  :state_code,
+              "2":  :meso_region_code,
+              "4":  :micro_region_code,
+              "6":  :municipality_code,
+              "9":  :district_code,
+              "12": :code,
+              "13": :full_code,
+              "14": :name
+    end
+  end
+end

data/lib/ibge/version.rb

@@ -0,0 +1,3 @@
+module Ibge
+  VERSION = "0.1.0"
+end

data/lib/ibge.rb

@@ -0,0 +1,17 @@
+require 'spreadsheet'
+
+require 'ibge/version'
+
+module Ibge
+  DATA_PATH = File.expand_path(File.join(__dir__, '..', 'data'))
+
+  module Reader
+    autoload :Base,         'ibge/reader/base'
+    autoload :State,        'ibge/reader/state'
+    autoload :MesoRegion,   'ibge/reader/meso_region'
+    autoload :MicroRegion,  'ibge/reader/micro_region'
+    autoload :Municipality, 'ibge/reader/municipality'
+    autoload :District,     'ibge/reader/district'
+    autoload :SubDistrict,  'ibge/reader/sub_district'
+  end
+end

data/spec/ibge/reader/base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Ibge::Reader::Base do
+  class Reader < Ibge::Reader::Base
+    columns "0": :code
+  end
+
+  subject { Reader }
+
+  describe '.columns' do
+    it { should respond_to :columns }
+
+    it 'maps the column index to a recognized column name' do
+      expect(subject.defined_columns).to eq "0": :code
+    end
+  end
+
+  describe '.read' do
+    context 'without pass a :filename as option' do
+      it 'reads the file inside data folder' do
+        expect(subject.read).to include code: "11"
+      end
+    end
+
+    context 'passing a :filename' do
+      it 'reads the file provided' do
+        filename = "spec/fixtures/DTB_example_subdistrito.xls"
+
+        expect(subject.read(filename: filename)).to include code: "11"
+      end
+    end
+  end
+
+  describe '#filename' do
+    it 'sets the default to file inside data folder' do
+      expect(subject.new.filename).to include 'data/DTB_2014_subdistrito.xls'
+    end
+  end
+end

data/spec/ibge/reader/district_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Ibge::Reader::District do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0": :state_code,
+                                               "2": :meso_region_code,
+                                               "4": :micro_region_code,
+                                               "6": :municipality_code,
+                                               "9": :code,
+                                               "10": :full_code,
+                                               "11": :name
+  end
+end

data/spec/ibge/reader/meso_region_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Ibge::Reader::MesoRegion do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0": :state_code,
+                                               "2": :code,
+                                               "3": :name
+  end
+end

data/spec/ibge/reader/micro_region_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Ibge::Reader::MicroRegion do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0": :state_code,
+                                               "2": :meso_region_code,
+                                               "4": :code,
+                                               "5": :name
+  end
+end

data/spec/ibge/reader/municipality_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Ibge::Reader::Municipality do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0": :state_code,
+                                               "2": :meso_region_code,
+                                               "4": :micro_region_code,
+                                               "6": :code,
+                                               "7": :full_code,
+                                               "8": :name
+  end
+end

data/spec/ibge/reader/state_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Ibge::Reader::State do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0": :code, "1": :state_name
+  end
+end

data/spec/ibge/reader/sub_district_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Ibge::Reader::SubDistrict do
+  subject { described_class }
+
+  it 'should have defined columns' do
+    expect(subject.defined_columns).to include "0":  :state_code,
+                                               "2":  :meso_region_code,
+                                               "4":  :micro_region_code,
+                                               "6":  :municipality_code,
+                                               "9":  :district_code,
+                                               "12": :code,
+                                               "13": :full_code,
+                                               "14": :name
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'ibge'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ibge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Arueira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  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: 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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Unofficial gem with a bunch of data collected by ibge
+email:
+- contato@brunoarueira.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/DTB_2014_subdistrito.xls
+- ibge.gemspec
+- lib/ibge.rb
+- lib/ibge/reader/base.rb
+- lib/ibge/reader/district.rb
+- lib/ibge/reader/meso_region.rb
+- lib/ibge/reader/micro_region.rb
+- lib/ibge/reader/municipality.rb
+- lib/ibge/reader/state.rb
+- lib/ibge/reader/sub_district.rb
+- lib/ibge/version.rb
+- spec/fixtures/DTB_example_subdistrito.xls
+- spec/ibge/reader/base_spec.rb
+- spec/ibge/reader/district_spec.rb
+- spec/ibge/reader/meso_region_spec.rb
+- spec/ibge/reader/micro_region_spec.rb
+- spec/ibge/reader/municipality_spec.rb
+- spec/ibge/reader/state_spec.rb
+- spec/ibge/reader/sub_district_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/brunoarueira/ibge
+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.6
+signing_key: 
+specification_version: 4
+summary: Unofficial gem with a bunch of data collected by ibge
+test_files:
+- spec/fixtures/DTB_example_subdistrito.xls
+- spec/ibge/reader/base_spec.rb
+- spec/ibge/reader/district_spec.rb
+- spec/ibge/reader/meso_region_spec.rb
+- spec/ibge/reader/micro_region_spec.rb
+- spec/ibge/reader/municipality_spec.rb
+- spec/ibge/reader/state_spec.rb
+- spec/ibge/reader/sub_district_spec.rb
+- spec/spec_helper.rb