cql_ruby 0.0.7 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd516a07069a73fad1c48a2ca7ae536d7c52a891c882211d2de0b5d9c670fb1
-  data.tar.gz: 9ec5696402ffd46da3427c338e18b33cc7d7fecf39df135cee451a29ccee39ae
+  metadata.gz: fbbc47dff29d232d492edfe95e28eab6a4bd9710ace6332ae7e14c9487830a4a
+  data.tar.gz: 39401f85b2ed054755aa5c8497a3822d3c1b2458119d151264029cdd97b4a3ac
 SHA512:
-  metadata.gz: 9b6dbc5df16b5042e431d6682435e0f993b013c66ab70541a259b66ed487405c71c088b63f554085fb2018bd59bd0e3499931c87dcfc0d2f4bc9c8bfbabeb421
-  data.tar.gz: ff722aee7187a9b0a44cbe9ff45182fa13fe97add03a46545f7de26238993abefdb16cb85e4e4302a90cf1f7c39d8071e1d1bcb1213db382df8a6d4f505ac819
+  metadata.gz: e94c7852a7fffe0d0d3d7221caf42c20be76392188c46faf58e44aff12dea386b6202368ae911ddf7abaf894835138e99103f6f78383c9c02462845e19b6fcb0
+  data.tar.gz: 93815de02dffcb1f1b61b1574ef03a610b2e758479048c25a58b22f50d0dd5d6d3dba69316eb10f1339160da91876a9b198a5e2337adbba1d9750035f59cd4d3

data/bin/cql_ruby

@@ -1,116 +1,139 @@
-#!/usr/bin/env ruby
-
-require 'cql_ruby'
-
-def show_help
-  puts <<~HELP
-        
-    \tSYNOPSIS
-    \t\tcql_ruby options pattern path filters ...
-
-    \tDESCRIPTION
-    \t\tCQL (Code Query Language) is a semantic search tool for your Ruby source code.
-
-    \tFILTERS
-    \t\tParent node type: type:T(,T)* Example: type:def,send,arg
-    \t\tNesting under: nest:T(=NAME) Example: nest:def=save_user nest:class=UserManager
-
-    \tOPTIONS
-    \t\t-lN (N is integer) Add N surrounding line before and after.
-    \t\t-nc (--no-color) No color on output.
-    \t\t-nf (--no-file) No file names.
-    \t\t-ns (--no-source) No source code.
-    \t\t-nr (--no-recursion) Non-recursive search.
-    \t\t-v -vv -vvv Debug output levels.
-
-    \tEXAMPLES
-    \t\tcql_ruby user ./
-    \t\tcql_ruby -ns -nr %user_info ./ type:send,arg nest:block nest:class=r/User/i
-  HELP
-
-  exit
-end
-
-# @return [Hash{Symbol->Boolean}]
-def extract_options
-  options = {
-    show_color: true,
-    show_file: true,
-    show_source: true,
-    recursive_search: true,
-    surrounding_lines: 0,
-  }
-
-  ARGV.delete_if do |arg|
-    if arg[0] == '-'
-      if %w[-nc --no-color].include?(arg)
-        options[:show_color] = false
-      elsif %w[-nf --no-file].include?(arg)
-        options[:show_file] = false
-      elsif %w[-ns --no-source].include?(arg)
-        options[:show_source] = false
-      elsif %w[-h --help].include?(arg)
-        show_help
-      elsif %w[-v -vv -vvv].include?(arg)
-        lvl = arg.chars.find_all { |c| c == 'v' }.size
-        CqlRuby::Config.debug_level = lvl
-      elsif %w[-nr --no-recursive].include?(arg)
-        options[:recursive_search] = false
-      elsif arg[0..1] == '-l' && arg[2..].to_i > 0
-        options[:surrounding_lines] = arg[2..].to_i
-      else
-        raise "Unknown arg #{arg}"
-      end
-
-      true
-    else
-      false
-    end
-  end
-
-  options
-end
-
-# @return [Array]
-def extract_filters
-  ARGV.take(ARGV.size)
-end
-
-begin
-  options = extract_options
-  CqlRuby.log "Call options: #{options}" if CqlRuby::Config.debug_level_2?
-
-  raise unless ARGV.size >= 2
-
-  pattern = ARGV.shift
-  CqlRuby.log "Call pattern: <#{pattern}>" if CqlRuby::Config.debug_level_2?
-
-  # TODO Make path patterns universal.
-  path = ARGV.shift
-  CqlRuby.log "Call path: <#{path}>" if CqlRuby::Config.debug_level_2?
-
-  # Rest must be filters - can sink ARGV now.
-  filters = extract_filters
-  CqlRuby.log "Call filters: #{filters}" if CqlRuby::Config.debug_level_2?
-
-  filter_reader = CqlRuby::FilterReader.new(filters)
-
-  printer = CqlRuby::ConsolePrinter.new
-  printer.color_on = options[:show_color]
-  printer.file_on = options[:show_file]
-  printer.source_on = options[:show_source]
-  printer.surrounding_lines = options[:surrounding_lines]
-
-  collector = CqlRuby::CrumbCollector.new(printer)
-  CqlRuby::Executor.new(
-    collector: collector,
-    filter_reader: filter_reader,
-    pattern: pattern,
-    path: path,
-    filters: filters,
-    recursive: options[:recursive_search],
-  ).search_all
-rescue => e
-  puts "Error: #{e}"
-  show_help
-end
+#!/usr/bin/env ruby
+
+require 'parser'
+require 'cql_ruby'
+
+def show_help
+  puts <<~HELP
+        
+    \tSYNOPSIS
+    \t\tcql_ruby [--token] pattern path options filters ...
+    \t\tcql_ruby --node    type    path options filters ...
+
+    \tDESCRIPTION
+    \t\tCQL (Code Query Language) is a semantic search tool for your Ruby source code.
+
+    \tFILTERS
+    \t\tParent node type: type:T(,T)* Example: type:def,send,arg
+    \t\tNesting under: nest:T(=NAME) Example: nest:def=save_user nest:class=UserManager
+    \t\tHas child: has:T(=NAME) Example: has:const has:def=valid?
+    \t\tPattern: pattern:(T-)*X(-T)* Example: pattern:class-def-X-block
+
+    \tOPTIONS
+    \t\t--include=PATTERN Parses only files whose name matches the pattern.
+    \t\t--exclude=PATTERN Parses only files whose name does not match the pattern.
+    \t\t-lN (N is integer) Add N surrounding line before and after.
+    \t\t-nc (--no-color) No color on output.
+    \t\t-nf (--no-file) No file names.
+    \t\t-ns (--no-source) No source code.
+    \t\t-nr (--no-recursion) Non-recursive search.
+    \t\t-v -vv -vvv Debug output levels.
+
+    \tALLOWED NODE TYPES
+    \t\tWhen defining filters only valid AST types can be defined. They are:
+    #{Parser::Meta::NODE_TYPES.to_a.join(' ')}
+
+    \tEXAMPLES
+    \t\tcql_ruby user ./
+    \t\tcql_ruby -ns -nr %user_info ./ type:send,arg nest:block nest:class=r/User/i has:str=WARNING
+  HELP
+
+  exit
+end
+
+# @return [Hash{Symbol->Boolean}]
+def extract_options
+  options = {
+    show_color: true,
+    show_file: true,
+    show_source: true,
+    recursive_search: true,
+    surrounding_lines: 0,
+    include_pattern: nil,
+    exclude_pattern: nil,
+    search_type: :token,
+  }
+
+  ARGV.delete_if do |arg|
+    if arg[0] == '-'
+      if %w[-nc --no-color].include?(arg)
+        options[:show_color] = false
+      elsif %w[-nf --no-file].include?(arg)
+        options[:show_file] = false
+      elsif %w[-ns --no-source].include?(arg)
+        options[:show_source] = false
+      elsif %w[-h --help].include?(arg)
+        show_help
+      elsif %w[-v -vv -vvv].include?(arg)
+        lvl = arg.chars.find_all { |c| c == 'v' }.size
+        CqlRuby::Config.debug_level = lvl
+      elsif %w[-nr --no-recursive].include?(arg)
+        options[:recursive_search] = false
+      elsif arg[0..1] == '-l' && arg[2..].to_i > 0
+        options[:surrounding_lines] = arg[2..].to_i
+      elsif arg.start_with?('--include=')
+        options[:include_pattern] = arg.split('=')[1]
+      elsif arg.start_with?('--exclude=')
+        options[:exclude_pattern] = arg.split('=')[1]
+      elsif arg == '--node'
+        options[:search_type] = :node
+      elsif arg == '--token'
+        options[:search_type] = :token
+      else
+        raise "Unknown arg #{arg}"
+      end
+
+      true
+    else
+      false
+    end
+  end
+
+  options
+end
+
+# @return [Array]
+def extract_filters
+  ARGV.take(ARGV.size)
+end
+
+begin
+  options = extract_options
+  CqlRuby.log "Call options: #{options}" if CqlRuby::Config.debug_level_2?
+
+  raise unless ARGV.size >= 2
+
+  pattern = ARGV.shift
+  CqlRuby.log "Call pattern: <#{pattern}>" if CqlRuby::Config.debug_level_2?
+
+  path = ARGV.shift
+  CqlRuby.log "Call path: <#{path}>" if CqlRuby::Config.debug_level_2?
+
+  # Rest must be filters - can sink ARGV now.
+  filters = extract_filters
+  CqlRuby.log "Call filters: #{filters}" if CqlRuby::Config.debug_level_2?
+
+  filter_reader = CqlRuby::FilterReader.new(filters)
+
+  printer = CqlRuby::ConsolePrinter.new
+  printer.color_on = options[:show_color]
+  printer.file_on = options[:show_file]
+  printer.source_on = options[:show_source]
+  printer.surrounding_lines = options[:surrounding_lines]
+
+  collector = CqlRuby::CrumbCollector.new(printer)
+  CqlRuby::Executor.new(
+    collector: collector,
+    filter_reader: filter_reader,
+    pattern: pattern,
+    path: path,
+    filters: filters,
+    recursive: options[:recursive_search],
+    include: options[:include_pattern],
+    exclude: options[:exclude_pattern],
+    search_type: options[:search_type],
+  ).search_all
+rescue
+  puts "Error: #{$!}"
+  show_help
+end

data/lib/cql_ruby.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-module CqlRuby;
-  def self.log(txt)
-    p txt
-  end
-end
-
-require 'cql_ruby/executor'
-require 'cql_ruby/crumb_collector'
-require 'cql_ruby/abstract_printer'
-require 'cql_ruby/console_printer'
-require 'cql_ruby/filter_reader'
-require 'cql_ruby/filter_evaluator'
-require 'cql_ruby/pattern_matcher'
+# frozen_string_literal: true
+
+module CqlRuby;
+  def self.log(txt)
+    p txt
+  end
+end
+
+require 'cql_ruby/executor'
+require 'cql_ruby/crumb_collector'
+require 'cql_ruby/abstract_printer'
+require 'cql_ruby/console_printer'
+require 'cql_ruby/filter_reader'
+require 'cql_ruby/filter_evaluator'
+require 'cql_ruby/pattern_matcher'

data/lib/cql_ruby/abstract_printer.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-
-module CqlRuby
-  #
-  # Printing Cqlruby::Crumb-s.
-  #
-  class AbstractPrinter
-    def print(_crumb)
-      raise NotImplementedError
-    end
-  end
-end
+# frozen_string_literal: true
+
+module CqlRuby
+  #
+  # Printing CqlRuby::Crumb-s.
+  #
+  class AbstractPrinter
+    def print(_crumb)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/cql_ruby/console_printer.rb

@@ -1,97 +1,97 @@
-# frozen_string_literal: true
-
-module CqlRuby
-  #
-  # Prints to console.
-  #
-  class ConsolePrinter < ::CqlRuby::AbstractPrinter
-    attr_writer :color_on
-    attr_writer :file_on
-    attr_writer :source_on
-    attr_writer :surrounding_lines
-
-    def initialize
-      super
-
-      @color_on = true
-      @file_on = true
-      @source_on = true
-      @surrounding_lines = 0
-      @counter = 0
-    end
-
-    #
-    # @param crumb [Cqlruby::Crumb]
-    #
-    def print(crumb)
-      parts = "##{color(97)}#{@counter}#{decor_reset}"
-      parts += " #{color(94)}#{crumb.file_name}#{decor_reset}:#{color(33)}#{crumb.line_no}#{decor_reset} #{color(93)}#{crumb.type}#{decor_reset}" if @file_on
-
-      if @source_on && @surrounding_lines.positive?
-        parts_visible_len = parts.gsub(/\e\[\d+m/, '').size + 1
-        indent = ' ' * parts_visible_len
-        (-@surrounding_lines).upto(-1).each { |offs| puts "#{indent}#{crumb.surrounding_line(offs)}" }
-      end
-
-      parts += ' ' + decorate_source_line(crumb) if @source_on
-
-      puts parts
-
-      if @source_on && @surrounding_lines.positive?
-        1.upto(@surrounding_lines).each { |offs| puts "#{indent}#{crumb.surrounding_line(offs)}" }
-        puts '--'
-      end
-
-      @counter += 1
-    end
-
-    private
-
-    def color(code)
-      if @color_on
-        "\e[#{code}m"
-      else
-        ''
-      end
-    end
-
-    def bold
-      if @color_on
-        "\e[1m"
-      else
-        ''
-      end
-    end
-
-    def decor_reset
-      if @color_on
-        "\e[0m"
-      else
-        ''
-      end
-    end
-
-    # @param [Cqlruby::Crumb] crumb
-    # @return [String]
-    def decorate_source_line(crumb)
-      source = crumb.source
-      from = crumb.line_col_no
-      to = from + crumb.expression_size
-
-      prefix = source[0..from - 1] || ''
-      subject = source[from..to - 1] || ''
-      suffix = source[to..] || ''
-
-      color(97) +
-        prefix +
-        decor_reset +
-        color(31) +
-        bold +
-        subject +
-        decor_reset +
-        color(97) +
-        suffix +
-        decor_reset
-    end
-  end
-end
+# frozen_string_literal: true
+
+module CqlRuby
+  #
+  # Prints to console.
+  #
+  class ConsolePrinter < ::CqlRuby::AbstractPrinter
+    attr_writer :color_on
+    attr_writer :file_on
+    attr_writer :source_on
+    attr_writer :surrounding_lines
+
+    def initialize
+      super
+
+      @color_on = true
+      @file_on = true
+      @source_on = true
+      @surrounding_lines = 0
+      @counter = 0
+    end
+
+    #
+    # @param crumb [CqlRuby::Crumb]
+    #
+    def print(crumb)
+      parts = "##{color(97)}#{@counter}#{decor_reset}"
+      parts += " #{color(94)}#{crumb.file_name}#{decor_reset}:#{color(33)}#{crumb.line_no}#{decor_reset} #{color(93)}#{crumb.type}#{decor_reset}" if @file_on
+
+      if @source_on && @surrounding_lines.positive?
+        parts_visible_len = parts.gsub(/\e\[\d+m/, '').size + 1
+        indent = ' ' * parts_visible_len
+        (-@surrounding_lines).upto(-1).each { |offs| puts "#{indent}#{crumb.surrounding_line(offs)}" }
+      end
+
+      parts += ' ' + decorate_source_line(crumb) if @source_on
+
+      puts parts
+
+      if @source_on && @surrounding_lines.positive?
+        1.upto(@surrounding_lines).each { |offs| puts "#{indent}#{crumb.surrounding_line(offs)}" }
+        puts '--'
+      end
+
+      @counter += 1
+    end
+
+    private
+
+    def color(code)
+      if @color_on
+        "\e[#{code}m"
+      else
+        ''
+      end
+    end
+
+    def bold
+      if @color_on
+        "\e[1m"
+      else
+        ''
+      end
+    end
+
+    def decor_reset
+      if @color_on
+        "\e[0m"
+      else
+        ''
+      end
+    end
+
+    # @param [CqlRuby::Crumb] crumb
+    # @return [String]
+    def decorate_source_line(crumb)
+      source = crumb.source
+      from = crumb.line_col_no
+      to = from + crumb.expression_size
+
+      prefix = source[0..from - 1] || ''
+      subject = source[from..to - 1] || ''
+      suffix = source[to..] || ''
+
+      color(97) +
+        prefix +
+        decor_reset +
+        color(31) +
+        bold +
+        subject +
+        decor_reset +
+        color(97) +
+        suffix +
+        decor_reset
+    end
+  end
+end