ffast 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce52e9ab5a9d9da32683b21584af707cf5c87e460f3bd74297e9038ea38c5494
-  data.tar.gz: 2b68a433982c97f278829b95234aed4ea5e4aec19264f15f9bfbe8615da19c9a
+  metadata.gz: da30bc7abc983e2ac54c1c4d1f454878d75dce0dd285a0e245d6ed54d73e4040
+  data.tar.gz: f286ce93d5ce2970d1c3a528d423bf8b8ed9239140f798f895a67e0aa1b8e2d2
 SHA512:
-  metadata.gz: 246e52812d6f332636363e9f8dd960fa5e5ad3ecc50666007ae62041a212efc0e17f79dc01a675e15cd862f04bcc6771ac2ede3c8fd98c656b0efe7f34b67ffc
-  data.tar.gz: 641af33dbc8858631ae458bc53a4c1b7ce08c44da6788d0cdf7c8c3cae571a9bcb20630f3f9527aeea9a6023a920ac8fe8b0df83672b8280ab8415977114ff4b
+  metadata.gz: 83c218849cd4a9184b34f9d760d537cae650fe8a96428aa83fdeff12ed6afc57129fff3ce4a0c6d6924225e178f80c114afb021e19ca41bc2677c85b0668ee99
+  data.tar.gz: 6d4499e8a11398c3f9bc8a04adcd5efd65ef1b385c9bc37370edc31f9375b8d844e8ed61981e33831b2b83961edd4245059a38167c2f7a5ffbc52dd49acb9fff

data/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - 'v*' # Triggers when a new tag like v0.2.0 is pushed
+
+jobs:
+  release:
+    name: Build and Release
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read     # Required to checkout the code
+      id-token: write    # Required for RubyGems Trusted Publishing
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@v1

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -5,8 +5,10 @@
 /coverage/
 /doc/
 /pkg/
+/site/
 /spec/reports/
 /tmp/
+.venv/
 
 # rspec failure tracking
 .rspec_status

data/Fastfile

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
+begin
+  require 'fast/source'
+rescue LoadError
+  nil
+end
+
 # Fastfile is loaded when you start an expression with a dot.
 #
 # You can introduce shortcuts or methods that can be embedded during your
@@ -18,9 +24,11 @@ Fast.shortcut(:finders, '(class ... (const nil Find)', 'lib')
 
 # Simple shortcut that I used often to show how the expression parser works
 Fast.shortcut(:parser, '(class (const nil ExpressionParser)', 'lib/fast.rb')
+Fast.shortcut(:sql_parser, '(def parse', 'lib/fast/sql.rb')
 
 # Use `fast .bump_version` to rewrite the version file
 Fast.shortcut :bump_version do
+  new_version = nil
   rewrite_file('(casgn nil VERSION (str _)', version_file) do |node|
     target = node.children.last.loc.expression
     pieces = target.source.split('.').map(&:to_i)
@@ -32,7 +40,24 @@ Fast.shortcut :bump_version do
         pieces[-(i + 1)] = 0
       end
     end
-    replace(target, "'#{pieces.join('.')}'")
+    new_version = pieces.join('.')
+    replace(target, "'#{new_version}'")
+  end
+
+  print "Commit bumped version v#{new_version}? (y/n) "
+  if $stdin.gets.chomp.downcase == 'y'
+    system("git add #{version_file} && git commit -m 'Bump version to v#{new_version}'")
+
+    print "Tag version v#{new_version}? (y/n) "
+    if $stdin.gets.chomp.downcase == 'y'
+      system("git tag v#{new_version}")
+
+      print "Push commit and tag to origin? (y/n) "
+      if $stdin.gets.chomp.downcase == 'y'
+        system("git push origin HEAD")
+        system("git push origin v#{new_version}")
+      end
+    end
   end
 end
 
@@ -57,22 +82,9 @@ Fast.shortcut :intro do
   Fast.shortcuts[:walk].run
 end
 
-# Useful for `fast .walk file.md` but not required by the library.
-private
-def require_or_install_tty_md
-  require 'tty-markdown'
-rescue LoadError
-  puts 'Installing tty-markdown gem to better engage you :)'
-  Gem.install('tty-markdown')
-  puts 'Done! Now, back to our topic \o/'
-  system('clear')
-  retry
-end
-
 # Interactive command line walkthrough
 # fast .walk docs/walkthrough.md
 Fast.shortcut :walk do
-  require_or_install_tty_md
   file = ARGV.last
   execute = ->(line) { system(line) }
   walk = ->(line) { line.each_char { |c| sleep(0.02) and print(c) } }
@@ -87,7 +99,82 @@ Fast.shortcut :walk do
     when /^!{3}\s/
       # Skip warnings that are only for web tutorials
     else
-      walk[TTY::Markdown.parse(line)]
+      walk[Fast.render_markdown_for_terminal(line)]
     end
   end
 end
+
+# Format SQL
+Fast.shortcut :format_sql do
+  require 'fast/sql'
+  file = ARGV.last
+  method = File.exist?(file) ? :parse_sql_file : :parse_sql
+  ast = Fast.public_send(method, file)
+  ast = ast.first if ast.is_a? Array
+  eligible_kw = [:RESERVED_KEYWORD]
+  eligible_tokens = [:BY]
+
+  output = Fast::SQL.replace('_', ast) do |root|
+    sb = root.loc.expression.source_buffer
+    sb.tokens.each do |token|
+      if eligible_kw.include?(token.keyword_kind) || eligible_tokens.include?(token.token)
+        range = Fast::Source.range(sb, token.start, token.end)
+        replace(range, range.source.upcase)
+      end
+    end
+  end
+  require 'fast/cli'
+  puts Fast.highlight(output, sql: true)
+end
+
+# Anonymize SQL
+# fast .anonymize_sql file.sql
+Fast.shortcut :anonymize_sql do
+  require 'fast/sql'
+  file = ARGV.last
+  method = File.exist?(file) ? :parse_sql_file : :parse_sql
+  ast = Fast.public_send(method, file)
+  memo = {}
+
+  relnames = search("(relname $_)", ast).grep(String).uniq
+  pattern = "{relname (sval {#{relnames.map(&:inspect).join(' ')}})}"
+  puts "searching with #{pattern}"
+
+  content = Fast::SQL.replace(pattern, ast) do |node|
+    new_name = memo[node.source.tr(%|"'|, '')] ||= "x#{memo.size}"
+    new_name = "'#{new_name}'" if node.type == :sval
+    replace(node.loc.expression, new_name)
+  end
+  puts Fast.highlight(content, sql: true)
+end
+
+# Give all details in a shorter format
+# fast .summary file.rb
+Fast.shortcut :summary do
+  file = ARGV.reverse.find { |arg| !arg.start_with?('-') && File.exist?(arg) }
+  if file && File.exist?(file)
+    Fast.summary(IO.read(file), file: file, level: fast_option_value(ARGV, '-l', '--level')).summarize
+  else
+    puts "Please provide a valid file to summarize."
+  end
+end
+
+# Group and classify multiple Ruby files without printing full bodies
+# fast .scan lib app/models --no-color
+Fast.shortcut :scan do
+  locations = ARGV.select { |arg| !arg.start_with?('-') && File.exist?(arg) }
+  if locations.any?
+    Fast.scan(locations, level: fast_option_value(ARGV, '-l', '--level')).scan
+  else
+    puts "Please provide at least one valid file or directory to scan."
+  end
+end
+
+def fast_option_value(args, short_name, long_name)
+  args.each_with_index do |arg, index|
+    return args[index + 1] if arg == short_name || arg == long_name
+    return arg.split('=', 2).last if arg.start_with?("#{long_name}=")
+  end
+
+  nil
+end

data/README.md

@@ -12,6 +12,20 @@ the code was written without an AST.
 
 Check out the official documentation: https://jonatas.github.io/fast.
 
+## Documentation locally
+
+The documentation site is built with MkDocs Material and a few Markdown
+extensions. To run it locally:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+python3 -m pip install -r requirements-docs.txt
+mkdocs serve
+```
+
+Then open `http://127.0.0.1:8000`.
+
 ## Token Syntax for `find` in AST
 
 The current version of Fast covers the following token elements:
@@ -57,18 +71,18 @@ For example, let's take an `Integer` in Ruby:
 1
 ```
 
-It's corresponding s-expression would be:
+Its corresponding s-expression would be:
 
 ```ruby
 s(:int, 1)
 ```
 
-`s` in `Fast` and `Parser` are a shorthand for creating an `Parser::AST::Node`.
+`s` in `Fast` is a shorthand for creating a `Fast::Node`.
 Each of these nodes has a `#type` and `#children` contained in it:
 
 ```ruby
 def s(type, *children)
-  Parser::AST::Node.new(type, children)
+  Fast::Node.new(type, children: children)
 end
 ```
 
@@ -198,7 +212,7 @@ def my_method
 end
 ```
 
-It's corresponding s-expression would be:
+Its corresponding s-expression would be:
 
 ```ruby
 ast =
@@ -372,7 +386,7 @@ ast = Fast.ast("def name; person.name end")
 Generally, we  use the `location.expression`:
 
 ```ruby
-ast.location.expression # => #<Parser::Source::Range (string) 0...25>
+ast.location.expression # => #<Fast::Source::Range (string) 0...25>
 ```
 
 But location also brings some metadata about specific fragments:
@@ -383,7 +397,7 @@ ast.location.instance_variables # => [:@keyword, :@operator, :@name, :@end, :@ex
 
 Range for the keyword that identifies the method definition:
 ```ruby
-ast.location.keyword # => #<Parser::Source::Range (string) 0...3>
+ast.location.keyword # => #<Fast::Source::Range (string) 0...3>
 ```
 
 You can always pick the source of a source range:
@@ -395,7 +409,7 @@ ast.location.keyword.source # => "def"
 Or only the method name:
 
 ```ruby
-ast.location.name # => #<Parser::Source::Range (string) 4...8>
+ast.location.name # => #<Fast::Source::Range (string) 4...8>
 ast.location.name.source # => "name"
 ```
 

data/bin/console

@@ -6,7 +6,7 @@ require 'fast'
 require 'fast/sql'
 
 def s(type, *children)
-  Parser::AST::Node.new(type, children)
+  Fast::Node.new(type, children: children)
 end
 
 def code(string)

data/bin/fast-experiment

@@ -8,6 +8,7 @@ require 'fast/experiment'
 require 'coderay'
 
 arguments = ARGV
+autoclean = arguments.delete('--autoclean')
 
 experiment_files = Fast.ruby_files_from(File.expand_path('../experiments', __dir__))
 experiment_files.each(&method(:require))
@@ -23,6 +24,7 @@ end
 if arguments.any?
   ruby_files = arguments.all? { |e| File.exist?(e) && e.end_with?('.rb') }
   experiments.each do |experiment|
+    experiment.autoclean = autoclean
     if ruby_files
       experiment.files = arguments
     else
@@ -30,4 +32,5 @@ if arguments.any?
     end
   end
 end
+experiments.each { |experiment| experiment.autoclean = autoclean }
 experiments.each(&:run)

data/bin/fast-mcp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'fast/mcp_server'
+
+Fast::McpServer.run!

data/fast.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|docs\/(assets|stylesheets))/})
+    f.match(%r{^(test|spec|experiments|examples|features|docs|assets|stylesheets|site)/})
   end
 
   spec.post_install_message = <<~THANKS
@@ -42,10 +42,8 @@ Gem::Specification.new do |spec|
   spec.executables   = %w[fast fast-experiment]
   spec.require_paths = %w[lib experiments]
 
-  spec.add_dependency 'astrolabe'
   spec.add_dependency 'coderay'
   spec.add_dependency 'parallel'
-  spec.add_dependency 'parser'
   spec.add_dependency 'pg_query'
 
   spec.add_development_dependency 'bundler'

data/lib/fast/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'fast'
+require 'fast/source'
 require 'fast/version'
 require 'fast/sql'
 require 'coderay'
@@ -17,12 +18,21 @@ module Fast
   # Useful for printing code with syntax highlight.
   # @param show_sexp [Boolean] prints node expression instead of code
   # @param colorize [Boolean] skips `CodeRay` processing when false.
-  def highlight(node, show_sexp: false, colorize: true, sql: false)
-    output =
-      if node.respond_to?(:loc) && !show_sexp
-        wrap_source_range(node).source
-      else
-        node
+  # @param level [Integer] defines the max depth to print the AST.
+  def highlight(node, show_sexp: false, colorize: true, sql: false, level: nil)
+      output =
+        if node.respond_to?(:loc) && !show_sexp
+          if level
+            Fast.fold_source(node, level: level)
+          else
+            wrap_source_range(node).source
+          end
+        elsif show_sexp && level && Fast.ast_node?(node)
+          Fast.fold_ast(node, level: level).to_s
+        elsif show_sexp
+          node.to_s
+        else
+          node
       end
     return output unless colorize
 
@@ -33,7 +43,7 @@ module Fast
   # and fixes end of the expression including heredoc strings.
   def wrap_source_range(node)
     expression = node.loc.expression
-    Parser::Source::Range.new(
+    Fast::Source.range(
       expression.source_buffer,
       first_position_from_expression(node),
       last_position_from_expression(node) || expression.end_pos
@@ -50,7 +60,7 @@ module Fast
   # to show the proper whitespaces for identing the next lines of the code.
   def first_position_from_expression(node)
     expression = node.loc.expression
-    if node.parent && node.parent.loc.expression.line != expression.line
+    if node.respond_to?(:parent) && node.parent && node.parent.loc.expression.line != expression.line
       expression.begin_pos - expression.column
     else
       expression.begin_pos
@@ -59,15 +69,16 @@ module Fast
 
   # Combines {.highlight} with files printing file name in the head with the
   # source line.
-  # @param result [Astrolabe::Node]
+  # @param result [Fast::Node]
   # @param show_sexp [Boolean] Show string expression instead of source
   # @param file [String] Show the file name and result line before content
   # @param headless [Boolean] Skip printing the file name and line before content
+  # @param level [Integer] Skip exploring deep branches of AST when showing sexp
   # @example
   #   Fast.report(result, file: 'file.rb')
-  def report(result, show_link: false, show_permalink: false, show_sexp: false, file: nil, headless: false, bodyless: false, colorize: true) # rubocop:disable Metrics/ParameterLists
+  def report(result, show_link: false, show_permalink: false, show_sexp: false, file: nil, headless: false, bodyless: false, colorize: true, level: nil) # rubocop:disable Metrics/ParameterLists
     if file
-      line = result.loc.expression.line if result.is_a?(Parser::AST::Node)
+      line = result.loc.expression.line if Fast.ast_node?(result) && result.respond_to?(:loc)
       if show_link
         puts(result.link)
       elsif show_permalink
@@ -76,23 +87,20 @@ module Fast
         puts(highlight("# #{file}:#{line}", colorize: colorize))
       end
     end
-    puts(highlight(result, show_sexp: show_sexp, colorize: colorize)) unless bodyless
+    puts(highlight(result, show_sexp: show_sexp, colorize: colorize, level: level)) unless bodyless
   end
 
   # Command Line Interface for Fast
   class Cli # rubocop:disable Metrics/ClassLength
-    attr_reader :pattern, :show_sexp, :pry, :from_code, :similar, :help
+    attr_reader :pattern, :show_sexp, :pry, :from_code, :similar, :help, :level
     def initialize(args)
-      args = replace_args_with_shortcut(args) if args.first&.start_with?('.')
-
-      @pattern, *@files = args.reject { |arg| arg.start_with? '-' }
+      args = args.dup
+      args = replace_args_with_shortcut(args) if shortcut_name_from(args)
       @colorize = STDOUT.isatty
-
       option_parser.parse! args
+      @pattern, @files = extract_pattern_and_files(args)
 
-      @files = [*@files].reject { |arg| arg.start_with?('-') }
       @sql ||= @files.any? && @files.all? { |file| file.end_with?('.sql') }
-
       require 'fast/sql' if @sql
     end
 
@@ -103,6 +111,10 @@ module Fast
           @debug = true
         end
 
+        opts.on('-l', '--level LEVELS', 'Maximum depth to print the AST') do |level|
+          @level = level.to_i
+        end
+
         opts.on('--ast', 'Print AST instead of code') do
           @show_sexp = true
         end
@@ -166,13 +178,14 @@ module Fast
     end
 
     def replace_args_with_shortcut(args)
-      shortcut = find_shortcut args.first[1..]
+      shortcut_name = shortcut_name_from(args)
+      shortcut = find_shortcut(shortcut_name)
 
       if shortcut.single_run_with_block?
         shortcut.run
         exit
       else
-        args.one? ? shortcut.args : shortcut.merge_args(args[1..])
+        shortcut.args
       end
     end
 
@@ -206,7 +219,7 @@ module Fast
 
       if @files.empty?
         ast ||= Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
-        puts Fast.highlight(ast, show_sexp: @show_sexp, colorize: @colorize, sql: @sql)
+        puts Fast.highlight(ast, show_sexp: @show_sexp, colorize: @colorize, sql: @sql, level: @level)
       else
         search
       end
@@ -272,20 +285,39 @@ module Fast
                   show_sexp: @show_sexp,
                   headless: @headless,
                   bodyless: @bodyless,
-                  colorize: @colorize)
+                  colorize: @colorize,
+                  level: @level)
+    end
+
+    def shortcut_name_from(args)
+      command = args.find { |arg| !arg.start_with?('-') }
+      return unless command&.start_with?('.')
+
+      command[1..]
+    end
+
+    def extract_pattern_and_files(args)
+      return [nil, []] if args.empty?
+
+      files_start = args.index { |arg| File.exist?(arg) || File.directory?(arg) }
+      if files_start
+        [args[0...files_start].join(' '), args[files_start..]]
+      else
+        [args.join(' '), []]
+      end
     end
 
     # Find shortcut by name. Preloads all `Fastfiles` before start.
     # @param name [String]
-    # @return [Fast::Shortcut]
     def find_shortcut(name)
       unless defined? Fast::Shortcut
         require 'fast/shortcut'
         Fast.load_fast_files!
       end
 
-      shortcut = Fast.shortcuts[name] || Fast.shortcuts[name.to_sym]
-      shortcut || exit_shortcut_not_found(name)
+      shortcut = Fast.shortcuts[name.to_sym]
+      exit_shortcut_not_found(name) unless shortcut
+      shortcut
     end
 
     # Exit process with warning message bolding the shortcut that was not found.

data/lib/fast/experiment.rb

@@ -91,6 +91,7 @@ module Fast
   class Experiment
     attr_writer :files
     attr_reader :name, :replacement, :expression, :files_or_folders, :ok_if
+    attr_accessor :autoclean
 
     def initialize(name, &block)
       @name = name
@@ -137,6 +138,10 @@ module Fast
     def run
       files.map(&method(:run_with))
     end
+
+    def autoclean?
+      !!@autoclean
+    end
   end
 
   # Suggest possible combinations of occurrences to replace.
@@ -285,7 +290,7 @@ module Fast
       @fail_experiments << combination
     end
 
-    # @return [Array<Astrolabe::Node>]
+    # @return [Array<Fast::Node>]
     def search_cases
       Fast.search(experiment.expression, @ast) || []
     end
@@ -323,15 +328,25 @@ module Fast
       filename
     end
 
+    def cleanup_generated_files!
+      Dir.glob(File.join(File.dirname(@file), "experiment_*_#{File.basename(@file)}")).each do |generated_file|
+        File.delete(generated_file) if File.exist?(generated_file)
+      end
+    end
+
     def done!
       count_executed_combinations = @fail_experiments.size + @ok_experiments.size
       puts "Done with #{@file} after #{count_executed_combinations} combinations"
-      return unless perfect_combination = @ok_experiments.last # rubocop:disable Lint/AssignmentInCondition
+      unless perfect_combination = @ok_experiments.last # rubocop:disable Lint/AssignmentInCondition
+        cleanup_generated_files! if experiment.autoclean?
+        return
+      end
 
       puts 'The following changes were applied to the file:'
       `diff #{experimental_filename(perfect_combination)} #{@file}`
       puts "mv #{experimental_filename(perfect_combination)} #{@file}"
       `mv #{experimental_filename(perfect_combination)} #{@file}`
+      cleanup_generated_files! if experiment.autoclean?
     end
 
     # Increase the `@round` by 1 to {ExperimentCombinations#generate_combinations}.
@@ -346,6 +361,7 @@ module Fast
     end
 
     def run
+      cleanup_generated_files! if experiment.autoclean?
       while (combinations = build_combinations).any?
         if combinations.size > 1000
           puts "Ignoring #{@file} because it has #{combinations.size} possible combinations"
@@ -378,6 +394,7 @@ module Fast
       else
         failed_with(combination)
         puts "🔴 #{experimental_file} - Combination: #{combination}"
+        File.delete(experimental_file) if experiment.autoclean? && File.exist?(experimental_file)
       end
     end
   end

data/lib/fast/git.rb

@@ -8,7 +8,7 @@ module Fast
   #  @example
   #    require 'fast/git'
   #    Fast.ast_from_file('lib/fast.rb').git_log.first.author.name # => "Jonatas Davi Paganini"
-  class Node < Astrolabe::Node
+  class Node
     # @return [Git::Base] from current directory
     def git
       require 'git' unless defined? Git