datacite 0.8.4 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b403085232bd106bb3b6be7fec2d5c536b83c91f38ab87def4df2e36f2a9f6f
-  data.tar.gz: 25367ebe7804eaefd8da17e5cdc96fedea5f6a77a890e47775c77661d66b207f
+  metadata.gz: 4673dab2c36b209696de4969fd06ef8ca6a85d6e0d14dc8b2455b85dd3ee83bb
+  data.tar.gz: 93f119fb2ca080a2fe664574310342ed4859bd82944eabff1932137acab66189
 SHA512:
-  metadata.gz: aeace413f533ea1aff7d2632285ea203c955b767683b784a24f57d9d306616255b3e6bfea2f5ea275460a49521c4e92ee35da140ea5e0ab63b7225e2d92286bf
-  data.tar.gz: 10d254d5705859bdabcc54c253b17f825ed88b2b819066778f06c0682a386c7ec56e9694595d29b685363884480cc8d00b98bfddae77f6641a0e26463378205e
+  metadata.gz: 4a68baebbf3e4685a920c84d77846a20565b318be6e3fe528d11d4471eea02fa82e6dfd141c41aa4e78f546b4137034086d6e8061a7384a4d7898da6516b00a9
+  data.tar.gz: 53d018337e391ceeb366b0260fda2777595b1c618d8bbde7a43619d1338cc777c2d62a8e623c979bc20732c89bff8830c0ec8f81d5b10bfc88dabb7534ba4120

data/.rubocop.yml

@@ -357,3 +357,48 @@ Style/RedundantArrayFlatten: # new in 1.76
   Enabled: true
 RSpec/IncludeExamples: # new in 3.6
   Enabled: true
+
+Lint/DataDefineOverride: # new in 1.85
+  Enabled: true
+Lint/DeprecatedReference: # new in 1.89
+  Enabled: true
+Lint/NameTypo: # new in 1.89
+  Enabled: true
+Lint/UnreachablePatternBranch: # new in 1.85
+  Enabled: true
+Style/EmptyClassDefinition: # new in 1.84
+  Enabled: true
+Style/FileOpen: # new in 1.85
+  Enabled: true
+Style/MapJoin: # new in 1.85
+  Enabled: true
+Style/ModuleMemberExistenceCheck: # new in 1.82
+  Enabled: true
+Style/NegativeArrayIndex: # new in 1.84
+  Enabled: true
+Style/OneClassPerFile: # new in 1.85
+  Enabled: true
+Style/PartitionInsteadOfDoubleSelect: # new in 1.85
+  Enabled: true
+Style/PredicateWithKind: # new in 1.85
+  Enabled: true
+Style/ReduceToHash: # new in 1.85
+  Enabled: true
+Style/RedundantMinMaxBy: # new in 1.85
+  Enabled: true
+Style/ReverseFind: # new in 1.84
+  Enabled: true
+Style/SelectByKind: # new in 1.85
+  Enabled: true
+Style/SelectByRange: # new in 1.85
+  Enabled: true
+Style/TallyMethod: # new in 1.85
+  Enabled: true
+RSpec/DiscardedMatcher: # new in 3.10
+  Enabled: true
+RSpec/LeakyLocalVariable: # new in 3.8
+  Enabled: true
+RSpec/MatchWithSimpleRegex: # new in 3.10
+  Enabled: true
+RSpec/Output: # new in 3.9
+  Enabled: true

data/Gemfile

@@ -7,8 +7,8 @@ gemspec
 
 # Specify development dependencies here
 gem 'base64'
-gem 'byebug'
 gem 'cocina-models' # only used in tests
+gem 'debug'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    datacite (0.8.4)
+    datacite (0.8.6)
       activesupport
+      cocina_display
       dry-monads (~> 1.3)
       faraday (~> 2.0)
       json_schemer
@@ -11,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.3)
+    activesupport (8.1.3.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -30,9 +31,7 @@ GEM
     attr_extras (7.1.0)
     base64 (0.3.0)
     bigdecimal (4.1.2)
-    byebug (13.0.0)
-      reline (>= 0.6.0)
-    cocina-models (0.132.0)
+    cocina-models (0.133.0)
       activesupport
       cocina_display
       deprecation
@@ -46,7 +45,7 @@ GEM
       super_diff
       thor
       zeitwerk (~> 2.1)
-    cocina_display (2.9.0)
+    cocina_display (2.12.0)
       activesupport (>= 7)
       edtf (~> 3.2)
       geo_coord (~> 0.2)
@@ -59,6 +58,9 @@ GEM
     crack (1.0.1)
       bigdecimal
       rexml
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.6.2)
@@ -93,6 +95,7 @@ GEM
       activesupport (>= 3.0, < 9.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
+    erb (6.0.7)
     faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
@@ -105,29 +108,34 @@ GEM
     i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    io-console (0.8.2)
+    io-console (0.9.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     iso8601 (0.13.0)
-    janeway-jsonpath (1.0.0)
-    json (2.21.1)
+    janeway-jsonpath (1.1.0)
+    json (2.21.2)
     json_schemer (2.5.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    jsonschema_rs (0.49.1)
+    jsonschema_rs (0.50.0)
       bigdecimal (>= 3.1, < 5)
       rb_sys (~> 0.9.124)
-    jsonschema_rs (0.49.1-aarch64-linux)
+    jsonschema_rs (0.50.0-aarch64-linux)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.1-aarch64-linux-musl)
+    jsonschema_rs (0.50.0-aarch64-linux-musl)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.1-arm64-darwin)
+    jsonschema_rs (0.50.0-arm64-darwin)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.1-x86_64-darwin)
+    jsonschema_rs (0.50.0-x86_64-darwin)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.1-x86_64-linux)
+    jsonschema_rs (0.50.0-x86_64-linux)
       bigdecimal (>= 3.1, < 5)
-    jsonschema_rs (0.49.1-x86_64-linux-musl)
+    jsonschema_rs (0.50.0-x86_64-linux-musl)
       bigdecimal (>= 3.1, < 5)
     language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
@@ -160,6 +168,9 @@ GEM
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.9.0)
     public_suffix (7.0.5)
     racc (1.8.1)
@@ -168,8 +179,17 @@ GEM
     rake-compiler-dock (1.12.0)
     rb_sys (0.9.128)
       rake-compiler-dock (= 1.12.0)
+    rbs (4.1.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
     regexp_parser (2.12.0)
-    reline (0.6.3)
+    reline (0.7.0)
       io-console (~> 0.5)
     rexml (3.4.4)
     rspec (3.13.2)
@@ -185,7 +205,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.88.2)
+    rubocop (1.89.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -208,13 +228,14 @@ GEM
       rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    simplecov (1.0.3)
+    simplecov (1.1.1)
     simpleidn (0.2.3)
     super_diff (0.19.0)
       attr_extras (>= 6.2.4, < 8)
       diff-lcs (~> 1.5)
       patience_diff (~> 1.2)
     thor (1.5.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
@@ -225,7 +246,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.8.2)
+    zeitwerk (2.8.3)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -239,9 +260,9 @@ PLATFORMS
 
 DEPENDENCIES
   base64
-  byebug
   cocina-models
   datacite!
+  debug
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
@@ -251,4 +272,4 @@ DEPENDENCIES
   webmock (~> 3.13)
 
 BUNDLED WITH
-  4.0.17
+  4.0.18

data/README.md

@@ -117,6 +117,26 @@ validator = Datacite::Validators::AttributesValidator.new(attributes: datacite_a
 puts validator.errors.join(', ') unless validator.valid?
 ```
 
+## Validating cocina locally
+
+With cocina json saved from arge (append `.json` to an argo view URL and save the content locally) then run:
+
+```
+bin/validate-cocina path/to/file.json
+```
+
+This will result in either a `Valid!` message or an `Invalid!` message with a list of validation errors.
+
+## Transforming cocina locally
+
+With cocina json saved from Argo (append `.json` to an Argo view URL and save the content locally) then run:
+
+```
+bin/transform path/to/file.json
+```
+
+This will output the formatted json content that would be sent to DataCite.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/transform

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is used to review the transformation of a cocina object
+# to a datacite payload
+# usage: bin/transform tmp/druid.json
+
+require 'bundler/setup'
+require 'datacite'
+require 'cocina/models'
+require 'json'
+
+if ARGV.empty?
+  warn "Usage: #{$PROGRAM_NAME} <path-to-cocina-json>"
+  exit 1
+end
+
+json_path = ARGV[0]
+
+unless File.exist?(json_path)
+  warn "File not found: #{json_path}"
+  exit 1
+end
+
+json = JSON.parse(File.read(json_path))
+cocina_object = Cocina::Models::DROWithMetadata.new(json)
+attributes = Datacite::Mapping::FromCocina::Attributes.build(cocina_object:)
+
+puts JSON.pretty_generate(attributes)

data/bin/validate-cocina

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is used to validate if a cocina object will produce
+# a valid datacite payload
+# usage: bin/validate-cocina tmp/druid.json
+
+require 'bundler/setup'
+require 'datacite'
+require 'cocina/models'
+require 'json'
+
+if ARGV.empty?
+  warn "Usage: #{$PROGRAM_NAME} <path-to-cocina-json>"
+  exit 1
+end
+
+json_path = ARGV[0]
+
+unless File.exist?(json_path)
+  warn "File not found: #{json_path}"
+  exit 1
+end
+
+json = JSON.parse(File.read(json_path))
+cocina_object = Cocina::Models::DROWithMetadata.new(json)
+validator = Datacite::Validators::CocinaValidator.new(cocina_object: cocina_object)
+
+if validator.valid?
+  puts 'Valid!'
+else
+  puts 'Invalid:'
+  validator.errors.each { |error| puts "  - #{error}" }
+  exit 1
+end

data/datacite.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'cocina_display'
   spec.add_dependency 'dry-monads', '~> 1.3'
   spec.add_dependency 'faraday', '~> 2.0'
   spec.add_dependency 'json_schemer'

data/lib/datacite/mapping/from_cocina/attributes.rb

@@ -30,7 +30,7 @@ module Datacite
             event: 'publish',
             url: description.purl,
             identifiers: Identifiers.build(identification:),
-            titles: Titles.build(description:),
+            titles: Titles.build(title: cocina_display.full_title),
             publisher: { name: 'Stanford Digital Repository' }, # per DataCite schema
             publicationYear: publication_year,
             subjects: Subject.build(description:),
@@ -46,6 +46,10 @@ module Datacite
           }.merge(ContributorAttributes.build(description:)).compact
         end
 
+        def cocina_display
+          @cocina_display ||= CocinaDisplay::CocinaRecord.from_json(cocina_object.to_json)
+        end
+
         private
 
         def publication_year

data/lib/datacite/mapping/from_cocina/titles.rb

@@ -13,19 +13,19 @@ module Datacite
           new(...).call
         end
 
-        def initialize(description:)
-          @description = description
+        def initialize(title:)
+          @title = title
         end
 
         # @return [Array<Hash>] list of titles for DataCite, conforming to the expectations of HTTP PUT request
         # to DataCite
         def call
-          [{ title: description.title.first.value }]
+          [{ title: }]
         end
 
         private
 
-        attr_reader :description
+        attr_reader :title
       end
     end
   end

data/lib/datacite/mapping/from_cocina/types.rb

@@ -39,26 +39,33 @@ module Datacite
           end&.value
         end
 
-        # @return [String] DataCite resourceType value
+        # @return [String, nil] DataCite resourceType value
         def resource_type
-          @resource_type ||= begin
-            self_deposit_form = Array(description.form).find { |cocina_form| self_deposit_form?(cocina_form) }
-
-            subtypes = self_deposit_subtypes(self_deposit_form)
-            if subtypes.blank?
-              self_deposit_type(self_deposit_form)
-            else
-              subtypes.select { |subtype| subtype if subtype != resource_type_general }.join('; ')
-            end
-          end
+          @resource_type ||= resource_type_from_subtypes || resource_type_from_type
+        end
+
+        def resource_type_from_subtypes
+          subtypes = self_deposit_subtypes(self_deposit_form)
+          return if subtypes.blank?
+
+          subtypes.reject { |subtype| subtype == resource_type_general }.join('; ')
+        end
+
+        def resource_type_from_type
+          self_deposit_type(self_deposit_form) || self_deposit_form&.value
+        end
+
+        def self_deposit_form
+          @self_deposit_form ||= Array(description.form).find { |cocina_form| self_deposit_form?(cocina_form) }
         end
 
-        # call with cocina form element for Stanford self deposit resource types
-        # @return String the value from the structuredValue when the type is 'type' for the cocina form element
+        # @param cocina_self_deposit_form [Cocina::Models::DescriptiveValue, nil] cocina form element for
+        #   Stanford self deposit resource types
+        # @return [String, nil] the value from the structuredValue when the type is 'type'
         def self_deposit_type(cocina_self_deposit_form)
-          cocina_self_deposit_form&.structuredValue&.each do |struct_val|
-            return struct_val.value if struct_val.type == 'type'
-          end
+          cocina_self_deposit_form&.structuredValue&.find do |struct_val|
+            struct_val.type == 'type'
+          end&.value
         end
 
         def self_deposit_subtypes(cocina_self_deposit_form)

data/lib/datacite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Datacite
-  VERSION = '0.8.4'
+  VERSION = '0.8.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datacite
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.6
 platform: ruby
 authors:
 - Justin Coyne
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cocina_display
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +112,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/transform
+- bin/validate-cocina
 - datacite.gemspec
 - lib/datacite.rb
 - lib/datacite/autogenerate_doi_request_body.rb