MiniMarkup 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,14 @@
+=== 1.0.1 / 2008-12-19
+
+* 6 major enhancements
+
+  * Improved Paragraph finding
+  * Added line breaks inside paragraphs
+  * Added more tests & removed fail safes to let library error
+  * Broke up elements to smaller parts for better testability
+  * Added support for & and ... to Html encoding
+  * Added formatting fixes for Flash Rendering issues
+
 === 1.0.0 / 2008-12-17
 
 * 1 major enhancement

data/README.txt

@@ -1,23 +1,33 @@
 = MiniMarkup
 
 * http://rubyforge.org/projects/uwruby
-* http://uwruby.rubyforge.org/mini_markup/
+* http://uwruby.rubyforge.org/
 
 == DESCRIPTION:
 
-This is a simplified version of how Textile works
+This is a very simplified version of how Textile works and also
+adds some fixes if you use the same HTML in a flash feed
+or widget.
 
 == FEATURES/PROBLEMS:
 
-Currently includes replacement <b> <i> and <p>
+Currently includes replacement of <b> <i> <p> <br /> inside a <p> & and ... 
+as well as some fixes for spacing formatting issues with the same HTML
+provided to a Flash TextArea element.
 
 == SYNOPSIS:
 
-  Coming soon
+  The general idea is to provide some of the more simple benefits that 
+Textile provides for mobile users which they can type easily. And also 
+give some sensible solutions to common output methods like HTML and Flash.
+While providing valid XHTML and looking at common user patterns and asking
+less of them to get what they really want. Most of this is based off of
+my observations designing, coding and doing customer support for Glue.
+http://gluenow.com/
 
 == REQUIREMENTS:
 
-* None
+* Awesomeness! Thats it!
 
 == INSTALL:
 

data/lib/mini_markup.rb

@@ -1,22 +1,119 @@
+class MiniMarkupNeedInputText         < StandardError; end
+class MiniMarkupUnknownError          < StandardError; end
+class MiniMarkupMissingInstructions   < StandardError; end
+
 class MiniMarkup
-  VERSION = '1.0.0'
-  B = {:seek => /(\*\b)([a-zA-Z0-9 -]+)(\b\*)/,         :tag => "b"}
-  I = {:seek => /(_(?=\S))([a-zA-Z0-9 -&]+)((?=\S)_)/,  :tag => "i"}
-  P = {:seek => /()((.+(\n|\z)){1,})/,                  :tag => "p"}
+
+  VERSION = '1.0.1'
+
+  ###
+  # REPLACEMENTS
+
+  # Default HTML Replacements
+  B = { :seek =>  /\*\b([a-zA-Z0-9 -&]+)\b\*/,                     :tag =>  "b"}
+  I = { :seek =>  /_(?=\S)([a-zA-Z0-9 -&]+)(?=\S)_/,               :tag =>  "i"}
+  P = { :seek =>  /(^(?:.+(\n|\z))+)/,                             :tag =>  "p"}
+
+  R = { :seek =>  /(<p>.+<\/p>|<p>.+\n((.+<\/p>)|(.+)(\n))+)/i,   
+        :loc  =>  /([ ]?\n)(?!\z)/,                                :tag => "br"}
+
+  C = { :ampr =>[ /&(?!(\w{2,9};|[#]\d{2,4};))/,                        "&amp;"],
+        :elip =>[ /(\.{3})(?=\w|\z|\n|\s|[<])/,                      "&hellip;"]
+      }
+
+  # Flash HTML Formatting Fixes
+  F_P={ :seek =>  /<p>/i,                                           :tag => "br"}
+
+  ###
+  # DEFAULT GROUPS
+  #
+  # There must be a better way to do this
+  # These get eval applied later on to call these functions
+
+  # Add block style replacements at start of array
+  TO_HTML_DEFAULTS = [
+    "add_p_tags",
+    "add_br_tags",
+    "add_b_tags",
+    "add_i_tags",
+    "add_symbols"
+    ]
+
+  FLASH_HTML_FIXES = [
+    "flash_p_fix"
+    ]
 
   attr_accessor :txt
 
   def initialize (t="")
-    t = t.to_s if !t.is_a?(String)
-    @txt = t
+    @txt = t.to_s
+  end
+
+  def add_inline m=nil
+    check_data([@txt,m])
+    @txt = @txt = @txt.gsub(m[:seek]) { "<#{m[:tag]}>#{$1}</#{m[:tag]}>" }
+  end
+
+  def add_block m=nil
+    check_data([@txt,m])
+    @txt = @txt.gsub(m[:seek]) { "<#{m[:tag]}>#{$1.chomp}</#{m[:tag]}>#{$2}" }
+  end
+
+  def add_p_breaks m=nil
+    check_data([@txt,m])
+    @txt = @txt.gsub(m[:seek]) {  $1.gsub(m[:loc]){ " <#{m[:tag]} />" } }
   end
 
-  def raw_to_tags (m=nil)
-    @txt.gsub(m[:seek]) { "<#{m[:tag]}>#{$2.chomp}</#{m[:tag]}>" }
+  def encode_chars m=nil
+    check_data([@txt,m])
+    m.each_pair { |seek, char|  @txt = @txt.gsub(char[0]) { char[1] } }
+    @txt
   end
 
-  def add_b_tags;   raw_to_tags B;  end;
-  def add_i_tags;   raw_to_tags I;  end;
-  def add_p_tags;   raw_to_tags P;  end;
+  def add_flash_br m=nil
+    check_data([@txt,m])
+    @txt = @txt.gsub(m[:seek]) { "#{$~}<#{m[:tag]} />" }
+  end
+
+  # Friendly easy to read one off methods
+  def add_b_tags;     add_inline   B;   end
+  def add_i_tags;     add_inline   I;   end
+  def add_p_tags;     add_block    P;   end
+  def add_br_tags;    add_p_breaks R;   end
+  def add_symbols;    encode_chars C;   end
+  def flash_p_fix;    add_flash_br F_P; end
+
+  # Run all markup methods
+  def to_HTML type=:default
+    case type
+      when :default
+        apply_updates [ TO_HTML_DEFAULTS  ]
+      when :flash
+        apply_updates [ TO_HTML_DEFAULTS  , FLASH_HTML_FIXES  ]
+      end
+      return @txt
+  end
+
+  def apply_updates ary
+    ary.each{ |group| group.each { |func_name| eval func_name } }
+  end
+
+  # Error Checking
+  def check_data(c)
+    raise_error(:content)       if      c[0].empty?   # Text Content
+    raise_error(:instructions)  unless  c[1]          # RegEx Intructions
+  end
+
+  # Error Handlin' / California Rasin'
+  def raise_error type=:unknown
+    case type
+      when :instructions
+        raise MiniMarkupMissingInstructions, "Instructions are required for this markup replacement."
+      when :content
+        raise MiniMarkupNeedInputText,       "No content was provided or it was lost in process."
+      when :unknown
+         raise MiniMarkupUnknownError ,      "An unknown Error occurred."
+      end
+  end
 
 end

data/test/test_mini_markup.rb

@@ -1,50 +1,11 @@
-#!/usr/bin/env ruby -w
-
 require 'test/unit'
 require 'mini_markup.rb'
 
-##
-# Student Name: Jordan Dobson
-# Homework Week: 8 
-#
-
 class TestMiniMarkup < Test::Unit::TestCase
 
   def setup
-
-    @inst = MiniMarkup.new 
-
+    @inst = MiniMarkup.new
     @no_inline_change = "* This text_should be unchanged."
-
-    @b_simple_before = "*bold text* *b*"
-    @b_simple_after = "<b>bold text</b> <b>b</b>"
-
-    @b_complex_before = "* this shouldn't b*e bold* \n ** but this should be *bold text*"
-    @b_complex_after = "* this shouldn't b<b>e bold</b> \n ** but this should be <b>bold text</b>"
-
-    @i_simple_before = "_italics_ _i_"
-    @i_simple_after = "<i>italics</i> <i>i</i>"
-
-    @i_complex_before = "http://_squadblog_.com/news_view/ th_is i_s _awesome_ and really _ _should work_\n _here_ "
-    @i_complex_after = "http://<i>squadblog</i>.com/news_view/ th<i>is i</i>s <i>awesome</i> and really _ <i>should work</i>\n <i>here</i> "
-
-    @p_simple_before = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool"
-    @p_simple_after = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>"
-
-    @p_medium_before = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool\n\nHere's some topics to help you get started!"
-    @p_medium_after = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>\n<p>Here's some topics to help you get started!</p>"
-
-    @p_complex_before = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool\n\nHere's some topics to help you get started!\n\n\n\n*Glue Help Blog Topics*"
-    @p_complex_after = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>\n<p>Here's some topics to help you get started!</p>\n\n\n<p>*Glue Help Blog Topics*</p>"
-
-    @p_with_breaks_before = "We release about *50 new accounts weekly* on Glue,\n our simple web & mobile content publishing tool\n\nHere's some topics to help you get started!\n\n*Glue Help Blog Topics*"
-    @p_with_breaks_after = "<p>We release about *50 new accounts weekly* on Glue,\n our simple web & mobile content publishing tool</p>\n<p>Here's some topics to help you get started!</p>\n<p>*Glue Help Blog Topics*</p>"
-
-  @all_with_breaks_before = "We release about *50 new accounts weekly* on Glue,\n our simple _web & mobile_ _content publish_ing tool\n\nHere's some topics to help you get started!\n\n*Glue Help Blog Topics*"
-
-
-  @all_with_breaks_after = "<p>We release about <b>50 new accounts weekly</b> on Glue,\n our simple <i>web & mobile</i> <i>content publish</i>ing tool</p>\n\n<p>Here's some topics to help you get started!</p>\n\n<p><b>Glue Help Blog Topics</b></p>"
-
   end
 
   ###
@@ -54,7 +15,7 @@ class TestMiniMarkup < Test::Unit::TestCase
   def test_is_mini_markup
     assert_kind_of MiniMarkup, @inst
   end
-  
+
   ###
   # DataType
   #
@@ -67,19 +28,28 @@ class TestMiniMarkup < Test::Unit::TestCase
 
   ###
   # Empty
-  # 
+  #
   # Ensure if nothing sent it returns nil
   def test_for_nil_if_no_params
     assert_equal "", @inst.txt
   end
 
-  # Ensure if tags added on nil still returns
-  def test_return_if_empty
-    assert_equal "", @inst.add_b_tags
-    assert_equal "", @inst.add_i_tags
-    assert_equal "", @inst.add_p_tags
+  # Ensure if worker functions Error if missing Content
+  def test_error_without_content
+    assert_raise MiniMarkupNeedInputText do
+      @inst.txt = ""
+      @inst.add_p_tags
+    end
+  end
+
+  # Ensure if worker functions Error if missing Contstant
+  def test_error_without_instructions
+    assert_raise MiniMarkupMissingInstructions do
+      @inst.txt = @no_inline_change
+      @inst.add_block
+    end
   end
-  
+
   ###
   # Initialize
   #
@@ -93,25 +63,28 @@ class TestMiniMarkup < Test::Unit::TestCase
 
   ###
   # Bold
-  # 
+  #
   # Check that no bold matches are returned
   def test_no_bold_matches
-    actual = MiniMarkup.new(@no_inline_change).add_b_tags
+    txt = @no_inline_change
     expected = @no_inline_change
+    actual = MiniMarkup.new(txt).add_b_tags
     assert_equal expected, actual
   end
 
   # Check for simple bold matches
   def test_find_bold_simple_matches
-    actual = MiniMarkup.new(@b_simple_before).add_b_tags
-    expected = @b_simple_after
+    txt = "*bold text* *b*"
+    expected = "<b>bold text</b> <b>b</b>"
+    actual = MiniMarkup.new(txt).add_b_tags
     assert_equal expected, actual
   end
 
   # Check for complex bold matches
   def test_find_bold_complex_matches
-    actual = MiniMarkup.new(@b_complex_before).add_b_tags
-    expected = @b_complex_after
+    txt = "* this shouldn't b*e bold* \n ** but this should be *bold text*"
+    expected = "* this shouldn't b<b>e bold</b> \n ** but this should be <b>bold text</b>"
+    actual = MiniMarkup.new(txt).add_b_tags
     assert_equal expected, actual
   end
 
@@ -120,53 +93,108 @@ class TestMiniMarkup < Test::Unit::TestCase
   #
   # Check that no italic matches are returned
   def test_no_italic_matches
-    actual = MiniMarkup.new(@no_inline_change).add_i_tags
-    expected = @no_inline_change
+    txt = @no_inline_change
+    expected = txt
+    actual = MiniMarkup.new(txt).add_i_tags
     assert_equal expected, actual
   end
 
   # Check for simple italic matches
   def test_find_italic_simple_matches
-    actual = MiniMarkup.new(@i_simple_before).add_i_tags
-   expected = @i_simple_after
+    txt = "_italics_ _i_"
+    expected = "<i>italics</i> <i>i</i>"
+    actual = MiniMarkup.new(txt).add_i_tags
     assert_equal expected, actual
   end
 
   # Check for complex italic matches
   def test_find_italic_complex_matches
-    actual = MiniMarkup.new(@i_complex_before).add_i_tags
-    expected = @i_complex_after
+    txt = "http://_squadblog_.com/news_view/ th_is i_s _awesome_ and really _ _should work_\n _here_ "
+    expected = "http://<i>squadblog</i>.com/news_view/ th<i>is i</i>s <i>awesome</i> and really _ <i>should work</i>\n <i>here</i> "
+    actual = MiniMarkup.new(txt).add_i_tags
     assert_equal expected, actual
   end
 
   ###
   # Paragraph
-  # 
+  #
   # Check that simple paragraph matches are returned
   def test_find_paragraph_simple
-    actual = MiniMarkup.new(@p_simple_before).add_p_tags
-    expected = @p_simple_after
+    txt = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool"
+    expected = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>"
+    actual = MiniMarkup.new(txt).add_p_tags
     assert_equal expected, actual
   end
 
   # Check that well formed paragraph matches are returned
   def test_find_paragraph_medium
-    actual = MiniMarkup.new(@p_medium_before).add_p_tags
-    expected = @p_medium_after
+    txt = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool\n\nHere's some topics to help you get started!"
+    expected = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>\n\n<p>Here's some topics to help you get started!</p>"
+    actual = MiniMarkup.new(txt).add_p_tags
     assert_equal expected, actual
   end
 
   # Check that poorly formed paragraph matches are returned
   def test_find_paragraph_complex
-    actual = MiniMarkup.new(@p_complex_before).add_p_tags
-    expected = @p_complex_after
+    txt = "We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool\n\nHere's some topics to help you get started!\n\n\n\n*Glue Help Blog Topics*"
+    expected = "<p>We release about *50 new accounts weekly* on Glue, our simple web & mobile content publishing tool</p>\n\n<p>Here's some topics to help you get started!</p>\n\n\n\n<p>*Glue Help Blog Topics*</p>"
+    actual = MiniMarkup.new(txt).add_p_tags
     assert_equal expected, actual
   end
-  
+
   # Check that line breaks are preserved inside paragraphs
-  def test_find_paragraph_keep breaks
-    actual = MiniMarkup.new(@p_with_breaks_before).add_p_tags
-    expected = @p_with_breaks_after
+  def test_find_paragraph_keep_linebreaks
+    txt = "\n\nHello\n\nWe release about *50 new accounts weekly* on Glue,\n our simple web & mobile content \npublishing tool\n\nHere's some topics to help you get started!\n\n*Glue Help Blog Topics*\n\n\n"
+    expected = "\n\n<p>Hello</p>\n\n<p>We release about *50 new accounts weekly* on Glue,\n our simple web & mobile content \npublishing tool</p>\n\n<p>Here's some topics to help you get started!</p>\n\n<p>*Glue Help Blog Topics*</p>\n\n\n"
+    actual = MiniMarkup.new(txt).add_p_tags
+    assert_equal expected, actual
+  end
+
+  # Add Line breaks inside Paragraph
+  def test_add_break_tags_to_paragraph
+    txt = "<p>Hello</p>\n\n<p>We release about *50 new accounts weekly* on Glue,\nour simple web & mobile content \npublishing tool</p>\n\n<p>Here's some topics to help you get started!</p>\n\n<p>*Glue Help Blog Topics*</p>"
+    expected = "<p>Hello</p>\n\n<p>We release about *50 new accounts weekly* on Glue, <br />our simple web & mobile content <br />publishing tool</p>\n\n<p>Here's some topics to help you get started!</p>\n\n<p>*Glue Help Blog Topics*</p>"
+    actual = MiniMarkup.new(txt).add_br_tags
+    assert_equal expected, actual
+  end
+
+  # Add Line breaks inside short and sloppy Paragraph
+  def test_add_breaks_in_sloppy_paragraph
+    txt = "\n<p>L1\nL2\nL3</p>\n<hr />\n\n<p>L4\nL5</p>\n"
+    expected = "\n<p>L1 <br />L2 <br />L3</p>\n<hr />\n\n<p>L4 <br />L5</p>\n"
+    actual = MiniMarkup.new(txt).add_br_tags
+    assert_equal expected, actual
+  end
+
+  #Test Character encodings
+  def test_character_encoding
+    txt = "...This sh&ould happen\n\nand then wyou will know.......... that it will happen & it's fine...&hellip; why just do this&#8903;\n\nright..."
+  expected = "&hellip;This sh&amp;ould happen\n\nand then wyou will know.......&hellip; that it will happen &amp; it's fine...&hellip; why just do this&#8903;\n\nright&hellip;"
+    actual = MiniMarkup.new(txt).add_symbols
+    assert_equal expected, actual
+  end
+
+  # Add all the tags together
+  def test_add_all_tags
+    txt="Hello\n\nWe release about *50 new accounts weekly* on Glue... \nour simple _web & mobile_ content \npublishing tool\n\nHere's some topics to help you get started...\n\n*Glue Help Blog Topics*"
+    expected = "<p>Hello</p>\n\n<p>We release about <b>50 new accounts weekly</b> on Glue&hellip; <br />our simple <i>web &amp; mobile</i> content <br />publishing tool</p>\n\n<p>Here's some topics to help you get started&hellip;</p>\n\n<p><b>Glue Help Blog Topics</b></p>"
+    actual = MiniMarkup.new(txt).to_HTML
+    assert_equal expected, actual
+  end
+
+  # test formatted HTML with only adding Flash fixes 
+  def test_add_all_flash_fixes
+    txt="<p>Hello</p>\n\n<p>We release about <b>50 new accounts weekly</b> on Glue&hellip; <br />our simple <i>web &amp; mobile</i> content <br />publishing tool</p>\n\n<p>Here's some topics to help you get started&hellip;</p>\n\n<p><b>Glue Help Blog Topics</b></p>"
+    expected = "<p><br />Hello</p>\n\n<p><br />We release about <b>50 new accounts weekly</b> on Glue&hellip; <br />our simple <i>web &amp; mobile</i> content <br />publishing tool</p>\n\n<p><br />Here's some topics to help you get started&hellip;</p>\n\n<p><br /><b>Glue Help Blog Topics</b></p>"
+    actual = MiniMarkup.new(txt).flash_p_fix
+    assert_equal expected, actual
+  end
+
+  # Test entirely raw text with default HTML replacements & flash fixes
+  def test_add_all_flash_fixes
+    txt="Hello\n\nWe release about *50 new accounts weekly* on Glue... \nour simple _web & mobile_ content \npublishing tool\n\nHere's some topics to help you get started...\n\n*Glue Help Blog Topics*"
+    expected = "<p><br />Hello</p>\n\n<p><br />We release about <b>50 new accounts weekly</b> on Glue&hellip; <br />our simple <i>web &amp; mobile</i> content <br />publishing tool</p>\n\n<p><br />Here's some topics to help you get started&hellip;</p>\n\n<p><br /><b>Glue Help Blog Topics</b></p>"
+    actual = MiniMarkup.new(txt).to_HTML(:flash)
     assert_equal expected, actual
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: MiniMarkup
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jordan Dobson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-17 00:00:00 -08:00
+date: 2008-12-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.2
     version: 
-description: This is a simplified version of how Textile works
+description: This is a very simplified version of how Textile works and also adds some fixes if you use the same HTML in a flash feed or widget.
 email: 
 - jordandobson@gmail.com
 executables: []
@@ -66,6 +66,6 @@ rubyforge_project: uwruby
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: This is a simplified version of how Textile works
+summary: This is a very simplified version of how Textile works and also adds some fixes if you use the same HTML in a flash feed or widget.
 test_files: 
 - test/test_mini_markup.rb