console1984 0.1.10 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d40ddccd6e06beaf5f506991d87a1b60d20246d6320e92a5dda0dceef86c746
-  data.tar.gz: 03cf91cc60cd5764665042e918c5241464ae4b2ab923dad19e7ccac28ae0954f
+  metadata.gz: edce6968a693f97b73d1e0c54ae8d0e83b659a71ef229bc8486c46f456f65783
+  data.tar.gz: 8705e765cf98e7ec0ee828c5134694670a71779ff7e065ffed27e2a5e7b2dfc2
 SHA512:
-  metadata.gz: db4dab2e225fb0565cf7654ac9030aecba5372f404e813633e088b615ad834c1283319456bb0c69b5c5526e5a2f8387c9151bb1f59ba20889d40993b3db29e9e
-  data.tar.gz: 921511573b0f9ad7c8d9019dbe2b83db1d5f054740508e33c48aea31de441a580a7d4ddecc75d9f722388028b08fae46fce5c1d7503a688598bf8b72d0121c14
+  metadata.gz: 51a530838a4a651ffef1df68cc8f724f5e30998c90b44fd34ec1dd63a187b5344b662fffe3abd077a89586eab503f07841dd780ee1739320aedbf83add9b6455
+  data.tar.gz: a24336a400da036dec22b6791234f83d09b4c313e61c37f80c6cc594b3f15ef8fe42313a6c1e2d092da0623b430d93be458513775fa88012fa8f63d8e1074362

data/config/protections.yml

@@ -5,6 +5,7 @@ validations:
     - PG
     - Mysql2
     - IRB
+    - Parser
   forbidden_constant_reference:
     always:
       - Console1984

data/lib/console1984/command_validator/.command_parser.rb

@@ -0,0 +1,69 @@
+# Naming class with dot so that it doesn't get loaded eagerly by Zeitwork. We want to load
+# only when a console session is started, when +parser+ is loaded.
+#
+# See +Console1984::Supervisor#require_dependencies+
+class Console1984::CommandValidator::CommandParser < ::Parser::AST::Processor
+  include AST::Processor::Mixin
+  include Console1984::Freezeable
+
+  def initialize
+    @constants = []
+    @declared_classes_or_modules = []
+    @constant_assignments = []
+  end
+
+  # We define accessors to define lists without duplicates. We are not using a +SortedSet+ because we want
+  # to mutate strings in the list while the processing is happening. And we don't use metapgroamming to define the
+  # accessors to prevent having problems with freezable and its instance_variable* protection.
+
+  def constants
+    @constants.uniq
+  end
+
+  def declared_classes_or_modules
+    @declared_classes_or_modules.uniq
+  end
+
+  def constant_assignments
+    @constant_assignments.uniq
+  end
+
+  def on_class(node)
+    super
+    const_declaration, _, _ = *node
+    constant = extract_constants(const_declaration).first
+    @declared_classes_or_modules << constant if constant.present?
+  end
+
+  alias_method :on_module, :on_class
+
+  def on_const(node)
+    super
+    name, const_name = *node
+    const_name = const_name.to_s
+    last_constant = @constants.last
+
+    if name.nil? || (name && name.type == :cbase) # cbase = leading ::
+      if last_constant&.end_with?("::")
+        last_constant << const_name
+      else
+        @constants << const_name
+      end
+    elsif last_constant
+      last_constant << "::#{const_name}"
+    end
+  end
+
+  def on_casgn(node)
+    super
+    scope_node, name, value_node = *node
+    @constant_assignments.push(*extract_constants(value_node))
+  end
+
+  private
+    def extract_constants(node)
+      self.class.new.tap do |processor|
+        processor.process(node)
+      end.constants
+    end
+end

data/lib/console1984/command_validator/parsed_command.rb

@@ -6,85 +6,19 @@ class Console1984::CommandValidator::ParsedCommand
 
   attr_reader :raw_command
 
-  delegate :declared_classes_or_modules, :constants, :constant_assignments, to: :processed_ast
+  delegate :declared_classes_or_modules, :constants, :constant_assignments, to: :command_parser
 
   def initialize(raw_command)
     @raw_command = Array(raw_command).join("\n")
   end
 
   private
-    def processed_ast
-      @processed_ast ||= CommandProcessor.new.tap do |processor|
+    def command_parser
+      @command_parser ||= Console1984::CommandValidator::CommandParser.new.tap do |processor|
         ast = Parser::CurrentRuby.parse(raw_command)
         processor.process(ast)
       rescue Parser::SyntaxError
         # Fail open with syntax errors
       end
     end
-
-    class CommandProcessor < ::Parser::AST::Processor
-      include AST::Processor::Mixin
-      include Console1984::Freezeable
-
-      def initialize
-        @constants = []
-        @declared_classes_or_modules = []
-        @constant_assignments = []
-      end
-
-      # We define accessors to define lists without duplicates. We are not using a +SortedSet+ because we want
-      # to mutate strings in the list while the processing is happening. And we don't use metapgroamming to define the
-      # accessors to prevent having problems with freezable and its instance_variable* protection.
-
-      def constants
-        @constants.uniq
-      end
-
-      def declared_classes_or_modules
-        @declared_classes_or_modules.uniq
-      end
-
-      def constant_assignments
-        @constant_assignments.uniq
-      end
-
-      def on_class(node)
-        super
-        const_declaration, _, _ = *node
-        constant = extract_constants(const_declaration).first
-        @declared_classes_or_modules << constant if constant.present?
-      end
-
-      alias_method :on_module, :on_class
-
-      def on_const(node)
-        super
-        name, const_name = *node
-        const_name = const_name.to_s
-        last_constant = @constants.last
-
-        if name.nil? || (name && name.type == :cbase) # cbase = leading ::
-          if last_constant&.end_with?("::")
-            last_constant << const_name
-          else
-            @constants << const_name
-          end
-        elsif last_constant
-          last_constant << "::#{const_name}"
-        end
-      end
-
-      def on_casgn(node)
-        super
-        scope_node, name, value_node = *node
-        @constant_assignments.push(*extract_constants(value_node))
-      end
-
-      private
-        def extract_constants(node)
-          self.class.new.tap do |processor|
-            processor.process(node)
-          end.constants
-        end
-    end
 end

data/lib/console1984/supervisor.rb

@@ -41,6 +41,16 @@ class Console1984::Supervisor
         require 'parser/current'
       end
       require 'colorized_string'
+
+      # Explicit lazy loading because it depends on +parser+, which we want to only load
+      # in console sessions.
+      require_relative "./command_validator/.command_parser"
+
+      # This solves a weird class loading error where ActiveRecord dosn't resolve +Relation+ properly.
+      # See https://github.com/basecamp/console1984/issues/29
+      #
+      # TODO: This is a temporary fix. Need to figure out why/when this happens.
+      require "active_record/relation"
     end
 
     def start_session

data/lib/console1984/version.rb

@@ -1,3 +1,3 @@
 module Console1984
-  VERSION = '0.1.10'
+  VERSION = '0.1.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console1984
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.14
 platform: ruby
 authors:
 - Jorge Manrubia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -200,6 +200,7 @@ files:
 - lib/console1984.rb
 - lib/console1984/command_executor.rb
 - lib/console1984/command_validator.rb
+- lib/console1984/command_validator/.command_parser.rb
 - lib/console1984/command_validator/forbidden_constant_reference_validation.rb
 - lib/console1984/command_validator/forbidden_reopening_validation.rb
 - lib/console1984/command_validator/parsed_command.rb