sufia 5.0.0 → 6.0.0.beta1

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

@@ -1,12 +1,32 @@
-require_relative 'abstract_migration_generator'
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::CachedStatsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
 
-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)
@@ -14,11 +34,35 @@ 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_file_download_stats.rb',
+      'create_user_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

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

@@ -1,7 +1,12 @@
-require_relative 'abstract_migration_generator'
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
 
-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:
@@ -14,15 +19,30 @@ 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",
@@ -94,13 +114,13 @@ This generator makes the following changes to your application:
     generate 'sufia:models:cached_stats'
   end
 
-  # Adds orcid field to user model
-  def orcid_field
-    generate 'sufia:models:orcid_field'
-  end
+  private
 
-  # Adds user stats-related migration & methods
-  def user_stats
-    generate 'sufia:models:user_stats'
+  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/sufia-models/lib/generators/sufia/models/proxies_generator.rb

@@ -1,12 +1,30 @@
-require_relative 'abstract_migration_generator'
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::ProxiesGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
 
-class Sufia::Models::ProxiesGenerator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
 
   desc """
 This generator adds proxies and transfers 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 PROXY/TRANSFER-RELATED SUFIA MODELS", :yellow)
@@ -14,6 +32,7 @@ This generator adds proxies and transfers to your application:
 
   # Setup the database migrations
   def copy_migrations
+    # Can't get this any more DRY, because we need this order.
     [
       'create_proxy_deposit_rights.rb',
       'create_proxy_deposit_requests.rb'
@@ -21,4 +40,14 @@ This generator adds proxies and transfers 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/sufia-models/lib/generators/sufia/models/templates/config/sufia.rb

@@ -111,6 +111,16 @@ Sufia.config do |config|
   # Specify how many seconds back from the current time that we should show by default of the user's activity on the user's dashboard
   # config.activity_to_show_default_seconds_since_now = 24*60*60
 
+  # Specify a date you wish to start collecting Google Analytic statistics for.
+  # Leaving it blank will set the start date to when ever the file was uploaded by
+  # NOTE: if you have always sent analytics to GA for downloads and page views leave this commented out
+  # config.analytic_start_date = DateTime.new(2014,9,10)
+  #
+  # Method of converting pids into URIs for storage in Fedora
+  # config.translate_uri_to_id = lambda { |uri| uri.to_s.split('/')[-1] }
+  # config.translate_id_to_uri = lambda { |id|
+  #      "#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}/#{Sufia::Noid.treeify(id)}" }
+
   # If browse-everything has been configured, load the configs.  Otherwise, set to nil.
   begin
     if defined? BrowseEverything

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

@@ -1,8 +1,13 @@
-require_relative 'abstract_migration_generator'
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Sufia::Models::Upgrade400Generator < Rails::Generators::Base
+  include Rails::Generators::Migration
 
-class Sufia::Models::Upgrade400Generator < Sufia::Models::AbstractMigrationGenerator
   source_root File.expand_path('../templates', __FILE__)
 
+  argument     :model_name, type: :string , default: "user"
   desc """
 This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
@@ -11,12 +16,28 @@ This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following
  4. Runs full-text 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", "UPGRADING SUFIA MODELS", :yellow)
   end
 
   # Setup the database migrations
   def copy_migrations
+    # Can't get this any more DRY, because we need this order.
     [
       'create_tinymce_assets.rb',
       'create_content_blocks.rb',
@@ -51,4 +72,14 @@ This generator for upgrading sufia-models from 3.7.2 to 4.0 makes the following
   def full_text_indexing
     generate "sufia:models:fulltext"
   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/sufia-models/lib/sufia/models/engine.rb

@@ -31,6 +31,10 @@ module Sufia
       # Defaulting analytic start date to when ever the file was uploaded by leaving it blank
       config.analytic_start_date = nil
 
+      config.translate_uri_to_id = lambda { |uri| uri.to_s.split('/')[-1] }
+      config.translate_id_to_uri = lambda { |id|
+        "#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}/#{Sufia::Noid.treeify(id)}" }
+
       config.autoload_paths += %W(
         #{config.root}/app/models/datastreams
       )
@@ -58,10 +62,15 @@ module Sufia
       end
 
       initializer 'configure' do
-        Hydra::Derivatives.ffmpeg_path    = Sufia.config.ffmpeg_path
-        Hydra::Derivatives.temp_file_base = Sufia.config.temp_file_base
-        Hydra::Derivatives.fits_path      = Sufia.config.fits_path
-        Hydra::Derivatives.enable_ffmpeg  = Sufia.config.enable_ffmpeg
+        Sufia.config.tap do |c|
+          Hydra::Derivatives.ffmpeg_path    = c.ffmpeg_path
+          Hydra::Derivatives.temp_file_base = c.temp_file_base
+          Hydra::Derivatives.fits_path      = c.fits_path
+          Hydra::Derivatives.enable_ffmpeg  = c.enable_ffmpeg
+
+          ActiveFedora::Base.translate_uri_to_id = c.translate_uri_to_id
+          ActiveFedora::Base.translate_id_to_uri = c.translate_id_to_uri
+        end
       end
     end
   end

data/sufia-models/lib/sufia/models/file_content/versions.rb

@@ -1,23 +1,21 @@
 module Sufia
   module FileContent
     module Versions
-      def get_version(version_id)
-        self.versions.select { |v| v.versionID == version_id}.first
+      extend ActiveSupport::Concern
+
+      included do
+        has_many_versions
       end
 
       def latest_version
-        self.versions.first
+        versions.last unless versions.empty?
       end
 
-      def version_committer(version)
-        vc = VersionCommitter.where(obj_id: version.pid,
-                                    datastream_id: version.dsid,
-                                    version_id: version.versionID)
-        return vc.empty? ? nil : vc.first.committer_login
+      def save
+        super.tap do |passing|
+          create_version if passing
+        end
       end
-
-
     end
   end
 end
-

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

@@ -12,11 +12,11 @@ module Sufia
         start_date = date_since_last_cache(user)
 
         stats = {}
-        file_ids_for_user(user).each do |file_id|
-          view_stats = FileViewStat.statistics(file_id, start_date, user.id)
+        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)
+          dl_stats = FileDownloadStat.statistics(file.id, start_date, user.id)
           stats = tally_results(dl_stats, :downloads, stats)
         end
 
@@ -38,12 +38,8 @@ private
       end
     end
 
-    def file_ids_for_user(user)
-      ids = []
-      ::GenericFile.find_in_batches("#{Solrizer.solr_name('depositor', :symbol)}:\"#{user.user_key}\"", fl:"id") do |group|
-        ids.concat group.map { |doc| doc["id"] }
-      end
-      ids
+    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

data/sufia-models/lib/sufia/models/version.rb

@@ -1,5 +1,5 @@
 module Sufia
   module Models
-    VERSION = "5.0.0"
+    VERSION = "6.0.0.beta1"
   end
 end

data/sufia-models/lib/sufia/permissions/writable.rb

@@ -8,32 +8,50 @@ module Sufia
       include Hydra::AccessControls::Visibility
 
       included do
-        has_metadata "rightsMetadata", type: ParanoidRightsDatastream
         validate :paranoid_permissions
       end
 
       def paranoid_permissions
-        # let the rightsMetadata ds make this determination
-        # - the object instance is passed in for easier access to the props ds
-        rightsMetadata.validate(self)
+        valid = true
+        VALIDATIONS.each do |validation|
+          if validation[:condition].call(self)
+            errors[validation[:key]] ||= []
+            errors[validation[:key]] << validation[:message]
+            valid = false
+          end
+        end
+        return valid
       end
 
-      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
-      def permissions=(params)
-        perm_hash = permission_hash
-        params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
-        params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
+      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') }}
+      ]
 
-        params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
-        params[:group].each { |name, access| perm_hash['group'][name] = access if ['read', 'edit'].include?(access)} if params[:group]
 
-        rightsMetadata.update_permissions(perm_hash)
+      def clear_permissions!
+        self.permissions = []
       end
 
-      def permissions
-        perms = super
-        perms.map {|p| { name: p.name, access: p.access, type:p.type } }
-      end
+      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
+      # def permissions=(params)
+      #   raise "Fixme #{params}"
+      #   perm_hash = permission_hash
+      #   params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
+      #   params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
+
+      #   params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
+      #   params[:group].each { |name, access| perm_hash['group'][name] = access if ['read', 'edit'].include?(access)} if params[:group]
+
+      #   # rightsMetadata.update_permissions(perm_hash)
+      # end
+
+      # def permissions
+      #   raise "Fixme "
+      #   perms = super
+      #   perms.map {|p| { name: p.name, access: p.access, type:p.type } }
+      # end
 
       private
 

data/sufia-models/sufia-models.gemspec

@@ -29,7 +29,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '~> 4.0', '< 5.0.0'
   spec.add_dependency 'activeresource', "~> 4.0" # No longer a dependency of rails 4.0
 
-  spec.add_dependency "hydra-head", "~> 7.0"
+  spec.add_dependency "hydra-head", "~> 9.0.0.beta1"
+  spec.add_dependency "active-fedora", "~> 9.0.0.beta5"
+  spec.add_dependency "hydra-collections", "~> 4.0.0.beta1"
+  spec.add_dependency 'hydra-derivatives', '~> 1.0.0.beta1'
   spec.add_dependency 'nest', '~> 1.1'
   spec.add_dependency 'resque', '~> 1.23'
   spec.add_dependency 'resque-pool', '~> 0.3'
@@ -37,7 +40,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mailboxer', '~> 0.12'
   spec.add_dependency 'acts_as_follower', '>= 0.1.1', '< 0.3'
   spec.add_dependency 'carrierwave', '~> 0.9'
-  spec.add_dependency 'hydra-derivatives', '~> 0.1'
   spec.add_dependency 'oauth2', '~> 0.9'
   spec.add_dependency 'google-api-client', '~> 0.7'
   spec.add_dependency 'legato', '~> 0.3'