lovely_rufus 0.1.0

data/README.md

@@ -0,0 +1,67 @@
+Lovely Rufus
+============
+
+Lovely Rufus is an executable and a Ruby library for wrapping paragraphs of text in the spirit of [Par](http://www.nicemice.net/par/).
+
+
+
+Usage
+-----
+
+Lovely Rufus can be used from the command-line by piping text through the `lovely-rufus` executable:
+
+    $ echo 'The Ballyshannon foundered off the coast of Cariboo, And down in fathoms many went the captain and the crew;' | lovely-rufus
+    The Ballyshannon foundered off the coast of Cariboo,
+    And down in fathoms many went the captain and the crew;
+
+Lovely Rufus can also be used from Ruby code through the `TextWrapper` class:
+
+    $ irb
+    >> require 'lovely_rufus'
+    >> text = 'The Ballyshannon foundered off the coast of Cariboo, And down in fathoms many went the captain and the crew;'
+    >> puts LovelyRufus::TextWrapper.wrap text
+    The Ballyshannon foundered off the coast of Cariboo,
+    And down in fathoms many went the captain and the crew;
+
+Note that `TextWrapper.wrap` can take optional desired width:
+
+    $ irb
+    >> require 'lovely_rufus'
+    >> text = 'The Ballyshannon foundered off the coast of Cariboo, And down in fathoms many went the captain and the crew;'
+    >> puts LovelyRufus::TextWrapper.wrap text, width: 15
+    The
+    Ballyshannon
+    foundered off
+    the coast of
+    Cariboo, And
+    down in fathoms
+    many went the
+    captain and
+    the crew;
+
+
+
+Features
+--------
+
+Currently, Lovely Rufus sports the following features:
+
+* paragraphs are wrapped to the specified width,
+* one-letter words are not left at ends of lines,
+* email quotes (`>`) are handled properly and normalised (`> > >` → `>>>`),
+* email-quoted paragraph breaks are cleared,
+* code comments (starting with `#` and `//`) are handled properly,
+* multiple paragraphs are wrapped independently.
+
+
+
+Name and history
+----------------
+
+Lovely Rufus was created as a [Ruby Mendicant University](http://blog.majesticseacreature.com/tag/rubymendicant) project and is named after [a certain _Love Actually_ character](http://en.wikipedia.org/wiki/Love_Actually#Rufus) who’s [exceptionally good at wrapping](http://www.youtube.com/watch?v=W6E1wPwOaE4).
+
+
+
+---
+
+© MMX-MMXIV Piotr Szotkowski <chastell@chastell.net>, licensed under AGPL-3.0 (see LICENCE)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/testtask'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+
+task default: %i[spec rubocop reek]
+
+Rake::TestTask.new :spec do |task|
+  task.test_files = FileList['spec/**/*_spec.rb']
+  task.warning    = true
+end
+
+Reek::Rake::Task.new do |task|
+  task.config_files  = 'config/reek.yml'
+  task.fail_on_error = false
+  task.reek_opts     = '--quiet'
+end
+
+Rubocop::RakeTask.new

data/bin/lovely-rufus

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/lovely_rufus'
+LovelyRufus::CLIWrapper.new.run

data/config/reek.yml

@@ -0,0 +1,14 @@
+IrresponsibleModule:
+  enabled: false
+
+NestedIterators:
+  max_allowed_nesting: 2
+
+UncommunicativeVariableName:
+  exclude:
+  - LovelyRufus::HangoutWrapper#hangout_line
+
+UnusedParameters:
+  exclude:
+  - LovelyRufus::Layer#call
+  - LovelyRufus::OneLetterGluer#call

data/lib/lovely_rufus/basic_wrapper.rb

@@ -0,0 +1,17 @@
+module LovelyRufus class BasicWrapper < Layer
+  def call wrap
+    @wrap   = wrap
+    wrapped = chopped.gsub(/(.{1,#{wrap.width}})( |$\n?)/, "\\1\n")
+    next_layer.call Wrap[wrapped, width: wrap.width]
+  end
+
+  attr_reader :wrap
+  private     :wrap
+
+  private
+
+  def chopped
+    words = wrap.text.split
+    words.map { |word| word.gsub(/(.{1,#{wrap.width}})/, '\\1 ') }.join.chop
+  end
+end end

data/lib/lovely_rufus/cli_wrapper.rb

@@ -0,0 +1,30 @@
+require 'optparse'
+
+module LovelyRufus class CLIWrapper
+  def initialize args = ARGV, text_wrapper: TextWrapper
+    @settings     = Settings.new args
+    @text_wrapper = text_wrapper
+  end
+
+  def run stream = $stdin
+    puts text_wrapper.wrap stream.read, width: settings.width
+  end
+
+  attr_reader :settings, :text_wrapper
+  private     :settings, :text_wrapper
+
+  private
+
+  class Settings
+    attr_reader :width
+
+    def initialize args
+      @width = 72
+      OptionParser.new do |opts|
+        opts.on '-w', '--width WIDTH', Integer, 'Wrapping width' do |width|
+          @width = width
+        end
+      end.parse! args
+    end
+  end
+end end

data/lib/lovely_rufus/hangout_wrapper.rb

@@ -0,0 +1,32 @@
+module LovelyRufus class HangoutWrapper < Layer
+  def call wrap
+    @wrap  = wrap
+    final  = hangout_line ? rewrapped : wrap.text
+    next_layer.call Wrap[final, width: wrap.width]
+  end
+
+  attr_reader :wrap
+  private     :wrap
+
+  private
+
+  def hangout_line
+    lines.each_cons 2 do |a, b|
+      return a if a[/\p{space}/] and a.rindex(/\p{space}/) >= b.size
+      unless b == lines.last
+        return b if b[/\p{space}/] and b.rindex(/\p{space}/) >= a.size
+      end
+    end
+  end
+
+  def lines
+    @lines ||= wrap.text.lines.map(&:chomp)
+  end
+
+  def rewrapped
+    hangout_line << NBSP
+    unfolded = lines.join(' ').gsub("#{NBSP} ", NBSP)
+    wrapped  = BasicWrapper.new.call(Wrap[unfolded, width: wrap.width]).text
+    HangoutWrapper.new.call(Wrap[wrapped, width: wrap.width]).text
+  end
+end end

data/lib/lovely_rufus/layer.rb

@@ -0,0 +1,12 @@
+module LovelyRufus class Layer
+  def initialize next_layer = -> wrap { wrap }
+    @next_layer = next_layer
+  end
+
+  def call opts = {}
+    fail 'Layer subclasses must define #call'
+  end
+
+  attr_reader :next_layer
+  private     :next_layer
+end end

data/lib/lovely_rufus/one_letter_gluer.rb

@@ -0,0 +1,7 @@
+module LovelyRufus class OneLetterGluer < Layer
+  def call wrap
+    pattern = /(?<=\p{space})(&|\p{letter})\p{space}/
+    text    = wrap.text.gsub pattern, "\\1\\2#{NBSP}"
+    next_layer.call Wrap[text, width: wrap.width]
+  end
+end end

data/lib/lovely_rufus/quote_stripper.rb

@@ -0,0 +1,27 @@
+module LovelyRufus class QuoteStripper < Layer
+  def call wrap
+    @wrap   = wrap
+    wrapped = next_layer.call stripped_wrap
+    quoted  = wrapped.text.lines.map { |line| fixed_quote + line }.join
+    Wrap[quoted, width: wrapped.width + fixed_quote.size]
+  end
+
+  attr_reader :wrap
+  private     :wrap
+
+  private
+
+  def fixed_quote
+    quote.size > 0 ? quote.delete(' ') + ' ' : ''
+  end
+
+  def quote
+    starts = wrap.text.lines.map { |line| line[/^#{QUOTES}/] }.uniq
+    starts.size == 1 ? starts.first || '' : ''
+  end
+
+  def stripped_wrap
+    stripped_text = wrap.text.lines.map { |line| line[quote.size..-1] }.join
+    Wrap[stripped_text, width: wrap.width - fixed_quote.size]
+  end
+end end

data/lib/lovely_rufus/text_wrapper.rb

@@ -0,0 +1,29 @@
+module LovelyRufus class TextWrapper
+  def self.wrap text, width: 72
+    new(Wrap[text, width: width]).call
+  end
+
+  def initialize wrap
+    @wrap = wrap
+  end
+
+  def call
+    paras.map do |para|
+      chain.call(Wrap[para, width: wrap.width]).text.tr NBSP, ' '
+    end.join "\n"
+  end
+
+  attr_reader :wrap
+  private     :wrap
+
+  private
+
+  def chain
+    layers = [QuoteStripper, OneLetterGluer, BasicWrapper, HangoutWrapper]
+    layers.reverse.reduce(-> wrap { wrap }) { |inner, outer| outer.new inner }
+  end
+
+  def paras
+    wrap.text.split(/\n#{QUOTES}?\n/).reject { |para| para[/^#{QUOTES}?$/] }
+  end
+end end

data/lib/lovely_rufus/wrap.rb

@@ -0,0 +1,10 @@
+module LovelyRufus
+  Wrap = Struct.new :text, :width do
+    class << self
+      undef []
+      def [] text = '', width: 72
+        new text, width
+      end
+    end
+  end
+end

data/lib/lovely_rufus.rb

@@ -0,0 +1,13 @@
+require_relative 'lovely_rufus/layer'
+require_relative 'lovely_rufus/basic_wrapper'
+require_relative 'lovely_rufus/cli_wrapper'
+require_relative 'lovely_rufus/hangout_wrapper'
+require_relative 'lovely_rufus/one_letter_gluer'
+require_relative 'lovely_rufus/quote_stripper'
+require_relative 'lovely_rufus/text_wrapper'
+require_relative 'lovely_rufus/wrap'
+
+module LovelyRufus
+  NBSP   = "\u00A0"
+  QUOTES = %r{[>/#][>/# ]*}
+end

data/lovely_rufus.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.author      = 'Piotr Szotkowski'
+  gem.description = 'An executable and a Ruby library for wrapping paragraphs of text.'
+  gem.email       = 'chastell@chastell.net'
+  gem.homepage    = 'http://github.com/chastell/lovely_rufus'
+  gem.license     = 'AGPL-3.0'
+  gem.name        = 'lovely_rufus'
+  gem.summary     = 'lovely_rufus: text wrapper'
+  gem.version     = '0.1.0'
+
+  gem.files       = `git ls-files -z`.split "\0"
+  gem.executables = gem.files.grep(%r{^bin/}).map { |path| File.basename path }
+  gem.test_files  = gem.files.grep %r{^spec/.*\.rb$}
+
+  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 'reek',           '~> 1.3'
+  gem.add_development_dependency 'rubocop',        '~> 0.18.0'
+end

data/spec/lovely_rufus/basic_wrapper_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../spec_helper'
+
+module LovelyRufus 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 'never extends past the given width, chopping words if necessary' do
+      text = 'I’m killing your brain like a poisonous mushroom'
+      wrap = <<-end.dedent
+        I’m
+        killi
+        ng
+        your
+        brain
+        like
+        a
+        poiso
+        nous
+        mushr
+        oom
+      end
+      bw = BasicWrapper.new
+      bw.call(Wrap[text, width: 5]).must_equal Wrap[wrap, width: 5]
+    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

data/spec/lovely_rufus/cli_wrapper_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../spec_helper'
+
+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 }
+
+    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
+      end.must_output text
+    end
+
+    it 'accepts the desired width and passes it to TextWrapper' do
+      wrap = <<-end.dedent
+        all right: stop,
+        collaborate and listen
+      end
+      stub(text_wrapper).wrap(text, width: 22) { wrap }
+      lambda do
+        stream = StringIO.new text
+        CLIWrapper.new(%w[--width 22], text_wrapper: text_wrapper).run stream
+      end.must_output wrap
+    end
+  end
+end end

data/spec/lovely_rufus/hangout_wrapper_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../spec_helper'
+
+module LovelyRufus 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 }
+      HangoutWrapper.new(layer).call(Wrap["I O\nU", width: 4]).must_equal final
+    end
+  end
+end end

data/spec/lovely_rufus/one_letter_gluer_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../spec_helper'
+
+module LovelyRufus 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 }
+      OneLetterGluer.new(layer).call(Wrap['I O U', width: 69]).must_equal final
+    end
+  end
+end end

data/spec/lovely_rufus/quote_stripper_spec.rb

@@ -0,0 +1,113 @@
+require_relative '../spec_helper'
+
+module LovelyRufus describe QuoteStripper 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
+      layer = fake :layer, call: Wrap[unquoted, width: 70]
+      QuoteStripper.new(layer).call Wrap[quoted, width: 72]
+      layer.must_have_received :call, [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]
+      QuoteStripper.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]
+      QuoteStripper.new.call(wrap).must_equal wrap
+    end
+
+    it 'does not alter text contents' do
+      wrap = Wrap['> foo > bar']
+      QuoteStripper.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
+      layer = fake :layer, call: Wrap[unquoted, width: 69]
+      QuoteStripper.new(layer).call Wrap[quoted, width: 72]
+      layer.must_have_received :call, [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
+      layer = fake :layer, call: Wrap[unquoted, width: 68]
+      QuoteStripper.new(layer).call Wrap[quoted, width: 72]
+      layer.must_have_received :call, [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]
+      QuoteStripper.new.call(wrap).must_equal Wrap[fixed, width: 72]
+    end
+
+    it 'strips // code comments' do
+      quoted = <<-end.dedent
+        // so fast other DJs say ‘damn!’
+        // if my rhyme was a drug I’d sell it by the gram
+      end
+      unquoted = <<-end.dedent
+        so fast other DJs say ‘damn!’
+        if my rhyme was a drug I’d sell it by the gram
+      end
+      layer = fake :layer, call: Wrap[unquoted, width: 69]
+      QuoteStripper.new(layer).call Wrap[quoted, width: 72]
+      layer.must_have_received :call, [Wrap[unquoted, width: 69]]
+    end
+
+    it 'strips # code comments' do
+      quoted = <<-end.dedent
+        # keep my composure when it’s time to get loose
+        # magnetized by the mic while I kick my juice
+      end
+      unquoted = <<-end.dedent
+        keep my composure when it’s time to get loose
+        magnetized by the mic while I kick my juice
+      end
+      layer = fake :layer, call: Wrap[unquoted, width: 70]
+      QuoteStripper.new(layer).call Wrap[quoted, width: 72]
+      layer.must_have_received :call, [Wrap[unquoted, width: 70]]
+    end
+  end
+end end

data/spec/lovely_rufus/text_wrapper_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../spec_helper'
+
+module LovelyRufus describe TextWrapper do
+  describe '.wrap' do
+    it 'wraps the passed String to 72 characters by default' do
+      short = 'all right: stop, collaborate and listen'
+      long  = short + ' – Ice is back with a brand new invention'
+      wrap  = <<-end.dedent
+        all right: stop, collaborate and listen
+        – Ice is back with a brand new invention
+      end
+      TextWrapper.wrap(short).must_equal "#{short}\n"
+      TextWrapper.wrap(long).must_equal wrap
+    end
+
+    it 'wraps the passed String to the given number of characters' do
+      input = 'something grabs a hold of me tightly; ' \
+        'flow like a harpoon – daily and nightly'
+      TextWrapper.wrap(input, width: 40).must_equal <<-end.dedent
+        something grabs a hold of me tightly;
+        flow like a harpoon – daily and nightly
+      end
+      TextWrapper.wrap(input, width: 21).must_equal <<-end.dedent
+        something grabs
+        a hold of me tightly;
+        flow like a harpoon
+        – daily and nightly
+      end
+    end
+
+    it 'supports all the example use-cases' do
+      path = File.expand_path 'text_wrapper_spec.yml', __dir__
+      YAML.load_file(path).each do |spec|
+        width = spec.fetch('width') { 72 }
+        wrap  = "#{spec['output']}\n"
+        TextWrapper.wrap(spec['input'], width: width).must_equal wrap
+      end
+    end
+  end
+end end