pink_shirt 0.0.1 → 0.0.2

data/changelog

@@ -0,0 +1,4 @@
+0.0.2 
+  whitespace and documentation formatting
+0.0.1 
+ intial release

data/lib/pink_shirt/attributes.rb

@@ -1,33 +1,34 @@
 class PinkShirt
-  # Attributes
-  # -------------------------
+  # = Attributes
+  # 
   # the sax parser passes an array of attributes along with each tag
   # attrs = ['href', 'http://www.example.com', 'style', 'background-color: snake;']
   #
   # Textile displays attributes in a certain way
   # 
-  # USAGE
-  # ---------------------------
+  # = USAGE
+  # 
   # Attributes.new(attrs).write
   #
+  # 
+  # * colspan=2                 => \2
+  # * rowspan=3                 => /3
+  # * style='padding-left:1em'  => (
+  # * style='padding-right:2em' => ))
+  # * style='text-align:right'  => >
+  # * style='text-align:left'   => <
+  # * style='text-align:center' => =
+  # * style='text-align:justify'=> <>
+  # * class = 'panthers'        => (panthers)
+  # * id = 'banner'             => (#banner)
+  # * class='this' id='that'    => (this#that)
+  # * lang='fr'                 => [fr]
+  # * style='color:red'         => {color:red}
+  #
   #
-  # colspan=2                 => \2
-  # rowspan=3                 => /3
-  # style='padding-left:1em'  => (
-  # style='padding-right:2em' => ))
-  # style='text-align:right'  => >
-  # style='text-align:left'   => <
-  # style='text-align:center' => =
-  # style='text-align:justify'=> <>
-  # class = 'panthers'        => (panthers)
-  # id = 'banner'             => (#banner)
-  # class='this' id='that'    => (this#that)
-  # lang='fr'                 => [fr]
-  # style='color:red'         => {color:red}
-  
-  
   class Attributes
-
+    # @param attrs [Array] formatted [key, value, key, value]
+    # 
     def initialize(attrs)
       @attrs = attrs
       @attrs_hash  = Hash[attrs]
@@ -44,7 +45,6 @@ class PinkShirt
       @styles_hash ||= {}
     end
 
-
     def write
       add = []
       add << colspan
@@ -56,11 +56,13 @@ class PinkShirt
       add << lang
       out = add.join
       return nil if out == ""
+      
       out
     end
 
     def parse_styles
       return nil unless attrs['style']
+      
       rules_list = attrs['style'].split(";").map{|rule|
         rule.split(":")
       }
@@ -89,13 +91,12 @@ class PinkShirt
       end
 
       nudges << text_align
-
       nudges
     end
 
     def steal_padding
-
       return nil unless attrs['style']
+      
       left = case styles.delete('padding-left')
       when '1em'; "(" ;
       when '2em'; "((";
@@ -111,11 +112,11 @@ class PinkShirt
       end
 
       padding = "#{left}#{right}"
-
     end
 
     def colspan
       return nil unless attrs['colspan']
+      
       width = attrs['colspan']
       colspan = ""
       colspan << "\\" #literal backslash
@@ -125,6 +126,7 @@ class PinkShirt
 
     def rowspan
       return nil unless attrs['rowspan']
+      
       height = attrs['rowspan']
       colspan = '/' + "#{height}" if height
     end
@@ -142,6 +144,7 @@ class PinkShirt
       klass = attrs['class']
       id    = attrs['id']
       return nil unless klass || id
+      
       output  = ""
       output += "("
       output += klass if klass
@@ -160,6 +163,7 @@ class PinkShirt
 
     def lang
       return nil unless attrs.include?('lang')
+      
       output  = ""
       output += "["
       output += attrs['lang']

data/lib/pink_shirt/entities.rb

@@ -1,26 +1,24 @@
 class PinkShirt
   # Gets rid of smart quotes, dashes and some pesky unicode
-  # Usage
-  # ---------------------
-  # Entities.sanitize(input)
+  # = Usage
+  #   Entities.sanitize(input)
   #
   class Entities
     REPLACEMENTS = {
-      8217 => "'", #single quote
-      8216 => "'", #left single quote
-      8220 => '"', #right double quote
-      8221 => '"', #left double quote
-      8211 => "-", #endash
-      8212 => "--", #emdash
+      8217 => "'",   #single quote
+      8216 => "'",   #left single quote
+      8220 => '"',   #right double quote
+      8221 => '"',   #left double quote
+      8211 => "-",   #endash
+      8212 => "--",  #emdash
       8230 => "...", #ellipsis
-      215  => "x", #times
-      8242 => "'", #inch
+      215  => "x",   #times
+      8242 => "'",   #inch
       174  => "(r)", #registered trademark
-      8482 => "(tm)", # trademark
+      8482 => "(tm)",# trademark
       169  => "(c)", #copyright
     }
 
-
     def self.sanitize(string)
       string_chars =  string.unpack("U*")
       string_chars.map! {|x| REPLACEMENTS[x] ? REPLACEMENTS[x].unpack('U*') : x}

data/lib/pink_shirt/output.rb

@@ -1,21 +1,23 @@
 class PinkShirt
-  # 
+
+  ##
   # Nokogiri::Sax builds output as a long stream.
   # Output collects all the writes as an array, and then joins them when required
   # you can also lock it for writing.
   # 
-  # Usage
-  # ------------------------
-  # stream = Output.new
-  # stream << 'goods... '
-  # stream.inspect #=> ['goods... ']
-  # stream.lock('suspicious tag')
-  # stream << 'bad stuff'
-  # stream.inspect #=> ['goods... ']
-  # stream.unlock
-  # stream << 'good again'
-  # stream.inspect #=> ['goods... ', 'good again']
+  # = Usage
+  # 
+  #  stream = Output.new
+  #  stream << 'goods... '
+  #  stream.inspect #=> ['goods... ']
+  #  stream.lock('suspicious tag')
+  #  stream << 'bad stuff'
+  #  stream.inspect #=> ['goods... ']
+  #  stream.unlock
+  #  stream << 'good again'
+  #  stream.inspect #=> ['goods... ', 'good again']
   #
+
   class Output
     def initialize
       @contents = []

data/lib/pink_shirt/sax/acronym.rb

@@ -1,13 +1,16 @@
 class PinkShirt
   class SAX::Acronym < SAX::Base
     TAGS = %(acronym)
+
     def initialize(*args)
       @current_acronym = []
       super
     end
+
     def start_acronym attrs
       @current_acronym << attrs['title']
     end
+
     def end_acronym
       @output << "(#{@current_acronym.pop})"
     end

data/lib/pink_shirt/sax/base.rb

@@ -1,6 +1,7 @@
 class PinkShirt
   class SAX::Base
     TAGS = []
+
     def initialize(input, flags)
       @output = input
       @flags  = flags

data/lib/pink_shirt/sax/basic.rb

@@ -2,6 +2,7 @@ class PinkShirt
   class SAX::Basic < SAX::Base
     TAGS = %w(strong b em i cite del ins sub sup span code)
     attr_accessor :nospan
+
     def start_strong attrs
       @output << "*"
       @output << add_attributes(attrs) if add_attributes(attrs)
@@ -11,7 +12,6 @@ class PinkShirt
 
     def end_strong
       @output << "*"
-
     end
 
     def start_b attrs

data/lib/pink_shirt/sax/block_level.rb

@@ -1,6 +1,7 @@
 class PinkShirt
   class SAX::BlockLevel < SAX::Base
     TAGS = %w(p br h1 h2 h3 h4 h5 h6 div blockquote)
+
     def start_p attrs
       @output << "p#{add_attributes(attrs)}. " if add_attributes(attrs)
     end

data/lib/pink_shirt/sax/boiler_plate.rb

@@ -1,6 +1,7 @@
 class PinkShirt
   class SAX::BoilerPlate < SAX::Base
     TAGS = %w(html body head)
+
     def start_html(attrs); end
     def end_html; end
     def start_body(attrs); end

data/lib/pink_shirt/sax/images.rb

@@ -1,6 +1,7 @@
 class PinkShirt
   class SAX::Images < SAX::Base
     TAGS = %(img)
+    
     def start_img attrs
       title   = attrs['alt'] || attrs['title']
       title   = nil if title == "" || title == " "
@@ -10,6 +11,7 @@ class PinkShirt
       image  += "!"
       @output << image
     end
+    
     def end_img
 
     end

data/lib/pink_shirt/sax/links.rb

@@ -1,6 +1,7 @@
 class PinkShirt
   class SAX::Links < SAX::Base
     TAGS = %(a)
+    
     def start_a attrs
       @link_info = attrs
       link  = ""
@@ -8,6 +9,7 @@ class PinkShirt
       link += "(#{attrs['class']}). " if attrs['class']
       @output << link
     end
+    
     def end_a
       link  = ""
       link += " (#{@link_info['title']})" if @link_info['title']

data/lib/pink_shirt/sax/lists.rb

@@ -1,11 +1,13 @@
 class PinkShirt
   class SAX::Lists < SAX::Base
     TAGS = %w(ul ol li dl dt dd)
+
     def initialize(*args)
       @last_depth = 0
       @nesting = []
       super
     end
+
     def start_ul(attrs)
       @nesting.push "ul"
       @in_ul = true

data/lib/pink_shirt/sax/preformatted.rb

@@ -1,11 +1,12 @@
-class PinkShirt
-  
+class PinkShirt  
   class SAX::Preformatted < SAX::Base
     TAGS = %(pre)
+
     def start_pre attrs
       @flags.pre = true
       @output << "pre#{add_attributes(attrs)}. "
     end
+
     def end_pre
       @flags.pre = false
     end

data/lib/pink_shirt/sax/script.rb

@@ -2,9 +2,11 @@ class PinkShirt
   # One does not textilize the contents of script tags, it is not done.
   class SAX::Script < SAX::Base
     TAGS = %(script)
+
     def start_script(attrs)
       @output.lock('script')
     end
+
     def end_script
       @output.unlock
     end

data/lib/pink_shirt/version.rb

@@ -1,3 +1,3 @@
 class PinkShirt
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/pink_shirt.rb

@@ -4,24 +4,23 @@ require 'nokogiri'
 # PinkShirt Undoes RedCloth
 # 
 #
-# Usage
-# ---------------------------------
-# html = "stuff <b>goood</b> stuff" 
-# PinkShirt.new('stuff').to_textile
+# = Usage
+#   html = "stuff <b>goood</b> stuff" 
+#   PinkShirt.new('stuff').to_textile
 #
-# Internals
-# ----------------------------------
+# = Internals
+# 
 # PinkShirt uses a sax parser built on nokogiri
-
-
+#
 class PinkShirt
-  
+  # @param html [String]
   def initialize(html)
     @html = html
     @sax_syntax = PinkShirt::SAX.new
     @parser     = Nokogiri::HTML::SAX::Parser.new(@sax_syntax)
   end
 
+  # renders to textile
   def to_textile
     @parser.parse(@html)do |config|
       config.replace_entities = false

data/pink_shirt.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["graemeworthy@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{An Html to Textile Converter}
-  s.description = %q{Converts Html to Textile, or as some say 'html2textile', it's built on nokogiri''}
+  s.description = %q{Converts Html to Textile, or as some say 'html2textile', it's built on nokogiri}
 
   s.rubyforge_project = "pink_shirt"
 

data/spec/textile-spec/phrase_modifiers.yaml

@@ -10,22 +10,22 @@ Stress emphasis:
       text is typically styled as __italics__.
     input: You didn't actually _believe_ her, did you?
     output: <p>You didn&#8217;t actually <em>believe</em> her, did you?</p>
-# Stylistic offset:
-#   Stylistic offset:
-#     desc: To stylistically differentiate a word or phrase from the surrounding text
-#       *without conveying any extra importance*, place two asterisks on either side.  Uses
-#       are key words in a document abstract, product names in a review, or other
-#       spans of text whose typical typographic presentation is boldened.
-#     input: |-
-#       Search results for **Textile**:
+Stylistic offset in links:
+  Stylistic offset in links:
+    desc: To stylistically differentiate a word or phrase from the surrounding text
+      *without conveying any extra importance*, place two asterisks on either side.  Uses
+      are key words in a document abstract, product names in a review, or other
+      spans of text whose typical typographic presentation is boldened.
+    input: |-
+      Search results for **Textile**:
 
-#       h4. ["**Textile** (markup language) - Wikipedia":http://en.wikipedia.org/wiki/Textile_(markup_language)]
+      h4. "**Textile** (markup language) - Wikipedia":http://en.wikipedia.org/wiki/Textile_(markup_language)
 
-#       **Textile** is a lightweight markup language originally developed by Dean Allen and billed as a "humane Web text generator".  **Textile** converts its marked-up text ...
-#     output: |-
-#       <p>Search results for <b>Textile</b>:</p>
-#       <h4><a href="http://en.wikipedia.org/wiki/Textile_(markup_language)"><b>Textile</b> (markup language) &#8211; Wikipedia</a></h4>
-#       <p><b>Textile</b> is a lightweight markup language originally developed by Dean Allen and billed as a &#8220;humane Web text generator&#8221;.  <b>Textile</b> converts its marked-up text &#8230;</p>
+      **Textile** is a lightweight markup language originally developed by Dean Allen and billed as a "humane Web text generator".  **Textile** converts its marked-up text ...
+    output: |-
+      <p>Search results for <b>Textile</b>:</p>
+      <h4><a href="http://en.wikipedia.org/wiki/Textile_(markup_language)"><b>Textile</b> (markup language) &#8211; Wikipedia</a></h4>
+      <p><b>Textile</b> is a lightweight markup language originally developed by Dean Allen and billed as a &#8220;humane Web text generator&#8221;.  <b>Textile</b> converts its marked-up text &#8230;</p>
 Stylistic offset:
   Stylistic offset:
     desc: To stylistically differentiate a word or phrase from the surrounding text

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pink_shirt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70119661660080 !ruby/object:Gem::Requirement
+  requirement: &70218567294800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70119661660080
+  version_requirements: *70218567294800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70119661659440 !ruby/object:Gem::Requirement
+  requirement: &70218567294300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70119661659440
+  version_requirements: *70218567294300
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70119661658480 !ruby/object:Gem::Requirement
+  requirement: &70218567293720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,9 +43,9 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70119661658480
+  version_requirements: *70218567293720
 description: Converts Html to Textile, or as some say 'html2textile', it's built on
-  nokogiri''
+  nokogiri
 email:
 - graemeworthy@gmail.com
 executables: []
@@ -56,6 +56,7 @@ files:
 - Gemfile
 - Rakefile
 - Readme.txt
+- changelog
 - lib/pink_shirt.rb
 - lib/pink_shirt/attributes.rb
 - lib/pink_shirt/entities.rb
@@ -128,3 +129,4 @@ test_files:
 - spec/textile-spec/paragraph_text.yaml
 - spec/textile-spec/phrase_modifiers.yaml
 - spec/textile_spec.rb
+has_rdoc: