word_wrapper 0.5.0

data/LICENSE

@@ -0,0 +1,11 @@
+Copyright © 2013 Stephen Pike. All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY [LICENSOR] "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,32 @@
+Ruby word wrapping implementation
+============================================================
+
+This is a pure ruby implementation of word wrapping. Currently supports the Greedy algorithm as well as Knuth's [Minimum Raggedness](http://en.wikipedia.org/wiki/Word_wrap#Knuth.27s_algorithm).
+
+Install:
+
+    gem install word_wrapper
+
+Usage:
+
+    require 'word_wrapper'
+
+    > text = "Before the law sits a gatekeeper. To this gatekeeper comes a man"
+
+    > puts WordWrapper::MinimumRaggedness.new(30, text).wrap
+
+    Before the law sits a
+    gatekeeper. To this
+    gatekeeper comes a man
+
+    > puts WordWrapper::Greedy.new(30, text).wrap
+
+    Before the law sits a
+    gatekeeper. To this gatekeeper
+    comes a man
+
+Contributing:
+
+You can run the tests if you have the Minitest gem installed with:
+
+    rake test

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*.rb'
+end

data/lib/greedy.rb

@@ -0,0 +1,33 @@
+class WordWrapper
+  class Greedy < WordWrapper
+    def wrap
+      words = @input.split
+      ans = ""
+      while words.any?
+        line = words.shift
+        while words.any? and (line.length + words[0].length) <= @width-1 # room for " "
+          line << " " << words.shift
+        end
+        ans << line << "\n"
+      end
+      @output = ans
+    end
+
+    def cost
+      compute_wrapping unless @cost
+      @cost
+    end
+
+    def compute_wrapping
+      @output = wrap
+      @cost = total_cost(@output)
+    end
+  end
+
+  if $0 == __FILE__ # run from cl
+    g = Greedy.new
+    g.compute_wrapping
+    puts g.output
+    puts "Greedy costs #{g.cost}"
+  end
+end

data/lib/minimum_raggedness.rb

@@ -0,0 +1,108 @@
+class WordWrapper
+  class MinimumRaggedness < WordWrapper
+    attr_accessor :splits
+
+    # Return the c
+    # @param [Array<String]] words in the text
+    # @param [Integer] i left bound of words to check between
+    # @param [Integer] j right bound of words to check between
+    # @return [Integer] cost of a line containing the words from i to j
+    def cost_between(words, i, j)
+      @c ||= {}
+      @c[[i,j]] ||=
+        begin
+          # Special case for single words that are longer than @width.
+          # Mark their cost as 0 so they get their own line without
+          # messing up the algorithm
+          if j == i and words[j-1].length >= @width
+            cost = 0
+          else
+            cost = @width -
+              ((j - i) * OneSpaceWidth ) -
+              words[i-1..j-1].inject(0){ |acc, w| acc + w.length } # 0 indexed
+            cost = cost >= 0 ? cost**2 : Infinity
+          end
+        end
+    end
+
+    # Use dynamic programming to computer the optimal cost of this text.
+    # Recursively calls itself, keeping track of costs found as well as the
+    # array of splits required to give that cost (so we can actually generate
+    # the optimal text at the end).
+    #
+    # @param [Array<String>] words to split
+    # @param [Intger] j index to compute cost up through, goes from 1..length of words as we
+    #  recursively compute costs.
+    #
+    # The evaluation looks like this (o is shorthand for optimal_cost):
+    #
+    #             -- o(1, j)                                   if c(1,j) < Inf
+    #     o(j) = -
+    #             -- min[ 1 <= k < j ] ( o(k) + c(k+1, j) )    if c(1,j) == Inf
+    #
+    # @return [Array<Integer, Array<String>>] (cost, [chain of splits that gives cost])
+    def optimal_cost(words, j)
+      @o ||= {}
+      @o[j] ||=
+        begin
+          ks = []
+          cost = cost_between words, 1, j
+          if cost == Infinity and j > 1
+            ks = (1..j-1)
+            candidates = {}
+            ks.collect do |k|
+            o = optimal_cost words, k
+            c = cost_between words, k + 1, j
+            # store both the chain of the child call and k
+            candidates[c + o[0]] = [o[1], k]
+          end
+            if candidates.any?
+              cost = candidates.keys.min
+              # ks is the chain of splits for this line of recursion
+              ks = candidates[cost][0] + [candidates[cost][1]]
+            end
+          end
+          # cost of this line, chain of splits that result in this cost
+          [cost,ks]
+        end
+    end
+
+    def cost
+      compute_wrapping unless @cost
+      @cost
+    end
+
+    def wrap
+      compute_wrapping unless @splits
+      prev = 0
+      ans = ""
+      @splits.each do |s|
+        ans << @words[prev..s-1].join(" ") << "\n"
+        prev = s
+      end
+      ans << @words[prev..@words.length].join(" ") << "\n"
+      ans
+    end
+
+    def compute_wrapping
+      @words = @input.split
+      @cost, @splits = optimal_cost(@words.dup, @words.length)
+    end
+
+    def solution?
+      cost != Infinity
+    end
+  end
+
+  if $0 == __FILE__ # from cl
+    m =  MinimumRaggedness.new
+    m.compute_wrapping
+    if m.solution?
+      puts m.wrap
+      puts "Minimum Raggedness costs #{m.cost}"
+    else
+      puts "Couldn't wrap the input to #{m.width} characters"
+      puts "Possible issues: #{m.illegal_words.join(', ')}"
+    end
+  end
+end

data/lib/word_wrapper.rb

@@ -0,0 +1,44 @@
+# Implementation of word wrappign in Ruby. See README for usage.
+class WordWrapper
+  OneSpaceWidth = 1
+  Infinity = 1/0.0
+  Width = 100
+
+  attr_accessor :width, :words, :output, :cost
+  def initialize(width = Width, text = nil)
+    @width = width
+    if text
+      @input = text
+    elsif ARGV[0]
+      begin
+        @input =  File.read(ARGV[0])
+      rescue Errno::ENOENT => e
+        @input = ARGV[0]
+      end
+    else
+      raise "You need to supply an input string or file"
+    end
+  end
+
+  # Calculate the cost of a line. Cost is defined as
+  #  [ Trailing whitespace ] ^ 2
+  # @param [String] line to compute cost for
+  def line_cost(line)
+    (@width - line.strip.length)**2  # no lines will ever start with whitespace
+  end
+
+  # The total cost of a block of text
+  # @param [String] text
+  def total_cost(text)
+    text.split("\n").inject(0){ |acc, line| acc + line_cost(line) }
+  end
+
+  # Any words in the text longer than the width of the output
+  # @return [Array<String>] illegal words
+  def illegal_words
+    @words.select{ |word| word.length > @width }
+  end
+end
+
+require  "minimum_raggedness"
+require  "greedy"

data/samples/before-the-law.txt

@@ -0,0 +1 @@
+Before the law sits a gatekeeper. To this gatekeeper comes a man from the country who asks to gain entry into the law. But the gatekeeper says that he cannot grant him entry at the moment. The man thinks about it and then asks if he will be allowed to come in sometime later on. “It is possible,” says the gatekeeper, “but not now.” The gate to the law stands open, as always, and the gatekeeper walks to the side, so the man bends over in order to see through the gate into the inside. When the gatekeeper notices that, he laughs and says: “If it tempts you so much, try going inside in spite of my prohibition. But take note. I am powerful. And I am only the most lowly gatekeeper. But from room to room stand gatekeepers, each more powerful than the other. I cannot endure even one glimpse of the third.” The man from the country has not expected such difficulties: the law should always be accessible for everyone, he thinks, but as he now looks more closely at the gatekeeper in his fur coat, at his large pointed nose and his long, thin, black Tartar’s beard, he decides that it would be better to wait until he gets permission to go inside. The gatekeeper gives him a stool and allows him to sit down at the side in front of the gate. There he sits for days and years. He makes many attempts to be let in, and he wears the gatekeeper out with his requests. The gatekeeper often interrogates him briefly, questioning him about his homeland and many other things, but they are indifferent questions, the kind great men put, and at the end he always tells him once more that he cannot let him inside yet. The man, who has equipped himself with many things for his journey, spends everything, no matter how valuable, to win over the gatekeeper. The latter takes it all but, as he does so, says, “I am taking this only so that you do not think you have failed to do anything.” During the many years the man observes the gatekeeper almost continuously. He forgets the other gatekeepers, and this first one seems to him the only obstacle for entry into the law. He curses the unlucky circumstance, in the first years thoughtlessly and out loud; later, as he grows old, he only mumbles to himself. He becomes childish and, since in the long years studying the gatekeeper he has also come to know the fleas in his fur collar, he even asks the fleas to help him persuade the gatekeeper. Finally his eyesight grows weak, and he does not know whether things are really darker around him or whether his eyes are merely deceiving him. But he recognizes now in the darkness an illumination which breaks inextinguishably out of the gateway to the law. Now he no longer has much time to live. Before his death he gathers in his head all his experiences of the entire time up into one question which he has not yet put to the gatekeeper. He waves to him, since he can no longer lift up his stiffening body. The gatekeeper has to bend way down to him, for the great difference has changed things considerably to the disadvantage of the man. “What do you still want to know now?” asks the gatekeeper. “You are insatiable.” “Everyone strives after the law,” says the man, “so how is it that in these many years no one except me has requested entry?” The gatekeeper sees that the man is already dying and, in order to reach his diminishing sense of hearing, he shouts at him, “Here no one else can gain entry, since this entrance was assigned only to you. I’m going now to close it.”

data/samples/getty-long.txt

@@ -0,0 +1,3 @@
+Four score and seven years ago our fathers brought forth on this continent a new nation, conceived in liberty, and dedicated to the proposition that all men are created equal.
+Now we are engaged in a great civil war, testing whether that nation, or any nation, so conceived and so dedicated, can long endure. We are met on a great battle-field of that war. We have come to dedicate a portion of that field, as a final resting place for those who here gave their lives that that nation might live. It is altogether fitting and proper that we should do this.
+But, in a larger sense, we can not dedicate, we can not consecrate, we can not hallow this ground. The brave men, living and dead, who struggled here, have consecrated it, far above our poor power to add or detract. The world will little note, nor long remember what we say here, but it can never forget what they did here. It is for us the living, rather, to be dedicated here to the unfinished work which they who fought here have thus far so nobly advanced. It is rather for us to be here dedicated to the great task remaining before us—that from these honored dead we take increased devotion to that cause for which they gave the last full measure of devotion—that we here highly resolve that these dead shall not have died in vain—that this nation, under God, shall have a new birth of freedom—and that government of the people, by the people, for the people, shall not perish from the earth.

data/samples/getty-med.txt

@@ -0,0 +1 @@
+Four score and seven years ago our fathers brought forth upon this continent a new nation, conceived in liberty and dedicated to the proposition that all men are created equal

data/samples/getty-small.txt

@@ -0,0 +1 @@
+Four score and seven years ago our fathers brought forth upon this continent a new nation

data/samples/oliver-twist.txt

@@ -0,0 +1,119 @@
+CHAPTER I
+
+TREATS OF THE PLACE WHERE OLIVER TWIST WAS BORN AND OF THE
+CIRCUMSTANCES ATTENDING HIS BIRTH
+
+Among other public buildings in a certain town, which for many reasons
+it will be prudent to refrain from mentioning, and to which I will
+assign no fictitious name, there is one anciently common to most towns,
+great or small: to wit, a workhouse; and in this workhouse was born; on
+a day and date which I need not trouble myself to repeat, inasmuch as
+it can be of no possible consequence to the reader, in this stage of
+the business at all events; the item of mortality whose name is
+prefixed to the head of this chapter.
+
+For a long time after it was ushered into this world of sorrow and
+trouble, by the parish surgeon, it remained a matter of considerable
+doubt whether the child would survive to bear any name at all; in which
+case it is somewhat more than probable that these memoirs would never
+have appeared; or, if they had, that being comprised within a couple of
+pages, they would have possessed the inestimable merit of being the
+most concise and faithful specimen of biography, extant in the
+literature of any age or country.
+
+Although I am not disposed to maintain that the being born in a
+workhouse, is in itself the most fortunate and enviable circumstance
+that can possibly befall a human being, I do mean to say that in this
+particular instance, it was the best thing for Oliver Twist that could
+by possibility have occurred.  The fact is, that there was considerable
+difficulty in inducing Oliver to take upon himself the office of
+respiration,--a troublesome practice, but one which custom has rendered
+necessary to our easy existence; and for some time he lay gasping on a
+little flock mattress, rather unequally poised between this world and
+the next: the balance being decidedly in favour of the latter.  Now,
+if, during this brief period, Oliver had been surrounded by careful
+grandmothers, anxious aunts, experienced nurses, and doctors of
+profound wisdom, he would most inevitably and indubitably have been
+killed in no time.  There being nobody by, however, but a pauper old
+woman, who was rendered rather misty by an unwonted allowance of beer;
+and a parish surgeon who did such matters by contract; Oliver and
+Nature fought out the point between them.  The result was, that, after
+a few struggles, Oliver breathed, sneezed, and proceeded to advertise
+to the inmates of the workhouse the fact of a new burden having been
+imposed  upon the parish, by setting up as loud a cry as could
+reasonably have been expected from a male infant who had not been
+possessed of that very useful appendage, a voice, for a much longer
+space of time than three minutes and a quarter.
+
+As Oliver gave this first proof of the free and proper action of his
+lungs, the patchwork coverlet which was carelessly flung over the iron
+bedstead, rustled; the pale face of a young woman was raised feebly
+from the pillow; and a faint voice imperfectly articulated the words,
+'Let me see the child, and die.'
+
+The surgeon had been sitting with his face turned towards the fire:
+giving the palms of his hands a warm and a rub alternately.  As the
+young woman spoke, he rose, and advancing to the bed's head, said, with
+more kindness than might have been expected of him:
+
+'Oh, you must not talk about dying yet.'
+
+'Lor bless her dear heart, no!' interposed the nurse, hastily
+depositing in her pocket a green glass bottle, the contents of which
+she had been tasting in a corner with evident satisfaction.
+
+'Lor bless her dear heart, when she has lived as long as I have, sir,
+and had thirteen children of her own, and all on 'em dead except two,
+and them in the wurkus with me, she'll know better than to take on in
+that way, bless her dear heart!  Think what it is to be a mother,
+there's a dear young lamb do.'
+
+Apparently this consolatory perspective of a mother's prospects failed
+in producing its due effect.  The patient shook her head, and stretched
+out her hand towards the child.
+
+The surgeon deposited it in her arms.  She imprinted her cold white
+lips passionately on its forehead; passed her hands over her face;
+gazed wildly round; shuddered; fell back--and died. They chafed her
+breast, hands, and temples; but the blood had stopped forever.  They
+talked of hope and comfort. They had been strangers too long.
+
+'It's all over, Mrs. Thingummy!' said the surgeon at last.
+
+'Ah, poor dear, so it is!' said the nurse, picking up the cork of the
+green bottle, which had fallen out on the pillow, as she stooped to
+take up the child.  'Poor dear!'
+
+'You needn't mind sending up to me, if the child cries, nurse,' said
+the surgeon, putting on his gloves with great deliberation. 'It's very
+likely it _will_ be troublesome. Give it a little gruel if it is.'  He
+put on his hat, and, pausing by the bed-side on his way to the door,
+added, 'She was a good-looking girl, too; where did she come from?'
+
+'She was brought here last night,' replied the old woman, 'by the
+overseer's order.  She was found lying in the street.  She had walked
+some distance, for her shoes were worn to pieces; but where she came
+from, or where she was going to, nobody knows.'
+
+The surgeon leaned over the body, and raised the left hand.  'The old
+story,' he said, shaking his head: 'no wedding-ring, I see. Ah!
+Good-night!'
+
+The medical gentleman walked away to dinner; and the nurse, having once
+more applied herself to the green bottle, sat down on a low chair
+before the fire, and proceeded to dress the infant.
+
+What an excellent example of the power of dress, young Oliver Twist
+was!  Wrapped in the blanket which had hitherto formed his only
+covering, he might have been the child of a nobleman or a beggar; it
+would have been hard for the haughtiest stranger to have assigned him
+his proper station in society.  But now that he was enveloped in the
+old calico robes which had grown yellow in the same service, he was
+badged and ticketed, and fell into his place at once--a parish
+child--the orphan of a workhouse--the humble, half-starved drudge--to
+be cuffed and buffeted through the world--despised by all, and pitied
+by none.
+
+Oliver cried lustily. If he could have known that he was an orphan,
+left to the tender mercies of church-wardens and overseers, perhaps he
+would have cried the louder.

data/test/word_wrapper_bench.rb

@@ -0,0 +1,38 @@
+require 'benchmark'
+include Benchmark
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'word_wrapper'
+
+samples_dir = File.join(File.dirname(__FILE__), '..', 'samples')
+@oliver_twist = File.read(File.join(samples_dir, "oliver-twist.txt"))
+@before_the_law = File.read(File.join(samples_dir, "before-the-law.txt"))
+@gettysburg = File.read(File.join(samples_dir, "getty-long.txt"))
+
+def run_greedy(text, times=10000)
+  g = WordWrapper::Greedy.new(100, text)
+  times.times do
+    g.compute_wrapping
+  end
+end
+
+def run_mr(text, times=100)
+  g = WordWrapper::MinimumRaggedness.new(100, text)
+  times.times do
+    g.compute_wrapping
+  end
+end
+
+puts "Greedy algorithm"
+Benchmark.bm do |x|
+  x.report("#{@gettysburg.split.length} words x 10000:") { run_greedy(@gettysburg) }
+  x.report("#{@before_the_law.split.length} words x 10000:") { run_greedy(@before_the_law) }
+  x.report("#{@oliver_twist.split.length} words x 10:")  { run_greedy(@oliver_twist, 10) }
+end
+
+puts "\nMinimum Raggedness algorithm"
+Benchmark.bm do |x|
+  x.report("#{@gettysburg.split.length} words x 10000:") { run_mr(@gettysburg) }
+  x.report("#{@before_the_law.split.length} words x 10000:") { run_mr(@before_the_law) }
+  x.report("#{@oliver_twist.split.length} words x 10:")  { run_mr(@oliver_twist, 10) }
+end

data/test/word_wrapper_test.rb

@@ -0,0 +1,80 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'word_wrapper'
+
+require 'minitest/autorun'
+
+class WordWrapperTest < MiniTest::Unit::TestCase
+  def setup
+    @short_text = "Four score and seven years ago our fathers brought forth upon this continent a new nation"
+    @med_text = "Four score and seven years ago our fathers brought forth upon this continent a new nation, conceived in liberty and dedicated to the proposition that all men are created equal"
+  end
+
+  def test_greedy_costs
+    assert_equal 90, WordWrapper::Greedy.new(13, @short_text).cost
+    assert_equal 264, WordWrapper::Greedy.new(13, @med_text).cost
+  end
+
+  def test_min_raggedness_costs
+    assert_equal 74, WordWrapper::MinimumRaggedness.new(13, @short_text).cost
+    assert_equal 204, WordWrapper::MinimumRaggedness.new(13, @med_text).cost
+  end
+
+  def test_optimal_word
+    assert_equal 0, WordWrapper::Greedy.new(13, "A"*13 ).cost
+    assert_equal 0, WordWrapper::MinimumRaggedness.new(13, "A"*13 ).cost
+  end
+
+  def test_greedy_output
+    assert_equal """Four score
+and seven
+years ago our
+fathers
+brought forth
+upon this
+continent a
+new nation,
+conceived in
+liberty and
+dedicated to
+the
+proposition
+that all men
+are created
+equal
+""", WordWrapper::Greedy.new(13,@med_text).wrap
+  end
+
+  def test_minimum_raggedness_output
+    assert_equal """Four score
+and seven
+years ago
+our fathers
+brought forth
+upon this
+continent a
+new nation,
+conceived in
+liberty and
+dedicated
+to the
+proposition
+that all
+men are
+created equal
+""", WordWrapper::MinimumRaggedness.new(13,@med_text).wrap
+  end
+
+  def test_minimum_raggedness_with_large_word
+    assert_equal """Before the
+law sits a
+gatekeeper.
+To this
+gatekeeper
+comes
+a man
+""", WordWrapper::MinimumRaggedness
+      .new(10,
+           "Before the law sits a gatekeeper. To this gatekeeper comes a man")
+      .wrap
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: word_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Pike
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70312798021560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70312798021560
+description: Word wrapping implementation in ruby. Includes a naive greedy algorithm
+  (fast) and Knuth's minimum raggedness algorithm from TeX (slower for long texts).
+email: scpike@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/greedy.rb
+- lib/minimum_raggedness.rb
+- lib/word_wrapper.rb
+- test/word_wrapper_bench.rb
+- test/word_wrapper_test.rb
+- samples/before-the-law.txt
+- samples/getty-long.txt
+- samples/getty-med.txt
+- samples/getty-small.txt
+- samples/oliver-twist.txt
+- Rakefile
+- README.md
+- LICENSE
+homepage: https://github.com/scpike/word-wrapping/tree/master/ruby
+licenses:
+- bsd
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Pure ruby word wrapping
+test_files: []
+has_rdoc: