valkyrie_active_fedora 0.0.1

data/lib/generators/valkyrie_active_fedora/config/solr/templates/solr_wrapper_test.yml

@@ -0,0 +1,8 @@
+#config/solr_wrapper_test.yml
+# version: 6.1.0
+port: 8985
+instance_dir: tmp/solr-test
+collection:
+    persist: false
+    dir: solr/config
+    name: hydra-test

data/lib/generators/valkyrie_active_fedora/model/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Generate a class that inherits from ActiveFedora::Base
+
+Example:
+  rails generate active_fedora:model Journal
+
+  This will create:
+    app/models/journal.rb
+    app/models/datastreams/journal_metadata.rb
+    spec/models/journal_spec.rb
+    spec/models/datastreams/journal_metadata_spec.rb

data/lib/generators/valkyrie_active_fedora/model/model_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+
+module ActiveFedora
+  class ModelGenerator < Rails::Generators::NamedBase
+    source_root ::File.expand_path('../templates', __FILE__)
+    check_class_collision
+
+    class_option :directory, type: :string, default: 'models', desc: "Which directory to generate? (i.e. app/DIRECTORY)"
+    class_option :datastream_directory, type: :string, default: 'models/datastreams', desc: "Which datastream directory to generate? (i.e. models/datastreams)"
+    class_option :has_subresource, type: :string, default: nil, desc: "Name a file to attach"
+    class_option :datastream, type: :string, default: nil, desc: "Name a metadata datastream to create"
+
+    def install
+      template('model.rb.erb', ::File.join('app', directory, "#{file_name}.rb"))
+      template('model_spec.rb.erb', ::File.join('spec', directory, "#{file_name}_spec.rb"))
+      return unless options[:datastream]
+      template('datastream.rb.erb', ::File.join('app', datastream_directory, "#{file_name}_metadata.rb"))
+      template('datastream_spec.rb.erb', ::File.join('spec', datastream_directory, "#{file_name}_metadata_spec.rb"))
+    end
+
+    protected
+
+      def directory
+        options[:directory]
+      end
+
+      def datastream_directory
+        options[:datastream_directory]
+      end
+  end
+end

data/lib/generators/valkyrie_active_fedora/model/templates/datastream.rb.erb

@@ -0,0 +1,32 @@
+# Generated via
+#  `rails generate active_fedora:model <%= class_name %>`
+class <%= class_name %>Metadata < ActiveFedora::OmDatastream
+
+  # Define a terminology for parsing this XML document
+  # See: https://github.com/samvera/om/wiki/Tame-your-XML-with-OM
+  #
+  # set_terminology do |t|
+  #   t.root(path: "fields")
+  #   t.title
+  #   t.author
+  # end
+
+
+  # Describe what an empty document looks like
+  #
+  # def self.xml_template
+  #   Nokogiri::XML.parse("<fields/>")
+  # end
+  #
+
+
+  # "If you need to add additional attributes to the SOLR document, define the
+  # #to_solr method and make sure to use super"
+  #
+  # def to_solr(solr_document={}, options={})
+  #   super(solr_document, options)
+  #   solr_document["my_attribute_s"] = my_attribute
+  #   return solr_document
+  # end
+
+end

data/lib/generators/valkyrie_active_fedora/model/templates/datastream_spec.rb.erb

@@ -0,0 +1,13 @@
+# Generated via
+#  `rails generate active_fedora:model <%= class_name %>`
+require 'rails_helper'
+
+describe <%= class_name %>Metadata do
+  it 'should have a title' do
+    pending "Create a terminology for <%= class_name %>Metadata, then enable this test"
+    subject.title = 'War and Peace'
+    expect(subject.title).to eq ['War and Peace']
+  end
+
+end
+

data/lib/generators/valkyrie_active_fedora/model/templates/model.rb.erb

@@ -0,0 +1,46 @@
+# Generated via
+#  `rails generate active_fedora:model <%= class_name %>`
+class <%= class_name %> < ActiveFedora::Base
+  <% if options['datastream'] %>
+  has_subresource :descMetadata, class_name: "<%= options['datastream'] %>"
+  <% else %>
+  # Define some properties to store:
+  #
+  property :title, predicate: ::RDF::Vocab::DC.title do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :creator, predicate: ::RDF::Vocab::DC.creator do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :contributor, predicate: ::RDF::Vocab::DC.contributor do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :description, predicate: ::RDF::Vocab::DC.description do |index|
+    index.as :stored_searchable
+  end
+  <%- end -%>
+  <% if options['has_subresource'] %>
+  has_subresource :<%= options['has_subresource'] %>"
+  <% else %>
+  # Uncomment the following lines to add an #attachment method that is a file
+  #
+  # has_subresource "attachment"
+  <% end %>
+  #
+  # If you need to add additional attributes to the SOLR document, extend the default indexer:
+  #
+  # def indexer
+  #   MyApp::IndexingService
+  # end
+  #
+  # This can go into app/services/my_app/indexing_service.rb
+  # module MyApp
+  #   class IndexingService < ActiveFedora::IndexingService
+  #     def generate_solr_document
+  #       super.tap do |solr_doc|
+  #         solr_doc["my_attribute_s"] = object.my_attribute
+  #       end
+  #     end
+  #   end
+  # end
+end

data/lib/generators/valkyrie_active_fedora/model/templates/model_spec.rb.erb

@@ -0,0 +1,38 @@
+# Generated via
+#  `rails generate active_fedora:model <%= class_name %>`
+require 'rails_helper'
+require 'active_fedora/test_support'
+
+describe <%= class_name %> do
+  it_behaves_like 'An ActiveModel'
+  include ActiveFedora::TestSupport
+  subject { <%= class_name %>.new }
+
+  describe "when persisted to fedora" do
+    before { subject.save! }
+    after { subject.destroy }
+    it 'should exist' do
+      expect(<%= class_name %>.exists?(subject.id)).to be true
+    end
+  end
+
+  <% if options['datastream'] %>
+  it 'should have a descMetadata datastream' do
+    expect(subject.descMetadata).to be_kind_of <%= options['descMetadata'] ? options['descMetadata'] : "#{class_name}Metadata" %>
+  end
+  <% else %>
+  it 'should have a title' do
+    subject.title = ['War and Peace']
+    expect(subject.title).to eq ['War and Peace']
+  end
+
+  describe "#to_solr" do
+    subject { <%= class_name %>.new(title: ['War and Peace']).to_solr }
+
+    it 'should have a title' do
+      expect(subject['title_tesim']).to eq ['War and Peace']
+    end
+  end
+  <% end %>
+
+end

data/lib/tasks/valkyrie_active_fedora_dev.rake

@@ -0,0 +1,67 @@
+APP_ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../")
+
+require 'solr_wrapper'
+require 'fcrepo_wrapper'
+require 'active_fedora/rake_support'
+
+namespace :valkyrie_active_fedora do
+  # Use yard to build docs
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    project_root = APP_ROOT
+    doc_destination = File.join(project_root, 'doc')
+
+    YARD::Rake::YardocTask.new(:doc) do |yt|
+      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+                   [ '-', File.join(project_root, 'README.md')]
+      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :doc do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+  require 'rspec/core/rake_task'
+  desc 'Run tests only'
+  RSpec::Core::RakeTask.new(:rspec) do |spec|
+    spec.rspec_opts = ['--backtrace'] if ENV['CI']
+  end
+
+  require 'rubocop/rake_task'
+  desc 'Run style checker'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.requires << 'rubocop-rspec'
+    task.fail_on_error = true
+  end
+
+  RSpec::Core::RakeTask.new(:rcov) do |spec|
+    spec.rcov = true
+  end
+
+  desc "CI build"
+  task :ci do
+    Rake::Task['valkyrie_active_fedora:rubocop'].invoke unless ENV['NO_RUBOCOP']
+    ENV['environment'] = "test"
+    with_test_server do
+      Rake::Task['valkyrie_active_fedora:coverage'].invoke
+    end
+  end
+
+  desc "Execute specs with coverage"
+  task :coverage do
+    # Put spec opts in a file named .rspec in root
+    ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+    ENV['COVERAGE'] = 'true' unless ruby_engine == 'jruby'
+    Rake::Task["valkyrie_active_fedora:spec"].invoke
+  end
+
+  desc "Execute specs with coverage"
+  task :spec do
+    with_test_server do
+      Rake::Task["valkyrie_active_fedora:rspec"].invoke
+    end
+  end
+end

data/lib/valkyrie_active_fedora.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'valkyrie_active_fedora/engine'
+require 'valkyrie_active_fedora/version'
+
+module ValkyrieActiveFedora
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Base
+  end
+end

data/lib/valkyrie_active_fedora/base.rb

@@ -0,0 +1,39 @@
+require 'active_support/descendants_tracker'
+# require 'active_fedora/errors'
+# require 'active_fedora/log_subscriber'
+
+module ValkyrieActiveFedora
+  # This class ties together many of the lower-level modules, and
+  # implements something akin to an ActiveRecord-alike interface to
+  # fedora. If you want to represent a fedora object in the ruby
+  # space, this is the class you want to extend.
+  #
+  # =The Basics
+  #   class Oralhistory < ActiveFedora::Base
+  #     property :creator, predicate: RDF::Vocab::DC.creator
+  #   end
+  #
+  # The above example creates a Fedora object with a property named "creator"
+  #
+  # Attached files defined with +has_subresource+ and iis accessed via the +attached_files+ member hash.
+  #
+  class Base < ActiveFedora::Base
+    def valkyrie_resource
+      klass = "Valkyrie::#{self.class.to_s}".constantize
+    rescue NameError
+      nil
+    end
+
+    def attributes_including_linked_ids
+      local_attributes = attributes.dup
+      reflections.keys.each do |key|
+        id_method = "#{key.to_s.singularize}_ids"
+        next unless self.respond_to? id_method
+        local_attributes.merge!(id_method => self.send(id_method)).with_indifferent_access
+      end
+      local_attributes
+    end
+  end
+
+  # ActiveSupport.run_load_hooks(:valkyrie_active_fedora, Base)
+end

data/lib/valkyrie_active_fedora/engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ValkyrieActiveFedora
+  class Engine < ::Rails::Engine
+    isolate_namespace ValkyrieActiveFedora
+
+    require 'valkyrie_active_fedora'
+
+    # def self.engine_mount
+    #   ValkyrieActiveFedora::Engine.routes.find_script_name({})
+    # end
+  end
+end

data/lib/valkyrie_active_fedora/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module ValkyrieActiveFedora
+  VERSION = '0.0.1'
+end

data/spec/.gitignore

@@ -0,0 +1 @@
+internal

data/spec/rails_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+# This file is normaly copied to spec/ when you run 'rails generate rspec:install'
+# but this is a dummy file to allow valkyrie_active_fedora specs to run.

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+ENV["environment"] ||= "test"
+
+require "bundler/setup"
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+)
+
+SimpleCov.start "rails" do
+  add_filter "/spec/"
+end
+
+require 'active-fedora'
+require 'valkyrie'
+require 'valkyrie_active_fedora'
+require 'rspec'
+require 'rspec/its'
+require 'equivalent-xml/rspec_matchers'
+require 'logger'
+require 'pry' unless ENV['TRAVIS']
+
+ActiveFedora::Base.logger = Logger.new(STDERR)
+ActiveFedora::Base.logger.level = Logger::WARN
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+$VERBOSE = nil
+
+# This loads the Fedora and Solr config info from /config/fedora.yml
+# You can load it from a different location by passing a file path as an argument.
+def restore_spec_configuration
+  ActiveFedora.init(fedora_config_path: File.join(File.dirname(__FILE__), "..", "config", "fedora.yml"))
+end
+restore_spec_configuration
+
+require 'active_fedora/cleaner'
+RSpec.configure do |config|
+  # Stub out test stuff.
+  config.before(:each) do
+    begin
+      ActiveFedora::Cleaner.clean!
+    rescue Faraday::ConnectionFailed, RSolr::Error::ConnectionRefused => e
+      $stderr.puts e.message
+    end
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+def fixture(file)
+  File.open(File.join(File.dirname(__FILE__), 'fixtures', file), 'rb')
+end