valkyrie_active_fedora 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e709de85b0b59a24e41e32aee09d7e9f74bcd2f2659e3d0f65f0df7101e55b9
-  data.tar.gz: 040bf354db71abc71e9642ed0a32706dbc356c1e745c50853920f68459768838
+  metadata.gz: 031ea02a2856b39b5bb9f39d9cc007f345067ff1e6676a0da258b143fc749252
+  data.tar.gz: 36376f71f46fe742f7356e1464dfd66a56466f759a80c9e75e6912ee84ef456b
 SHA512:
-  metadata.gz: acb5eb00f9d1601967c49f883390478d09c57a050b304cee177904d3c821416be8b010fa2aa508e12d7296724db79fc928377cbd9308f2cc63ab8d40ac0a7038
-  data.tar.gz: cd95a1245819eb9d05c624d8568b2d8a3d0dba6c44bc763ddae70be25f5518a56512f87ec6e766f9ac29e8810ff6171df83f73a31f01eb29c1be16c852be34bb
+  metadata.gz: 823bdd0d669eb88e583b477032d0b4230100119ea3fb64012ba4461490a0812b7ab91b193baed2f5623426bf76d940f7f7c57e086c9d03b8dd307b35eb3466f5
+  data.tar.gz: dc3c799d74d9382ac3caf53efc05876b6e8bec98a851bf974c93aefab0300ee8c50ecc10ebfa253411e8817f830a80046ac684f405aff4a3a4d846ab6e7f9ca7

data/.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_gem:
-#  bixby: bixby_default.yml
+  bixby: bixby_default.yml
 
 inherit_from: .rubocop_todo.yml
 
@@ -26,6 +26,13 @@ Lint/AssignmentInCondition:
 Metrics/LineLength:
   Enabled: false
 
+Metrics/BlockLength:
+  ExcludedMethods: ['included']
+  Exclude:
+    - 'valkyrie_active_fedora.gemspec'
+    - 'lib/tasks/*.rake'
+    - 'spec/**/*.rb'
+
 Metrics/AbcSize:
   Enabled: false
 

data/.travis.yml

@@ -1,15 +1,11 @@
 language: ruby
 cache: bundler
 sudo: false
-rvm: 2.4
-matrix:
-  include:
-    - rvm: 2.3
-      env: RAILS_VERSION=4.2.10
-    - env: RAILS_VERSION=5.0.7
-    - env: RAILS_VERSION=5.1.6
-    - rvm: 2.5
-    - env: RAILS_VERSION=5.2.1
+rvm: 2.5
+env:
+  matrix:
+    - "RAILS_VERSION=5.1.6"
+    - "RAILS_VERSION=5.0.7"
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 before_install:

data/Gemfile

@@ -4,14 +4,12 @@ source "https://rubygems.org"
 
 gemspec path: File.expand_path('..', __FILE__)
 
+gem 'activemodel', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
 gem 'byebug' unless ENV['TRAVIS']
+gem 'jruby-openssl', platform: :jruby
 gem 'pry-byebug' unless ENV['CI']
 
-gem 'activemodel', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
-
 group :test do
-  gem 'simplecov', require: false
   gem 'coveralls', require: false
-  end
-
-gem 'jruby-openssl', platform: :jruby
+  gem 'simplecov', require: false
+end

data/lib/tasks/valkyrie_active_fedora_dev.rake

@@ -14,7 +14,7 @@ namespace :valkyrie_active_fedora do
 
     YARD::Rake::YardocTask.new(:doc) do |yt|
       yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
-                   [ '-', File.join(project_root, 'README.md')]
+                   ['-', File.join(project_root, 'README.md')]
       yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
     end
   rescue LoadError

data/lib/valkyrie_active_fedora.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require 'valkyrie_active_fedora/version'
 
 module ValkyrieActiveFedora
@@ -6,5 +5,6 @@ module ValkyrieActiveFedora
 
   eager_autoload do
     autoload :Base
+    autoload :ResourceFactory
   end
 end

data/lib/valkyrie_active_fedora/base.rb

@@ -1,39 +1,33 @@
 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.
+  # This class extends ActiveFedora::Base to add in methods that allow
+  # an instance of the class to be converted to a Valkyrie::Resource.
   #
   # =The Basics
-  #   class Oralhistory < ActiveFedora::Base
+  #   class Oralhistory < ValkyrieActiveFedora::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
+      "Valkyrie::#{self.class}".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
+      linked_id_keys.each do |id_method|
+        local_attributes.merge!(id_method => send(id_method)).with_indifferent_access
       end
       local_attributes
     end
-  end
 
-  # ActiveSupport.run_load_hooks(:valkyrie_active_fedora, Base)
+    def linked_id_keys
+      @linked_id_keys ||= reflections.keys.map do |key|
+        id_method = "#{key.to_s.singularize}_ids"
+        id_method if respond_to? id_method
+      end.compact
+    end
+  end
 end

data/lib/valkyrie_active_fedora/rake_support.rb

@@ -1,5 +1,3 @@
-require 'byebug'
-
 # Starts a fedora server and a solr server on a random port and then
 # yields the passed block
 def with_test_server(&block)
@@ -23,7 +21,6 @@ def with_server(environment)
     unless Dir.exist?(solr_config_path)
       $stderr.puts "Solr configuration not found at #{solr_config_path}. Using ValkyrieActiveFedora defaults"
       # Otherwise use the configs delivered with ValkyrieActiveFedora.
-byebug
       solr_config_path = File.join(File.expand_path("../..", File.dirname(__FILE__)), 'lib', 'generators', 'valkyrie_active_fedora', 'config', 'solr', 'templates', 'solr', 'config')
     end
     solr.with_collection(name: "hydra-#{environment}", dir: solr_config_path) do

data/lib/valkyrie_active_fedora/resource_factory.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ValkyrieActiveFedora
+  # we really want a class var here. maybe we could use a singleton instead?
+  # rubocop:disable Style/ClassVars
+  class ResourceFactory
+    class ResourceClassCache
+      attr_reader :cache
+
+      def initialize
+        @cache = {}
+      end
+
+      def fetch(key)
+        @cache.fetch(key) do
+          @cache[key] = yield
+        end
+      end
+    end
+
+    @@resource_class_cache = ResourceClassCache.new
+
+    attr_accessor :active_fedora_object
+
+    def initialize(active_fedora_object:)
+      self.active_fedora_object = active_fedora_object
+    end
+
+    def self.for(active_fedora_object)
+      new(active_fedora_object: active_fedora_object).build
+    end
+
+    def build
+      klass = @@resource_class_cache.fetch(active_fedora_object) do
+        # we need a local binding to the object for use in the class scope below
+        active_fedora_local = active_fedora_object
+
+        Class.new(::Valkyrie::Resource) do
+          active_fedora_local.send(:properties).each_key do |property_name|
+            attribute property_name.to_sym, ::Valkyrie::Types::String
+          end
+        end
+      end
+
+      klass.new(id: active_fedora_object.id, **active_fedora_object.attributes.symbolize_keys)
+    end
+
+    # private
+    #
+    #   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
+  # rubocop:enable Style/ClassVars
+end

data/lib/valkyrie_active_fedora/version.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module ValkyrieActiveFedora
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'.freeze
 end

data/spec/spec_helper.rb

@@ -42,7 +42,7 @@ restore_spec_configuration
 require 'active_fedora/cleaner'
 RSpec.configure do |config|
   # Stub out test stuff.
-  config.before(:each) do
+  config.before do
     begin
       ActiveFedora::Cleaner.clean!
     rescue Faraday::ConnectionFailed, RSolr::Error::ConnectionRefused => e

data/spec/unit/base_spec.rb

@@ -29,7 +29,7 @@ describe ValkyrieActiveFedora::Base do
       end
     end
 
-    it 'should return nil when the Valkyrie version of the class is NOT defined' do
+    it 'returns nil when the Valkyrie version of the class is NOT defined' do
       expect(foo_history.valkyrie_resource).to eq nil
     end
   end
@@ -51,8 +51,7 @@ describe ValkyrieActiveFedora::Base do
       end
 
       let(:library1) { Library.create(id: 'lib1', books: [book1]) }
-      # let(:book1) { Book.create(id: 'bk1', library: library1) }
-      let(:book1) { Book.create(id: 'bk1') }
+      let(:book1) { Book.new(id: 'bk1') }
 
       before do
         book1.library = library1
@@ -60,15 +59,18 @@ describe ValkyrieActiveFedora::Base do
       end
 
       it "inserts ids of child objects into parent's attributes" do
-        expected_results = { "id"=>"lib1", "book_ids"=>["bk1"] }
-        # expect(library1.attributes_including_linked_ids).to eq expected_results
+        expected_results = { 'id' => 'lib1', 'book_ids' => ['bk1'] }
         expect(library1.reload.attributes_including_linked_ids).to eq expected_results
       end
 
       it "inserts ids of parent objects into child's attributes" do
-        expected_results = { "id"=>"bk1", "library_id"=>"lib1" }
+        expected_results = { 'id' => 'bk1', 'library_id' => 'lib1' }
         expect(book1.reload.attributes_including_linked_ids).to eq expected_results
       end
+
+      it "knows the keys of the linked items" do
+        expect(library1.reload.linked_id_keys).to eq(['book_ids'])
+      end
     end
   end
 end

data/spec/unit/resource_factory_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe ValkyrieActiveFedora::ResourceFactory do
+  subject(:factory) { described_class.new(active_fedora_object: book) }
+
+  class BookWithPages < ValkyrieActiveFedora::Base
+    # has_many :pages
+    property :title, predicate: ::RDF::Vocab::DC.title
+    property :contributor, predicate: ::RDF::Vocab::DC.contributor
+    property :description, predicate: ::RDF::Vocab::DC.description
+  end
+  # class Page < ValkyrieActiveFedora::Base
+  #   belongs_to :book_with_pages, predicate: ActiveFedora::RDF::Fcrepo::RelsExt.isPartOf
+  # end
+
+  let(:id)          { 'moomin123' }
+  let(:book)        { BookWithPages.new(id: id, **attributes) }
+  # let(:page1)       { Page.new(id: 'pg1') }
+  # let(:page2)       { Page.new(id: 'pg2') }
+
+  let(:attributes) do
+    {
+      title: ['fake title'],
+      contributor: ['user1'],
+      description: ['a description']
+      # description: ['a description'],
+      # pages: [page1, page2]
+    }
+  end
+
+  # TODO: extract to Valkyrie?
+  define :have_a_valkyrie_id_of do |expected_id_str|
+    match do |valkyrie_resource|
+      expect(valkyrie_resource.id).to be_a Valkyrie::ID
+      valkyrie_resource.id.id == expected_id_str
+    end
+  end
+
+  describe '.for' do
+    it 'returns a Valkyrie::Resource' do
+      expect(described_class.for(book)).to be_a Valkyrie::Resource
+    end
+  end
+
+  describe '#build' do
+    it 'returns a Valkyrie::Resource' do
+      expect(factory.build).to be_a Valkyrie::Resource
+    end
+
+    it 'has the id of the active_fedora_object' do
+      expect(factory.build).to have_a_valkyrie_id_of book.id
+    end
+
+    it 'has attributes matching the active_fedora_object' do
+      expect(factory.build)
+        .to have_attributes title: book.title,
+                            contributor: book.contributor,
+                            description: book.description
+      #                      description: book.description,
+      #                      page_ids: [page1.id, page2.id]
+    end
+  end
+end

data/valkyrie_active_fedora.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'active-fedora', '~> 11.0'
   s.add_development_dependency 'valkyrie'
 
-  # s.add_development_dependency 'bixby', '~> 1.0.0' # rubocop styleguide
+  s.add_development_dependency 'bixby', '~> 1.0.0' # rubocop styleguide
   s.add_development_dependency 'rails'
   s.add_development_dependency 'rdoc'
   s.add_development_dependency 'yard'
@@ -33,12 +33,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'equivalent-xml'
   s.add_development_dependency 'simplecov', '~> 0.8'
-  s.add_development_dependency 'rubocop', '~> 0.56.0'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.12.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.extra_rdoc_files = [
     'LICENSE',
     'README.md'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valkyrie_active_fedora
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -192,34 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.56.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.56.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.12.0
 description: A rails engine to extend ActiveFedora gem to play nicely with Valkyrie
   data mapper gem
 email:
@@ -243,47 +229,17 @@ files:
 - config/fedora.yml
 - config/service_mappings.yml
 - config/solr.yml
-- lib/generators/valkyrie_active_fedora/config/USAGE
-- lib/generators/valkyrie_active_fedora/config/config_generator.rb
-- lib/generators/valkyrie_active_fedora/config/fedora/fedora_generator.rb
-- lib/generators/valkyrie_active_fedora/config/fedora/templates/.fcrepo_wrapper.yml
-- lib/generators/valkyrie_active_fedora/config/fedora/templates/fcrepo_wrapper_test.yml
-- lib/generators/valkyrie_active_fedora/config/fedora/templates/fedora.yml
-- lib/generators/valkyrie_active_fedora/config/solr/solr_generator.rb
-- lib/generators/valkyrie_active_fedora/config/solr/templates/.solr_wrapper.yml
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr.yml
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/_rest_managed.json
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/admin-extra.html
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/elevate.xml
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/mapping-ISOLatin1Accent.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/protwords.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/schema.xml
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/scripts.conf
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/solrconfig.xml
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/spellings.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/stopwords.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/stopwords_en.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/synonyms.txt
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/xslt/example.xsl
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/xslt/example_atom.xsl
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/xslt/example_rss.xsl
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr/config/xslt/luke.xsl
-- lib/generators/valkyrie_active_fedora/config/solr/templates/solr_wrapper_test.yml
-- lib/generators/valkyrie_active_fedora/model/USAGE
-- lib/generators/valkyrie_active_fedora/model/model_generator.rb
-- lib/generators/valkyrie_active_fedora/model/templates/datastream.rb.erb
-- lib/generators/valkyrie_active_fedora/model/templates/datastream_spec.rb.erb
-- lib/generators/valkyrie_active_fedora/model/templates/model.rb.erb
-- lib/generators/valkyrie_active_fedora/model/templates/model_spec.rb.erb
 - lib/tasks/valkyrie_active_fedora_dev.rake
 - lib/valkyrie_active_fedora.rb
 - lib/valkyrie_active_fedora/base.rb
 - lib/valkyrie_active_fedora/rake_support.rb
+- lib/valkyrie_active_fedora/resource_factory.rb
 - lib/valkyrie_active_fedora/version.rb
 - spec/.gitignore
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/resource_factory_spec.rb
 - valkyrie_active_fedora.gemspec
 homepage: http://github.com/samvera-labs/valkyrie_active_fedora
 licenses: