typedown 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-08-12
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/typedown
+lib/typedown.rb
+lib/typedown/document.rb
+script/console
+script/destroy
+script/generate
+test/data/example.tpd
+test/test_helper.rb
+test/test_typedown.rb

data/README.rdoc

@@ -0,0 +1,118 @@
+= typedown
+
+* http://github.com/wrimle/typedown
+
+== DESCRIPTION
+
+Typedown is a markdown dialect optimized for fast typing on mobile devices.
+The typedown is basically a preprocessor that translates typedown to markdown,
+for further processing by a markdown parser.
+
+At the moment the typedown syntax is mainly tested with the iPod touch/iPhone iOS 
+4.0.1 keyboard. It takes into account looks at how easy it is to get to important
+characters on the keyboard, as well as features like auto-capitalizing.
+
+A typical typedown document will look like this:
+
+
+    ! Heading
+    
+    Exclamation mark is chosen because the
+    first word after it is auto-capitalized. And
+    it is easier to get to than the hash (#) in the 
+    iPhone/iPod touch keyboard layout.
+    
+    //. This is a bold paragraph
+    that might run through several lines
+    before ending in a double line break.
+    The dot ensuers the first word is 
+    auto-capitalized.
+
+    /. This paragraph is italic.
+    
+    Single words may be /italic/ or //bold//. Or you 
+    may use standard _markdown italic_ and __bold__
+    for more flexibility. The slash syntax only
+    works for single words and whole words, because
+    the slash may have other uses.
+    
+    !! Subheading
+    
+    As typedown is a preprocessor, one is free
+    to use standard markdown. There is one exception
+    though. The dash will no longer create
+    bullet-lists.
+    
+    - Why? you ask.
+    
+    - It is used for dialogue instead.
+    
+    - Why?
+    
+    - I want typedown to be a tool for journalists and writers. 
+    In some countries, including mine, this is a usual style for 
+    writing dialogue both in newspapers, magazines and fiction.
+
+    - Ah! you say. - I get it.
+
+    The dash does not auto-capitalize, though. Because of this
+    there is an alternative syntax:
+
+    -. You may add dialogue like this.
+
+    -. That dot is ugly.
+
+    -. Yeah, I agree. But this actually is faster to type. Saves a lot of shifting.
+
+    -. On the iPod again, I guess.
+
+    -. How did you know? I ask.
+
+    You grin.
+
+       
+== FEATURES/PROBLEMS:
+
+The preprocessor at present is not aware of CODE
+blocks or similar, and will not leave your regexps
+alone.
+
+== REQUIREMENTS:
+
+Typedown is presently using bluecloth as its markdown
+parser.
+
+== SYNOPSIS:
+
+    require 'typedown'
+
+    doc = Typedown::Document.new content
+    doc << "! More content\n"
+    puts doc.to_markdown
+    puts doc.to_html
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Rune Myrland
+
+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,24 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/typedown'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "typedown"
+    gem.summary = %Q{A markdown dialect optimized for fast typing on mobile devices}
+    gem.description = %Q{Typedown is a markdown preprocessor which forwards it's output to a markdown parser. Presently bluecloth}
+    gem.email = "rmyrland@gmail.com"
+    gem.homepage = "http://github.com/wrimle/typedown"
+    gem.authors = ["wrimle"]
+    gem.add_dependency('bluecloth','>= 2.0.7')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/typedown

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+#
+# = newsdown
+#
+# Format one or more text files with the newsdown formatter.
+# Typedown is a dialect of markdown optimized for typing on mobile devices.
+#
+# = Synopsis
+#
+#   newsdown [OPTIONS] [FILES]
+#
+# 
+#
+
+$: << "lib"
+require 'typedown'
+require 'optparse'
+
+
+DocumentWrapper = %{
+<html>
+  <head><title>%s</title></head>
+  <body>
+%s
+  </body>
+</html>
+}
+
+def main
+  fragment = false
+
+  ARGV.options do |oparser|
+    oparser.banner = "Usage: #$0 [OPTIONS] FILES"
+
+    # Debug mode
+    oparser.on( "--debug", "-d", TrueClass, "Turn debugging output on" ) {
+      $DEBUG = true
+    }
+
+    # 'Fragment' mode
+    oparser.on( "--fragment", "-f", TrueClass,
+                "Output HTML fragments instead of whole documents" ) {
+      fragment = true
+    }
+
+    oparser.parse!
+  end
+
+  # Filter mode if no arguments
+  ARGV.push( "-" ) if ARGV.empty?
+
+  ARGV.each {|file|
+    if file == '-'
+      contents = $stdin.read
+    else
+      contents = File::read( file )
+    end
+
+    nd = Typedown::Document.new( contents )
+    $stderr.puts "Using Typedown version #{Typedown::VERSION}"
+
+    if fragment
+      $stdout.puts nd.to_html
+    else
+      $stdout.puts DocumentWrapper % [ file, nd.to_html ]
+    end
+  }
+
+rescue => err
+  $stderr.puts "Aborting: Fatal error: %s" % err.message
+  exit 255
+end
+
+
+main

data/lib/typedown/document.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+#require 'kramdown'
+require 'bluecloth'
+
+module Typedown
+  class Document < String
+    def initialize text = nil
+      super ""
+      self << text if text
+    end
+
+    def to_markdown
+      text = self
+
+      # Translate '! headings' to '# headings'
+      text.gsub!(/^! /, "# ")
+      text.gsub!(/^!! /, "## ")
+      text.gsub!(/^!!! /, "### ")
+      text.gsub!(/^!!!! /, "#### ")
+      text.gsub!(/^!!!!! /, "##### ")
+      text.gsub!(/^!!!!!! /, "###### ")
+
+      # Dialogue dashes
+      text.gsub!(/^-\.? /, "&#8213; ")
+      text.gsub!(/\s-\.? /, " &#8213; ")
+
+      # Insert placeholders around lead in
+      text.gsub!(/^\. (( *[^\n].+\n)*)/, "! x!\\1!x-!\n")
+      # Remove placeholders while using them to remove whitespace
+      text.gsub!(/^! x!\s*/, "**")
+      text.gsub!(/\s*!x-!$/, "**")
+
+
+      # Insert placeholders around lead in
+      text.gsub!(/^\/\/\. (( *[^\n].+\n)*)/, "! x!\\1!x-!\n")
+      # Remove placeholders while using them to remove whitespace
+      text.gsub!(/^! x!\s*/, "**")
+      text.gsub!(/\s*!x-!$/, "**")
+
+
+      # Insert placeholders around lead in
+      text.gsub!(/^\/\. (( *[^\n].+\n)*)/, "! x!\\1!x-!\n")
+      # Remove placeholders while using them to remove whitespace
+      text.gsub!(/^! x!\s*/, "*")
+      text.gsub!(/\s*!x-!$/, "*")
+
+      # Slash for _
+      text.gsub!(/(\s)\/(\S+)\/(\s)[\.\,\?\!]?/, "\\1_\\2_\\3")
+      text.gsub!(/(\s)\/\/(\S+)\/\/[\.\,\?\!]?(\s)/, "\\1__\\2__\\3")
+      text.gsub!(/(\s)\/\/\/(\S+)\/\/\/[\.\,\?\!]?(\s)/, "\\1___\\2___\\3")
+      text
+    end
+
+
+    def to_html
+      #kramdown = Kramdown::Document.new to_markdown
+      #kramdown.to_html
+      bluecloth = BlueCloth::new( to_markdown )
+      bluecloth.to_html
+    end
+  end
+end

data/lib/typedown.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'typedown/document'
+
+module Typedown
+  VERSION = '0.0.1'
+end
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/typedown.rb'}"
+puts "Loading typedown gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/data/example.tpd

@@ -0,0 +1,21 @@
+! Heading
+
+//. A lead-in saying what the article is about.
+Some more lead-in. 
+And more.
+
+Some body copy.
+
+!! Subheading
+
+More body copy.
+
+- Dialogue like this, he said. - I tell you.
+
+- Oh, yeah?
+
+More body copy. Standard markdown /italic/ and //bold//.
+
+!! Another subheading
+
+And body copy again.

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/typedown'

data/test/test_typedown.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestTypedown < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/typedown.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{typedown}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["wrimle"]
+  s.date = %q{2010-08-13}
+  s.default_executable = %q{typedown}
+  s.description = %q{Typedown is a markdown preprocessor which forwards it's output to a markdown parser. Presently bluecloth}
+  s.email = %q{rmyrland@gmail.com}
+  s.executables = ["typedown"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/typedown",
+     "lib/typedown.rb",
+     "lib/typedown/document.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "test/data/example.tpd",
+     "test/test_helper.rb",
+     "test/test_typedown.rb",
+     "typedown.gemspec"
+  ]
+  s.homepage = %q{http://github.com/wrimle/typedown}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A markdown dialect optimized for fast typing on mobile devices}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_typedown.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bluecloth>, [">= 2.0.7"])
+    else
+      s.add_dependency(%q<bluecloth>, [">= 2.0.7"])
+    end
+  else
+    s.add_dependency(%q<bluecloth>, [">= 2.0.7"])
+  end
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: typedown
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- wrimle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-13 00:00:00 +02:00
+default_executable: typedown
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 0
+        - 7
+        version: 2.0.7
+  type: :runtime
+  version_requirements: *id001
+description: Typedown is a markdown preprocessor which forwards it's output to a markdown parser. Presently bluecloth
+email: rmyrland@gmail.com
+executables: 
+- typedown
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/typedown
+- lib/typedown.rb
+- lib/typedown/document.rb
+- script/console
+- script/destroy
+- script/generate
+- test/data/example.tpd
+- test/test_helper.rb
+- test/test_typedown.rb
+- typedown.gemspec
+has_rdoc: true
+homepage: http://github.com/wrimle/typedown
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A markdown dialect optimized for fast typing on mobile devices
+test_files: 
+- test/test_helper.rb
+- test/test_typedown.rb