terragona 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8960cea1763219e0706e07cd4f972d62c57a87ff
-  data.tar.gz: 0377f3156e42d39426927b353aaf68bade666536
+  metadata.gz: 3262e299d7235463ec2c190c7a135cca36fd8a7d
+  data.tar.gz: 52e1fe48936cf4e903b0ee842f47cdc3bee1a4e4
 SHA512:
-  metadata.gz: a841fbf0d6f63e54492ed030388d85075a5e92199cf44a3443e89c39db13b4d8b076ae478fff06d6e0fcbdfd4681710006e66953794e4127729ca360a69ccbec
-  data.tar.gz: 523101fea46f423189c81b62cabc80ef3fd46ba30a414547542b662c909e283cf733450db0494f3d7845eef549e4aa70b677859b9ced0cd7dc8123231923ad05
+  metadata.gz: 99b2033b1c95c6fd402a01b5ab772c63289a9a79221fed7b6d5b689cd03d6ee861db6e844f7b081692104576a7fea80fd4a16df51274b4f86420f23b81dc9cf4
+  data.tar.gz: fd604ce36230c33f8cc30658a4bc7742fc4c045faa27aac96fea27e1392113ea355107d814f09b2849bf5837d5d7ca7ade7d4a25a3d27fb93d9eb927dd058b4b

data/README.md

@@ -31,7 +31,8 @@ First, create a db in postgres and install the postgis extension.
 
 Right now, as sources you can use:
 * GeoNames API, with the `Terragona::Geonames::API` class,
-* A Geonames dump, (`Terragona::Geonames::Dump` class) and specify the dump file path in opts. 
+* A Geonames dump, (`Terragona::Geonames::Dump` class) and specify the dump file path in opts.
+* A hash (actually an array of hashes) (`Terragona::Geonames::FromHash` class)
 * A CSV (`Terragona::CSVParser` class) (with headers: `name,x,y`)
 
 The API is faster but less accurate than the dump (max 1000 points per request). 
@@ -84,11 +85,35 @@ result.each {|r|
 terragona.create_polygons_family(italian_rest,'province','comuni')
 ```
 
+With the FromHash class
+
+```ruby
+require 'terragona'
+
+my_hash = [{:name=>'some_tag',:y=>some_lat,:x=>some_lon},
+           {:name=>'some_tag',:y=>some_lat,:x=>some_lon},
+           ...]
+
+opts={
+	:target_percent=> 0.85,
+	:max_distance_ratio=>1.6,
+	:db_username=>'mydbuser',
+	:db_password=>'mydbpsswd',
+	:db_name=>'mydb',
+	:hash=>my_hash}
+
+italy=[] #Don't need input but the hash option.
+
+terragona = Terragona::FromHash.new(opts)
+terragona.create_polygons_family(italy,'italy','italian_regions')
+```
+
 With the CSVParser class
 
 ```ruby
 require 'terragona'
 
+# csv with headers: name,x,y
 opts={
 	:target_percent=> 0.85,
 	:max_distance_ratio=>1.6,
@@ -137,39 +162,55 @@ The methods create the tables, fill them with polygons and return the following
 Options
 ------
 
-```
-dump                    Only for Dump. Path to dump file.
-max_points              Only for Dump. Max number of points to consider from
-                        dump file.
-csv_filename            Only for CSV.
-default_country         Default country. Only for Geonames.
-geonames_username       Only for API. Geonames API username.
-use_cache               Boolean. Default: false.
-cache_expiration_time   Default: 7200.
-projection              Default: EPSG 4326 (WGS84).
-target_percent          Require to draw the concave polygons. 
-                        Closer to 1: convex. Closer to 0, concave. Default: 0.8. 
-allow_holes             Can the polygons have holes? Default: false. 
-max_distance_ratio      Points distant more than this ratio times from the average 
-                        distance between points are not considered. Default: 1.6.
-minimal_polygon_points  Minimal number of points to build a polygon.
-force_homogeneity       Uses max_distance_ratio also to compare with the avg distance
-                        between points of all the other polygons of the same family level.
-                        This helps to discard outliers. The result are homogeneous polygons. 
-dont_create_polygons    (boolean) Default: false.
-table                   Table where polygons are saved. This option is overriden 
-                        by args of create_polygons_family method.
-```
+### General options
+
+ Option | Explanation
+--------|-------------
+use_cache               | Boolean. Default: false.
+cache_expiration_time   | Default: 7200.
+projection              | Default: EPSG 4326 (WGS84).
+target_percent          | Require to draw the concave polygons. Closer to 1: convex. Closer to 0, concave. Default: 0.8. 
+allow_holes             | Can the polygons have holes? Default: false. 
+max_distance_ratio      | Points distant more than this ratio times from the average 
+                        | distance between points are not considered. Default: 1.6.
+minimal_polygon_points  | Minimal number of points to build a polygon.
+force_homogeneity       | Uses max_distance_ratio also to compare with the avg distance between points of all the other polygons of the same family level. This helps to discard outliers. The result are homogeneous polygons. 
+dont_create_polygons    | (boolean) Default: false.
+table                   | Table where polygons are saved. This option is overriden by args of create_polygons_family method.
+
+#### Geonames classes options
+
+ Option | Explanation
+--------|------------
+default_country   | Default country.
+geonames_username | **API class**. Geonames API username.
+dump              | **Dump class**. Path to dump file.
+max_points        | **Dump class**. Max number of points to consider from dump file.
+
+#### FromHash class options
+
+ Option | Explanation
+--------|------------
+hash  | Array of hashes. Each hash should be something like `{:tag=>'tag',:y=>some_lat, :x=>some_lon}`
+
+#### CSVParser
+
+ Option | Explanation
+--------|------------
+csv_filename | Path to CSV file.
+
+
+#### Postgres options
+
+ Option | Explanation
+--------|------------
+db_name              | The db *must* have the Postgis extension installed.
+db_username          |
+db_password          | 
+db_host              | Default: localhost.
+db_port              | Default: 5432.
+db_max_connections   | Default: 10.
 
-Postgres options
-```
-db_name                The db *must* have the Postgis extension installed.
-db_username
-db_password
-db_host                Default: localhost.
-db_port                Default: 5432.
-db_max_connections     Default: 10.
-```
 
 TODO
 ----

data/lib/terragona/base.rb

@@ -15,8 +15,9 @@ module Terragona
 
       concave_hull = ConcaveHull.new(opts)
 
-      if (!names or names.empty?) and @input.class == Generic::CSVParser
-        n = {:name => 'CSV'}
+      if (!names or names.empty?) and
+          (@input.class == Generic::CSVParser or @input.class == Generic::FromHash)
+        n = {:name => :generic}
         name = @input.search(n)
         process_points(n,name,concave_hull,opts)
         return [name]
@@ -82,4 +83,11 @@ module Terragona
       @input = Generic::CSVParser.new(options)
     end
   end
+
+  class FromHash < Base
+    def initialize (options={})
+      super
+      @input = Generic::FromHash.new(options)
+    end
+  end
 end

data/lib/terragona/generic.rb

@@ -18,7 +18,7 @@ module Terragona
 
         points = []
 
-        if name == 'CSV'
+        if name == :generic
           children = []
 
           @csv.each {|p|
@@ -37,5 +37,41 @@ module Terragona
         {:children_places=>children_places, :points => points, :place_name=> name, :place_id=>@id_counter}
       end
     end
+
+    class FromHash
+      def initialize(args = {})
+        # @hash should be actually an array of hashes
+        @hash = args[:hash]
+
+        return unless @hash
+
+        @id_counter = 0
+      end
+      def search(options = {})
+        @id_counter +=1
+
+        name = options[:name]
+
+        points = []
+
+        if name == :generic
+          children = []
+
+          @hash.each {|p|
+            points.push({:x => p[:x], :y => p[:y]})
+            children.push({:name => p[:name]})
+          }
+
+          children.uniq!
+
+          children_places = (children.count > 1 )? children : []
+        else
+          @hash.select{|row| row[:name] == name}.each {|p| points.push({:x => p[:x], :y => p[:y]})}
+          children_places = []
+        end
+
+        {:children_places=>children_places, :points => points, :place_name=> name, :place_id=>@id_counter}
+      end
+    end
   end
 end

data/lib/terragona/version.rb

@@ -1,3 +1,3 @@
 module Terragona
-  VERSION = "0.2.1"
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terragona
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Bruno Salerno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg