newstile 1.0.1

data/README

@@ -0,0 +1,31 @@
+# newstile
+
+newstile is newstile-parser. It is forked off Thomas Leitner's markdown parser kramdown, and
+modified to support the newstile syntax. Newstile is a markdown dialect optimized for fast typing
+on mobile devices like iPhone and Android phones.
+
+The syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
+the documentation is available online at http://newstile.rubyforge.org.
+
+
+# Usage
+
+newstile has a basic *Cloth API, so using newstile is as easy as
+
+    require 'newstile'
+
+    Newstile::Document.new(text).to_html
+
+
+# Development
+
+Just clone the git repository as described in doc/installation.page you are good to go. You probably
+want to install `rake` so that you can use the provided rake tasks. Aside from that:
+
+* The `tidy` binary needs to be installed for the automatically derived tests to work.
+* The `latex` binary needs to be installed for the latex-compilation tests to work.
+
+
+# License
+
+See the COPYING file.

data/Rakefile

@@ -0,0 +1,342 @@
+# -*- ruby -*-
+
+# load all optional developer libraries
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue LoadError
+end
+
+begin
+  require 'webgen/webgentask'
+  require 'webgen/page'
+  require 'webgen/website'
+rescue LoadError
+end
+
+begin
+  require 'rdoc/task'
+  require 'rdoc/rdoc'
+rescue LoadError
+end
+
+begin
+  require 'rubyforge'
+rescue LoadError
+end
+
+begin
+  require 'rcov/rcovtask'
+rescue LoadError
+end
+
+require 'fileutils'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'erb'
+
+$:.unshift('lib')
+require 'newstile'
+
+# End user tasks ################################################################
+
+task :default => :test
+
+desc "Install using setup.rb"
+task :install do
+  ruby "setup.rb config"
+  ruby "setup.rb setup"
+  ruby "setup.rb install"
+end
+
+task :clobber do
+  ruby "setup.rb clean"
+end
+
+
+if defined? Webgen
+  desc "Generate the HTML documentation"
+  Webgen::WebgenTask.new('htmldoc') do |site|
+    site.clobber_outdir = true
+    site.config_block = lambda do |config|
+      config['sources'] = [['/', "Webgen::Source::FileSystem", 'doc']]
+      config['output'] = ['Webgen::Output::FileSystem', 'htmldoc']
+      config.default_processing_pipeline('Page' => 'erb,tags,newstile,blocks,fragments')
+      config.optionsdisplay.items [], :mandatory => 'default'
+      config.kdlink.oid nil, :mandatory => true
+      config.kdlink.part nil, :mandatory => true
+      config['contentprocessor.tags.map']['options'] = 'OptionsDisplay'
+      config['contentprocessor.tags.map']['kdexample'] = 'KDExample'
+      config['contentprocessor.tags.map']['kdlink'] = 'KDLink'
+    end
+  end
+end
+
+if defined? Rake::RDocTask
+  rd = Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'htmldoc/rdoc'
+    rdoc.title = 'newstile'
+    rdoc.main = 'Newstile'
+    rdoc.options << '--line-numbers'
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+end
+
+if defined?(Webgen) && defined?(Rake::RDocTask)
+  desc "Build the whole user documentation"
+  task :doc => [:rdoc, 'htmldoc']
+end
+
+tt = Rake::TestTask.new do |test|
+  test.warning = true
+  test.libs << 'test'
+end
+
+# Release tasks and development tasks ############################################
+
+namespace :dev do
+
+  SUMMARY = 'newstile is a fast, pure-Ruby Newstile converter.'
+  DESCRIPTION = <<EOF
+newstile is parser for the newstile dialect of markdown. Newstile is optimised
+for typing on mobile devices like iPhone and Andorid mobiles. It is forked
+from Thomas Leitner's kramdown, which is a fast, pure Ruby, markdown parser.
+EOF
+
+  begin
+    REL_PAGE = Webgen::Page.from_data(File.read('doc/news/release_' + Newstile::VERSION.split('.').join('_') + '.page'))
+  rescue
+    puts 'NO RELEASE NOTES/CHANGES FILE'
+  end
+
+  PKG_FILES = FileList.new([
+                            'Rakefile',
+                            'setup.rb',
+                            'COPYING', 'GPL', 'README', 'AUTHORS',
+                            'VERSION', 'ChangeLog', 'CONTRIBUTERS',
+                            'bin/*',
+                            'benchmark/*',
+                            'lib/**/*.rb',
+                            'man/man1/newstile.1',
+                            'data/**/*',
+                            'doc/**',
+                            'test/**/*'
+                           ])
+
+  CLOBBER << "VERSION"
+  file 'VERSION' do
+    puts "Generating VERSION file"
+    File.open('VERSION', 'w+') {|file| file.write(Newstile::VERSION + "\n")}
+  end
+
+  CLOBBER << 'ChangeLog'
+  file 'ChangeLog' do
+    puts "Generating ChangeLog file"
+    `git log --name-only > ChangeLog`
+  end
+
+  CLOBBER << 'CONTRIBUTERS'
+  file 'CONTRIBUTERS' do
+    puts "Generating CONTRIBUTERS file"
+    `echo "  Count Name" > CONTRIBUTERS`
+    `echo "======= ====" >> CONTRIBUTERS`
+    `git log | grep ^Author: | sed 's/^Author: //' | sort | uniq -c | sort -nr >> CONTRIBUTERS`
+  end
+
+  CLOBBER << "man/man1/newstile.1"
+  file 'man/man1/newstile.1' => ['man/man1/newstile.1.erb'] do
+    puts "Generating newstile man page"
+    File.open('man/man1/newstile.1', 'w+') do |file|
+      file.write(ERB.new(File.read('man/man1/newstile.1.erb')).result(binding))
+    end
+  end
+
+  Rake::PackageTask.new('newstile', Newstile::VERSION) do |pkg|
+    pkg.need_tar = true
+    pkg.need_zip = true
+    pkg.package_files = PKG_FILES
+  end
+
+  if defined? Gem
+    spec = Gem::Specification.new do |s|
+
+      #### Basic information
+      s.name = 'newstile'
+      s.version = Newstile::VERSION
+      s.summary = SUMMARY
+      s.description = DESCRIPTION
+
+      #### Dependencies, requirements and files
+      s.files = PKG_FILES.to_a
+
+      s.require_path = 'lib'
+      s.executables = ['newstile']
+      s.default_executable = 'newstile'
+
+      #### Documentation
+
+      s.has_rdoc = true
+      s.rdoc_options = ['--line-numbers', '--main', 'Newstile']
+
+      #### Author and project details
+
+      s.author = 'Thomas Leitner / Rune Myrland'
+      s.email = 'rune@epubify.com'
+      s.homepage = "http://github.com/wrimle/newstile"
+    end
+
+    Rake::GemPackageTask.new(spec) do |pkg|
+      pkg.need_zip = true
+      pkg.need_tar = true
+    end
+
+  end
+
+  if defined?(RubyForge) && defined?(Webgen) && defined?(Gem) && defined?(Rake::RDocTask)
+    desc 'Release Newstile version ' + Newstile::VERSION
+    task :release => [:clobber, :package, :publish_files, :publish_website, :post_news]
+  end
+
+  if defined? RubyForge
+    desc "Upload the release to Rubyforge"
+    task :publish_files => [:package] do
+      print 'Uploading files to Rubyforge...'
+      $stdout.flush
+
+      rf = RubyForge.new
+      rf.configure
+      rf.login
+
+      rf.userconfig["release_notes"] = REL_PAGE.blocks['content'].content
+      rf.userconfig["preformatted"] = false
+
+      files = %w[.gem .tgz .zip].collect {|ext| "pkg/newstile-#{Newstile::VERSION}" + ext}
+
+      rf.add_release('newstile', 'newstile', Newstile::VERSION, *files)
+
+      sh "gem push pkg/newstile-#{Newstile::VERSION}.gem"
+      puts 'done'
+    end
+
+    desc 'Post announcement to rubyforge.'
+    task :post_news do
+      print 'Posting announcement to Rubyforge ...'
+      $stdout.flush
+      rf = RubyForge.new
+      rf.configure
+      rf.login
+
+      content = REL_PAGE.blocks['content'].content
+      content += "\n\n\nAbout newstile\n\n#{SUMMARY}\n\n#{DESCRIPTION}"
+      rf.post_news('newstile', "newstile #{Newstile::VERSION} released", content)
+      puts "done"
+    end
+  end
+
+  desc "Upload the website to Rubyforge"
+  task :publish_website => ['doc'] do
+    sh "rsync -avc --delete --exclude 'wiki' --exclude 'js/jsMath' --exclude 'robots.txt'  htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/newstile/"
+  end
+
+
+  if defined? Rcov
+    Rcov::RcovTask.new do |rcov|
+      rcov.libs << 'test'
+    end
+  end
+
+  CODING_LINE = "# -*- coding: utf-8 -*-\n"
+  COPYRIGHT=<<EOF
+#
+#--
+# Copyright (C) 2009-2010 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of newstile.
+#
+# newstile is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+#
+EOF
+
+  desc "Insert/Update copyright notice"
+  task :update_copyright do
+    inserted = false
+    Dir["lib/**/*.rb"].each do |file|
+      if !File.read(file).start_with?(CODING_LINE + COPYRIGHT)
+        inserted = true
+        puts "Updating file #{file}"
+        old = File.read(file)
+        if !(result = old.gsub!(/\A#{Regexp.escape(CODING_LINE)}#\n#--.*?\n#\+\+\n#\n/m, CODING_LINE + COPYRIGHT))
+          old.gsub!(/\A(#{Regexp.escape(CODING_LINE)})?/, CODING_LINE + COPYRIGHT + "\n")
+        end
+        File.open(file, 'w+') {|f| f.puts(old)}
+      end
+    end
+    puts "Look through the above mentioned files and correct all problems" if inserted
+  end
+
+end
+
+task :clobber => ['dev:clobber']
+
+# Helper methods and misc  ###################################################################
+
+if defined? Webgen
+
+  class OptionsDisplay
+
+    include Webgen::Tag::Base
+
+    def call(tag, body, context)
+      param('optionsdisplay.items').collect do |opt|
+        Newstile::Options.definitions[opt]
+      end.collect do |term|
+        lines = term.desc.split(/\n/)
+        first = lines.shift
+        rest = lines[0..-2].collect {|l| "  " + l}.join("\n")
+        "`#{term.name}`\n: #{first}\n#{rest}\n\n"
+      end.join("\n")
+    end
+
+  end
+
+  require 'cgi'
+
+  class KDExample
+
+    include Webgen::Tag::Base
+
+    def call(tag, body, context)
+      result = ::Newstile::Document.new(body, :auto_ids => false).to_html
+      before = "<pre class='kdexample-before'>#{body}<code>\n</code></pre>"
+      after = "<pre class='kdexample-after-source'>#{CGI::escapeHTML(result)}<code>\n</code></pre>"
+      afterhtml = "<div class='kdexample-after-live'>#{result}</div>"
+      "<div class='kdexample'>#{before}#{after}#{afterhtml}\n</div><div class='clear'></div>"
+    end
+
+  end
+
+  class KDLink
+
+    include Webgen::Tag::Base
+
+    def call(tag, body, context)
+      link = "<a href='syntax.html##{param('kdlink.oid')}'>&rarr; Syntax for #{param('kdlink.part')}</a>"
+      "<div class='kdsyntaxlink'>#{link}\n</div>"
+    end
+
+  end
+
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/benchmark/benchmark.rb

@@ -0,0 +1,34 @@
+require 'benchmark'
+require 'stringio'
+
+require 'newstile'
+require 'bluecloth'
+require 'maruku'
+require 'maruku/version'
+require 'rdiscount'
+require 'bluefeather'
+
+module MaRuKu::Errors
+  def tell_user(s)
+  end
+end
+
+
+RUNS=20
+
+FILES=['mdsyntax.text', 'mdbasics.text']
+
+puts "Running tests on #{Time.now.strftime("%Y-%m-%d")} under #{RUBY_DESCRIPTION}"
+
+FILES.each do |file|
+  data = File.read(File.join(File.dirname(__FILE__), file))
+  puts
+  puts "Test using file #{file} and #{RUNS} runs"
+  Benchmark.bmbm do |b|
+    b.report("newstile #{Newstile::VERSION}") { RUNS.times { Newstile::Document.new(data).to_html } }
+    b.report("Maruku #{MaRuKu::Version}") { RUNS.times { Maruku.new(data, :on_error => :ignore).to_html } }
+    b.report("BlueFeather #{BlueFeather::VERSION}") { RUNS.times { BlueFeather.parse(data) } }
+    b.report("BlueCloth #{BlueCloth::VERSION}") { RUNS.times { BlueCloth.new(data).to_html } }
+    b.report("RDiscount #{RDiscount::VERSION}") { RUNS.times { RDiscount.new(data).to_html } }
+  end
+end

data/benchmark/generate_data.rb

@@ -0,0 +1,112 @@
+require 'benchmark'
+require 'optparse'
+require 'fileutils'
+
+require 'newstile'
+require 'maruku'
+require 'maruku/version'
+begin
+  require 'rdiscount'
+  require 'bluecloth'
+rescue LoadError
+end
+require 'bluefeather'
+
+module MaRuKu::Errors
+  def tell_user(s)
+  end
+end
+
+options = {:static => false}
+OptionParser.new do |opts|
+  opts.on("-s", "--[no-]static", "Generate static data") {|v| options[:static] = v}
+  opts.on("-g", "--[no-]graph", "Generate graph") {|v| options[:graph] = v}
+  opts.on("-h NAME", "--historic NAME", String, "Add historic benchmark data") {|v| options[:historic] = v}
+end.parse!
+
+
+THISRUBY = (self.class.const_defined?(:RUBY_DESCRIPTION) ? RUBY_DESCRIPTION.scan(/^.*?(?=\s*\()/).first.sub(/\s/, '-') : "ruby-#{RUBY_VERSION}")
+
+Dir.chdir(File.dirname(__FILE__))
+$:.unshift "../lib"
+BMDATA = File.read('mdbasics.text')
+MULTIPLIER = (0..5).map {|i| 2**i}
+
+if options[:static]
+  static = {}
+  2.times do
+    MULTIPLIER.each do |i|
+      $stderr.puts "Generating static benchmark data, multiplier #{i}"
+      mddata = BMDATA*i
+      static[i] = []
+      static[i] << ["Maruku #{MaRuKu::Version}", Benchmark::measure { Maruku.new(mddata, :on_error => :ignore).to_html }.real]
+      static[i] << ["BlueFeather #{BlueFeather::VERSION}", Benchmark::measure { BlueFeather.parse(mddata) }.real]
+      if self.class.const_defined?(:BlueCloth)
+        static[i] << ["BlueCloth #{BlueCloth::VERSION}", Benchmark::measure { BlueCloth.new(mddata).to_html }.real]
+      else
+        static[i] << ["BlueCloth Not Available.", 0]
+      end
+      if self.class.const_defined?(:RDiscount)
+        static[i] << ["RDiscount #{RDiscount::VERSION}", Benchmark::measure { RDiscount.new(mddata).to_html }.real]
+      else
+        static[i] << ["RDiscount Not Available.", 0]
+      end
+    end
+  end
+  File.open("static-#{THISRUBY}.dat", 'w+') do |f|
+    f.puts "# " + static[MULTIPLIER.first].map {|name, val| name }.join(" || ")
+    format_str = "%5d" + " %10.5f"*static[MULTIPLIER.first].size
+    static.sort.each do |m,v|
+      f.puts format_str % [m, *v.map {|name,val| val}]
+    end
+  end
+end
+
+if options[:historic]
+  historic = "historic-#{THISRUBY}.dat"
+  data = if File.exist?(historic)
+           lines = File.readlines(historic).map {|l| l.chomp}
+           lines.first << " || "
+           lines
+         else
+           ["# ", *MULTIPLIER.map {|m| "%5d" % m}]
+         end
+  data.first << " #{options[:historic]}"
+  MULTIPLIER.each_with_index do |m, i|
+    $stderr.puts "Generating historic benchmark data, multiplier #{m}"
+    mddata = BMDATA*m
+    Benchmark::measure { Newstile::Document.new(mddata).to_html }
+    data[i+1] << " %10.5f" % Benchmark::measure { Newstile::Document.new(mddata).to_html }.real
+  end
+  File.open(historic, 'w+') do |f|
+    data.each {|l| f.puts l}
+  end
+end
+
+if options[:graph]
+  Dir['historic-*.dat'].each do |historic_name|
+    theruby = historic_name.sub(/^historic-/, '').sub(/\.dat$/, '')
+    graph_name = "graph-#{theruby}.png"
+    #static_name = "static-#{theruby}.dat"
+    historic_names = File.readlines(historic_name).first.chomp[1..-1].split(/\s*\|\|\s*/)
+    #static_names = (File.exist?(static_name) ? File.readlines(static_name).first.chomp[1..-1].split(/\s*\|\|\s*/) : [])
+    File.open("gnuplot.dat", "w+") do |f|
+      f.puts <<EOF
+set title "Execution Time Performance for #{theruby}"
+set xlabel "File Multiplier (i.e. n times mdbasic.text)"
+set ylabel "Execution Time in secondes"
+set key left top
+set grid "on"
+set terminal png
+set output "#{graph_name}"
+EOF
+      f.print "plot "
+      i, j = 1, 1
+      f.puts((historic_names.map {|n| i += 1; "\"#{historic_name}\" using 1:#{i} with lp title \"#{n}\""}
+              #static_names.map {|n| j += 1; n =~ /bluefeather/i ? nil : "\"#{static_name}\" using 1:#{j} with lp title \"#{n}\""}.compact
+             ).join(", "))
+    end
+    `gnuplot gnuplot.dat`
+    FileUtils.rm("gnuplot.dat")
+  end
+end