lowkey 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29b11d6aea2b779089fd087a90495983424bc601eed544dd05275067a6e4f42d
-  data.tar.gz: 0a712a5ff40e024de4b38c00899d9d63b899595e14a2a17e636241da9caf65ed
+  metadata.gz: 0c3c9495f9a78f72d1c42103c7feca2dd8bc07aee9621658e20849f9aca22952
+  data.tar.gz: 3a9f9940d723fadc08d8f6ac552eb79f2cdfc56b4b01316498b18fd327b5ebed
 SHA512:
-  metadata.gz: ec78422aac7af3ec938be6e39a2bda2d2c85824d6060df0ceb655062abc8b539a2af1ed0c739043ee6820c1ef5e5395af89cc63383f4f42624692f138d105436
-  data.tar.gz: cd35dcf2ffe61ff07568e8aeb0db5632da57c6927bb7946118f31f98ee942e3dbeff58c537a6654f2b195edc9d2ef9eda06956c4af8f67958cbf09018d257bbd
+  metadata.gz: d1e42a9e1d4dbdd21dcf869d6c2862724b5e609c1e8f5c8716ae530edaca518f655de6d04aff0b9686746a7cd06e00665a243bd60d3a5f8bdc7a3b57435f8912
+  data.tar.gz: d0ccec589e58a7a1f379e683689f52fbc2cd8b1ea71dce3bb809a3f3267ae4427f1f83885d08231fadc56b567ecefb9820a5a1438ca797510a35fd5549d282c6

data/lib/factories/proxy_factory.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require_relative '../factories/source_factory'
+
 require_relative '../proxies/body_proxy'
 require_relative '../proxies/class_proxy'
 require_relative '../proxies/file_proxy'
 require_relative '../proxies/method_proxy'
+require_relative '../proxies/module_proxy'
 require_relative '../proxies/param_proxy'
 require_relative '../proxies/return_proxy'
 
@@ -16,10 +18,15 @@ module Lowkey
         FileProxy.new(root_node:, source:)
       end
 
-      def class_proxy(node:, namespace:, file_path:, lines:)
-        source = SourceFactory.class_source(node:, namespace:, file_path:, lines:)
+      def module_proxy(node:, namespace:, file_path:, lines:)
+        source = SourceFactory.module_source(node:, namespace:, file_path:, lines:)
         name = node.respond_to?(:name) ? node.name : 'Object'
-        ClassProxy.new(node:, name:, namespace:, source:)
+        ModuleProxy.new(node:, name:, namespace:, source:)
+      end
+
+      def class_proxy(node:, namespace:, file_path:, lines:)
+        source = SourceFactory.class_source(node:, file_path:, lines:)
+        ClassProxy.new(node:, name: node.name, namespace:, source:)
       end
 
       def method_proxy(method_node:, file_proxy:)

data/lib/factories/source_factory.rb

@@ -6,14 +6,13 @@ module Lowkey
   class SourceFactory
     class << self
       def file_source(root_node:, file_path:)
-        end_line = root_node.respond_to?(:end_line) ? root_node.end_line : nil
+        end_line = root_node.respond_to?(:end_line) ? root_node.end_line : nil # TODO: Get file line count.
 
-        Source.new(file_path:, scope: 'file', lines: root_node.script_lines, start_line: 0, end_line:)
+        Source.new(file_path:, scope: 'file', lines: root_node.script_lines, start_line: 1, end_line:)
       end
 
-      # @param node: Either the class node or the main object node.
-      def class_source(node:, namespace:, file_path:, lines:)
-        start_line = node.respond_to?(:class_keyword_loc) ? node.class_keyword_loc.start_line : 0
+      def module_source(node:, namespace:, file_path:, lines:)
+        start_line = node.respond_to?(:class_keyword_loc) ? node.class_keyword_loc.start_line : 1
         end_line = node.respond_to?(:end_keyword_loc) ? node.end_keyword_loc.end_line : start_line
         end_line = node.end_line if namespace == 'Object'
         scope = node.respond_to?(:name) ? node.name : 'Object'
@@ -21,11 +20,19 @@ module Lowkey
         Source.new(file_path:, scope:, lines:, start_line:, end_line:)
       end
 
+      def class_source(node:, file_path:, lines:)
+        start_line = node.respond_to?(:class_keyword_loc) ? node.class_keyword_loc.start_line : 1
+        end_line = node.respond_to?(:end_keyword_loc) ? node.end_keyword_loc.end_line : start_line
+
+        Source.new(file_path:, scope: node.name, lines:, start_line:, end_line:)
+      end
+
       def method_source(method_node:, file_path:, lines:)
         scope = method_node.name
         start_line = method_node.start_line
         end_line = method_node.end_line
-        end_line = end_line_from_indent(method_node:, lines:) if end_line > lines.count
+        # TODO: Brittle conditional. What we really want to identify is if the method/rest of file was able to be parsed into an AST.
+        end_line = end_line_from_indent(method_node:, lines:) if end_line >= lines.count
 
         Source.new(file_path:, scope:, lines:, start_line:, end_line:)
       end

data/lib/interfaces/proxy.rb

@@ -10,7 +10,7 @@ module Lowkey
 
     attr_reader :name
 
-    def_delegators :@source, :file_path, :lines, :start_line, :scope
+    def_delegators :@source, :file_path, :lines, :lines=, :start_line, :end_line, :scope
     def_delegators :@source, :wrap, :export
 
     def initialize(name:, source:)

data/lib/lowkey.rb

@@ -18,7 +18,7 @@ module Lowkey
       keys[key]
     end
 
-    def load(file_path)
+    def load(file_path, cache: true)
       root_node = Prism.parse_file(file_path).value
       file_proxy = ProxyFactory.file_proxy(root_node:, file_path:)
 
@@ -28,7 +28,7 @@ module Lowkey
 
       AdapterLoader.load(file_proxy:)
 
-      if Lowkey.config.cache
+      if Lowkey.config.cache && cache
         map_file_path(file_proxy:)
         map_definitions(file_proxy:)
       end

data/lib/models/source.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 module Lowkey
+  class WriteError < StandardError; end
+
   class Source
-    attr_reader :file_path, :scope
-    attr_accessor :lines, :start_line, :end_line
+    attr_reader :file_path, :scope, :lines
+    attr_accessor :start_line, :end_line
 
     def initialize(file_path:, scope:, lines:, start_line:, end_line: nil)
       @file_path = file_path
@@ -14,16 +16,26 @@ module Lowkey
       @lines = lines
     end
 
+    def lines=(new_lines)
+      raise WriteError, "More new lines than old lines, won't fit" if new_lines.count > lines.count
+
+      indent = lines[start_index][/^\s+/]
+
+      [start_index..end_index].each do |line_index|
+        lines[line_index] = indent + new_lines.pop.to_s || ''
+      end
+    end
+
     def wrap(prefix:, suffix:)
       start_line = lines[start_index]
       indent = start_line[/^\s+/]
-      lines[start_index] = indent + prefix.to_s + start_line.lstrip
 
+      lines[start_index] = indent + prefix.to_s + start_line.lstrip
       lines[end_index] = lines[end_index] + suffix.to_s
     end
 
     def export
-      lines.join
+      lines[start_index..end_index].join
     end
 
     private

data/lib/proxies/class_proxy.rb

@@ -1,45 +1,16 @@
 # frozen_string_literal: true
 
-require_relative '../interfaces/proxy'
-require_relative '../queries/query'
+require_relative 'module_proxy'
 
 module Lowkey
-  class ClassProxy < Proxy
-    include Query
-
-    attr_reader :namespace
-    attr_accessor :private_start_line, :keyed_methods, :class_methods, :instance_methods, :method_calls
+  class ClassProxy < ModuleProxy
+    attr_accessor :instance_methods, :class_binding
 
     def initialize(node:, name:, namespace:, source:)
-      super(name:, source:)
-
-      @node = node
-      @namespace = namespace
-
-      @private_start_line = nil
+      super(node:, name:, namespace:, source:)
 
-      @keyed_methods = {}
-      @class_methods = {}
       @instance_methods = {}
-
-      @method_calls = []
-    end
-
-    def [](key)
-      key.start_with?('.') ? query(node: @node, namespace: nil, name: key.delete_prefix('.')) : @keyed_methods[key]
-    end
-
-    class << self
-      def class_method?(method_node:, parent_map:)
-        return true if method_node.is_a?(::Prism::DefNode) && method_node.receiver.instance_of?(Prism::SelfNode) # self.method_name
-        return true if method_node.is_a?(::Prism::SingletonClassNode) # class << self
-
-        if (parent_node = parent_map[method_node])
-          return class_method?(method_node: parent_node, parent_map:)
-        end
-
-        false
-      end
+      @class_binding = nil
     end
   end
 end

data/lib/proxies/file_proxy.rb

@@ -17,7 +17,7 @@ module Lowkey
       @root_node = root_node
 
       @definitions = {}
-      @dependencies = []
+      @dependencies = Set.new
     end
 
     def [](keypath)
@@ -29,9 +29,13 @@ module Lowkey
       # TODO: Slice the lines in a file and replace with the output of the class proxy.
     end
 
-    def upsert_class_proxy(class_proxy:)
+    def upsert_definition(module_proxy:)
       # TODO: Merge duplicate class with existing class.
-      @definitions[class_proxy.namespace] ||= class_proxy
+      @definitions[module_proxy.namespace] ||= module_proxy
+    end
+
+    def upsert_dependency(namespace:)
+      @dependencies.add(namespace)
     end
   end
 end

data/lib/proxies/module_proxy.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../interfaces/proxy'
+require_relative '../queries/query'
+
+module Lowkey
+  class ModuleProxy < Proxy
+    include Query
+
+    attr_reader :namespace
+    attr_accessor :private_start_line, :keyed_methods, :class_methods, :method_calls
+
+    def initialize(node:, name:, namespace:, source:)
+      super(name:, source:)
+
+      @node = node
+      @namespace = namespace
+
+      @private_start_line = nil
+
+      @keyed_methods = {}
+      @class_methods = {}
+
+      @method_calls = []
+    end
+
+    def [](key)
+      key.start_with?('.') ? query(node: @node, namespace: nil, name: key.delete_prefix('.')) : @keyed_methods[key]
+    end
+
+    class << self
+      def class_method?(method_node:, parent_map:)
+        return true if method_node.is_a?(::Prism::DefNode) && method_node.receiver.instance_of?(Prism::SelfNode) # self.method_name
+        return true if method_node.is_a?(::Prism::SingletonClassNode) # class << self
+
+        if (parent_node = parent_map[method_node])
+          return class_method?(method_node: parent_node, parent_map:)
+        end
+
+        false
+      end
+    end
+  end
+end

data/lib/queries/query.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'prism'
+
 module Lowkey
   module Query
     # TODO: Make name a keypath.
@@ -10,6 +12,9 @@ module Lowkey
     end
 
     def namespace(node:, parent_map:, namespace: [])
+      # When inside RBX, Prism thinks we're defining a class because of "<".
+      return nil if node.respond_to?(:constant_path) && node.constant_path.is_a?(Prism::MissingNode)
+
       if parent_map[node].nil?
         namespace << 'Object' if namespace.empty?
         return namespace.reverse.join('::')

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lowkey
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
 end

data/lib/visitors/{method_class_visitor.rb → class_visitor.rb}

@@ -4,27 +4,18 @@ require_relative '../factories/proxy_factory'
 require_relative '../queries/query'
 
 module Lowkey
-  class MethodClassVisitor
+  class ClassVisitor
     include Query
 
     def initialize(file_proxy:, parent_map:)
       @file_proxy = file_proxy
       @parent_map = parent_map
-
-      create_root_class
     end
 
     def visit(node)
-      namespace = namespace(node:, parent_map:)
+      namespace = namespace(node:, parent_map:) || return
       class_proxy = ProxyFactory.class_proxy(node:, namespace:, file_path:, lines:)
-      @file_proxy.upsert_class_proxy(class_proxy:)
-    end
-
-    private
-
-    def create_root_class
-      class_proxy = ProxyFactory.class_proxy(node: @file_proxy.root_node, namespace: 'Object', file_path:, lines:)
-      @file_proxy.upsert_class_proxy(class_proxy:)
+      @file_proxy.upsert_definition(module_proxy: class_proxy)
     end
 
     attr_reader :parent_map

data/lib/visitors/method_call_visitor.rb

@@ -12,18 +12,28 @@ module Lowkey
     end
 
     def visit(node)
-      namespace = namespace(node:, parent_map:)
-      class_proxy = @file_proxy[namespace]
-      class_proxy.method_calls << node
+      namespace = namespace(node:, parent_map:) || return
+      module_proxy = file_proxy[namespace]
 
-      return unless node.name == :private && node.respond_to?(:start_line) && class_proxy.start_line && class_proxy.end_line
-      return unless node.start_line > class_proxy.start_line && node.start_line < class_proxy.end_line
+      module_proxy.method_calls << node
+      upsert_dependency(node:, namespace:)
 
-      class_proxy.private_start_line = node.start_line
+      return unless node.name == :private && node.respond_to?(:start_line) && module_proxy.start_line && module_proxy.end_line
+      return unless node.start_line > module_proxy.start_line && node.start_line < module_proxy.end_line
+
+      module_proxy.private_start_line = node.start_line
     end
 
     private
 
-    attr_reader :parent_map
+    def upsert_dependency(node:, namespace:)
+      return unless %i[include extend].include?(node.name)
+
+        dependency_name = node.arguments.arguments.first.name.to_s
+        dependency_name = "#{namespace}::#{dependency_name}" unless dependency_name.start_with?('::')
+        file_proxy.upsert_dependency(namespace: dependency_name)
+    end
+
+    attr_reader :file_proxy, :parent_map
   end
 end

data/lib/visitors/method_def_visitor.rb

@@ -2,6 +2,7 @@
 
 require_relative '../factories/source_factory'
 require_relative '../factories/proxy_factory'
+require_relative '../proxies/method_proxy'
 require_relative '../queries/query'
 
 module Lowkey
@@ -15,16 +16,16 @@ module Lowkey
 
     def visit(method_node)
       namespace = namespace(node: method_node, parent_map:)
-      class_proxy = file_proxy[namespace]
+      module_proxy = file_proxy[namespace]
       method_proxy = ProxyFactory.method_proxy(method_node:, file_proxy:)
 
-      class_proxy.keyed_methods[method_node.name] = method_proxy
+      module_proxy.keyed_methods[method_node.name] = method_proxy
 
       # TODO: Implemented as tagged methods similar to tagged params.
-      if ClassProxy.class_method?(method_node:, parent_map:)
-        class_proxy.class_methods[method_node.name] = method_proxy
-      else
-        class_proxy.instance_methods[method_node.name] = method_proxy
+      if ModuleProxy.class_method?(method_node:, parent_map:)
+        module_proxy.class_methods[method_node.name] = method_proxy
+      elsif module_proxy.class <= ClassProxy
+        module_proxy.instance_methods[method_node.name] = method_proxy
       end
     end
 

data/lib/visitors/module_visitor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../factories/proxy_factory'
+require_relative '../queries/query'
+
+module Lowkey
+  class ModuleVisitor
+    include Query
+
+    def initialize(file_proxy:, parent_map:)
+      @file_proxy = file_proxy
+      @parent_map = parent_map
+
+      create_root_module
+    end
+
+    def visit(node)
+      namespace = namespace(node:, parent_map:)
+      module_proxy = ProxyFactory.module_proxy(node:, namespace:, file_path:, lines:)
+      @file_proxy.upsert_definition(module_proxy:)
+    end
+
+    private
+
+    def create_root_module
+      module_proxy = ProxyFactory.module_proxy(node: @file_proxy.root_node, namespace: 'Object', file_path:, lines:)
+      @file_proxy.upsert_definition(module_proxy:)
+    end
+
+    attr_reader :parent_map
+
+    def file_path
+      @file_proxy.file_path
+    end
+
+    def lines
+      @file_proxy.lines
+    end
+  end
+end

data/lib/visitors/visitor.rb

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
 
-require_relative 'method_call_visitor'
-require_relative 'method_class_visitor'
+require_relative 'class_visitor'
+require_relative 'module_visitor'
 require_relative 'method_def_visitor'
+require_relative 'method_call_visitor'
 
 module Lowkey
   class Visitor < Prism::Visitor
     def initialize(file_proxy:, parent_map:)
-      @method_call_visitor = MethodCallVisitor.new(file_proxy:, parent_map:)
-      @method_class_visitor = MethodClassVisitor.new(file_proxy:, parent_map:)
+      @class_visitor = ClassVisitor.new(file_proxy:, parent_map:)
+      @module_visitor = ModuleVisitor.new(file_proxy:, parent_map:)
       @method_def_visitor = MethodDefVisitor.new(file_proxy:, parent_map:)
+      @method_call_visitor = MethodCallVisitor.new(file_proxy:, parent_map:)
     end
 
-    def visit_call_node(node)
-      @method_call_visitor.visit(node)
+    def visit_class_node(node)
+      @class_visitor.visit(node)
       super
     end
 
-    def visit_class_node(node)
-      @method_class_visitor.visit(node)
+    def visit_module_node(node)
+      @module_visitor.visit(node)
       super
     end
 
@@ -26,5 +28,10 @@ module Lowkey
       @method_def_visitor.visit(node)
       super
     end
+
+    def visit_call_node(node)
+      @method_call_visitor.visit(node)
+      super
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lowkey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - maedi
@@ -44,13 +44,15 @@ files:
 - lib/proxies/class_proxy.rb
 - lib/proxies/file_proxy.rb
 - lib/proxies/method_proxy.rb
+- lib/proxies/module_proxy.rb
 - lib/proxies/param_proxy.rb
 - lib/proxies/return_proxy.rb
 - lib/queries/query.rb
 - lib/version.rb
+- lib/visitors/class_visitor.rb
 - lib/visitors/method_call_visitor.rb
-- lib/visitors/method_class_visitor.rb
 - lib/visitors/method_def_visitor.rb
+- lib/visitors/module_visitor.rb
 - lib/visitors/visitor.rb
 homepage: https://github.com/low-rb/lowkey
 licenses: []