lowkey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c9ed7172b4b3902649abd82140869b7d97bb285f12a81283548f2c38c1b15ce
+  data.tar.gz: 1d85f8da175513ebea0bc9ba487654f4b1b7275068ac5f1e1d4ae768c196849c
+SHA512:
+  metadata.gz: 2192b79de007545b2f01e66967f171fb0aa19fcf1aa3253eb79505169d802c3f8bad2e122b7e393ee2829250dc1992482b5593434d4b20d899ea641bbeeb6705
+  data.tar.gz: 0c8e064e9a70f7b6580e3f94058a77371df69cbc744a871207fc466911cd607c9fc48f34f1bedab048a250da6ad1dc4228f553c4832a52edc27bdb5c3ae5a5af

data/lib/lowkey.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'prism'
+
+require_relative 'visitors/visitor'
+require_relative 'proxies/file_proxy'
+
+module Lowkey
+  class << self
+    def keys
+      @keys ||= {}
+    end
+
+    def [](key)
+      keys[key]
+    end
+
+    def load(file_path:)
+      root_node = Prism.parse_file(file_path).value
+      file_proxy = FileProxy.new(path: file_path, root_node:)
+
+      parent_map = ParentMap.new(root_node:)
+      visitor = Visitor.new(file_proxy:, parent_map:)
+      root_node.accept(visitor)
+
+      map_file_path(file_proxy:)
+      map_definitions(file_proxy:)
+
+      file_proxy
+    end
+
+    def clear
+      keys.clear
+    end
+
+    private
+
+    def map_file_path(file_proxy:)
+      keys[file_proxy.path] = file_proxy
+    end
+
+    def map_definitions(file_proxy:)
+      file_proxy.definitions.each_key do |namespace|
+        keys[namespace] ||= []
+        keys[namespace] << file_proxy
+      end
+    end
+  end
+end

data/lib/maps/parent_map.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lowkey
+  class ParentMap
+    def initialize(root_node:)
+      @parent_map = {}
+      @current_parent = nil
+
+      map(root_node)
+    end
+
+    def [](node)
+      @parent_map[node]
+    end
+
+    private
+
+    def map(node)
+      @parent_map[node] = @current_parent
+
+      old_parent = @current_parent
+      @current_parent = node
+
+      node.compact_child_nodes.each do |n|
+        map(n)
+      end
+
+      @current_parent = old_parent
+    end
+  end
+end

data/lib/proxies/class_proxy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Lowkey
+  class ClassProxy
+    attr_reader :namespace, :file_proxy, :start_line, :end_line
+    attr_accessor :private_start_line, :class_methods, :instance_methods, :method_calls
+
+    def initialize(node:, namespace:, file_proxy:)
+      @namespace = namespace
+      @file_proxy = file_proxy
+
+      @start_line = node.class_keyword_loc.start_line
+      @end_line = node.end_keyword_loc.end_line # class_keyword_loc ?
+      @private_start_line = nil
+
+      @class_methods = {}
+      @instance_methods = {}
+      @method_calls = []
+    end
+
+    private
+
+    def class_method?(node)
+      return true if node.is_a?(::Prism::DefNode) && node.receiver.instance_of?(Prism::SelfNode) # self.method_name
+      return true if node.is_a?(::Prism::SingletonClassNode) # class << self
+
+      if (parent_node = parent_map.parent(node:))
+        return class_method?(parent_node)
+      end
+
+      false
+    end
+  end
+end

data/lib/proxies/file_proxy.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../maps/parent_map'
+require_relative '../proxies/class_proxy'
+
+module Lowkey
+  class FileProxy
+    attr_reader :path, :start_line, :end_line
+    attr_accessor :definitions, :dependencies
+
+    def initialize(path:, root_node:)
+      @path = path
+      @start_line = 0
+      @end_line = root_node.respond_to?(:end_line) ? root_node.end_line : nil
+
+      @definitions = {}
+      @dependencies = []
+    end
+
+    def class_proxy(node:, parent_map:)
+      namespace = namespace(node:, parent_map:).reverse.join('::')
+      @definitions[namespace] ||= ClassProxy.new(node:, namespace:, file_proxy: self)
+    end
+
+    private
+
+    def namespace(node:, parent_map:, namespace: [])
+      return namespace if parent_map[node].nil?
+
+      namespace << node.constant_path.name.to_s if node.respond_to?(:constant_path)
+
+      namespace(node: parent_map[node], parent_map:, namespace:)
+    end
+  end
+end

data/lib/version.rb

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

data/lib/visitors/method_call_visitor.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class MethodCallVisitor
+  attr_reader :parent_map
+
+  def initialize(file_proxy:, parent_map:)
+    @file_proxy = file_proxy
+    @parent_map = parent_map
+  end
+
+  def visit(node)
+    class_proxy = @file_proxy.class_proxy(node:, parent_map:)
+    class_proxy.method_calls << node
+
+    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
+
+    class_proxy.private_start_line = node.start_line
+  end
+end

data/lib/visitors/method_class_visitor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class MethodClassVisitor
+  attr_reader :parent_map
+
+  def initialize(file_proxy:, parent_map:)
+    @file_proxy = file_proxy
+    @parent_map = parent_map
+  end
+
+  def visit(node)
+    @file_proxy.class_proxy(node:, parent_map:)
+  end
+end

data/lib/visitors/method_def_visitor.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class MethodDefVisitor
+  attr_reader :parent_map
+
+  def initialize(file_proxy:, parent_map:)
+    @file_proxy = file_proxy
+    @parent_map = parent_map
+  end
+
+  def visit(node)
+    class_proxy = @file_proxy.class_proxy(node:, parent_map:)
+
+    if class_proxy.class_method?(node:, parent_map:)
+      class_proxy.class_methods[node.name] = node
+    else
+      class_proxy.instance_methods[node.name] = node
+    end
+  end
+end

data/lib/visitors/visitor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'method_call_visitor'
+require_relative 'method_class_visitor'
+require_relative 'method_def_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:)
+      @method_def_visitor = MethodDefVisitor.new(file_proxy:, parent_map:)
+    end
+
+    def visit_call_node(node)
+      @method_call_visitor.visit(node)
+      super
+    end
+
+    def visit_class_node(node)
+      @method_class_visitor.visit(node)
+      super
+    end
+
+    def visit_def_node(node)
+      @method_def_visitor.visit(node)
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: lowkey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- maedi
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PRISM is amazing but we need to use it responsibly and only load the
+  AST once, do that with Lowkey!
+email:
+- maediprichard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lowkey.rb
+- lib/maps/parent_map.rb
+- lib/proxies/class_proxy.rb
+- lib/proxies/file_proxy.rb
+- lib/version.rb
+- lib/visitors/method_call_visitor.rb
+- lib/visitors/method_class_visitor.rb
+- lib/visitors/method_def_visitor.rb
+- lib/visitors/visitor.rb
+homepage: https://github.com/low-rb/lowkey
+licenses: []
+metadata:
+  homepage_uri: https://github.com/low-rb/lowkey
+  source_code_uri: https://github.com/low-rb/lowkey/src/branch/main
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: An API for accessing PRISM metadata easily and efficiently
+test_files: []