textutils 0.8.4 → 0.8.5

data/Manifest.txt

@@ -16,6 +16,7 @@ lib/textutils/helper/title_helper.rb
 lib/textutils/helper/unicode_helper.rb
 lib/textutils/helper/value_helper.rb
 lib/textutils/helper/xml_helper.rb
+lib/textutils/page.rb
 lib/textutils/patterns.rb
 lib/textutils/reader/code_reader.rb
 lib/textutils/reader/fixture_reader.rb

data/lib/textutils/page.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+
+##
+## page template class for book production w/ markdown
+##   and static site compiler (e.g. jekyll)
+##
+## todo: move filters to filter for public reuse!!!
+
+module TextUtils
+
+
+############
+## fix:
+###   add some unit tests!!!!!!!!!!!!!!!!!
+###
+
+class Page
+
+  ### convenience helper; use like:
+  ##   Page.open() do |page|
+  ##      page.write( text )
+  ##      page.write( text )
+  ##   end
+
+  def self.open( path, mode, opts={} )
+    page = self.new( path, mode, opts )
+    yield( page )
+    page.close
+  end
+
+  def self.create( path, opts={} )
+    ## todo: check if 'w' is good enough?? do NOT need to add +
+    page = self.new( path, 'w+', opts )
+    yield( page )
+    page.close
+  end
+
+  def self.update( path, opts={} )
+    ## todo: check if 'a' is good enough?? do NOT need to add +
+    page = self.new( path, 'a+', opts )
+    yield( page )
+    page.close
+  end
+
+
+  def initialize( path, mode, opts={} )
+    ## check if folders exists? if not create folder in path
+    FileUtils.mkdir_p( File.dirname(path) )
+
+    @file = File.new( path, mode )
+
+    ## add frontmatter if passed in
+    ## todo: assert check if mode = 'w' and NOT 'a' !!!
+    @file.write render_frontmatter( opts[:frontmatter] )  if opts[:frontmatter]
+  end
+
+  def write( text )
+    @file.write( text )
+  end
+
+  def close
+    @file.close
+  end
+
+private
+
+###########################
+#  helpers
+#   - make public for reuse !!!!!
+
+def render_frontmatter( h )
+  buf = ''
+  buf += "---\n"
+
+  h.each do |key,value|
+    buf += "#{key}: #{value}\n"
+  end
+
+  buf += "---\n\n"
+  buf
+end
+
+end # class Page
+
+
+class PageTemplate
+
+
+###
+## todo: what is the best convention for loading file and handling string
+## for now it its:
+#
+#  PageTemplate.read( 'to/path ' )  or     --- use load ???? instead of read??
+#  PageTemplate.new( 'template content'  )
+
+
+def self.read( path )
+  self.new( File.read_utf8( path ) )
+end
+
+
+def initialize( tmpl )
+  @tmpl = tmpl.dup   # make a copy; just to be sure no one will change text
+end
+
+def render( ctx )
+# note: erb offers the following trim modes:
+#  1) <> omit newline for lines starting with <% and ending in %>
+#  2)  >  omit newline for lines ending in %>
+#  3)  omit blank lines ending in -%>
+  ## run filters
+  tmpl = remove_html_comments( @tmpl )
+  tmpl = remove_blanks( tmpl )
+
+  tmpl = django_to_erb( tmpl )  ## allow django/jinja style templates
+
+  tmpl = remove_leading_spaces( tmpl )
+  tmpl = concat_lines( tmpl )
+
+  text = ERB.new( tmpl, nil, '<>' ).result( ctx )
+
+  ### text = cleanup_newlines( text )
+  text
+end
+
+#######################
+#  filters
+#   - use better names and make public for reuse!!!!
+
+def django_to_erb( text )
+  ## convert django style markers to erb style marker e.g
+  #  {% %} becomes <% %>  -- supports multi-line
+  #  {{ }} becomes <%= %>  - does NOT support multi-line
+
+  ## comments (support multi-line)
+  text = text.gsub( /\{#(.+?)#\}/m ) do |_|
+   "<%# #{1} %>"
+  end
+
+  text = text.gsub( /\{%(.+?)%\}/m ) do |_|
+    ## note: also replace newlines w/  %>\n<%  to split
+    #   multi-line stmts into single-line stmts
+    # lets us use
+    # {%
+    #  %} will become
+    # <%  %>
+    # <%  %>
+    "<% #{$1} %>".gsub( "\n", " %>\n<% " )
+  end
+
+  # note: for now {{ }} will NOT support multi-line
+  text = text.gsub( /\{\{(.+?)\}\}/ ) do |_|
+    "<%= #{$1} %>"
+  end
+
+  text
+end
+
+def remove_html_comments( text )
+  text.gsub( /<!--.+?-->/, '' )
+end
+
+def remove_leading_spaces( text )
+  # remove leading spaces if less than four !!!
+  text.gsub( /^[ \t]+(?![ \t])/, '' )    # use negative regex lookahead e.g. (?!)
+end
+
+def remove_blanks( text )
+  # remove lines only with  ..
+  text.gsub( /^[ \t]*\.{2}[ \t]*\n/, '' )
+end
+
+def cleanup_newlines( text )
+  # remove all blank lines that go over three
+  text.gsub( /\n{4,}/, "\n\n\n" )
+end
+
+
+def concat_lines( text )
+  #  lines ending with  ++  will get newlines get removed
+  # e.g.
+  # >|   hello1 ++
+  # >1   hello2
+  #  becomes
+  # >|   hello1 hello2
+  
+  #
+  # note: do NOT use \s - will include \n (newline) ??
+  
+  text.gsub( /[ \t]+\+{2}[ \t]*\n[ \t]*/, ' ' )  # note: replace with single space
+end
+
+
+end # class PageTemplate
+
+end # module TextUtils
+

data/lib/textutils/utils.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-
-
 module TextUtils
   # make helpers available as class methods e.g. TextUtils.convert_unicode_dashes_to_plain_ascii
   extend UnicodeHelper
@@ -33,7 +31,7 @@ end
 
 
 def find_data_path_from_gemfile_gitref( name )
-  puts "[debug] find_data_path( name='#{name}' )..."
+  puts "[textutils] find_data_path( name='#{name}' )..."
   puts "load path:"
   pp $LOAD_PATH
 

data/lib/textutils/version.rb

@@ -1,7 +1,8 @@
 
 module TextUtils
 
-  VERSION = '0.8.4'
+  VERSION = '0.8.5'
 
 end   # module TextUtils
 
+

data/lib/textutils.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 
 # core and stlibs
 
@@ -43,3 +45,22 @@ require 'textutils/reader/fixture_reader'
 
 require 'textutils/classifier'
 
+require 'textutils/page'   # for book pages and page templates
+
+
+
+module TextUtils
+
+  def self.banner
+    "textutils/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
+  end
+
+end
+
+
+
+puts TextUtils.banner   if $DEBUG    # say hello

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textutils
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &20379624 !ruby/object:Gem::Requirement
+  requirement: &21250380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *20379624
+  version_requirements: *21250380
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &20377728 !ruby/object:Gem::Requirement
+  requirement: &21250032 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *20377728
+  version_requirements: *21250032
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &20376972 !ruby/object:Gem::Requirement
+  requirement: &21249564 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.7'
   type: :development
   prerelease: false
-  version_requirements: *20376972
+  version_requirements: *21249564
 description: textutils - Text Filters, Helpers, Readers and More
 email: ruby-talk@ruby-lang.org
 executables: []
@@ -71,6 +71,7 @@ files:
 - lib/textutils/helper/unicode_helper.rb
 - lib/textutils/helper/value_helper.rb
 - lib/textutils/helper/xml_helper.rb
+- lib/textutils/page.rb
 - lib/textutils/patterns.rb
 - lib/textutils/reader/code_reader.rb
 - lib/textutils/reader/fixture_reader.rb