Transition to rspec from TestUnit

Author: chrahunt

.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

Rakefile

@@ -1,15 +1,11 @@
 require 'rake'
-require 'rake/testtask'
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/test_*.rb'
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new('spec')
 
 desc 'Run tests.'
-task default: :test
+task default: :spec
 
 desc "Open an irb session preloaded with this library."
 task :console do

docx.gemspec

@@ -13,4 +13,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'nokogiri', '~> 1.5'
   s.add_dependency 'rubyzip',  '~> 0.9'
+
+  s.add_development_dependency 'rspec'
 end

spec/docx/document_spec.rb

@@ -0,0 +1,210 @@
+require 'docx'
+require 'tempfile'
+
+describe Docx::Document do
+  before(:all) do
+    @fixtures_path = "spec/fixtures"
+  end
+
+  describe 'reading' do
+    before do
+      @doc = Docx::Document.open(@fixtures_path + '/basic.docx')
+    end
+
+    it 'should read the document' do
+      @doc.paragraphs.size.should eq 2
+      @doc.paragraphs.first.text.should eq 'hello'
+      @doc.paragraphs.last.text.should eq 'world'
+      @doc.text.should eq "hello\nworld"
+    end
+
+    it 'should read bookmarks' do
+      @doc.bookmarks.size.should eq 1
+      @doc.bookmarks['test_bookmark'].should_not be_nil
+    end
+
+    it 'should have paragraphs' do
+      @doc.each_paragraph do |p|
+        expect(p).to be_an_instance_of(Docx::Elements::Containers::Paragraph)
+      end
+    end
+
+    it 'should have properly formatted text runs' do
+      @doc.each_paragraph do |p|
+        p.each_text_run do |tr|
+          expect(tr).to be_an_instance_of(Docx::Elements::Containers::TextRun)
+          tr.formatting.should eq Docx::Elements::Containers::TextRun::DEFAULT_FORMATTING
+        end
+      end
+    end
+  end
+
+  describe 'editing'  do
+    before do
+      @doc = Docx::Document.open(@fixtures_path + '/editing.docx')
+    end
+
+    it 'should copy paragraphs' do
+      old_p = @doc.paragraphs.first
+      new_p = old_p.copy
+      expect(new_p).to be_an_instance_of(Docx::Elements::Containers::Paragraph)
+      new_p.should_not be_nil
+      new_p.should_not eq(old_p)
+    end
+
+    it 'allows insertion of text' do
+      @doc.paragraphs.size.should eq 3
+      first_p = @doc.paragraphs.first
+      new_p = first_p.copy
+      new_p.insert_after first_p
+      @doc.paragraphs.size.should eq 4
+    end
+
+    it 'should change text' do
+      @doc.paragraphs.first.text.should eq 'test text'
+      @doc.paragraphs.first.text = 'the real test'
+      @doc.paragraphs.first.text.should eq 'the real test'
+    end
+
+    it 'should allow insertion of text before a bookmark' do
+      @doc.paragraphs.first.text.should eq 'test text'
+      @doc.bookmarks['beginning_bookmark'].insert_text_before('foo')
+      @doc.paragraphs.first.text.should eq 'footest text'
+    end
+
+    it 'should allow insertion of text after a bookmark' do
+      @doc.paragraphs.first.text.should eq 'test text'
+      @doc.bookmarks['end_bookmark'].insert_text_after('bar')
+      @doc.paragraphs.first.text.should eq 'test textbar'
+    end
+
+    it 'should allow multiple lines of text to be inserted at a bookmark' do
+      @doc.paragraphs.last.text.should eq ''
+      new_lines = ['replacement test', 'second paragraph test', 'and a third paragraph test']
+      @doc.bookmarks['isolated_bookmark'].insert_multiple_lines(new_lines)
+      new_lines.each_index do |line|
+        @doc.paragraphs[line + 2].text.should eq new_lines[line]
+      end
+    end
+
+    it 'should allow multi-line insertion with replacement' do
+      @doc.paragraphs[1].text.should eq 'placeholder text'
+      new_lines = ['replacement test', 'second paragraph test', 'and a third paragraph test']
+      @doc.bookmarks['word_splitting_bookmark'].insert_multiple_lines(new_lines)
+      new_lines.each_index do |line|
+        @doc.paragraphs[line + 1].text.should eq new_lines[line]
+      end
+    end
+
+    it 'should allow content deletion' do
+      @doc.paragraphs.first.text.should eq 'test text'
+      @doc.paragraphs.first.blank!
+      @doc.paragraphs.first.text.should eq ''
+    end
+  end
+
+  describe 'read formatting' do
+    before do
+      @doc = Docx::Document.open(@fixtures_path + '/formatting.docx')
+      @formatting = @doc.paragraphs.map { |p| p.text_runs.map(&:formatting) }
+      @default_formatting = Docx::Elements::Containers::TextRun::DEFAULT_FORMATTING
+      @only_italic = @default_formatting.merge italic: true
+      @only_bold = @default_formatting.merge bold: true
+      @only_underline = @default_formatting.merge underline: true
+      @all_formatted = @default_formatting.merge italic: true, bold: true, underline: true
+    end
+
+    it 'should have the correct text' do
+      @doc.paragraphs.size.should eq 6
+      @doc.paragraphs[0].text.should eq 'Normal'
+      @doc.paragraphs[1].text.should eq 'Italic'
+      @doc.paragraphs[2].text.should eq 'Bold'
+      @doc.paragraphs[3].text.should eq 'Underline'
+      @doc.paragraphs[4].text.should eq 'Normal'
+      @doc.paragraphs[5].text.should eq 'This is a sentence with all formatting options in the middle of the sentence.'
+    end
+
+    it 'should contain a paragraph with multiple text runs' do
+
+    end
+
+    it 'should detect normal formatting' do
+      [0, 4].each do |i|
+        @formatting[i][0].should eq @default_formatting
+        @doc.paragraphs[i].text_runs[0].italicized?.should be_false
+        @doc.paragraphs[i].text_runs[0].bolded?.should be_false
+        @doc.paragraphs[i].text_runs[0].underlined?.should be_false
+      end
+    end
+
+    it 'should detect italic formatting' do
+      @formatting[1][0].should eq @only_italic
+      @doc.paragraphs[1].text_runs[0].italicized?.should be_true
+      @doc.paragraphs[1].text_runs[0].bolded?.should be_false
+      @doc.paragraphs[1].text_runs[0].underlined?.should be_false
+    end
+
+    it 'should detect bold formatting' do
+      @formatting[2][0].should eq @only_bold
+      @doc.paragraphs[2].text_runs[0].italicized?.should be_false
+      @doc.paragraphs[2].text_runs[0].bolded?.should be_true
+      @doc.paragraphs[2].text_runs[0].underlined?.should be_false
+    end
+
+    it 'should detect underline formatting' do
+      @formatting[3][0].should eq @only_underline
+      @doc.paragraphs[3].text_runs[0].italicized?.should be_false
+      @doc.paragraphs[3].text_runs[0].bolded?.should be_false
+      @doc.paragraphs[3].text_runs[0].underlined?.should be_true
+    end
+
+    it 'should detect mixed formatting' do
+      @formatting[5][0].should eq @default_formatting
+      @doc.paragraphs[5].text_runs[0].italicized?.should be_false
+      @doc.paragraphs[5].text_runs[0].bolded?.should be_false
+      @doc.paragraphs[5].text_runs[0].underlined?.should be_false
+      
+      @formatting[5][1].should eq @all_formatted
+      @doc.paragraphs[5].text_runs[1].italicized?.should be_true
+      @doc.paragraphs[5].text_runs[1].bolded?.should be_true
+      @doc.paragraphs[5].text_runs[1].underlined?.should be_true
+      
+      @formatting[5][2].should eq @default_formatting
+      @doc.paragraphs[5].text_runs[2].italicized?.should be_false
+      @doc.paragraphs[5].text_runs[2].bolded?.should be_false
+      @doc.paragraphs[5].text_runs[2].underlined?.should be_false
+    end
+  end
+
+  describe 'saving' do
+    before do
+      @doc = Docx::Document.open(@fixtures_path + '/saving.docx')
+    end
+
+    it 'should save to a normal file path' do
+      @new_doc_path = @fixtures_path + '/new_save.docx'
+      @doc.save(@new_doc_path)
+      @new_doc = Docx::Document.open(@new_doc_path)
+      @new_doc.paragraphs.size.should eq @doc.paragraphs.size
+    end
+
+    it 'should save to a tempfile' do
+      temp_file = Tempfile.new(['docx_gem', '.docx'])
+      @new_doc_path = temp_file.path
+      @doc.save(@new_doc_path)
+      @new_doc = Docx::Document.open(@new_doc_path)
+      @new_doc.paragraphs.size.should eq @doc.paragraphs.size
+
+      temp_file.close
+      temp_file.unlink
+      # ensure temp file has been removed
+      File.exists?(@new_doc_path).should be_false
+    end
+
+    after do
+      if File.exists?(@new_doc_path)
+        File.delete(@new_doc_path)
+      end
+    end
+  end
+end

test/fixtures/basic.docx spec/fixtures/basic.docxtest/fixtures/basic.docx renamed to spec/fixtures/basic.docx

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end