ruby_px 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44941ebae6202b2580d1303054c643bd3e713971
+  data.tar.gz: 4d9b8e3bc4dc2ae1156366473137d68618f31b05
+SHA512:
+  metadata.gz: 915d7fa2b750f11a241d25b2188210e4cbcceb2041a6c501fe78df65f480e21bce23bf172be39d1972d910ad05fea61277706fe543124a2e2bd9d5371a5aebcf
+  data.tar.gz: 37b7bdc3faa735d97cbd04cc341e8811a49f3340b69a8e25ed21cd150e7a0520ced342c5d1fc7b7f81da786f13c941fa48c43b122f4d91cb3ff070b2451c0361

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

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, ethnicity, 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 ruby_px.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fernando Blat
+
+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,109 @@
+# RubyPx
+
+[![Build Status](https://travis-ci.org/PopulateTools/ruby_px.svg?branch=master)](https://travis-ci.org/PopulateTools/ruby_px)
+
+Work with PC-Axis files using Ruby.
+
+## Motivation
+
+The Spanish Statistics Institute ([INE](http://www.ine.es/welcome.shtml)) favourite format to publish
+the data is PC-Axis, a semi-plain-text format which is kind of difficult to work with unless you
+have a PC with Windows installed in.
+
+There is a library in R called [pxR](https://github.com/cran/pxR) from [@gilbellosta](https://twitter.com/gilbellosta), but I don't know more alternatives in other programming languages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_px'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_px
+
+## Usage
+
+```ruby
+# Load a dataset
+dataset = RubyPx::Dataset.new 'spec/fixtures/ine-padron-2014.px'
+
+# Query some metadata
+dataset.title
+=> "Población por sexo, municipios y edad (año a año)."
+
+dataset.units
+=> "personas"
+
+dataset.source
+=> "Instituto Nacional de Estadística"
+
+dataset.contact
+=> "INE E-mail:www.ine.es/infoine. Internet: www.ine.es. Tel: +34 91 583 91 00 Fax: +34 91 583 91 58"
+
+dataset.last_updated
+=> "05/10/99" # Really, INE?
+
+dataset.creation_date
+=> "20141201"
+
+# Obtain the headings and the stubs
+dataset.headings
+=> ["edad (año a año)"]
+
+dataset.stubs
+=> ["sexo", "municipios"]
+
+# Obtain the dimensions of the dataset
+dataset.dimensions
+=> ["sexo", "edad (año a año)", "municipios"]
+
+# Get the list of values of a dimension
+dataset.dimension('sexo')
+=> ["Ambos sexos", "Hombres", "Mujeres"]
+
+# Query the data using the method #data
+# You can query the data in two ways:
+# 1 - providing all the dimensions, so you'll obtain a single value
+dataset.data('edad (año a año)' => 'Total', 'sexo' => 'Ambos sexos', 'municipios' => '28079-Madrid')
+=> "3165235"
+
+# 2 - providing all the dimensions except one, so you'll obtain an array
+dataset.data('edad (año a año)' => 'Total', 'sexo' => 'Ambos sexos')
+=> [....] # an array with the population of all places for all ages and both sexs
+
+```
+
+## TODO
+
+- Allow to receive an URL as an argument
+- Refactor
+- Test the gem with more files
+- Speed-up the parsing time
+
+
+## Development
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ruby_px. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## Thanks
+
+Thank you [Xavier Badosa](https://twitter.com/badosa) for inspiring me with [json-stat.org](http://json-stat.org/) and the API of
+the Javascript library [json-stat.com](http://json-stat.com/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+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 "pc-axis/dataset"
+
+# 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/ruby_px/dataset.rb

@@ -0,0 +1,196 @@
+module RubyPx
+  class Dataset
+    attr_reader :headings, :stubs
+
+    METADATA_RECORDS = ['TITLE','UNITS','SOURCE','CONTACT','LAST-UPDATED','CREATION-DATE']
+    HEADING_RECORD = 'HEADING'
+    STUB_RECORD = 'STUB'
+
+    def initialize(file)
+      if !File.readable?(file)
+        raise "File #{file} not readable"
+      end
+
+      @metadata = {}
+      @headings = []
+      @stubs = []
+      @values = {}
+      @data = []
+
+      parse_file(file)
+    end
+
+    def title
+      @metadata['TITLE']
+    end
+
+    def units
+      @metadata['UNITS']
+    end
+
+    def source
+      @metadata['SOURCE']
+    end
+
+    def contact
+      @metadata['CONTACT']
+    end
+
+    def last_updated
+      @metadata['LAST-UPDATED']
+    end
+
+    def creation_date
+      @metadata['CREATION-DATE']
+    end
+
+    def dimension(name)
+      @values[name] || raise("Missing dimension #{name}")
+    end
+
+    def dimensions
+      @values.keys
+    end
+
+    def data(options)
+      # Validate parameters
+      options.each do |k,v|
+        raise "Invalid value #{v} for dimension #{k}" unless dimension(k).include?(v)
+      end
+
+      # Return a single value
+      # 2D array[ i*M + j]
+      # 3D array[ i*(N*M) + j*M + k ]
+      # 4D array[ i*(N*M*R) + j*M*R + k*R + l]
+      if options.length == dimensions.length
+        offset = 0
+
+        # positions are i, j, k
+        positions = (stubs + headings).map do |dimension_name|
+          self.dimension(dimension_name).index(options[dimension_name])
+        end
+
+        # dimension_sizes are from all dimensions except the first one
+        dimension_sizes = (stubs + headings)[1..-1].map do |dimension_name|
+          self.dimension(dimension_name).length
+        end
+
+        positions.each_with_index do |p, i|
+          d = dimension_sizes[i..-1].reduce(&:*)
+          offset += (d ? p*d : p)
+        end
+
+        return @data[offset]
+
+      # Return an array of options
+      elsif options.length == dimensions.length - 1
+        result = []
+
+        missing_dimension = (dimensions - options.keys).first
+        dimension(missing_dimension).each do |dimension_value|
+          result << data(options.merge(missing_dimension => dimension_value))
+        end
+
+        return result
+      else
+        raise "Not implented yet, sorry"
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{self.object_id}>"
+    end
+
+    private
+
+    def parse_file(file)
+      File.foreach(file) do |line|
+        parse_line(line.chomp)
+      end
+      return true
+    end
+
+    def parse_line(line)
+      @line = line
+
+      if @current_record.nil?
+        key, value = line.scan(/[^\=]+/)
+        set_current_record(key)
+      else
+        value = line
+      end
+
+      return if @current_record.nil? || value.nil?
+
+      if @type == :data
+        value = value.split(' ')
+
+        add_value_to_bucket(bucket,value) unless value == [';']
+      else
+        # First format: "\"20141201\";"
+        if value =~ /\A\"([^"]+)\";\z/
+          value = value.match(/\A\"([^"]+)\";\z/)[1]
+          add_value_to_bucket(bucket, value.strip)
+
+          # Second format: "Ambos sexos","Hombres","Mujeres";
+        elsif value =~ /\"([^"]+)\",?/
+          value = value.split(/\"([^"]+)\",?;?/).delete_if{ |s| s.blank? }.each(&:strip)
+          add_value_to_bucket(bucket, value)
+        end
+      end
+
+      # If we see a ; at the end of the line, close out the record so we
+      # expect a new record.
+      if line[-1..-1] == ";"
+        @current_record = nil
+      end
+    end
+
+    def set_current_record(key)
+      @current_record = if METADATA_RECORDS.include?(key)
+                          @type = :metadata
+                          key
+                        elsif key == HEADING_RECORD
+                          @type = :headings
+                          key
+                        elsif key == STUB_RECORD
+                          @type = :stubs
+                          key
+                        elsif key =~ /\AVALUES/
+                          @type = :values
+                          key.match(/\"([^"]+)\"/)[1]
+                        elsif key =~ /\ADATA/
+                          @type = :data
+                          key
+                        end
+    end
+
+    def bucket
+      instance_variable_get("@#{@type}")
+    end
+
+    def add_value_to_bucket(bucket, value)
+      if @type == :data
+        @data.concat(value)
+      elsif @type == :headings || @type == :stubs
+        bucket << value
+        bucket.flatten!
+      else
+        if bucket.is_a?(Hash)
+          if value.is_a?(Array)
+            value = value.map(&:strip)
+          elsif value.is_a?(String)
+            value.strip!
+          end
+          if bucket[@current_record].nil?
+            bucket[@current_record] = value
+          else
+            bucket[@current_record].concat([value])
+            bucket[@current_record].flatten!
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/ruby_px.rb

@@ -0,0 +1,5 @@
+require 'active_support/all'
+
+module RubyPx
+  require 'ruby_px/dataset'
+end

data/ruby_px.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_px"
+  spec.version       = '0.2.0'
+  spec.authors       = ["Fernando Blat"]
+  spec.email         = ["ferblape@gmail.com"]
+
+  spec.summary       = %q{Read PC-Axis files using Ruby}
+  spec.description   = %q{Read PC-Axis files using Ruby}
+  spec.homepage      = "https://github.com/PopulateTools/ruby_px"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_runtime_dependency "activesupport", "~> 4.2", ">= 4.2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ruby_px
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Fernando Blat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Read PC-Axis files using Ruby
+email:
+- ferblape@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_px.rb
+- lib/ruby_px/dataset.rb
+- ruby_px.gemspec
+homepage: https://github.com/PopulateTools/ruby_px
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Read PC-Axis files using Ruby
+test_files: []
+has_rdoc: