sapluuna 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f176e218e8e443cec9eaa8e94f6ca233ae9f8014
+  data.tar.gz: 3f783c2bc0f48f9297a052bd0d8b55352b4a2833
+SHA512:
+  metadata.gz: f174827d07bc20c043cb03f6c792518dc2b7ef42d2bb86aa6b53b521792aa57a892f3e7d38263b8a5ba2756c006eea10e24f0bbf518e90a12eaff416136f1b78
+  data.tar.gz: 364fc6803738df805c191364e8c8a9eecb1693e8b3159b003fda9aba93d8a908006247b3289d9bd746eff16d5883dd588bb0203a56c4876fa6aa50ffadd93415

data/.gitignore

@@ -0,0 +1,2 @@
+gems
+cfg*

data/Gemfile

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

data/README.md

@@ -0,0 +1,11 @@
+# Sapluuna
+
+Silly little template based configuration maker
+
+  * Anything outside {{{ ... }}} is comment and won't be in generated file
+  * Inside {{{ }}} you can have <% foo %> which is just ruby
+  * For method_missing in <% foo %> we try variable[name] hash, given to constrcutor, i.e. Sapluuna.new variables: {replace_this: 'with_this'} .... <% replace_this %> works
+  * {{{ can be followed by negative or positive labels, if labels match to those given to constructor {{{ }}} is evaluated, otherwise ignored
+  * rationale for labels is {{{ PE ..... }}}   or     {{{ Finland Sweden ..... }}} to conditionally evaluate blocks
+  * You can query the instance on what variables are needed when labels X are set, use-case is in say in webUI to automatically generate form with all variables template needs
+

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'rake/testtask'
+  require 'bundler'
+  # Bundler.setup
+rescue LoadError
+  warn 'bundler missing'
+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 do
+  Rake::TestTask.new do |t|
+    t.libs.push "lib"
+    t.test_files = FileList['spec/*_spec.rb']
+    t.verbose = true
+  end
+end
+
+desc 'Build gem'
+task :build 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 -Es 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}"
+  system "git tag #{gemspec.version}"
+end

data/bin/sapluuna

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require_relative '../lib/sapluuna/cli'
+  k = Sapluuna::CLI.new
+  @debug = k.debug
+  k.run
+rescue => error
+  warn "ERROR: #{error.message} (#{error.class})"
+  raise if @debug
+end

data/lib/sapluuna/class_helpers.rb

@@ -0,0 +1,44 @@
+require_relative 'ip'
+
+class Sapluuna
+  module ClassHelpers
+
+    class ::String
+      def ip
+        IP.new(self).ip
+      end
+      def acl
+        IP.new(self).acl
+      end
+      def net
+        IP.new(self).net
+      end
+      def cidr
+        IP.new(self).cidr
+      end
+    end
+
+    class ::Array
+      def as_ip format_string
+        as_method 'ip', format_string
+      end
+
+      def as_acl format_string
+        as_method 'acl', format_string
+      end
+
+      def as_cidr format_string
+        as_method 'cidr', format_string
+      end
+
+      private
+
+      def as_method method, format_string
+        map do |str|
+          format_string % str.send(method)
+        end.join("\n")
+      end
+    end
+
+  end
+end

data/lib/sapluuna/cli.rb

@@ -0,0 +1,61 @@
+require_relative 'sapluuna'
+begin
+  require 'slop'
+rescue LoadError
+  warn "sudo gem install slop ## required by sapluuna CLI"
+  exit 42
+end
+
+
+
+class Sapluuna
+  class CLI
+    ROOT = '.'
+    attr_reader :debug
+
+    def initialize
+      @opts   = opts_parse
+      args    = @opts.arguments
+      @file   = args.shift
+      @labels = @opts[:label].split(/[,\s]+/) if @opts[:label]
+      @vars   = {}
+      @disco  = @opts[:variables]
+      args.each do |var|
+        name, value = var.split '='
+        @vars[name.to_sym] = value
+      end
+      if @opts.debug?
+        @debug = true
+        Log.level = Logger::DEBUG
+      end
+    end
+
+    def run
+      raise MissingOption, 'File is mandatory argument' unless @file
+      sap = Sapluuna.new labels: @labels, variables: @vars,
+                         discover_variables: @disco,
+                         root_directory: (@opts[:root] or ROOT)
+      cfg = sap.parse File.read(@file)
+      puts @disco ? sap.discovered_variables.keys : cfg
+    rescue => error
+      crash error
+      raise
+    end
+
+    private
+
+    def opts_parse
+      Slop.parse do |o|
+        o.banner = 'Usage: sapluuna [OPTIONS] FILE [variables]'
+        o.bool   '-d', '--debug',     'turn on debugging'
+        o.string '-l', '--label',     'commma separated list of labels'
+        o.bool   '-v', '--variables', 'displays required variables'
+        o.string '-r', '--root',      'root directory for template import'
+        o.on     '-h', '--help' do puts o; exit; end
+      end
+    end
+
+    def crash error
+    end
+  end
+end

data/lib/sapluuna/context.rb

@@ -0,0 +1,94 @@
+class Sapluuna
+  class Context
+    attr_reader :discovered_variables, :variables
+
+    RootDirectory = '.'
+
+    class VariableMissing < Error; end
+
+    def initialize opts
+      @opts                 = opts.dup
+      @discover_variables   = opts.delete :discover_variables
+      @variables            = (opts.delete(:variables) or {})
+      @root_directory       = (opts.delete(:root_directory) or RootDirectory)
+      @output               = ''
+      @discovered_variables = {}
+    end
+
+    def cfg value
+      @output << value
+    end
+
+    def code value
+      @output << eval(value).to_s
+    end
+
+    def str
+      @output
+    end
+
+    def are value
+      [:are, value]
+    end
+
+    def is value
+      [:is, value]
+    end
+
+    def silent *args
+      ""
+    end
+
+    private
+
+    def import file
+      template = File.read resolve_file(file)
+      @opts[:variables]      = @variables
+      @opts[:root_directory] = @root_directory.dup
+      Log.debug "importing #{file}"
+      sapl     = Sapluuna.new @opts
+      output   = sapl.parse template
+      @discovered_variables.merge! sapl.discovered_variables
+      add_indent output.lines, @output.lines.last
+    rescue => error
+      raise error, "#{error.message} (while reading #{file})"
+    end
+
+    def resolve_file file
+      # should we avoid ../../../etc/passwd style input here?
+      # why? we control templates?
+      File.join @root_directory, file
+    end
+
+    def add_indent output, indent_hint
+      return output.join.chomp if output.size < 2 or not indent_hint
+      indent_size = indent_hint.match(/\A\s*/)[0].size
+      first_line  = output[0]
+      output = output[1..-1].map { |line| ' ' * indent_size + line }
+      output.unshift(first_line).join.chomp
+    end
+
+    def method_missing method, *args
+      if Array === args.first
+        value = args.first.last
+        case args.first.first
+        when :is
+          @variables[method] = value
+        when :are
+          @variables[method] = value.to_s.strip.split(/\s+/)
+        end
+        ""
+      elsif @variables[method]
+        @variables[method]
+      else
+        if @discover_variables
+          args ||= ['']
+          @discovered_variables[method] = args[0] unless @discovered_variables.has_key? method
+          ""
+        else
+          raise VariableMissing, "variable '#{method}' required, but not given"
+        end
+      end
+    end
+  end
+end

data/lib/sapluuna/ip.rb

@@ -0,0 +1,51 @@
+require 'ipaddr'
+
+class Sapluuna
+  class IP < IPAddr
+
+    def initialize(addr = '::', family = Socket::AF_UNSPEC)
+      addr_org, _family_org = addr, family
+      prefix, _prefixlen = addr_org.split('/')
+      @addr_org = prefix
+      super
+      if @family == Socket::AF_UNSPEC or @family == Socket::AF_INET
+        @addr_org = in_addr(@addr_org)
+      else
+        @addr_org = in6_addr(@addr_org)
+      end
+    end
+
+    def ip
+      addr_tmp = @addr
+      @addr = @addr_org
+      ip = self.to_s
+      @addr = addr_tmp
+      ip
+    end
+
+    def mask_cidr
+      @mask_addr.to_s(2).delete('0').size
+    end
+
+    def mask_wild
+      _to_string ~@mask_addr
+    end
+
+    def mask_net
+      _to_string @mask_addr
+    end
+
+    def cidr
+      ip + '/' + mask_cidr.to_s
+    end
+
+    def acl
+      ip + ' '+ mask_wild
+    end
+
+    def net
+      ip + ' ' + mask_net
+    end
+
+  end
+end

data/lib/sapluuna/parser.rb

@@ -0,0 +1,74 @@
+require 'strscan'
+
+class Sapluuna
+  class Parser
+    CODE_OPEN      = '<%\s*'
+    CODE_CLOSE     = '\s*%>'
+    TEMPLATE_OPEN  = '^\s*{{{[\t ]*'
+    TEMPLATE_CLOSE = '\s*}}}\s*$'
+    NEW_LINE       = "\n"
+    class ParserError < Error; end
+    class UnterminatedBlock < ParserError; end
+
+    def initialize
+      @sc    = StringScanner.new ''
+    end
+
+    def parse input
+      level      = 0
+      cfg        = []
+      @sc.string = input
+      loop do
+        if @sc.scan_until Regexp.new(TEMPLATE_OPEN)
+          cfg << [:template, get_labels, get_template(level)]
+        else
+          break
+        end
+      end
+      @sc.string = '' # no need to keep it in memory
+      cfg
+    end
+
+    private
+
+    def get_labels
+      labels = @sc.scan_until Regexp.new(NEW_LINE)
+      labels.strip.split(/\s+/)
+    end
+
+    def re_combine *args
+      re = args.map do |arg|
+        '(?:%s)' % arg
+      end.join('|')
+      Regexp.new re
+    end
+
+    def clean_scan scan
+      endstr = -(@sc.matched.size+1)
+      scan[0..endstr]
+    end
+
+    def get_template level
+      cfg = []
+      loop do
+        scan = @sc.scan_until re_combine(CODE_OPEN, TEMPLATE_OPEN, TEMPLATE_CLOSE)
+        raise UnterminatedBlock, "template at #{level}, #{@sc.pos} runs forever" unless scan
+        cfg << [:cfg, clean_scan(scan)]
+        case @sc.matched
+
+        when Regexp.new(CODE_OPEN)
+          scan = @sc.scan_until Regexp.new(CODE_CLOSE)
+          raise UnterminatedBlock, "code at #{level}, #{@sc.pos} runs forever" unless scan
+          cfg << [:code, clean_scan(scan)]
+
+        when Regexp.new(TEMPLATE_OPEN)
+          cfg << [:template, get_labels, get_template(level+1)]
+
+        when Regexp.new(TEMPLATE_CLOSE)
+          return cfg
+        end
+      end
+    end
+
+  end
+end

data/lib/sapluuna/sapluuna.rb

@@ -0,0 +1,91 @@
+require 'logger'
+require_relative 'class_helpers'
+
+class Sapluuna
+
+  include ClassHelpers
+  class Error < StandardError; end
+  class InvalidOption < StandardError; end
+  class MissingOption < StandardError; end
+  class InvalidType < Error; end
+  Log = Logger.new STDERR
+  Log.level = Logger::WARN
+
+  def initialize opts
+    @context     = (opts[:context] or Context)
+    @want_labels = read_labels (opts[:labels] or [])
+    @context     = @context.new(opts) if @context.class == Class
+    @parser      = Parser.new
+  end
+
+  def discovered_variables
+    @context.discovered_variables
+  end
+
+  def variables
+    @context.variables
+  end
+
+  def parse input
+    @parser.parse(input).each do |cfg|
+      type = cfg.shift
+      case type
+      when :template
+        template cfg
+      else
+        raise InvalidType, "#{type} was not recognized by parser"
+      end
+    end
+    @context.str
+  end
+
+  private
+
+  def read_labels labels
+    pos, neg = [], []
+    labels.each do |label|
+      label[0] == '!' ? neg.push(label[1..-1]) : pos.push(label)
+    end
+    [pos, neg]
+  end
+
+  def template templ
+    return unless valid_labels? read_labels(templ.shift)
+    templ.shift.each do |t|
+      type = t.shift
+      case type
+      when :code
+        @context.code t.last
+      when :cfg
+        @context.cfg t.last
+      when :template
+        template t
+      else
+        raise InvalidType, "#{type} was not recognized by parser"
+      end
+    end
+  end
+
+  def valid_labels? got_labels
+    # first/[0] is our positive labels (label)
+    # last/[1]  is our negative labels (!label)
+
+    # template has label which we explcitly don't want
+    return false if (got_labels[0] & @want_labels[1]).size > 0
+
+    # template forbids label which we explicitly want
+    return false if (got_labels[1] & @want_labels[0]).size > 0
+
+    # template requires no labels
+    return true if got_labels[0].empty?
+
+    # template requires labels, do we want at least one of them?
+    return false unless (got_labels[0] & @want_labels[0]).size > 0
+
+    true
+  end
+
+end
+
+require_relative 'parser'
+require_relative 'context'

data/sapluuna.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name              = 'sapluuna'
+  s.version           = '0.1.4'
+  s.licenses          = %w( Apache-2.0 )
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = [ 'Saku Ytti' ]
+  s.email             = %w( saku@ytti.fi )
+  s.homepage          = 'http://github.com/ytti/sapluuna'
+  s.summary           = 'Template parser'
+  s.description       = 'Template based network configuration generator'
+  s.rubyforge_project = s.name
+  s.files             = `git ls-files`.split("\n")
+  s.executables       = %w( sapluuna )
+  s.require_path      = 'lib/sapluuna'
+
+  s.required_ruby_version =        '>= 2.0.0'
+  s.add_runtime_dependency 'slop', '~> 4.0'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sapluuna
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Saku Ytti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Template based network configuration generator
+email:
+- saku@ytti.fi
+executables:
+- sapluuna
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/sapluuna
+- lib/sapluuna/class_helpers.rb
+- lib/sapluuna/cli.rb
+- lib/sapluuna/context.rb
+- lib/sapluuna/ip.rb
+- lib/sapluuna/parser.rb
+- lib/sapluuna/sapluuna.rb
+- sapluuna.gemspec
+homepage: http://github.com/ytti/sapluuna
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/sapluuna
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sapluuna
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Template parser
+test_files: []