ine-places 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520d85a6b88bda35a7421a32b03c1466eb9f0905
-  data.tar.gz: d449952c735544ee62c8349f6df93f4c651ce6e6
+  metadata.gz: 2aeb712180cbc9f2584a43b30e9d99057416fc28
+  data.tar.gz: ae8db3e9b905b2072c81725132de81e48d43287e
 SHA512:
-  metadata.gz: 9cdd68d2602127d859640d2b0b523af92a9987811776e50078a6546e158b929cde2e9a150f55bdd1c563dbcc5d4e625dc82eb6f21bb58fea8affe3da0d9a3724
-  data.tar.gz: 2a15d0086ad6174d62610541d95596ad4d6f0f8b56474b44e5e1836a092ed0c067aa15f4547712ddd862ce6e16a299bb513943d73f80263065a252b638f285f1
+  metadata.gz: 901d1a2771bd5a74d8d294ed08dc1b0a247ae46285006528885718978110d412665f0c3e0dd92f1721cfa7b3f1675896aad3aa3a32b5bab976b2711369f95c8e
+  data.tar.gz: b6a293d00f5ab63684070025e9e01ade125b40c56018ab5dee805d3ff4b9432385c22596260bc05c0709464a11dde20a6750e1dcec3f1f862111aae30a9b4eb9

data/README.md

@@ -165,6 +165,40 @@ INE::Places::Place.find_by_slug('burjassot')
 => #<INE::Places::Place id="46078", name="Burjassot", slug="burjassot", province_id="46", lon="-0.4135963", lat="39.5096699", province=#<INE::Places::Province id="46", name="Valencia/València", slug="valencia", autonomous_region_id="10", lon="-0.3762881", lat="39.4699075", autonomous_region=#<INE::Places::AutonomousRegion id="10", name="Comunidad Valenciana", slug="comunidad-valenciana", lon="-0.7532808999999999", lat="39.4840108">>>
 ```
 
+## Hydratating models with data (experimental feature)
+
+It's quite common to work with data related with the entities provided by this gem. For example, to know the debt of a place, the amount of schools, the number of inhabitants, and so on. This data lives in external sources, such a CSV or a JSON file, or an API endpoint but can be co-related with the entities using an ID column.
+
+Hydratation feature helps you with this issue. For the moment it's very experimental but allows you to add basics sets of data from a local CSV file.
+
+For example, given a CSV file with a single row:
+
+```csv
+municipio,value
+28079,33
+```
+
+You could hydratate the model `INE::Places::Place` using the `.hydrate` function:
+
+```ruby
+INE::Places.hydratate INE::Places::Place, 'spec/fixtures/happiness.csv', id_column: 'municipio',
+                                                                         as: :happiness,
+                                                                         value_column: 'value'
+```
+
+You just need to provide:
+
+- id column, to match the IDs
+- the `as` column, with the name of the new method
+- the value column, to know exactly where the value is
+
+After hydratating a class, every object of the class has the new method in the `.data` property:
+
+```ruby
+place.data.happiness
+#> 100
+```
+
 ## 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.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require_relative "../lib/ine/places/places"
+require_relative "../lib/ine/places"
 
 # 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.

data/ine-places.gemspec

@@ -27,9 +27,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport", "~> 4.2", ">= 4.2.4"
+  spec.add_runtime_dependency "activesupport", ">= 4.2", "<= 5.1"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "byebug", '~> 9.0', '>= 9.0.5'
 end

data/lib/ine/places.rb

@@ -2,6 +2,7 @@ require "ine/places/version"
 require "csv"
 require "ostruct"
 require "active_support/all"
+require "byebug"
 
 module INE
   module Places
@@ -23,5 +24,21 @@ module INE
 
       nil
     end
+
+    def self.hydratate(klass, data_path, options)
+      unless File.file?(data_path)
+        raise "Missing data file: #{data_path}"
+      end
+
+      data = CSV.read(data_path, headers: true)
+      klass.all.map do |obj|
+        obj.tap do
+          value = if r = data.detect{|row| row[options[:id_column]] == obj.id }
+                    r[options[:value_column]]
+                  end
+          obj.data.send((options[:as].to_s + '=').to_sym, value)
+        end
+      end
+    end
   end
 end

data/lib/ine/places/place.rb

@@ -7,6 +7,10 @@ class INE::Places::Place < OpenStruct
     collection_klass.records.select{ |place| place.province_id == province_id }
   end
 
+  def data
+    @data ||= OpenStruct.new
+  end
+
   private
 
   def self.collection_klass

data/lib/ine/places/version.rb

@@ -1,5 +1,5 @@
 module INE
   module Places
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ine-places
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Fernando Blat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-08 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.4
+        version: '5.1'
   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.4
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
 description: Work with Spanish regions using INE codes and data
 email:
 - ferblape@gmail.com