MiniMarkup 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-12-17
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/mini_markup.rb
+test/test_mini_markup.rb

data/README.txt

@@ -0,0 +1,49 @@
+= MiniMarkup
+
+* http://rubyforge.org/projects/uwruby
+* http://uwruby.rubyforge.org/mini_markup/
+
+== DESCRIPTION:
+
+This is a simplified version of how Textile works
+
+== FEATURES/PROBLEMS:
+
+Currently includes replacement <b> <i> and <p>
+
+== SYNOPSIS:
+
+  Coming soon
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install minimarkup
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/mini_markup.rb'
+
+Hoe.new('MiniMarkup', MiniMarkup::VERSION) do |p|
+  p.rubyforge_name = 'uwruby'
+  p.developer('Jordan Dobson', 'jordandobson@gmail.com')
+end
+
+# vim: syntax=Ruby

data/lib/mini_markup.rb

@@ -0,0 +1,22 @@
+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"}
+
+  attr_accessor :txt
+
+  def initialize (t="")
+    t = t.to_s if !t.is_a?(String)
+    @txt = t
+  end
+
+  def raw_to_tags (m=nil)
+    @txt.gsub(m[:seek]) { "<#{m[:tag]}>#{$2.chomp}</#{m[:tag]}>" }
+  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;
+
+end

data/test/test_mini_markup.rb

@@ -0,0 +1,173 @@
+#!/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 
+
+    @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
+
+  ###
+  # Setup
+  #
+  # Test our setup file is good
+  def test_is_mini_markup
+    assert_kind_of MiniMarkup, @inst
+  end
+  
+  ###
+  # DataType
+  #
+  # Make sure it returns a string if given something different
+  def test_always_string_on_init
+    assert_kind_of String, MiniMarkup.new([42,"bad",[]]).txt
+    assert_kind_of String, MiniMarkup.new({:bad => "bad"}).txt
+    assert_kind_of String, MiniMarkup.new(42).txt
+  end
+
+  ###
+  # 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
+  end
+  
+  ###
+  # Initialize
+  #
+  # Ensure Data returns unchanged after initialize
+  def test_no_replacements
+    actual = @no_inline_change
+    obj = MiniMarkup.new(actual)
+    expected = obj.txt
+    assert_equal expected, actual
+  end
+
+  ###
+  # Bold
+  # 
+  # Check that no bold matches are returned
+  def test_no_bold_matches
+    actual = MiniMarkup.new(@no_inline_change).add_b_tags
+    expected = @no_inline_change
+    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
+    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
+    assert_equal expected, actual
+  end
+
+  ###
+  # Italic
+  #
+  # 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
+    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
+    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
+    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
+    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
+    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
+    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
+    assert_equal expected, actual
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: MiniMarkup
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jordan Dobson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: This is a simplified version of how Textile works
+email: 
+- jordandobson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/mini_markup.rb
+- test/test_mini_markup.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/uwruby
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: uwruby
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: This is a simplified version of how Textile works
+test_files: 
+- test/test_mini_markup.rb