valkyrie 0.1.0 → 1.0.0.rc1

data/lib/valkyrie/derivative_service.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'hydra/derivatives'
-module Valkyrie
-  ##
-  # Container for registering DerivativeServices.
-  #
-  # To add a new service:
-  #   DerivativeService.services << MyDerivativeService
-  class DerivativeService
-    require 'valkyrie/local_file_service'
-    require 'valkyrie/persist_derivatives'
-    Hydra::Derivatives.source_file_service = Valkyrie::LocalFileService
-    Hydra::Derivatives.output_file_service = Valkyrie::PersistDerivatives
-    class_attribute :services
-    self.services = []
-    # Returns a derivative service for a change_set.
-    # @param resource [Valkyrie::ChangeSet]
-    # @return [Valkyrie::DerivativeService]
-    def self.for(change_set)
-      services.map { |service| service.new(change_set) }.find(&:valid?) ||
-        new(change_set)
-    end
-    attr_reader :change_set
-    delegate :mime_type, :uri, to: :change_set
-    # @param resource [Valkyrie::Resource]
-    def initialize(change_set)
-      @change_set = change_set
-    end
-
-    # Deletes any derivatives generated.
-    def cleanup_derivatives; end
-
-    # Creates derivatives.
-    def create_derivatives; end
-
-    # Returns true if the given resource is valid for this derivative service.
-    # @return [Boolean]
-    def valid?
-      true
-    end
-  end
-end

data/lib/valkyrie/file_characterization_service.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'ruby_tika_app'
-
-module Valkyrie
-  # Abstract base class for file characterization
-  # registers file characterization service a ValkyrieFileCharacterization service
-  # initializes the interface for file characterization
-  # @since 0.1.0
-  class FileCharacterizationService
-    class_attribute :services
-    self.services = []
-    # initializes the file characterization service
-    # @param file_node [FileNode] the FileNode to be characterized
-    # @param persister [AppendingPersister] the Persister used to save the FileNode
-    # @return [TikaFileCharacterizationService] the file characterization service, currently only TikaFileCharacterizationService is implemented
-    def self.for(file_node:, persister:)
-      services.map { |service| service.new(file_node: file_node, persister: persister) }.find(&:valid?) ||
-        new(file_node: file_node, persister: persister)
-    end
-    attr_reader :file_node, :persister
-    delegate :mime_type, :height, :width, :checksum, to: :file_node
-    def initialize(file_node:, persister:)
-      @file_node = file_node
-      @persister = persister
-    end
-
-    # characterizes the file_node passed into this service
-    # Default options are:
-    #   save: true
-    # @param save [Boolean] should the persister save the file_node after Characterization
-    # @return [FileNode]
-    def characterize(save: true)
-      persister.save(resource: @file_node) if save
-      @file_node
-    end
-
-    # Stub function that sets this service as valid for all FileNode types
-    def valid?
-      true
-    end
-  end
-end

data/lib/valkyrie/local_file_service.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-module Valkyrie
-  class LocalFileService
-    # @param [String] file_name path to the file
-    # @param [Hash] _options
-    # @yield [File] opens the file and yields it to the block
-    def self.call(file_name, _options)
-      yield File.open(file_name)
-    end
-  end
-end

data/lib/valkyrie/persist_derivatives.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-module Valkyrie
-  class PersistDerivatives < Hydra::Derivatives::PersistOutputFileService
-    # Persists a derivative to the local file system.
-    # This Service conforms to the signature of `Hydra::Derivatives::PersistOutputFileService`.
-    # This service is an alternative to the default Hydra::Derivatives::PersistOutputFileService.
-    # This service will always update existing and does not do versioning of persisted files.
-    #
-    # @param [#read] stream the derivative filestream
-    # @param [Hash] directives
-    # @option directives [String] :url a url to the file destination
-    def self.call(stream, directives)
-      output_file(directives) do |output|
-        IO.copy_stream(stream, output)
-      end
-    end
-
-    # Open the output file to write and yield the block to the
-    # file. It makes the directories in the path if necessary.
-    def self.output_file(directives, &blk)
-      raise ArgumentError, "No :url was provided in the transcoding directives" unless directives.key?(:url)
-      uri = URI(directives.fetch(:url))
-      raise ArgumentError, "Must provide a file uri" unless uri.scheme == 'file'
-      output_file_dir = File.dirname(uri.path)
-      FileUtils.mkdir_p(output_file_dir) unless File.directory?(output_file_dir)
-      File.open(uri.path, 'wb', &blk)
-    end
-  end
-end

data/lib/valkyrie/persistence/postgres/queries.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-require 'valkyrie/persistence/postgres/queries/find_inverse_references_query'
-require 'valkyrie/persistence/postgres/queries/find_members_query'
-require 'valkyrie/persistence/postgres/queries/find_references_query'
-module Valkyrie::Persistence::Postgres
-  module Queries
-  end
-end

data/lib/valkyrie/persistence/postgres/queries/find_inverse_references_query.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-module Valkyrie::Persistence::Postgres::Queries
-  class FindInverseReferencesQuery
-    delegate :orm_class, to: :resource_factory
-    attr_reader :obj, :property, :resource_factory
-    def initialize(obj, property, resource_factory:)
-      @obj = obj
-      @property = property
-      @resource_factory = resource_factory
-    end
-
-    def run
-      relation.lazy.map do |orm_object|
-        resource_factory.to_resource(object: orm_object)
-      end
-    end
-
-    private
-
-      def relation
-        orm_class.find_by_sql([query, property, "[{\"id\": \"#{obj.id}\"}]"])
-      end
-
-      def query
-        <<-SQL
-        SELECT * FROM orm_resources WHERE
-        metadata->? @> ?
-      SQL
-      end
-  end
-end

data/lib/valkyrie/persistence/postgres/queries/find_members_query.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-module Valkyrie::Persistence::Postgres::Queries
-  class FindMembersQuery
-    attr_reader :obj, :resource_factory
-    delegate :orm_class, to: :resource_factory
-    def initialize(obj, resource_factory:)
-      @obj = obj
-      @resource_factory = resource_factory
-    end
-
-    def run
-      return [] if obj.id.blank?
-      relation.lazy.map do |orm_object|
-        resource_factory.to_resource(object: orm_object)
-      end
-    end
-
-    private
-
-      def relation
-        orm_class.find_by_sql([query, obj.id.to_s])
-      end
-
-      def query
-        <<-SQL
-        SELECT member.* FROM orm_resources a,
-        jsonb_array_elements(a.metadata->'member_ids') WITH ORDINALITY AS b(member, member_pos)
-        JOIN orm_resources member ON (b.member->>'id')::uuid = member.id WHERE a.id = ?
-        ORDER BY b.member_pos
-      SQL
-      end
-  end
-end

data/lib/valkyrie/persistence/postgres/queries/find_references_query.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-module Valkyrie::Persistence::Postgres::Queries
-  class FindReferencesQuery
-    delegate :orm_class, to: :resource_factory
-    attr_reader :obj, :property, :resource_factory
-    def initialize(obj, property, resource_factory:)
-      @obj = obj
-      @property = property
-      @resource_factory = resource_factory
-    end
-
-    def run
-      return [] if obj.id.blank? || obj[property].blank?
-      relation.lazy.map do |orm_object|
-        resource_factory.to_resource(object: orm_object)
-      end
-    end
-
-    private
-
-      def relation
-        orm_class.find_by_sql([query, property, obj.id.to_s])
-      end
-
-      def query
-        <<-SQL
-        SELECT member.* FROM orm_resources a,
-        jsonb_array_elements(a.metadata->?) AS b(member)
-        JOIN orm_resources member ON (b.member->>'id')::uuid = member.id WHERE a.id = ?
-      SQL
-      end
-  end
-end

data/lib/valkyrie/specs/shared_specs/derivative_service.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-RSpec.shared_examples 'a Valkyrie::DerivativeService' do
-  before do
-    raise 'valid_change_set must be set with `let(:valid_change_set)`' unless
-      defined? valid_change_set
-    raise 'derivative_service must be set with `let(:derivative_service)`' unless
-      defined? derivative_service
-  end
-
-  subject { derivative_service.new(valid_change_set) }
-
-  it { is_expected.to respond_to(:create_derivatives).with(0).arguments }
-
-  it { is_expected.to respond_to(:cleanup_derivatives).with(0).arguments }
-
-  it { is_expected.to respond_to(:change_set) }
-
-  it { is_expected.to respond_to(:mime_type) }
-
-  describe "#valid?" do
-    context "when given a resource it handles" do
-      it { is_expected.to be_valid }
-    end
-  end
-
-  it "takes a change_set as an argument" do
-    obj = derivative_service.new(valid_change_set)
-    expect(obj.change_set.resource).to eq valid_change_set.resource
-  end
-end

data/lib/valkyrie/specs/shared_specs/file_characterization_service.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples 'a Valkyrie::FileCharacterizationService' do
-  before do
-    raise 'valid_file_node must be set with `let(:valid_file_node)`' unless
-      defined? valid_file_node
-    raise 'persister must be set with `let(:persister)`' unless
-      defined? persister
-    raise 'file_characterization_service must be set with `let(:file_characterization_service)`' unless
-      defined? file_characterization_service
-  end
-
-  let(:file_node) { valid_file_node }
-  subject { file_characterization_service.new(file_node: file_node, persister: persister) }
-
-  it { is_expected.to respond_to(:characterize).with(0).arguments }
-  it 'returns a file node' do
-    expect(subject.characterize).to be_a(FileNode)
-  end
-
-  describe '#valid?' do
-    context 'when given a file_node it handles' do
-      let(:file_node) { valid_file_node }
-      it { is_expected.to be_valid }
-    end
-  end
-
-  it 'takes a file_node and a persister as arguments' do
-    obj = file_characterization_service.new(file_node: file_node, persister: persister)
-    expect(obj.file_node).to eq valid_file_node
-    expect(obj.persister).to eq persister
-  end
-end