manveru-org 2009.02.21 → 2009.03.28

data/CHANGELOG

@@ -0,0 +1,36 @@
+[96fa8b5 | Sat Mar 28 06:57:31 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Better rake tasks, now managed by raku
+
+[971a989 | Fri Mar 20 05:23:05 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Spec how lists behave right now
+
+[c21d3fb | Sun Mar 15 06:39:58 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Fix the header spec
+
+[93db8d3 | Sun Mar 15 06:35:43 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Transform input to use \n, add specs for it
+
+[9b1ff3a | Sat Feb 21 04:49:40 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Fix gemspec
+
+[bca87be | Sat Feb 21 04:47:40 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Add the Rakefile
+
+[f304ebf | Sat Feb 21 03:40:35 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Version 2009.02.21
+
+[ca4d900 | Thu Jan 01 14:55:47 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Org for rakki
+
+[3b1f2d2 | Sun Oct 12 08:22:45 UTC 2008] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Extracted from rakki
+

data/MANIFEST

@@ -0,0 +1,29 @@
+CHANGELOG
+MANIFEST
+README.md
+Rakefile
+doc/syntax.org
+lib/org.rb
+lib/org/markup.rb
+lib/org/rule.rb
+lib/org/rules.rb
+lib/org/scope.rb
+lib/org/scope/org_mode.rb
+lib/org/state.rb
+lib/org/stringscanner.rb
+lib/org/to/html.rb
+lib/org/to/toc.rb
+lib/org/token.rb
+lib/org/version.rb
+org.gemspec
+spec/org.rb
+tasks/bacon.rake
+tasks/changelog.rake
+tasks/gem.rake
+tasks/gem_installer.rake
+tasks/grancher.rake
+tasks/install_dependencies.rake
+tasks/manifest.rake
+tasks/rcov.rake
+tasks/release.rake
+tasks/reversion.rake

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'time'
+require 'date'
+
+PROJECT_SPECS = Dir['spec/**/*.rb']
+PROJECT_MODULE = 'Org'
+
+GEMSPEC = Gem::Specification.new{|s|
+  s.name         = 'org'
+  s.author       = "Michael 'manveru' Fellinger"
+  s.summary      = "transformation of a subset of org-mode markup to html."
+  s.description  = "transformation of a subset of org-mode markup to html."
+  s.email        = 'm.fellinger@gmail.com'
+  s.homepage     = 'http://github.com/manveru/org'
+  s.platform     = Gem::Platform::RUBY
+  s.version      = (ENV['PROJECT_VERSION'] || Date.today.strftime("%Y.%m.%d"))
+  s.files        = `git ls-files`.split("\n").sort
+  s.has_rdoc     = true
+  s.require_path = 'lib'
+}
+
+Dir['tasks/*.rake'].each{|f| import(f) }
+
+task :default => [:bacon]
+
+CLEAN.include('')

data/lib/org/markup.rb

@@ -3,20 +3,19 @@ module Org
     attr_accessor :string
 
     def initialize(file = nil)
-      @string = File.read(file) if file
+      self.string = File.read(file) if file
     end
 
     def apply(string = @string)
+      self.string = string
+
       parent = RootToken.new(:root, nil)
-      scanner = StringScanner.new(string)
+      scanner = StringScanner.new(self.string)
       state = State.new(@scope, parent, scanner)
 
       until scanner.eos?
         pos = scanner.pos
-        # puts "=" * 80
         state.step
-        # puts "=" * 80
-        # pp state
         raise("Didn't move: %p" % scanner) if pos == scanner.pos
       end
 
@@ -27,5 +26,9 @@ module Org
       @scope = Scope.new(name, options)
       yield(@scope)
     end
+
+    def string=(string)
+      @string = string.gsub(/\r\n|\r/, "\n")
+    end
   end
 end

data/lib/org/scope/org_mode.rb

@@ -1,11 +1,13 @@
 module Org
   OrgMode = Markup.new
+  eol = /\n/ # we keep this simple and convert the input string instead
 
   OrgMode.scope(:block, :indent => true) do |block|
-    block.rule :header, /(\*+)\s+(.*)(\n|\z)/, :bol => true
+    block.rule :header, /(\*+)\s+(.*)(#{eol}|\z)/, :bol => true
     block.rule :table, /\|([^|]+)/, :bol => true, :start => :table, :unscan => true
-    block.rule :ul, /[ \t]+(\*+)\s*(.*)/, :start => :ul, :unscan => true, :bol => true
-    block.rule :br, /\n/
+    block.rule :ul, /[ \t]+[\*\+\-]+\s*(.*)/, :start => :ul, :unscan => true, :bol => true
+    block.rule :ol, /[ \t]+[0-9]+[\.\)]\s*(.*)/, :start => :ol, :unscan => true, :bol => true
+    block.rule :br, eol
     block.rule :p, /(.)/, :bol => true, :start => :inline, :unscan => true
     block.rule :space, /\s/
 
@@ -30,25 +32,38 @@ module Org
     end
 
     block.scope :ul do |ul|
-      ul.rule :li, /[ \t]+\*+\s*/, :start => :li, :bol => true
-      ul.rule :close, /\n/, :end => :ul
+      ul.rule :li, /[ \t]+[\*\+\-]+\s*/, :start => :li, :bol => true
+      ul.rule :close, eol, :end => :ul
       ul.rule :close, /(.)/, :end => :ul, :unscan => true
 
       ul.scope :li do |li|
         li.apply(&inline_rules)
         li.rule :text, /(.)/
-        li.rule :ul, /[ \t]+\*+\s*/, :start => ul, :bol => true
-        li.rule :close, /\n/, :end => :li
+        li.rule :ul, /[ \t]+[\*\+\-]+\s*/, :start => ul, :bol => true
+        li.rule :close, eol, :end => :li
+      end
+    end
+
+    block.scope :ol do |ol|
+      ol.rule :li, /[ \t]+[0-9]+[\.\)]\s*/, :start => :li, :bol => true
+      # ol.rule :ul, /[ \t]+[\*\-\+]+\s*/, :start => :ul, :bol => true, :unscan => true
+      ol.rule :close, eol, :end => :ol
+      ol.rule :close, /(.)/, :end => :ol, :unscan => true
+
+      ol.scope :li do |li|
+        li.apply(&inline_rules)
+        li.rule :text, /(.)/
+        li.rule :close, eol, :end => :li
       end
     end
 
     block.scope(:inline, :indent => false) do |inline|
       inline.apply(&inline_rules)
-      inline.rule :highlight, /\{\{\{[\t ]*(\S+)\n(.*?)\n\}\}\}/m
-      inline.rule :highlight, /\{\{\{\n(.*?)\n\}\}\}/m
+      inline.rule :highlight, /\{\{\{[\t ]*(\S+)#{eol}(.*?)#{eol}\}\}\}/m
+      inline.rule :highlight, /\{\{\{#{eol}(.*?)#{eol}\}\}\}/m
       inline.rule :text, /(.)/
-      inline.rule :close, /\n\n+/, :end => :inline
-      inline.rule :br, /\n/
+      inline.rule :close, /#{eol}#{eol}+/, :end => :inline
+      inline.rule :br, eol
     end
 
     block.scope(:table, :indent => true) do |table|
@@ -58,12 +73,12 @@ module Org
       # | Mrs. Y |    888-888 |   21 |
 
       table.rule :tr, /\|([^|]+)/, :bol => true, :unscan => true, :start => :tr
-      table.rule :close, /\n/, :end => :table
+      table.rule :close, eol, :end => :table
 
       table.scope(:tr, :indent => true) do |tr|
         tr.rule :table_separator, /\|[+-]+\|/, :ignore => true
-        tr.rule :close, /\|\n/, :end => :tr
-        tr.rule :close, /\n/, :end => :tr
+        tr.rule :close, /\|#{eol}/, :end => :tr
+        tr.rule :close, eol, :end => :tr
         tr.rule :td, /\|/, :start => :td
 
         tr.scope :td do |td|

data/lib/org/version.rb

@@ -0,0 +1,3 @@
+module Org
+  VERSION = "2009.03.28"
+end

data/org.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{org}
+  s.version = "2009.03.28"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael 'manveru' Fellinger"]
+  s.date = %q{2009-03-28}
+  s.description = %q{transformation of a subset of org-mode markup to html.}
+  s.email = %q{m.fellinger@gmail.com}
+  s.files = ["CHANGELOG", "MANIFEST", "README.md", "Rakefile", "doc/syntax.org", "lib/org.rb", "lib/org/markup.rb", "lib/org/rule.rb", "lib/org/rules.rb", "lib/org/scope.rb", "lib/org/scope/org_mode.rb", "lib/org/state.rb", "lib/org/stringscanner.rb", "lib/org/to/html.rb", "lib/org/to/toc.rb", "lib/org/token.rb", "lib/org/version.rb", "org.gemspec", "spec/org.rb", "tasks/bacon.rake", "tasks/changelog.rake", "tasks/gem.rake", "tasks/gem_installer.rake", "tasks/grancher.rake", "tasks/install_dependencies.rake", "tasks/manifest.rake", "tasks/rcov.rake", "tasks/release.rake", "tasks/reversion.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/manveru/org}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{transformation of a subset of org-mode markup to html.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/org.rb

@@ -6,6 +6,12 @@ module Org
   class Token
     include ToHtml
     include ToToc
+
+    def html_a(*args)
+      link, desc = *values
+      href = link =~ /^https?:\/\// ? link : "/#{link}"
+      tag(:a, (desc || link), :href => href)
+    end
   end
 end
 
@@ -21,12 +27,12 @@ describe Org::Markup do
   end
 
   should 'markup headers' do
-    t("* header"     ).should == '<h1>header</h1>'
-    t("** header"    ).should == '<h2>header</h2>'
-    t("*** header"   ).should == '<h3>header</h3>'
-    t("**** header"  ).should == '<h4>header</h4>'
-    t("***** header" ).should == '<h5>header</h5>'
-    t("****** header").should == '<h6>header</h6>'
+    t("* header"     ).should == '<h1 id="header">header</h1>'
+    t("** header"    ).should == '<h2 id="header">header</h2>'
+    t("*** header"   ).should == '<h3 id="header">header</h3>'
+    t("**** header"  ).should == '<h4 id="header">header</h4>'
+    t("***** header" ).should == '<h5 id="header">header</h5>'
+    t("****** header").should == '<h6 id="header">header</h6>'
   end
 
   should 'markup inline' do
@@ -50,4 +56,37 @@ describe Org::Markup do
     t('[[http://go.to/]]').should == '<p><a href="http://go.to/">http://go.to/</a></p>'
     t('[[http://go.to/][Go to]]').should == '<p><a href="http://go.to/">Go to</a></p>'
   end
+
+  should 'work with \r, \n, and \n\r' do
+    t("a\nb").should == '<p>a<br />b</p>'
+    t("a\r\nb").should == t("a\nb")
+    t("a\rb").should == t("a\nb")
+  end
+
+  should 'markup unorderd lists' do
+    t(" * one").should == '<ul><li>one</li></ul>'
+    t(" * one\n * two").should == '<ul><li>one</li><li>two</li></ul>'
+    t(" * one
+ * two
+ * three").should == '<ul><li>one</li><li>two</li><li>three</li></ul>'
+    t(" + one").should == '<ul><li>one</li></ul>'
+    t(" - one").should == '<ul><li>one</li></ul>'
+  end
+
+  should 'markup ordered lists' do
+    t(" 1. one").should == '<ol><li>one</li></ol>'
+    t(" 1) one").should == '<ol><li>one</li></ol>'
+    t(" 1. one\n 2. two").should == '<ol><li>one</li><li>two</li></ol>'
+  end
+
+  should 'markup nested lists' do
+    t(" * one\n + nest1\n + nest2\n * two\n").should ==
+      '<ul><li>one</li><ul><li>nest1</li><li>nest2</li></ul></ul>'
+    t(" 1. one\n + nest1\n + nest2\n 2. two\n").should ==
+      '<ol><li>one</li><ul><li>nest1</li><li>nest2</li></ul></ol>'
+  end
+
+  should 'markup inline in lists' do
+    t(' * first _foo_ /bar/').should == '<ul><li>first <u>foo</u> <i>bar</i></li></ul>'
+  end
 end

data/tasks/bacon.rake

@@ -0,0 +1,49 @@
+desc 'Run all bacon specs with pretty output'
+task :bacon => :install_dependencies do
+  require 'open3'
+  require 'scanf'
+
+  specs = PROJECT_SPECS
+
+  some_failed = false
+  total = specs.size
+  len = specs.map{|s| s.size }.sort.last
+  tt = ta = tf = te = 0
+
+  red, yellow, green = "\e[31m%s\e[0m", "\e[33m%s\e[0m", "\e[32m%s\e[0m"
+  left_format = "%4d/%d: %-#{len + 11}s"
+  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
+
+  specs.each_with_index do |spec, idx|
+    print(left_format % [idx + 1, total, spec])
+
+    Open3.popen3(RUBY, spec) do |sin, sout, serr|
+      out = sout.read
+      err = serr.read
+
+      ran = false
+
+      out.each_line do |line|
+        tests, assertions, failures, errors = all = line.scanf(spec_format)
+        next unless all.any?
+        ran = true
+        tt += tests; ta += assertions; tf += failures; te += errors
+
+        if tests == 0 || failures + errors > 0
+          puts((red % spec_format) % all)
+          puts out
+          puts err
+        else
+          puts((green % "%6d passed") % tests)
+        end
+
+        break
+      end
+
+      puts(yellow % "       skipped") unless ran
+    end
+  end
+
+  puts(spec_format % [tt, ta, tf, te])
+  exit 1 if some_failed
+end

data/tasks/changelog.rake

@@ -0,0 +1,18 @@
+desc 'update changelog'
+task :changelog do
+  File.open('CHANGELOG', 'w+') do |changelog|
+    `git log -z --abbrev-commit`.split("\0").each do |commit|
+      next if commit =~ /^Merge: \d*/
+      ref, author, time, _, title, _, message = commit.split("\n", 7)
+      ref    = ref[/commit ([0-9a-f]+)/, 1]
+      author = author[/Author: (.*)/, 1].strip
+      time   = Time.parse(time[/Date: (.*)/, 1]).utc
+      title.strip!
+
+      changelog.puts "[#{ref} | #{time}] #{author}"
+      changelog.puts '', "  * #{title}"
+      changelog.puts '', message.rstrip if message
+      changelog.puts
+    end
+  end
+end

data/tasks/gem.rake

@@ -0,0 +1,22 @@
+require 'rake/gempackagetask'
+
+task :gemspec => [:manifest, :changelog] do
+  gemspec_file = "#{GEMSPEC.name}.gemspec"
+  File.open(gemspec_file, 'w+'){|gs| gs.puts(GEMSPEC.to_ruby) }
+end
+
+desc "package and install from gemspec"
+task :install => [:gemspec] do
+  sh "gem build #{GEMSPEC.name}.gemspec"
+  sh "gem install #{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+desc "uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{gem uninstall -x #{GEMSPEC.name}}
+end
+
+Rake::GemPackageTask.new(GEMSPEC) do |p|
+  p.need_tar = true
+  p.need_zip = true
+end

data/tasks/gem_installer.rake

@@ -0,0 +1,76 @@
+task :gem_installer do
+  class GemInstaller
+    def initialize(options = {}, &block)
+      @gems = []
+      @options = options
+
+      run(&block)
+    end
+
+    def run(&block)
+      instance_eval(&block) if block_given?
+    end
+
+    def gem(name, version = nil, options = {})
+      if version.respond_to?(:merge!)
+        options = version
+      else
+        options[:version] = version
+      end
+
+      @gems << [name, options]
+    end
+
+    def setup_gemspec(gemspec)
+      gemspec.dependencies.each do |dependency|
+        dependency.version_requirements.as_list.each do |version|
+          gem(dependency.name, version)
+        end
+      end
+
+      setup
+    end
+
+    def setup
+      require 'rubygems'
+      require 'rubygems/dependency_installer'
+
+      @gems.each do |name, options|
+        setup_gem(name, options)
+      end
+    end
+
+    def setup_gem(name, options, try_install = true)
+      print "activating #{name} ... "
+      Gem.activate(name, *[options[:version]].compact)
+      require(options[:lib] || name)
+      puts "success."
+    rescue LoadError => error
+      puts error
+      install_gem(name, options) if try_install
+      setup_gem(name, options, try_install = false)
+    end
+
+    def install_gem(name, options)
+      installer = Gem::DependencyInstaller.new(options)
+
+      temp_argv(options[:extconf]) do
+        print "Installing #{name} ... "
+        installer.install(name, options[:version])
+        puts "done."
+      end
+    end
+
+    def temp_argv(extconf)
+      if extconf ||= @options[:extconf]
+        old_argv = ARGV.clone
+        ARGV.replace(extconf.split(' '))
+      end
+
+      yield
+
+    ensure
+      ARGV.replace(old_argv) if extconf
+    end
+  end
+end

data/tasks/grancher.rake

@@ -0,0 +1,12 @@
+begin
+  require 'grancher/task'
+
+  Grancher::Task.new do |g|
+    g.branch = 'gh-pages'
+    g.push_to = 'origin'
+    g.message = 'Updated website'
+    g.directory 'ydoc', 'doc'
+  end
+rescue LoadError
+  # oh well :)
+end

data/tasks/install_dependencies.rake

@@ -0,0 +1,6 @@
+desc 'install dependencies'
+task :install_dependencies => [:gem_installer] do
+  GemInstaller.new do
+    setup_gemspec(GEMSPEC)
+  end
+end

data/tasks/manifest.rake

@@ -0,0 +1,4 @@
+desc 'update manifest'
+task :manifest do
+  File.open('MANIFEST', 'w+'){|io| io.puts(*GEMSPEC.files) }
+end

data/tasks/rcov.rake

@@ -0,0 +1,19 @@
+desc 'code coverage'
+task :rcov => :clean do
+  specs = Dir['spec/innate/**/*.rb']
+  specs -= Dir['spec/innate/cache/common.rb']
+
+  # we ignore adapter as this has extensive specs in rack already.
+  ignore = %w[ gem rack bacon innate/adapter\.rb ]
+  ignore << 'fiber\.rb' if RUBY_VERSION < '1.9'
+
+  ignored = ignore.join(',')
+
+  cmd = "rcov --aggregate coverage.data --sort coverage -t --%s -x '#{ignored}' %s"
+
+  while spec = specs.shift
+    puts '', "Gather coverage for #{spec} ..."
+    html = specs.empty? ? 'html' : 'no-html'
+    sh(cmd % [html, spec])
+  end
+end

data/tasks/release.rake

@@ -0,0 +1,12 @@
+desc 'publish to github'
+task :release => [:reversion, :gemspec] do
+  name, version = GEMSPEC.name, GEMSPEC.version
+
+  sh("git add MANIFEST CHANGELOG #{name}.gemspec lib/#{name}/version.rb")
+
+  puts "I added the relevant files, you can now run:", ''
+  puts "git commit -m 'Version #{version}'"
+  puts "git tag -a -m '#{version}' '#{version}'"
+  puts "git push"
+  puts
+end

data/tasks/reversion.rake

@@ -0,0 +1,8 @@
+desc "update version.rb"
+task :reversion do
+  File.open("lib/#{GEMSPEC.name}/version.rb", 'w+') do |file|
+    file.puts("module #{PROJECT_MODULE}")
+    file.puts('  VERSION = %p' % GEMSPEC.version.to_s)
+    file.puts('end')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: manveru-org
 version: !ruby/object:Gem::Version 
-  version: 2009.02.21
+  version: 2009.03.28
 platform: ruby
 authors: 
 - Michael 'manveru' Fellinger
@@ -9,20 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 -08:00
+date: 2009-03-28 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.4.0
-    version: 
-description: Simple, straight-forward, base for web-frameworks.
+dependencies: []
+
+description: transformation of a subset of org-mode markup to html.
 email: m.fellinger@gmail.com
 executables: []
 
@@ -31,7 +22,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- CHANGELOG
+- MANIFEST
 - README.md
+- Rakefile
 - doc/syntax.org
 - lib/org.rb
 - lib/org/markup.rb
@@ -44,7 +38,19 @@ files:
 - lib/org/to/html.rb
 - lib/org/to/toc.rb
 - lib/org/token.rb
+- lib/org/version.rb
+- org.gemspec
 - spec/org.rb
+- tasks/bacon.rake
+- tasks/changelog.rake
+- tasks/gem.rake
+- tasks/gem_installer.rake
+- tasks/grancher.rake
+- tasks/install_dependencies.rake
+- tasks/manifest.rake
+- tasks/rcov.rake
+- tasks/release.rake
+- tasks/reversion.rake
 has_rdoc: true
 homepage: http://github.com/manveru/org
 post_install_message: 
@@ -70,6 +76,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Powerful web-framework wrapper for Rack.
+summary: transformation of a subset of org-mode markup to html.
 test_files: []