geo_concerns 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd19ec74fed0ecc262ba3f2edd8e2023d49ae84a
-  data.tar.gz: 3c8f983b7b6390540be758426c50e398b9726026
+  metadata.gz: d850f85f49b98f05f74464b49214d41d56e2d374
+  data.tar.gz: 156c5df7de4895edc978638b2ac909f072419ad9
 SHA512:
-  metadata.gz: e50e69b852f8f347e2b1f13e521b074004bf605ca51c2711a87356f3b51bc782585f93aac6b7a50be653a05edeea418886e63d2e14d6ac2796498796171621b5
-  data.tar.gz: e9f12811b2c8c7472dadf4cce7075ebc580db63ddca8e649fe58cffad0b283052f4a7d87a1d60fd34e9a47130925d7377044de416d9315571404bf0097ab3c77
+  metadata.gz: 13b2fd98b15f4532db299158a4839bca07c6f67454a9273997040a340baad74aa3be1ba56fe4e0c09a33a5e927b1a573776de3814615a78c5761d13559ef0cf0
+  data.tar.gz: df553728f7d7cb4bd8a478bcda5c203668b5d9112617540f7c9e68db927a954b0e80c50bdb52c0799874702acc10b8f6dcca45d3517b8cf0b3f6c2bcce8db4be

data/.rubocop.yml

@@ -1,3 +1,5 @@
+require: rubocop-rspec
+
 Rails:
   Enabled: true
   

data/README.md

@@ -11,7 +11,12 @@ Rails application for developing Hydra Geo models. Built around Curation Concern
 
 ## Dependencies
 
-* [GDAL](http://www.gdal.org/)
+1. Solr
+1. [Fedora Commons](http://www.fedora-commons.org/) digital repository
+1. A SQL RDBMS (MySQL, PostgreSQL), though **note** that SQLite will be used by default if you're looking to get up and running quickly
+1. [Redis](http://redis.io/), a key-value store
+1. [ImageMagick](http://www.imagemagick.org/) with JPEG-2000 support
+1. [GDAL](http://www.gdal.org/)
     * You can install it on Mac OSX with `brew install gdal`.
     * On Ubuntu, use `sudo apt-get install gdal-bin`.
 

data/app/models/concerns/geo_concerns/file_set/derivatives.rb

@@ -19,7 +19,7 @@ module GeoConcerns
       def image_derivatives(filename)
         Hydra::Derivatives::ImageDerivatives
           .create(filename, outputs: [{ label: :thumbnail,
-                                        format: 'png',
+                                        format: 'jpg',
                                         size: '200x150>',
                                         url: derivative_url('thumbnail') }])
       end
@@ -32,8 +32,8 @@ module GeoConcerns
                                         url: derivative_url('display_raster') },
                                       { input_format: mime_type,
                                         label: :thumbnail,
-                                        format: 'png',
-                                        size: '150x150',
+                                        format: 'jpg',
+                                        size: '200x150',
                                         url: derivative_url('thumbnail') }])
       end
 
@@ -45,8 +45,8 @@ module GeoConcerns
                                         url: derivative_url('display_vector') },
                                       { input_format: mime_type,
                                         label: :thumbnail,
-                                        format: 'png',
-                                        size: '150x150',
+                                        format: 'jpg',
+                                        size: '200x150',
                                         url: derivative_url('thumbnail') }])
       end
 

data/app/models/concerns/geo_concerns/image_file_behavior.rb

@@ -6,7 +6,7 @@ module GeoConcerns
     # Retrieve the Image Work of which this Object is a member
     # @return [GeoConcerns::ImageWork]
     def image_work
-      generic_works.select do |parent|
+      parents.select do |parent|
         parent.class.included_modules.include?(::GeoConcerns::ImageWorkBehavior)
       end.to_a
     end

data/app/models/concerns/geo_concerns/raster_file_behavior.rb

@@ -6,7 +6,7 @@ module GeoConcerns
     # Retrieve the Raster Work of which this Object is a member
     # @return [GeoConcerns::Raster]
     def raster_work
-      generic_works.select do |parent|
+      parents.select do |parent|
         parent.class.included_modules.include?(::GeoConcerns::RasterWorkBehavior)
       end.to_a
     end

data/app/models/concerns/geo_concerns/vector_file_behavior.rb

@@ -6,7 +6,7 @@ module GeoConcerns
     # Retrieve the Vector Work of which this Object is a member
     # @return [GeoConcerns::VectorWork]
     def vector_work
-      generic_works.select do |parent|
+      parents.select do |parent|
         parent.class.included_modules.include?(::GeoConcerns::VectorWorkBehavior)
       end.to_a
     end

data/app/processors/geo_concerns/processors/base_geo_processor.rb

@@ -1,36 +1,66 @@
+require 'mini_magick'
+
 module GeoConcerns
   module Processors
     module BaseGeoProcessor
       extend ActiveSupport::Concern
 
       included do
-        # Returns a formatted gdal_translate command. Used to translate a raster
-        # format into a different format. Also used in generating thumbnails
-        # from vector data.
+        # Chains together and recursively runs a set of commands.
+        # Except for the last command in the queue, a temp file
+        # is created as output and is then fed into the input of the next.
+        # Temp files are deleted in reverse order after the last command
+        # is run. The commands must have the same method signature:
+        # command_name(in_path, out_path, options)
         #
         # @param in_path [String] file input path
-        # #param options [Hash] creation options
         # @param out_path [String] processor output file path
-        # @return [String] command for transforming a raster dataset
-        def self.translate(in_path, options, out_path)
-          "gdal_translate -outsize #{options[:output_size]} -q -ot Byte "\
-            "-of #{options[:output_format]} \"#{in_path}\" #{out_path}"
+        # @param method_queue [Array] set of commands to run
+        # @param options [Hash] creation options to pass
+        def self.run_commands(in_path, out_path, method_queue, options)
+          next_step = method_queue.shift
+          if method_queue.empty?
+            method(next_step).call(in_path, out_path, options)
+          else
+            temp = temp_path(out_path)
+            method(next_step).call(in_path, temp, options)
+            run_commands(temp, out_path, method_queue, options)
+            FileUtils.rm_rf(temp)
+          end
         end
 
-        # Returns a path to an intermediate temp file.
-        #
+        # Returns a path to an intermediate temp file or directory.
         # @param path [String] input file path to base temp path on
         # @return [String] tempfile path
-        def self.intermediate_file_path(path)
-          ext = File.extname(path)
-          "#{File.dirname(path)}/#{File.basename(path, ext)}_temp#{ext}"
+        def self.temp_path(path)
+          time = (Time.now.to_f * 1000).to_i
+          "#{File.dirname(path)}/#{File.basename(path, File.extname(path))}_#{time}"
+        end
+
+        # Uses imagemagick to resize an image and convert it to jpeg format.
+        # Keeps the aspect ratio of the original image and adds padding to
+        # to the ouput image.
+        # @param in_path [String] file input path
+        # @param out_path [String] processor output file path
+        # @param options [Hash] creation options
+        def self.convert(in_path, out_path, options)
+          size = options[:output_size].tr(' ', 'x')
+          # byebug
+          image = MiniMagick::Image.open(in_path)
+          image.format 'jpg'
+          image.combine_options do |i|
+            i.resize size
+            i.background 'white'
+            i.gravity 'center'
+            i.extent size
+          end
+          image.write(out_path)
         end
       end
 
       def options_for(_format)
         {
           label: label,
-          output_format: output_format,
           output_size: output_size,
           output_srid: output_srid,
           basename: basename
@@ -38,29 +68,12 @@ module GeoConcerns
       end
 
       # Returns the label directive or an empty string.
-      #
       # @return [Sting] output label
       def label
         directives.fetch(:label, '')
       end
 
-      # Tranforms the format directive into a GDAL output format.
-      #
-      # @return [Sting] derivative output format
-      def output_format
-        format = directives.fetch(:format, '').upcase
-        case format
-        when 'JPG'
-          'JPEG'
-        when 'TIF'
-          'GTiff'
-        else
-          format
-        end
-      end
-
       # Tranforms the size directive into a GDAL size parameter.
-      #
       # @return [String] derivative size
       def output_size
         return unless directives[:size]
@@ -68,15 +81,12 @@ module GeoConcerns
       end
 
       # Gets srid for reprojection derivative or returns WGS 84.
-      #
       # @return [String] spatial reference code
       def output_srid
         directives.fetch(:srid, 'EPSG:4326')
-        # directives[:srid] ? directives[:srid] : 'EPSG:4326'
       end
 
       # Extracts the base file name (without extension) from the source file path.
-      #
       # @return [String] base file name for source
       def basename
         File.basename(source_path, File.extname(source_path))

data/app/processors/geo_concerns/processors/gdal.rb

@@ -0,0 +1,49 @@
+module GeoConcerns
+  module Processors
+    module Gdal
+      extend ActiveSupport::Concern
+
+      included do
+        # Executes a gdal_translate command. Used to translate a raster
+        # format into a different format. Also used in generating thumbnails
+        # from vector data.
+        # @param in_path [String] file input path
+        # @param out_path [String] processor output file path
+        # @param options [Hash] creation options
+        def self.translate(in_path, out_path, _options)
+          execute "gdal_translate -q -ot Byte -of GTiff \"#{in_path}\" #{out_path}"
+        end
+
+        # Executes a gdalwarp command. Used to transform a raster
+        # from one projection into another.
+        # @param in_path [String] file input path
+        # @param out_path [String] processor output file path
+        # @param options [Hash] creation options
+        def self.warp(in_path, out_path, options)
+          execute "gdalwarp -q -r bilinear -t_srs #{options[:output_srid]} "\
+                  "#{in_path} #{out_path} -co 'COMPRESS=NONE'"
+        end
+
+        # Executes a gdal_translate command. Used to compress
+        # a previously uncompressed raster.
+        # @param in_path [String] file input path
+        # @param out_path [String] processor output file path
+        # @param options [Hash] creation options
+        def self.compress(in_path, out_path, options)
+          execute "gdal_translate -q -ot Byte -a_srs #{options[:output_srid]} "\
+                    "#{in_path} #{out_path} -co 'COMPRESS=LZW'"
+        end
+
+        # Executes a gdal_rasterize command. Used to rasterize vector
+        # format into raster format.
+        # @param in_path [String] file input path
+        # #param options [Hash] creation options
+        # @param out_path [String] processor output file path
+        def self.rasterize(in_path, out_path, options)
+          execute "gdal_rasterize -q -burn 0 -init 255 -ot Byte -ts "\
+                    "#{options[:output_size]} -of GTiff #{in_path} #{out_path}"
+        end
+      end
+    end
+  end
+end

data/app/processors/geo_concerns/processors/ogr.rb

@@ -0,0 +1,19 @@
+module GeoConcerns
+  module Processors
+    module Ogr
+      extend ActiveSupport::Concern
+
+      included do
+        # Executes a ogr2ogr command. Used to reproject a
+        # vector dataset and save the output as a shapefile
+        # @param in_path [String] file input path
+        # #param options [Hash] creation options
+        # @param out_path [String] processor output file path
+        def self.reproject(in_path, out_path, options)
+          execute "env SHAPE_ENCODING= ogr2ogr -q -nln #{options[:basename]} -f 'ESRI Shapefile'"\
+                    " -t_srs #{options[:output_srid]} '#{out_path}' '#{in_path}'"
+        end
+      end
+    end
+  end
+end

data/app/processors/geo_concerns/processors/raster/aig.rb

@@ -6,37 +6,33 @@ module GeoConcerns
 
         def self.encode(path, options, output_file)
           unzip(path, output_file) do |zip_path|
-            info = gdalinfo(zip_path)
-            options[:min_max] = get_raster_min_max(info)
+            info = Info.new(zip_path)
+            options[:min_max] = info.min_max
             case options[:label]
             when :thumbnail
-              encode_raster(zip_path, options, output_file)
+              encode_raster(zip_path, output_file, options)
             when :display_raster
-              reproject_raster(zip_path, options, output_file)
+              reproject_raster(zip_path, output_file, options)
             end
           end
         end
 
-        def self.reproject_raster(in_path, options, out_path)
-          options[:output_size] = '100% 100%'
-          intermediate_file = intermediate_file_path(out_path)
-          execute warp(in_path, options, intermediate_file)
-          execute translate(intermediate_file, options, out_path)
-          FileUtils.rm_rf(intermediate_file)
+        # Set of commands to run to reproject the AIG.
+        # @return [Array] set of command name symbols
+        def self.reproject_queue
+          [:warp, :translate]
         end
 
-        # Returns a formatted gdal_translate command to translate a raster
+        # Executes a gdal_translate command to translate a raster
         # format into a different format with a scaling options. This command
         # scales the min and max values of the raster into the 0 to 255 range.
         # Scale is inverted (255 to 0) to create a better visualization.
-        #
         # @param in_path [String] file input path
-        # #param options [Hash] creation options
         # @param out_path [String] processor output file path
-        # @return [String] command for tranforming a usgs dem dataset
-        def self.translate(in_path, options, out_path)
-          "gdal_translate -scale #{options[:min_max]} 255 0 -outsize #{options[:output_size]} "\
-             "-q -ot Byte -of #{options[:output_format]} \"#{in_path}\" #{out_path}"
+        # @param options [Hash] creation options
+        def self.translate(in_path, out_path, options)
+          execute "gdal_translate -scale #{options[:min_max]} 255 0 "\
+                    "-q -ot Byte -of GTiff \"#{in_path}\" #{out_path}"
         end
       end
     end

data/app/processors/geo_concerns/processors/raster/base.rb

@@ -4,69 +4,35 @@ module GeoConcerns
       class Base < Hydra::Derivatives::Processors::Processor
         include Hydra::Derivatives::Processors::ShellBasedProcessor
         include GeoConcerns::Processors::BaseGeoProcessor
+        include GeoConcerns::Processors::Gdal
 
         def self.encode(path, options, output_file)
           case options[:label]
           when :thumbnail
-            encode_raster(path, options, output_file)
+            encode_raster(path, output_file, options)
           when :display_raster
-            reproject_raster(path, options, output_file)
+            reproject_raster(path, output_file, options)
           end
         end
 
-        def self.encode_raster(in_path, options, out_path)
-          execute translate(in_path, options, out_path)
-          File.unlink("#{out_path}.aux.xml")
+        # Set of commands to run to encode the raster thumbnail.
+        # @return [Array] set of command name symbols
+        def self.encode_queue
+          [:translate, :convert]
         end
 
-        def self.reproject_raster(in_path, options, out_path)
-          intermediate_file = intermediate_file_path(out_path)
-          execute warp(in_path, options, intermediate_file)
-          execute compress(intermediate_file, options, out_path)
-          FileUtils.rm_rf(intermediate_file)
+        # Set of commands to run to reproject the raster.
+        # @return [Array] set of command name symbols
+        def self.reproject_queue
+          [:warp, :compress]
         end
 
-        # Returns a formatted gdalwarp. Used to transform a raster
-        # from one projection into another.
-        #
-        # @param in_path [String] file input path
-        # #param options [Hash] creation options
-        # @param out_path [String] processor output file path
-        # @return [String] command for reprojecting a raster
-        def self.warp(in_path, options, out_path)
-          "gdalwarp -q -r bilinear -t_srs #{options[:output_srid]} "\
-            " #{in_path} #{out_path} -co 'COMPRESS=NONE'"
+        def self.encode_raster(in_path, out_path, options)
+          run_commands(in_path, out_path, encode_queue, options)
         end
 
-        # Returns a formatted gdal_translate command. Used compress
-        # an previously uncompressed raster.
-        #
-        # @param in_path [String] file input path
-        # #param options [Hash] creation options
-        # @param out_path [String] processor output file path
-        # @return [String] command for compressing a raster dataset
-        def self.compress(in_path, options, out_path)
-          "gdal_translate -q -ot Byte -a_srs #{options[:output_srid]} "\
-            "\"#{in_path}\" #{out_path} -co 'COMPRESS=LZW'"
-        end
-
-        # Given an output string from the gdalinfo command, returns
-        # a formatted string for the computed min and max values.
-        #
-        # @param info_string [String] ouput from gdalinfo
-        # @return [String] computed min and max values
-        def self.get_raster_min_max(info_string)
-          match = %r{(?<=Computed Min/Max=).*?(?=\s)}.match(info_string)
-          match ? match[0].tr(',', ' ') : ''
-        end
-
-        # Runs the gdalinfo command and returns the result as a string.
-        #
-        # @param path [String] path to raster file
-        # @return [String] output of gdalinfo
-        def self.gdalinfo(path)
-          stdout, _stderr, _status = Open3.capture3("gdalinfo -mm #{path}")
-          stdout
+        def self.reproject_raster(in_path, out_path, options)
+          run_commands(in_path, out_path, reproject_queue, options)
         end
       end
     end

data/app/processors/geo_concerns/processors/raster/dem.rb

@@ -2,43 +2,26 @@ module GeoConcerns
   module Processors
     module Raster
       class Dem < GeoConcerns::Processors::Raster::Base
-        def self.encode_raster(in_path, options, out_path)
-          intermediate_file = intermediate_file_path(out_path)
-          execute translate(in_path, options, intermediate_file)
-          execute hillshade(intermediate_file, options, out_path)
-          FileUtils.rm_rf(intermediate_file)
-          File.unlink("#{out_path}.aux.xml")
+        # Set of commands to run to encode the DEM thumbnail.
+        # @return [Array] set of command name symbols
+        def self.encode_queue
+          [:hillshade, :convert]
         end
 
-        def self.reproject_raster(in_path, options, out_path)
-          intermediate_file = intermediate_file_path(out_path)
-          execute hillshade(in_path, options, intermediate_file)
-          execute warp(intermediate_file, options, out_path)
-          FileUtils.rm_rf(intermediate_file)
+        # Set of commands to run to reproject the DEM.
+        # @return [Array] set of command name symbols
+        def self.reproject_queue
+          [:hillshade, :warp]
         end
 
-        # Returns a formatted gdal_translate command to translate a vector
-        # in USGS DEM format into a different format.
-        #
-        # @param in_path [String] file input path
-        # #param options [Hash] creation options
-        # @param out_path [String] processor output file path
-        # @return [String] command for tranforming a usgs dem dataset
-        def self.translate(in_path, options, out_path)
-          "gdal_translate -outsize #{options[:output_size]} -q -ot Byte "\
-            "-of USGSDEM #{in_path} #{out_path}"
-        end
-
-        # Returns a formatted gdal hillshade command. Calculates hillshade
+        # Executes a gdal hillshade command. Calculates hillshade
         # on a raster that contains elevation data.
-        #
         # @param in_path [String] file input path
-        # #param options [Hash] creation options
-        # @param output_file [String] processor output file path
-        # @return [String] command for generating a hillshade
-        def self.hillshade(in_path, options, out_path)
-          "gdaldem hillshade -q "\
-            "-of #{options[:output_format]} \"#{in_path}\" #{out_path}"
+        # @param out_path [String] processor output file path
+        # @param options [Hash] creation options
+        def self.hillshade(in_path, out_path, _options)
+          execute "gdaldem hillshade -q "\
+                    "-of GTiff \"#{in_path}\" #{out_path}"
         end
       end
     end