cocina-models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c031b56f3548f5017668e942e8464b8043799b66eb3de2a627a0bce2fb7954c2
+  data.tar.gz: f71f049e417a93ece04d27cf3b6836b24bdf7fa232ffcec4f5bba2236298a7bb
+SHA512:
+  metadata.gz: c1ccd0ab5d5367632a44abb864eb6d7eb6787791a4cbe3c71cfd0d97f1ef13e04d0e4ee7ca8947bdf7f71e50c1af19dce29600f92e5694d3ec46c5582eed0eaf
+  data.tar.gz: 277c311506184fa9d0958d101a0dfe3168681e4f26619d339b750e48c990ebfd8d89ca7d998291c6bffe70d25e2e9c5beddec93930f9ce8deb3d333e94ac822a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocina-models.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Cocina::Models
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cocina/models`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cocina-models'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cocina-models
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cocina-models.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cocina/models'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cocina-models.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocina/models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocina-models'
+  spec.version       = Cocina::Models::VERSION
+  spec.authors       = ['Justin Coyne']
+  spec.email         = ['jcoyne@justincoyne.com']
+
+  spec.summary       = 'Data models for the SDR'
+  spec.description   = 'SDR data models that can be validated'
+  spec.homepage      = 'https://github.com/sul-dlss-labs/cocina-models'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss-labs/cocina-models'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'zeitwerk', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/cocina/models/dro.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cocina
+  module Models
+    # A digital repository object.  See https://github.com/sul-dlss-labs/taco/blob/master/maps/DRO.json
+    class DRO < Dry::Struct
+      attribute :externalIdentifier, Types::Strict::String
+      attribute :type, Types::Strict::String
+      attribute :label, Types::Strict::String
+
+      def self.from_dynamic(d)
+        DRO.new(
+          externalIdentifier: d['externalIdentifier'],
+          type: d['type'],
+          label: d['label']
+        )
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/types.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # This defines the data types supported by the model
+    module Types
+      include Dry.Types()
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    VERSION = '0.1.0'
+  end
+end

data/lib/cocina/models.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'cocina/models/version'
+require 'zeitwerk'
+require 'dry-struct'
+require 'dry-types'
+
+class CocinaModelsInflector < Zeitwerk::Inflector
+  def camelize(basename, _abspath)
+    case basename
+    when 'dro'
+      'DRO'
+    else
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.inflector = CocinaModelsInflector.new
+loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
+loader.setup
+
+module Cocina
+  module Models
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: cocina-models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  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-types
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: SDR data models that can be validated
+email:
+- jcoyne@justincoyne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cocina-models.gemspec
+- lib/cocina/models.rb
+- lib/cocina/models/dro.rb
+- lib/cocina/models/types.rb
+- lib/cocina/models/version.rb
+homepage: https://github.com/sul-dlss-labs/cocina-models
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss-labs/cocina-models
+  source_code_uri: https://github.com/sul-dlss-labs/cocina-models
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Data models for the SDR
+test_files: []