jekyll-pseudo 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea
+*.iml

data/.ruby-version

@@ -0,0 +1 @@
+ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-pseudo.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# jekyll-pseudo
+A pseudocode/algorithm formatter for sites powered by jekyll.
+
+Sometimes you don't want to use a particular programming language to
+demonstrate a concept because of the syntactic overhead. Jekyll-Pseudo lets
+you use a gently styled free-formated representation.
+
+## Language
+* indentation is preserved
+* a word beginning with a capital letter is a keyword
+* a word followed by parentheses is a function name
+* all other words are variables
+* words within double quotes are generally strings
+
+* these symbols are auto-formatted: `<-- <= >= --> =`
+
+
+Sample output:
+
+    {% pseudo %}
+    Function swap(old, new)
+      remaining <- quorumSize
+      success <- False
+      For Each host
+        result[host] <- send(host, propose(old, new))
+        If result[host] = "ok"
+          remaining--
+
+      If remaining > 1+quorumSize/2
+        success <- True
+
+      For Each result
+        If success
+          send(host, confirm(old, new))
+        Else
+          send(host, cancel(old, new))
+    {% endpseudo %}
+
+## Output
+Output is annotated with `<span>` classes and can be styled using CSS. Typically keywords are made bold and variables are italicized.
+
+With a bit of formatting, the above code becomes:
+
+![Image](https://raw.github.com/wkm/jekyll-pseudo/master/doc/samplecode.png)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-pseudo.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jekyll-pseudo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jekyll-pseudo"
+  s.version     = Jekyll::Pseudo::VERSION
+  s.authors     = ["Wiktor Macura"]
+  s.email       = ["wmacura@gmail.com"]
+  s.homepage    = "http://github.com/wkm/jekyll-pseudo"
+  s.summary     = %q{A trivial jekyll plugin for formatting pseudocode}
+  s.description = %q{jekyll-pseudo helps typeset pseudocode with minimal formatting}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "jekyll"
+end

data/lib/jekyll-pseudo.rb

@@ -0,0 +1,23 @@
+require 'liquid'
+require 'jekyll-pseudo/version'
+require 'jekyll-pseudo/grammar'
+require 'jekyll-pseudo/html_brush'
+
+module Jekyll
+  class PseudoBlock < Liquid::Block
+    def initialize(tag_name, text, tokens)
+      super
+      @brush = Pseudo::HtmlBrush.new
+      @grammar = Pseudo::Grammar.new
+    end
+
+    def render(context)
+      @text = @nodelist.join('')
+      @formatted = @grammar.format(@text, @brush)
+      "<div class='pseudo'>#{@formatted}</div>"
+    end
+  end
+end
+
+
+Liquid::Template.register_tag('pseudo', Jekyll::PseudoBlock)

data/lib/jekyll-pseudo/brush.rb

@@ -0,0 +1,40 @@
+module Jekyll
+  module Pseudo
+    class Brush
+      # format a symbol
+      def sym(txt)
+        raise 'not implemented'
+      end
+
+      # format a function
+      def fn(txt)
+        raise 'not implemented'
+      end
+
+      # format a variable
+      def var(txt)
+        raise 'not implemented'
+      end
+
+      # format a comment
+      def comment(txt)
+        raise 'not implemented'
+      end
+
+      # format an operator
+      def op(txt)
+        raise 'not implemented'
+      end
+
+      # format a string
+      def string(txt)
+        raise 'not implemented'
+      end
+
+      # render plain text
+      def plain(txt)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/jekyll-pseudo/grammar.rb

@@ -0,0 +1,56 @@
+module Jekyll
+  module Pseudo
+    class Grammar
+      # format a block of text, giving html as output
+      def format(txt, brush)
+        results = []
+
+        mappings = [
+          [/\#(.*$)/, :comment],
+          [/\b([A-Z]\w+)/, :sym],
+          [/(\w+)(?=[({\[])/, :fn],
+          [/(\".*?\")/, :string],
+          [/(<-|->|\+\+|<=|>=|--)/, :op], # try these operations first
+          [/([-()\[\]{}=<>+])/, :op],     # and these second
+          [/^(\s)+/, :indent]
+        ]
+        
+        txt.strip!
+
+        # lazy man's parser (we don't do that backtracking business)
+        cursor = 0
+        while true
+          matches = mappings.map do |pair|
+            [pair[0].match(txt, cursor), pair[1]]
+          end
+
+          upto = matches.min_by do |pair|
+            matchdata = pair[0]
+            if matchdata == nil
+              txt.size
+            else
+              matchdata.begin(0)
+            end
+          end
+
+          if upto[0] != nil
+            results << brush.plain(txt.slice(cursor, upto[0].begin(0)-cursor))
+
+            match = upto[0][1]
+            # which match?
+            results << brush.method(upto[1]).call(match)
+            cursor = upto[0].end(1)
+          else
+            # no matches remaining
+            results << brush.plain(txt.slice(cursor, txt.size))
+            break
+          end
+        end
+
+        # puts "FINAL: #{results.inspect}"
+        # puts "     = #{results.join('').inspect}"
+        return results.join('')
+      end
+    end
+  end
+end

data/lib/jekyll-pseudo/html_brush.rb

@@ -0,0 +1,49 @@
+require 'jekyll-pseudo/brush'
+
+module Jekyll
+  module Pseudo
+    class HtmlBrush < Jekyll::Pseudo::Brush
+      def sym(txt)
+        "<span class='symbol'>#{txt}</span>"
+      end
+
+      def fn(txt)
+        "<span class='function'>#{txt}</span>"
+      end
+
+      def var(txt)
+        "<span class='variable'>#{var}</span>"
+      end
+
+      def comment(txt)
+        "<span class='comment'>/* #{txt.strip} */</span>"
+      end
+
+      def string(txt)
+        "<span class='string'>#{txt}</span>"
+      end
+
+      def indent(txt)
+        "<span class='indent'>#{txt}</span>"
+      end
+
+      def op(txt)
+        symbol = case txt
+        when '<' then '&lt;'
+        when '>' then '&gt;'
+        when '<=' then '&le;'
+        when '>=' then '&ge;'
+        when '<-' then '&larr;'
+        when '->' then '&rarr;'
+        else txt
+        end
+        # FIXME: html conversion for some operators
+        "<span class='op'>#{symbol}</span>"
+      end
+
+      def plain(txt)
+        txt
+      end
+    end
+  end
+end

data/lib/jekyll-pseudo/mock_brush.rb

@@ -0,0 +1,39 @@
+require 'jekyll-pseudo/brush'
+
+module Jekyll
+  module Pseudo
+    class MockBrush < Brush
+      def sym(txt)
+        "sym(#{txt})"
+      end
+
+      def fn(txt)
+        "fn(#{txt})"
+      end
+
+      def var(txt)
+        "var(#{var})"
+      end
+
+      def comment(txt)
+        "c(#{txt})"
+      end
+
+      def op(txt)
+        "op(#{txt})"
+      end
+
+      def string(txt)
+        "str(#{txt})"
+      end
+
+      def indent(txt)
+        "i(#{txt})"
+      end
+
+      def plain(txt)
+        txt
+      end
+    end
+  end
+end

data/lib/jekyll-pseudo/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Pseudo
+    VERSION = "0.1.0"
+  end
+end

data/spec/grammar_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../lib/jekyll-pseudo.rb'
+require_relative '../lib/jekyll-pseudo/mock_brush.rb'
+# require 'spec_helper'
+
+include Jekyll::Pseudo
+
+describe Grammar do
+  def format(txt)
+    g = Grammar.new
+    g.format(txt, MockBrush.new)
+  end
+  
+  describe "#format" do
+    it "ignores plain text" do
+      format("plain text").should eql "plain text"
+    end
+
+    it "formats symbols" do
+      format("For").should eql "sym(For)"
+      format("For this").should eql "sym(For) this"
+      format("If Then").should eql "sym(If) sym(Then)"
+      format("If Then that").should eql ("sym(If) sym(Then) that")
+    end
+
+    it "formats comments" do
+      format("oh #hi\n there").should eql "oh c(hi)\ni( )there"
+    end
+
+    it "formats operators" do
+      format("For a < b").should eql("sym(For) a op(<) b")
+    end
+
+    it 'formats strings' do
+      format('oh "what" a world!').should eql 'oh str("what") a world!'
+    end
+
+    it 'formats functions' do
+      format('fn(b,c)').should eql('fn(fn)op(()b,cop())')
+      format('fn[b,c]').should eql('fn(fn)op([)b,cop(])')
+      format('fn{b,c}').should eql('fn(fn)op({)b,cop(})')
+    end
+  end
+end

data/spec/html_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/jekyll-pseudo.rb'
+require_relative '../lib/jekyll-pseudo/mock_brush.rb'
+# require 'spec_helper'
+
+include Jekyll::Pseudo
+
+describe HtmlBrush do
+  def format(txt)
+    g = Grammar.new
+    g.format(txt, HtmlBrush.new)
+  end
+
+  describe "#format" do
+    it "symbol span" do
+      format("For").should eql "<span class='symbol'>For</span>"
+    end
+
+    it "fn span" do
+      format("fn()").should eql "<span class='function'>fn</span><span class='op'>(</span><span class='op'>)</span>"
+    end
+
+    it "comment span" do
+      format("# hi!").should eql "<span class='comment'>/* hi! */</span>"
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: jekyll-pseudo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wiktor Macura
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jekyll
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: jekyll-pseudo helps typeset pseudocode with minimal formatting
+email: 
+- wmacura@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .ruby-version
+- Gemfile
+- README.md
+- Rakefile
+- doc/samplecode.png
+- jekyll-pseudo.gemspec
+- lib/jekyll-pseudo.rb
+- lib/jekyll-pseudo/brush.rb
+- lib/jekyll-pseudo/grammar.rb
+- lib/jekyll-pseudo/html_brush.rb
+- lib/jekyll-pseudo/mock_brush.rb
+- lib/jekyll-pseudo/version.rb
+- spec/grammar_spec.rb
+- spec/html_spec.rb
+has_rdoc: true
+homepage: http://github.com/wkm/jekyll-pseudo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A trivial jekyll plugin for formatting pseudocode
+test_files: 
+- spec/grammar_spec.rb
+- spec/html_spec.rb