stanford-geo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9084a2315eada6391743c282970117cd111473c80987d24ad858bc6efe044c3
+  data.tar.gz: b91d4f6689a79e01a381d52b3575a313be663309a07b7f35d9403f5c8a9265b7
+SHA512:
+  metadata.gz: 22fdb6a5944c360c0d88d56b4f3dd03c266c10b804b08f7295ba6868a6c6763e02823a3ce224c1636e6ff3866e7421f2027eda7a21755b0387df673604f579ff
+  data.tar.gz: 431f1ccd94e6df58a2c04f0071f6e7ee50f4037552f059889f760e119e28be0495ca1244499aef5e9244f5aa3f40fa11840be479bc0fc40541b65db4750873d9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  AllowedMethods: ['describe', 'context']

data/README.md

@@ -0,0 +1,29 @@
+# Stanford::Geo
+
+This gem provides some shared classes for dealing with Geo data.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, 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 the created tag, 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/sul-dlss/stanford-geo.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/stanford/geo/coordinate.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Stanford
+  module Geo
+    ##
+    # Geospatial coordinate parsing
+    class Coordinate
+      COORD_TO_DECIMAL_REGEX = Regexp.union(
+        /(?<dir>[NESW])\s*(?<deg>\d+)[°⁰º](?:(?<min>\d+)[ʹ'])?(?:(?<sec>\d+)[ʺ"])?/,
+        /^\s*(?<dir>[NESW])\s*(?<deg>\d+(?:[.]\d+)?)\s*$/
+      )
+
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      # @return [String] the coordinate in WKT/CQL ENVELOPE representation
+      def as_envelope
+        return unless valid?
+
+        "ENVELOPE(#{bounds[:min_x]}, #{bounds[:max_x]}, #{bounds[:max_y]}, #{bounds[:min_y]})"
+      end
+
+      # @return [String] the coordinate in Solr 4.x+ bbox-format representation
+      def as_bbox
+        return unless valid?
+
+        "#{bounds[:min_x]} #{bounds[:min_y]} #{bounds[:max_x]} #{bounds[:max_y]}"
+      end
+
+      # @return [Boolean] true iff the coordinates are geographically valid
+      def valid?
+        return false if bounds.empty?
+
+        range_x = -180.0..180.0
+        range_y = -90.0..90.0
+
+        range_x.include?(bounds[:min_x]) &&
+          range_x.include?(bounds[:max_x]) &&
+          range_y.include?(bounds[:min_y]) &&
+          range_y.include?(bounds[:max_y])
+      end
+
+      private
+
+      def bounds
+        @bounds ||= begin
+          matches = cleaner_coordinate(value).match %r{\A(?<lat>[EW].+-+.+)\s*/\s*(?<lng>[NS].+-+.+)\Z}
+          return {} unless matches
+
+          min_x, max_x = matches["lat"].split(/-+/).map { |x| coord_to_decimal(x) }.minmax
+          min_y, max_y = matches["lng"].split(/-+/).map { |y| coord_to_decimal(y) }.minmax
+          { min_x: min_x, min_y: min_y, max_x: max_x, max_y: max_y }
+        end
+      end
+
+      # @deprecated see GeoUtils
+      def coord
+        cleaner_coordinate(value)
+      end
+
+      # @param [String] val Coordinates value
+      # @return [String] cleaned value (strips parens and period), or the original value
+      def cleaner_coordinate(val)
+        matches = val.match(/^\(?([^)]+)\)?\.?$/)
+        matches ? matches[1] : val
+      end
+
+      # @param [String] point coordinate point in degrees notation
+      # @return [Float] converted value in decimal notation
+      def coord_to_decimal(point)
+        match = COORD_TO_DECIMAL_REGEX.match(point)
+        return Float::INFINITY unless match
+
+        dec = match["deg"].to_f
+        dec += match["min"].to_f / 60
+        dec += match["sec"].to_f / 60 / 60
+        dec = -1 * dec if match["dir"] == "W" || match["dir"] == "S"
+        dec
+      end
+    end
+  end
+end

data/lib/stanford/geo/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stanford
+  module Geo
+    VERSION = "0.1.0"
+  end
+end

data/lib/stanford/geo.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "geo/version"
+require_relative "geo/coordinate"
+
+module Stanford
+  module Geo
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/stanford/geo.rbs

@@ -0,0 +1,6 @@
+module Stanford
+  module Geo
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: stanford-geo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-08 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jcoyne@justincoyne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/stanford/geo.rb
+- lib/stanford/geo/coordinate.rb
+- lib/stanford/geo/version.rb
+- sig/stanford/geo.rbs
+homepage: https://github.com/sul-dlss/stanford-geo
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss/stanford-geo
+  source_code_uri: https://github.com/sul-dlss/stanford-geo
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Geo related data for Stanford Libraries
+test_files: []