ddr-models 2.11.0 → 3.0.0.alpha.1

data/lib/ddr/events.rb

@@ -4,7 +4,6 @@ module Ddr
 
     autoload :Event
     autoload :CreationEvent
-    autoload :DeaccessionEvent
     autoload :DeletionEvent
     autoload :FixityCheckEvent
     autoload :IngestionEvent

data/lib/ddr/events/deletion_event.rb

@@ -1,8 +1,12 @@
-module Ddr::Events
-  class DeletionEvent < Event
-    include PreservationEventBehavior
+module Ddr
+  module Events
+    class DeletionEvent < Event
 
-    self.description = "Object deleted"
-    self.preservation_event_type = :del
+      include PreservationEventBehavior
+
+      self.description = "Object deleted"
+      self.preservation_event_type = :del
+
+    end
   end
 end

data/lib/ddr/events/event.rb

@@ -39,20 +39,10 @@ module Ddr
       # Receive message sent by ActiveSupport::Notifications
       def self.call(*args)
         notification = ActiveSupport::Notifications::Event.new(*args)
-        payload = notification.payload.dup
-        payload[:event_date_time] ||= notification.time
-        create do |event|
-          event.attributes = payload.select { |k, v| event.has_attribute?(k) }
-          yield [event, notification] if block_given?
-        end
+        create(notification.payload)
       end
 
-      # Repository software version -- e.g., "Fedora Repository 3.7.0"
-      def self.repository_software
-        @@repository_software ||= ActiveFedora::Base.connection_for_pid(0).repository_profile
-                                                    .values_at(:repositoryName, :repositoryVersion)
-                                                    .join(" ")
-      end
+      # Scopes
 
       def self.for_object(obj)
         for_pid(obj.pid)
@@ -62,6 +52,8 @@ module Ddr
         where(pid: pid)
       end
 
+      # Rendering methods
+
       def display_type
         # Ddr::Events::UpdateEvent => "Update"
         @display_type ||= self.class.to_s.split("::").last.sub("Event", "").titleize
@@ -75,6 +67,8 @@ module Ddr
         comment.present? ? comment : summary
       end
 
+      # Outcome methods
+
       def success!
         self.outcome = SUCCESS
       end
@@ -91,6 +85,7 @@ module Ddr
         outcome == FAILURE
       end
 
+      # Object getter and setter
       def object
         @object ||= ActiveFedora::Base.find(pid) if pid
       end
@@ -121,7 +116,7 @@ module Ddr
       protected
 
       def set_defaults
-        self.attributes = defaults.reject { |attr, val| attribute_present?(attr) }
+        self.attributes = defaults.reject { |attr, val| attribute_present? attr }
       end
 
       def defaults

data/lib/ddr/events/fixity_check_event.rb

@@ -32,12 +32,6 @@ module Ddr
           Ddr::Index::Fields::LAST_FIXITY_CHECK_OUTCOME => outcome }
       end
 
-      protected
-
-      def default_software
-        self.class.repository_software
-      end
-
     end
   end
 end

data/lib/ddr/events/ingestion_event.rb

@@ -1,8 +1,12 @@
-module Ddr::Events
-  class IngestionEvent < Event
-    include PreservationEventBehavior
+module Ddr
+  module Events
+    class IngestionEvent < Event
 
-    self.preservation_event_type = :ing
-    self.description = "Object ingested into the repository"
+      include PreservationEventBehavior
+
+      self.preservation_event_type = :ing
+      self.description = "Object ingested into the repository"
+
+    end
   end
 end

data/lib/ddr/events/update_event.rb

@@ -1,22 +1,9 @@
-module Ddr::Events
-  class UpdateEvent < Event
+module Ddr
+  module Events
+    class UpdateEvent < Event
 
-    self.description = "Object updated"
+      self.description = "Object updated"
 
-    def self.call(*args)
-      super do |event, notification|
-        attrs_changed = notification.payload[:attributes_changed]
-        ds_changed = notification.payload[:datastreams_changed]
-        detail = [
-          "Datastreams changed: #{ds_changed.join(', ')}",
-          event.detail,
-        ]
-        if attrs_changed.present?
-          detail << "Attributes changed: #{attrs_changed}"
-        end
-        event.detail = detail.compact.join("\n\n")
-      end
     end
-
   end
 end

data/lib/ddr/index.rb

@@ -7,20 +7,20 @@ module Ddr
     autoload :CSVQueryResult
     autoload :DocumentBuilder
     autoload :Field
-    autoload :FieldAttribute
     autoload :Fields
     autoload :Filter
+    autoload :Filters
+    autoload :LegacyLicenseFields
     autoload :Query
     autoload :QueryBuilder
     autoload :QueryClause
-    autoload :QueryParams
     autoload :QueryResult
+    autoload :QueryValue
     autoload :Response
-    autoload :SortOrder
     autoload :UniqueKeyField
 
     def self.pids
-      builder = QueryBuilder.new { field UniqueKeyField.instance }
+      builder = QueryBuilder.new
       query = builder.query
       query.pids
     end

data/lib/ddr/index/abstract_query_result.rb

@@ -2,15 +2,16 @@ module Ddr::Index
   class AbstractQueryResult
     include Enumerable
 
-    attr_reader :query
+    attr_reader :query, :conn
     delegate :params, to: :query
 
     def initialize(query)
-      @query = query.dup.freeze
+      @query = query
+      @conn = Connection.new
     end
 
     def count
-      response = Connection.select(params, rows: 0)
+      response = conn.select(params, rows: 0)
       response.num_found
     end
 

data/lib/ddr/index/connection.rb

@@ -1,36 +1,17 @@
-require "rsolr"
-require "forwardable"
-
 module Ddr::Index
-  #
-  # Wraps an RSolr connection
-  #
-  class Connection
-
-    module Methods
-      extend Forwardable
-
-      delegate [:get, :post, :paginate] => :solr
-
-      def solr
-        RSolr.connect(ActiveFedora.solr_config)
-      end
+  class Connection < SimpleDelegator
 
-      def select(params, extra={})
-        Response.new post("select", params: params.merge(extra))
-      end
-
-      def page(*args)
-        Response.new paginate(*args)
-      end
+    def initialize
+      super RSolr.connect(ActiveFedora.solr_config)
+    end
 
-      def count(params)
-        select(params, rows: 0).num_found
-      end
+    def select(params, extra={})
+      Response.new get("select", params: params.merge(extra))
     end
 
-    extend Methods
-    include Methods
+    def page(*args)
+      Response.new paginate(*args)
+    end
 
   end
 end

data/lib/ddr/index/csv_query_result.rb

@@ -3,73 +3,58 @@ require "csv"
 module Ddr::Index
   class CSVQueryResult < AbstractQueryResult
 
-    MAX_ROWS         = 10**8 # Just set to a really high number :)
-    CSV_MV_SEPARATOR = ";"
+    MAX_ROWS = 10**8
 
-    delegate :headers, :to_s, :to_csv, to: :table
+    COL_SEP    = CSV::DEFAULT_OPTIONS[:col_sep].freeze
+    QUOTE_CHAR = CSV::DEFAULT_OPTIONS[:quote_char].freeze
 
-    def delete_empty_columns!
-      table.by_col!.delete_if { |c, vals| vals.all?(&:nil?) }
-    end
+    SOLR_CSV_OPTS = {
+      "csv.header"       => "false",
+      "csv.mv.separator" => "|",
+      "wt"               => "csv",
+    }.freeze
 
-    def each(&block)
-      table.by_row!.each(&block)
-    end
+    CSV_OPTS = {
+      return_headers: true,
+      write_headers:  true,
+    }.freeze
 
-    def [](index_or_header)
-      table.by_col_or_row![index_or_header]
-    end
+    attr_reader :csv_opts, :solr_csv_opts
 
-    def table
-      @table ||= CSV.parse(data, csv_opts)
-    end
+    def initialize(query, **opts)
+      super(query)
 
-    def csv_opts
-      { headers:        csv_headers,
-        converters:     [convert_semicolons, convert_escaped_newlines],
-        return_headers: false,
-        write_headers:  true,
-      }
-    end
+      @solr_csv_opts = SOLR_CSV_OPTS.dup
+      @solr_csv_opts[:rows] ||= MAX_ROWS
 
-    def solr_csv_opts
-      { "csv.mv.separator" => CSV_MV_SEPARATOR,
-        "csv.header"       => solr_csv_header?,
-        "rows"             => solr_csv_rows,
-        "wt"               => "csv",
-      }
-    end
+      @csv_opts = CSV_OPTS.dup
+      @csv_opts[:headers] = query.fields.map(&:label)
 
-    def query_field_headings
-      query.fields.map { |f| f.respond_to?(:heading) ? f.heading : f.to_s }
+      # Set column separator and quote character consistently
+      @csv_opts[:col_sep]    = @solr_csv_opts["csv.separator"]    = opts.fetch(:col_sep, COL_SEP)
+      @csv_opts[:quote_char] = @solr_csv_opts["csv.encapsulator"] = opts.fetch(:quote_char, QUOTE_CHAR)
     end
 
-    def csv_headers
-      query.fields.empty? ? :first_row : query_field_headings
+    def csv
+      CSV.new(data, csv_opts)
     end
 
-    def solr_csv_header?
-      csv_headers == :first_row
+    def each
+      csv.each
     end
 
-    def solr_csv_rows
-      query.rows || MAX_ROWS
+    def to_s
+      csv.string
     end
 
-    def solr_csv_params
+    private
+
+    def csv_params
       params.merge(solr_csv_opts)
     end
 
     def data
-      Connection.get("select", params: solr_csv_params)
-    end
-
-    def convert_semicolons
-      lambda { |f| f.gsub(/\\#{CSV_MV_SEPARATOR}/, CSV_MV_SEPARATOR) rescue f }
-    end
-
-    def convert_escaped_newlines
-      lambda { |f| f.gsub(/\\r/, "\r").gsub(/\\n/, "\n") rescue f }
+      conn.get "select", params: csv_params
     end
 
   end

data/lib/ddr/index/field.rb

@@ -16,17 +16,7 @@ module Ddr::Index
     end
 
     def label
-      I18n.t "#{i18n_base}.label", default: base.titleize
-    end
-
-    def heading
-      I18n.t "#{i18n_base}.heading", default: base
-    end
-
-    private
-
-    def i18n_base
-      "ddr.index.fields.#{base}"
+      I18n.t "ddr.index.fields.#{base}", default: base.titleize
     end
 
   end

data/lib/ddr/index/fields.rb

@@ -1,169 +1,86 @@
 module Ddr::Index
   module Fields
-    extend Deprecation
+
+    def self.get(name)
+      const_get(name.to_s.upcase, false)
+    end
+
+    def self.techmd
+      constants(false)
+        .select { |c| c =~ /\ATECHMD_/ }
+        .map    { |c| const_get(c) }
+    end
 
     ID = UniqueKeyField.instance
+    PID = UniqueKeyField.instance
 
     ACCESS_ROLE                 = Field.new :access_role, :stored_sortable
     ACTIVE_FEDORA_MODEL         = Field.new :active_fedora_model, :stored_sortable
     ADMIN_SET                   = Field.new :admin_set, :stored_sortable
     ADMIN_SET_FACET             = Field.new :admin_set_facet, :facetable
-    ADMIN_SET_TITLE             = Field.new :admin_set_title, :stored_sortable
-    AFFILIATION                 = Field.new :affiliation, :stored_searchable
-    AFFILIATION_FACET           = Field.new :affiliation_facet, :facetable
-    ALEPH_ID                    = Field.new :aleph_id, :stored_sortable
-    ALL_TEXT                    = Field.new :all_text, solr_name: "all_text_timv"
-    ARRANGER_FACET              = Field.new :arranger_facet, :facetable
-    ASPACE_ID                   = Field.new :aspace_id, :stored_sortable
-    ATTACHED_FILES_HAVING_CONTENT =
-      Field.new :attached_files_having_content, :symbol
-    BIBLICAL_BOOK_FACET         = Field.new :biblical_book_facet, :facetable
     BOX_NUMBER_FACET            = Field.new :box_number_facet, :facetable
-    CATEGORY_FACET              = Field.new :category_facet, :facetable
-    CHAPTER_AND_VERSE_FACET     = Field.new :chapter_and_verse_facet, :facetable
     COLLECTION_FACET            = Field.new :collection_facet, :facetable
-    COLLECTION_TITLE            = Field.new :collection_title, :stored_sortable
     COLLECTION_URI              = Field.new :collection_uri, :symbol
-    COMPANY_FACET               = Field.new :company_facet, :facetable
-    COMPOSER_FACET              = Field.new :composer_facet, :facetable
-    CONTENT_CONTROL_GROUP       = Field.new :content_control_group, :searchable, type: :string
-    CONTENT_CREATE_DATE         = Field.new :content_create_date, :stored_sortable, type: :date
-    CONTENT_SIZE                = Field.new :content_size, solr_name: "content_size_lsi"
+    CONTENT_SIZE                = Field.new :content_size, :stored_sortable, type: :integer
     CONTENT_SIZE_HUMAN          = Field.new :content_size_human, :symbol
-    CONTRIBUTOR_FACET           = Field.new :contributor_facet, :facetable
     CREATOR_FACET               = Field.new :creator_facet, :facetable
     DATE_FACET                  = Field.new :date_facet, :facetable
     DATE_SORT                   = Field.new :date_sort, :sortable
-    DC_IS_PART_OF               = Field.new :isPartOf, :symbol
     DEPOSITOR                   = Field.new :depositor, :stored_sortable
     DISPLAY_FORMAT              = Field.new :display_format, :stored_sortable
     DOI                         = Field.new :doi, :symbol
     EAD_ID                      = Field.new :ead_id, :stored_sortable
-    ENGRAVER_FACET              = Field.new :engraver_facet, :facetable
-    EXTRACTED_TEXT              = Field.new :extracted_text, solr_name: "extracted_text_tsm"
-    FOLDER_FACET                = Field.new :folder_facet, :facetable
-    FORMAT_FACET                = Field.new :format_facet, :facetable
-    GENRE_FACET                 = Field.new :genre_facet, :facetable
+    EXTRACTED_TEXT              = Field.new :extracted_text, :searchable, type: :text
     HAS_MODEL                   = Field.new :has_model, :symbol
     IDENTIFIER_ALL              = Field.new :identifier_all, :symbol
-    ILLUSTRATED_FACET           = Field.new :illustrated_facet, :facetable
-    ILLUSTRATOR_FACET           = Field.new :illustrator_facet, :facetable
-    INGESTED_BY                 = Field.new :ingested_by, :stored_sortable
-    INGESTION_DATE              = Field.new :ingestion_date, :stored_sortable, type: :date
-    INSTRUMENTATION_FACET       = Field.new :instrumentation_facet, :facetable
-    INTERNAL_URI                = Field.new :internal_uri, :stored_sortable
-    INTERVIEWER_NAME_FACET      = Field.new :interviewer_name_facet, :facetable
     IS_ATTACHED_TO              = Field.new :is_attached_to, :symbol
     IS_EXTERNAL_TARGET_FOR      = Field.new :is_external_target_for, :symbol
-    IS_FORMAT_OF                = Field.new :isFormatOf, :symbol
-    IS_GOVERNED_BY              = Field.new :is_governed_by, :symbol
-    IS_LOCKED                   = Field.new :is_locked, :stored_sortable
+    IS_GOVERNED_BY              = Field.new :is_governed_by, solr_name: "isGovernedBy_ssim"
     IS_MEMBER_OF                = Field.new :is_member_of, :symbol
     IS_MEMBER_OF_COLLECTION     = Field.new :is_member_of_collection, :symbol
     IS_PART_OF                  = Field.new :is_part_of, :symbol
-    LANGUAGE_FACET              = Field.new :language_facet, :facetable
-    LANGUAGE_NAME               = Field.new :language_name, :stored_searchable
     LAST_FIXITY_CHECK_ON        = Field.new :last_fixity_check_on, :stored_sortable, type: :date
     LAST_FIXITY_CHECK_OUTCOME   = Field.new :last_fixity_check_outcome, :symbol
     LAST_VIRUS_CHECK_ON         = Field.new :last_virus_check_on, :stored_sortable, type: :date
     LAST_VIRUS_CHECK_OUTCOME    = Field.new :last_virus_check_outcome, :symbol
     LICENSE                     = Field.new :license, :stored_sortable
-    LITHOGRAPHER_FACET          = Field.new :lithographer_facet, :facetable
     LOCAL_ID                    = Field.new :local_id, :stored_sortable
-    LYRICIST_FACET              = Field.new :lyricist_facet, :facetable
     MEDIA_SUB_TYPE              = Field.new :content_media_sub_type, :facetable
     MEDIA_MAJOR_TYPE            = Field.new :content_media_major_type, :facetable
     MEDIA_TYPE                  = Field.new :content_media_type, :symbol
-    MEDIUM_FACET                = Field.new :medium_facet, :facetable
     MULTIRES_IMAGE_FILE_PATH    = Field.new :multires_image_file_path, :stored_sortable
-    NESTED_PATH                 = Field.new :nested_path, :stored_sortable
-    NESTED_PATH_TEXT            = Field.new :nested_path_text, :searchable
     OBJECT_PROFILE              = Field.new :object_profile, :displayable
     OBJECT_STATE                = Field.new :object_state, :stored_sortable
     OBJECT_CREATE_DATE          = Field.new :system_create, :stored_sortable, type: :date
     OBJECT_MODIFIED_DATE        = Field.new :system_modified, :stored_sortable, type: :date
-    ORIGINAL_FILENAME           = Field.new :original_filename, solr_name: "admin_metadata__original_filename_ssi"
-    PERFORMER_FACET             = Field.new :performer_facet, :facetable
     PERMANENT_ID                = Field.new :permanent_id, :stored_sortable, type: :string
     PERMANENT_URL               = Field.new :permanent_url, :stored_sortable, type: :string
-    PLACEMENT_COMPANY_FACET     = Field.new :placement_company_facet, :facetable
     POLICY_ROLE                 = Field.new :policy_role, :symbol
-    PRODUCER_FACET              = Field.new :producer_facet, :facetable
-    PRODUCT_FACET               = Field.new :product_facet, :facetable
-    PUBLICATION_FACET           = Field.new :publication_facet, :facetable
     PUBLISHER_FACET             = Field.new :publisher_facet, :facetable
     RESEARCH_HELP_CONTACT       = Field.new :research_help_contact, :stored_sortable
     RESOURCE_ROLE               = Field.new :resource_role, :symbol
-    RIGHTS_NOTE                 = Field.new :rights_note, :stored_searchable
-    ROLL_NUMBER_FACET           = Field.new :roll_number_facet, :facetable
     SERIES_FACET                = Field.new :series_facet, :facetable
-    SETTING_FACET               = Field.new :setting_facet, :facetable
     SPATIAL_FACET               = Field.new :spatial_facet, :facetable
-    STREAMABLE_MEDIA_TYPE       = Field.new :streamable_media_type, :stored_sortable
-    STRUCTURE                   = Field.new :structure, solr_name: "structure_ss"
-    STRUCTURE_SOURCE            = Field.new :structure_source, :stored_sortable
-    SUBJECT_FACET               = Field.new :subject_facet, :facetable
-    SUBSERIES_FACET             = Field.new :subseries_facet, :facetable
+    STRUCT_MAPS                 = Field.new :struct_maps, :stored_sortable
     TECHMD_COLOR_SPACE          = Field.new :techmd_color_space, :symbol
     TECHMD_CREATING_APPLICATION = Field.new :techmd_creating_application, :symbol
     TECHMD_CREATION_TIME        = Field.new :techmd_creation_time, :stored_searchable, type: :date
-    TECHMD_FILE_SIZE            = Field.new :techmd_file_size, solr_name: "techmd_file_size_lsi"
+    TECHMD_FILE_SIZE            = Field.new :techmd_file_size, :stored_searchable, type: :integer
     TECHMD_FITS_VERSION         = Field.new :techmd_fits_version, :stored_sortable
     TECHMD_FITS_DATETIME        = Field.new :techmd_fits_datetime, :stored_sortable, type: :date
     TECHMD_FORMAT_LABEL         = Field.new :techmd_format_label, :symbol
     TECHMD_FORMAT_VERSION       = Field.new :techmd_format_version, :symbol
-    TECHMD_ICC_PROFILE_NAME     = Field.new :techmd_icc_profile_name, :symbol
-    TECHMD_ICC_PROFILE_VERSION  = Field.new :techmd_icc_profile_version, :symbol
     TECHMD_IMAGE_HEIGHT         = Field.new :techmd_image_height, :stored_searchable, type: :integer
     TECHMD_IMAGE_WIDTH          = Field.new :techmd_image_width, :stored_searchable, type: :integer
-    TECHMD_MD5                  = Field.new :techmd_md5, :stored_sortable
     TECHMD_MEDIA_TYPE           = Field.new :techmd_media_type, :symbol
     TECHMD_MODIFICATION_TIME    = Field.new :techmd_modification_time, :stored_searchable, type: :date
     TECHMD_PRONOM_IDENTIFIER    = Field.new :techmd_pronom_identifier, :symbol
     TECHMD_VALID                = Field.new :techmd_valid, :symbol
     TECHMD_WELL_FORMED          = Field.new :techmd_well_formed, :symbol
-    TEMPORAL_FACET              = Field.new :temporal_facet, :facetable
     TITLE                       = Field.new :title, :stored_sortable
-    TONE_FACET                  = Field.new :tone_facet, :facetable
     TYPE_FACET                  = Field.new :type_facet, :facetable
-    VOLUME_FACET                = Field.new :volume_facet, :facetable
     WORKFLOW_STATE              = Field.new :workflow_state, :stored_sortable
     YEAR_FACET                  = Field.new :year_facet, solr_name: "year_facet_iim"
 
-    def self.get(name)
-      const_get(name.to_s.upcase, false)
-    end
-
-    def self.techmd
-      @techmd ||= constants(false).select { |c| c =~ /\ATECHMD_/ }.map { |c| const_get(c) }.freeze
-    end
-
-    def self.descmd
-      @descmd ||= Ddr::Datastreams::DescriptiveMetadataDatastream.properties.map do |base, config|
-        Field.new base, *(config.behaviors)
-      end.freeze
-    end
-
-    def self.adminmd
-      @adminmd ||= Ddr::Datastreams::AdministrativeMetadataDatastream.properties.map do |base, config|
-        begin
-          get(base)
-        rescue NameError
-          Field.new base, *(config.behaviors)
-        end
-      end.freeze
-    end
-
-    def self.const_missing(name)
-      if name == :PID
-        Deprecation.warn(Ddr::Index::Fields,
-                         "`Ddr::Index::Fields::#{name}` is deprecated." \
-                         " Use `Ddr::Index::Fields::ID` instead.")
-        ID
-      else
-        super
-      end
-    end
-
   end
 end