monospace_text_formatter 0.0.3 → 0.1.0

data/Changelog

@@ -1,3 +1,7 @@
+0.1.0 (February 29, 2012)
+  Implemented "padding" setting.
+  Fixed "width" calculation for Box class.
+
 0.0.3 (February 18, 2012)
   Fixed handling of non display length for horizontal alignment.
   Minor refactorings.

data/README.md

@@ -37,6 +37,16 @@ The `line` object for the following examples:
    => "This is some ..."
 ```
 
+* `padding_left` and `padding_right` (in number of characters)
+
+```ruby
+  line.padding_left = 3
+  line.padding_right = 2
+
+  line.to_s
+   => "   This is ...  "
+```
+
 * `omission`
 
 ```ruby
@@ -105,6 +115,24 @@ The `box` object for the following examples:
        "And second, a ...   "]
 ```
 
+* `padding_top`, `padding_right`, `padding_bottom` and `padding_left` (in number of lines/characters)
+
+```ruby
+  box.height = 5
+
+  box.padding_top = 1
+  box.padding_right = 1
+  box.padding_bottom = 2
+  box.padding_left = 2
+
+  box.lines
+   => ["                    ",
+       "  First line.       ",
+       "  And second, a ... ",
+       "                    ",
+       "                    "]
+```
+
 * `omission`
 
 ```ruby

data/lib/monospace_text_formatter/box.rb

@@ -2,6 +2,11 @@ module MonospaceTextFormatter
   class Box
 
     def initialize(string_or_chunk, attrs={})
+      @padding_top    = 0
+      @padding_right  = 0
+      @padding_bottom = 0
+      @padding_left   = 0
+
          @omission = string_to_chunk(" ...")
             @align = :left
            @valign = :top
@@ -13,6 +18,7 @@ module MonospaceTextFormatter
       attributes(attrs)
     end
 
+    attr_reader :padding_top, :padding_right, :padding_bottom, :padding_left
     attr_reader :omission, :align, :valign, :fill
 
     def width
@@ -20,7 +26,7 @@ module MonospaceTextFormatter
     end
 
     def height
-      @fixed_height || content_lines.size
+      @fixed_height || padding_top + content_lines.size + padding_bottom
     end
 
     def attributes(attrs={})
@@ -31,7 +37,7 @@ module MonospaceTextFormatter
       return if fixed_width == @fixed_width
       raise ArgumentError, "The :width must be equal or greater than 0, but is #{fixed_width}" unless fixed_width.nil? or fixed_width >= 0
 
-      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_top_lines = @content_lines = @empty_bottom_lines = nil
+      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_top_lines = @content_lines = @empty_bottom_lines = @fixed_width_minus_padding = nil
       @fixed_width = fixed_width
     end
 
@@ -39,10 +45,46 @@ module MonospaceTextFormatter
       return if fixed_height == @fixed_height
       raise ArgumentError, "The :height must be equal or greater than 0, but is #{fixed_height}" unless fixed_height.nil? or fixed_height >= 0
 
-      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_top_lines = @content_lines = @empty_bottom_lines = nil
+      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_top_lines = @content_lines = @empty_bottom_lines = @fixed_height_minus_padding = nil
       @fixed_height = fixed_height
     end
 
+    def padding_top=(padding_top)
+      return if padding_top == @padding_top
+      raise ArgumentError, "The :padding_top must be a number equal or greater than 0, but is #{padding_top.inspect}" unless padding_top.kind_of?(Fixnum) && padding_top >= 0
+
+      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_top_lines = nil
+      @content_lines = @empty_bottom_lines = @fixed_height_minus_padding = nil if @fixed_height
+      @padding_top = padding_top
+    end
+
+    def padding_right=(padding_right)
+      return if padding_right == @padding_right
+      raise ArgumentError, "The :padding_right must be a number equal or greater than 0, but is #{padding_right.inspect}" unless padding_right.kind_of?(Fixnum) && padding_right >= 0
+
+      @to_s = @lines = @aligned_all_lines = @all_lines = @content_lines = nil
+      @fixed_width_minus_padding = nil if @fixed_width
+      @padding_right = padding_right
+    end
+
+    def padding_bottom=(padding_bottom)
+      return if padding_bottom == @padding_bottom
+      raise ArgumentError, "The :padding_bottom must be a number equal or greater than 0, but is #{padding_bottom.inspect}" unless padding_bottom.kind_of?(Fixnum) && padding_bottom >= 0
+
+      @to_s = @lines = @aligned_all_lines = @all_lines = @empty_bottom_lines = nil
+      @content_lines = @empty_top_lines = @fixed_height_minus_padding = nil if @fixed_height
+      @padding_bottom = padding_bottom
+    end
+
+    def padding_left=(padding_left)
+      return if padding_left == @padding_left
+      raise ArgumentError, "The :padding_left must be a number equal or greater than 0, but is #{padding_left.inspect}" unless padding_left.kind_of?(Fixnum) && padding_left >= 0
+
+      @to_s = @lines = @aligned_all_lines = @all_lines = @content_lines = nil
+      @fixed_width_minus_padding = nil if @fixed_width
+      @padding_left = padding_left
+    end
+
     def omission=(omission)
       return if omission == @omission
 
@@ -103,9 +145,17 @@ module MonospaceTextFormatter
       Line.new(string_or_chunk, attrs)
     end
 
+    def fixed_height_minus_padding
+      @fixed_height_minus_padding ||= @fixed_height && (@fixed_height - padding_top - padding_bottom)
+    end
+
+    def fixed_width_minus_padding
+      @fixed_width_minus_padding ||= @fixed_width && (@fixed_width - padding_left - padding_right)
+    end
+
     def aligned_all_lines
       @aligned_all_lines ||= all_lines.each do |line|
-        line.attributes(:align => align, :fill => fill, :width => width)
+        line.attributes(:align => align, :fill => fill, :width => width, :padding_left => padding_left, :padding_right => padding_right)
       end
     end
 
@@ -114,53 +164,68 @@ module MonospaceTextFormatter
     end
 
     def empty_top_lines
-      @empty_top_lines ||= if @fixed_height && fill && !fill.empty?
-                             case valign
-                             when :top
-                               []
-                             when :middle
-                               Array.new(((@fixed_height - content_lines.size) / 2.0).floor, new_line(""))
-                             when :bottom
-                               Array.new(@fixed_height - content_lines.size, new_line(""))
-                             end
-                           else
-                             []
-                           end
+      @empty_top_lines ||= Array.new(empty_top_lines_number, new_line(""))
+    end
+
+    def empty_top_lines_number
+      return 0 if fill.nil? or fill.empty?
+
+      [[padding_top +
+        if @fixed_height
+          case valign
+          when :top
+            0
+          when :middle
+            ((fixed_height_minus_padding - content_lines.size) / 2.0).floor
+          when :bottom
+            fixed_height_minus_padding - content_lines.size
+          end
+        else
+          0
+        end, @fixed_height && @fixed_height - content_lines.size].compact.min, 0].max
     end
 
     def empty_bottom_lines
-      @empty_bottom_lines ||= if @fixed_height && fill && !fill.empty?
-                                case valign
-                                when :top
-                                  Array.new(@fixed_height - content_lines.size, new_line(""))
-                                when :middle
-                                  Array.new(((@fixed_height - content_lines.size) / 2.0).ceil, new_line(""))
-                                when :bottom
-                                  []
-                                end
-                              else
-                                []
-                              end
+      @empty_bottom_lines ||= Array.new(empty_bottom_lines_number, new_line(""))
+    end
+
+    def empty_bottom_lines_number
+      return 0 if fill.nil? or fill.empty?
+
+      [[padding_bottom +
+        if @fixed_height
+          case valign
+          when :top
+            fixed_height_minus_padding - content_lines.size
+          when :middle
+            ((fixed_height_minus_padding - content_lines.size) / 2.0).ceil
+          when :bottom
+            0
+          end
+        else
+          0
+        end, @fixed_height && @fixed_height - content_lines.size].compact.min, 0].max
     end
 
     def content_lines
       return @content_lines unless @content_lines.nil?
-      return @content_lines = [] if @fixed_width == 0 && @fixed_height.nil?
+      return @content_lines = [] if fixed_width_minus_padding && fixed_width_minus_padding <= 0 && fixed_height_minus_padding.nil?
       return @content_lines = [new_line("")] if @original_chunk.empty?
 
       @remaining_chunk = @original_chunk.duplicate
       @line_chunks = []
 
-      until (@fixed_height && @line_chunks.size == @fixed_height) || @remaining_chunk.empty?
-        @line_chunks << if @line_chunks.size + 1 == @fixed_height
+      until (fixed_height_minus_padding && @line_chunks.size >= fixed_height_minus_padding) || @remaining_chunk.empty?
+        @line_chunks << if @line_chunks.size + 1 == fixed_height_minus_padding
                           @remaining_chunk
                         else
-                          @remaining_chunk.slice!(@fixed_width ? @fixed_width : nil)
+                          @remaining_chunk.slice!(fixed_width_minus_padding ? [fixed_width_minus_padding, 0].max : nil)
                         end
       end
 
-      common_width = @fixed_width || @line_chunks.map { |chunk| chunk.display_length }.max
-      @content_lines = @line_chunks.map { |chunk| new_line(chunk, :width => common_width, :omission => omission) }
+      @content_lines = @line_chunks.map { |chunk| new_line(chunk, :omission => omission, :padding_left => padding_left, :padding_right => padding_right) }
+      common_width = @fixed_width || @content_lines.map { |line| line.width }.max
+      @content_lines.each { |line| line.width = common_width }
     end
   end
 end

data/lib/monospace_text_formatter/line.rb

@@ -2,10 +2,12 @@ module MonospaceTextFormatter
   class Line
 
     def initialize(string_or_chunk, attrs={})
-         @omission = string_to_chunk(" ...")
-            @align = :left
-             @fill = " "
-        @truncated = nil
+      @padding_left  = 0
+      @padding_right = 0
+           @omission = string_to_chunk(" ...")
+              @align = :left
+               @fill = " "
+          @truncated = nil
 
       raise ArgumentError, "No string given" unless string_or_chunk
       @original_chunk = to_chunk_if_string(string_or_chunk)
@@ -13,10 +15,10 @@ module MonospaceTextFormatter
       attributes(attrs)
     end
 
-    attr_reader :omission, :align, :fill
+    attr_reader :padding_left, :padding_right, :omission, :align, :fill
 
     def width
-      @fixed_width || visible_chunk.display_length
+      @fixed_width || padding_left + visible_chunk.display_length + padding_right
     end
 
     def attributes(attrs={})
@@ -27,10 +29,28 @@ module MonospaceTextFormatter
       return if fixed_width == @fixed_width
       raise ArgumentError, "The :width must be equal or greater than 0, but is #{fixed_width}" unless fixed_width.nil? or fixed_width >= 0
 
-      @aligned_visible_text = @visible_chunk = nil
+      @aligned_visible_text = @visible_chunk = @fixed_width_minus_padding = nil
       @fixed_width = fixed_width
     end
 
+    def padding_left=(padding_left)
+      return if padding_left == @padding_left
+      raise ArgumentError, "The :padding_left must be a number equal or greater than 0, but is #{padding_left.inspect}" unless padding_left.kind_of?(Fixnum) && padding_left >= 0
+
+      @aligned_visible_text = nil
+      @visible_chunk = @fixed_width_minus_padding = nil if @fixed_width
+      @padding_left = padding_left
+    end
+
+    def padding_right=(padding_right)
+      return if padding_right == @padding_right
+      raise ArgumentError, "The :padding_right must be a number equal or greater than 0, but is #{padding_right.inspect}" unless padding_right.kind_of?(Fixnum) && padding_right >= 0
+
+      @aligned_visible_text = nil
+      @visible_chunk = @fixed_width_minus_padding = nil if @fixed_width
+      @padding_right = padding_right
+    end
+
     def omission=(omission)
       return if omission == @omission
 
@@ -76,28 +96,66 @@ module MonospaceTextFormatter
       Chunk.new(string)
     end
 
+    def fixed_width_minus_padding
+      @fixed_width_minus_padding ||= @fixed_width && (@fixed_width - padding_left - padding_right)
+    end
+
     def aligned_visible_text
-      @aligned_visible_text ||= if @fixed_width.nil? or fill.nil? or fill.empty?
+      @aligned_visible_text ||= if fill.nil? or fill.empty?
                                   visible_chunk.to_s
                                 else
-                                  case align
-                                  when :left
-                                    visible_chunk.to_s.ljust( @fixed_width + visible_chunk.non_display_length, fill)
-                                  when :center
-                                    visible_chunk.to_s.center(@fixed_width + visible_chunk.non_display_length, fill)
-                                  when :right
-                                    visible_chunk.to_s.rjust( @fixed_width + visible_chunk.non_display_length, fill)
-                                  end
+                                  string = visible_chunk.to_s
+                                  string
+                                    .rjust(left_fill_length(visible_chunk.display_length) + string.length                                                  , fill)
+                                    .ljust(left_fill_length(visible_chunk.display_length) + string.length + right_fill_length(visible_chunk.display_length), fill)
                                 end
     end
 
+    def left_fill_length(display_length)
+      return 0 if fill.nil? or fill.empty?
+      return @fixed_width || 0 if display_length == 0
+
+      [padding_left +
+        if @fixed_width
+          case align
+          when :left
+            0
+          when :center
+            ((fixed_width_minus_padding - display_length) / 2.0).floor
+          when :right
+            fixed_width_minus_padding - display_length
+          end
+        else
+          0
+        end, @fixed_width && @fixed_width - display_length].compact.min
+    end
+
+    def right_fill_length(display_length)
+      return 0 if fill.nil? or fill.empty?
+      return 0 if display_length == 0
+
+      [padding_right +
+        if @fixed_width
+          case align
+          when :left
+            fixed_width_minus_padding - display_length
+          when :center
+            ((fixed_width_minus_padding - display_length) / 2.0).ceil
+          when :right
+            0
+          end
+        else
+          0
+        end, @fixed_width && @fixed_width - display_length].compact.min
+    end
+
     def visible_chunk
-      @visible_chunk ||= if @original_chunk.multiline? || @fixed_width && @original_chunk.display_length > @fixed_width
+      @visible_chunk ||= if @original_chunk.multiline? || fixed_width_minus_padding && @original_chunk.display_length > fixed_width_minus_padding
                            @truncated = true
-                           @original_chunk.slice(@fixed_width ? @fixed_width - omission.display_length : nil).concat(omission).slice!(@fixed_width)
+                           @original_chunk.slice(fixed_width_minus_padding ? fixed_width_minus_padding - omission.display_length : nil).concat(omission).slice!(fixed_width_minus_padding)
                          else
                            @truncated = false
-                           @original_chunk.slice(@fixed_width)
+                           @original_chunk.slice(fixed_width_minus_padding)
                          end
     end
   end

data/lib/monospace_text_formatter/version.rb

@@ -1,3 +1,3 @@
 module MonospaceTextFormatter
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monospace_text_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-18 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83233040 !ruby/object:Gem::Requirement
+  requirement: &71850560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *83233040
+  version_requirements: *71850560
 description: Formats monospaced text into a line or visual box of defined 'width'
   and 'height' boundaries (expressed in number of characters).
 email: jacekmikrut.software@gmail.com