lovely_rufus 0.2.1 → 0.3.0

data/lovely_rufus.gemspec

@@ -7,17 +7,19 @@ Gem::Specification.new do |gem|
   gem.license     = 'AGPL-3.0'
   gem.name        = 'lovely_rufus'
   gem.summary     = 'lovely_rufus: text wrapper'
-  gem.version     = '0.2.1'
+  gem.version     = '0.3.0'
 
   gem.files       = `git ls-files -z`.split("\0")
   gem.executables = gem.files.grep(/^bin\//).map { |path| File.basename(path) }
-  gem.test_files  = gem.files.grep(/^spec\/.*\.rb$/)
+  gem.test_files  = gem.files.grep(/^test\/.*\.rb$/)
+
+  gem.add_dependency 'private_attr', '~> 1.0'
 
   gem.add_development_dependency 'bogus',          '~> 0.1.4'
   gem.add_development_dependency 'minitest',       '~> 5.0'
   gem.add_development_dependency 'minitest-focus', '~> 1.1'
   gem.add_development_dependency 'rake',           '~> 10.1'
-  gem.add_development_dependency 'reek',           '~> 1.3'
+  gem.add_development_dependency 'reek',           '~> 2.0'
   gem.add_development_dependency 'rerun',          '~> 0.10.0'
-  gem.add_development_dependency 'rubocop',        '~> 0.27.0'
+  gem.add_development_dependency 'rubocop',        '~> 0.29.0'
 end

data/{spec/lovely_rufus/cli_wrapper_spec.rb → test/lovely_rufus/cli_wrapper_test.rb}

@@ -1,23 +1,23 @@
 require 'stringio'
-require_relative '../spec_helper'
+require_relative '../test_helper'
 require_relative '../../lib/lovely_rufus/cli_wrapper'
 
 module LovelyRufus
   describe CLIWrapper do
     describe '#run' do
-      let(:text) { "all right: stop, collaborate and listen\n" }
-      let(:text_wrapper) { fake(:text_wrapper, as: :class) }
+      let(:stream)       { StringIO.new(text)                          }
+      let(:text)         { "all right: stop, collaborate and listen\n" }
+      let(:text_wrapper) { fake(:text_wrapper, as: :class)             }
 
       it 'reads the passed stream to TextWrapper and prints the results' do
         stub(text_wrapper).wrap(text, width: 72) { text }
         lambda do
-          CLIWrapper.new(text_wrapper: text_wrapper).run StringIO.new(text)
+          CLIWrapper.new(text_wrapper: text_wrapper).run stream
         end.must_output text
       end
 
       it 'accepts the desired width and passes it to TextWrapper' do
         capture_io do
-          stream = StringIO.new(text)
           CLIWrapper.new(%w(--width=22), text_wrapper: text_wrapper).run stream
         end
         text_wrapper.must_have_received :wrap, [text, { width: 22 }]

data/test/lovely_rufus/layers/basic_wrapper_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/lovely_rufus/layers/basic_wrapper'
+require_relative '../../../lib/lovely_rufus/wrap'
+
+module LovelyRufus
+  module Layers
+    describe BasicWrapper do
+      describe '#call' do
+        it 'wraps text to the given width' do
+          text = 'I go crazy when I hear a cymbal and a hi-hat ' \
+            'with a souped-up tempo'
+          wrap = <<-end.dedent
+            I go crazy when I hear
+            a cymbal and a hi-hat
+            with a souped-up tempo
+          end
+          bw = BasicWrapper.new
+          bw.call(Wrap[text, width: 22]).must_equal Wrap[wrap, width: 22]
+        end
+
+        it 'extends past the given width when necessary' do
+          text = 'I’m killing your brain like a poisonous mushroom'
+          wrap = <<-end.dedent
+            I’m
+            killing
+            your
+            brain
+            like
+            a
+            poisonous
+            mushroom
+          end
+          bw = BasicWrapper.new
+          bw.call(Wrap[text, width: 5]).must_equal Wrap[wrap, width: 5]
+        end
+
+        it 'rewraps a String from zero' do
+          text = <<-end.dedent
+            turn off
+            the lights and I’ll glow
+          end
+          wrap = "turn off the lights and I’ll glow\n"
+          BasicWrapper.new.call(Wrap[text]).must_equal Wrap[wrap]
+        end
+
+        it 'passes the fixed text to the next layer and returns its outcome' do
+          final = fake(:wrap)
+          layer = fake(:layer)
+          mock(layer).call(Wrap["I\nO\nU\n", width: 2]) { final }
+          BasicWrapper.new(layer).call(Wrap['I O U', width: 2]).must_equal final
+        end
+      end
+    end
+  end
+end

data/test/lovely_rufus/layers/code_comment_stripper_test.rb

@@ -0,0 +1,90 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/lovely_rufus/layers/code_comment_stripper'
+require_relative '../../../lib/lovely_rufus/wrap'
+
+module LovelyRufus
+  module Layers
+    describe CodeCommentStripper do
+      describe '#call' do
+        it 'strips comments and adjusts width before calling the next layer' do
+          commented = <<-end.dedent
+            # to the extreme I rock a mic like a vandal
+            # light up a stage and wax a chump like a candle
+          end
+          uncommented = <<-end.dedent
+            to the extreme I rock a mic like a vandal
+            light up a stage and wax a chump like a candle
+          end
+          CodeCommentStripper.must_pass_to_next Wrap[commented,   width: 72],
+                                                Wrap[uncommented, width: 70]
+        end
+
+        it 'adds comments back in (and adjusts width) before returning' do
+          text = <<-end.dedent
+            # take heed, ’cause I’m a lyrical poet
+            # Miami’s on the scene just in case you didn’t know it
+          end
+          commented = Wrap[text, width: 72]
+          CodeCommentStripper.new.call(commented).must_equal commented
+        end
+
+        it 'does not touch non-commented texts' do
+          text = <<-end.dedent
+            my town, that created all the bass sound
+            enough to shake and kick holes in the ground
+          end
+          uncommented = Wrap[text, width: 72]
+          CodeCommentStripper.new.call(uncommented).must_equal uncommented
+        end
+
+        it 'does not alter text contents' do
+          wrap = Wrap['# Ice # Ice # Baby']
+          CodeCommentStripper.new.call(wrap).must_equal wrap
+        end
+
+        it 'strips // code comments' do
+          commented = <<-end.dedent
+            // so fast other DJs say ‘damn!’
+            // if my rhyme was a drug I’d sell it by the gram
+          end
+          uncommented = <<-end.dedent
+            so fast other DJs say ‘damn!’
+            if my rhyme was a drug I’d sell it by the gram
+          end
+          CodeCommentStripper.must_pass_to_next Wrap[commented,   width: 72],
+                                                Wrap[uncommented, width: 69]
+        end
+
+        it 'only considers homogenous characters as comments' do
+          commented = <<-end.dedent
+            # /if there was a problem,
+            # yo – I’ll solve it!/
+          end
+          uncommented = <<-end.dedent
+            /if there was a problem,
+            yo – I’ll solve it!/
+          end
+          CodeCommentStripper.must_pass_to_next Wrap[commented,   width: 72],
+                                                Wrap[uncommented, width: 70]
+        end
+
+        it 'strips initial space indentation' do
+          indented = Wrap['  // check out the hook', width: 72]
+          passed   = Wrap['check out the hook',      width: 67]
+          CodeCommentStripper.must_pass_to_next indented, passed
+        end
+
+        it 'strips initial tab indentation' do
+          indented = Wrap["\t# while my DJ revolves it", width: 72]
+          stripped = Wrap['while my DJ revolves it',     width: 69]
+          CodeCommentStripper.must_pass_to_next indented, stripped
+        end
+
+        it 'pays proper homage to K&R' do
+          not_commented = Wrap['#define ASSERT(msg, cond) // TODO']
+          CodeCommentStripper.must_pass_to_next not_commented, not_commented
+        end
+      end
+    end
+  end
+end

data/test/lovely_rufus/layers/email_quote_stripper_test.rb

@@ -0,0 +1,101 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/lovely_rufus/layers/email_quote_stripper'
+require_relative '../../../lib/lovely_rufus/wrap'
+
+module LovelyRufus
+  module Layers
+    describe EmailQuoteStripper do
+      describe '#call' do
+        it 'strips quotes and adjusts width before calling the next layer' do
+          quoted = <<-end.dedent
+            > to the extreme I rock a mic like a vandal
+            > light up a stage and wax a chump like a candle
+          end
+          unquoted = <<-end.dedent
+            to the extreme I rock a mic like a vandal
+            light up a stage and wax a chump like a candle
+          end
+          EmailQuoteStripper.must_pass_to_next Wrap[quoted,   width: 72],
+                                               Wrap[unquoted, width: 70]
+        end
+
+        it 'adds quotes back in (and adjusts width) before returning' do
+          quoted = <<-end.dedent
+            > take heed, ’cause I’m a lyrical poet
+            > Miami’s on the scene just in case you didn’t know it
+          end
+          wrap = Wrap[quoted, width: 72]
+          EmailQuoteStripper.new.call(wrap).must_equal wrap
+        end
+
+        it 'does not touch non-quoted texts' do
+          plain = <<-end.dedent
+            my town, that created all the bass sound
+            enough to shake and kick holes in the ground
+          end
+          wrap = Wrap[plain, width: 72]
+          EmailQuoteStripper.new.call(wrap).must_equal wrap
+        end
+
+        it 'does not alter text contents' do
+          wrap = Wrap['> Ice > Ice > Baby']
+          EmailQuoteStripper.new.call(wrap).must_equal wrap
+        end
+
+        it 'strips multilevel quotes' do
+          quoted = <<-end.dedent
+            >> ’cause my style’s like a chemical spill
+            >> feasible rhymes that you can vision and feel
+          end
+          unquoted = <<-end.dedent
+            ’cause my style’s like a chemical spill
+            feasible rhymes that you can vision and feel
+          end
+          EmailQuoteStripper.must_pass_to_next Wrap[quoted,   width: 72],
+                                               Wrap[unquoted, width: 69]
+        end
+
+        it 'strips broken quotes properly' do
+          quoted = <<-end.dedent
+            > > >conducted and formed this is a hell of a concept
+            > > >we make it hype and you want to step with this
+          end
+          unquoted = <<-end.dedent
+            conducted and formed this is a hell of a concept
+            we make it hype and you want to step with this
+          end
+          EmailQuoteStripper.must_pass_to_next Wrap[quoted,   width: 72],
+                                               Wrap[unquoted, width: 68]
+        end
+
+        it 'fixes broken quotes when adding them back in' do
+          quoted = <<-end.dedent
+            > > >Shay plays on the fade,
+            > > >slice like a ninja
+            > > >cut like a razor blade
+          end
+          fixed = <<-end.dedent
+            >>> Shay plays on the fade,
+            >>> slice like a ninja
+            >>> cut like a razor blade
+          end
+          wrap = Wrap[quoted, width: 72]
+          EmailQuoteStripper.new.call(wrap).must_equal Wrap[fixed, width: 72]
+        end
+
+        it 'only considers homogenous characters as comments' do
+          quoted = <<-end.dedent
+            > /if there was a problem,
+            > yo – I’ll solve it!/
+          end
+          unquoted = <<-end.dedent
+            /if there was a problem,
+            yo – I’ll solve it!/
+          end
+          EmailQuoteStripper.must_pass_to_next Wrap[quoted,   width: 72],
+                                               Wrap[unquoted, width: 70]
+        end
+      end
+    end
+  end
+end

data/test/lovely_rufus/layers/hangout_wrapper_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/lovely_rufus/layers/hangout_wrapper'
+require_relative '../../../lib/lovely_rufus/wrap'
+
+module LovelyRufus
+  module Layers
+    describe HangoutWrapper do
+      describe '#call' do
+        it 'removes hangouts from the text' do
+          text = <<-end.dedent
+            I go crazy when I hear a cymbal and
+            a hi-hat with a souped-up tempo
+          end
+          wrap = <<-end.dedent
+            I go crazy when I hear a cymbal
+            and a hi-hat with a souped-up tempo
+          end
+          hw = HangoutWrapper.new
+          hw.call(Wrap[text, width: 35]).must_equal Wrap[wrap, width: 35]
+        end
+
+        it 'passes the fixed text to the next layer and returns its outcome' do
+          final = fake(:wrap)
+          layer = fake(:layer)
+          mock(layer).call(any(Wrap)) { final }
+          wrapped = HangoutWrapper.new(layer).call(Wrap["I O\nU", width: 4])
+          wrapped.must_equal final
+        end
+
+        it 'doesn’t let the last line to hang out' do
+          text = <<-end.dedent
+            Just found out the Finnish term for grammar Nazi is pilkunnussija.
+            Direct translation: comma fucker. You’re welcome.
+          end
+          HangoutWrapper.new.call(Wrap[text, width: 76]).text.must_equal text
+        end
+      end
+    end
+  end
+end

data/test/lovely_rufus/layers/one_letter_gluer_test.rb

@@ -0,0 +1,33 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/lovely_rufus/layers/one_letter_gluer'
+require_relative '../../../lib/lovely_rufus/wrap'
+
+module LovelyRufus
+  module Layers
+    describe OneLetterGluer do
+      describe '#call' do
+        it 'replaces spaces after one-letter words with non-break spaces' do
+          text = 'I go crazy when I hear a cymbal and a hi-hat'
+          glue = 'I go crazy when I hear a cymbal and a hi-hat'
+          olg  = OneLetterGluer.new
+          olg.call(Wrap[text, width: 42]).must_equal Wrap[glue, width: 42]
+        end
+
+        it 'glues subsequent one-letter words' do
+          text = 'one-letter words in English: a, I & o'
+          glue = 'one-letter words in English: a, I & o'
+          olg  = OneLetterGluer.new
+          olg.call(Wrap[text, width: 42]).must_equal Wrap[glue, width: 42]
+        end
+
+        it 'passes the fixed text to the next layer and returns its outcome' do
+          final = fake(:wrap)
+          layer = fake(:layer)
+          mock(layer).call(Wrap['I O U', width: 69]) { final }
+          glued = OneLetterGluer.new(layer).call(Wrap['I O U', width: 69])
+          glued.must_equal final
+        end
+      end
+    end
+  end
+end

data/{spec/lovely_rufus/settings_spec.rb → test/lovely_rufus/settings_test.rb}

@@ -1,4 +1,4 @@
-require_relative '../spec_helper'
+require_relative '../test_helper'
 require_relative '../../lib/lovely_rufus/settings'
 
 module LovelyRufus

data/{spec/lovely_rufus/text_wrapper_spec.rb → test/lovely_rufus/text_wrapper_test.rb}

@@ -1,5 +1,5 @@
 require 'yaml'
-require_relative '../spec_helper'
+require_relative '../test_helper'
 require_relative '../../lib/lovely_rufus/text_wrapper'
 
 module LovelyRufus
@@ -41,7 +41,7 @@ module LovelyRufus
       end
 
       it 'supports all the example use-cases' do
-        path = File.expand_path('text_wrapper_spec.yml', __dir__)
+        path = File.expand_path('text_wrapper_test.yml', __dir__)
         YAML.load_file(path).each do |spec|
           width = spec.fetch('width') { 72 }
           wrap  = "#{spec['output']}\n"

data/{spec/lovely_rufus/wrap_spec.rb → test/lovely_rufus/wrap_test.rb}

@@ -1,16 +1,16 @@
-require_relative '../spec_helper'
+require_relative '../test_helper'
 require_relative '../../lib/lovely_rufus/wrap'
 
 module LovelyRufus
   describe Wrap do
     describe '.[]' do
       it 'creates a Wrap with the given text and target width' do
-        Wrap['Ice Ice Baby', width: 7].text.must_equal  'Ice Ice Baby'
+        Wrap['Ice Ice Baby', width: 7].text.must_equal 'Ice Ice Baby'
         Wrap['Ice Ice Baby', width: 7].width.must_equal 7
       end
 
       it 'defaults to empty text and width of 72' do
-        Wrap[].text.must_equal  ''
+        Wrap[].text.must_equal ''
         Wrap[].width.must_equal 72
       end
     end

data/{spec/lovely_rufus_spec.rb → test/lovely_rufus_test.rb}

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require_relative 'test_helper'
 require_relative '../lib/lovely_rufus'
 
 describe LovelyRufus do

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/focus'
+require 'minitest/pride'
+require 'bogus/minitest/spec'
+require 'lovely_rufus'
+require_relative '../lib/lovely_rufus/layers/layer'
+require_relative '../lib/lovely_rufus/wrap'
+
+Bogus.configure do |config|
+  config.search_modules << LovelyRufus
+  config.search_modules << LovelyRufus::Layers
+end
+
+class String
+  def dedent
+    gsub(/^#{scan(/^ +/).min}/, '')
+  end
+end
+
+module CustomAssertions
+  def assert_passes_to_next(subject, called_with, to_be_passed)
+    next_layer = fake(:layer, call: LovelyRufus::Wrap.new)
+    subject.new(next_layer).call called_with
+    assert_received next_layer, :call, [to_be_passed]
+  end
+end
+
+Minitest::Test.include CustomAssertions
+
+module Minitest
+  module Expectations
+    class << LovelyRufus::Layers::Layer
+      infect_an_assertion :assert_passes_to_next, :must_pass_to_next, true
+    end
+  end
+end