sufia 6.2.0 → 6.3.0

data/spec/models/content_block_spec.rb

@@ -1,41 +1,52 @@
 require 'spec_helper'
 
-describe ContentBlock, :type => :model do
-
-  let(:bilbo) { ContentBlock.create!(
-    name: ContentBlock::RESEARCHER,
-    value: '<h1>Bilbo Baggins</h1>',
-    created_at: Time.now)
-  }
+describe ContentBlock, type: :model do
+  let(:bilbo) do
+    described_class.create!(
+      name: ContentBlock::RESEARCHER,
+      value: '<h1>Bilbo Baggins</h1>',
+      created_at: Time.now)
+  end
 
-  let(:frodo) { ContentBlock.create!(
-    name: ContentBlock::RESEARCHER,
-    value: '<h1>Frodo Baggins</h1>',
-    created_at: 2.hours.ago)
-  }
+  let(:frodo) do
+    described_class.create!(
+      name: ContentBlock::RESEARCHER,
+      value: '<h1>Frodo Baggins</h1>',
+      created_at: 2.hours.ago)
+  end
 
-  let(:marketing) { ContentBlock.create!(
-    name: ContentBlock::MARKETING,
-    value: '<h1>Marketing Text</h1>')
-  }
+  let(:marketing) do
+    described_class.create!(
+      name: ContentBlock::MARKETING,
+      value: '<h1>Marketing Text</h1>')
+  end
 
   describe '.recent_researchers' do
-    before { frodo; bilbo; marketing }
-    subject { ContentBlock.recent_researchers }
+    before do
+      frodo
+      bilbo
+      marketing
+    end
+
+    subject { described_class.recent_researchers }
 
     it 'returns featured_researcher entries in chronological order' do
-      expect(ContentBlock.count).to eq 3
+      expect(described_class.count).to eq 3
       expect(subject).to eq [bilbo, frodo]
     end
   end
 
   describe '.featured_researcher' do
-    before { frodo; bilbo; marketing }
-    subject { ContentBlock.featured_researcher }
+    before do
+      frodo
+      bilbo
+      marketing
+    end
+
+    subject { described_class.featured_researcher }
 
     it 'finds the most recent entry for featured_researcher' do
       expect(subject).to eq bilbo
     end
   end
-
 end

data/spec/models/download_spec.rb

@@ -1,13 +1,12 @@
 require 'spec_helper'
 
-describe Sufia::Download, :type => :model do
-
+describe Sufia::Download, type: :model do
   before do
-    @download = Sufia::Download
+    @download = described_class
   end
 
   it 'has an events metric' do
-    expect(@download.metrics).to be  == Legato::ListParameter.new(:metrics, [:totalEvents])
+    expect(@download.metrics).to be == Legato::ListParameter.new(:metrics, [:totalEvents])
   end
 
   it 'has dimensions' do
@@ -17,5 +16,4 @@ describe Sufia::Download, :type => :model do
   it 'responds to :for_file' do
     expect(@download).to respond_to(:for_file)
   end
-
 end

data/spec/models/featured_work_list_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe FeaturedWorkList, :type => :model do
+describe FeaturedWorkList, type: :model do
   let(:file1) { create(:generic_file) }
   let(:file2) { create(:generic_file) }
 
@@ -10,7 +10,7 @@ describe FeaturedWorkList, :type => :model do
       create(:featured_work, generic_file_id: file2.id)
     end
 
-    it 'should be a list of the featured work objects, each with the generic_file\'s solr_doc' do
+    it 'is a list of the featured work objects, each with the generic_file\'s solr_doc' do
       expect(subject.featured_works.size).to eq 2
       solr_doc = subject.featured_works.first.generic_file_solr_document
       expect(solr_doc).to be_kind_of SolrDocument
@@ -25,7 +25,7 @@ describe FeaturedWorkList, :type => :model do
       file1.destroy
     end
 
-    it 'should be a list of the remaining featured work objects, each with the generic_file\'s solr_doc' do
+    it 'is a list of the remaining featured work objects, each with the generic_file\'s solr_doc' do
       expect(subject.featured_works.size).to eq 1
       solr_doc = subject.featured_works.first.generic_file_solr_document
       expect(solr_doc).to be_kind_of SolrDocument

data/spec/models/featured_work_spec.rb

@@ -1,25 +1,25 @@
 require 'spec_helper'
 
-describe FeaturedWork, :type => :model do
-  let(:feature) { FeaturedWork.create(generic_file_id:"99") }
+describe FeaturedWork, type: :model do
+  let(:feature) { described_class.create(generic_file_id: "99") }
 
-  it "should have a file" do
+  it "has a file" do
     expect(feature.generic_file_id).to eq "99"
   end
 
-  it "should not allow six features" do
+  it "does not allow six features" do
     5.times do |n|
-      expect(FeaturedWork.create(generic_file_id:n.to_s)).to_not be_new_record 
+      expect(described_class.create(generic_file_id: n.to_s)).to_not be_new_record
     end
-    FeaturedWork.create(generic_file_id:"6").tap do |sixth|
-      expect(sixth).to be_new_record 
+    described_class.create(generic_file_id: "6").tap do |sixth|
+      expect(sixth).to be_new_record
       expect(sixth.errors.full_messages).to eq ["Limited to 5 featured works."]
     end
-    expect(FeaturedWork.count).to eq 5
+    expect(described_class.count).to eq 5
   end
 
   describe "can_create_another?" do
-    subject { FeaturedWork }
+    subject { described_class }
     context "when none exist" do
       describe '#can_create_another?' do
         subject { super().can_create_another? }
@@ -29,7 +29,7 @@ describe FeaturedWork, :type => :model do
     context "when five exist" do
       before do
         5.times do |n|
-          FeaturedWork.create(generic_file_id:n.to_s)
+          described_class.create(generic_file_id: n.to_s)
         end
       end
 
@@ -41,13 +41,11 @@ describe FeaturedWork, :type => :model do
   end
 
   describe "#order" do
-    subject { FeaturedWork.new(order: 5) }
+    subject { described_class.new(order: 5) }
 
     describe '#order' do
       subject { super().order }
-      it {is_expected.to eq 5 }
+      it { is_expected.to eq 5 }
     end
   end
 end
-
-

data/spec/models/file_content_datastream_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe FileContentDatastream, :type => :model do
+describe FileContentDatastream, type: :model do
   describe "#latest_version" do
     let(:file) do
       GenericFile.create do |f|
@@ -25,14 +25,16 @@ describe FileContentDatastream, :type => :model do
   end
 
   describe "extract_metadata" do
-    let(:datastream) { FileContentDatastream.new('foo/content') }
-    let(:file) { ActionDispatch::Http::UploadedFile.new(tempfile: File.new(fixture_path + '/world.png'),
-                                                 filename: 'world.png') }
+    let(:datastream) { described_class.new('foo/content') }
+    let(:file) do
+      ActionDispatch::Http::UploadedFile.new(tempfile: File.new(fixture_path + '/world.png'),
+                                             filename: 'world.png')
+    end
     before { datastream.content = file }
     let(:document) { Nokogiri::XML.parse(datastream.extract_metadata).root }
-    let(:namespace) { { 'ns'=>'http://hul.harvard.edu/ois/xml/ns/fits/fits_output' } }
+    let(:namespace) { { 'ns' => 'http://hul.harvard.edu/ois/xml/ns/fits/fits_output' } }
 
-    it "should return an xml document", unless: $in_travis do
+    it "returns an xml document", unless: $in_travis do
       expect(document.xpath('//ns:identity/@mimetype', namespace).first.value).to eq 'image/png'
     end
   end
@@ -43,7 +45,7 @@ describe FileContentDatastream, :type => :model do
       @generic_file.apply_depositor_metadata('mjg36')
     end
 
-    it "should only return true when the datastream has actually changed" do
+    it "onlies return true when the datastream has actually changed" do
       @generic_file.add_file(File.open(fixture_path + '/world.png', 'rb'), path: 'content', original_name: 'world.png')
       expect(@generic_file.content).to be_changed
       @generic_file.save!

data/spec/models/file_download_stat_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-RSpec.describe FileDownloadStat, :type => :model do
-  let(:file_id) {"99"}
-  let(:date) {DateTime.new}
-  let(:file_stat) {FileDownloadStat.create(downloads:"2", date: date, file_id: file_id)}
+RSpec.describe FileDownloadStat, type: :model do
+  let(:file_id) { "99" }
+  let(:date) { DateTime.new }
+  let(:file_stat) { described_class.create(downloads: "2", date: date, file_id: file_id) }
 
   it "has attributes" do
     expect(file_stat).to respond_to(:downloads)
@@ -14,73 +14,67 @@ RSpec.describe FileDownloadStat, :type => :model do
     expect(file_stat.downloads).to eq(2)
   end
 
-
   describe "#get_float_statistics" do
-
-    let(:dates) {
+    let(:dates) do
       ldates = []
-      4.downto(0) {|idx| ldates << (Date.today-idx.day) }
+      4.downto(0) { |idx| ldates << (Date.today - idx.day) }
       ldates
-    }
-    let(:date_strs) {
-      dates.map {|date|  date.strftime("%Y%m%d") }
-    }
+    end
+    let(:date_strs) do
+      dates.map { |date| date.strftime("%Y%m%d") }
+    end
 
-    let(:download_output) {
+    let(:download_output) do
       [[statistic_date(dates[0]), 1], [statistic_date(dates[1]), 1], [statistic_date(dates[2]), 2], [statistic_date(dates[3]), 3]]
-    }
+    end
 
     # This is what the data looks like that's returned from Google Analytics (GA) via the Legato gem
     # Due to the nature of querying GA, testing this data in an automated fashion is problematc.
     # Sample data structures were created by sending real events to GA from a test instance of
     # Scholarsphere.  The data below are essentially a "cut and paste" from the output of query
     # results from the Legato gem.
-    let(:sample_download_statistics) {
+    let(:sample_download_statistics) do
       [
-          OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[0], totalEvents: "1"),
-          OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[1], totalEvents: "1"),
-          OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[2], totalEvents: "2"),
-          OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[3], totalEvents: "3"),
-          #OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[4], totalEvents: "5"),
+        OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[0], totalEvents: "1"),
+        OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[1], totalEvents: "1"),
+        OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[2], totalEvents: "2"),
+        OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[3], totalEvents: "3"),
+        # OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[4], totalEvents: "5"),
       ]
-    }
+    end
 
     describe "cache empty" do
-      let(:stats) {
-        expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
-        FileDownloadStat.statistics(file_id,Date.today-4.day)
-      }
+      let(:stats) do
+        expect(described_class).to receive(:ga_statistics).and_return(sample_download_statistics)
+        described_class.statistics(file_id, Date.today - 4.day)
+      end
 
       it "includes cached ga data" do
-        expect(FileDownloadStat.to_flots stats).to include(*download_output)
+        expect(described_class.to_flots stats).to include(*download_output)
       end
 
       it "caches data" do
-        expect(FileDownloadStat.to_flots stats).to include(*download_output)
+        expect(described_class.to_flots stats).to include(*download_output)
 
         # at this point all data should be cached
-        allow(FileDownloadStat).to receive(:ga_statistics).with(Date.today, file_id).and_raise("We should not call Google Analytics All data should be cached!")
+        allow(described_class).to receive(:ga_statistics).with(Date.today, file_id).and_raise("We should not call Google Analytics All data should be cached!")
 
-        stats2 = FileDownloadStat.statistics(file_id,Date.today-4.day)
-        expect(FileDownloadStat.to_flots stats2).to include(*download_output)
+        stats2 = described_class.statistics(file_id, Date.today - 4.day)
+        expect(described_class.to_flots stats2).to include(*download_output)
       end
-
     end
 
     describe "cache loaded" do
+      let!(:file_download_stat) { described_class.create(date: (Date.today - 5.day).to_datetime, file_id: file_id, downloads: "25") }
 
-      let!(:file_download_stat) { FileDownloadStat.create(date: (Date.today-5.day).to_datetime, file_id: file_id, downloads:"25")}
-
-      let(:stats) {
-        expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
-        FileDownloadStat.statistics(file_id,Date.today-5.day)
-      }
+      let(:stats) do
+        expect(described_class).to receive(:ga_statistics).and_return(sample_download_statistics)
+        described_class.statistics(file_id, Date.today - 5.day)
+      end
 
       it "includes cached data" do
-        expect(FileDownloadStat.to_flots stats).to include([file_download_stat.date.to_i*1000,file_download_stat.downloads],*download_output)
+        expect(described_class.to_flots stats).to include([file_download_stat.date.to_i * 1000, file_download_stat.downloads], *download_output)
       end
-
     end
   end
-
 end

data/spec/models/file_usage_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
-describe FileUsage, :type => :model do
-
+describe FileUsage, type: :model do
   let(:file) do
     GenericFile.new.tap do |file|
       file.apply_depositor_metadata("awead")
@@ -9,24 +8,25 @@ describe FileUsage, :type => :model do
     end
   end
 
-  let(:dates) {
+  let(:dates) do
     ldates = []
-    4.downto(0) {|idx| ldates << (Date.today-idx.day) }
+    4.downto(0) { |idx| ldates << (Date.today - idx.day) }
     ldates
-  }
-  let(:date_strs) {
+  end
+
+  let(:date_strs) do
     ldate_strs = []
-    dates.each {|date| ldate_strs << date.strftime("%Y%m%d") }
+    dates.each { |date| ldate_strs << date.strftime("%Y%m%d") }
     ldate_strs
-  }
+  end
 
-  let(:view_output) {
+  let(:view_output) do
     [[statistic_date(dates[0]), 4], [statistic_date(dates[1]), 8], [statistic_date(dates[2]), 6], [statistic_date(dates[3]), 10], [statistic_date(dates[4]), 2]]
-  }
+  end
 
-  let(:download_output) {
-    [[statistic_date(dates[0]), 1], [statistic_date(dates[1]), 1], [statistic_date(dates[2]), 2], [statistic_date(dates[3]), 3],  [statistic_date(dates[4]), 5]]
-  }
+  let(:download_output) do
+    [[statistic_date(dates[0]), 1], [statistic_date(dates[1]), 1], [statistic_date(dates[2]), 2], [statistic_date(dates[3]), 3], [statistic_date(dates[4]), 5]]
+  end
 
   # This is what the data looks like that's returned from Google Analytics (GA) via the Legato gem
   # Due to the nature of querying GA, testing this data in an automated fashion is problematc.
@@ -34,17 +34,17 @@ describe FileUsage, :type => :model do
   # Scholarsphere.  The data below are essentially a "cut and paste" from the output of query
   # results from the Legato gem.
 
-  let(:sample_download_statistics) {
+  let(:sample_download_statistics) do
     [
       OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[0], totalEvents: "1"),
       OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[1], totalEvents: "1"),
       OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[2], totalEvents: "2"),
       OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[3], totalEvents: "3"),
-      OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[4], totalEvents: "5"),
+      OpenStruct.new(eventCategory: "Files", eventAction: "Downloaded", eventLabel: "sufia:x920fw85p", date: date_strs[4], totalEvents: "5")
     ]
-  }
+  end
 
-  let(:sample_pageview_statistics) {
+  let(:sample_pageview_statistics) do
     [
       OpenStruct.new(date: date_strs[0], pageviews: 4),
       OpenStruct.new(date: date_strs[1], pageviews: 8),
@@ -52,33 +52,30 @@ describe FileUsage, :type => :model do
       OpenStruct.new(date: date_strs[3], pageviews: 10),
       OpenStruct.new(date: date_strs[4], pageviews: 2)
     ]
-  }
+  end
 
-  let(:usage) {
-    allow_any_instance_of(GenericFile).to receive(:create_date).and_return((Date.today-4.day).to_s)
+  let(:usage) do
+    allow_any_instance_of(GenericFile).to receive(:create_date).and_return((Date.today - 4.day).to_s)
     expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
     expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
-    FileUsage.new(file.id)
-  }
+    described_class.new(file.id)
+  end
 
   describe "#initialize" do
-
-    it "should set the id" do
+    it "sets the id" do
       expect(usage.id).to eq(file.id)
     end
 
-    it "should set the path" do
+    it "sets the path" do
       expect(usage.path).to eq("/files/#{URI.encode(file.id, '/')}")
     end
 
-    it "should set the created date" do
+    it "sets the created date" do
       expect(usage.created).to eq(file.create_date)
     end
-
   end
 
   describe "statistics" do
-
     before(:all) do
       @system_timezone = ENV['TZ']
       ENV['TZ'] = 'UTC'
@@ -88,15 +85,15 @@ describe FileUsage, :type => :model do
       ENV['TZ'] = @system_timezone
     end
 
-    it "should count the total numver of downloads" do
+    it "counts the total numver of downloads" do
       expect(usage.total_downloads).to eq(12)
     end
 
-    it "should count the total numver of pageviews" do
+    it "counts the total numver of pageviews" do
       expect(usage.total_pageviews).to eq(30)
     end
 
-    it "should return an array of hashes for use with JQuery Flot" do
+    it "returns an array of hashes for use with JQuery Flot" do
       expect(usage.to_flot[0][:label]).to eq("Pageviews")
       expect(usage.to_flot[1][:label]).to eq("Downloads")
       expect(usage.to_flot[0][:data]).to include(*view_output)
@@ -113,27 +110,26 @@ describe FileUsage, :type => :model do
       end
 
       describe "create date before earliest date set" do
-        let(:usage) {
+        let(:usage) do
           allow_any_instance_of(GenericFile).to receive(:create_date).and_return(create_date.to_s)
           expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
           expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
-          FileUsage.new(file.id)
-        }
-        it "should set the created date to the earliest date not the created date" do
+          described_class.new(file.id)
+        end
+        it "sets the created date to the earliest date not the created date" do
           expect(usage.created).to eq(earliest)
         end
-
       end
 
       describe "create date after earliest" do
-        let(:usage) {
-          allow_any_instance_of(GenericFile).to receive(:create_date).and_return((Date.today-4.day).to_s)
+        let(:usage) do
+          allow_any_instance_of(GenericFile).to receive(:create_date).and_return((Date.today - 4.day).to_s)
           expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
           expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
           Sufia.config.analytic_start_date = earliest
-          FileUsage.new(file.id)
-        }
-        it "should set the created date to the earliest date not the created date" do
+          described_class.new(file.id)
+        end
+        it "sets the created date to the earliest date not the created date" do
           expect(usage.created).to eq(file.create_date)
         end
       end
@@ -143,20 +139,19 @@ describe FileUsage, :type => :model do
         Sufia.config.analytic_start_date = nil
       end
 
-      let(:usage) {
+      let(:usage) do
         allow_any_instance_of(GenericFile).to receive(:create_date).and_return(create_date.to_s)
         expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
         expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
-        FileUsage.new(file.id)
-      }
-      it "should set the created date to the earliest date not the created date" do
+        described_class.new(file.id)
+      end
+      it "sets the created date to the earliest date not the created date" do
         expect(usage.created).to eq(create_date)
       end
-
     end
   end
 
-  describe "on a migrated file" do 
+  describe "on a migrated file" do
     let(:date_uploaded) { "2014-12-31" }
 
     let(:file_migrated) do
@@ -167,15 +162,14 @@ describe FileUsage, :type => :model do
       end
     end
 
-    let(:usage) {
+    let(:usage) do
       expect(FileDownloadStat).to receive(:ga_statistics).and_return(sample_download_statistics)
       expect(FileViewStat).to receive(:ga_statistics).and_return(sample_pageview_statistics)
-      FileUsage.new(file_migrated.id)
-    }
+      described_class.new(file_migrated.id)
+    end
 
-    it "should use the date_uploaded for analytics" do
+    it "uses the date_uploaded for analytics" do
       expect(usage.created).to eq(date_uploaded)
     end
   end
-
 end