monospace_tag_text_formatter 0.0.3

data/Changelog

@@ -0,0 +1,2 @@
+0.0.3 (February 18, 2012)
+  Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jacek Mikrut
+
+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,66 @@
+MonospaceTagTextFormatter
+=========================
+
+MonospaceTagTextFormatter is a Ruby Gem that is an **extension to [MonospaceTextFormatter](http://github.com/jacekmikrut/monospace_text_formatter)** Ruby Gem.
+
+Features
+--------
+
+* It **treats HTML-like tags as zero-length**, according to an assumption that these tags are going to be eventually removed or replaced before the text is displayed (for instance, they may be converted into color ANSI escape sequences by [AnsiChameleon](http://github.com/jacekmikrut/ansi_chameleon) Ruby Gem).
+
+Thanks to that, for example, the following text will not be truncated:
+
+```ruby
+  MonospaceTagTextFormatter::Line.new("<tag>Some text.</tag>", :width => 10).to_s
+   => "<tag>Some text.</tag>"
+```
+
+* It **treats "&amp;lt;" and "&amp;gt;" character entities as having the length equal to 1 character**, according to an assumption that these entities were used to escape HTML-like tags and are going to be replaced with "&lt;" and "&gt;" signs.
+
+For instance, the following text will not be truncated:
+
+```ruby
+  MonospaceTagTextFormatter::Line.new("&lt;div&gt;Some text.&lt;/div&gt;", :width => 21).to_s
+   => "&lt;div&gt;Some text.&lt;/div&gt;"
+```
+
+* It **ensures that HTML-like tags are properly closed when a text is truncated**.
+
+An example:
+
+```ruby
+  MonospaceTagTextFormatter::Line.new("<tag>This is some text.</tag>", :width => 8).to_s
+   => "<tag>This</tag> ..."
+```
+
+* When a text is wrapped, it **closes opened tags at the end of each line, and reopens them at the beginning of the next line**, according to an assumption that these tags correspond to some text formatting. Thanks to that feature, formatting of each line is preserved.
+
+```ruby
+  MonospaceTagTextFormatter::Box.new("<tag>This is a bit longer text.</tag>", :width => 8).lines
+   => ["<tag>This is</tag> ",
+       "<tag>a bit</tag>   ",
+       "<tag>longer</tag>  ",
+       "<tag>text.</tag>   "]
+```
+
+Installation
+------------
+
+As a Ruby Gem, MonospaceTagTextFormatter can be installed either by running
+
+```bash
+  gem install monospace_tag_text_formatter
+```
+
+or adding
+
+```ruby
+  gem "monospace_tag_text_formatter"
+```
+
+to the Gemfile and then invoking `bundle install`.
+
+License
+-------
+
+License is included in the LICENSE file.

data/lib/monospace_tag_text_formatter.rb

@@ -0,0 +1,12 @@
+require "monospace_tag_text_formatter/version"
+
+require "monospace_text_formatter"
+
+require "monospace_tag_text_formatter/atomic_chunk"
+require "monospace_tag_text_formatter/atomic_chunk_factory"
+require "monospace_tag_text_formatter/chunk"
+require "monospace_tag_text_formatter/line"
+require "monospace_tag_text_formatter/box"
+
+module MonospaceTagTextFormatter
+end

data/lib/monospace_tag_text_formatter/atomic_chunk.rb

@@ -0,0 +1,28 @@
+module MonospaceTagTextFormatter
+  class AtomicChunk < MonospaceTextFormatter::AtomicChunk
+
+    def self.closing_tag(name)
+      new("</#{name}>")
+    end
+
+    def display_length
+      @display_length ||= %W(&lt; &gt;).include?(display_string) ? 1 : super
+    end
+
+    def display_string
+      @display_string ||= @string.gsub(/^<\/?[^\/>][^>]*>$/, '')
+    end
+
+    def opening_tag?
+      !!@string.match(/^<[^\/>][^>]*>$/)
+    end
+
+    def closing_tag?
+      !!@string.match(/^<\/[^>]+>$/)
+    end
+
+    def tag_name
+      m = @string.match(/^<\/?(?<name>\w+)[^>]*>$/) and m[:name].to_sym
+    end
+  end
+end

data/lib/monospace_tag_text_formatter/atomic_chunk_factory.rb

@@ -0,0 +1,16 @@
+module MonospaceTagTextFormatter
+  class AtomicChunkFactory < MonospaceTextFormatter::AtomicChunkFactory
+
+    REGEXP = /^(?:\n|[ \t]+|&lt;|&gt;|<\/?\w+[^>]+>|(?:[^ \t\n<&]|&(?!lt;)(?!gt;))+)/
+
+    def new(string)
+      AtomicChunk.new(string)
+    end
+
+    protected
+
+    def regexp
+      REGEXP
+    end
+  end
+end

data/lib/monospace_tag_text_formatter/box.rb

@@ -0,0 +1,14 @@
+module MonospaceTagTextFormatter
+  class Box < MonospaceTextFormatter::Box
+
+    private
+
+    def string_to_chunk(string)
+      Chunk.new(string)
+    end
+
+    def new_line(string_or_chunk, attrs={})
+      Line.new(string_or_chunk, attrs)
+    end
+  end
+end

data/lib/monospace_tag_text_formatter/chunk.rb

@@ -0,0 +1,38 @@
+module MonospaceTagTextFormatter
+  class Chunk < MonospaceTextFormatter::Chunk
+
+    def slice!(max_display_length=nil, smartly_split_too_long_word=true)
+      sliced_chunk = super
+
+      sliced_chunk.unclosed_tags_data.reverse.each do |data|
+        sliced_chunk.push_atomic_chunk(AtomicChunk.closing_tag(data[:name]))
+        unshift_atomic_chunk(data[:chunk])
+      end
+
+      sliced_chunk
+    end
+
+    protected
+
+    def atomic_chunk_factory
+      @atomic_chunk_factory ||= AtomicChunkFactory.new
+    end
+
+    def unclosed_tags_data
+      opened_tags_data = []
+
+      atomic_chunks.each do |atomic_chunk|
+
+        if atomic_chunk.opening_tag?
+          opened_tags_data.push(:name => atomic_chunk.tag_name, :chunk => atomic_chunk)
+
+        elsif atomic_chunk.closing_tag? && opened_tags_data.last && atomic_chunk.tag_name == opened_tags_data.last[:name]
+          opened_tags_data.pop
+
+        end
+      end
+
+      opened_tags_data
+    end
+  end
+end

data/lib/monospace_tag_text_formatter/line.rb

@@ -0,0 +1,10 @@
+module MonospaceTagTextFormatter
+  class Line < MonospaceTextFormatter::Line
+
+    private
+
+    def string_to_chunk(string)
+      Chunk.new(string)
+    end
+  end
+end

data/lib/monospace_tag_text_formatter/version.rb

@@ -0,0 +1,3 @@
+module MonospaceTagTextFormatter
+  VERSION = "0.0.3"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: monospace_tag_text_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jacek Mikrut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: monospace_text_formatter
+  requirement: &73461590 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *73461590
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &73461330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *73461330
+description: Extension to monospace_text_formatter Gem. Treats HTML-like tags as zero-length
+  and ensures they are properly closed during text truncation/splitting and reopened
+  after line wrapping.
+email: jacekmikrut.software@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/monospace_tag_text_formatter.rb
+- lib/monospace_tag_text_formatter/atomic_chunk_factory.rb
+- lib/monospace_tag_text_formatter/box.rb
+- lib/monospace_tag_text_formatter/version.rb
+- lib/monospace_tag_text_formatter/atomic_chunk.rb
+- lib/monospace_tag_text_formatter/line.rb
+- lib/monospace_tag_text_formatter/chunk.rb
+- README.md
+- LICENSE
+- Changelog
+homepage: http://github.com/jacekmikrut/monospace_tag_text_formatter
+licenses: []
+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.12
+signing_key: 
+specification_version: 3
+summary: Extension to monospace_text_formatter Gem that handles HTML-like tags.
+test_files: []