Merge pull request #48 from Dantemss/publish_all_task

Added rake task to publish all unpublished objects in the database

Author: Dantemss

app/routines/exercises/import/excel.rb

@@ -1,6 +1,4 @@
 # Imports an Excel file
-# Arguments are, in order:
-# filename, author's user id, copyright holder's user id, skip_first_row
 
 # Reads xls format
 require 'spreadsheet'

app/routines/exercises/import/zip.rb

@@ -1,8 +1,5 @@
 # Imports a zip file
-# The zip file should an Excel spreadsheet and, optionally, image files
-# Arguments are, in order:
-# zip_filename, excel_filename (in the zip file),
-# author's user id, copyright holder's user id, skip_first_row
+# The zip file should contain an Excel spreadsheet and, optionally, image files
 
 module Exercises
   module Import

app/routines/publishables/publish/all.rb

@@ -0,0 +1,22 @@
+# Publishes all unpublished exercises and solutions
+
+module Publishables
+  module Publish
+    class All
+
+      lev_routine
+
+      protected
+
+      def exec
+        publishables = Publication.where(published_at: nil).to_a
+        Rails.logger.info "Publishing #{publishables.length} objects"
+
+        publishables.each do |p|
+          p.publish
+          p.save!
+        end
+      end
+    end
+  end
+end

lib/tasks/exercises_import.rake renamed to lib/tasks/exercises/import.rake

@@ -1,15 +1,12 @@
-# Imports unicode tab-delimited txt file saved from Excel
-# Arguments are, in order:
-# filename, author's user id, copyright holder's user id,
-# skip_first_row, column separator and row separator
-# Example: rake exercises:import:unicode[exercises.txt,1,2]
-#          will import exercises from exercises.txt and
-#          assign the user with ID 1 as the author and
-#          solution author, and the user with ID 2 as the CR holder
-
 namespace :exercises do
   namespace :import do
-
+    # Imports exercises from a spreadsheet
+    # Arguments are, in order:
+    # filename, author's user id, copyright holder's user id, skip_first_row
+    # Example: rake exercises:import:excel[exercises.xlsx,1,2]
+    #          will import exercises from exercises.xlsx and
+    #          assign the user with ID 1 as the author and
+    #          solution author, and the user with ID 2 as the CR holder
     desc "import an Excel file"
     task :excel, [:filename, :author_id, :ch_id, :skip_first_row] => :environment do |t, args|
       # Output import logging info to the console (except in the test environment)
@@ -24,6 +21,13 @@ namespace :exercises do
       end
     end
 
+    # Imports exercises from a zip file
+    # Arguments are, in order:
+    # zip_filename, excel_filename, author's user id, copyright holder's user id, skip_first_row
+    # Example: rake exercises:import:zip[exercises.zip,exercises.xlsx,1,2]
+    #          will import exercises from exercises.xlsx (within exercises.zip) and
+    #          assign the user with ID 1 as the author and
+    #          solution author, and the user with ID 2 as the CR holder
     desc "import a zip file"
     task :zip, [:zip_filename, :excel_filename,
                 :author_id, :ch_id, :skip_first_row] => :environment do |t, args|

lib/tasks/publishables/publish.rake

@@ -0,0 +1,23 @@
+namespace :publishables do
+  namespace :publish do
+
+    # Publishes all unpublished exercises and solutions
+    # Takes no arguments
+    # Example: rake publishables:publish:all
+    #          will publish all unpublished exercises and solutions
+    desc "publishes all unpublished exercises and solutions"
+    task :all => :environment do |t, args|
+      # Output import logging info to the console (except in the test environment)
+      original_logger = Rails.logger
+      begin
+        Rails.logger = ActiveSupport::Logger.new(STDOUT) unless Rails.env.test?
+
+        Publishables::Publish::All.call
+      ensure
+        # Restore original logger
+        Rails.logger = original_logger
+      end
+    end
+
+  end
+end

spec/factories/exercises.rb

@@ -20,7 +20,7 @@
 
     trait :published do
       after(:build) do |exercise|
-        exercise.publication.published_at = Time.now
+        exercise.publication.publish
       end
     end
   end

spec/factories/solutions.rb

@@ -3,5 +3,15 @@
     question
     solution_type SolutionType::EXAMPLE
     content "Worked example!"
+
+    after(:build) do |solution, evaluator|
+      solution.publication ||= build(:publication, publishable: solution)
+    end
+
+    trait :published do
+      after(:build) do |solution|
+        solution.publication.publish
+      end
+    end
   end
 end

spec/lib/tasks/exercises_import_rake_spec.rb renamed to spec/lib/tasks/exercises/import_rake_spec.rb

@@ -3,7 +3,7 @@
 
 describe 'exercises import' do
   before :all do
-    Rake.application.rake_require "tasks/exercises_import"
+    Rake.application.rake_require "tasks/exercises/import"
     Rake::Task.define_task(:environment)
   end
 

spec/lib/tasks/publishables/publish_rake_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+require 'rake'
+
+describe 'publishables publish' do
+  before :all do
+    Rake.application.rake_require "tasks/publishables/publish"
+    Rake::Task.define_task(:environment)
+  end
+
+  context 'all' do
+    let :run_rake_task do
+      Rake::Task["publishables:publish:all"].reenable
+      Rake.application.invoke_task "publishables:publish:all"
+    end
+
+    it 'calls Publishables::Publish::All' do
+      expect(Publishables::Publish::All).to receive(:call)
+      run_rake_task
+    end
+  end
+end

spec/routines/publishables/publish/all_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+module Publishables::Publish
+  RSpec.describe All do
+    let!(:published_exercise) { FactoryGirl.create :exercise, :published }
+    let!(:published_solution) { FactoryGirl.create :solution, :published }
+
+    let!(:exercise_1)         { FactoryGirl.create :exercise }
+    let!(:exercise_2)         { FactoryGirl.create :exercise }
+
+    let!(:solution_1)         { FactoryGirl.create :solution }
+    let!(:solution_2)         { FactoryGirl.create :solution }
+
+    it 'publishes all unpublished publishables' do
+      exercise_published_at = published_exercise.published_at
+      solution_published_at = published_solution.published_at
+
+      Publishables::Publish::All.call
+
+      expect(published_exercise.published_at).to eq (exercise_published_at)
+      expect(published_solution.published_at).to eq (solution_published_at)
+
+      expect(exercise_1.reload.is_published?).to eq true
+      expect(exercise_2.reload.is_published?).to eq true
+
+      expect(solution_1.reload.is_published?).to eq true
+      expect(solution_2.reload.is_published?).to eq true
+    end
+  end
+end