lovely-rufus 0.0.4 → 0.0.5

data/README.md

@@ -1,70 +0,0 @@
-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 `Wrapper` 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::Wrapper.new(text).wrapped
-    The Ballyshannon foundered off the coast of Cariboo,
-    And down in fathoms many went the captain and the crew;
-    >>
-
-Note that `Wrapper#wrapped` 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::Wrapper.new(text).wrapped(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-MMXIII Piotr Szotkowski <chastell@chastell.net>, licensed under AGPL 3 (see LICENCE)

data/Rakefile

@@ -1,18 +0,0 @@
-require 'rake/testtask'
-require 'reek/rake/task'
-require 'rubocop/rake_task'
-
-task default: %i[spec rubocop]
-
-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

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

data/lib/lovely-rufus.rb

@@ -1,5 +0,0 @@
-require 'delegate'
-require 'optparse'
-
-require_relative 'lovely-rufus/executable'
-require_relative 'lovely-rufus/wrapper'

data/lib/lovely-rufus/executable.rb

@@ -1,25 +0,0 @@
-module LovelyRufus class Executable
-  def initialize args = ARGV
-    @settings = settings_from args
-  end
-
-  def run input = $stdin
-    puts Wrapper.new(input.read).wrapped settings.width
-  end
-
-  attr_reader :settings
-  private     :settings
-
-  private
-
-  def settings_from args
-    Struct.new(:width).new.tap do |settings|
-      settings.width = 72
-      OptionParser.new do |opts|
-        opts.on '-w', '--width WIDTH', Integer, 'Wrapping width' do |width|
-          settings.width = width
-        end
-      end.parse! args
-    end
-  end
-end end

data/lib/lovely-rufus/wrapper.rb

@@ -1,93 +0,0 @@
-module LovelyRufus class Wrapper
-  NBSP = ' '
-
-  def initialize text
-    @paras = text.split(%r{\n[/#> ]*\n}).map { |para| Para.new para.strip }
-  end
-
-  def wrapped max_width = 72
-    return '' if paras.all?(&:empty?)
-
-    paras.map do |para|
-      para.wrap_recursively max_width
-    end.join "\n\n"
-  end
-
-  attr_reader :paras
-  private     :paras
-
-  private
-
-  class Para
-    def initialize text
-      @text = text
-    end
-
-    def empty?
-      text.empty?
-    end
-
-    def wrap_recursively max_width
-      best = wrap_to_width max_width
-      (max_width - 1).downto 1 do |width|
-        shorter = wrap_to_width width
-        break if shorter.lines.count           > best.lines.count
-        break if shorter.lines.map(&:size).max > best.lines.map(&:size).max
-        best = shorter
-      end
-      best
-    end
-
-    def wrap_to_width width
-      quotes = text[/^([\/#> ]*)/]
-      leader = quotes.empty? ? '' : quotes.tr(' ', '') + ' '
-      width -= leader.size if width > leader.size
-      text.lines
-        .map { |line| line[quotes.size..-1] }.join        # drop quotes
-        .tr("\n", ' ')                                    # unwrap para
-        .gsub(/ ([^ ]) /, " \\1#{NBSP}")                  # glue 1-letter words
-        .gsub(/(.{1,#{width}})( |$\n?)/, "\\1\n")         # wrap to width
-        .tap { |par| remove_hangouts par, width }         # handle hangouts
-        .lines.map { |line| line.insert 0, leader }.join  # re-insert leader
-        .tr(NBSP, ' ')                                    # drop glue spaces
-        .chomp                                            # final touch
-    end
-
-    attr_reader :text
-    private     :text
-
-    private
-
-    def find_hangout_line lines
-      lines.find.with_index do |line, i|
-        i < lines.size - 1 and
-        space = hangout_last_space(line) and
-        (hangout_to_previous_line i, lines, space or
-        hangout_to_next_line i, lines, space)
-      end
-    end
-
-    def hangout_last_space line
-      line.rindex(/[ #{NBSP}]/)
-    end
-
-    def hangout_to_next_line i, lines, space
-      (i < lines.size - 2 or lines.size == 2) and
-        space + 1 >= lines[i + 1].size
-    end
-
-    def hangout_to_previous_line i, lines, space
-      i > 0 and space + 1 >= lines[i - 1].size
-    end
-
-    def remove_hangouts para, width
-      lines = para.split "\n"
-      hangout_line = find_hangout_line lines
-      if hangout_line
-        hangout_line << NBSP
-        fixed = self.class.new lines.join(' ').gsub "#{NBSP} ", NBSP
-        para.replace fixed.wrap_to_width width
-      end
-    end
-  end
-end end

data/lovely-rufus.gemspec

@@ -1,14 +0,0 @@
-Gem::Specification.new do |gem|
-  gem.name     = 'lovely-rufus'
-  gem.version  = '0.0.4'
-  gem.summary  = 'lovely-rufus: text wrapper'
-  gem.homepage = 'http://github.com/chastell/lovely-rufus'
-  gem.author   = 'Piotr Szotkowski'
-  gem.email    = 'chastell@chastell.net'
-
-  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_dependency 'lovely_rufus'
-end

data/spec/fixtures/wrapper.yml

@@ -1,188 +0,0 @@
-# returns unwrapped input if it’s short enough
-- input: ‘Etiquette’ by Sir William Schwenck Gilbert
-  output: ‘Etiquette’ by Sir William Schwenck Gilbert
-
-# wraps short input if requested to wrap it shorter (and avoids hangouts)
-- width: 16
-  input: ‘Etiquette’ by Sir William Schwenck Gilbert
-  output: |-
-    ‘Etiquette’
-    by Sir William
-    Schwenck Gilbert
-
-# certain tricky hangout situations are catered for
-- input: |-
-    dropping spaces, it-would-look-like this written-by-Sir-William-Schwenck-Gilbert
-  output: |-
-    dropping spaces, it-would-look-like this
-    written-by-Sir-William-Schwenck-Gilbert
-
-# next-to-last hangouts are taken care of in two-line paragraphs
-- input: |-
-    Well, the old ones go mmmmmbbbbzzzzttteeeeeep as they start up and
-    the new ones go whupwhupwhupwhooopwhooooopwhooooooommmmmmmmmm.
-  output: |-
-    Well, the old ones go mmmmmbbbbzzzzttteeeeeep as they start up
-    and the new ones go whupwhupwhupwhooopwhooooopwhooooooommmmmmmmmm.
-
-# unwrapping works with quoted text
-- input: |-
-    > For some reason recently lovely-rufus
-    > versions can’t wrap.
-  output: |-
-    > For some reason recently lovely-rufus versions can’t wrap.
-
-# wraps long input to 72 characters by default
-- input: The Ballyshannon foundered off the coast of Cariboo, And down in fathoms many went the captain and the crew;
-  output: |-
-    The Ballyshannon foundered off the coast of Cariboo,
-    And down in fathoms many went the captain and the crew;
-
-# rewraps multiline paragraphs
-- input: |-
-    Down went the owners — greedy men
-    whom hope of gain allured:
-    Oh, dry the starting tear,
-    for they were heavily insured.
-  output: |-
-    Down went the owners — greedy men whom hope of gain allured:
-    Oh, dry the starting tear, for they were heavily insured.
-
-# wrapped paragraphs are as short as possible
-- input: |-
-    Besides the captain and the mate, the owners and the crew,
-    The passengers were also drowned, excepting only two:
-    Young PETER GRAY, who tasted teas for BAKER, CROOP, AND CO.,
-    And SOMERS, who from Eastern shores imported indigo.
-  output: |-
-    Besides the captain and the mate, the owners and the crew,
-    The passengers were also drowned, excepting only two: Young
-    PETER GRAY, who tasted teas for BAKER, CROOP, AND CO., And
-    SOMERS, who from Eastern shores imported indigo.
-
-# one-letter words are not left at line ends
-- width: 39
-  input: |-
-    These passengers, by reason of their clinging to a mast,
-    Upon a desert island were eventually cast.
-    They hunted for their meals, as ALEXANDER SELKIRK used,
-    But they couldn’t chat together — they had not been introduced.
-  output: |-
-    These passengers, by reason of
-    their clinging to a mast, Upon
-    a desert island were eventually
-    cast. They hunted for their meals,
-    as ALEXANDER SELKIRK used, But they
-    couldn’t chat together — they had
-    not been introduced.
-
-# multiple paragraphs are wrapped independently
-- input: |-
-    For PETER GRAY, and SOMERS too, though certainly in trade,
-    Were properly particular about the friends they made;
-    And somehow thus they settled it without a word of mouth —
-    That GRAY should take the northern half while SOMERS took the south.
-
-    On PETER’S portion oysters grew — a delicacy rare,
-    But oysters were a delicacy PETER couldn’t bear.
-    On SOMERS’ side was turtle, on the shingle lying thick,
-    Which SOMERS couldn’t eat, because it always made him sick.
-  output: |-
-    For PETER GRAY, and SOMERS too, though certainly in trade, Were
-    properly particular about the friends they made; And somehow
-    thus they settled it without a word of mouth — That GRAY should
-    take the northern half while SOMERS took the south.
-
-    On PETER’S portion oysters grew — a delicacy rare, But
-    oysters were a delicacy PETER couldn’t bear. On SOMERS’
-    side was turtle, on the shingle lying thick, Which
-    SOMERS couldn’t eat, because it always made him sick.
-
-# email-quoted paragraphs are wrapped regardless of quotes
-- input: |-
-    > On PETER’S portion oysters grew — a delicacy rare,
-    > But oysters were a delicacy PETER couldn’t bear.
-    > On SOMERS’ side was turtle, on the shingle lying thick,
-    > Which SOMERS couldn’t eat, because it always made him sick.
-  output: |-
-    > On PETER’S portion oysters grew — a delicacy rare, But
-    > oysters were a delicacy PETER couldn’t bear. On SOMERS’
-    > side was turtle, on the shingle lying thick, Which
-    > SOMERS couldn’t eat, because it always made him sick.
-
-# email quotes can be of any depth
-- input: |-
-    >> GRAY gnashed his teeth with envy as he saw a mighty store
-    >> Of turtle unmolested on his fellow-creature’s shore:
-    >> The oysters at his feet aside impatiently he shoved,
-    >> For turtle and his mother were the only things he loved.
-  output: |-
-    >> GRAY gnashed his teeth with envy as he saw a mighty store
-    >> Of turtle unmolested on his fellow-creature’s shore: The
-    >> oysters at his feet aside impatiently he shoved, For turtle
-    >> and his mother were the only things he loved.
-
-# email quotes are normalised upon wrapping
-- input: |-
-    > > >And SOMERS sighed in sorrow as he settled in the south,
-    > > >For the thought of PETER’S oysters brought the water to his mouth.
-    > > >He longed to lay him down upon the shelly bed, and stuff:
-    > > >He had often eaten oysters, but had never had enough.
-  output: |-
-    >>> And SOMERS sighed in sorrow as he settled in the south, For
-    >>> the thought of PETER’S oysters brought the water to his mouth.
-    >>> He longed to lay him down upon the shelly bed, and stuff: He
-    >>> had often eaten oysters, but had never had enough.
-
-# quoted paragraph breaks are cleared
-- input: |-
-    >> How they wished an introduction to each other they had had
-    >> When on board The Ballyshannon! And it drove them nearly mad
-    >> To think how very friendly with each other they might get,
-    >> If it wasn’t for the arbitrary rule of etiquette!
-    > 
-    > One day, when out a-hunting for the mus ridiculus,
-    > GRAY overheard his fellow-man soliloquising thus:
-    > ‘I wonder how the playmates of my youth are getting on,
-    > MCCONNELL, S. B. WALTERS, PADDY BYLES, and ROBINSON?’
-  output: |-
-    >> How they wished an introduction to each other they had had
-    >> When on board The Ballyshannon! And it drove them nearly
-    >> mad To think how very friendly with each other they might
-    >> get, If it wasn’t for the arbitrary rule of etiquette!
-
-    > One day, when out a-hunting for the mus ridiculus, GRAY overheard his
-    > fellow-man soliloquising thus: ‘I wonder how the playmates of my youth
-    > are getting on, MCCONNELL, S. B. WALTERS, PADDY BYLES, and ROBINSON?’
-
-# code comments are handled like email-quoted text
-- input: |-
-    // These simple words made PETER as delighted as could be,
-    // Old chummies at the Charterhouse were ROBINSON and he!
-    // He walked straight up to SOMERS, then he turned extremely red,
-    // Hesitated, hummed and hawed a bit, then cleared his throat, and said:
-    //
-    # ‘I beg your pardon—pray forgive me if I seem too bold,
-    # But you have breathed a name I knew familiarly of old.
-    # You spoke aloud of ROBINSON – I happened to be by—
-    # You know him?’ ‘Yes, extremely well.’ ‘Allow me – so do I!’
-    #
-    It was enough: they felt they could more sociably get on,
-    For (ah, the magic of the fact!) they each knew ROBINSON!
-    And MR. SOMERS’ turtle was at PETER’S service quite,
-    And MR. SOMERS punished PETER’S oyster-beds all night.
-  output: |-
-    // These simple words made PETER as delighted as could be, Old
-    // chummies at the Charterhouse were ROBINSON and he! He walked
-    // straight up to SOMERS, then he turned extremely red, Hesitated,
-    // hummed and hawed a bit, then cleared his throat, and said:
-
-    # ‘I beg your pardon—pray forgive me if I seem too bold,
-    # But you have breathed a name I knew familiarly of old.
-    # You spoke aloud of ROBINSON – I happened to be by— You
-    # know him?’ ‘Yes, extremely well.’ ‘Allow me – so do I!’
-
-    It was enough: they felt they could more sociably get on,
-    For (ah, the magic of the fact!) they each knew ROBINSON!
-    And MR. SOMERS’ turtle was at PETER’S service quite, And
-    MR. SOMERS punished PETER’S oyster-beds all night.

data/spec/lovely-rufus/executable_spec.rb

@@ -1,25 +0,0 @@
-require_relative '../spec_helper'
-
-module LovelyRufus describe Executable do
-  describe '#run' do
-    it 'outputs passed text' do
-      text = StringIO.new 'some text'
-      -> { Executable.new.run text }.must_output "some text\n"
-    end
-
-    it 'wraps passed text to desired width' do
-      text = StringIO.new 'some text'
-      -> { Executable.new(%w[--width 4]).run text }.must_output "some\ntext\n"
-    end
-
-    it 'supports short arguments' do
-      text = StringIO.new 'some text'
-      -> { Executable.new(%w[-w4]).run text }.must_output "some\ntext\n"
-    end
-
-    it 'outputs properly wrapped input' do
-      text = StringIO.new 'some more text'
-      -> { Executable.new(%w[-w4]).run text }.must_output "some\nmore\ntext\n"
-    end
-  end
-end end