PrettyComment 0.1.2 → 0.1.3

data/README.md

@@ -0,0 +1,191 @@
+PrettyComment
+=============
+
+Ruby gem to pretty-print status messages and comments to the terminal. The text is formatted to fill the full width
+of the terminal.
+
+
+Usage:
+------
+
+### Headers:
+```
+puts PrettyComment.h1("To be or not to be")
+puts
+puts PrettyComment.h2("That is the question")
+puts
+puts PrettyComment.h3("Whether 'tis nobler in the mind")
+```
+
+will result in:
+
+```
+################################################################################
+# To be or not to be                                                           #
+################################################################################
+
+#==============================================================================#
+# That is the question                                                         #
+#==============================================================================#
+
+#------------------------------------------------------------------------------#
+# Whether 'tis nobler in the mind                                              #
+#------------------------------------------------------------------------------#
+```
+
+### Text Formatting:
+
+```
+Prefix = "Summary:"
+PrefixOnlyFirstLine = true
+puts PrettyComment.format_line(Summary, Prefix, PrefixOnlyFirstLine)
+```
+
+will result in:
+
+```
+Summary: The play is set in Denmark at the Castle Elsinore. The King Hamlet     
+         has just died and his brother, Claudius, has replaced him and also     
+         married his dead brother's wife, Gertrude. In the second scene of ACT  
+         I, Claudius addresses the court on his recent marriage to Gertrude,    
+         on political matters and also gives his blessings to Laertes, the son  
+         of the Lord Chamberlain Polonius, who is about to leave for France.    
+         He then turns to Hamlet, who is still mourning his father and doesn't  
+         seem to get over it. Even if it's natural to mourn his father's        
+         death, he argues, he should get over it.  
+```
+
+### Separators:
+```
+puts PrettyComment.separator
+puts PrettyComment.small_separator
+puts PrettyComment.separator '*'
+```
+
+```
+#==============================================================================#
+#------------------------------------------------------------------------------#
+#******************************************************************************#
+```
+
+### Boxes:
+``` 
+a_box = PrettyComment::Box.new do
+  para "Summary:"
+  hline '-'
+  para "The play is set in Denmark at the Castle Elsinore. The King Hamlet has just died and his brother, Claudius, has replaced him and also married his dead brother's wife, Gertrude. In the second scene of ACT I, Claudius addresses the court on his recent marriage to Gertrude, on political matters and also gives his blessings to Laertes, the son of the Lord Chamberlain Polonius, who is about to leave for France. He then turns to Hamlet, who is still mourning his father and doesn't seem to get over it. Even if it's natural to mourn his father's death, he argues, he should get over it."
+  h3   "Dramatis Personae:"
+  para "Hamlet: Son of the former king, and nephew of the present King\n"
+  para "Claudius: King of Denmark, Hamlet's uncle.\n"
+  para "Gertrude: Queen of Denmark, and mother to Hamlet\n"
+  para "Polonius: Lord Chamberlain\n"
+  para "Ophelia: Daughter to Polonius\n"
+  para "Horatio: Friend to Hamlet\n"
+  para "Laertes: Son to Polonius\n"
+  para "Voltimand, Cornelius: Courtiers\n"
+  para "Rosencrantz, Guildenstern: Courtiers, friends to Hamlet\n"
+  para "Osric: a Courtier\n"
+  para "Marcellus: an Officer\n"
+  para "Bernardo: an Officer\n"
+  para "Francisco: a Soldier\n"
+  para "Reynaldo: Servant to Polonius\n"
+  para "Ghost of Hamlet's Father\n"
+  para "Fortinbras: Prince of Norway\n"
+  para "Gravediggers: A sexton and a clown\n"
+  para "Player King, Player Queen, Lucianus, etc.: Players\n"
+end  
+```
+
+will result in:
+```
+#==============================================================================#
+# Summary:                                                                     #
+#------------------------------------------------------------------------------#
+# The play is set in Denmark at the Castle Elsinore. The King Hamlet has just  #
+# died and his brother, Claudius, has replaced him and also married his dead   #
+# brother's wife, Gertrude. In the second scene of ACT I, Claudius addresses   #
+# the court on his recent marriage to Gertrude, on political matters and also  #
+# gives his blessings to Laertes, the son of the Lord Chamberlain Polonius,    #
+# who is about to leave for France. He then turns to Hamlet, who is still      #
+# mourning his father and doesn't seem to get over it. Even if it's natural    #
+# to mourn his father's death, he argues, he should get over it.               #
+#------------------------------------------------------------------------------#
+# Dramatis Personae:                                                           #
+#------------------------------------------------------------------------------#
+# Hamlet: Son of the former king, and nephew of the present King               #
+# Claudius: King of Denmark, Hamlet's uncle.                                   #
+# Gertrude: Queen of Denmark, and mother to Hamlet                             #
+# Polonius: Lord Chamberlain                                                   #
+# Ophelia: Daughter to Polonius                                                #
+# Horatio: Friend to Hamlet                                                    #
+# Laertes: Son to Polonius                                                     #
+# Voltimand, Cornelius: Courtiers                                              #
+# Rosencrantz, Guildenstern: Courtiers, friends to Hamlet                      #
+# Osric: a Courtier                                                            #
+# Marcellus: an Officer                                                        #
+# Bernardo: an Officer                                                         #
+# Francisco: a Soldier                                                         #
+# Reynaldo: Servant to Polonius                                                #
+# Ghost of Hamlet's Father                                                     #
+# Fortinbras: Prince of Norway                                                 #
+# Gravediggers: A sexton and a clown                                           #
+# Player King, Player Queen, Lucianus, etc.: Players                           #
+#==============================================================================#
+```
+
+###Styles:
+
+```
+puts PrettyComment::Box.new {
+  box_style  'c++'
+  box_width  120
+  para "This is a long c++ source comment box."
+}
+puts
+
+puts PrettyComment::Box.new {
+  box_style  'latex'
+  para "This is a latex comment box."
+}
+puts
+
+puts PrettyComment::Box.new {
+  box_left '|'
+  box_right '/'
+  box_top '*'
+  box_bottom '#'
+  para "This is a custom box."
+}
+```
+
+will result in:
+
+
+```
+//====================================================================================================================//
+// This is a long c++ source comment box.                                                                                  //
+//====================================================================================================================//
+
+%==============================================================================%
+% This is a latex comment box.                                                 %
+%==============================================================================%
+
+|******************************************************************************/
+| This is a free-form box.                                                     /
+|##############################################################################/
+```
+
+
+Currently the following styles are implemented:
+ * default for terminal, ruby, python etc.
+ * c++
+ * latex
+ 
+Styles can also be set globally on the Box class:
+
+```
+PrettyComment::Box::style = 'c++'
+PrettyComment::Box::width = 120
+PrettyComment::Box::left = '#'
+etc.
+```

data/lib/PrettyComment.rb

@@ -5,9 +5,35 @@ require 'terminfo'
 #======================================================================================================================#
 
 module PrettyComment
+@@width = TermInfo.screen_size[1]
+@@styles = {
+  'default' => { :left => '#',  :right => '#' }, 
+  'c++'     => { :left => '//', :right => '//'},
+  'latex'   => { :left => '%',  :right => '%'} 
+}
+  
+#======================================================================================================================#
+
+def self.width
+  @@width
+end
 
 
-#======================================================================================================================#
+#----------------------------------------------------------------------------------------------------------------------#
+
+def self.width=(a_width)
+  @@width = a_width
+end
+
+
+#----------------------------------------------------------------------------------------------------------------------#
+
+def self.styles
+  @@styles
+end
+
+
+#----------------------------------------------------------------------------------------------------------------------#
 
 def self.terminal_width
   TermInfo.screen_size[1]
@@ -16,8 +42,8 @@ end
 
 #----------------------------------------------------------------------------------------------------------------------#
 
-def self.separator(char='=', left='#', right='#')
-  left + (char * (terminal_width - left.length - right.length)) + right
+def self.separator(char='=', left='#', right='#', width=@@width)
+  left + (char * (width - left.length - right.length)) + right
 end  
 
 
@@ -31,7 +57,7 @@ end
 #----------------------------------------------------------------------------------------------------------------------#
 
 def self.comment(comment)
-  pad_string("\# #{comment}", "#", terminal_width)
+  pad_string("\# #{comment}", "#", width)
 end
 
 
@@ -51,9 +77,9 @@ end
 
 #----------------------------------------------------------------------------------------------------------------------#  
   
-def self.format_line(text, prefix, only_first_line_prefix=false, suffix='', alternate_prefix='')
+def self.format_line(text, prefix, only_first_line_prefix=false, suffix='', alternate_prefix='', width=@@width)
   the_suffix = suffix.length ? " " + suffix : ""
-  text_width = terminal_width - 1 - the_suffix.length
+  text_width = width - 1 - the_suffix.length
   title_array = text.split(" ")
   result = []
   current_line = prefix.dup
@@ -64,12 +90,12 @@ def self.format_line(text, prefix, only_first_line_prefix=false, suffix='', alte
   
   title_array.each do |w|
     (current_line.length + w.length + 1 > text_width) \
-      && result << pad_string(current_line, suffix, terminal_width) \
+      && result << pad_string(current_line, suffix, width) \
       && current_line = current_prefix.dup
     current_line << " " << w
   end
   
-  current_line.length > current_prefix.length && result << pad_string(current_line, suffix, terminal_width)
+  current_line.length > current_prefix.length && result << pad_string(current_line, suffix, width)
   result.join("\n")
 end
 
@@ -105,20 +131,119 @@ end
 #----------------------------------------------------------------------------------------------------------------------#  
 
 class Box
-  attr_accessor :left, :right, :top, :bottom
+  class << self
+    attr_accessor :right, :top, :bottom, :width
+  end
+  @@left = @@right = '#'
+  @@top = @@bottom = '='
+  @@width = PrettyComment::width
+
+  attr_accessor :left, :right, :top, :bottom, :width
   def initialize *a, &b
-    @left = @right = '#'
-    @top = @bottom = '='
-    @width = PrettyComment.terminal_width
+    @left = @@left
+    @right = @@right
+    @top = @@top
+    @bottom = @@bottom
+    @width = @@width
     @linebuffer = []
     cloaker(&b).bind(self).call(*a) if b
   end
 
 
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.left=(a_left)
+    @@left = a_left
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.right=(a_right)
+    @@right = a_right
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.top=(a_top)
+    @@top = a_top
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.bottom=(a_bottom)
+    @@bottom = a_bottom
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.width=(a_width)
+    @@width = a_width
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def self.style=(a_style)
+    style = PrettyComment::styles[a_style]
+    
+    @@left = style[:left]
+    @@right = style[:right]
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_style(a_style)
+    style = PrettyComment.styles[a_style]
+    
+    @left = style[:left]
+    @right = style[:right]
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_left(a_left)
+    @left = a_left
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_right(a_right)
+    @right = a_right
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_top(a_top)
+    @top = a_top
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_bottom(a_bottom)
+    @bottom = a_bottom
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def box_width(a_width)
+    @width = a_width
+  end
+
+
 #----------------------------------------------------------------------------------------------------------------------#  
 
   def para(a_string)
-    @linebuffer << PrettyComment::format_line(a_string, left, false, right)
+    @linebuffer << PrettyComment::format_line(a_string, left, false, right, '', width)
   end
 
 
@@ -133,7 +258,7 @@ class Box
 
   def heading(a_string, a_char)
     @linebuffer << PrettyComment.separator(a_char, left, right) 
-    @linebuffer << PrettyComment::format_line(a_string, left, false, right)
+    @linebuffer << PrettyComment::format_line(a_string, left, false, right, '', width)
     @linebuffer << PrettyComment.separator(a_char, left, right) 
   end
 
@@ -163,9 +288,19 @@ class Box
 
   def to_s
     newline = "\n"
-    PrettyComment::separator(top) + newline + @linebuffer.join("\n") + newline + PrettyComment::separator(bottom)
+    result =  PrettyComment::separator(top, left, right, width) << newline
+    result << @linebuffer.join("\n") << newline
+    result << PrettyComment::separator(bottom, left, right, width)
+  end
+
+
+#----------------------------------------------------------------------------------------------------------------------#  
+
+  def inspect
+    to_s
   end
 
+
 #----------------------------------------------------------------------------------------------------------------------#  
 
   def cloaker &b

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: PrettyComment
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-terminfo
@@ -27,13 +27,18 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.1.1
-description: Formatting of status messages and comments for terminal output.
+description: ! 'Formatting of status messages and comments for terminal output and
+  source files.
+
+'
 email: wolfgang.steiner@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - lib/PrettyComment.rb
+- README.md
 homepage: https://github.com/WolfgangSteiner/PrettyComment
 licenses: []
 post_install_message: