sufia 6.0.0.beta1 → 6.0.0.rc1

data/spec/views/collections/_show_descriptions.html.erb_spec.rb

@@ -2,24 +2,30 @@ require 'spec_helper'
 
 describe 'collections/_show_descriptions.html.erb', :type => :view do
   context 'displaying a custom collection' do
+    let(:collection) do
+      mock_model(Collection,
+                  resource_type: [], creator: [], contributor: [], tag: [],
+                  rights: [], publisher: [], date_created: ['2000-01-01'], subject: [],
+                  language: [], identifier: [], based_near: [], related_url: [],
+                  members: ['foo', 'bar'], bytes: 123456678
+                )
+    end
     before do
-      @collection = mock_model(Collection)
-      allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)
-      allow(@collection).to receive(:date_modified).and_return(["today"])
-      allow(@collection).to receive(:terms_for_display).and_return([:date_modified])
-      allow(@collection).to receive(:members).and_return(["foo","bar"])
-      allow(@collection).to receive(:bytes).and_return(123456678)
+      assign(:presenter, presenter)
+      assign(:collection, collection)
     end
 
+    let(:presenter) { Sufia::CollectionPresenter.new(collection) }
+
+
     it "should draw the metadata fields for collection" do
       render
-      expect(rendered).to have_content 'Date modified'
-      expect(rendered).to include('itemprop="date_modified"')
+      expect(rendered).to have_content 'Date Created'
+      expect(rendered).to include('itemprop="dateCreated"')
       expect(rendered).to have_content 'Total Items'
       expect(rendered).to have_content '2'
       expect(rendered).to have_content 'Size'
       expect(rendered).to have_content '118 MB'
     end
   end
-
 end

data/spec/views/dashboard/index_spec.rb

@@ -64,8 +64,8 @@ describe "dashboard/index.html.erb", :type => :view do
       expect(@sidebar).to include '<span class="badge">2</span>'
       expect(@sidebar).to include '<span class="badge">15</span>'
       expect(@sidebar).to include '<span class="badge">3</span>'
-      expect(@sidebar).to include '1 View'
-      expect(@sidebar).to include '3 Downloads'
+      expect(@sidebar).to include '<span class="badge-optional">1</span> View'
+      expect(@sidebar).to include '<span class="badge-optional">3</span> Downloads'
     end
 
     it "should show the statistics before the profile" do

data/spec/views/generic_file/_permission_form.html.erb_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'generic_files/_permission_form.html.erb', :type => :view do
+  let(:generic_file) {
+    stub_model(GenericFile, noid: '123',
+        depositor: 'bob',
+        resource_type: ['Dataset'])
+  }
+
+  before do
+    allow(controller).to receive(:current_user).and_return(stub_model(User))
+    allow(generic_file).to receive(:permissions).and_return([])
+    form_for(generic_file, url: '/update') do |f|
+      @f = f
+    end
+  end
+
+  it "should draw the permissions form without error" do
+    render 'generic_files/permission_form.html.erb', f: @f
+    expect(rendered).to have_css("input#new_user_name_skel")
+  end
+
+end

data/spec/views/generic_file/edit.html.erb_spec.rb

@@ -19,10 +19,15 @@ describe 'generic_files/edit.html.erb', :no_clean do
         resource_type: ['Book', 'Dataset'])
     }
 
+    let(:form) {
+      Sufia::Forms::GenericFileEditForm.new(generic_file)
+    }
+
     before do
       allow(generic_file).to receive(:content).and_return(content)
       allow(controller).to receive(:current_user).and_return(stub_model(User))
       assign(:generic_file, generic_file)
+      assign(:form, form)
       assign(:version_list, version_list)
     end
 

data/spec/views/generic_file/show.html.erb_spec.rb

@@ -28,6 +28,10 @@ describe 'generic_files/show.html.erb', :type => :view do
       subject: ['Biology', 'Physiology', 'Ethnography'])
   end
 
+  let(:presenter) {
+    Sufia::GenericFilePresenter.new(generic_file)
+  }
+
   before do
     allow(generic_file).to receive(:content).and_return(content)
     allow(controller).to receive(:current_user).and_return(depositor)
@@ -36,6 +40,7 @@ describe 'generic_files/show.html.erb', :type => :view do
     allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)
     allow(view).to receive(:on_the_dashboard?).and_return(false)
     assign(:generic_file, generic_file)
+    assign(:presenter, presenter)
     assign(:events, [])
     assign(:notify_number, 0)
   end

data/sufia-models/app/actors/sufia/generic_file/actor.rb

@@ -56,7 +56,7 @@ module Sufia::GenericFile
     end
 
     def update_metadata(attributes, visibility)
-      generic_file.attributes = generic_file.sanitize_attributes(attributes)
+      generic_file.attributes = attributes
       update_visibility(visibility)
       generic_file.date_modified = DateTime.now
       remove_from_feature_works if generic_file.visibility_changed? && !generic_file.public?

data/sufia-models/app/jobs/batch_update_job.rb

@@ -8,12 +8,12 @@ class BatchUpdateJob
 
   attr_accessor :login, :title, :file_attributes, :batch_id, :visibility, :saved, :denied
 
-  def initialize(login, params)
+  def initialize(login, batch_id, title, file_attributes, visibility)
     self.login = login
-    self.title = params[:title] || {}
-    self.file_attributes = params[:generic_file]
-    self.visibility = params[:visibility]
-    self.batch_id = params[:id]
+    self.title = title || {}
+    self.file_attributes = file_attributes
+    self.visibility = visibility
+    self.batch_id = batch_id
     self.saved = []
     self.denied = []
   end

data/sufia-models/app/models/batch.rb

@@ -10,6 +10,9 @@ class Batch < ActiveFedora::Base
   property :status, predicate: ::RDF::DC.type
 
   def self.find_or_create(id)
+    # FIXME potential race condition in this method. Consider that `find' may raise
+    # ObjectNotFound in multiple processes. However, Fedora should raise an error
+    # if we try to create two objects with the same id.
     begin
       Batch.find(id)
     rescue ActiveFedora::ObjectNotFoundError
@@ -17,9 +20,10 @@ class Batch < ActiveFedora::Base
     end
   end
 
-  def to_solr(solr_doc={})
-    super.tap do |solr_doc|
-      solr_doc[Solrizer.solr_name('noid', Sufia::GenericFile::Indexing.noid_indexer)] = noid
+  class << self
+    # override the default indexing service
+    def indexer
+      Sufia::IndexingService
     end
   end
 end

data/sufia-models/app/models/concerns/sufia/collection.rb

@@ -5,41 +5,16 @@ module Sufia
     include Sufia::ModelMethods
     include Sufia::Noid
     include Sufia::GenericFile::Permissions
-    include Sufia::GenericFile::WebForm # provides initialize_fields method
 
     included do
       before_save :update_permissions
       validates :title, presence: true
-
-    end
-
-    def terms_for_display
-      terms_for_editing - [:title, :description]
-    end
-
-    def terms_for_editing
-      [:resource_type, :title, :creator, :contributor, :description, :tag,
-        :rights, :publisher, :date_created, :subject, :language, :identifier,
-        :based_near, :related_url]
-    end
-
-    # Test to see if the given field is required
-    # @param [Symbol] key a field
-    # @return [Boolean] is it required or not
-    def required?(key)
-      self.class.validators_on(key).any?{|v| v.kind_of? ActiveModel::Validations::PresenceValidator}
     end
 
     def to_param
       noid
     end
 
-    def to_solr(solr_doc={})
-      super.tap do |solr_doc|
-        solr_doc[Solrizer.solr_name("noid", Sufia::GenericFile::Indexing.noid_indexer)] = noid
-      end
-    end
-
     def update_permissions
       self.visibility = "open"
     end
@@ -50,5 +25,12 @@ module Sufia
       members.reduce(0) { |sum, gf| sum + gf.file_size.first.to_i }
     end
 
+    module ClassMethods
+      # override the default indexing service
+      def indexer
+        Sufia::IndexingService
+      end
+    end
+
   end
 end

data/sufia-models/app/models/concerns/sufia/generic_file.rb

@@ -9,7 +9,6 @@ module Sufia
     include Sufia::GenericFile::Export
     include Sufia::GenericFile::Characterization
     include Sufia::GenericFile::Permissions
-    include Sufia::GenericFile::WebForm
     include Sufia::GenericFile::Derivatives
     include Sufia::GenericFile::Trophies
     include Sufia::GenericFile::Featured

data/sufia-models/app/models/concerns/sufia/generic_file/export.rb

@@ -21,8 +21,8 @@ module Sufia
           '%G' => [:language],
           '%[' => [:date_modified],
           '%9' => [:resource_type],
-          '%~' => Application.config.application_name,
-          '%W' => t('sufia.institution_name')
+          '%~' => I18n.t('sufia.product_name'),
+          '%W' => I18n.t('sufia.institution_name')
         }
         text = []
         text << "%0 GenericFile"

data/sufia-models/app/models/concerns/sufia/generic_file/indexing.rb

@@ -3,19 +3,10 @@ module Sufia
     module Indexing
       extend ActiveSupport::Concern
 
-      # Unstemmed, searchable, stored
-      def self.noid_indexer
-        @noid_indexer ||= Solrizer::Descriptor.new(:text, :indexed, :stored)
-      end
-
-      def to_solr(solr_doc={})
-        super.tap do |solr_doc|
-          solr_doc[Solrizer.solr_name('label')] = label
-          solr_doc[Solrizer.solr_name('noid', Sufia::GenericFile::Indexing.noid_indexer)] = noid
-          solr_doc[Solrizer.solr_name('file_format')] = file_format
-          solr_doc[Solrizer.solr_name('file_format', :facetable)] = file_format
-          solr_doc['all_text_timv'] = full_text.content
-          solr_doc = index_collection_ids(solr_doc)
+      module ClassMethods
+        # override the default indexing service
+        def indexer
+          Sufia::GenericFileIndexingService
         end
       end
     end

data/sufia-models/app/models/concerns/sufia/generic_file/metadata.rb

@@ -5,7 +5,7 @@ module Sufia
 
       included do
 
-        property :label, predicate: ::RDF::DC.title, multiple: false
+        property :label, predicate: ActiveFedora::RDF::Fcrepo::Model.downloadFilename, multiple: false
 
         property :depositor, predicate: ::RDF::URI.new("http://id.loc.gov/vocabulary/relators/dpt"), multiple: false do |index|
           index.as :symbol, :stored_searchable

data/sufia-models/app/models/concerns/sufia/user.rb

@@ -18,33 +18,50 @@ module Sufia::User
     # Users should be followable
     acts_as_followable
 
-    # Setup accessible (or protected) attributes for your model
+    # Set up proxy-related relationships
     has_many :proxy_deposit_requests, foreign_key: 'receiving_user_id'
-
     has_many :deposit_rights_given, foreign_key: 'grantor_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_receive_deposits_from, through: :deposit_rights_given, source: :grantee
-
     has_many :deposit_rights_received, foreign_key: 'grantee_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_make_deposits_for, through: :deposit_rights_received, source: :grantor
 
+    # Validate and normalize ORCIDs
+    validates_with OrcidValidator
+    after_validation :normalize_orcid
+
+    # Set up user profile avatars
     mount_uploader :avatar, AvatarUploader, mount_on: :avatar_file_name
     validates_with AvatarValidator
+
     has_many :trophies
     attr_accessor :update_directory
   end
 
+  # Coerce the ORCID into URL format
+  def normalize_orcid
+    # Skip normalization if:
+    #   1. validation has already flagged the ORCID as invalid
+    #   2. the orcid field is blank
+    #   3. the orcid is already in its normalized form
+    return if self.errors[:orcid].first.present? || self.orcid.blank? || self.orcid.starts_with?('http://orcid.org/')
+    bare_orcid = /\d{4}-\d{4}-\d{4}-\d{4}/.match(self.orcid).string
+    self.orcid = "http://orcid.org/#{bare_orcid}"
+  end
+
   # Format the json for select2 which requires just an id and a field called text.
   # If we need an alternate format we should probably look at a json template gem
   def as_json(opts = nil)
-    {id: user_key, text: display_name ? "#{display_name} (#{user_key})" : user_key}
+    { id: user_key, text: display_name ? "#{display_name} (#{user_key})" : user_key }
   end
 
   def email_address
-    return self.email
+    self.email
   end
 
   def name
-    return self.display_name.titleize || self.user_key rescue self.user_key
+    self.display_name.titleize || raise
+  rescue
+    self.user_key
   end
 
   # Redefine this for more intuitive keys in Redis
@@ -61,7 +78,7 @@ module Sufia::User
 
   # method needed for messaging
   def mailboxer_email(obj=nil)
-    return nil
+    nil
   end
 
   # The basic groups method, override or will fallback to Sufia::Ldap::User
@@ -80,14 +97,6 @@ module Sufia::User
   end
 
   module ClassMethods
-
-    def permitted_attributes
-      [:email, :login, :display_name, :address, :admin_area,
-        :department, :title, :office, :chat_id, :website, :affiliation,
-        :telephone, :avatar, :group_list, :groups_last_update, :facebook_handle,
-        :twitter_handle, :googleplus_handle, :linkedin_handle, :remove_avatar]
-    end
-
     def current
       Thread.current[:user]
     end
@@ -119,7 +128,5 @@ module Sufia::User
     def from_url_component(component)
       User.find_by_user_key(component.gsub(/-dot-/, '.'))
     end
-
   end
-
 end

data/sufia-models/app/models/sufia/orcid_validator.rb

@@ -0,0 +1,8 @@
+module Sufia
+  class OrcidValidator < ActiveModel::Validator
+    def validate(record)
+      return if record.orcid.blank?
+      record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless /\d{4}-\d{4}-\d{4}-\d{4}/.match(record.orcid)
+    end
+  end
+end

data/sufia-models/app/services/sufia/generic_file_indexing_service.rb

@@ -0,0 +1,13 @@
+module Sufia
+  class GenericFileIndexingService < IndexingService
+    def generate_solr_document
+      super.tap do |solr_doc|
+        solr_doc[Solrizer.solr_name('label')] = object.label
+        solr_doc[Solrizer.solr_name('file_format')] = object.file_format
+        solr_doc[Solrizer.solr_name('file_format', :facetable)] = object.file_format
+        solr_doc['all_text_timv'] = object.full_text.content
+        solr_doc = object.index_collection_ids(solr_doc)
+      end
+    end
+  end
+end

data/sufia-models/app/services/sufia/indexing_service.rb

@@ -0,0 +1,15 @@
+module Sufia
+  class IndexingService < ActiveFedora::IndexingService
+
+    # Unstemmed, searchable, stored
+    def self.noid_indexer
+      @noid_indexer ||= Solrizer::Descriptor.new(:text, :indexed, :stored)
+    end
+
+    def generate_solr_document
+      super.tap do |solr_doc|
+        solr_doc[Solrizer.solr_name("noid", Sufia::IndexingService.noid_indexer)] = object.noid
+      end
+    end
+  end
+end

data/sufia-models/lib/generators/sufia/models/abstract_migration_generator.rb

@@ -0,0 +1,30 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::AbstractMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(path)
+    if @prev_migration_nr
+      @prev_migration_nr += 1
+    else
+      if last_migration = Dir[File.join(path, '*.rb')].sort.last
+        @prev_migration_nr = last_migration.sub(File.join(path, '/'), '').to_i + 1
+      else
+        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      end
+    end
+    @prev_migration_nr.to_s
+  end
+
+  protected
+
+  def better_migration_template(file)
+    migration_template "migrations/#{file}", "db/migrate/#{file}"
+  rescue Rails::Generators::Error => e
+    say_status("warning", e.message, :yellow)
+  end
+end

data/sufia-models/lib/generators/sufia/models/cached_stats_generator.rb

@@ -1,32 +1,12 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::CachedStatsGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::CachedStatsGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
-  argument :model_name, type: :string , default: "user"
 
   desc """
 This generator adds the ability to cache usage stats to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
- 2. Adds stats methods to the user model
        """
-  # Implement the required interface for Rails::Generators::Migration.
-  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-  def self.next_migration_number(path)
-    if @prev_migration_nr
-      @prev_migration_nr += 1
-    else
-      if last_migration = Dir[File.join(path, '*.rb')].sort.last
-        @prev_migration_nr = last_migration.sub(File.join(path, '/'), '').to_i + 1
-      else
-        @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-      end
-    end
-    @prev_migration_nr.to_s
-  end
 
   def banner
     say_status("warning", "ADDING STATS CACHING-RELATED SUFIA MODELS", :yellow)
@@ -34,35 +14,11 @@ This generator adds the ability to cache usage stats to your application:
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       'create_file_view_stats.rb',
-      'create_file_download_stats.rb',
-      'create_user_stats.rb'
+      'create_file_download_stats.rb'
     ].each do |file|
       better_migration_template file
     end
   end
-
-  def add_stats_mixin_to_user_model
-    file_path = "app/models/#{model_name.underscore}.rb"
-
-    if File.exists?(file_path)
-      inject_into_file file_path, after: /include Sufia\:\:User.*$/ do
-        "\n include Sufia::UserUsageStats"
-      end
-    else
-      puts "     \e[31mFailure\e[0m  Sufia requires a user object. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g sufia client"
-    end
-  end
-
-  private
-
-  def better_migration_template(file)
-    begin
-      migration_template "migrations/#{file}", "db/migrate/#{file}"
-    rescue Rails::Generators::Error => e
-      say_status("warning", e.message, :yellow)
-    end
-  end
 end