console1984 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a1a63354e44bfc19ab3ca033e14a44505c55832aa150ae1fc11b77b8d01919
-  data.tar.gz: beef047a7ec407f4fac7d08601a7522689d2cb0365d186447a4f4bbf0f06ebfe
+  metadata.gz: 315c8962dd29be4689059dfd02352fc55a0a30ad0d00de1267f033886156084f
+  data.tar.gz: 7f3ee9d6b9a3bebb3616d8ea1dadb7d2de40bea1141c2763a4f46fcffb89c532
 SHA512:
-  metadata.gz: 925ef9d2ec34d823fe1ed7714164ca6ef7842e91f952c8746fdc60d53d8e5e7a9870a0b0883c702f5d5f7f26f653251f09325814bac8b504a8d40de2eab2b67a
-  data.tar.gz: a362cb02f0499406b7aea4e9e415265ceabefe9aaeb4661fe6097789252c746a4fd52d8faad4aaed56b7c5b48abefc1045cc539cf605077327300ec9d1b94483
+  metadata.gz: d127676bd46058d5128a139509055f77561e1f4abbf56f8b52730cc5d2c9190e5dfe5ed1c6f6e91cafc1f8ef7b4b60b200e98f5969dbd2f2b374685d026274c7
+  data.tar.gz: 72213cf757e348f7e5b29ce5d515d38e5b0d4e0e5694491d02dcf120cab4596f434f0baef9c4850f7b010221b781cd47ad12c4813b26a370c1408059e45fefd8

data/README.md

@@ -60,6 +60,14 @@ Unnamed, why are you using this console today?
 > ...
 ```
 
+`rails query` doesn't prompt, so each query is recorded as its own session with the reason `rails query`, or `rails query (via <agent>)` when a known agent's environment variable is set, such as `rails query (via Claude Code)`. To record why a query was run, set `CONSOLE_REASON`, e.g. to the card, issue or support conversation that authorized it:
+
+```
+$ CONSOLE_REASON=https://app.basecamp.com/1/buckets/2/card_tables/cards/3 rails query 'Account.count'
+```
+
+The session is recorded with the reason `rails query: https://app.basecamp.com/…`. The value is flattened to one line of plain text and capped at 255 characters.
+
 ### Auditing sessions
 
 Check out [`audits1984`](https://github.com/basecamp/audits1984), a companion auditing tool prepared to work with `console1984` database session trails.

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

@@ -1,7 +1,7 @@
 # Naming class with dot so that it doesn't get loaded eagerly by Zeitwerk. We want to load
-# only when a console session is started, when +parser+ is loaded.
-#
-# See +Console1984::Supervisor#require_dependencies+
+# only when a console session is started.
+Console1984.require_ruby_parser_dependencies
+
 class Console1984::CommandValidator::CommandParser < ::Parser::AST::Processor
   include AST::Processor::Mixin
   include Console1984::Freezeable

data/lib/console1984/command_validator/parsed_command.rb

@@ -1,6 +1,4 @@
 # Parses a command string and exposes different constructs to be used by validations.
-#
-# Internally, it uses the {parser}[https://github.com/whitequark/parser] gem to perform the parsing.
 class Console1984::CommandValidator::ParsedCommand
   include Console1984::Freezeable
 
@@ -15,7 +13,7 @@ class Console1984::CommandValidator::ParsedCommand
   private
     def command_parser
       @command_parser ||= Console1984::CommandValidator::CommandParser.new.tap do |processor|
-        ast = Parser::CurrentRuby.parse(raw_command)
+        ast = Console1984.ruby_parser.parse(raw_command)
         processor.process(ast)
       rescue Parser::SyntaxError
         # Fail open with syntax errors

data/lib/console1984/query_auditor.rb

@@ -1,4 +1,7 @@
 class Console1984::QueryAuditor
+  REASON_ENV_KEY = "CONSOLE_REASON"
+  REASON_LENGTH_LIMIT = 255
+
   mattr_accessor :known_agents, default: {
     "CLAUDECODE"      => "Claude Code",
     "CODEX_THREAD_ID" => "Codex"
@@ -27,6 +30,10 @@ class Console1984::QueryAuditor
     end
 
     def session_reason
+      [ default_reason, given_reason ].compact.join(": ")
+    end
+
+    def default_reason
       if agent = detected_agent
         "rails query (via #{agent})"
       else
@@ -37,4 +44,14 @@ class Console1984::QueryAuditor
     def detected_agent
       known_agents.find { |var, _| ENV[var].present? }&.last
     end
+
+    # The authorization link (card, issue, support conversation) for this query, from CONSOLE_REASON.
+    # It is shown in the audit UI, so keep it to one line of plain text: no control or format
+    # characters (newlines, bidi overrides), no markup brackets, and a bounded length.
+    def given_reason
+      ENV.fetch(REASON_ENV_KEY, "").dup.force_encoding(Encoding::UTF_8).scrub("")
+        .gsub(/[\p{Cc}\p{Cf}<>]/, " ").squish
+        .truncate(REASON_LENGTH_LIMIT, omission: "…")
+        .presence
+    end
 end

data/lib/console1984/refrigerator.rb

@@ -27,6 +27,6 @@ class Console1984::Refrigerator
 
     def external_modules_and_classes_to_freeze
       # Not using a constant because we want this to run lazily (console-dependant dependencies might not be loaded).
-      [Parser::CurrentRuby]
+      [Console1984.ruby_parser]
     end
 end

data/lib/console1984/supervisor.rb

@@ -41,13 +41,7 @@ class Console1984::Supervisor
 
   private
     def require_dependencies
-      Kernel.silence_warnings do
-        require 'parser/current'
-      end
       require 'rainbow'
-
-      # 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.

data/lib/console1984/version.rb

@@ -1,3 +1,3 @@
 module Console1984
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/console1984.rb

@@ -55,6 +55,28 @@ module Console1984
     def running_protected_environment?
       protected_environments.collect(&:to_sym).include?(Rails.env.to_sym)
     end
+
+    def require_ruby_parser_dependencies
+      if RUBY_VERSION >= "3.3"
+        require 'parser'
+        require 'prism'
+      else
+        Kernel.silence_warnings do
+          require 'parser/current'
+        end
+      end
+    end
+
+    # Returns the parser class used for parsing console commands.
+    # Uses Prism on Ruby >= 3.3 for forward-compatibility with Ruby 4.0+.
+    # Falls back to the parser gem on older Rubies.
+    def ruby_parser
+      if RUBY_VERSION >= "3.3"
+        Prism::Translation::ParserCurrent
+      else
+        Parser::CurrentRuby
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console1984
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Jorge Manrubia
@@ -310,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Your Rails console, 1984 style
 test_files: []