cql_ruby 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958c076c71b8288666a536478ac62399953865f9d9f829be68252bce88eb7625
-  data.tar.gz: c4c6514cbef0488606b863654c2ad08471b75cd5b3dd2a0a9bb410e2a85a6551
+  metadata.gz: 4e459067630e91a0d52a1839445f881647e9c0271c052d973ccfafd6040f21b6
+  data.tar.gz: 39379431fb2d817930aff070a8335c02b62822d6bba0129956f6691cb5ea99b8
 SHA512:
-  metadata.gz: 1cacdb6eb09004a14f2f5bcd4542a5a6935cf03ec95aaf3fbbcd9e61a6047f9f102a17e70575758fce2a15b57167260fc706176f92a0476f3a3185609f21320a
-  data.tar.gz: 662ee75e93906a67bacda9cfdd8b992a59f2cc695e39bc1abb7bcc931b47cb1c51585f9d7fa6385043455b7cdc74fc512fb9895f70d1ebd4013997b192b53092
+  metadata.gz: 1de5455822e96348fad5fbda540e66ebf830723a4579927f8d4b1a2a9a4c9dd1c6d4763a514674eebff6974c8d61958e53af9fae74397fd643bb8a036f0a725d
+  data.tar.gz: 94c05fd4d565b1db7e793137495bd97456b1e459f9a58c6faba8c008c772a4898929ce5dc02d4064dec2ef0ee2ef0a7a2b68a2f9915430c681aca2a1a2bbb6f9

data/bin/cql_ruby

@@ -1,26 +1,39 @@
 #!/usr/bin/env ruby
 
+require 'parser'
 require 'cql_ruby'
 
 def show_help
   puts <<~HELP
         
     \tSYNOPSIS
-    \tcql_ruby options pattern path filters ...
+    \t\tcql_ruby options pattern path filters ...
 
     \tDESCRIPTION
-    \tCQL (Code Query Language) is a semantic search tool for your Ruby source code.
+    \t\tCQL (Code Query Language) is a semantic search tool for your Ruby source code.
 
     \tFILTERS
-    \t\tParent node type: type:T(,T)*
+    \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?
 
     \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
-    \tcql_ruby -ns update_user_info ./ type:send,arg
+    \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
@@ -32,6 +45,10 @@ def extract_options
     show_color: true,
     show_file: true,
     show_source: true,
+    recursive_search: true,
+    surrounding_lines: 0,
+    include_pattern: nil,
+    exclude_pattern: nil,
   }
 
   ARGV.delete_if do |arg|
@@ -42,8 +59,19 @@ def extract_options
         options[:show_file] = false
       elsif %w[-ns --no-source].include?(arg)
         options[:show_source] = false
-      elsif %w[-h --help]
+      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]
       else
         raise "Unknown arg #{arg}"
       end
@@ -64,24 +92,39 @@ end
 
 begin
   options = extract_options
+  CqlRuby.log "Call options: #{options}" if CqlRuby::Config.debug_level_2?
 
   raise unless ARGV.size >= 2
 
   pattern = ARGV.shift
-  # TODO Make path patterns universal.
+  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, filter_reader, pattern, path, filters).search_all
+  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_all
 rescue => e
   puts "Error: #{e}"
   show_help

data/lib/cql_ruby.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-module CqlRuby; end
+module CqlRuby;
+  def self.log(txt)
+    p txt
+  end
+end
 
 require 'cql_ruby/executor'
 require 'cql_ruby/crumb_collector'

data/lib/cql_ruby/console_printer.rb

@@ -8,6 +8,7 @@ module CqlRuby
     attr_writer :color_on
     attr_writer :file_on
     attr_writer :source_on
+    attr_writer :surrounding_lines
 
     def initialize
       super
@@ -15,14 +16,33 @@ module CqlRuby
       @color_on = true
       @file_on = true
       @source_on = true
+      @surrounding_lines = 0
+      @counter = 0
     end
 
     #
     # @param crumb [Cqlruby::Crumb]
     #
     def print(crumb)
-      puts "#{color(94)}#{crumb.file_name}#{decor_reset}:#{color(33)}#{crumb.line_no}#{decor_reset} #{color(93)}#{crumb.type}#{decor_reset}" if @file_on
-      puts decorate_source_line(crumb) if @source_on
+      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
@@ -54,7 +74,6 @@ module CqlRuby
     # @param [Cqlruby::Crumb] crumb
     # @return [String]
     def decorate_source_line(crumb)
-      # TODO add +- line surrounding options
       source = crumb.source
       from = crumb.line_col_no
       to = from + crumb.expression_size
@@ -63,14 +82,14 @@ module CqlRuby
       subject = source[from..to - 1] || ''
       suffix = source[to..] || ''
 
-      color(90) +
+      color(97) +
         prefix +
         decor_reset +
         color(31) +
         bold +
         subject +
         decor_reset +
-        color(90) +
+        color(97) +
         suffix +
         decor_reset
     end

data/lib/cql_ruby/executor.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 
 require 'parser/current'
+require 'pathname'
+
+module CqlRuby
+  class Config
+    @@debug_level = 0
+
+    class << self
+      def debug_level=(lvl); @@debug_level = lvl; end
+      def debug_level; @@debug_level; end
+      def debug_level_1?; @@debug_level >= 1; end
+      def debug_level_2?; @@debug_level >= 2; end
+      def debug_level_3?; @@debug_level >= 3; end
+    end
+  end
+end
 
 #
 # Executes search and dumps results into the collector.
@@ -10,43 +25,85 @@ require 'parser/current'
 # @param path [String]
 # @param filters [Array<String>]
 #
-CqlRuby::Executor = Struct.new(:collector, :filter_reader, :pattern, :path, :filters) do
-  def search_all
-    files.flat_map do |file|
-      search(file)
+module CqlRuby
+  class Executor
+    def initialize(
+      collector:,
+      filter_reader:,
+      pattern:,
+      path:,
+      filters: [],
+      recursive: true,
+      include: nil,
+      exclude: nil
+    )
+      @collector = collector
+      @filter_reader = filter_reader
+      @pattern = pattern
+      @path = path
+      @filters = filters
+      @recursive = recursive
+      @include = include
+      @exclude = exclude
     end
-  end
 
-  private
+    def search_all
+      files.flat_map do |file|
+        next if !@exclude.nil? && CqlRuby::PatternMatcher.match?(@exclude, file)
+        next unless @include.nil? || CqlRuby::PatternMatcher.match?(@include, file)
 
-  def search(file)
-    ast = Parser::CurrentRuby.parse(File.read(file))
-    source_reader = CqlRuby::SourceReader.new(file)
-    walk(ast, [], source_reader)
+        CqlRuby.log "File check: #{file}" if CqlRuby::Config.debug_level_3?
+        search(file)
+      end
+    end
 
-    nil
-  end
+    private
 
-  def walk(node, ancestors, source_reader)
-    if node.is_a?(Parser::AST::Node)
-      node.children.flat_map do |child|
-        walk(child, ancestors.dup + [node], source_reader)
-      end
-    else
-      if match?(node) && CqlRuby::FilterEvaluator.pass?(filter_reader, node, ancestors)
-        collector.add(CqlRuby::Crumb.new(node, ancestors, source_reader))
+    def search(file)
+      ast = Parser::CurrentRuby.parse(File.read(file))
+      source_reader = CqlRuby::SourceReader.new(file)
+      walk(ast, [], source_reader)
+
+      nil
+    rescue => e
+      CqlRuby.log "File #{file} cannot be parsed"
+      CqlRuby.log "Reason: #{e}" if CqlRuby::Config.debug_level_1?
+    end
+
+    def walk(node, ancestors, source_reader)
+      if node.is_a?(Parser::AST::Node)
+        node.children.flat_map do |child|
+          walk(child, ancestors.dup + [node], source_reader)
+        end
+      else
+        if match?(node) && CqlRuby::FilterEvaluator.pass?(filter_reader, node, ancestors)
+          collector.add(CqlRuby::Crumb.new(node, ancestors, source_reader))
+        end
       end
+
+      nil
     end
 
-    nil
-  end
+    def match?(target)
+      CqlRuby::PatternMatcher.match?(pattern, target)
+    end
 
-  def match?(target)
-    CqlRuby::PatternMatcher.match?(pattern, target)
-  end
+    def files
+      return [path] if File.file?(path)
+
+      clean_path = Pathname(path).cleanpath.to_s
+      clean_path += '/**' if recursive
+      clean_path += '/*.rb'
 
-  def files
-    Dir.glob(path)
+      Dir.glob(clean_path)
+    end
+
+    attr_reader :collector
+    attr_reader :filter_reader
+    attr_reader :pattern
+    attr_reader :path
+    attr_reader :filters
+    attr_reader :recursive
   end
 end
 
@@ -63,6 +120,10 @@ CqlRuby::Crumb = Struct.new(:full_name, :ancestors, :source_reader) do
     source_reader.source_line(line_no)
   end
 
+  def surrounding_line(offset)
+    source_reader.source_line(line_no + offset)
+  end
+
   def file_name
     source_reader.file
   end
@@ -82,6 +143,8 @@ CqlRuby::SourceReader = Struct.new(:file) do
   end
 
   def source_line(n)
+    return nil unless lines.size >= n
+
     lines[n - 1].chop
   end
 

data/lib/cql_ruby/filter_evaluator.rb

@@ -7,6 +7,7 @@ module CqlRuby
         [
           pass_type?(filter_reader, ancestors),
           pass_nesting?(filter_reader, ancestors),
+          pass_has?(filter_reader, node, ancestors),
         ].all?
       end
 
@@ -25,7 +26,7 @@ module CqlRuby
       end
 
       #
-      # @param [Cqlruby::FilterReader] filter_reader
+      # @param [CqlRuby::FilterReader] filter_reader
       # @param [Array<Parser::AST::Node>] ancestors
       #
       # @return [Boolean]
@@ -49,6 +50,79 @@ module CqlRuby
           end
         end
       end
+
+      #
+      # @param [CqlRuby::FilterReader] filter_reader
+      # @param [Parser::AST::Node] node
+      # @param [Array<Parser::AST::Node>] ancestors
+      #
+      def pass_has?(filter_reader, node, ancestors)
+        return true unless filter_reader.restrict_children?
+
+        filter_reader.has_leaves.all? do |has_rule|
+          anchor_node = try_get_class(ancestors) || try_get_module(ancestors) || try_get_def(ancestors)
+          next false unless anchor_node
+
+          has_node_with_name?(anchor_node, has_rule)
+        end
+      end
+
+      #
+      # @param [Array<Parser::AST::Node>] ancestors
+      #
+      def try_get_class(ancestors)
+        return nil unless ancestors.size >= 2
+        return nil unless ancestors[-1].type == :const
+        return nil unless ancestors[-2].type == :class
+
+        ancestors[-2].children[2]
+      end
+
+      #
+      # @param [Array<Parser::AST::Node>] ancestors
+      #
+      def try_get_module(ancestors)
+        return nil unless ancestors.size >= 2
+        return nil unless ancestors[-1].type == :const
+        return nil unless ancestors[-2].type == :module
+
+        ancestors[-2].children[1]
+      end
+
+      #
+      # @param [Array<Parser::AST::Node>] ancestors
+      #
+      def try_get_def(ancestors)
+        return nil unless ancestors.size >= 1
+        return nil unless ancestors[-1].type == :def
+
+        ancestors[-1].children[2]
+      end
+
+      #
+      # @param [Parser::AST::Node] anchor_node
+      # @param [CqlRuby::NodeSpec]
+      #
+      def has_node_with_name?(anchor_node, has_rule)
+        return false unless anchor_node.is_a?(Parser::AST::Node)
+
+        fn_children_with_type = ->(node) { node.children.map { |child| [child, node.type] } }
+        to_visit = fn_children_with_type.call(anchor_node)
+
+        until to_visit.empty?
+          current_node, current_type = to_visit.shift
+
+          if current_node.is_a?(Parser::AST::Node)
+            to_visit += fn_children_with_type.call(current_node)
+          else
+            if current_type == has_rule.type.to_sym && CqlRuby::PatternMatcher.match?(has_rule.name, current_node)
+              return true
+            end
+          end
+        end
+
+        false
+      end
     end
   end
 end

data/lib/cql_ruby/filter_reader.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# TODO: Have convenience filters for type:_ such as: isclass, ismodule, isdef ...
+
 module CqlRuby
-  class NestRule < Struct.new(:type, :name)
+  class NodeSpec < Struct.new(:type, :name)
+    # Make this non duplicated.
     NAME_ANY = '*'
-    ALLOWED_TYPE = %w[class module def block].freeze
 
     class << self
       #
@@ -15,8 +17,7 @@ module CqlRuby
         type, name = raw_value.split('=')
         name ||= NAME_ANY
 
-        raise "Unknown type: #{type}. Allowed: #{ALLOWED_TYPE}" unless ALLOWED_TYPE.include?(type)
-        raise "Type #{type} cannot have a name." if %w[block].include?(type) && name != NAME_ANY
+        raise "Type '#{type}' is not recognized. See 'cql_ruby --help' for allowed types." unless Parser::Meta::NODE_TYPES.member?(type.to_sym)
 
         new(type, name)
       end
@@ -38,16 +39,21 @@ module CqlRuby
   # example: type:def,send
   #
   class FilterReader
-    # @attribute [Parser::AST::Node] allowed_types
+    NESTING_ALLOWED_TYPES = %w[class module def block].freeze
+
+    # @attribute [Array<Symbol>] allowed_types
     attr_reader :allowed_types
-    # @attribute [Array<Cqlruby::NestRule>] nest_under
+    # @attribute [Array<CqlRuby::NodeSpec>] nest_under
     attr_reader :nest_under
+    # @attribute [Array<CqlRuby::NodeSpec>] has_leaves
+    attr_reader :has_leaves
 
     def initialize(raw_filters)
       super()
 
       @allowed_types = []
       @nest_under = []
+      @has_leaves = []
 
       parse_raw_filters(raw_filters)
     end
@@ -60,6 +66,10 @@ module CqlRuby
       !@nest_under.empty?
     end
 
+    def restrict_children?
+      !@has_leaves.empty?
+    end
+
     private
 
     # @param [Array<String>] raw_filters
@@ -71,7 +81,13 @@ module CqlRuby
         if %w[type t].include?(name)
           @allowed_types += value.split(',').map(&:to_sym)
         elsif %w[nest n].include?(name)
-          @nest_under << NestRule.from(value)
+          spec = NodeSpec.from(value)
+          raise "Unknown type for nesting: '#{spec.type}' from '#{raw_filter}'. Allowed: #{NESTING_ALLOWED_TYPES}" unless NESTING_ALLOWED_TYPES.include?(spec.type)
+          raise "Type #{spec.type} cannot have a name." if %w[block].include?(spec.type) && spec.restrict_name?
+
+          @nest_under << spec
+        elsif %w[has h].include?(name)
+          @has_leaves << NodeSpec.from(value)
         end
       end
 

data/lib/cql_ruby/pattern_matcher.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 module CqlRuby
   module PatternMatcher
+    MATCH_ANY = '*'
+
     def self.match?(pattern, subject)
-      subject = subject.to_s
       pattern = pattern.to_s
+      return true if pattern == MATCH_ANY
+
+      subject = subject.to_s
 
       if regex?(pattern)
         regex_match?(pattern, subject)
@@ -15,7 +19,7 @@ module CqlRuby
     end
 
     def self.regex?(pattern)
-      pattern[0..1] == 'r:'
+      pattern[0..1] == 'r/'
     end
     private_class_method :regex?
 
@@ -26,7 +30,9 @@ module CqlRuby
 
     def self.regex_match?(pattern, subject)
       pattern = pattern[2..]
-      pattern, *mods = pattern.split('+')
+      delim_idx = pattern.rindex('/')
+      mods = pattern[delim_idx + 1..].chars
+      pattern = pattern[0..delim_idx - 1]
 
       fops = 0
       fops |= Regexp::IGNORECASE if mods.include?('i')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cql_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 platform: ruby
 authors:
 - itarato