underpass 0.0.7 → 0.9.0

data/lib/underpass/version.rb

@@ -12,8 +12,8 @@ module Underpass
   # Used to generate the version string
   module VERSION
     MAJOR = 0
-    MINOR = 0
-    PATCH = 7
+    MINOR = 9
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join('.')
   end

data/lib/underpass/way_chain.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Underpass
+  # Chains way node sequences that share endpoints into complete rings.
+  #
+  # Used internally by {Shape.multipolygon_from_relation} to merge multiple
+  # way segments into closed linear rings.
+  class WayChain
+    # @api private
+    MERGE_STRATEGIES = [
+      ->(cur, seq) { cur.last == seq.first ? cur + seq[1..] : nil },
+      ->(cur, seq) { cur.last == seq.last ? cur + seq.reverse[1..] : nil },
+      ->(cur, seq) { cur.first == seq.last ? seq + cur[1..] : nil },
+      ->(cur, seq) { cur.first == seq.first ? seq.reverse + cur[1..] : nil }
+    ].freeze
+
+    # Creates a new WayChain from way IDs and a way lookup table.
+    #
+    # @param way_ids [Array<Integer>] IDs of the ways to chain
+    # @param ways [Hash{Integer => Hash}] way lookup table
+    def initialize(way_ids, ways)
+      @sequences = way_ids.filter_map do |way_id|
+        way = ways[way_id]
+        next unless way
+
+        way[:nodes].dup
+      end
+    end
+
+    # Merges node sequences that share endpoints into continuous rings.
+    #
+    # @return [Array<Array<Integer>>] the merged node ID sequences
+    def merged_sequences
+      return @sequences if @sequences.empty?
+
+      remaining = @sequences.dup
+      current = remaining.shift
+      current, remaining = merge_all(current, remaining)
+      [current, *remaining]
+    end
+
+    private
+
+    def merge_all(current, remaining)
+      until remaining.empty?
+        found = find_connection(current, remaining)
+        break unless found
+
+        remaining.delete(found[:seq])
+        current = found[:merged]
+      end
+      [current, remaining]
+    end
+
+    def find_connection(current, sequences)
+      sequences.each do |seq|
+        merged = try_merge(current, seq)
+        return { seq: seq, merged: merged } if merged
+      end
+      nil
+    end
+
+    def try_merge(current, seq)
+      MERGE_STRATEGIES.each do |strategy|
+        result = strategy.call(current, seq)
+        return result if result
+      end
+      nil
+    end
+  end
+end

data/lib/underpass.rb

@@ -3,26 +3,72 @@
 require 'rgeo'
 require 'json'
 
-require 'underpass/ql/ql'
+require 'underpass/cache'
+require 'underpass/configuration'
+require 'underpass/errors'
+require 'underpass/client'
+require 'underpass/feature'
+require 'underpass/filter'
+require 'underpass/geo_json'
+require 'underpass/matcher'
+require 'underpass/shape'
+require 'underpass/way_chain'
+require 'underpass/ql/bounding_box'
+require 'underpass/ql/builder'
+require 'underpass/ql/query'
+require 'underpass/ql/query_analyzer'
+require 'underpass/ql/request'
+require 'underpass/ql/response'
 
 # Underpass is a library that makes it easy to query the Overpass API
-# and translate its responses into RGeo objects
+# and translate its responses into RGeo objects.
+#
+# @example Quick start
+#   wkt = 'POLYGON ((23.669 47.65, 23.725 47.65, 23.725 47.674, 23.669 47.674, 23.669 47.65))'
+#   bbox = RGeo::Geographic.spherical_factory.parse_wkt(wkt)
+#   query = 'way["heritage:operator"="lmi"];'
+#   features = Underpass::QL::Query.perform(bbox, query)
+#
+# @example Configure the API endpoint
+#   Underpass.configure do |config|
+#     config.api_endpoint = 'https://overpass.kumi.systems/api/interpreter'
+#     config.timeout = 30
+#   end
 module Underpass
-end
+  class << self
+    # @return [Cache, nil] the cache instance used for storing API responses
+    attr_accessor :cache
 
-# Example usage
-#
-# require 'underpass'
-# wkt = <<-WKT
-#   POLYGON ((
-#     23.669 47.65,
-#     23.725 47.65,
-#     23.725 47.674,
-#     23.669 47.674,
-#     23.669 47.65
-#   ))
-# WKT
-# f = RGeo::Geographic.spherical_factory
-# bbox = f.parse_wkt(wkt)
-# op_query = 'way["heritage:operator"="lmi"]["ref:ro:lmi"="MM-II-m-B-04508"];'
-# Underpass::QL::Query.perform(bbox, op_query)
+    # @return [Configuration] the current configuration
+    attr_writer :configuration
+
+    # Returns the current configuration, initializing a default one if needed.
+    #
+    # @return [Configuration] the current configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Yields the current configuration for modification.
+    #
+    # @yield [config] the current configuration
+    # @yieldparam config [Configuration] the configuration instance
+    # @return [void]
+    #
+    # @example
+    #   Underpass.configure do |config|
+    #     config.api_endpoint = 'https://overpass.kumi.systems/api/interpreter'
+    #     config.timeout = 30
+    #   end
+    def configure
+      yield(configuration)
+    end
+
+    # Resets the configuration to default values.
+    #
+    # @return [Configuration] a new default configuration
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: underpass
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.9.0
 platform: ruby
 authors:
 - Janos Rusiczki
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo
@@ -16,114 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.7.3
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.7.3
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.3
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: rgeo-geojson
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :development
+        version: '2.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '2.2'
 description: "    A library that makes it easy to query the Overpass API and translate
   its responses into RGeo objects\n"
 email: janos.rusiczki@gmail.com
@@ -134,20 +47,31 @@ files:
 - LICENSE
 - README.md
 - lib/underpass.rb
+- lib/underpass/cache.rb
+- lib/underpass/client.rb
+- lib/underpass/configuration.rb
+- lib/underpass/errors.rb
+- lib/underpass/feature.rb
+- lib/underpass/filter.rb
+- lib/underpass/geo_json.rb
+- lib/underpass/matcher.rb
 - lib/underpass/ql/bounding_box.rb
-- lib/underpass/ql/parser.rb
-- lib/underpass/ql/ql.rb
+- lib/underpass/ql/builder.rb
 - lib/underpass/ql/query.rb
+- lib/underpass/ql/query_analyzer.rb
 - lib/underpass/ql/request.rb
-- lib/underpass/ql/shape.rb
+- lib/underpass/ql/response.rb
+- lib/underpass/shape.rb
 - lib/underpass/version.rb
+- lib/underpass/way_chain.rb
 homepage: http://github.com/haiafara/underpass
 licenses:
 - MIT
 metadata:
   source_code_uri: http://github.com/haiafara/underpass
   bug_tracker_uri: http://github.com/haiafara/underpass/issues
-post_install_message: 
+  documentation_uri: https://haiafara.github.io/underpass
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -155,16 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A library that translates Overpass API responses into RGeo objects
 test_files: []

data/lib/underpass/ql/parser.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Underpass
-  module QL
-    # Deals with parsing the API request response into easily digestable objects
-    # which are then returned as matches
-    class Parser
-      def initialize(response)
-        @response = response
-        @matches = []
-      end
-
-      def parse
-        parsed_json = JSON.parse(@response.body, symbolize_names: true)
-        elements = parsed_json[:elements]
-
-        @nodes = extract_indexed_nodes(elements)
-        @ways = extract_indexed_ways(elements)
-
-        self
-      end
-
-      def matches
-        @nodes.each_value do |node|
-          @matches << point_from_node(node) if node.key?(:tags)
-        end
-
-        @ways.each_value do |way|
-          @matches << way_matches(way) if way.key?(:tags)
-        end
-
-        @matches
-      end
-
-      private
-
-      def way_matches(way)
-        if open_way?(way)
-          polygon_from_way(way, @nodes)
-        else
-          line_string_from_way(way, @nodes)
-        end
-      end
-
-      def open_way?(way)
-        Underpass::QL::Shape.open_way?(way)
-      end
-
-      def point_from_node(node)
-        Underpass::QL::Shape.point_from_node(node)
-      end
-
-      def polygon_from_way(way, nodes)
-        Underpass::QL::Shape.polygon_from_way(way, nodes)
-      end
-
-      def line_string_from_way(way, nodes)
-        Underpass::QL::Shape.line_string_from_way(way, nodes)
-      end
-
-      def extract_indexed_nodes(elements)
-        nodes = elements.select { |e| e[:type] == 'node' }
-        nodes.map { |e| [e[:id], e] }.to_h
-      end
-
-      def extract_indexed_ways(elements)
-        ways = elements.select { |e| e[:type] == 'way' }
-        ways.map { |e| [e[:id], e] }.to_h
-      end
-    end
-  end
-end

data/lib/underpass/ql/ql.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'underpass/ql/bounding_box'
-require 'underpass/ql/shape'
-require 'underpass/ql/request'
-require 'underpass/ql/parser'
-require 'underpass/ql/query'
-
-module Underpass
-  # Provides the means to work with Overpass by using the
-  # Overpass Query Language (QL). Overpass also provides an XML based
-  # query language but we're not interested in that
-  module QL
-  end
-end

data/lib/underpass/ql/shape.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Underpass
-  module QL
-    # Contains factories for various RGeo shapes from ways and nodes parsed
-    # with the Parser class
-    class Shape
-      def self.open_way?(way)
-        way[:nodes].first == way[:nodes].last
-      end
-
-      def self.polygon_from_way(way, nodes)
-        f = RGeo::Geographic.spherical_factory(srid: 4326)
-        f.polygon(line_string_from_way(way, nodes))
-      end
-
-      def self.line_string_from_way(way, nodes)
-        f = RGeo::Geographic.spherical_factory(srid: 4326)
-        f.line_string(
-          way[:nodes].map do |n|
-            f.point(nodes[n][:lon], nodes[n][:lat])
-          end
-        )
-      end
-
-      def self.point_from_node(node)
-        f = RGeo::Geographic.spherical_factory(srid: 4326)
-        f.point(node[:lon], node[:lat])
-      end
-
-      # There should be some sort of 'decorator' to return an object
-      # with the shape and a copy of the tags as
-      # Bonus: try to make it RGeo::GeoJSON.encode compatible
-      # {
-      #   tags: way[:tags],
-      #   shape: shape
-      # }
-    end
-  end
-end