textutils 0.0.1 → 0.1.0

data/Manifest.txt

@@ -3,3 +3,4 @@ Manifest.txt
 README.markdown
 Rakefile
 lib/textutils.rb
+lib/textutils/filter/comment_filter.rb

data/README.markdown

@@ -1,9 +1,73 @@
 # `textutils` - Text Filters 'n' Helpers in Ruby
 
-## Usage
+## Filters
+
+### `comments_percent_style`
+
+Strip comments lines starting with percent (that is, %). Example:
+
+    %%%%%%%%%%%%%%%%
+    % Some Headers
+    
+    Title: Web Services REST-Style: Universal Identifiers, Formats & Protocols
+    
+    %%%%%%%%%%%%%%%%%%%
+    % Some Extra CSS
+    
+    table { width: 100%; }
+    table#restspeak th:nth-child(1) { width: 20%; }
+    table#restspeak th:nth-child(2) { width: 5%; }
+
+Becomes
+
+    Title: Web Services REST-Style: Universal Identifiers, Formats & Protocols
+    
+    table { width: 100%; }
+    table#restspeak th:nth-child(1) { width: 20%; }
+    table#restspeak th:nth-child(2) { width: 5%; }
+
+Also supports multiline comments with `%begin`|`comment`|`comments`/`%end` pairs. Example:
+
+    %begin
+    Using modern browser such as Firefox, Chrome and Safari you can
+    now theme your slide shows using using "loss-free" vector graphics
+    in plain old CSS. Thanks to gradient support in backgrounds in CSS3.
+    %end
+
+or
+
+    %comment
+    Using modern browser such as Firefox, Chrome and Safari you can
+    now theme your slide shows using using "loss-free" vector graphics
+    in plain old CSS. Thanks to gradient support in backgrounds in CSS3.
+    %end
+
+Note: As a shortcut using a single `%end` directive (that is, without a matching `%begin`)
+will skip everything until the end of the document.
+
+
+### `skip_end_directive`
+
+Skip/comment out blocks in your document by
+enclosing with `__SKIP__`/`__END__`. Example:
+
+    __SKIP__
+    Using modern browser such as Firefox, Chrome and Safari you can
+    now theme your slide shows using using "loss-free" vector graphics
+    in plain old CSS. Thanks to gradient support in backgrounds in CSS3.
+    __END__
+
+As a shortcut if you just use `__END__` (without `__SKIP__`) the filter
+will skip everything from `__END__` until the end of the document.
+
 
 TBD
 
+## Helpers
+
+TBD
+
+
 ## Install
 
 Just install the gem:
@@ -15,9 +79,10 @@ Just install the gem:
 
 The [`slideshow`](http://slideshow.rubyforge.org) (also known as Slide Show (S9)) gem
 that lets you create slide shows
-and author slides in plain text using a wiki-style markup language that's easy-to-write and easy-to-read
-ships with the `props` gem.
+and author slides in plain text using a wiki-style markup language that's easy-to-write and easy-to-read.
 
+The [`markdown`](http://geraldb.github.com/markdown) gem that lets you use your markdown library
+of choice. 
 
 ## Alternatives
 

data/lib/textutils.rb

@@ -8,8 +8,13 @@ require 'optparse'
 require 'fileutils'
 
 
+# our own code
+
+require 'textutils/filter/comment_filter'
+
+
 module TextUtils
 
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 
-end   # class TextUtils
+end   # module TextUtils

data/lib/textutils/filter/comment_filter.rb

@@ -0,0 +1,60 @@
+
+module TextUtils
+  module Filter
+
+def comments_percent_style( content, options={} )
+
+    # remove comments
+    # % comments
+    # %begin multiline comment
+    # %end multiline comment
+
+    # track statistics
+    comments_multi  = 0
+    comments_single = 0
+    comments_end    = 0
+
+    # remove multi-line comments
+    content.gsub!(/^%(begin|comment|comments).*?%end/m) do |match|
+      comments_multi += 1
+      ""
+    end
+    
+     # remove everyting starting w/ %end (note, can only be once in file) 
+    content.sub!(/^%end.*/m) do |match|
+      comments_end += 1
+      ""
+    end
+
+    # hack/note: 
+    #  note multi-line erb expressions/stmts might cause trouble
+    #  
+    #  %> gets escaped as special case (not treated as comment)
+    # <%
+    #   whatever
+    # %> <!-- trouble here; would get removed as comment!
+    #  todo: issue warning?
+    
+    # remove single-line comments    
+    content.gsub!(/(^%$)|(^%[^>].*)/ ) do |match|
+      comments_single += 1
+      ""
+    end
+    
+    puts "  Removing %-comments (#{comments_single} lines, " +
+       "#{comments_multi} begin/end-blocks, #{comments_end} end-blocks)..."
+    
+    content
+  end
+
+  def skip_end_directive( content, options={} )
+    # codex-style __SKIP__, __END__ directive
+    # ruby note: .*? is non-greedy (shortest-possible) regex match
+    content.gsub!(/__SKIP__.*?__END__/m, '')
+    content.sub!(/__END__.*/m, '')
+    content
+  end
+
+
+  end  # module Filter
+end   # module TextUtils

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: textutils
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -61,6 +61,7 @@ files:
 - README.markdown
 - Rakefile
 - lib/textutils.rb
+- lib/textutils/filter/comment_filter.rb
 homepage: http://geraldb.github.com/textutils
 licenses: []