sufia-models 4.3.1 → 5.0.0.beta1

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

@@ -1,18 +0,0 @@
-# add this in here until we can use a version of Active Fedora that contains this ability
-module Sufia
-  module GenericFile
-    module ReloadOnSave
-
-      attr_writer :reload_on_save
-
-      def reload_on_save?
-        !!@reload_on_save
-      end
-
-      def refresh
-        self.reload if reload_on_save?
-      end
-    end
-  end
-end
-

data/app/models/concerns/sufia/properties_datastream_behavior.rb

@@ -1,32 +0,0 @@
-module Sufia
-  module PropertiesDatastreamBehavior
-    extend ActiveSupport::Concern
-
-    included do
-      set_terminology do |t|
-        t.root(path: "fields")
-        # This is where we put the user id of the object depositor -- impacts permissions/access controls
-        t.depositor index_as: [:symbol, :stored_searchable]
-        # This is where we put the relative path of the file if submitted as a folder
-        t.relative_path
-        t.import_url path: 'importUrl', index_as: :symbol
-        t.proxy_depositor path: 'proxyDepositor', index_as: :symbol
-        # This value is set when a user indicates they are depositing this for someone else
-        t.on_behalf_of path: 'onBehalfOf', index_as: :symbol
-      end
-    end
-
-    module ClassMethods
-      def xml_template
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.fields
-        end
-        builder.doc
-      end
-    end
-
-    def prefix
-      ""
-    end
-  end
-end

data/app/models/concerns/sufia/user_usage_stats.rb

@@ -1,15 +0,0 @@
-module Sufia::UserUsageStats
-
-  def stats
-    @stats ||= UserStat.where(user_id: id).order(date: :asc)
-  end
-
-  def total_file_views
-    stats.reduce(0) { |total, stat| total + stat.file_views }
-  end
-
-  def total_file_downloads
-    stats.reduce(0) { |total, stat| total + stat.file_downloads }
-  end
-
-end

data/app/models/datastreams/batch_rdf_datastream.rb

@@ -1,6 +0,0 @@
-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/generic_file_rdf_datastream.rb

@@ -1,69 +0,0 @@
-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

@@ -1,22 +0,0 @@
-# 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

@@ -1,4 +0,0 @@
-# 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/sufia/orcid_validator.rb

@@ -1,8 +0,0 @@
-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

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

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

@@ -1,30 +0,0 @@
-# -*- 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/orcid_field_generator.rb

@@ -1,19 +0,0 @@
-require_relative 'abstract_migration_generator'
-
-class Sufia::Models::OrcidFieldGenerator < Sufia::Models::AbstractMigrationGenerator
-  source_root File.expand_path('../templates', __FILE__)
-
-  desc """
-This generator adds a field to hold users' ORCIDs to your application:
- 1. Creates a database migration if they do not exist in /db/migrate
-       """
-
-  def banner
-    say_status("warning", "ADDING ORCID FIELD TO USER MODEL", :yellow)
-  end
-
-  # Setup the database migration
-  def copy_migrations
-    better_migration_template 'add_orcid_to_users.rb'
-  end
-end

data/lib/generators/sufia/models/templates/migrations/add_orcid_to_users.rb

@@ -1,5 +0,0 @@
-class AddOrcidToUsers < ActiveRecord::Migration
-  def change
-    add_column :users, :orcid, :string
-  end
-end

data/lib/generators/sufia/models/templates/migrations/create_user_stats.rb

@@ -1,19 +0,0 @@
-class CreateUserStats < ActiveRecord::Migration
-  def change
-    create_table :user_stats do |t|
-      t.integer :user_id
-      t.datetime :date
-      t.integer :file_views
-      t.integer :file_downloads
-
-      t.timestamps
-    end
-
-    add_column :file_view_stats, :user_id, :integer
-    add_column :file_download_stats, :user_id, :integer
-
-    add_index :user_stats, :user_id
-    add_index :file_view_stats, :user_id
-    add_index :file_download_stats, :user_id
-  end
-end

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

@@ -1,31 +0,0 @@
-require_relative 'abstract_migration_generator'
-
-class Sufia::Models::UserStatsGenerator < Sufia::Models::AbstractMigrationGenerator
-  source_root File.expand_path('../templates', __FILE__)
-  argument :model_name, type: :string , default: "user"
-
-  desc """
-This generator adds usage stats methods to the user model in your application:
-       """
-
-  def banner
-    say_status("warning", "ADDING USER STATS-RELATED ABILITIES TO SUFIA MODELS", :yellow)
-  end
-
-  # Setup the database migrations
-  def copy_migrations
-    better_migration_template 'create_user_stats.rb'
-  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 generator 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:models:user_stats client"
-    end
-  end
-end

data/lib/sufia/models/stats/user_stat_importer.rb

@@ -1,85 +0,0 @@
-module Sufia
-  class UserStatImporter
-
-    def initialize(options={})
-      @verbose = options[:verbose]
-      @logging = options[:logging]
-    end
-
-    def import
-      log_message('Begin import of User stats.')
-      ::User.find_each do |user|
-        start_date = date_since_last_cache(user)
-
-        stats = {}
-        files_for_user(user).each do |file|
-          view_stats = FileViewStat.statistics(file.id, start_date, user.id)
-          stats = tally_results(view_stats, :views, stats)
-
-          dl_stats = FileDownloadStat.statistics(file.id, start_date, user.id)
-          stats = tally_results(dl_stats, :downloads, stats)
-        end
-
-        create_or_update_user_stats(stats, user)
-      end
-      log_message('User stats import complete.')
-    end
-
-
-private
-
-    def date_since_last_cache(user)
-      last_cached_stat = UserStat.where(user_id: user.id).order(date: :asc).last
-
-      if last_cached_stat
-        last_cached_stat.date + 1.day
-      else
-        Sufia.config.analytic_start_date
-      end
-    end
-
-    def files_for_user(user)
-      ::GenericFile.where(Solrizer.solr_name('depositor', :symbol) => user.user_key)
-    end
-
-    # For each date, add the view and download counts for this
-    # file to the view & download sub-totals for that day.
-    # The resulting hash will look something like this:
-    # {"2014-11-30 00:00:00 UTC" => {:views=>2, :downloads=>5},
-    #  "2014-12-01 00:00:00 UTC" => {:views=>4, :downloads=>4}}
-    def tally_results(file_stats, stat_name, total_stats)
-      file_stats.each do |stats|
-        # Exclude the stats from today since it will only be a partial day's worth of data
-        break if stats.date == Date.today
-
-        date_key = stats.date.to_s
-        old_count = total_stats[date_key] ? total_stats[date_key].fetch(stat_name) { 0 } : 0
-        new_count = old_count + stats.method(stat_name).call
-
-        old_values = total_stats[date_key] || {}
-        total_stats.store(date_key, old_values)
-        total_stats[date_key].store(stat_name, new_count)
-      end
-      total_stats
-    end
-
-    def create_or_update_user_stats(stats, user)
-      stats.each do |date_string, data|
-        date = Time.zone.parse(date_string)
-
-        user_stat = UserStat.where(user_id: user.id).where(date: date).first
-        user_stat ||= UserStat.new(user_id: user.id, date: date)
-
-        user_stat.file_views = data[:views] || 0
-        user_stat.file_downloads = data[:downloads] || 0
-        user_stat.save!
-      end
-    end
-
-    def log_message(message)
-      puts message if @verbose
-      Rails.logger.info "#{self.class}: #{message}" if @logging
-    end
-
-  end
-end

data/lib/tasks/stats_tasks.rake

@@ -1,12 +0,0 @@
-namespace :sufia do
-  namespace :stats do
-
-    desc "Cache file view & download stats for all users"
-    task :user_stats => :environment do
-      require 'sufia/models/stats/user_stat_importer'
-      importer = Sufia::UserStatImporter.new(verbose: true, logging: true)
-      importer.import
-    end
-
-  end
-end