ddr-models 3.0.0.beta.3 → 3.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88f17b85f90657e216998de459b6e4ebd08334e6
-  data.tar.gz: 073db6c4741c656699531369123246d0ddcc1375
+  metadata.gz: ec966b30c1ee1106c893b7bcf914015a74d6a872
+  data.tar.gz: 4780ab2e5ec085392cf788e79cf920fed807ad0a
 SHA512:
-  metadata.gz: 65c74339f0e42019ae99099d3f1e382751e8cddf32e1a2fc578c52df44d9987227625890f1886f2ad18076fd3e8b8d45258d6b75d101ce4661b1dc16c6eb4bf2
-  data.tar.gz: 40c13719805412f5760c3b5ae72807636dc0c3f2f7f75206c647ec7555ea42a26977b9bf4dd24c692d911a2ee5deb5aa3961e56b0e004012281113c5d00d77d3
+  metadata.gz: 78bfd911fbcaebc909ad6ab26bef1efdc6447eb4c99f9733abc36b75f6ba1a6ea6acbe6856d379bbadcbf46476d8d9cdbf5d61bb9f23400ab9f62aff6bf75a79
+  data.tar.gz: d32e38fec5818a9887061e9a84bcee2cb471b080d9353ff85c04ce535c76525781e9b56eb42cdd6c41813f0ca1e52cbe12ae3b312d24def4639a60acc0103e86

data/.travis.yml

@@ -6,9 +6,9 @@ before_install:
 rvm:
   - 2.1.5
 script: "bundle exec rake ci"
-notifications:
-  email:
-    - lib-drs@duke.edu
 bundler_args: --without production
 jdk:
   - oraclejdk8
+env:
+  - DDR_AUX_API_URL=http://localhost:3000/api
+

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

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib", "app/models"]
 
   s.add_dependency "rails", "~> 4.1.13"
+  s.add_dependency "activeresource"
   s.add_dependency "active-triples", "~> 0.7.2"
   s.add_dependency "active-fedora", "~> 9.6.2"
   s.add_dependency "hydra-validations", "~> 0.5"
@@ -30,11 +31,11 @@ Gem::Specification.new do |s|
   s.add_dependency "rdf-vocab", "~> 0.8"
   s.add_dependency "net-ldap", "~> 0.11"
   s.add_dependency "cancancan", "~> 1.12"
-  s.add_dependency "ddr-aux-client", "~> 1.2", ">= 1.2.2"
   s.add_dependency "ddr-antivirus", "~> 2.1.1"
   s.add_dependency "virtus", "~> 1.0.5"
+  s.add_dependency "hashie", "~> 3.4.3"
 
-  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "bundler", "~> 1.11", ">= 1.11.2"
   s.add_development_dependency "rake"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec-rails", "~> 3.1"

data/lib/ddr/auth.rb

@@ -71,8 +71,11 @@ module Ddr
       "::Ability"
     end
 
-    mattr_accessor :repository_group_filter do
-      ENV["REPOSITORY_GROUP_FILTER"]
+    def self.repository_group_filter
+      if filter = ENV["REPOSITORY_GROUP_FILTER"]
+        return filter
+      end
+      raise Ddr::Models::Error, "The \"REPOSITORY_GROUP_FILTER\" environment variable is not set."
     end
 
   end

data/lib/ddr/auth/roles.rb

@@ -18,7 +18,6 @@ module Ddr::Auth
     SCOPES = [RESOURCE_SCOPE, POLICY_SCOPE].freeze
 
     class << self
-
       def type_map
         @type_map ||= role_types.map { |role_type| [role_type.to_s, role_type] }.to_h
       end
@@ -26,7 +25,6 @@ module Ddr::Auth
       def role_types
         @role_types ||= RoleTypes.constants(false).map { |const| RoleTypes.const_get(const) }
       end
-
     end
 
   end

data/lib/ddr/auth/roles/role_set.rb

@@ -3,6 +3,7 @@ require "virtus"
 
 module Ddr::Auth
   module Roles
+    extend Deprecation
     #
     # Wraps a set of Roles
     #

data/lib/ddr/derivatives/generators/png_generator.rb

@@ -13,7 +13,7 @@ module Ddr
       end
 
       def generate(source_path, output_path)
-        command = "convert #{source_path} #{options} png:#{output_path}"
+        command = "convert #{source_path}[0] #{options} png:#{output_path}"
         out, err, s = Open3.capture3(command)
         GeneratorResult.new(output_path, out, err, s)
       end

data/lib/ddr/index.rb

@@ -4,9 +4,11 @@ module Ddr
 
     autoload :AbstractQueryResult
     autoload :Connection
+    autoload :CSVOptions
     autoload :CSVQueryResult
     autoload :DocumentBuilder
     autoload :Field
+    autoload :FieldAttribute
     autoload :Fields
     autoload :Filter
     autoload :Filters
@@ -14,13 +16,15 @@ module Ddr
     autoload :Query
     autoload :QueryBuilder
     autoload :QueryClause
+    autoload :QueryParams
     autoload :QueryResult
-    autoload :QueryValue
     autoload :Response
+    autoload :SolrCSVOptions
+    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/abstract_query_result.rb

@@ -6,7 +6,7 @@ module Ddr::Index
     delegate :params, to: :query
 
     def initialize(query)
-      @query = query
+      @query = query.dup.freeze
       @conn = Connection.new
     end
 

data/lib/ddr/index/csv_options.rb

@@ -0,0 +1,14 @@
+require "csv"
+require "hashie"
+
+module Ddr::Index
+  class CSVOptions < Hashie::Dash
+
+    property :headers,        default: CSV::DEFAULT_OPTIONS[:headers]
+    property :return_headers, default: true
+    property :write_headers,  default: true
+    property :col_sep,        default: CSV::DEFAULT_OPTIONS[:col_sep]
+    property :quote_char,     default: CSV::DEFAULT_OPTIONS[:quote_char]
+
+  end
+end

data/lib/ddr/index/csv_query_result.rb

@@ -4,57 +4,64 @@ module Ddr::Index
   class CSVQueryResult < AbstractQueryResult
 
     MAX_ROWS = 10**8
+    MV_SEP   = ";"
 
-    COL_SEP    = CSV::DEFAULT_OPTIONS[:col_sep].freeze
-    QUOTE_CHAR = CSV::DEFAULT_OPTIONS[:quote_char].freeze
+    attr_reader :mv_sep
 
-    SOLR_CSV_OPTS = {
-      "csv.header"       => "false",
-      "csv.mv.separator" => "|",
-      "wt"               => "csv",
-    }.freeze
+    delegate :read, :each, to: :csv
 
-    CSV_OPTS = {
-      return_headers: true,
-      write_headers:  true,
-    }.freeze
-
-    attr_reader :csv_opts, :solr_csv_opts
-
-    def initialize(query, **opts)
+    def initialize(query, mv_sep: MV_SEP)
       super(query)
+      @mv_sep = mv_sep
+    end
+
+    def csv
+      CSV.new(data, csv_opts.to_h)
+    end
 
-      @solr_csv_opts = SOLR_CSV_OPTS.dup
-      @solr_csv_opts[:rows] ||= MAX_ROWS
+    def to_s
+      read.to_csv
+    end
 
-      @csv_opts = CSV_OPTS.dup
-      @csv_opts[:headers] = query.fields.map(&:label)
+    def rows
+      query.rows || MAX_ROWS
+    end
 
-      # 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)
+    def csv_opts
+      @csv_opts ||= CSVOptions.new(headers: csv_headers)
     end
 
-    def csv
-      CSV.new(data, csv_opts)
+    def solr_csv_opts
+      @solr_csv_opts ||= SolrCSVOptions.new(col_sep: csv_opts.col_sep,
+                                            quote_char: csv_opts.quote_char,
+                                            header: solr_csv_header,
+                                            mv_sep: mv_sep,
+                                            rows: rows)
     end
 
-    def each
-      csv.each
+    def headers
+      @headers ||= query.fields.map(&:heading)
     end
 
-    def to_s
-      csv.string
+    def csv_headers
+      if headers.empty?
+        :first_row
+      else
+        headers
+      end
     end
 
-    private
+    def solr_csv_header
+      csv_headers == :first_row
+    end
 
-    def csv_params
-      params.merge(solr_csv_opts)
+    def solr_csv_params
+      params.merge solr_csv_opts.params
     end
 
     def data
-      conn.get "select", params: csv_params
+      raw = conn.get("select", params: solr_csv_params)
+      raw.gsub(/\\#{mv_sep}/, mv_sep)
     end
 
   end

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/field_attribute.rb

@@ -0,0 +1,22 @@
+require "virtus"
+
+module Ddr::Index
+  class FieldAttribute < Virtus::Attribute
+
+    def self.coerce(value)
+      case value
+      when Field
+        value
+      when String
+        Field.new(value)
+      when Symbol
+        Fields.get(value)
+      end
+    end
+
+    def coerce(value)
+      self.class.coerce(value)
+    end
+
+  end
+end

data/lib/ddr/index/fields.rb

@@ -2,36 +2,20 @@ 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
-
-    def self.const_missing(name)
-      if name == :PID
-        Deprecation.warn(Fields, "The constant `:PID` is deprecated; use `:ID` instead.")
-        return ID
-      end
-      super
-    end
-
     ID = 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
+    ASPACE_ID                   = Field.new :aspace_id, :stored_sortable
     ATTACHED_FILES              = Field.new :attached_files, solr_name: "attached_files_ss"
     BOX_NUMBER_FACET            = Field.new :box_number_facet, :facetable
     COLLECTION_FACET            = Field.new :collection_facet, :facetable
     COLLECTION_URI              = Field.new :collection_uri, :symbol
-    CONTENT_SIZE                = Field.new :content_size, :stored_sortable, type: :integer
+    CONTENT_SIZE                = Field.new :content_size, solr_name: "content_size_lsi"
     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
@@ -73,10 +57,11 @@ module Ddr::Index
     SERIES_FACET                = Field.new :series_facet, :facetable
     SPATIAL_FACET               = Field.new :spatial_facet, :facetable
     STRUCT_MAPS                 = Field.new :struct_maps, :stored_sortable
+    SUBJECT_FACET               = Field.new :subject_facet, :facetable
     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, :stored_searchable, type: :integer
+    TECHMD_FILE_SIZE            = Field.new :techmd_file_size, solr_name: "techmd_file_size_lsi"
     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
@@ -93,5 +78,29 @@ module Ddr::Index
     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) }
+    end
+
+    def self.descmd
+      @descmd ||= Ddr::Datastreams::DescriptiveMetadataDatastream.properties.map do |base, config|
+        Field.new base, *(config.behaviors)
+      end
+    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.")
+        return ID
+      end
+      super
+    end
+
   end
 end