ddr-models 2.4.0.rc2 → 2.4.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1c49fbe59e6c5428bb0bc0386cc8540645a68a4
-  data.tar.gz: 2d4611d4cb06dd91ff9cada3c9e9cf6f4ec27ced
+  metadata.gz: 80b4bf4ac88afd31bc2ec1941a081a7e5002928e
+  data.tar.gz: 3454977d7ae1e765bebf7454d3957d4e57e7ff79
 SHA512:
-  metadata.gz: 26122a595e168eebe097b956e44f91e4b06465fe62c02a443036a3b848b436987fecceab9fc007608216fd2c255b27d810b0ecbe548997a503a07e02a48fb434
-  data.tar.gz: 28c0e57885bab002e0309f293b72c6f53c51cbbd9227a0fcd50411c267c3b61167c7089e9cf1ba445d590ebad8051171acd009401a875304b644e85ef3f13ddc
+  metadata.gz: 56a5f5fca3277ea75bbba6766b6b14b570b059cb889e6511abd27a085cf56daf7430dac82afb005806a208ae7a11ff6716cebaee543733a6fd6d4969c08e73fd
+  data.tar.gz: 9b5f82ad467a6b6fdec25048c3a70e01c4a2ccb7ddc6ebbae8652e112d9ee4bdaac48ece550dc6059b45efe0efa7f659d2d0241e880a9dfaf791e1bd2619bdf4

data/config/locales/ddr-models.en.yml

@@ -0,0 +1,74 @@
+en:
+  ddr:
+    index:
+      fields:
+        id:
+          label: "Fedora PID"
+          heading: pid
+        active_fedora_model:
+          label: Model
+          heading: model
+        aspace_id:
+          label: "ArchivesSpace ID"
+        doi:
+          label: DOI
+        ead_id:
+          label: "EAD ID"
+        local_id:
+          label: "Local ID"
+        system_create:
+          label: "Creation Date"
+          heading: creation_date
+        system_modified:
+          label: "Modification Date"
+          heading: modification_date
+        permanent_id:
+          label: "Permanent ID"
+        permanent_url:
+          label: "Permanent URL"
+        techmd_color_space:
+          label: "Color Space"
+          heading: color_space          
+        techmd_creating_application:
+          label: "Creating Application"
+          heading: creating_application          
+        techmd_creation_time:
+          label: "Creation Time"
+          heading: creation_time          
+        techmd_file_size:
+          label: "File Size"
+          heading: "file_size"        
+        techmd_fits_version:
+          label: "FITS Version"
+          heading: fits_version
+        techmd_fits_datetime:
+          label: "FITS Run At"
+          heading: fits_datetime
+        techmd_format_label:
+          label: "Format Label"
+          heading: format_label
+        techmd_format_version:
+          label: "Format Version"
+          heading: format_version
+        techmd_image_height:
+          label: "Image Height"
+          heading: image_height          
+        techmd_image_width:
+          label: "Image Width"
+          heading: image_width
+        techmd_media_type:
+          label: "Media Type"
+          heading: media_type
+        techmd_modification_time:
+          label: "Modification Time"
+          heading: modification_time
+        techmd_pronom_identifier:
+          label: "PRONOM Unique ID"
+          heading: "pronom_uid"
+        techmd_valid:
+          label: Valid
+          heading: valid
+        techmd_well_formed:
+          label: "Well-formed"
+          heading: well_formed
+          

data/ddr-models.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "net-ldap", "~> 0.11"
   s.add_dependency "cancancan", "~> 1.12"
   s.add_dependency "ddr-antivirus", "~> 2.1.1"
+  s.add_dependency "virtus", "~> 1.0.5"
 
   s.add_development_dependency "bundler", "~> 1.7"
   s.add_development_dependency "rake"

data/lib/ddr/index.rb

@@ -11,16 +11,19 @@ module Ddr
     autoload :Filter
     autoload :Filters
     autoload :LegacyLicenseFields
+    autoload :Queries
     autoload :Query
     autoload :QueryBuilder
     autoload :QueryClause
+    autoload :QueryParams
     autoload :QueryResult
     autoload :QueryValue
     autoload :Response
+    autoload :SortOrder
     autoload :UniqueKeyField
 
     def self.pids
-      builder = QueryBuilder.new
+      builder = QueryBuilder.new { field UniqueKeyField.instance }
       query = builder.query
       query.pids
     end

data/lib/ddr/index/csv_query_result.rb

@@ -10,7 +10,7 @@ module Ddr::Index
 
     SOLR_CSV_OPTS = {
       "csv.header"       => "false",
-      "csv.mv.separator" => "|",
+      "csv.mv.separator" => ";",
       "wt"               => "csv",
     }.freeze
 

data/lib/ddr/index/field.rb

@@ -16,7 +16,17 @@ module Ddr::Index
     end
 
     def label
-      I18n.t "ddr.index.fields.#{base}", default: base.titleize
+      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}"
     end
 
   end

data/lib/ddr/index/fields.rb

@@ -2,16 +2,6 @@ module Ddr::Index
   module Fields
     extend Deprecation
 
-    def self.const_missing(name)
-      if const = LegacyLicenseFields.const_get(name)
-        Deprecation.warn(Ddr::Index::Fields,
-                         "The constant `#{name}` is deprecated and will be removed in ddr-models 3.0.")
-        const
-      else
-        super
-      end
-    end
-
     def self.get(name)
       const_get(name.to_s.upcase, false)
     end
@@ -23,7 +13,6 @@ module Ddr::Index
     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
@@ -96,5 +85,20 @@ module Ddr::Index
     WORKFLOW_STATE              = Field.new :workflow_state, :stored_sortable
     YEAR_FACET                  = Field.new :year_facet, solr_name: "year_facet_iim"
 
+    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.")
+        return ID
+      end
+      if const = LegacyLicenseFields.const_get(name)
+        Deprecation.warn(Ddr::Index::Fields,
+                         "`Ddr::Index::Fields::#{name}` is deprecated and will be removed in ddr-models 3.0.")
+        return const
+      end
+      super
+    end
+
   end
 end

data/lib/ddr/index/filter.rb

@@ -1,14 +1,24 @@
+require "forwardable"
+
 module Ddr::Index
   class Filter
 
     class << self
-      delegate :where, :raw, :before_days, :before, :present, :absent, to: :new
+      extend Forwardable
+
+      def_delegators :new, :raw, :where, :absent, :present, :negative, :before, :before_days
     end
 
     attr_accessor :clauses
 
-    def initialize
-      @clauses = [ ]
+    def initialize(clauses = nil)
+      @clauses = Array(clauses)
+    end
+
+    # Adds clause (String) w/o escaping
+    def raw(*clauses)
+      self.clauses.push *clauses
+      self
     end
 
     def where(conditions)
@@ -23,26 +33,28 @@ module Ddr::Index
       raw *clauses
     end
 
-    # Adds clause (String) w/o escaping
-    def raw(*clauses)
-      self.clauses += clauses
-      self
+    def absent(*args)
+      raw QueryClause.absent(*args)
+    end
+
+    def present(*args)
+      raw QueryClause.present(*args)
     end
 
-    def present(field)
-      raw QueryClause.present(field)
+    def negative(*args)
+      raw QueryClause.negative(*args)
     end
 
-    def absent(field)
-      raw QueryClause.absent(field)
+    def before(*args)
+      raw QueryClause.before(*args)
     end
 
-    def before(field, date_time)
-      raw QueryClause.before(field, date_time)
+    def before_days(*args)
+      raw QueryClause.before_days(*args)
     end
 
-    def before_days(field, days)
-      raw QueryClause.before_days(field, days)
+    def ==(other)
+      other.instance_of?(self.class) && (other.clauses == self.clauses)
     end
 
   end

data/lib/ddr/index/filters.rb

@@ -1,19 +1,39 @@
 module Ddr::Index
   module Filters
+    extend Deprecation
 
-    HAS_CONTENT = Filter.where(Fields::ACTIVE_FEDORA_MODEL => ["Component", "Attachment", "Target"])
+    def self.has_content
+      Filter.where(Fields::ACTIVE_FEDORA_MODEL => ["Component", "Attachment", "Target"])
+    end
 
-    class << self
-      def is_governed_by(pid)
-        Filter.where(Fields::IS_GOVERNED_BY => internal_uri(pid))
-      end
+    def self.is_governed_by(object_or_id)
+      Filter.where(Fields::IS_GOVERNED_BY => internal_uri(object_or_id))
+    end
+
+    def self.is_member_of_collection(object_or_id)
+      Filter.where(Fields::IS_MEMBER_OF_COLLECTION => internal_uri(object_or_id))
+    end
+
+    private
 
-      def internal_uri(pid)
-        ActiveFedora::Base.internal_uri(pid)
+    def self.const_missing(name)
+      if name == :HAS_CONTENT
+        Deprecation.warn(self,
+                         "`Ddr::Index::Filters::#{name}` is deprecated and will be removed in ddr-models 3.0." \
+                         " Use `Ddr::Index::Filters.has_content` instead.")
+        has_content
+      else
+        super
       end
     end
 
-    private_class_method :internal_uri
+    def self.internal_uri(object_or_id)
+      if object_or_id.respond_to?(:internal_uri)
+        object_or_id.internal_uri
+      else
+        ActiveFedora::Base.internal_uri(object_or_id)
+      end
+    end
 
   end
 end

data/lib/ddr/index/queries.rb

@@ -0,0 +1,20 @@
+module Ddr::Index
+  module Queries
+
+    # Returns a query for a single index document.
+    # @param doc_id [String] the index document id
+    # @return [Query] the query
+    def self.id(doc_id)
+      builder = QueryBuilder.new { id doc_id }
+      builder.query
+    end
+
+    # Returns a query for the index document for an object.
+    # @param obj [ActiveFedora::Base] the object
+    # @return [Query] the query
+    def self.object(obj)
+      id(obj.pid)
+    end
+
+  end
+end

data/lib/ddr/index/query.rb

@@ -1,9 +1,18 @@
+require "virtus"
+require "forwardable"
+
 module Ddr::Index
   class Query
+    include Virtus.model
+    extend Forwardable
 
-    attr_reader :q, :fields, :filters, :sort, :rows
+    attribute :q,       String
+    attribute :fields,  Array[String], default: [ ]
+    attribute :filters, Array[Filter], default: [ ]
+    attribute :sort,    Array[String], default: [ ]
+    attribute :rows,    Integer
 
-    delegate :count, :docs, :pids, :each_pid, :all, to: :result
+    def_delegators :result, :count, :docs, :pids, :each_pid, :all
 
     def inspect
       "#<#{self.class.name} q=#{q.inspect}, filters=#{filters.inspect}," \
@@ -15,12 +24,7 @@ module Ddr::Index
     end
 
     def params
-      { q:    q,
-        fq:   filters.map(&:clauses).flatten,
-        fl:   fields.join(","),
-        sort: sort.join(","),
-        rows: rows,
-      }.select { |k, v| v.present? }
+      QueryParams.new(self).params
     end
 
     def result

data/lib/ddr/index/query_builder.rb

@@ -1,25 +1,28 @@
 module Ddr::Index
+  #
+  # QueryBuilder - Provides a DSL for building a Query.
+  #
   class QueryBuilder
+    extend Deprecation
 
+    # Builds a Query object
+    # @yield [builder] a new QueryBuilder instance.
+    # @return [Query]
     def self.build
+      Deprecation.warn(self,
+                       "`Ddr::Index::QueryBuilder.build` is deprecated and will be removed in ddr-models 3.0." \
+                       " Use `Ddr::Index::QueryBuilder.new` instead.")
       builder = new
       yield builder
       builder.query
     end
 
-    def initialize
-      @q       = nil
-      @fields  = [ ]
-      @filters = [ ]
-      @sort    = [ ]
-      @rows    = nil
-    end
+    attr_reader :query
 
-    def query
-      Query.new.tap do |qry|
-        instance_variables.each do |var|
-          qry.instance_variable_set(var, instance_variable_get(var))
-        end
+    def initialize(&block)
+      @query = Query.new
+      if block_given?
+        instance_eval &block
       end
     end
 
@@ -28,47 +31,81 @@ module Ddr::Index
       limit 1
     end
 
-    def filter(*fltrs)
-      @filters.push *fltrs
+    def filter(*filters)
+      query.filters.push(*filters)
       self
     end
+    alias_method :filters, :filter
+
+    def raw(*args)
+      filter Filter.raw(*args)
+    end
+
+    def where(*args)
+      filter Filter.where(*args)
+    end
+
+    def absent(*args)
+      filter Filter.absent(*args)
+    end
+
+    def present(*args)
+      filter Filter.present(*args)
+    end
+
+    def negative(*args)
+      filter Filter.negative(*args)
+    end
+
+    def before(*args)
+      filter Filter.before(*args)
+    end
+
+    def before_days(*args)
+      filter Filter.before_days(*args)
+    end
 
-    def fields(*flds)
-      @fields.push *flds
+    def field(*fields)
+      query.fields.push(*fields)
       self
     end
+    alias_method :fields, :field
 
     def limit(num)
-      @rows = num
+      query.rows = num
       self
     end
+    alias_method :rows, :limit
 
-    def order_by(field, order)
-      @sort << [field, order].join(" ")
+    def order_by(*args)
+      unless args.first.is_a? Hash
+        Deprecation.warn(QueryBuilder, "`order_by` will require a hash of orderings in ddr-models 3.0.")
+        field, order = args
+        return order_by(field => order)
+      end
+      query.sort += args.first.map { |field, order| SortOrder.new(field: field, order: order) }
       self
     end
+    alias_method :sort, :order_by
 
     def asc(field)
-      order_by field, "asc"
+      Deprecation.warn(QueryBuilder,
+                       "`asc(field)` is deprecated and will be removed from ddr-models 3.0." \
+                       " Use `order_by(field => \"asc\")` instead.")
+      order_by(field => SortOrder::ASC)
     end
 
     def desc(field)
-      order_by field, "desc"
+      Deprecation.warn(QueryBuilder,
+                       "`desc(field)` is deprecated and will be removed from ddr-models 3.0." \
+                       " Use `order_by(field => \"desc\")` instead.")
+      order_by(field => SortOrder::DESC)
     end
 
     def q(q)
-      @q = q
+      query.q = q
       self
     end
 
-    protected
-
-    def method_missing(name, *args, &block)
-      if Filter.respond_to? name
-        return filter Filter.send(name, *args, &block)
-      end
-      super
-    end
-
   end
 end