geo_works 0.1.0

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

@@ -0,0 +1,50 @@
+module GeoWorks
+  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] = GeoWorks::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_works/extractors/mods_helper.rb

@@ -0,0 +1,15 @@
+module GeoWorks
+  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_works/file_set_metadata.rb

@@ -0,0 +1,15 @@
+module GeoWorks
+  # Attributes and methods for basic geospatial metadata used by Works
+  module FileSetMetadata
+    extend ActiveSupport::Concern
+
+    included do
+      apply_schema ::GeoWorks::FileSetMetadataRequired,
+                   ActiveFedora::SchemaIndexingStrategy.new(
+                     ActiveFedora::Indexers::GlobalIndexer.new(
+                       [:stored_searchable, :symbol]
+                     )
+                   )
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+module GeoWorks
+  module GeoFileFormatBehavior
+    extend ActiveSupport::Concern
+
+    def image_file?
+      GeoWorks::ImageFormatService.include?(geo_mime_type)
+    end
+
+    def raster_file?
+      GeoWorks::RasterFormatService.include?(geo_mime_type)
+    end
+
+    def vector_file?
+      GeoWorks::VectorFormatService.include?(geo_mime_type)
+    end
+
+    def external_metadata_file?
+      GeoWorks::MetadataFormatService.include?(geo_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_works/geo_file_set_behavior.rb

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

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

@@ -0,0 +1,18 @@
+module GeoWorks
+  # 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_works/image_file_behavior.rb

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

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

@@ -0,0 +1,69 @@
+module GeoWorks
+  # Attributes and methods for image works
+  module ImageWorkBehavior
+    extend ActiveSupport::Concern
+    include ::GeoWorks::MetadataExtractionHelper
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object,
+            Hydra::Works::Vocab::WorksTerms.GenericWork,
+            ::GeoWorks::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_works/metadata_extraction_helper.rb

@@ -0,0 +1,27 @@
+module GeoWorks
+  module MetadataExtractionHelper
+    # Extracts properties from the constitutent external metadata file
+    # @return [Hash]
+    def extract_metadata(id)
+      return {} if metadata_files.blank?
+      metadata_file = metadata_files.find { |f| f.id == id }
+      metadata_file.extract_metadata if metadata_file
+    end
+
+    # Sets properties from the constitutent external metadata file
+    def populate_metadata(id)
+      extract_metadata(id).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? && args != ''
+      return unless should_populate_metadata
+      populate_metadata(args)
+      save
+    end
+  end
+end

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

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

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

@@ -0,0 +1,82 @@
+# Attributes and methods for raster works
+module GeoWorks
+  module RasterWorkBehavior
+    extend ActiveSupport::Concern
+    include ::GeoWorks::MetadataExtractionHelper
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object,
+            Hydra::Works::Vocab::WorksTerms.GenericWork,
+            ::GeoWorks::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?(::GeoWorks::ImageWorkBehavior)
+      end
+    end
+
+    # Retrieve the only Image Works for which georeferencing generates this Raster Work
+    # @return [GeoWorks::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_works/solr_document_behavior.rb

@@ -0,0 +1,46 @@
+module GeoWorks
+  module SolrDocumentBehavior
+    extend ActiveSupport::Concern
+    include Hyrax::SolrDocumentBehavior
+
+    # @return [Array<String>]
+    def spatial
+      fetch(Solrizer.solr_name('spatial'), [])
+    end
+
+    # @return [Array<String>]
+    def temporal
+      fetch(Solrizer.solr_name('temporal'), [])
+    end
+
+    # @return [String]
+    def issued
+      fetch(Solrizer.solr_name('issued'), nil)
+    end
+
+    # @return [String]
+    def coverage
+      fetch(Solrizer.solr_name('coverage'), nil)
+    end
+
+    # @return [String]
+    def provenance
+      name = I18n.t('hyrax.institution_name')
+      raise ArgumentError, "Provenance required in configuration" unless name.present?
+      name
+    end
+
+    # @return [DateTime]
+    def layer_modified
+      # TODO: `date_modified` isn't working correctly -- it's stored as a string not a date
+      # @see 'https://github.com/projecthydra/curation_concerns/issues/957'
+      dt = first(Solrizer.solr_name('system_modified', :stored_sortable, type: :date))
+      dt.nil? ? nil : DateTime.parse(dt).utc
+    end
+
+    # @return [Array<String>]
+    def identifier
+      fetch(Solrizer.solr_name('identifier'), [])
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module GeoWorks
+  # Attributes and methods for vector files
+  module VectorFileBehavior
+    extend ActiveSupport::Concern
+    include ::GeoWorks::GeoreferencedBehavior
+    # Retrieve the Vector Work of which this Object is a member
+    # @return [GeoWorks::VectorWork]
+    def vector_work
+      parents.select do |parent|
+        parent.class.included_modules.include?(::GeoWorks::VectorWorkBehavior)
+      end.to_a
+    end
+  end
+end

data/app/models/concerns/geo_works/vector_work_behavior.rb

@@ -0,0 +1,78 @@
+module GeoWorks
+  # Attributes and methods for vector works
+  module VectorWorkBehavior
+    extend ActiveSupport::Concern
+    include ::GeoWorks::MetadataExtractionHelper
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object,
+            Hydra::Works::Vocab::WorksTerms.GenericWork,
+            ::GeoWorks::GeoTerms.VectorWork]
+    end
+
+    def vector_files
+      members.select(&:vector_file?)
+    end
+
+    def metadata_files
+      members.select(&:external_metadata_file?)
+    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?
+      false
+    end
+
+    def raster_file?
+      false
+    end
+
+    def vector_work?
+      true
+    end
+
+    def vector_file?
+      false
+    end
+
+    def external_metadata_file?
+      false
+    end
+
+    # Retrieve all Raster Works for which this Vector Work can be extracted
+    # @return [Array]
+    def raster_works
+      ordered_by.select do |parent|
+        parent.class.included_modules.include?(::GeoWorks::RasterWorkBehavior)
+      end
+    end
+
+    # Retrieve the only Raster Work for which feature extraction generates this Vector Work
+    # @return [GeoWorks::RasterWork]
+    def raster_work
+      raster_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