jekyll-pseudocode 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a51b68d46cbd01b77363100383fef7df319bd65c
+  data.tar.gz: 0d9a29b14040cb8bc6777b4f0b5abe04839c7b7d
+SHA512:
+  metadata.gz: 04e6f11f961ba2f3552d6ad83bd606c114e3eca1cb38a6f3538ab9ffd91884da6302cbcf0dbf4528dfc8b03aa1007b0faa6df7f04786c3843f8cb68966cccd30
+  data.tar.gz: 490b282dea171022a112c850253e8aed6d5a3d3eda36a7060f6e30a433597a5330fcc28d6c924cf0fd9e05be4d42fb862042af75c46abcc43b797e417b195335

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-pseudocode.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Victor Eduardo Bazterra
+
+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/README.md

@@ -0,0 +1,42 @@
+# jekyll-pseudocode
+A pseudocode/algorithm formatter for sites powered by jekyll. This is a fork from wkm/jekyll-pseudo.
+
+Sometimes you don't want to use a particular programming language to
+demonstrate a concept because of the syntactic overhead. jekyll-pseudocode 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.
+
+Using the style provided in `lib/jekyll-pseudocode.css` previous markdown should be rendered as:
+
+![Image](https://raw.github.com/baites/jekyll-pseudocode/master/doc/screenshot.png)

data/Rakefile

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

data/jekyll-pseudocode.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jekyll-pseudocode/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jekyll-pseudocode"
+  s.version     = Jekyll::PseudoCode::VERSION
+  s.authors     = ["Victor Bazterra"," Wiktor Macura"]
+  s.email       = ["bazterra@gmail.com", "wmacura@gmail.com"]
+  s.homepage    = "http://github.com/baites/jekyll-pseudocode"
+  s.summary     = %q{A trivial jekyll plugin for pseudocode fork from jekyll-pseudo}
+  s.description = %q{jekyll-pseudocode 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-pseudocode.css

@@ -0,0 +1,23 @@
+---
+---
+
+@import "{{ site.theme }}";
+
+.pseudocode {
+  text-indent: 50px;
+  font-family: "Courier New", Courier, monospace;
+  white-space: pre-wrap;
+}
+
+.symbol {
+  font-weight: bold;
+  text-transform: lowercase;
+}
+
+.function {
+  text-transform: uppercase;
+}
+
+.variable {
+  font-style: italic;
+}

data/lib/jekyll-pseudocode.rb

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

data/lib/jekyll-pseudocode/brush.rb

@@ -0,0 +1,40 @@
+module Jekyll
+  module PseudoCode
+    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, sub)
+        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-pseudocode/grammar.rb

@@ -0,0 +1,68 @@
+module Jekyll
+  module PseudoCode
+    class Grammar
+      # parse a block of text, using the given brush to format output (works in a single pass)
+      def format(txt, brush)
+        results = []
+
+        mappings = [
+          [/\#(.*$)/, :comment],
+          [/\b([A-Z]\w+)/, :sym],
+          [/(\w+)(?=[(])/, :fn],
+          [/(\".*?\")/, :string],
+          [/(<-|->|\+\+|<=|>=|--)/, :op],  # try these operators first
+          [/([-()\[\]{}=<>+*])/, :op],     # and these second
+          [/\b([a-z][a-zA-Z0-9]*)(_[a-zA-Z0-9]+)?/, :var],
+          [/^(\s+)/, :indent]
+        ]
+
+        # replace tabs with three spaces
+        txt.gsub! /^\t/, '   '
+
+        # count leading whitespace
+        ws = txt.scan(/^ */).map do |leading|
+          leading.size
+        end
+        leading = (ws.min or 0)
+
+        # remove leading whitespace of the given length
+        if leading > 0
+          r = /^ {#{leading}}/
+          txt.gsub! r, ''
+        end
+
+        # lazy man's parser (we don't do any of that silly backtracking)
+        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))
+
+            # which match?
+            captures = upto[0].captures
+            results << brush.method(upto[1]).call(*captures)
+            cursor = upto[0].end(0)
+          else
+            # no matches remaining
+            results << brush.plain(txt.slice(cursor, txt.size))
+            break
+          end
+        end
+
+        return results.join('')
+      end
+    end
+  end
+end

data/lib/jekyll-pseudocode/html_brush.rb

@@ -0,0 +1,57 @@
+require 'jekyll-pseudocode/brush'
+
+module Jekyll
+  module PseudoCode
+    class HtmlBrush < Jekyll::PseudoCode::Brush
+      def sym(txt)
+        "<span class='symbol'>#{txt}</span>"
+      end
+
+      def fn(txt)
+        "<span class='function'>#{txt}</span>"
+      end
+
+      def var(txt, sub)
+        if sub
+          "<span class='variable'>#{txt}<sub>#{sub.slice(1,sub.size)}</sub></span>"
+        else
+          "<span class='variable'>#{txt}</span>"
+        end
+      end
+
+      def comment(txt)
+        "<span class='comment'>/* #{txt.strip} */</span>"
+      end
+
+      def string(txt)
+        "<span class='string'>#{txt}</span>"
+      end
+
+      def indent(txt)
+        txt.gsub! "\t", '   '
+        "<span class='indent'>#{txt}</span>"
+      end
+
+      def op(txt)
+        symbol = case txt
+        when '<' then '&#12296;'
+        when '>' then '&#12297;'
+        when '<=' then '&le;'
+        when '>=' then '&ge;'
+        when '<-' then '&larr;'
+        when '->' then '&rarr;'
+        when '*' then '&times;'
+        when '[' then '&#65339;'
+        when ']' then '&#65341;'
+        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-pseudocode/mock_brush.rb

@@ -0,0 +1,43 @@
+require 'jekyll-pseudocode/brush'
+
+module Jekyll
+  module PseudoCode
+    class MockBrush < Brush
+      def sym(txt)
+        "sym(#{txt})"
+      end
+
+      def fn(txt)
+        "fn(#{txt})"
+      end
+
+      def var(txt, sub)
+        if sub
+          "#{txt}sub(#{sub.slice(1,sub.size)})"
+        else
+          txt
+        end
+      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-pseudocode/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PseudoCode
+    VERSION = "0.1.3"
+  end
+end

data/spec/grammar_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../lib/jekyll-pseudocode.rb'
+require_relative '../lib/jekyll-pseudocode/mock_brush.rb'
+
+include Jekyll::PseudoCode
+
+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 variables' do
+      format('x_0').should eql ('xsub(0)')
+      format('x_i').should eql ('xsub(i)')
+    end
+
+    it 'formats functions' do
+      format('fn(b,c)').should eql('fn(fn)op(()b,cop())')
+    end
+
+    it 'strips leading whitespace' do
+      format("\thi\n\tthere").should eql("hi\nthere")
+      format("\thi\n\t\tthere").should eql("hi\ni(\t)there")
+      format("\t\thi\n\tthere").should eql("i(\t)hi\nthere")
+    end
+  end
+end

data/spec/html_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../lib/jekyll-pseudocode.rb'
+require_relative '../lib/jekyll-pseudocode/mock_brush.rb'
+# require 'spec_helper'
+
+include Jekyll::PseudoCode
+
+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
+
+    it "variable span" do
+      format("a_b").should eql "<span class='variable'>a<sub>b</sub></span>"
+    end
+
+    it "operator converstions" do
+      format("<").should eql "<span class='op'>&#12296;</span>"
+      format("*").should eql "<span class='op'>&times;</span>"
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pseudocode
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Victor Bazterra
+- " Wiktor Macura"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: jekyll-pseudocode helps typeset pseudocode with minimal formatting
+email:
+- bazterra@gmail.com
+- wmacura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/screenshot.png
+- jekyll-pseudocode.gemspec
+- lib/jekyll-pseudocode.css
+- lib/jekyll-pseudocode.rb
+- lib/jekyll-pseudocode/brush.rb
+- lib/jekyll-pseudocode/grammar.rb
+- lib/jekyll-pseudocode/html_brush.rb
+- lib/jekyll-pseudocode/mock_brush.rb
+- lib/jekyll-pseudocode/version.rb
+- spec/grammar_spec.rb
+- spec/html_spec.rb
+homepage: http://github.com/baites/jekyll-pseudocode
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A trivial jekyll plugin for pseudocode fork from jekyll-pseudo
+test_files:
+- spec/grammar_spec.rb
+- spec/html_spec.rb