ddr-models 2.5.3 → 2.6.0.rc1

data/lib/ddr/models/indexing.rb

@@ -20,12 +20,14 @@ module Ddr
           ACCESS_ROLE             => roles.to_json,
           ADMIN_SET               => admin_set,
           ADMIN_SET_TITLE         => admin_set_title,
+          ARRANGER_FACET          => desc_metadata_values('arranger'),
           ASPACE_ID               => aspace_id,
           ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
           BOX_NUMBER_FACET        => desc_metadata_values('box_number'),
           CATEGORY_FACET          => desc_metadata_values('category'),
           COLLECTION_TITLE        => collection_title,
           COMPANY_FACET           => desc_metadata_values('company'),
+          COMPOSER_FACET          => desc_metadata_values('composer'),
           CONTRIBUTOR_FACET       => contributor,
           CREATOR_FACET           => creator,
           DATE_FACET              => date,
@@ -34,33 +36,47 @@ module Ddr
           DISPLAY_FORMAT          => display_format,
           DOI                     => adminMetadata.doi,
           EAD_ID                  => ead_id,
+          ENGRAVER_FACET          => desc_metadata_values('engraver'),
           FOLDER_FACET            => desc_metadata_values('folder'),
           FORMAT_FACET            => format,
+          GENRE_FACET             => desc_metadata_values('genre'),
           IDENTIFIER_ALL          => all_identifiers,
+          ILLUSTRATED_FACET       => desc_metadata_values('illustrated'),
+          ILLUSTRATOR_FACET       => desc_metadata_values('illustrator'),
+          INSTRUMENTATION_FACET   => desc_metadata_values('instrumentation'),
           INTERNAL_URI            => internal_uri,
+          INTERVIEWER_NAME_FACET  => desc_metadata_values('interviewer_name'),
           IS_LOCKED               => is_locked,
           LICENSE                 => license,
           LICENSE_DESCRIPTION     => rightsMetadata.license.description.first,
           LICENSE_TITLE           => rightsMetadata.license.title.first,
           LICENSE_URL             => rightsMetadata.license.url.first,
+          LITHOGRAPHER_FACET      => desc_metadata_values('lithographer'),
           LOCAL_ID                => local_id,
+          LYRICIST_FACET          => desc_metadata_values('lyricist'),
           MEDIUM_FACET            => desc_metadata_values('medium'),
+          PERFORMER_FACET         => desc_metadata_values('performer'),
           PERMANENT_ID            => permanent_id,
           PERMANENT_URL           => permanent_url,
           PLACEMENT_COMPANY_FACET => desc_metadata_values('placement_company'),
           POLICY_ROLE             => roles.in_policy_scope.agents,
+          PRODUCER_FACET          => desc_metadata_values('producer'),
           PRODUCT_FACET           => desc_metadata_values('product'),
           PUBLICATION_FACET       => desc_metadata_values('publication'),
           PUBLISHER_FACET         => publisher,
           RESEARCH_HELP_CONTACT   => research_help_contact,
           RESOURCE_ROLE           => roles.in_resource_scope.agents,
+          ROLL_NUMBER_FACET       => desc_metadata_values('roll_number'),
           SERIES_FACET            => desc_metadata_values('series'),
           SETTING_FACET           => desc_metadata_values('setting'),
           SPATIAL_FACET           => desc_metadata_values('spatial'),
           SUBJECT_FACET           => subject,
+          SUBSERIES_FACET         => desc_metadata_values('subseries'),
+          TEMPORAL_FACET          => desc_metadata_values('temporal'),
           TITLE                   => title_display,
           TONE_FACET              => desc_metadata_values('tone'),
           TYPE_FACET              => type,
+          VOLUME_FACET            => desc_metadata_values('volume'),
           WORKFLOW_STATE          => workflow_state,
           YEAR_FACET              => year_facet,
         }

data/lib/ddr/models/solr_document.rb

@@ -18,6 +18,14 @@ module Ddr::Models
         end
         raise NotFound, "SolrDocument not found for \"#{pid_or_uri}\"."
       end
+
+      def find_by_permanent_id(ark)
+        query = Ddr::Index::Query.new { where permanent_id: ark }
+        if doc = query.docs.first
+          return doc
+        end
+        raise NotFound, "SolrDocument not found for permanent id \"#{ark}\"."
+      end
     end
 
     def inspect

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.5.3"
+    VERSION = "2.6.0.rc1"
   end
 end

data/lib/ddr/models/year_facet.rb

@@ -1,153 +1,95 @@
 require "date"
+require "edtf"
 
 module Ddr::Models
   class YearFacet
 
     EARLIEST_YEAR = 1000
+    LATEST_YEAR = Date.today.year + 100
+    VALID_YEARS = (EARLIEST_YEAR..LATEST_YEAR)
+    VALUE_SEP = /;/
 
     # Between 1965 and 1968
     BETWEEN = Regexp.new '\A([Bb]etween\s+)(\d{4})(\s+and\s+)(\d{4})\??\z'
 
-    # YYYx (192x)
-    # YYYX (192X)
-    # YYY? (192?)
-    # YYY- (192-)
-    # YYY-? (192-?)
-    IN_DECADE = Regexp.new '\A(\d{3})([xX\-]\??|\?)\z'
-
-    # YYxx (19xx)
-    IN_CENTURY = Regexp.new '\A(\d{2})xx\z'
-
-    # YYY0s (1920s)
-    # YYY0s? (1920s?)
-    DECADE = Regexp.new '\A(\d{3}0)s\??\z'
-
-    # YYYY-MM (2010-01)
-    # YYYY/MM (2010/01)
-    YEAR_MONTH = Regexp.new '\A(\d{4})[/-](0[1-9]|1[0-2])\z'
-
-    # YYYY-YYYY (1935-2010)
-    # YYYY/YYYY (1935/2010)
-    YEAR_RANGE = Regexp.new '\A(\d{4})[/-](\d{4})\z'
-
-    # YYYY (1979)
-    YEAR = Regexp.new '\A\d{4}\z'
-
-    SQUARE_BRACKETS = Regexp.new '[\[\]]'
-
-    # c. 1920
-    # ca. 1920
-    # c1920
+    # circa 1920, ca. 1920, c1920 => 1920
     CIRCA = Regexp.new '\b(circa\s+|ca?\.\s*|c(?=\d{4}[^\d]*))'
 
-    class << self
-      def call(obj)
-        new(obj).values
-      end
-    end
-
-    attr_reader :obj, :values
-
-    def initialize(obj)
-      @obj = obj
-      @values = []
-      facet_values
-    end
-
-    def facet_values
-      obj.date.each do |date|
-        date.split(/;/).each do |value|
-          clean! value
-          years = extract_years(value)
-          validate! years
-          values.push *years
-        end
-      end
-    end
-
-    def extract_years(value)
-      years = match_years(value) || parse_year(value)
-      Array(years)
-    end
-
-    def clean!(value)
-      value.strip!
-      value.gsub! SQUARE_BRACKETS, ""
-      value.gsub! CIRCA, ""
-    end
+    # 1935-1940 => 1935/1940
+    YEAR_RANGE = Regexp.new '(?<=\d{4})-(?=\d{4})'
 
-    def validate!(years)
-      years = years & valid_years.to_a
-    end
+    # 1920s, 1920s?, 192u, 192-, 192-?, 192? => 192x
+    DECADE = Regexp.new '(?<=\A\d{3})(-\??|0s\??|u|\?)\z'
 
-    def parse_year(value)
-      Date.parse(value).year
-    rescue ArgumentError
-      nil
-    end
+    # 2010/01 => 2010-01
+    MONTH = Regexp.new '(?<=\A\d{4})\/(?=\d{2}\z)'
 
-    def valid_years
-      (EARLIEST_YEAR..latest_year)
-    end
+    # 193u/, 193x/ => 1930/
+    START_DECADE = Regexp.new '(?<=\d{3})[uxX](?=\/)'
 
-    def latest_year
-      Date.today.year + 100
-    end
+    # /194x, /194u => /1949
+    END_DECADE = Regexp.new '(?<=\/\d{3})[uxX]'
 
-    def match_years(value)
-      result = match_year_range(value) ||
-               match_year_month(value) ||
-               match_year(value) ||
-               match_in_decade(value) ||
-               match_in_century(value) ||
-               match_decade(value) ||
-               match_between(value)
-      first_year, last_year = Array(result).map(&:to_i)
-      last_year ? (first_year..last_year) : first_year
-    end
+    # 19uu => 19xx
+    CENTURY = Regexp.new '(?<=\A\d{2})uu(?=\z)'
 
-    def match_year_range(value)
-      if m = YEAR_RANGE.match(value)
-        m[1, 2]
-      end
+    def self.call(object)
+      new(object).call
     end
 
-    def match_year_month(value)
-      if m = YEAR_MONTH.match(value)
-        m[1]
-      end
-    end
+    attr_reader :object
 
-    def match_year(value)
-      if m = YEAR.match(value)
-        value
-      end
+    def initialize(object)
+      @object = object
     end
 
-    def match_in_decade(value)
-      if m = IN_DECADE.match(value)
-        [ "#{m[1]}0", "#{m[1]}9" ]
+    def call
+      source_dates.each_with_object([]) do |date, facet_values|
+        date.split(VALUE_SEP).each do |value|
+          value.strip!
+          edtf_date = convert_to_edtf(value)
+          years = Array(edtf_years(edtf_date))
+          years.select! { |year| VALID_YEARS.include?(year) }
+          facet_values.push(*years)
+        end
       end
     end
 
-    def match_in_century(value)
-      if m = IN_CENTURY.match(value)
-        [ "#{m[1]}00", "#{m[1]}99" ]
-      end
-    end
+    private
 
-    def match_decade(value)
-      if m = DECADE.match(value)
-        [ m[1], m[1].sub(/0\z/, "9") ]
-      end
+    def source_dates
+      object.descMetadata.date
     end
 
-    def match_between(value)
+    def convert_to_edtf(value)
       if m = BETWEEN.match(value)
         value.sub! m[1], ""  # [Bb]etween
-        value.sub! m[3], "-" # and
-        match_year_range(value)
+        value.sub! m[3], "/" # and
       end
+      substitutions.reduce(value) { |memo, (regexp, repl)| memo.gsub(regexp, repl) }
+    end
+
+    def substitutions
+      [
+        [ CIRCA,         "" ],
+        [ YEAR_RANGE,   "/" ],
+        [ DECADE,       "x" ],
+        [ MONTH,        "-" ],
+        [ START_DECADE, "0" ],
+        [ END_DECADE,   "9" ],
+        [ CENTURY,     "xx" ],
+      ]
+    end
+
+    def edtf_years(value)
+      case parsed = EDTF.parse!(value)
+      when Date, EDTF::Season
+        parsed.year
+      when EDTF::Set, EDTF::Interval, EDTF::Epoch
+        parsed.map(&:year).uniq
+      end
+    rescue ArgumentError # EDTF cannot parse
+      nil
     end
 
   end

data/spec/auth/ability_spec.rb

@@ -297,7 +297,7 @@ module Ddr::Auth
         let(:cache_key) { obj }
         let(:perm_obj) { SolrDocument.new({"id"=>"test:1"}) }
         before do
-          allow_any_instance_of(RoleBasedAbilityDefinitions).to receive(:permissions_doc).with(obj) { perm_obj }
+          allow(SolrDocument).to receive(:find).with("test:1") { perm_obj }
         end
         it_behaves_like "it has role based abilities"
       end

data/spec/auth/roles/role_spec.rb

@@ -42,19 +42,19 @@ module Ddr::Auth
 
       describe "validation" do
         it "should require the presence of an agent" do
-          expect { described_class.build(type: "Curator", scope: "resource") }.to raise_error
-          expect { described_class.build(type: "Curator", agent: nil, scope: "resource") }.to raise_error
-          expect { described_class.build(type: "Curator", agent: "", scope: "resource") }.to raise_error
+          expect { described_class.build(type: "Curator", scope: "resource") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: "Curator", agent: nil, scope: "resource") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: "Curator", agent: "", scope: "resource") }.to raise_error(Ddr::Models::Error)
         end
         it "should require a valid scope" do
-          expect { described_class.build(type: "Curator", agent: agent, scope: "") }.to raise_error
-          expect { described_class.build(type: "Curator", agent: agent, scope: "other") }.to raise_error
+          expect { described_class.build(type: "Curator", agent: agent, scope: "") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: "Curator", agent: agent, scope: "other") }.to raise_error(Ddr::Models::Error)
         end
         it "should require a valid type" do
-          expect { described_class.build(agent: agent, scope: "policy") }.to raise_error
-          expect { described_class.build(type: nil, agent: agent, scope: "policy") }.to raise_error
-          expect { described_class.build(type: "", agent: agent, scope: "policy") }.to raise_error
-          expect { described_class.build(type: "Invalid", agent: agent, scope: "policy") }.to raise_error
+          expect { described_class.build(agent: agent, scope: "policy") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: nil, agent: agent, scope: "policy") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: "", agent: agent, scope: "policy") }.to raise_error(Ddr::Models::Error)
+          expect { described_class.build(type: "Invalid", agent: agent, scope: "policy") }.to raise_error(Ddr::Models::Error)
         end
       end
 

data/spec/index/fields_spec.rb

@@ -56,6 +56,12 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "admin_set" }
       end
 
+      describe "ARRANGER_FACET" do
+        subject { Fields::ARRANGER_FACET }
+        its(:label) { is_expected.to eq "Arranger Facet" }
+        its(:heading) { is_expected.to eq "arranger_facet" }
+      end
+
       describe "ASPACE_ID" do
         subject { Fields::ASPACE_ID }
         its(:label) { is_expected.to eq "ArchivesSpace ID" }
@@ -74,6 +80,12 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "company_facet" }
       end
 
+      describe "COMPOSER_FACET" do
+        subject { Fields::COMPOSER_FACET }
+        its(:label) { is_expected.to eq "Composer Facet" }
+        its(:heading) { is_expected.to eq "composer_facet" }
+      end
+
       describe "DOI" do
         subject { Fields::DOI }
         its(:label) { is_expected.to eq "DOI" }
@@ -86,18 +98,66 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "ead_id" }
       end
 
+      describe "ENGRAVER FACET" do
+        subject { Fields::ENGRAVER_FACET }
+        its(:label) { is_expected.to eq "Engraver Facet" }
+        its(:heading) { is_expected.to eq "engraver_facet" }
+      end
+
       describe "FOLDER_FACET" do
         subject { Fields::FOLDER_FACET }
         its(:label) { is_expected.to eq "Folder Facet" }
         its(:heading) { is_expected.to eq "folder_facet" }
       end
 
+      describe "GENRE_FACET" do
+        subject { Fields::GENRE_FACET }
+        its(:label) { is_expected.to eq "Genre Facet" }
+        its(:heading) { is_expected.to eq "genre_facet" }
+      end
+
       describe "LOCAL_ID" do
         subject { Fields::LOCAL_ID }
         its(:label) { is_expected.to eq "Local ID" }
         its(:heading) { is_expected.to eq "local_id" }
       end
 
+      describe "ILLUSTRATED_FACET" do
+        subject { Fields::ILLUSTRATED_FACET }
+        its(:label) { is_expected.to eq "Illustrated Facet" }
+        its(:heading) { is_expected.to eq "illustrated_facet" }
+      end
+
+      describe "ILLUSTRATOR_FACET" do
+        subject { Fields::ILLUSTRATOR_FACET }
+        its(:label) { is_expected.to eq "Illustrator Facet" }
+        its(:heading) { is_expected.to eq "illustrator_facet" }
+      end
+
+      describe "INSTRUMENTATION_FACET" do
+        subject { Fields::INSTRUMENTATION_FACET }
+        its(:label) { is_expected.to eq "Instrumentation Facet" }
+        its(:heading) { is_expected.to eq "instrumentation_facet" }
+      end
+
+      describe "INTERVIEWER_NAME_FACET" do
+        subject { Fields::INTERVIEWER_NAME_FACET }
+        its(:label) { is_expected.to eq "Interviewer Name Facet" }
+        its(:heading) { is_expected.to eq "interviewer_name_facet" }
+      end
+
+      describe "LITHOGRAPHER_FACET" do
+        subject { Fields::LITHOGRAPHER_FACET }
+        its(:label) { is_expected.to eq "Lithographer Facet" }
+        its(:heading) { is_expected.to eq "lithographer_facet" }
+      end
+
+      describe "LYRICIST_FACET" do
+        subject { Fields::LYRICIST_FACET }
+        its(:label) { is_expected.to eq "Lyricist Facet" }
+        its(:heading) { is_expected.to eq "lyricist_facet" }
+      end
+
       describe "MEDIUM_FACET" do
         subject { Fields::MEDIUM_FACET }
         its(:label) { is_expected.to eq "Medium Facet" }
@@ -116,6 +176,12 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "modification_date" }
       end
 
+      describe "PERFORMER_FACET" do
+        subject { Fields::PERFORMER_FACET }
+        its(:label) { is_expected.to eq "Performer Facet" }
+        its(:heading) { is_expected.to eq "performer_facet" }
+      end
+
       describe "PERMANENT_ID" do
         subject { Fields::PERMANENT_ID }
         its(:label) { is_expected.to eq "Permanent ID" }
@@ -134,6 +200,12 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "placement_company_facet" }
       end
 
+      describe "PRODUCER_FACET" do
+        subject { Fields::PRODUCER_FACET }
+        its(:label) { is_expected.to eq "Producer Facet" }
+        its(:heading) { is_expected.to eq "producer_facet" }
+      end
+
       describe "PRODUCT_FACET" do
         subject { Fields::PRODUCT_FACET }
         its(:label) { is_expected.to eq "Product Facet" }
@@ -146,12 +218,24 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "publication_facet" }
       end
 
+      describe "ROLL_NUMBER_FACET" do
+        subject { Fields::ROLL_NUMBER_FACET }
+        its(:label) { is_expected.to eq "Roll Number Facet" }
+        its(:heading) { is_expected.to eq "roll_number_facet" }
+      end
+
       describe "SETTING_FACET" do
         subject { Fields::SETTING_FACET }
         its(:label) { is_expected.to eq "Setting Facet" }
         its(:heading) { is_expected.to eq "setting_facet" }
       end
 
+      describe "SUBSERIES_FACET" do
+        subject { Fields::SUBSERIES_FACET }
+        its(:label) { is_expected.to eq "Subseries Facet" }
+        its(:heading) { is_expected.to eq "subseries_facet" }
+      end
+
       describe "TECHMD_COLOR_SPACE" do
         subject { Fields::TECHMD_COLOR_SPACE }
         its(:label) { is_expected.to eq "Color Space" }
@@ -242,11 +326,23 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "well_formed" }
       end
 
+      describe "TEMPORAL_FACET" do
+        subject { Fields::TEMPORAL_FACET }
+        its(:label) { is_expected.to eq "Temporal Facet" }
+        its(:heading) { is_expected.to eq "temporal_facet" }
+      end
+
       describe "TONE_FACET" do
         subject { Fields::TONE_FACET }
         its(:label) { is_expected.to eq "Tone Facet" }
         its(:heading) { is_expected.to eq "tone_facet" }
       end
+
+      describe "VOLUME_FACET" do
+        subject { Fields::VOLUME_FACET }
+        its(:label) { is_expected.to eq "Volume Facet" }
+        its(:heading) { is_expected.to eq "volume_facet" }
+      end
     end
 
   end