jekyll-pseudocode-b 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a206281381f3106b1d82cc74b939b8ab10ec3ee
+  data.tar.gz: 7d81b69ca7f21bfbd8fcea8147f99244ab429a21
+SHA512:
+  metadata.gz: dadf8baefeda70808d11d0a76d5a2ffab0d462611dd53ded0957bdc3af1ac18d168b1b376ad565eaf198c98f0c93c1e8f9e909e39dbe2d60fbc398b73f3f9697
+  data.tar.gz: 891fbd1fc6c702d5746fb5b79211873f8e53e59d1e250310a8741639b5ad52ca180796b1c11cde3b2f52d8cca3b50764466bf71872e39d5960106c63c05ea932

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

data/README.md

@@ -0,0 +1,108 @@
+# jekyll-pseudocode-b
+_A pseudocode/algorithm formatter for sites powered by Jekyll._
+
+This is a updated fork from **[wkm/jekyll-pseudo](https://github.com/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-b** lets
+you use a gently styled free-formated representation.
+
+
+
+## Usage:
+
+0. Install the `gem`
+
+```
+gem install jekyll-pseudocode-b
+```
+
+1. Add the following line to your site's `Gemfile`
+
+```GemFile
+gem 'jekyll-pseudocode-b'
+```
+
+2. And add the following line to your site plugin's `_config.yml`
+
+```yml
+plugins:
+  - jekyll-pseudocode-b
+```
+
+Note: if `jekyll --version` is less than `3.5` use:
+
+```yml
+gems:
+  - jekyll-pseudocode-b
+```
+
+## 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
+* Variables that calls a function can reproduce the following output: `myVar.FUNCTION(a);`
+
+## Auto-Formatted Syntax
+
+The following table shows auto-formated symbols:
+
+| Syntax | Symbol   |
+| :------: | :--------: |
+| <-     | &#x2190; |
+| ->     | &#x2192; |
+| <--    | &#x27f5; |
+| -->    | &#x27f6; |
+| =>     | &#x2265; |
+| <=     | &#x2264; |
+| ==     | &#xff1d; |
+| :=     | &#x2254; |
+| =      | &#x3d;   |
+| <      | &#65308; |
+| >      | &#65310; |
+| [      | &#65339; |
+| ]      | &#65341; |
+| <->    | &#x2194; |
+| <-->   | &#x27f7; |
+| $pi     | &#x3C0;  |
+| $tau    | &#x1d6d5;  |
+
+## Output
+
+Output is annotated with `<span>` classes and can be styled using CSS. Typically keywords are made bold and variables are italicized. Using the following code lines:
+
+    {% pseudocode %}
+    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))
+    {% endpseudocode %}
+
+With a bit of formatting, the above code becomes:
+
+![Image](https://raw.githubusercontent.com/tobiasbu/jekyll-pseudo/master/doc/output-sample.png)
+
+## More Styles
+
+You can also create your own style for pseudo-codes like images below. Check on the `css` folder for CSS files examples.
+
+_Comming soon_
+
+## Author
+
+[Wiktor Macura](https://github.com/wkm) is the author of this plugin. This is fork for updated version with some new features. Also it's based on the fork of [Victor Bazterra](https://github.com/baites).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/jekyll-pseudocode-b.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jekyll-pseudocode-b/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "jekyll-pseudocode-b"
+  spec.version     = Jekyll::PseudoCodeB::VERSION
+  spec.authors     = ["Tobias Ulrich", "Victor Bazterra", "Wiktor Macura"]
+  spec.email       = ["tobiasbulrich@gmail.com","bazterra@gmail.com", "wmacura@gmail.com"]
+  spec.homepage    = "http://github.com/wkm/jekyll-pseudo"
+  spec.summary     = %q{A trivial jekyll plugin for formatting pseudocode}
+  spec.description = %q{jekyll-pseudocode helps typeset pseudocode with minimal formatting}
+  spec.licenses = ["MIT"]
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  spec.add_runtime_dependency "jekyll", "~> 3.0"
+
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rake", "~> 12"
+end

data/lib/jekyll-pseudocode-b/brush.rb

@@ -0,0 +1,54 @@
+module Jekyll
+  module PseudoCodeB
+    class Brush
+      # format a symbol
+      def sym(txt)
+        raise 'not implemented'
+      end
+
+      # format a function
+      def fn(txt)
+        raise 'not implemented'
+      end
+
+      # format a object call function
+      def objfn(txt)
+        raise 'not implemented'
+      end
+
+      # format a variable
+      def variable(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
+
+      # render math symbols
+      def math(txt)
+        raise 'not implemented'
+      end
+
+      def number(txt)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/jekyll-pseudocode-b/grammar.rb

@@ -0,0 +1,72 @@
+module Jekyll
+  module PseudoCodeB
+    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],
+          [/\/\/(.*$)/, :comment],
+          [/(\w+)(?=[({\[])/, :fn],
+          [/\b([a-zA-Z0-9]*\w+)\.(\w+)(?=[({\[])/, :objfn], # obj calls funcion
+          [/\b([A-Z]\w+)/, :sym],
+          [/(\".*?\")/, :string],
+          [/(<-|->|\+\+|<=|>=|--|!=|:=|==|<>|<->|<-->|<--|-->)/, :op],  # try these operators first
+          [/([-()\[\]{}=<>+*\/])/, :op],     # and these second
+          [/(\$pi|\$tau)/, :math],
+          [/\b([0-9]*\.?[0-9]+)/, :number],
+          [/\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-b/html_brush.rb

@@ -0,0 +1,103 @@
+require 'jekyll-pseudocode-b/brush'
+
+module Jekyll
+  module PseudoCodeB
+    class HtmlBrush < Jekyll::PseudoCodeB::Brush
+
+      def is_numeric?(s)
+        begin
+          Float(s)
+        rescue
+          false # not numeric
+        else
+          true # numeric
+        end
+      end
+
+      def sym(txt)
+        "<span class='symbol'>#{txt}</span>"
+      end
+
+
+      def fn(txt)
+        "<span class='function'>#{txt}</span>"
+      end
+
+      def objfn(obj, fnc)
+        "<span class='variable'>#{obj}</span><span class='operator'>.</span><span class='function'>#{fnc}</span>"
+      end
+
+      def number(txt)
+        "<span class='numeric'>#{txt}</span>"
+      end
+
+      def var(txt, sub)
+        if sub
+          "<span class='variable'>#{txt}<sub>#{sub.slice(1,sub.size)}</sub></span>"
+        else
+          if (is_numeric?(txt))
+            "<span class='numeric'>#{txt}</span>"
+          else
+            "<span class='variable'>#{txt}</span>"
+          end
+        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 '&#65308;'
+        when '>' then '&#65310;'
+        when '<=' then '&#x2264;'
+        when '>=' then '&#x2265;'
+        when '<-' then '&#x2190;'
+        when '->' then '&#x2192;'
+        when '<--' then '&#x27f5;'
+        when '-->' then '&#x27f6;'
+        when '<->' then '&#x2194;'
+        when '<-->' then '&#x27f7;'
+        when '*' then '&times;'
+        when '[' then '&#65339;'
+        when ']' then '&#65341;'
+        when '!=' then '&#x2260;'
+        when '<>' then '&#x2260;'
+        when '=' then '&#x3d;'
+        when ':=' then '&#x2254;'
+        when '+' then '&#x2b;'
+        when '-' then '-'
+        when '/' then '/'
+        when '==' then '&#xff1d;'
+        else txt
+        end
+        # FIXME: html conversion for some operators
+        "<span class='operator'>#{symbol}</span>"
+      end
+
+      def math(txt)
+        symbol = case txt
+        when '$pi' then '&#x3C0;'
+        when '$tau' then '&#x1d6d5;'
+        else txt
+        end
+        # FIXME: html conversion for some operators
+        "<span class='math-symbol'>#{symbol}</span>"
+      end
+
+      def plain(txt)
+        "#{txt}"
+      end
+    end
+  end
+end

data/lib/jekyll-pseudocode-b/mock_brush.rb

@@ -0,0 +1,59 @@
+require 'jekyll-pseudocode-b/brush'
+
+module Jekyll
+  module PseudoCodeB
+    class MockBrush < Brush
+      def sym(txt)
+        "sym(#{txt})"
+      end
+
+      def fn(txt)
+        "fn(#{txt})"
+      end
+
+      def objfn(obj, fnc)
+        "v(#{obj})op(.)fn(#{fnc})"
+      end
+
+      def variable(txt)
+        "v(#{txt})"
+      end
+
+      def number(txt)
+        "num(#{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 math(txt)
+        "math(#{txt})"
+      end
+
+      def plain(txt)
+        txt
+      end
+    end
+  end
+end

data/lib/jekyll-pseudocode-b/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PseudoCodeB
+    VERSION = "0.1.1"
+  end
+end

data/lib/jekyll-pseudocode-b.rb

@@ -0,0 +1,40 @@
+require 'liquid'
+require 'jekyll-pseudocode-b/version'
+require 'jekyll-pseudocode-b/grammar'
+require 'jekyll-pseudocode-b/html_brush'
+
+
+class String
+
+  def remove_lines(i)
+    split("\n")[i..-1].join("\n")
+  end
+
+end
+
+module Jekyll
+  class PseudoCodeBlockB < Liquid::Block
+    def initialize(tag_name, text, tokens)
+      super
+      @brush = PseudoCodeB::HtmlBrush.new
+      @grammar = PseudoCodeB::Grammar.new
+    end
+
+    
+
+    def render(context)
+      @text = super
+
+      # for some reason is adding a line to initial code
+      # let's removes
+      @text = @text.remove_lines(1)
+
+      @formatted = @grammar.format(@text, @brush)
+      
+      "<div class='pseudocode'>#{@formatted}</div>"
+    end
+  end
+end
+
+
+Liquid::Template.register_tag('pseudocode', Jekyll::PseudoCodeBlockB)

data/spec/grammar_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../lib/jekyll-pseudocode-b.rb'
+require_relative '../lib/jekyll-pseudocode-b/mock_brush.rb'
+require 'spec_helper'
+
+include Jekyll::PseudoCodeB
+
+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 number" do
+      format("1234").should eql "num(1234)"
+      format("1234.1234").should eql "num(1234.1234)"
+    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())')
+      format('fn[b,c]').should eql('fn(fn)op([)b,cop(])')
+      format('fn{b,c}').should eql('fn(fn)op({)b,cop(})')
+    end
+
+    it 'formats objects functions' do
+      format('obj.fn(b,c)').should eql('v(obj)op(.)fn(fn)op(()b,cop())')
+      format('obj.fn[b,c]').should eql('v(obj)op(.)fn(fn)op([)b,cop(])')
+      format('obj.fn{b,c}').should eql('v(obj)op(.)fn(fn)op({)b,cop(})')
+      format('ObjCapital.fn{b,c}').should eql('v(ObjCapital)op(.)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,43 @@
+require_relative '../lib/jekyll-pseudocode-b.rb'
+require_relative '../lib/jekyll-pseudocode-b/mock_brush.rb'
+require 'spec_helper'
+
+include Jekyll::PseudoCodeB
+
+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='operator'>(</span><span class='operator'>)</span>"
+    end
+
+    it "obj fn span" do
+      format("obj.fn()").should eql "<span class='variable'>obj</span><span class='operator'>.</span><span class='function'>fn</span><span class='operator'>(</span><span class='operator'>)</span>"
+    end
+
+    it "numeric span" do
+      format("1234").should eql "<span class='numeric'>1234</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='operator'>&#65308;</span>"
+      format("*").should eql "<span class='operator'>&times;</span>"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+
+
+RSpec.configure do |config|
+    config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+
+    config.mock_with :rspec do |mocks|
+        mocks.syntax = [:should, :receive]
+    end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pseudocode-b
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tobias Ulrich
+- Victor Bazterra
+- Wiktor Macura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+description: jekyll-pseudocode helps typeset pseudocode with minimal formatting
+email:
+- tobiasbulrich@gmail.com
+- bazterra@gmail.com
+- wmacura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- doc/output-sample.png
+- doc/samplecode.png
+- jekyll-pseudocode-b.gemspec
+- lib/jekyll-pseudocode-b.rb
+- lib/jekyll-pseudocode-b/brush.rb
+- lib/jekyll-pseudocode-b/grammar.rb
+- lib/jekyll-pseudocode-b/html_brush.rb
+- lib/jekyll-pseudocode-b/mock_brush.rb
+- lib/jekyll-pseudocode-b/version.rb
+- spec/grammar_spec.rb
+- spec/html_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wkm/jekyll-pseudo
+licenses:
+- MIT
+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.14
+signing_key: 
+specification_version: 4
+summary: A trivial jekyll plugin for formatting pseudocode
+test_files: []