sufia-models 5.0.0.beta1 → 5.0.0.rc1

data/app/models/datastreams/batch_rdf_datastream.rb

@@ -0,0 +1,6 @@
+class BatchRdfDatastream < ActiveFedora::NtriplesRDFDatastream
+  property :part, predicate: RDF::DC.hasPart
+  property :creator, predicate: RDF::DC.creator
+  property :title, predicate: RDF::DC.title
+  property :status, predicate: RDF::DC.type
+end

data/app/models/datastreams/file_content_datastream.rb

@@ -1,4 +1,4 @@
-class FileContentDatastream < ActiveFedora::File
+class FileContentDatastream < ActiveFedora::Datastream
   include Hydra::Derivatives::ExtractMetadata
   include Sufia::FileContent::Versions
 end

data/app/models/datastreams/fits_datastream.rb

@@ -1,7 +1,7 @@
 class FitsDatastream < ActiveFedora::OmDatastream
   include OM::XML::Document
 
-  def prefix(_)
+  def prefix
     ""
   end
 

data/app/models/datastreams/generic_file_rdf_datastream.rb

@@ -0,0 +1,69 @@
+class GenericFileRdfDatastream < ActiveFedora::NtriplesRDFDatastream
+  property :part_of, predicate: RDF::DC.isPartOf
+  property :resource_type, predicate: RDF::DC.type do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :title, predicate: RDF::DC.title do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :creator, predicate: RDF::DC.creator do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :contributor, predicate: RDF::DC.contributor do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :description, predicate: RDF::DC.description do |index|
+    index.type :text
+    index.as :stored_searchable
+  end
+  property :tag, predicate: RDF::DC.relation do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :rights, predicate: RDF::DC.rights do |index|
+    index.as :stored_searchable
+  end
+  property :publisher, predicate: RDF::DC.publisher do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :date_created, predicate: RDF::DC.created do |index|
+    index.as :stored_searchable
+  end
+  property :date_uploaded, predicate: RDF::DC.dateSubmitted do |index|
+    index.type :date
+    index.as :stored_sortable
+  end
+  property :date_modified, predicate: RDF::DC.modified do |index|
+    index.type :date
+    index.as :stored_sortable
+  end
+  property :subject, predicate: RDF::DC.subject do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :language, predicate: RDF::DC.language do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :identifier, predicate: RDF::DC.identifier do |index|
+    index.as :stored_searchable
+  end
+  property :based_near, predicate: RDF::FOAF.based_near do |index|
+    index.as :stored_searchable, :facetable
+  end
+  property :related_url, predicate: RDF::RDFS.seeAlso do |index|
+    index.as :stored_searchable
+  end
+  property :bibliographic_citation, predicate: RDF::DC.bibliographicCitation do |index|
+    index.as :stored_searchable
+  end
+  property :source, predicate: RDF::DC.source do |index|
+    index.as :stored_searchable
+  end
+
+  # TODO: Move this somewhere more appropriate
+  begin
+    LocalAuthority.register_vocabulary(self, "subject", "lc_subjects")
+    LocalAuthority.register_vocabulary(self, "language", "lexvo_languages")
+    LocalAuthority.register_vocabulary(self, "tag", "lc_genres")
+  rescue
+    puts "tables for vocabularies missing"
+  end
+end

data/app/models/datastreams/paranoid_rights_datastream.rb

@@ -0,0 +1,22 @@
+# subclass built-in Hydra RightsDatastream and build in extra model-level validation
+class ParanoidRightsDatastream < Hydra::Datastream::RightsMetadata
+  use_terminology Hydra::Datastream::RightsMetadata
+
+  VALIDATIONS = [
+    {key: :edit_users, message: 'Depositor must have edit access', condition: lambda { |obj| !obj.edit_users.include?(obj.depositor) }},
+    {key: :edit_groups, message: 'Public cannot have edit access', condition: lambda { |obj| obj.edit_groups.include?('public') }},
+    {key: :edit_groups, message: 'Registered cannot have edit access', condition: lambda { |obj| obj.edit_groups.include?('registered') }}
+  ]
+
+  def validate(object)
+    valid = true
+    VALIDATIONS.each do |validation|
+      if validation[:condition].call(object)
+        object.errors[validation[:key]] ||= []
+        object.errors[validation[:key]] << validation[:message]
+        valid = false
+      end
+    end
+    return valid
+  end
+end

data/app/models/datastreams/properties_datastream.rb

@@ -0,0 +1,4 @@
+# properties datastream: catch-all for info that didn't have another home.  Particularly depositor.
+class PropertiesDatastream < ActiveFedora::OmDatastream
+  include Sufia::PropertiesDatastreamBehavior
+end

data/app/models/file_download_stat.rb

@@ -5,8 +5,8 @@ class FileDownloadStat < ActiveRecord::Base
     [ self.class.convert_date(date), downloads ]
   end
 
-  def self.statistics file_id, start_date
-    combined_stats file_id, start_date, :downloads, :totalEvents
+  def self.statistics file_id, start_date, user_id=nil
+    combined_stats file_id, start_date, :downloads, :totalEvents, user_id
   end
 
   # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download

data/app/models/file_usage.rb

@@ -3,13 +3,17 @@ class FileUsage
   attr_accessor :id, :created, :path, :downloads, :pageviews
 
   def initialize id
+    file = ::GenericFile.find(id)
+    user = User.where(email: file.depositor).first
+    user_id = user ? user.id : nil
+
     self.id = id
     self.path = Sufia::Engine.routes.url_helpers.generic_file_path(Sufia::Noid.noidify(id))
     earliest = Sufia.config.analytic_start_date
-    self.created = ::GenericFile.find(id).create_date
+    self.created = DateTime.parse(file.create_date)
     self.created = earliest > created ? earliest : created unless earliest.blank?
-    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created)
-    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created)
+    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created, user_id)
+    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created, user_id)
   end
 
   def total_downloads
@@ -19,8 +23,8 @@ class FileUsage
   def total_pageviews
     self.pageviews.reduce(0) { |total, result| total + result[1].to_i }
   end
-
-  # Package data for visualization using JQuery Flot
+  
+  # Package data for visualization using JQuery Flot 
   def to_flot
     [
       { label: "Pageviews",  data: pageviews },

data/app/models/file_view_stat.rb

@@ -5,8 +5,8 @@ class FileViewStat < ActiveRecord::Base
     [ self.class.convert_date(date), views ]
   end
 
-  def self.statistics file_id, start_date
-    combined_stats file_id, start_date, :views, :pageviews
+  def self.statistics file_id, start_date, user_id=nil
+    combined_stats file_id, start_date, :views, :pageviews, user_id
   end
 
   # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download

data/app/models/local_authority.rb

@@ -9,10 +9,10 @@ class LocalAuthority < ActiveRecord::Base
     return unless self.where(name: name).empty?
     authority = self.create(name: name)
     format = opts.fetch(:format, :ntriples)
-    predicate = opts.fetch(:predicate, ::RDF::SKOS.prefLabel)
+    predicate = opts.fetch(:predicate, RDF::SKOS.prefLabel)
     entries = []
     sources.each do |uri|
-      ::RDF::Reader.open(uri, format: format) do |reader|
+      RDF::Reader.open(uri, format: format) do |reader|
         reader.each_statement do |statement|
           if statement.predicate == predicate
             entries << LocalAuthorityEntry.new(local_authority: authority,

data/app/models/proxy_deposit_request.rb

@@ -78,7 +78,7 @@ class ProxyDepositRequest < ActiveRecord::Base
 
   def title
     return 'file not found' if deleted_file?
-    query = ActiveFedora::SolrQueryBuilder.construct_query_for_ids([pid])
+    query = ActiveFedora::SolrService.construct_query_for_pids([pid])
     solr_response = ActiveFedora::SolrService.query(query, raw: true)
     SolrDocument.new(solr_response['response']['docs'].first, solr_response).title
   end

data/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/app/models/user_stat.rb

@@ -0,0 +1,2 @@
+class UserStat < ActiveRecord::Base
+end

data/app/services/sufia/id_service.rb

@@ -9,11 +9,11 @@ module Sufia
 
     @minter = ::Noid::Minter.new(template: noid_template)
     @pid = $$
-    #@namespace = Sufia.config.id_namespace
+    @namespace = Sufia.config.id_namespace
     @semaphore = Mutex.new
     def self.valid?(identifier)
       # remove the fedora namespace since it's not part of the noid
-      noid = identifier#.split(":").last
+      noid = identifier.split(":").last
       return @minter.valid? noid
     end
     def self.mint
@@ -28,20 +28,20 @@ module Sufia
     protected
 
     def self.next_id
-      id = ''
+      pid = ''
       File.open(Sufia.config.minter_statefile, File::RDWR|File::CREAT, 0644) do |f|
         f.flock(File::LOCK_EX)
         yaml = YAML::load(f.read)
         yaml = {template: noid_template} unless yaml
         minter = ::Noid::Minter.new(yaml)
-        id = minter.mint
+        pid = "#{@namespace}:#{minter.mint}"
         f.rewind
         yaml = YAML::dump(minter.dump)
         f.write yaml
         f.flush
         f.truncate(f.pos)
       end
-      id
+      return pid
     end
   end
 end

data/app/services/sufia/noid.rb

@@ -2,14 +2,16 @@ module Sufia
   module Noid
     extend ActiveSupport::Concern
 
-    ## This overrides the default behavior, which is to ask Fedora for a pid
-    # @see ActiveFedora::Sharding.assign_pid
-    def assign_pid
-      Sufia::IdService.mint
+    module ClassMethods
+      ## This overrides the default behavior, which is to ask Fedora for a pid
+      # @see ActiveFedora::Sharding.assign_pid
+      def assign_pid(_)
+        Sufia::IdService.mint
+      end
     end
 
     def noid
-      Noid.noidify(id)
+      Noid.noidify(self.pid)
     end
 
     # Redefine this for more intuitive keys in Redis
@@ -22,11 +24,6 @@ module Sufia
         String(identifier).split(":").last
       end
 
-      # Create a pairtree like path for the given identifier
-      def treeify(identifier)
-        (identifier.scan(/..?/).first(4) + [identifier]).join('/')
-      end
-
       def namespaceize(identifier)
         return identifier if identifier.include?(':')
         "#{namespace}:#{identifier}"

data/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/lib/generators/sufia/models/cached_stats_generator.rb

@@ -1,30 +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__)
 
   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
        """
-  # 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)
@@ -32,7 +14,6 @@ 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'
@@ -40,14 +21,4 @@ This generator adds the ability to cache usage stats to your application:
       better_migration_template file
     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

data/lib/generators/sufia/models/install_generator.rb

@@ -1,12 +1,7 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-class Sufia::Models::InstallGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+require_relative 'abstract_migration_generator'
 
+class Sufia::Models::InstallGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
-
   argument     :model_name, type: :string , default: "user"
   desc """
 This generator makes the following changes to your application:
@@ -19,30 +14,15 @@ This generator makes the following changes to your application:
  7. Runs full-text generator
  8. Runs proxies generator
  9. Runs cached stats generator
+10. Runs ORCID field generator
+11. Runs user stats generator
        """
-
-  # 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", "GENERATING SUFIA MODELS", :yellow)
   end
 
   # Setup the database migrations
   def copy_migrations
-    # Can't get this any more DRY, because we need this order.
     [
       "acts_as_follower_migration.rb",
       "add_social_to_users.rb",
@@ -114,13 +94,13 @@ This generator makes the following changes to your application:
     generate 'sufia:models:cached_stats'
   end
 
-  private
+  # Adds orcid field to user model
+  def orcid_field
+    generate 'sufia:models:orcid_field'
+  end
 
-  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
+  # Adds user stats-related migration & methods
+  def user_stats
+    generate 'sufia:models:user_stats'
   end
 end