Merge pull request #274 from ifad/chore/specs

Modernize specs
ifad · Sep 14, 2024 · d8ac9f6 · d8ac9f6
2 parents 6d7cde3 + 7dc52bf
commit d8ac9f6
Show file tree

Hide file tree

Showing 24 changed files with 369 additions and 154 deletions.
diff --git a/.github/workflows/rubocop.yml b/.github/workflows/rubocop.yml
@@ -25,4 +25,5 @@ jobs:
     - name: RuboCop
       run: |
         gem install rubocop
+        gem install rubocop-rspec
         rubocop
diff --git a/.rspec b/.rspec
@@ -1 +1 @@
---format doc
+--require spec_helper
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,5 +1,8 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
@@ -30,6 +33,15 @@ Metrics/ModuleLength:
   Exclude:
     - 'spec/**/*'
 
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
 

diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
diff --git a/spec/heathen/convert_spec.rb b/spec/heathen/convert_spec.rb
@@ -15,10 +15,11 @@ def failing_step_1
   end
 end
 
-describe Heathen::Converter do
+RSpec.describe Heathen::Converter do
   before do
     Heathen::Task.clear 'test'
   end
+
   after do
     Heathen::Task.clear 'test'
   end

diff --git a/spec/heathen/filename_spec.rb b/spec/heathen/filename_spec.rb
@@ -1,10 +1,11 @@
 require 'spec_helper'
 require 'filemagic/ext'
 
-describe Heathen::Filename do
+RSpec.describe Heathen::Filename do
   let(:content) { 'The quick brown fox jumps over the lazy dog' }
   let(:mime_type) { content.mime_type }
-  context '.suggest' do
+
+  describe '.suggest' do
     it 'suggests foo.pdf' do
       expect(described_class.suggest('foo.pdf', mime_type)).to eq 'foo.txt'
     end
@@ -22,7 +23,7 @@
     end
   end
 
-  context '.suggest_in_new_dir' do
+  describe '.suggest_in_new_dir' do
     it 'suggests (short dir) -> (longer dir)' do
       expect(
         described_class.suggest_in_new_dir('/home/joe/src/foo.pdf', mime_type, '/home', '/opt/users')

diff --git a/spec/heathen/processor_methods/convert_image_spec.rb b/spec/heathen/processor_methods/convert_image_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:content) { File.read(fixture('heathen/quickfox.jpg')) }
   let(:job) { Heathen::Job.new 'foo', content, 'en' }
   let(:processor) { described_class.new job: job, logger: spec_logger }
@@ -9,7 +9,7 @@
     processor.clean_up
   end
 
-  context '#convert_image' do
+  describe '#convert_image' do
     it 'converts to tiff' do
       processor.convert_image to: :tiff, params: '-density 72'
       expect(job.content.mime_type).to eq 'image/tiff; charset=binary'

diff --git a/spec/heathen/processor_methods/htmltotext_spec.rb b/spec/heathen/processor_methods/htmltotext_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:content) { File.read(fixture('heathen/quickfox.html')) }
   let(:job) { Heathen::Job.new 'foo', content, 'en' }
   let(:processor) { described_class.new job: job, logger: Logger.new($stderr) }
@@ -9,7 +9,7 @@
     processor.clean_up
   end
 
-  context '#htmltotext' do
+  describe '#htmltotext' do
     it 'converts HTML to TXT' do
       processor.htmltotext
       expect(job.content.mime_type).to eq 'text/plain; charset=us-ascii'

diff --git a/spec/heathen/processor_methods/libreoffice_spec.rb b/spec/heathen/processor_methods/libreoffice_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:ms_word_content) { File.read(fixture('heathen/msword.docx')) }
   let(:ms_spreadsheet_content) { File.read(fixture('heathen/msexcel.xlsx')) }
   let(:ms_ppt_content) { File.read(fixture('heathen/mspowerpoint.pptx')) }
@@ -17,33 +17,38 @@ def new_job(content)
     @processor.clean_up
   end
 
-  context '#libreoffice' do
+  describe '#libreoffice' do
     context 'convert to PDF' do
       it 'from MS word' do
         new_job ms_word_content
         @processor.libreoffice format: 'pdf'
         expect(@job.content.mime_type).to eq 'application/pdf; charset=binary'
       end
+
       it 'from MS spreadsheet' do
         new_job ms_spreadsheet_content
         @processor.libreoffice format: 'pdf'
         expect(@job.content.mime_type).to eq 'application/pdf; charset=binary'
       end
+
       it 'from MS powerpoint' do
         new_job ms_ppt_content
         @processor.libreoffice format: 'pdf'
         expect(@job.content.mime_type).to eq 'application/pdf; charset=binary'
       end
+
       it 'from OO word' do
         new_job oo_word_content
         @processor.libreoffice format: 'pdf'
         expect(@job.content.mime_type).to eq 'application/pdf; charset=binary'
       end
+
       it 'from OO spreadsheet' do
         new_job oo_spreadsheet_content
         @processor.libreoffice format: 'pdf'
         expect(@job.content.mime_type).to eq 'application/pdf; charset=binary'
       end
+
       it 'from OO presentation' do
         new_job oo_presentation_content
         @processor.libreoffice format: 'pdf'
@@ -57,11 +62,13 @@ def new_job(content)
         @processor.libreoffice format: 'msoffice'
         expect(ms_word_mime_types).to include(@job.content.mime_type)
       end
+
       it 'from OO spreadsheet' do
         new_job oo_spreadsheet_content
         @processor.libreoffice format: 'msoffice'
         expect(ms_excel_mime_types).to include(@job.content.mime_type)
       end
+
       it 'from OO presentation' do
         new_job oo_presentation_content
         @processor.libreoffice format: 'msoffice'
@@ -75,11 +82,13 @@ def new_job(content)
         @processor.libreoffice format: 'ooffice'
         expect(oo_odt_mime_types).to include(@job.content.mime_type)
       end
+
       it 'from MS spreadsheet' do
         new_job ms_spreadsheet_content
         @processor.libreoffice format: 'ooffice'
         expect(oo_ods_mime_types).to include(@job.content.mime_type)
       end
+
       it 'from MS powerpoint' do
         new_job ms_ppt_content
         @processor.libreoffice format: 'ooffice'
@@ -93,6 +102,7 @@ def new_job(content)
         @processor.libreoffice format: 'txt'
         expect(@job.content.mime_type).to eq 'text/plain; charset=us-ascii'
       end
+
       it 'from OO word' do
         new_job oo_word_content
         @processor.libreoffice format: 'txt'

diff --git a/spec/heathen/processor_methods/pdftotext_spec.rb b/spec/heathen/processor_methods/pdftotext_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:content) { File.read(fixture('heathen/quickfox.pdf')) }
   let(:job) { Heathen::Job.new 'foo', content, 'en' }
   let(:processor) { described_class.new job: job, logger: Logger.new($stderr) }
@@ -9,7 +9,7 @@
     processor.clean_up
   end
 
-  context '#pdftotext' do
+  describe '#pdftotext' do
     it 'converts PDF to TXT' do
       processor.pdftotext
       expect(job.content.mime_type).to eq 'text/plain; charset=us-ascii'

diff --git a/spec/heathen/processor_methods/tesseract_spec.rb b/spec/heathen/processor_methods/tesseract_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:content) { File.read(fixture('heathen/quickfox.tiff')) }
   let(:job) { Heathen::Job.new 'foo', content, 'en' }
   let(:processor) { described_class.new job: job, logger: spec_logger }
@@ -9,15 +9,17 @@
     processor.clean_up
   end
 
-  context '#tesseract' do
+  describe '#tesseract' do
     it 'converts a tiff to text' do
       processor.tesseract format: nil
       expect(job.content.mime_type).to eq 'text/plain; charset=us-ascii'
     end
+
     it 'converts a tiff to PDF' do
       processor.tesseract format: 'pdf'
       expect(job.content.mime_type).to eq 'application/pdf; charset=binary'
     end
+
     it 'converts a tiff to HOCR' do
       processor.tesseract format: 'hocr'
       expect(tesseract_hocr_mime_types).to include(job.content.mime_type)

diff --git a/spec/heathen/processor_methods/wkhtmltopdf_spec.rb b/spec/heathen/processor_methods/wkhtmltopdf_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Heathen::Processor do
+RSpec.describe Heathen::Processor do
   let(:content) { File.read(fixture('heathen/quickfox.html')) }
   let(:job) { Heathen::Job.new 'foo', content, 'en' }
   let(:processor) { described_class.new job: job, logger: spec_logger }
@@ -9,7 +9,7 @@
     processor.clean_up
   end
 
-  context '#wkhtmltopdf' do
+  describe '#wkhtmltopdf' do
     it 'converts HTML to PDF' do
       processor.wkhtmltopdf
       expect(job.content.mime_type).to eq 'application/pdf; charset=binary'

diff --git a/spec/integration/standard_tasks_spec.rb b/spec/integration/standard_tasks_spec.rb
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Standard Heathen tasks:' do
+RSpec.describe 'Standard Heathen tasks:' do
   before do
     setup_storage
     allow(Colore::C_).to receive(:storage_directory) { tmp_storage_dir }