gloss 0.0.1 → 0.0.6

data/lib/gloss/writer.rb

@@ -1,26 +1,32 @@
-# frozen_string_literal: true
+  # frozen_string_literal: true
 
+  ##### This file was generated by Gloss; any changes made here will be overwritten.
+  ##### See src/ to make changes
+
+  require "pathname"
+require "fileutils"
 module Gloss
   module Utils
     module_function
-
     def src_path_to_output_path(src_path)
-      src_path.sub(%r{\A(?:\./)?#{Config.src_dir}/?}, "")
+      src_path.sub("#{Config.src_dir}/", "")
+.sub(/\.gl$/, ".rb")
     end
   end
-
   class Writer
     include Utils
-
-    def initialize(content, src_path, output_path = nil)
-      @content, @src_path = content, src_path
-      @output_path = output_path || src_path_to_output_path(src_path)
+    def initialize(content, src_path, output_path = Pathname.new(src_path_to_output_path(src_path)))
+      @content = content
+      @output_path = output_path
     end
-
-    def run
-      File.open(@output_path, "wb") do |file|
-        file << @content
+    def run()
+      unless       @output_path.parent
+.exist?
+        FileUtils.mkdir_p(@output_path.parent)
       end
+      File.open(@output_path, "wb") { |file|
+        file.puts(@content)
+      }
     end
   end
 end

data/sig/gloss.rbs

@@ -0,0 +1,3 @@
+module Gloss
+  def self.parse_buffer: (String) -> String
+end

data/sig/listen.rbs

@@ -19,6 +19,7 @@ module Listen
                 ?ignore: Regexp | Array[Regexp],
                 ?ignore!: Regexp,
                 ?only: Regexp?,
+                ?latency: (Integer | Float)?,
                 ?polling_fallback_message: String?) {
                   (Array[String] modified, Array[String] added, Array[String] removed) -> void
                 } -> Listener

data/src/lib/gloss/builder.gl

@@ -0,0 +1,546 @@
+module Gloss
+  module Utils
+    module_function
+
+    def with_file_header(str)
+      "#{Builder::FILE_HEADER}\n\n#{str}"
+    end
+  end
+
+  class Builder
+    FILE_HEADER = <<~RUBY
+      #{"# frozen_string_literal: true\n" if Config.frozen_string_literals}
+      ##### This file was generated by Gloss; any changes made here will be overwritten.
+      ##### See #{Config.src_dir}/ to make changes
+    RUBY
+
+    include Utils
+
+    attr_reader :tree
+
+    def initialize(tree_hash, type_checker = nil)
+      @indent_level = 0
+      @inside_macro = false
+      @eval_vars = false
+      @current_scope = nil
+      @tree = tree_hash
+      @type_checker = type_checker
+    end
+
+    def run
+      rb_output = visit_node(@tree)
+      with_file_header(rb_output)
+    end
+
+    # type node = Hash[Symbol, String | Array[String | node] | Hash[Symbol, node]] | true | false
+
+    def visit_node(node : Hash[Symbol, Any], scope = Scope.new) : String
+      src = Source.new(@indent_level)
+      case node[:type]
+      when "ClassNode"
+        class_name = visit_node(node[:name])
+        current_namespace = @current_scope ? @current_scope.name.to_namespace : RBS::Namespace.root
+        superclass_type = nil
+        superclass_output = nil
+        if node[:superclass]
+          @eval_vars = true
+          superclass_output = visit_node(node[:superclass])
+          @eval_vars = false
+          superclass_type = RBS::Parser.parse_type superclass_output
+          if node.dig(:superclass, :type) == "Generic"
+            superclass_output = superclass_output[/^[^\[]+/]
+          end
+        end
+
+        src.write_ln "class #{class_name}#{" < #{superclass_output}" if superclass_output}"
+
+        class_type = RBS::AST::Declarations::Class.new(
+          name: RBS::TypeName.new(
+            namespace: current_namespace,
+            name: class_name.to_sym
+          ),
+          type_params: RBS::AST::Declarations::ModuleTypeParams.new, # responds to #add to add params
+          super_class: superclass_type,
+          members: Array.new, # TODO
+          annotations: Array.new, # TODO
+          location: node[:location],
+          comment: node[:comment]
+        )
+        old_parent_scope = @current_scope
+        @current_scope = class_type
+
+        indented(src) { src.write_ln visit_node(node[:body]) if node[:body] }
+
+        src.write_ln "end"
+
+        @current_scope = old_parent_scope
+
+        @current_scope.members << class_type if @current_scope
+
+        if @type_checker
+          @type_checker.top_level_decls[class_type.name.name] = class_type unless @current_scope
+        end
+      when "ModuleNode"
+        module_name = visit_node node[:name]
+        src.write_ln "module #{module_name}"
+
+        current_namespace = @current_scope ? @current_scope.name.to_namespace : RBS::Namespace.root
+
+        module_type = RBS::AST::Declarations::Module.new(
+          name: RBS::TypeName.new(
+            namespace: current_namespace,
+            name: module_name.to_sym
+          ),
+          type_params: RBS::AST::Declarations::ModuleTypeParams.new, # responds to #add to add params
+          self_types: Array.new, # TODO
+          members: Array.new, # TODO
+          annotations: Array.new, # TODO
+          location: node[:location],
+          comment: node[:comment]
+        )
+        old_parent_scope = @current_scope
+        @current_scope = module_type
+
+        indented(src) { src.write_ln visit_node(node[:body]) if node[:body] }
+
+        @current_scope = old_parent_scope
+
+        @current_scope.members << module_type if @current_scope
+
+        if @type_checker
+          @type_checker.top_level_decls[module_type.name.name] = module_type unless @current_scope
+        end
+        src.write_ln "end"
+      when "DefNode"
+        args = render_args(node)
+        receiver = node[:receiver] ? visit_node(node[:receiver]) : nil
+        src.write_ln "def #{"#{receiver}." if receiver}#{node[:name]}#{args[:representation]}"
+
+        return_type = if node[:return_type]
+                        RBS::Types::ClassInstance.new(
+                          name: RBS::TypeName.new(
+                            name: eval(visit_node(node[:return_type])).to_s.to_sym,
+                            namespace: RBS::Namespace.root
+                          ),
+                          args: EMPTY_ARRAY, # TODO
+                          location: node[:location]
+                        )
+                      else
+                        RBS::Types::Bases::Any.new(
+                          location: node[:location]
+                        )
+                      end
+
+        method_types = [
+          RBS::MethodType.new(
+            type_params: EMPTY_ARRAY, # TODO
+            type: RBS::Types::Function.new(
+              required_positionals: args.dig(:types, :required_positionals),
+              optional_positionals: args.dig(:types, :optional_positionals),
+              rest_positionals: args.dig(:types, :rest_positionals),
+              trailing_positionals: args.dig(:types, :trailing_positionals),
+              required_keywords: args.dig(:types, :required_keywords),
+              optional_keywords: args.dig(:types, :optional_keywords),
+              rest_keywords: args.dig(:types, :rest_keywords),
+              return_type: return_type
+            ),
+            block: node[:yield_arg_count] ?
+              RBS::Types::Block.new(
+                type: RBS::Types::Function.new(
+                  required_positionals: Array.new,
+                  optional_positionals: Array.new,
+                  rest_positionals: nil,
+                  trailing_positionals: Array.new,
+                  required_keywords: Hash.new,
+                  optional_keywords: Hash.new,
+                  rest_keywords: nil,
+                  return_type: RBS::Types::Bases::Any.new(location: node[:location])
+                ),
+                required: !!(node[:block_arg] || node[:yield_arg_count])
+              ) : nil,
+            location: node[:location]
+          )
+        ]
+        method_definition = RBS::AST::Members::MethodDefinition.new(
+          name: node[:name].to_sym,
+          kind: receiver ? :class : :instance,
+          types: method_types,
+          annotations: EMPTY_ARRAY, # TODO
+          location: node[:location],
+          comment: node[:comment],
+          overload: false
+        )
+
+        if @current_scope
+          @current_scope.members << method_definition
+        else
+          @type_checker.type_env << method_definition if @type_checker # should be new class declaration for Object with method_definition as private method
+        end
+
+        indented(src) { src.write_ln visit_node(node[:body]) if node[:body] }
+
+        src.write_ln "end"
+
+      when "VisibilityModifier"
+
+        src.write_ln "#{node[:visibility]} #{visit_node(node[:exp])}"
+      when "CollectionNode"
+        node[:children].each { |a| src.write visit_node(a, scope) }
+      when "Call"
+        obj = node[:object] ? "#{visit_node(node[:object], scope)}." : ""
+        arg_arr = node.fetch(:args) { EMPTY_ARRAY }
+        arg_arr += node[:named_args] if node[:named_args]
+        args = if !arg_arr.empty? || node[:block_arg]
+                 "#{arg_arr.map { |a| visit_node(a, scope).strip }.reject(&:blank?).join(", ")}#{"&#{visit_node(node[:block_arg]).strip}" if node[:block_arg]}"
+               else
+                 nil
+               end
+        block = node[:block] ? " #{visit_node(node[:block])}" : nil
+        has_parens = !!(node[:has_parentheses] || args || block)
+        opening_delimiter = if has_parens
+                              "("
+                            else
+                              nil
+                            end
+        call = "#{obj}#{node[:name]}#{opening_delimiter}#{args}#{")" if has_parens}#{block}"
+        src.write_ln(call)
+
+      when "Block"
+        args = render_args node
+        src.write "{ #{args[:representation].gsub(/(\A\(|\)\z)/,'|')}\n"
+
+        indented(src) { src.write visit_node(node[:body]) }
+
+        src.write_ln "}"
+
+      when "RangeLiteral"
+        dots = node[:exclusive] ? "..." : ".."
+
+        # parentheses around the whole thing help the compatibility with precendence of operators in some situations
+        # eg. (1..3).cover? 2 vs. 1..3.cover? 2
+        # parentheses around either number help with things like arithemtic ((x-1)..(y+5))
+        src.write "(", "(", visit_node(node[:from]), ")", dots, "(", visit_node(node[:to]), ")", ")"
+
+      when "LiteralNode"
+
+        src.write node[:value]
+
+      when "ArrayLiteral"
+
+        src.write("[", node[:elements].map { |e| visit_node(e).strip }.join(", "), "]")
+        src.write ".freeze" if node[:frozen]
+
+      when "StringInterpolation"
+
+        contents = node[:contents].inject(String.new) do |str, c|
+          str << case c[:type]
+                 when "LiteralNode"
+                   c[:value][1...-1]
+                 else
+                   [%q|#{|, visit_node(c).strip, "}"].join
+                 end
+        end
+        src.write '"', contents, '"'
+
+      when "Path"
+
+        src.write node[:value]
+
+      when "Require"
+
+        src.write_ln %(require "#{node[:value]}")
+
+      when "Assign", "OpAssign"
+
+        src.write_ln "#{visit_node(node[:target])} #{node[:op]}= #{visit_node(node[:value]).strip}"
+
+      when "MultiAssign"
+
+        src.write_ln "#{node[:targets].map{ |t| visit_node(t).strip }.join(", ")} = #{node[:values].map { |v| visit_node(v).strip }.join(", ")}"
+
+      when "Var"
+
+        if @eval_vars
+          src.write scope[node[:name]]
+        else
+          src.write node[:name]
+        end
+
+      when "InstanceVar"
+
+        src.write node[:name]
+
+      when "GlobalVar"
+
+        src.write node[:name]
+
+      when "Arg"
+        val = node[:external_name]
+        if node[:keyword_arg]
+          val += ":"
+          val += " #{visit_node(node[:value])}" if node[:value]
+        elsif node[:value]
+          val += " = #{visit_node(node[:value])}"
+        end
+
+        src.write val
+
+      when "UnaryExpr"
+
+        src.write "#{node[:op]}#{visit_node(node[:value]).strip}"
+
+      when "BinaryOp"
+
+        src.write visit_node(node[:left]).strip, " #{node[:op]} ", visit_node(node[:right]).strip
+
+      when "HashLiteral"
+
+        contents = node[:elements].map do |k, v|
+          key = case k
+                when String
+                  k.to_sym.inspect
+                else
+                  visit_node k
+                end
+          value = visit_node v
+          "#{key} => #{value}"
+        end
+
+        src.write "{#{contents.join(",\n")}}"
+        src.write ".freeze" if node[:frozen]
+
+      when "Enum"
+        src.write_ln "module #{node[:name]}"
+        node[:members].each_with_index do |m, i|
+          indented(src) { src.write_ln(visit_node(m) + (!m[:value] ? " = #{i}" : "")) }
+        end
+        src.write_ln "end"
+      when "If"
+        src.write_ln "(if #{visit_node(node[:condition]).strip}"
+
+        indented(src) { src.write_ln visit_node(node[:then]) }
+
+        if node[:else]
+          src.write_ln "else"
+          indented(src) { src.write_ln visit_node(node[:else]) }
+        end
+
+        src.write_ln "end)"
+      when "Unless"
+        src.write_ln "unless #{visit_node node[:condition]}"
+        indented(src) { src.write_ln visit_node(node[:then]) }
+
+        if node[:else]
+          src.write_ln "else"
+          indented(src) { src.write_ln visit_node(node[:else]) }
+        end
+
+        src.write_ln "end"
+      when "Case"
+        src.write "case"
+        src.write " #{visit_node(node[:condition]).strip}\n" if node[:condition]
+        indented(src) do
+          node[:whens].each do |w|
+            src.write_ln visit_node(w)
+          end
+          if node[:else]
+            src.write_ln "else"
+            indented(src) do
+              src.write_ln visit_node(node[:else])
+            end
+          end
+        end
+        src.write_ln "end"
+      when "When"
+        src.write_ln "when #{node[:conditions].map { |n| visit_node(n) }.join(", ")}"
+
+        indented(src) { src.write_ln(node[:body] ? visit_node(node[:body]) : "# no op") }
+      when "MacroFor"
+        vars, expr, body = node[:vars], node[:expr], node[:body]
+        var_names = vars.map { |v| visit_node v }
+        @inside_macro = true
+        indent_level = @indent_level
+        @indent_level -= 1 unless indent_level.zero?
+        expanded : Array[String] = eval(visit_node(expr)).map do |*a|
+          locals = [var_names.join(%(", "))].zip(a).to_h
+          locals.merge!(scope) if @inside_macro
+          visit_node(body, locals)
+        end.flatten
+        @indent_level += 1 unless indent_level.zero?
+        expanded.each { |e| src.write e }
+        @inside_macro = false
+      when "MacroLiteral"
+        src.write node[:value]
+      when "MacroExpression"
+        if node[:output]
+          expr = visit_node node[:expr], scope
+          val = scope[expr]
+          src.write val
+        end
+      when "MacroIf"
+        if evaluate_macro_condition(node[:condition], scope)
+          src.write_ln visit_node(node[:then], scope) if node[:then]
+        else
+          src.write_ln visit_node(node[:else], scope) if node[:else]
+        end
+      when "Return"
+        val = node[:value] ? " #{visit_node(node[:value]).strip}" : nil
+        src.write "return#{val}"
+      when "TypeDeclaration"
+        src.write_ln "# @type var #{visit_node(node[:var])}: #{visit_node(node[:declared_type])}"
+        src.write_ln "#{visit_node(node[:var])} = #{visit_node(node[:value])}"
+      when "ExceptionHandler"
+        src.write_ln "begin"
+        indented src do
+          src.write_ln visit_node(node[:body])
+        end
+          if node[:rescues]
+            node[:rescues].each do |r|
+              src.write_ln "rescue #{r[:types].map { |n| visit_node n }.join(", ") if r[:types]}#{" => #{r[:name]}" if r[:name]}"
+              indented(src) { src.write_ln visit_node(r[:body]) } if r[:body]
+            end
+          end
+          if node[:else]
+            src.write_ln "else"
+            indented(src) { src.write_ln visit_node(node[:else]) }
+          end
+          if node[:ensure]
+            src.write_ln "ensure"
+            indented(src) { src.write_ln visit_node(node[:ensure]) }
+          end
+        src.write_ln "end"
+      when "Generic"
+        src.write "#{visit_node(node[:name])}[#{node[:args].map { |a| visit_node a }.join(", ")}]"
+      when "Proc"
+        fn = node[:function]
+        src.write "->#{render_args(fn)} { #{visit_node fn[:body]} }"
+      when "Include"
+        current_namespace = @current_scope ? @current_scope.name.to_namespace : RBS::Namespace.root
+        name = visit_node node[:name]
+        src.write_ln "include #{name}"
+          type = RBS::AST::Members::Include.new(
+            name: method(:TypeName).call(name),
+            args: Array.new,
+            annotations: Array.new,
+            location: node[:location],
+            comment: node[:comment]
+          )
+        if @current_scope
+          @current_scope.members << type
+        else
+          @type_checker.type_env << type
+        end
+      when "Extend"
+        current_namespace = @current_scope ? @current_scope.name.to_namespace : RBS::Namespace.root
+        name = visit_node node[:name]
+        src.write_ln "extend #{name}"
+          type = RBS::AST::Members::Extend.new(
+            name: method(:TypeName).call(name),
+            args: Array.new,
+            annotations: Array.new,
+            location: node[:location],
+            comment: node[:comment]
+          )
+        if @current_scope
+          @current_scope.members << type
+        else
+          @type_checker.type_env << type
+        end
+      when "RegexLiteral"
+        contents = visit_node node[:value]
+        src.write Regexp.new(contents.undump).inspect
+      when "Union"
+        types = node[:types]
+        output = if types.length == 2 && types[1][:type] == "Path" && types[1]["value"] == nil
+                  "#{visit_node(types[0])}?"
+                 else
+                   types.map { |t| visit_node(t) }.join(" | ")
+                 end
+        src.write output
+      when "Next"
+        val = " #{node[:value]}" if node[:value]
+        src.write "next#{val}"
+      when "EmptyNode"
+        # pass
+      else
+        raise "Not implemented: #{node[:type]}"
+      end
+
+      src
+    end
+
+    private def evaluate_macro_condition(condition_node, scope)
+      @eval_vars = true
+      eval(visit_node(condition_node, scope))
+      @eval_vars = false
+    end
+
+    private def indented(src)
+      increment_indent(src)
+      yield
+      decrement_indent(src)
+    end
+
+    private def increment_indent(src)
+      @indent_level += 1
+      src.increment_indent
+    end
+
+    private def decrement_indent(src)
+      @indent_level -= 1
+      src.decrement_indent
+    end
+
+    # TODO: allow NamedTuple as return type
+    private def render_args(node)# : { representation: String, types: Hash[Symbol, Any] }
+      rp : Array[Hash[Symbol, Any]] = node.fetch(:positional_args) { EMPTY_ARRAY }.filter { |a| !a[:value] }
+      op : Array[Hash[Symbol, Any]] = node.fetch(:positional_args) { EMPTY_ARRAY }.filter { |a| a[:value] }
+      rkw : Hash[Symbol, Any] = node.fetch(:req_kw_args) { EMPTY_HASH }
+      okw : Hash[Symbol, Any] = node.fetch(:opt_kw_args) { EMPTY_HASH }
+      rest_p : String? = node[:rest_p_args] ? visit_node(node[:rest_p_args]) : nil
+      rest_kw : Hash[Symbol, Any]? = node[:rest_kw_args]
+      return nil if [rp, op, rkw, okw, rest_p, rest_kw].all? { |a| a && a.empty? }
+
+      contents = [
+        rp.map { |a| visit_node(a) },
+        op.map { |a| "#{a[:name]} = #{visit_node(a[:value]).strip}" },
+        rkw.map { |name, _| "#{name}:" },
+        okw.map { |name, value| "#{name}: #{value}" },
+        rest_p ? "*#{rest_p}" : "",
+        rest_kw ? "**#{visit_node(rest_kw)}" : ""
+      ].reject(&:empty?).flatten.join(", ")
+      representation = "(#{contents})"
+      rp.map! do |a|
+        RBS::Types::Function::Param.new(
+          name: visit_node(a).to_sym,
+          type: RBS::Types::Bases::Any.new(
+            location: a[:location]
+          )
+        )
+      end
+      op.map! do |a|
+        RBS::Types::Function::Param.new(
+          name: visit_node(a).to_sym,
+          type: RBS::Types::Bases::Any.new(location: a[:location])
+        )
+      end
+      rest_p = (rpa = node[:rest_p_args]) ? RBS::Types::Function::Param.new(name: visit_node(rpa).to_sym, type: RBS::Types::Bases::Any.new(location: node[:location])) : nil
+      {
+        representation: representation,
+        types: {
+          required_positionals: rp,
+          optional_positionals: op,
+          rest_positionals: rest_p,
+          trailing_positionals: EMPTY_ARRAY, # TODO
+          required_keywords: node[:req_kw_args] || EMPTY_HASH,
+          optional_keywords: node[:opt_kw_args] || EMPTY_HASH,
+          rest_keywords: node[:rest_kw_args] ?
+            RBS::Types::Function::Param.new(
+              name: visit_node(node[:rest_kw_args]).to_sym,
+              type: RBS::Types::Bases::Any.new(location: node[:location])
+            ) : nil
+        }
+      }
+    end
+  end
+end