geo_concerns 0.0.1

data/app/models/concerns/geo_concerns/extractors/iso19139_helper.rb

@@ -0,0 +1,50 @@
+module GeoConcerns
+  module Extractors
+    module Iso19139Helper
+      NS = {
+        'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
+        'xmlns:gco' => 'http://www.isotc211.org/2005/gco'
+      }.freeze
+
+      # TODO: Migrate this code into an XSLT?
+      # TODO: Need to support multivalued fields
+      def extract_iso19139_metadata(doc)
+        h = {}
+        doc.at_xpath('//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString', NS).tap do |node|
+          h[:title] = [node.text.strip]
+        end
+
+        doc.at_xpath('//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:extent/gmd:EX_Extent/gmd:geographicElement/gmd:EX_GeographicBoundingBox', NS).tap do |node|
+          w = node.at_xpath('gmd:westBoundLongitude/gco:Decimal', NS).text.to_f
+          e = node.at_xpath('gmd:eastBoundLongitude/gco:Decimal', NS).text.to_f
+          n = node.at_xpath('gmd:northBoundLatitude/gco:Decimal', NS).text.to_f
+          s = node.at_xpath('gmd:southBoundLatitude/gco:Decimal', NS).text.to_f
+          h[:coverage] = GeoConcerns::Coverage.new(n, e, s, w).to_s
+        end
+
+        doc.at_xpath('//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:abstract/gco:CharacterString', NS).tap do |node|
+          h[:description] = [node.text.strip]
+        end
+
+        doc.xpath('//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode[@codeListValue=\'originator\']', NS).each do |node|
+          h[:creator] = begin
+                          [node.at_xpath('ancestor-or-self::*/gmd:individualName', NS).text.strip]
+                        rescue
+                          [node.at_xpath('ancestor-or-self::*/gmd:organisationName', NS).text.strip]
+                        end
+        end
+
+        # TODO: Not sure if custodian is the same as source
+        doc.xpath('//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode[@codeListValue=\'custodian\']', NS).each do |node|
+          h[:source] = begin
+                         [node.at_xpath('ancestor-or-self::*/gmd:individualName', NS).text.strip]
+                       rescue
+                         [node.at_xpath('ancestor-or-self::*/gmd:organisationName', NS).text.strip]
+                       end
+        end
+
+        h
+      end
+    end
+  end
+end

data/app/models/concerns/geo_concerns/extractors/mods_helper.rb

@@ -0,0 +1,15 @@
+module GeoConcerns
+  module Extractors
+    module ModsHelper
+      NS = {
+        'xmlns:mods' => 'http://www.loc.gov/mods/v3'
+      }.freeze
+      def extract_mods_metadata(doc)
+        {
+          title: [doc.at_xpath('//mods:mods/mods:titleInfo/mods:title', NS).text],
+          description: [doc.at_xpath('//mods:mods/mods:abstract', NS).text]
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module GeoConcerns
+  module FileSet
+    module Derivatives
+      extend ActiveSupport::Concern
+
+      def create_derivatives(filename)
+        case mime_type
+        when *ImageFormatService.select_options.map(&:last)
+          image_derivatives(filename)
+        when *RasterFormatService.select_options.map(&:last)
+          raster_derivatives(filename)
+        when *VectorFormatService.select_options.map(&:last)
+          vector_derivatives(filename)
+        end
+
+        super
+      end
+
+      def image_derivatives(filename)
+        Hydra::Derivatives::ImageDerivatives
+          .create(filename, outputs: [{ label: :thumbnail,
+                                        format: 'png',
+                                        size: '200x150>',
+                                        url: derivative_url('thumbnail') }])
+      end
+
+      def raster_derivatives(filename)
+        GeoConcerns::Runners::RasterDerivatives
+          .create(filename, outputs: [{ input_format: mime_type,
+                                        label: :display_raster,
+                                        format: 'tif',
+                                        url: derivative_url('display_raster') },
+                                      { input_format: mime_type,
+                                        label: :thumbnail,
+                                        format: 'png',
+                                        size: '150x150',
+                                        url: derivative_url('thumbnail') }])
+      end
+
+      def vector_derivatives(filename)
+        GeoConcerns::Runners::VectorDerivatives
+          .create(filename, outputs: [{ input_format: mime_type,
+                                        label: :display_vector,
+                                        format: 'zip',
+                                        url: derivative_url('display_vector') },
+                                      { input_format: mime_type,
+                                        label: :thumbnail,
+                                        format: 'png',
+                                        size: '150x150',
+                                        url: derivative_url('thumbnail') }])
+      end
+
+      private
+
+        def derivative_path_factory
+          GeoConcerns::DerivativePath
+        end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module GeoConcerns
+  module FileSetPresenterBehavior
+    def label
+      nil
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module GeoConcerns
+  module GeoFileFormatBehavior
+    extend ActiveSupport::Concern
+
+    def image_file?
+      ImageFormatService.include?(mime_type)
+    end
+
+    def raster_file?
+      RasterFormatService.include?(mime_type)
+    end
+
+    def vector_file?
+      VectorFormatService.include?(mime_type)
+    end
+
+    def external_metadata_file?
+      MetadataFormatService.include?(mime_type)
+    end
+
+    def geo_file_format?
+      image_file? || raster_file? || vector_file? || external_metadata_file?
+    end
+
+    def image_work?
+      false
+    end
+
+    def raster_work?
+      false
+    end
+
+    def vector_work?
+      false
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module GeoConcerns
+  module GeoFileSetBehavior
+    extend ActiveSupport::Concern
+    include ::GeoConcerns::GeoFileFormatBehavior
+    include ::GeoConcerns::ImageFileBehavior
+    include ::GeoConcerns::RasterFileBehavior
+    include ::GeoConcerns::VectorFileBehavior
+    include ::GeoConcerns::ExternalMetadataFileBehavior
+    include ::GeoConcerns::FileSet::Derivatives
+  end
+end

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

@@ -0,0 +1,18 @@
+module GeoConcerns
+  # Attributes and methods for georeferenced files
+  module GeoreferencedBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      # Defines the OGC coordinate reference system (CRS) identifier for the resource
+      # @see http://www.opengeospatial.org/ogcna OGC Naming Authority
+      # @example
+      #   raster_file.cartographic_projection = "urn:ogc:def:crs:EPSG:6.3:26986"
+      property :cartographic_projection,
+               predicate: ::RDF::Vocab::Bibframe.cartographicProjection,
+               multiple: false do |index|
+        index.as :stored_searchable
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module GeoConcerns
+  # Attributes and methods for image files
+  module ImageFileBehavior
+    extend ActiveSupport::Concern
+
+    # Retrieve the Image Work of which this Object is a member
+    # @return [GeoConcerns::ImageWork]
+    def image_work
+      generic_works.select do |parent|
+        parent.class.included_modules.include?(::GeoConcerns::ImageWorkBehavior)
+      end.to_a
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module GeoConcerns
+  # Attributes and methods for image works
+  module ImageWorkBehavior
+    extend ActiveSupport::Concern
+    include ::GeoConcerns::MetadataExtractionHelper
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object,
+            Hydra::Works::Vocab::WorksTerms.GenericWork,
+            ::GeoConcerns::GeoTerms.ImageWork]
+    end
+
+    def image_file
+      members.select(&:image_file?).to_a.first
+    end
+
+    def metadata_files
+      members.select(&:external_metadata_file?)
+    end
+
+    def raster_works
+      members.select(&:raster_work?)
+    end
+
+    # Defines type by what it is and isn't
+
+    # This is an Image Resource
+    # @return [Boolean]
+    def image_work?
+      true
+    end
+
+    # This is not an ImageFile Resource
+    # @return [Boolean]
+    def image_file?
+      false
+    end
+
+    # This is not an ImageFile Resource
+    # @return [Boolean]
+    def raster_work?
+      false
+    end
+
+    # This is not an ImageFile Resource
+    # @return [Boolean]
+    def raster_file?
+      false
+    end
+
+    # This is not an ImageFile Resource
+    # @return [Boolean]
+    def vector_work?
+      false
+    end
+
+    # This is not an ImageFile Resource
+    # @return [Boolean]
+    def vector_file?
+      false
+    end
+
+    # This is not an ExternalMetadataFile Resource
+    # @return [Boolean]
+    def external_metadata_file?
+      false
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module GeoConcerns
+  module MetadataExtractionHelper
+    # Extracts properties from the constitutent external metadata file
+    # @return [Hash]
+    def extract_metadata
+      return {} if metadata_files.blank?
+      # TODO: Does not support multiple external metadata files
+      raise NotImplementedError if metadata_files.length > 1
+      metadata_files.first.extract_metadata
+    end
+
+    # Sets properties from the constitutent external metadata file
+    def populate_metadata
+      extract_metadata.each do |k, v|
+        send("#{k}=".to_sym, v) # set each property
+      end
+    end
+
+    attr_accessor :should_populate_metadata
+
+    def should_populate_metadata=(args)
+      @should_populate_metadata = args.present?
+      return unless should_populate_metadata
+      populate_metadata
+      save
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module GeoConcerns
+  # Attributes and methods for raster files
+  module RasterFileBehavior
+    extend ActiveSupport::Concern
+    include ::GeoConcerns::GeoreferencedBehavior
+    # Retrieve the Raster Work of which this Object is a member
+    # @return [GeoConcerns::Raster]
+    def raster_work
+      generic_works.select do |parent|
+        parent.class.included_modules.include?(::GeoConcerns::RasterWorkBehavior)
+      end.to_a
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# Attributes and methods for raster works
+module GeoConcerns
+  module RasterWorkBehavior
+    extend ActiveSupport::Concern
+    include ::GeoConcerns::MetadataExtractionHelper
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object,
+            Hydra::Works::Vocab::WorksTerms.GenericWork,
+            ::GeoConcerns::GeoTerms.RasterWork]
+    end
+
+    def raster_files
+      members.select(&:raster_file?)
+    end
+
+    def metadata_files
+      members.select(&:external_metadata_file?)
+    end
+
+    def vector_works
+      members.select(&:vector_work?)
+    end
+
+    # Defines type by what it is and isn't
+    # @return [Boolean]
+    def image_work?
+      false
+    end
+
+    def image_file?
+      false
+    end
+
+    def raster_work?
+      true
+    end
+
+    def raster_file?
+      false
+    end
+
+    def vector_work?
+      false
+    end
+
+    def vector_file?
+      false
+    end
+
+    def external_metadata_file?
+      false
+    end
+
+    # Retrieve all Image Works for which georeferencing generates this Raster Work
+    # @return [Array]
+    def image_works
+      ordered_by.select do |parent|
+        parent.class.included_modules.include?(::GeoConcerns::ImageWorkBehavior)
+      end
+    end
+
+    # Retrieve the only Image Works for which georeferencing generates this Raster Work
+    # @return [GeoConcerns::ImageWork]
+    def image_work
+      image_works.first
+    end
+
+    def to_solr(solr_doc = {})
+      super.tap do |doc|
+        doc[solr_name("ordered_by", :symbol)] ||= []
+        doc[solr_name("ordered_by", :symbol)] += send(:ordered_by_ids)
+      end
+    end
+
+    private
+
+      def solr_name(*args)
+        ActiveFedora.index_field_mapper.solr_name(*args)
+      end
+  end
+end

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

@@ -0,0 +1,25 @@
+module GeoConcerns
+  module SolrDocumentBehavior
+    extend ActiveSupport::Concern
+
+    def spatial
+      fetch(Solrizer.solr_name('spatial'), [])
+    end
+
+    def temporal
+      fetch(Solrizer.solr_name('temporal'), [])
+    end
+
+    def issued
+      fetch(Solrizer.solr_name('issued'), nil)
+    end
+
+    def coverage
+      fetch(Solrizer.solr_name('coverage'), nil)
+    end
+
+    def provenance
+      fetch(Solrizer.solr_name('provenance'), nil)
+    end
+  end
+end