word_wrap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4660c08a3ffd74a97b105526d2361f186bfb236a
+  data.tar.gz: 7591f43b255fa1e8d80d21342ebd1e41d7ab2b62
+SHA512:
+  metadata.gz: 36bb550b86addd349547a880cbaa3c8b705da3a43958b6028254f4d633e2b22b36b2561589790802b696afe1fca37c4dce6b1ec0db0176a8a3d6a53c6c9a42c0
+  data.tar.gz: cb381f125177bc732d3276d068ca59ea063e35f38fb6db269e8fb5a2e17e723ff8c783c1b08aa080a89eb45e1b772034acef86363a303095f7443f8a6e47badc

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_store
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in word_wrap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Radek Pazdera
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# WordWrap
+
+This gem is a extremely simple tool to word-wrap texts, which is the one an
+only thing it can do. It comes with a script called `ww` that you can use
+in the command line. And of course, you can get the functionality from within
+Ruby as well.
+
+For more information on usage, please refer to the **Usage** section of this
+README bellow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'word_wrap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install word_wrap
+
+## Usage
+
+You can use either the binary for the command line or the library directly
+from your Ruby scripts. Both use cases are explained bellow.
+
+### Command Line
+
+When in shell, you can use the `ww` tool (ww stands for word-wrap). It takes
+only two arguments:
+
+* `-w W, --width WIDTH` - The width to which the text should be wrapped.
+                          It is set to 80 by default.
+* `-f, --fit` - In this case, the program will also rearrange lines, that are
+                shorter than 80 to fit them as much as possible to the
+                predefined width, in addition to wrapping the lines that exceed
+                it. This option is generally better for plain text. For code,
+                however, it will mess up your indentation.
+#### Examples
+
+The example file looks like this:
+```bash
+cat hip.txt
+Forage Shoreditch disrupt Pitchfork meh.
+
+Mustache 3 wolf moon gluten-free whatever master burn
+vinyl.
+```
+
+```bash
+ww -w20 hip.txt
+Forage Shoreditch
+disrupt Pitchfork
+meh.
+
+Mustache 3 wolf moon
+gluten-free whatever
+master burn
+vinyl.
+```
+
+But you can also use stdin:
+```bash
+cat hip | ww -w20
+Forage Shoreditch
+disrupt Pitchfork
+meh.
+
+Mustache 3 wolf moon
+gluten-free whatever
+master burn
+vinyl.
+```
+
+Note the difference at end of the second paragraph:
+```bash
+cat hip | ww -w20
+Forage Shoreditch
+disrupt Pitchfork
+meh.
+
+Mustache 3 wolf moon
+gluten-free whatever
+master burn
+vinyl.
+```
+
+### Ruby library
+
+If you would like to use the library in Ruby, you have two options:
+
+* Use the `WordWrap#ww` function directly
+* Use the `String#wrap` and `String#fit` functions this module adds to the
+  standard `String` class.
+
+#### Example
+
+```irb
+irb(main):001:0> require 'word_wrap'
+=> true
+
+irb(main):002:0> WordWrap.ww "123 456 789", 5
+=> "123\n456\n789\n"
+
+irb(main):003:0> "123 456 789".wrap 5
+=> "123\n456\n789\n"
+
+irb(main):004:0> "123 456 789".fit 8
+=> "123 456\n789\n"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/pazdera/word_wrap/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/ww

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2014 Radek Pazdera
+# Distributed under the MIT License
+
+require 'optparse'
+require 'word_wrap'
+
+options = {:width => 80, :fit => false}
+OptionParser.new do |opts|
+  opts.banner = "Usage: ww [OPTIONS] [input-file]"
+
+  opts.on("-f", "--fit", "Fit precisely to the defined width") do |f|
+    options[:fit] = f
+  end
+
+  opts.on("-w", "--width COLUMNS", "Set line width (defaults to 80)") do |w|
+    options[:width] = w.to_i
+  end
+end.parse!
+
+if ARGV.length > 0
+  File.open(ARGV[0], "r") do |f|
+    print WordWrap::ww f.read, options[:width], options[:fit]
+  end
+else
+  print WordWrap::ww STDIN.read, options[:width], options[:fit]
+end

data/lib/word_wrap.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2014 Radek Pazdera
+# Distributed under the MIT License
+
+require "word_wrap/version"
+require "word_wrap/wrapper"
+
+module WordWrap
+  DEFAULT_WIDTH=80
+
+  def self.ww(text, width=DEFAULT_WIDTH, fit=false)
+    w = Wrapper.new(text, width)
+    fit ? w.fit : w.wrap
+  end
+end
+
+class String
+  def wrap(width=DEFAULT_WIDTH)
+    WordWrap.ww(self, width, false)
+  end
+
+  def fit(width=DEFAULT_WIDTH)
+    WordWrap.ww(self, width, true)
+  end
+end

data/lib/word_wrap/version.rb

@@ -0,0 +1,3 @@
+module WordWrap
+  VERSION = "0.1.0"
+end

data/lib/word_wrap/wrapper.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2014 Radek Pazdera
+# Distributed under the MIT License
+
+# The actual implementation of wrapping
+# TODO: share code between wrap and fit implementations
+
+module WordWrap
+  class Wrapper
+    def initialize(text, width)
+      @text = text
+      @width = width
+    end
+
+    def fit
+      lines = []
+      next_line = ""
+      continued = false
+      @text.lines do |line|
+        line.chomp! "\n"
+        if line.length == 0
+          if next_line.length > 0
+            lines.push next_line
+            next_line = ""
+          end
+          lines.push ""
+        end
+
+        words = line.split " "
+
+        words.each do |word|
+          word.chomp! "\n"
+
+          if next_line.length + word.length < @width
+            if next_line.length > 0
+              next_line << " " << word
+            else
+              next_line = word
+            end
+          else
+            if word.length >= @width
+              lines.push next_line unless next_line == ""
+              lines.push word
+              next_line = ""
+            else
+              lines.push next_line
+              next_line = word
+            end
+          end
+        end
+      end
+
+      lines.push next_line
+      if next_line.length <= 0
+        lines.join("\n")
+      else
+        lines.join("\n") + "\n"
+      end
+    end
+
+    def wrap
+      output = []
+
+      @text.lines do |line|
+        line.chomp! "\n"
+        if line.length > @width
+          new_lines = split_line(line, @width)
+          while new_lines.length > 1 && new_lines[1].length > @width
+            output.push new_lines[0]
+            new_lines = split_line new_lines[1], @width
+          end
+          output += new_lines
+        else
+          output.push line
+        end
+      end
+      output.map { |s| s.rstrip! }
+      output.join("\n") + "\n"
+    end
+
+    def split_line(line, width)
+      at = line.index /\s/
+      last_at = at
+
+      while at != nil && at < width
+        last_at = at
+        at = line.index /\s/, last_at + 1
+      end
+
+      if last_at == nil
+        [line]
+      else
+        [line[0,last_at], line[last_at+1, line.length]]
+      end
+    end
+  end
+end

data/spec/ww_spec.rb

@@ -0,0 +1,272 @@
+# Copyright (c) 2014 Radek Pazdera
+# Distributed under the MIT License
+
+# Several tests for the ww function
+
+require "word_wrap"
+
+describe WordWrap do
+  describe "#ww" do
+    it "wraps a single line correctly" do
+      text = "0123456789 01234 0123456"
+      expected =<<EOF
+0123456789
+01234
+0123456
+EOF
+      wrapped = WordWrap.ww(text, 10)
+      wrapped.should eql expected
+    end
+
+    it "works without breaks" do
+      text =<<EOF
+0123456789012345678 9
+0123456 0123456
+EOF
+
+      expected =<<EOF
+0123456789012345678
+9
+0123456
+0123456
+EOF
+      wrapped = WordWrap.ww(text, 10)
+      wrapped.should eql expected
+    end
+
+    it "wraps two paragraphs" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl, authentic disrupt banh mi cliche fixie skateboard biodiesel chillwave before they sold out pop-up direct trade.
+
+Mumblecore letterpress iPhone, Brooklyn pork belly distillery cray semiotics.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf
+moon vinyl,
+authentic disrupt
+banh mi cliche
+fixie skateboard
+biodiesel chillwave
+before they sold
+out pop-up direct
+trade.
+
+Mumblecore
+letterpress iPhone,
+Brooklyn pork belly
+distillery cray
+semiotics.
+EOF
+      wrapped = WordWrap.ww(text, 20)
+      wrapped.should eql expected
+    end
+
+    it "wraps a partialy wrapped paragraph" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl,
+authentic
+disrupt banh mi cliche
+fixie skateboard biodiesel chillwave
+before they sold out pop-up direct trade.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf
+moon vinyl,
+authentic
+disrupt banh mi
+cliche
+fixie skateboard
+biodiesel chillwave
+before they sold
+out pop-up direct
+trade.
+EOF
+      wrapped = WordWrap.ww(text, 20)
+      wrapped.should eql expected
+    end
+
+    it "wrapping keeps whitespace" do
+      text =<<EOF
+
+        word word word word word
+
+
+word      word  word
+word word   reallylong word
+
+extremelylonganduglyword
+
+    extremelylonganduglyword
+
+
+EOF
+
+      expected =<<EOF
+
+        word word
+word word word
+
+
+word      word  word
+word word
+reallylong word
+
+extremelylonganduglyword
+
+
+extremelylonganduglyword
+
+
+EOF
+      wrapped = WordWrap.ww(text, 20)
+      wrapped.should eql expected
+    end
+
+    it "wrap as a part of String interface" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl.
+
+Mumblecore letterpress iPhone.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf
+moon vinyl.
+
+Mumblecore
+letterpress iPhone.
+EOF
+      text.wrap(20).should eql expected
+    end
+
+    it "fits a single line correctly" do
+      text = "0123456789 01234 0123456"
+      expected =<<EOF
+0123456789
+01234
+0123456
+EOF
+      wrapped = WordWrap.ww(text, 10, true)
+      wrapped.should eql expected
+    end
+    
+    it "works without breaks" do
+      text =<<EOF
+0123456789012345678 9
+0123456 0123456
+EOF
+
+      expected =<<EOF
+0123456789012345678
+9 0123456
+0123456
+EOF
+      wrapped = WordWrap.ww(text, 10, true)
+      wrapped.should eql expected
+    end
+
+    it "fits two paragraphs" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl, authentic disrupt banh mi cliche fixie skateboard biodiesel chillwave before they sold out pop-up direct trade.
+
+Mumblecore letterpress iPhone, Brooklyn pork belly distillery cray semiotics.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf moon
+vinyl, authentic
+disrupt banh mi
+cliche fixie
+skateboard biodiesel
+chillwave before
+they sold out pop-up
+direct trade.
+
+Mumblecore
+letterpress iPhone,
+Brooklyn pork belly
+distillery cray
+semiotics.
+EOF
+      wrapped = WordWrap.ww(text, 20, true)
+      wrapped.should eql expected
+    end
+
+    it "fits a partialy wrapped paragraph" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl,
+awesome
+disrupt banh mi cliche
+fixie skateboard biodiesel chillwave
+before they sold out pop-up direct trade.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf moon
+vinyl, awesome
+disrupt banh mi
+cliche fixie
+skateboard biodiesel
+chillwave before
+they sold out pop-up
+direct trade.
+EOF
+      wrapped = WordWrap.ww(text, 20, true)
+      wrapped.should eql expected
+    end
+
+    it "fitting keeps empty lines" do
+      text =<<EOF
+
+        word word word word word
+
+
+word      word  word
+word word   reallylong word
+
+extremelylonganduglyword
+
+    extremelylonganduglyword
+
+
+EOF
+
+      expected =<<EOF
+
+word word word word
+word
+
+
+word word word word
+word reallylong word
+
+extremelylonganduglyword
+
+extremelylonganduglyword
+
+
+EOF
+      wrapped = WordWrap.ww(text, 20, true)
+      wrapped.should eql expected
+    end
+
+    it "fit as a part of String interface" do
+      text =<<EOF
+Try-hard 3 wolf moon vinyl.
+
+Mumblecore letterpress iPhone.
+EOF
+
+      expected =<<EOF
+Try-hard 3 wolf moon
+vinyl.
+
+Mumblecore
+letterpress iPhone.
+EOF
+      text.fit(20).should eql expected
+    end
+  end
+end

data/word_wrap.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'word_wrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "word_wrap"
+  spec.version       = WordWrap::VERSION
+  spec.authors       = ["Radek Pazdera"]
+  spec.email         = ["radek@pazdera.co.uk"]
+  spec.summary       = %q{Simple tool for word-wrapping text}
+  spec.description   = %q{This gem contains a very simple CLI tool for
+                          word-wrapping plain-text files. As simple as
+                          it gets. You can also use it in your Ruby
+                          scripts - check out the sources for help.}
+  spec.homepage      = "http://linuxwell.com/ww"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: word_wrap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Radek Pazdera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  This gem contains a very simple CLI tool for
+                            word-wrapping plain-text files. As simple as
+                            it gets. You can also use it in your Ruby
+                            scripts - check out the sources for help.
+email:
+- radek@pazdera.co.uk
+executables:
+- ww
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ww
+- lib/word_wrap.rb
+- lib/word_wrap/version.rb
+- lib/word_wrap/wrapper.rb
+- spec/ww_spec.rb
+- word_wrap.gemspec
+homepage: http://linuxwell.com/ww
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple tool for word-wrapping text
+test_files:
+- spec/ww_spec.rb