mallinna 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05a38f928da3bea1a216060832b7a371efcae6e7
+  data.tar.gz: 7262a8d7a83b458fe5c1943bb101013e402b546a
+SHA512:
+  metadata.gz: 565b2a393437c24dcebe207cb1efa4e828b819d6bb980dd7a17dc13f28124f8f2eb15aebe2410a91f589c320e8690e92322069bf2d4fe0503eb1af8f54a8bc2c
+  data.tar.gz: ac44b2df593e894b243eaac63e41892d3c2ee74b5920f2230c0fe49273528f077215a213a4aa21a7870c11a908a55ebca57f0b8cda6419b332856a4b9e425732

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# Malline
+
+Malline is template engine targeting IOS/JunOS or generally configurations (or
+more accurately what ever text stuff I'm doing).
+
+It surfaced from the need to do something like this in ERB:
+```
+interfaces {
+  <%= name %> {
+    description "<%if description %>";
+  }
+}
+```
+
+where description "description"; is only output if the code evaluates true,
+keeping the template clean in common use-case
+
+```
+Consider this code
+require_relative './lib/malline'
+require 'pry'
+class Int
+  attr_accessor :name, :mtu, :description, :poop
+  def initialize
+    @name = 'xe-1/2/3.42'
+    @mtu = 1500
+    @description = 'K: S-123455 - poop customer'
+    @poop = true
+  end
+  def get_binding
+    binding
+  end
+end
+
+template = <<EOF
+interfaces {
+   <% name %> {
+     mtu <%if mtu %>;
+     description "<%if description %>";
+   }
+}
+EOF
+
+int = Int.new
+cfg = Malline.run template, int.get_binding
+binding.pry
+```
+
+Real use might look something like this:
+```
+[1] pry(main)> puts cfg
+interfaces {
+   xe-1/2/3.42 {
+     mtu 1500;
+     description "K: S-123455 - poop customer";
+   }
+}
+=> nil
+[2] pry(main)> int.mtu = 900
+=> 900
+[3] pry(main)> int.description = nil
+=> nil
+[4] pry(main)> puts Malline.run template, int.get_binding
+interfaces {
+   xe-1/2/3.42 {
+     mtu 900;
+   }
+}
+=> nil
+```
+
+
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake/testtask'
+
+rule '.rb' => '.y' do |t|
+  sh "racc -l -o #{t.name} #{t.source}"
+end
+gemspec = eval(File.read(Dir['*.gemspec'].first))
+file    = [gemspec.name, gemspec.version].join('-') + '.gem'
+
+desc 'Validate gemspec'
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run minitest'
+task :test => :compile do
+  Rake::TestTask.new do |t|
+    t.libs.push "lib"
+    all = FileList['spec/*_spec.rb']
+    first = %w(spec/lexer_spec.rb spec/handler_spec.rb)
+    t.test_files = [first, all-first].flatten
+    t.verbose = true
+  end
+end
+
+desc 'Compile RACC parser'
+task :compile => 'lib/malline/parser.rb'
+
+desc 'Build gem'
+task :build => [:gemspec, :test] do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p 'gems'
+  FileUtils.mv file, 'gems'
+end
+
+desc 'Install gem'
+task :install => :build do
+  system "sudo sh -c \'umask 022; gem install gems/#{file}\'"
+end
+
+desc 'Remove gems'
+task :clean do
+  FileUtils.rm_rf 'gems'
+end
+
+desc 'Push to rubygems'
+task :push do
+  system "gem push gems/#{file}"
+end

data/lib/malline.rb

@@ -0,0 +1,14 @@
+module Malline
+  require_relative './malline/lexer'
+  require_relative './malline/parser'
+  require_relative './malline/compiler.rb'
+
+  def self.run template, binding
+    lex = Lexer.new template
+    par = Parser.new lex
+    han = par.parse
+    com = Compiler.new han.parsed
+    template = com.compile
+    eval(template, binding)
+  end
+end

data/lib/malline/compiler.rb

@@ -0,0 +1,95 @@
+module Malline
+  class Compiler
+    VAR = '_malline_'
+    OUT = VAR + '_out'
+    class InvalidKind < NameError; end
+    attr_reader :out
+    def initialize parsed
+      @parsed = parsed
+      @out = nil
+      @cmd = {
+        :if => {
+          :now  => 0,
+          :line => [],
+          :id   => [],
+        },
+      }
+    end
+
+    def compile
+      @out = resolve(combine)
+    end
+
+    def combine
+      out = []
+      @parsed.each do |e|
+        case kind=e.shift
+        when :data then data(out, *e)
+        when :code then code(out, *e)
+        else
+          raise InvalidKind, "'#{kind}' was not recognized"
+        end
+      end
+      out
+    end
+
+    def data out, str, lines
+      lines = (lines.first .. lines.last).to_a
+      str.lines.each_with_index do |line, index|
+        linenr = lines[index]
+        line = '%s.concat \'%s\'' % [OUT, line.gsub(/'/, %q(\\\'))]
+        out << [line, linenr]
+      end
+    end
+
+    def code out, cmd, str, lines
+      lines = (lines.first .. lines.last).to_a
+      str.lines.each_with_index do |line, index|
+        linenr = lines[index]
+        line = cmd_if(line, lines, @cmd[:if][:now]+=1) if cmd == :if
+        line = '%s.concat %s' % [OUT, line] unless cmd == :s
+        out << ["#{line}.to_s", linenr]
+      end
+    end
+
+
+    def cmd_if str, lines, id
+      name = VAR+'if_'+id.to_s
+      (lines.first .. lines.last).each do |line|
+        @cmd[:if][:line][line] ||= []
+        @cmd[:if][:line][line] << id
+        @cmd[:if][:id][id] = [name, str]
+      end
+      name
+    end
+
+    def resolve out_org
+      out = ["#{OUT}='';"]
+      cmp = []
+      seen = []
+      out_org.each do |line, line_nr|
+        resolve_cmd_if(line_nr, cmp, out) unless seen.include? line_nr
+        seen << line_nr
+        if not cmp.empty?
+          line = line + ' if ' + cmp.join(' and ')
+        end
+        out << line + ';'
+      end
+      out << "#{OUT}"
+      out.join "\n"
+    end
+
+    def resolve_cmd_if line_nr, cmp, out
+      cmp.clear
+      set = []
+      [@cmd[:if][:line][line_nr]].flatten.compact.each do |cmd_id|
+        varname, varvalue = @cmd[:if][:id][cmd_id]
+        set << [varname,varvalue]
+        cmp << varname
+      end
+      set.each do |name, value|
+        out << name + '=' + value + ';'
+      end
+    end
+  end
+end

data/lib/malline/handler.rb

@@ -0,0 +1,17 @@
+module Malline
+  class Handler
+    attr_reader :parsed
+    attr_accessor :token_line
+    def initialize
+      @parsed = []
+    end
+
+    def code string, cmd=nil
+      @parsed << [:code, cmd, string, token_line]
+    end
+
+    def data string
+      @parsed << [:data, string, token_line]
+    end
+  end
+end

data/lib/malline/lexer.rb

@@ -0,0 +1,36 @@
+require 'strscan'
+require 'stringio'
+
+module Malline
+  class Lexer
+    TOKEN = {
+      :START_CODE => /<%(if|s)?/,
+      :END_CODE   => /%>/,
+    }
+
+    def initialize io
+      io  = StringIO.new io if io.class == String
+      @ss = StringScanner.new io.read
+      @token, @state = [], [:CODE, :DATA]
+    end
+
+    def next_token
+      return @token.shift unless @token.empty?
+      return if @ss.eos?
+
+      start = line
+      name = @state.rotate!.first == :DATA ? :START_CODE : :END_CODE
+      if data = @ss.scan_until(TOKEN[name])
+        @token << [name, @ss.matched, start, line]
+        @token << [:CMD, @ss.matched[2..-1], start, line] if @ss.matched.size > 2
+        [:DATA, data[0..-(@ss.matched.size+1)], start, line]
+      else #gobble gobble gobble
+        [:DATA, @ss.scan(/.*/m), start, line]
+      end
+    end
+
+    def line
+      @ss.string[0..@ss.pos].lines.count
+    end
+  end
+end

data/lib/malline/parser.rb

@@ -0,0 +1,152 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.11
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+module Malline
+  class Parser < Racc::Parser
+
+
+require_relative 'handler'
+
+def initialize lexer, handler=Handler.new
+  @lexer   = lexer
+  @handler = handler
+  super()
+end
+
+def next_token
+  token, string, start_line, end_line = @lexer.next_token
+  @handler.token_line = [start_line, end_line]
+  [token, string] if token
+end
+
+def parse
+  do_parse
+  @handler
+end
+##### State transition tables begin ###
+
+racc_action_table = [
+     7,     5,     5,     6,     6,     9,    11,    10,    12,    13,
+    14,    15 ]
+
+racc_action_check = [
+     1,     0,     1,     0,     1,     5,     5,     5,     7,    10,
+    11,    13 ]
+
+racc_action_pointer = [
+    -1,     0,   nil,   nil,   nil,     2,   nil,     8,   nil,   nil,
+     5,     7,   nil,     8,   nil,   nil ]
+
+racc_action_default = [
+    -9,    -9,    -2,    -3,    -4,    -9,    -8,    -9,    -1,    -5,
+    -9,    -9,    16,    -9,    -7,    -6 ]
+
+racc_goto_table = [
+     2,     8,     1 ]
+
+racc_goto_check = [
+     2,     2,     1 ]
+
+racc_goto_pointer = [
+   nil,     2,     0,   nil,   nil ]
+
+racc_goto_default = [
+   nil,   nil,   nil,     3,     4 ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  2, 7, :_reduce_none,
+  1, 7, :_reduce_none,
+  1, 8, :_reduce_none,
+  1, 8, :_reduce_none,
+  2, 9, :_reduce_none,
+  4, 9, :_reduce_6,
+  3, 9, :_reduce_7,
+  1, 10, :_reduce_8 ]
+
+racc_reduce_n = 9
+
+racc_shift_n = 16
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :START_CODE => 2,
+  :END_CODE => 3,
+  :DATA => 4,
+  :CMD => 5 }
+
+racc_nt_base = 6
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "START_CODE",
+  "END_CODE",
+  "DATA",
+  "CMD",
+  "$start",
+  "values",
+  "value",
+  "code_block",
+  "data" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+# reduce 1 omitted
+
+# reduce 2 omitted
+
+# reduce 3 omitted
+
+# reduce 4 omitted
+
+# reduce 5 omitted
+
+def _reduce_6(val, _values, result)
+ @handler.code(val[2], val[1].to_sym) 
+    result
+end
+
+def _reduce_7(val, _values, result)
+ @handler.code val[1] 
+    result
+end
+
+def _reduce_8(val, _values, result)
+ @handler.data val.first 
+    result
+end
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+  end   # class Parser
+  end   # module Malline

data/lib/malline/parser.y

@@ -0,0 +1,40 @@
+class Malline::Parser
+token START_CODE END_CODE DATA CMD
+rule
+  values
+    : values value
+    | value
+    ;
+  value
+    : code_block
+    | data
+    ;
+  code_block
+    : START_CODE END_CODE
+    | START_CODE CMD DATA END_CODE { @handler.code(val[2], val[1].to_sym) }
+    | START_CODE DATA END_CODE     { @handler.code val[1] }
+    ;
+  data : DATA { @handler.data val.first }
+
+end
+
+---- inner
+
+require_relative 'handler'
+
+def initialize lexer, handler=Handler.new
+  @lexer   = lexer
+  @handler = handler
+  super()
+end
+
+def next_token
+  token, string, start_line, end_line = @lexer.next_token
+  @handler.token_line = [start_line, end_line]
+  [token, string] if token
+end
+
+def parse
+  do_parse
+  @handler
+end

data/mallinna.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = 'mallinna'
+  s.version           = '0.0.2'
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = [ 'Saku Ytti' ]
+  s.email             = %w( saku@ytti.fi )
+  s.homepage          = 'https://github.com/ytti/malline'
+  s.summary           = 'Templating language targeting IOS/JunOS configs'
+  s.description       = 'Mostly like ERB, but <%if foo%> conditional will omit whole line unless code evaluates true'
+  s.rubyforge_project =  s.name
+  s.files             = `git ls-files`.split("\n")
+  s.require_path      = 'lib'
+
+  # s.add_dependency 'bundler'
+
+  s.add_development_dependency 'racc'
+end

data/spec/compiler_spec.rb

@@ -0,0 +1,44 @@
+require_relative 'spec_helper.rb'
+
+class Int
+  attr_accessor :name, :mtu, :description, :vrf
+  def initialize
+    @name = 'xe-1/2/3'
+    @mtu = 1500
+    @description = 'K: S-12345 foobar \'quote\' xyzzy'
+    @vrf = 'VRF0001'
+  end
+  def get_binding; binding; end
+end
+
+describe Compiler do
+  #it "can be created with string argument" do
+  #  Lexer.new('k').must_be_instance_of Lexer
+  #end
+
+  #it "can't be created without an argument" do
+  #  ->{Lexer.new}.must_raise ArgumentError
+  #end
+
+  it "must pass junos example" do
+    int = Int.new
+    str = Malline.run TemplateJunOS, int.get_binding
+    str.must_equal ResultJunOS[0]
+    int.description = nil
+    int.mtu = 42
+    str = Malline.run TemplateJunOS, int.get_binding
+    str.must_equal ResultJunOS[1]
+  end
+
+  it "must pass ios example" do
+    int = Int.new
+    int.name = 'GigabitEthernet0/42'
+    str = Malline.run TemplateIOS, int.get_binding
+    str.must_equal ResultIOS[0]
+    int.description = 'f00fc7c8'
+    int.mtu = nil
+    int.vrf = 'xyzzy'
+    str = Malline.run TemplateIOS, int.get_binding
+    str.must_equal ResultIOS[1]
+  end
+end

data/spec/handler_spec.rb

@@ -0,0 +1,22 @@
+require_relative 'spec_helper.rb'
+
+def get_handler string
+  lex = Lexer.new string
+  par = Parser.new lex
+  par.parse
+end
+
+describe Handler do
+
+  it "can be created" do
+    Handler.new.must_be_instance_of Handler
+  end
+
+  it "must get correctly parsed data" do
+    # yeah bit of a cope out :)
+    TEST.each do |tst|
+      han = get_handler tst[:string]
+      han.parsed.must_equal tst[:parsed]
+    end
+  end
+end

data/spec/lexer_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'spec_helper.rb'
+describe Lexer do
+  it "can be created with string argument" do
+    Lexer.new('k').must_be_instance_of Lexer
+  end
+
+  it "can't be created without an argument" do
+    ->{Lexer.new}.must_raise ArgumentError
+  end
+
+  it "must lex correctly" do
+    # yeah bit of a cope out :)
+    TEST.each do |tst|
+      lex = Lexer.new tst[:string]
+      ary, token = [], nil
+      ary << token while token = lex.next_token
+      ary.must_equal tst[:lex]
+    end
+  end
+
+  describe '#line' do
+    it 'must not consider trailing \n as new line' do
+      lex = Lexer.new "foo\n"
+      ss = lex.instance_variable_get :@ss
+      ss.scan_until(/.*/m)
+      lex.line.must_equal 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/malline.rb'
+include Malline
+
+class Int
+  attr_accessor :name, :mtu, :description, :vrf
+  def initialize
+    @name = 'xe-1/2/3'
+    @mtu = 1500
+    @description = 'K: S-12345 foobar \'quote\' xyzzy'
+    @vrf = 'VRF0001'
+  end
+  def get_binding; binding; end
+end
+
+TemplateJunOS = <<EOF
+interfaces {
+   <% name %> {
+     mtu <%if mtu %>;
+     description "<%if description %>";
+   }
+}
+EOF
+TemplateIOS = <<EOF
+interface <% name %>
+  description <%if description %>
+  mtu <%if mtu %>
+  vrf forwarding <%if vrf %>
+EOF
+
+ResultJunOS = []
+ResultJunOS << <<EOF
+interfaces {
+   xe-1/2/3 {
+     mtu 1500;
+     description "K: S-12345 foobar 'quote' xyzzy";
+   }
+}
+EOF
+ResultJunOS << <<EOF
+interfaces {
+   xe-1/2/3 {
+     mtu 42;
+   }
+}
+EOF
+
+ResultIOS = []
+ResultIOS << <<EOF
+interface GigabitEthernet0/42
+  description K: S-12345 foobar 'quote' xyzzy
+  mtu 1500
+  vrf forwarding VRF0001
+EOF
+ResultIOS << <<EOF
+interface GigabitEthernet0/42
+  description f00fc7c8
+  vrf forwarding xyzzy
+EOF
+
+
+TEST = [
+{
+:string => "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+:lex => [[:DATA, "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 1, 1]],
+:parsed => [[:data, "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", [1, 1]]],
+},
+
+{
+:string => "Lorem ipsum <%dolor sit amet%>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+:lex => [[:DATA, "Lorem ipsum ", 1, 1], [:START_CODE, "<%", 1, 1], [:DATA, "dolor sit amet", 1, 1], [:END_CODE, "%>", 1, 1], [:DATA, ", consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 1, 1]],
+:parsed => [[:data, "Lorem ipsum ", [1, 1]], [:code, nil, "dolor sit amet", [1, 1]], [:data, ", consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", [1, 1]]],
+},
+
+{
+:string => "Lorem ipsum <%dolor\nsit amet%>, con\nsectetur <%if testing\n bar\n fooi %> adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+:lex => [[:DATA, "Lorem ipsum ", 1, 1], [:START_CODE, "<%", 1, 1], [:DATA, "dolor\nsit amet", 1, 2], [:END_CODE, "%>", 1, 2], [:DATA, ", con\nsectetur ", 2, 3], [:START_CODE, "<%if", 2, 3], [:CMD, "if", 2, 3], [:DATA, " testing\n bar\n fooi ", 3, 5], [:END_CODE, "%>", 3, 5], [:DATA, " adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 5, 5]],
+:parsed => [[:data, "Lorem ipsum ", [1, 1]], [:code, nil, "dolor\nsit amet", [1, 2]], [:data, ", con\nsectetur ", [2, 3]], [:code, :if, " testing\n bar\n fooi ", [3, 5]], [:data, " adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", [5, 5]]],
+},
+
+]

data/tst.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require_relative './lib/malline'
+class Int
+  attr_accessor :name, :mtu, :description, :poop
+  def initialize
+    @name        = 'xe-1/2/3.42'
+    @mtu         = 1500
+    @description = 'K: S-123455 - poop customer'
+  end
+  def get_binding; binding; end
+end
+
+template = <<EOF
+interfaces {
+   <% name %> {
+     mtu <%if mtu %>;
+     description "<%if description %>";
+   }
+}
+EOF
+
+puts Malline.run template, Int.new.get_binding

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: mallinna
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Saku Ytti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mostly like ERB, but <%if foo%> conditional will omit whole line unless
+  code evaluates true
+email:
+- saku@ytti.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/malline.rb
+- lib/malline/compiler.rb
+- lib/malline/handler.rb
+- lib/malline/lexer.rb
+- lib/malline/parser.rb
+- lib/malline/parser.y
+- mallinna.gemspec
+- spec/compiler_spec.rb
+- spec/handler_spec.rb
+- spec/lexer_spec.rb
+- spec/spec_helper.rb
+- tst.rb
+homepage: https://github.com/ytti/malline
+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: mallinna
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Templating language targeting IOS/JunOS configs
+test_files: []
+has_rdoc: