scrag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6497b445e4a0f1279357da48c6f451ad76e7969c7c565c857d11b89405668c90
+  data.tar.gz: 3f8d6c011473b47341a1b6392327bf3cc92768639fac176ee563b38d73910398
+SHA512:
+  metadata.gz: f6e779ad79c007d369bfe72b3505072ebc8e33ba49d228d1a898575721ede6598a983c81335e673188fc009f49ce64aba10cb5a76ea5f59226ef82daa6e080f0
+  data.tar.gz: a0b5c131b51aff35b7c03f785733e2c244073c0cfa375e3ebc030cc3e55096e210f67e56465b8b741e1c83cd26392af1edfce4614cbf6299110f9fd70c15f064

data/bin/scrag

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/scrag'
+Scrag::Runner.run(*ARGV)

data/lib/scrag/code.rb

@@ -0,0 +1,47 @@
+class Code
+
+  attr_accessor :indent,:lines
+
+  def initialize str=nil
+    @lines=[]
+    (@lines << str) if str
+    @indent=0
+  end
+
+  def <<(thing)
+    if (code=thing).is_a? Code
+      code.lines.each do |line|
+        @lines << " "*@indent+line.to_s
+      end
+    elsif thing.is_a? Array
+      thing.each do |kode|
+        @lines << kode
+      end
+    elsif thing.nil?
+    else
+      @lines << " "*@indent+thing.to_s
+    end
+  end
+
+  def finalize
+    return @lines.join("\n") if @lines.any?
+    ""
+  end
+
+  def newline
+    @lines << " "
+  end
+
+  def save_as filename,verbose=true,sep="\n"
+    str=self.finalize
+    File.open(filename,'w'){|f| f.puts(str)}
+    puts "=> code saved as : #{filename}" if verbose
+    return filename
+  end
+
+  def size
+    @lines.size
+  end
+
+
+end

data/lib/scrag/compiler.rb

@@ -0,0 +1,119 @@
+require 'erb'
+require_relative 'code'
+
+module Scrag
+
+  class Compiler
+
+    attr_accessor :options
+    attr_accessor :project_name
+
+    def initialize options={}
+      @options=options
+    end
+
+    def compile project_name
+      @project_name=project_name.downcase
+      puts "project #{project_name}".center(65,'=')
+      @files_for_dir={
+        project_name          => [:gemspec],
+        "bin"                 => [:exec],
+        "lib"                 => [:top_module],
+        "lib/#{project_name}" => [
+                                  :ast,
+                                  :code,
+                                  :compiler,
+                                  :exec,
+                                  :generic_lexer,
+                                  :generic_parser,
+                                  :lexer,
+                                  :parser,
+                                  :pretty_printer,
+                                  :runner,
+                                  :token,
+                                  :top_module,
+                                  :transformer,
+                                  :version,
+                                  :visitor,
+                                ]
+      }
+      generate
+    end
+
+    def item n=0,str
+      subitem=(n==0) ? "": "  "
+      spaces=case n
+      when 0 then 0
+      when 1 then 1
+      else
+        1+(n-1)*4
+      end
+
+      puts " "*spaces+"#{subitem}[+] #{str}"
+    end
+
+    def generate
+      @pwd=Dir.pwd
+      check_doesnt_exists(project_name)
+      create "#{project_name}"
+      create "#{project_name}/bin"
+      create "#{project_name}/lib"
+      create "#{project_name}/lib/#{project_name}"
+      create "#{project_name}/tests"
+    end
+
+    def create dir
+      item "creating dir '#{dir}'"
+      create_stuff dir
+    end
+
+    def check_doesnt_exists dir
+      if Dir.exists?(dir)
+        if options[:force]
+          puts "WARNING : project already exists !"
+          puts "Are you sure you want to force generation ? files will be lost !"
+          key=$stdin.chomp
+          puts key
+        else
+          puts "Scrag ERROR : project '#{project_name}' already exists. Type -v for options."
+          abort
+        end
+      end
+    end
+
+    def create_stuff dir
+      Dir.mkdir dir
+      Dir.chdir dir
+      rel_dir=dir.split('/')[1..-1].join('/')
+      files_to_create=@files_for_dir[rel_dir]
+      if files_to_create
+        files_to_create.each do |file|
+          create_file(file)
+        end
+      end
+      Dir.chdir @pwd
+    end
+
+    SPECIALS=[:top_module,:exec,:gemspec]
+    def create_file file
+
+      gen_file=(SPECIALS.include?(file)) ? project_name : file
+      ext=case file
+      when :exec    then ""
+      when :gemspec then ".gemspec"
+      else ".rb"
+      end
+      item 1,"creating file '#{gen_file}'"
+      template=load_template(file)
+      renderer=ERB.new(template)
+      gen_code=renderer.result(binding)
+      code=Code.new(gen_code)
+      code.save_as "#{gen_file}#{ext}",verbose=false
+    end
+
+    def load_template file
+      template="#{__dir__}/../templates/#{file}.erb"
+      template_str=IO.read template
+    end
+  end
+end

data/lib/scrag/runner.rb

@@ -0,0 +1,71 @@
+require "optparse"
+require "colorize"
+
+require_relative "compiler"
+
+module Scrag
+
+  class Runner
+
+    def self.run *arguments
+      new.run(arguments)
+    end
+
+    def run arguments
+      compiler=Compiler.new
+      compiler.options = options = parse_options(arguments)
+      if project=options[:project_name]
+        compiler.compile project
+      end
+    end
+
+    def header
+      puts "Scrag : scaffolding Ruby compilers (#{VERSION})- (c) JC Le Lann 20"
+    end
+
+    private
+    def parse_options(arguments)
+      header
+
+      parser = OptionParser.new
+
+      options = {}
+
+      parser.on("-h", "--help", "Show help message") do
+        puts parser
+        print_help_message
+        exit(true)
+      end
+
+      parser.on("--vv", "verbose") do
+        options[:verbose] = true
+      end
+
+      parser.on("--force", "force creation, even if file structure already exists") do
+        options[:force] = true
+      end
+
+      parser.on("-v", "--version", "Show version number") do
+        puts VERSION
+        exit(true)
+      end
+
+      parser.parse!(arguments)
+
+      options[:project_name]=arguments.shift #the remaining c file
+
+      unless options[:project_name]
+        puts parser
+        print_help_message
+      end
+
+      options
+    end
+
+    def print_help_message
+      puts
+      puts "simply enter your project name like > scrag my_dsl".green
+      puts
+    end
+  end
+end

data/lib/scrag/version.rb

@@ -0,0 +1,3 @@
+module Scrag
+  VERSION="0.0.1"
+end

data/lib/scrag.rb

@@ -0,0 +1,6 @@
+require_relative './scrag/runner'
+require_relative './scrag/version'
+require_relative './scrag/compiler'
+
+module Scrag
+end

data/lib/templates/ast.erb

@@ -0,0 +1,42 @@
+# your project process may use rkgen for class generation :
+# require_relative "ast_<%=project_name%>_rkgen"
+
+module <%=project_name.capitalize%>
+
+  class AstNode
+    def accept(visitor, arg=nil)
+       name = self.class.name.split(/::/).last
+       visitor.send("visit#{name}".to_sym, self ,arg) # Metaprograming !
+    end
+
+    def str
+      ppr=PrettyPrinter.new
+      self.accept(ppr)
+    end
+  end
+
+  class Root < AstNode
+    attr_accessor :design_units
+    def initialize design_units=[]
+      @design_units=design_units
+    end
+  end
+
+  class Ident < AstNode
+    attr_accessor :token
+    def initialize token=nil
+      @token=token
+    end
+  end
+
+  class Expression
+  end
+
+  class Binary < Expression
+    attr_accessor :lhs,:op,:rhs
+    def initialize lhs=nil,op=nil,rhs=nil
+      @lhs,@op,@rhs=lhs,op,rhs
+    end
+  end
+
+end

data/lib/templates/code.erb

@@ -0,0 +1,47 @@
+class Code
+
+  attr_accessor :indent,:lines
+
+  def initialize str=nil
+    @lines=[]
+    (@lines << str) if str
+    @indent=0
+  end
+
+  def <<(thing)
+    if (code=thing).is_a? Code
+      code.lines.each do |line|
+        @lines << " "*@indent+line.to_s
+      end
+    elsif thing.is_a? Array
+      thing.each do |kode|
+        @lines << kode
+      end
+    elsif thing.nil?
+    else
+      @lines << " "*@indent+thing.to_s
+    end
+  end
+
+  def finalize
+    return @lines.join("\n") if @lines.any?
+    ""
+  end
+
+  def newline
+    @lines << " "
+  end
+
+  def save_as filename,verbose=true,sep="\n"
+    str=self.finalize
+    File.open(filename,'w'){|f| f.puts(str)}
+    puts "=> code saved as : #{filename}" if verbose
+    return filename
+  end
+
+  def size
+    @lines.size
+  end
+
+
+end

data/lib/templates/compiler.erb

@@ -0,0 +1,28 @@
+require 'erb'
+require_relative 'parser'
+require_relative 'pretty_printer'
+require_relative 'transformer'
+require_relative 'code'
+
+module <%=project_name.capitalize%>
+
+  class Compiler
+
+    attr_accessor :options
+    attr_accessor :project_name
+
+    def initialize options={}
+      @options=options
+    end
+
+    def compile filename
+      puts "=> compiling #{filename}"
+      # parse(filename)
+    end
+
+    def parse filename
+      @ast=Parser.new.parse filename
+    end
+
+  end
+end

data/lib/templates/exec.erb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/<%=project_name%>'
+<%= project_name.capitalize%>::Runner.run(*ARGV)

data/lib/templates/gemspec.erb

@@ -0,0 +1,33 @@
+require_relative "./lib/<%=project_name%>/version"
+
+Gem::Specification.new do |s|
+  s.name        = '<%=project_name%>'
+  s.version     = <%project_name.capitalize%>::VERSION
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.summary     = "<%= project_name%> DSL compiler"
+  s.description = "<%= project_name%> DSL compiler"
+  s.authors     = ["Jean-Christophe Le Lann"]
+  s.email       = 'lelannje@ensta-bretagne.fr'
+  s.files       = [
+                    "lib/<%=project_name%>/runner.rb",
+                    "lib/<%=project_name%>/compiler.rb",
+                    "lib/<%=project_name%>/ast.rb",
+                    "lib/<%=project_name%>/code.rb",
+                    "lib/<%=project_name%>/generic_lexer.rb",
+                    "lib/<%=project_name%>/generic_parser.rb",
+                    "lib/<%=project_name%>/lexer.rb",
+                    "lib/<%=project_name%>/parser.rb",
+                    "lib/<%=project_name%>/pretty_printer.rb",
+                    "lib/<%=project_name%>/token.rb",
+                    "lib/<%=project_name%>/version.rb",
+                    "lib/<%=project_name%>.rb"
+                ]
+
+  s.executables << '<%=project_name%>'
+  s.homepage    = 'https://github.com/JC-LL/<%=project_name%>'
+  s.license     = 'MIT'
+  s.post_install_message = "Thanks for installing ! Homepage :https://github.com/JC-LL/<%=project_name%>"
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_runtime_dependency 'colorize', '0.8.1'
+
+end

data/lib/templates/generic_lexer.erb

@@ -0,0 +1,62 @@
+require 'strscan'
+
+require_relative 'token'
+
+class GenericLexer
+
+  def initialize
+    @rules = []
+    @rules << [:newline,/[\n]/]
+  end
+
+  def ignore pattern
+    @rules << [:skip,pattern]
+  end
+
+  def keyword str
+    @rules.unshift [str.to_sym,/#{str}\b/i]
+  end
+
+  def token hash
+    token,pattern=*hash.to_a.flatten
+    @rules << [token, pattern]
+  end
+
+  def open code
+    @ssc = StringScanner.new code
+    @line=0
+  end
+
+  def next_token
+    return [nil,nil,nil] if @ssc.empty?
+    tok = get_token
+    return (tok.is_a? :skip) ? next_token : tok
+  end
+
+  def get_token
+    linecol=position()
+    @rules.each do |rule, regexp|
+      val = @ssc.scan(regexp)
+      return Token.new([rule, val, linecol]) if val
+    end
+    raise  "lexing error line #{linecol.first} around : ...'#{@ssc.peek(5)}'... "
+  end
+
+  def position
+    if @ssc.bol?
+      @line+=1
+      @old_pos=@ssc.pos
+    end
+    [@line,@ssc.pos-@old_pos+1]
+  end
+
+  def tokenize code
+    open(code)
+    tokens=[]
+    tokens << next_token() while not @ssc.eos?
+    # while not @ssc.eos?
+    #   tokens << (p next_token)
+    # end #usefull for debug
+    tokens
+  end
+end

data/lib/templates/generic_parser.erb

@@ -0,0 +1,53 @@
+class GenericParser
+
+  def acceptIt
+    tok=tokens.shift
+    puts "consuming #{tok.val} (#{tok.kind})" if @verbose
+    tok
+  end
+
+  def showNext k=1
+    tokens[k-1]
+  end
+
+  def expect kind
+    if (actual=showNext.kind)!=kind
+      abort "ERROR at #{showNext.pos}. Expecting #{kind}. Got #{actual}"
+    else
+      return acceptIt()
+    end
+  end
+
+  def maybe kind
+    if showNext.kind==kind
+      return acceptIt
+    end
+    nil
+  end
+
+  def more?
+    !tokens.empty?
+  end
+
+  def lookahead n
+    showNext(k=n)
+  end
+
+  def niy
+    raise "NIY"
+  end
+
+  def  next_tokens n=5
+    @tokens[0..n].map{|tok| [tok.kind,tok.val].to_s}.join(',')
+  end
+
+  def consume_to token_kind
+    while showNext && showNext.kind!=token_kind
+      acceptIt
+    end
+    if showNext.nil?
+      raise "cannot find token '#{token_kind}'"
+    end
+  end
+
+end

data/lib/templates/lexer.erb

@@ -0,0 +1,50 @@
+require_relative 'generic_lexer'
+require_relative 'generic_parser'
+
+module <%=project_name.capitalize%>
+  class Lexer < GenericLexer
+    def initialize
+      super
+
+      keyword 'if'
+
+      #.............................................................
+      token :comment           => /\A\-\-(.*)$/
+      token :ident             => /[a-zA-Z]\w*/
+      token :string_literal    => /"[^"]*"/
+      token :char_literal      => /'(\w+)'/
+      token :decimal_literal   => /\d+(\.\d+)?(E([+-]?)\d+)?/
+
+      token :comma             => /\A\,/
+      token :colon             => /\A\:/
+      token :semicolon         => /\A\;/
+      token :lparen            => /\A\(/
+      token :rparen            => /\A\)/
+
+      # arith
+      token :add               => /\A\+/
+      token :sub               => /\A\-/
+      token :mul               => /\A\*/
+      token :div               => /\A\//
+
+      token :imply             => /\A\=\>/
+
+      # logical
+      token :eq                => /\A\=/
+      token :neq               => /\A\/\=/
+      token :gte               => /\A\>\=/
+      token :gt                => /\A\>/
+      token :leq               => /\A\<\=/
+      token :lt                => /\A\</
+
+      token :ampersand         => /\A\&/
+
+      token :dot               => /\A\./
+      token :bar               => /\|/
+      #............................................................
+      token :newline           =>  /[\n]/
+      token :space             => /[ \t\r]+/
+
+    end #def
+  end #class
+end #module

data/lib/templates/parser.erb

@@ -0,0 +1,73 @@
+# coding: utf-8
+require_relative 'generic_parser'
+require_relative 'ast'
+require_relative 'lexer'
+
+module <%=project_name.capitalize%>
+
+  class Parser < GenericParser
+
+    attr_accessor :options
+    attr_accessor :lexer,:tokens
+    attr_accessor :basename,:filename
+
+    def initialize options={}
+      @options=options
+    end
+
+    def lex filename
+      unless File.exists?(filename)
+        raise "ERROR : cannot find file '#{filename}'"
+      end
+      begin
+        str=IO.read(filename).downcase
+        tokens=Lexer.new.tokenize(str)
+        tokens=tokens.select{|t| t.class==Token} # filters [nil,nil,nil]
+        tokens.reject!{|tok| tok.is_a? [:comment,:newline,:space]}
+        return tokens
+      rescue Exception=>e
+        unless options[:mute]
+          puts e.backtrace
+          puts e
+        end
+        raise "an error occured during LEXICAL analysis. Sorry. Aborting."
+      end
+    end
+
+    def parse filename
+      begin
+        @tokens=lex(filename)
+        puts "......empty file !" if tokens.size==0
+        root=Root.new([])
+        while @tokens.any?
+          case showNext.kind
+          when :comment
+            root << acceptIt
+          # etc...
+          else
+            raise "got #{showNext}"
+          end
+        end
+      rescue Exception => e
+        unless options[:mute]
+          puts e.backtrace
+          puts e
+        end
+        raise
+      end
+      root
+    end
+
+    def parse_thing
+      expect :thing
+      expect :ident
+      while showNext.is_a?(:comma)
+        acceptIt
+        expect :ident
+      end
+      expect :semicolon
+    end
+
+    # ....etc...
+  end
+end

data/lib/templates/pretty_printer.erb

@@ -0,0 +1,29 @@
+require_relative 'code'
+
+module <%=project_name.capitalize%>
+
+  class PrettyPrinter
+
+    def print ast
+      ast.accept(self)
+    end
+
+    def visitRoot root,args=nil
+      code=Code.new
+      code << "--automatically generated"
+      root.list.each{|e| code << e.accept(self)}
+      code
+    end
+
+    def visitComment comment,args=nil
+      code=Code.new
+      comment.list.each{|e| code << e.accept(self)}
+      code
+    end
+
+    def visitIdent id,args=nil
+      id.token.val
+    end
+
+  end
+end