wrapomatic 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f73d07ec7875f19f75cc62b414edabc568e3032
-  data.tar.gz: 601f3b88c10b86452685d645ccbb5377987cbf70
+  metadata.gz: 4c73d088e719445e4d5a9393b58b2ee9d328ff0e
+  data.tar.gz: b492f8d020442d589fb291275d308ee1a2be7774
 SHA512:
-  metadata.gz: ab5a57250855cffa032779b6f78206bb7508c0dcd6950ae831d59bcf7e253f928b91e79d3a96453950898cc979de4a9181f0e83b6da1c9b48e0683e0c2f230a9
-  data.tar.gz: 5f35e85be2049250ec0bd6b40af7a45b582e2ce4f1486f7fd32d28abc0bcd9837d1829117e137793e86503028dcdbb80ff5edaf5ef6bb50a0dae912bcb6ca710
+  metadata.gz: 9abe5effd94b0ee85444827b618cc64fed6053802ec1c064248ae3b95334f5b84b9c2b7bd65343af95e30e9ffc7bf97197d00fb953f4c663413d7b81ec342e45
+  data.tar.gz: 58fc933525133cd6d9e6a2a6f2a37637dba97487dd66880e8a5969e9c0aa4f2ae2821f62d541c7d6ed99789c78df420b72bb13f319264227031711ec1ab31394

data/README.md

@@ -1,8 +1,6 @@
 # Wrapomatic
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wrapomatic`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Wrapomatic is a naive text line wrapper that also supports indentation for the wrapped text.
 
 ## Installation
 
@@ -22,10 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'wrapomatic'
+
+text = <<-EOT
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+And THAT was a lot of text on one line!
+EOT
+
+Wrapomatic.wrap(text, indents: 1, columns: 40)
+
+# => "  Lorem ipsum dolor sit amet,\n  consectetur adipiscing elit, sed do\n  eiusmod tempor incididunt ut labore et\n  dolore magna aliqua. Ut enim ad minim\n  veniam, quis nostrud exercitation\n  ullamco laboris nisi ut aliquip ex ea\n  commodo consequat. Duis aute irure\n  dolor in reprehenderit in voluptate\n  velit esse cillum dolore eu fugiat\n  nulla pariatur. Excepteur sint\n  occaecat cupidatat non proident, sunt\n  in culpa qui officia deserunt mollit\n  anim id est laborum.\n  \n  And THAT was a lot of text on one\n  line!"
+```
 
 ## Development
 
+Branches and releases for this project are managed by [git-flow](https://github.com/nvie/gitflow).
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -33,7 +45,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/wrapomatic/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch off of develop (`git checkout develop ; 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 a new Pull Request

data/lib/wrapomatic/line/processor/base.rb

@@ -0,0 +1,48 @@
+module Wrapomatic
+  class Line
+    module Processor
+
+      # The base processor from which all other processors inherit
+      #
+      # @note To create a new Line processor, inherit from this class and
+      #   implement the private method `processed`, returning a String
+      #
+      # @example Creating A New Line Processor
+      #   class MyProcessor < Wrapomatic::Line::Processor::Base
+      #     private
+      #     def processed
+      #       "the conent that we want to pass back after processing"
+      #     end
+      #   end
+      #
+      # @!attribute [r] text
+      #   @return [String] the text being processed
+      #
+      # @!attribute [r] columns
+      #   @return [Integer] the maximum number of characters in the result
+      class Base
+        attr_reader :text, :columns
+
+        # @param text [String] the text to process
+        #
+        # @param columns [Integer] the column cutoff at which the line should
+        #   be wrapped
+        def initialize(text, columns)
+          @text, @columns = text, columns
+        end
+
+        # The content after processing
+        #
+        # @return [String] the line part resulting from processing
+        def content
+          processed
+        end
+
+        private
+        def processed
+          text
+        end
+      end
+    end
+  end
+end

data/lib/wrapomatic/line/processor/primary.rb

@@ -0,0 +1,38 @@
+require 'wrapomatic/line/processor/base'
+
+module Wrapomatic
+  class Line
+    module Processor
+
+      # A line processor that extracts the primary line, which is all parts of
+      # the line before the column cutoff, inclusive.
+      class Primary < Base
+        private
+        def processed
+          @processed ||= primary_part
+        end
+
+        def primary_part
+          text.slice(0..line_break).rstrip
+        end
+
+        def last_leading_whitespace
+          [0, text.index(/[^\s]/).to_i - 1].max
+        end
+
+        def line_break
+          case breaking_whitespace > last_leading_whitespace
+          when true
+            [columns, breaking_whitespace].min
+          else
+            columns
+          end
+        end
+
+        def breaking_whitespace
+          text.rindex(/(\s|-)/, columns).to_i
+        end
+      end
+    end
+  end
+end

data/lib/wrapomatic/line/processor/remainder.rb

@@ -0,0 +1,22 @@
+require 'wrapomatic/line/processor/base'
+require 'wrapomatic/line/processor/primary'
+
+module Wrapomatic
+  class Line
+    module Processor
+
+      # A line processor that extracts the line remainder, which is what is left
+      # after the primary line is extracted.
+      class Remainder < Base
+        private
+        def processed
+          @processed ||= text.gsub(/^#{primary}/, '').lstrip
+        end
+
+        def primary
+          @primary ||= Primary.new(text, columns).content
+        end
+      end
+    end
+  end
+end

data/lib/wrapomatic/line/processor.rb

@@ -0,0 +1,32 @@
+require 'wrapomatic/line/processor/primary'
+require 'wrapomatic/line/processor/remainder'
+
+module Wrapomatic
+  class Line
+
+    # A deep and dark module that really shouldn't be used directly
+    #
+    # @api private
+    module Processor
+
+      # Process a line
+      #
+      # @param [Line] a Line object to process
+      #
+      # @return [Array<String>] the processed line, broken into individually
+      #   wrapped lines
+      def self.process(line)
+        columns = line.columns
+        indents = line.indents
+        text = line.indented
+
+        [Primary.new(text, columns).content] +
+          line.class.new(
+            Remainder.new(text, columns).content,
+            indents,
+            columns
+          ).wrapped
+      end
+    end
+  end
+end

data/lib/wrapomatic/line.rb

@@ -0,0 +1,58 @@
+require 'wrapomatic/line/processor'
+
+module Wrapomatic
+
+  # Wrap a single line
+  #
+  # @!attribute [r] columns
+  #   @return [Integer] the columns cutoff
+  #
+  # @!attribute [r] indents
+  #   @return [Integer] the indentation level
+  #
+  # @!attribute [r] original
+  #   @return [String] the original text
+  class Line
+    # An indentation in Wrapomatic is two spaces
+    INDENTATION = '  '
+
+    attr_reader :original, :indents, :columns
+
+    # @param original [String] a single line of text
+    #
+    # @param indents [Integer] the number of indentation levels to which the
+    #   line should be wrapped
+    #
+    # @param columns [Integer] the number of columns to which the line should be
+    #   wrapped
+    #
+    # @raise [ArgumentError] if the provided text contains newline characters
+    def initialize(original, indents, columns)
+      @original, @indents, @columns = original, indents, columns
+      raise ArgumentError.new('original may not contain newline') if contains_newline?
+    end
+
+    # The result of wrapping the text to the provided indentation level and
+    # columns
+    #
+    # @return [Array<String>] the original line broken into several lines that
+    #   adhere to the column cutoff and indentation level
+    def wrapped
+      @wrapped ||= indented.length <= columns ? 
+        [indented] :
+        Processor.process(self)
+    end
+
+    # The indented line before wrapping
+    #
+    # @return [String] the line indented to the indentation level
+    def indented
+      "#{INDENTATION * indents}#{original}"
+    end
+
+    private
+    def contains_newline?
+      original.chars.include?("\n")
+    end
+  end
+end

data/lib/wrapomatic/version.rb

@@ -1,3 +1,4 @@
 module Wrapomatic
-  VERSION = "0.1.1"
+  # The current Wrapomatic version
+  VERSION = "0.2.0"
 end

data/lib/wrapomatic/wrapper.rb

@@ -1,47 +1,52 @@
+require 'wrapomatic/line'
+
 module Wrapomatic
+
+  # Wrap several lines
+  #
+  # @!attribute [r] text
+  #   @return [String] the text to wrap
+  #
+  # @!attribute [r] lines
+  #   @return [Array<String>] the text after wrapping as individual lines
+  #
+  # @!attribute [r] indents
+  #   @return [Integer] the indentation level
+  #
+  # @!attribute [r] columns
+  #   @return [Integer] the column cutoff
   class Wrapper
     attr_reader :text, :lines, :indents, :columns
 
+    # @param text [String] the text to wrap
+    #
+    # @param indents [Integer] the level to which each line should be
+    #   indented
+    #
+    # @param columns [Integer] the column to which each line should be
+    #   wrapped
     def initialize(text, indents = 0, columns = 80)
-      @text = text.split("\n").join(' ')
-      @indents = indents
-      @columns = columns
+      @text, @indents, @columns = text, indents, columns
       @lines = []
-      indentomize
+      spit_some_mad_fire
     end
 
+    # The text wrapped to the desired indentation level and column cutoff
+    #
+    # @return [String] the wrapped text, joined by newlines
     def wrapped
-      lines.join("\n")
+      @lines.join("\n")
     end
 
     private
-
-    def indentomize
-      until (line = next_line).nil?
-        @lines.push(line)
-      end
-    end
-
-    def next_line
-      return nil if text.length == 0
-      offset + text_up_to(space_before_location(columns - offset.length - 1))
-    end
-
-    def space_before_location(start)
-      return start if start > text.length
-      text.rindex(/(\s|-)/, start) || start
-    end
-
-    def text_up_to(count)
-      text.slice!(0..count)
-    end
-
-    def indentation
-      '  '
+    def spit_some_mad_fire
+      @lines = unwrapped_lines.map {|line|
+        Line.new(line, indents, columns).wrapped
+      }.flatten
     end
 
-    def offset
-      indentation * indents
+    def unwrapped_lines
+      text.split("\n")
     end
   end
 end

data/lib/wrapomatic.rb

@@ -1,10 +1,26 @@
 require 'wrapomatic/version'
+require 'wrapomatic/line'
 require 'wrapomatic/wrapper'
 
+# Let's line wrap some strings!
 module Wrapomatic
+
+  # Wraps the given text with optional indentation and width
+  #
+  # @param text [String] the text blob to wrap
+  #
+  # @param [Hash] options the options with which to wrap the text
+  #
+  # @option options [Integer] :indents (0) the number of indentation levels to
+  #   use for wrapping the text
+  #
+  # @option options [Integer] :columns (80) the number of columes to which the
+  #   text should be wrapped
+  #
+  # @return [String] the wrapped text
   def self.wrap(text, options = {})
-    options[:indents] ||= 0
-    options[:columns] ||= 80
-    Wrapper.new(text, options[:indents], options[:columns]).wrapped
+    indents = options[:indents] || 0
+    columns = options[:columns] || 80
+    Wrapper.new(text, indents, columns).wrapped
   end
 end

data/wrapomatic.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "yard", "~> 0.8.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis Walters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: 
 email:
 - dwalters@engineyard.com
@@ -85,6 +99,11 @@ files:
 - bin/console
 - bin/setup
 - lib/wrapomatic.rb
+- lib/wrapomatic/line.rb
+- lib/wrapomatic/line/processor.rb
+- lib/wrapomatic/line/processor/base.rb
+- lib/wrapomatic/line/processor/primary.rb
+- lib/wrapomatic/line/processor/remainder.rb
 - lib/wrapomatic/version.rb
 - lib/wrapomatic/wrapper.rb
 - wrapomatic.gemspec
@@ -113,3 +132,4 @@ signing_key:
 specification_version: 4
 summary: Naive text wrapping for terminal output
 test_files: []
+has_rdoc: