cql_ruby 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6255a37c5d7ad3bb69be36d10bf4056eb8b40729a5989db72ecdc81e30a2784a
-  data.tar.gz: e60a47023bf3062f83157f1d414dfc8122c58df9a4c6898f6048ac91727accea
+  metadata.gz: 7bd516a07069a73fad1c48a2ca7ae536d7c52a891c882211d2de0b5d9c670fb1
+  data.tar.gz: 9ec5696402ffd46da3427c338e18b33cc7d7fecf39df135cee451a29ccee39ae
 SHA512:
-  metadata.gz: 773f82e313c1ce9ad9a3c7f24d243d7045d7ad731d508ec082a5b8f3dce7a0d13078a9f21a0930bd535b2d3b530d801ee534eabcfa70ab44eada8af01b6adc65
-  data.tar.gz: 9dbca8f1684162d99e81a8729cd1544fae6fc32bb7a327e184fa47b44939892a97940dc11e8880bfe99eac7e9d6793a235bfd0e0cae78b3053bc2ad5bf2c286e
+  metadata.gz: 9b6dbc5df16b5042e431d6682435e0f993b013c66ab70541a259b66ed487405c71c088b63f554085fb2018bd59bd0e3499931c87dcfc0d2f4bc9c8bfbabeb421
+  data.tar.gz: ff722aee7187a9b0a44cbe9ff45182fa13fe97add03a46545f7de26238993abefdb16cb85e4e4302a90cf1f7c39d8071e1d1bcb1213db382df8a6d4f505ac819

data/bin/cql_ruby

@@ -0,0 +1,116 @@
+#!/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

data/lib/cql_ruby.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-module CqlRuby
-  ; end
+module CqlRuby;
+  def self.log(txt)
+    p txt
+  end
+end
 
-require 'cql/executor'
-require 'cql/crumb_collector'
-require 'cql/abstract_printer'
-require 'cql/console_printer'
-require 'cql/filter_reader'
-require 'cql/filter_evaluator'
-require 'cql/pattern_matcher'
+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/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,77 @@ 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
+    )
+      @collector = collector
+      @filter_reader = filter_reader
+      @pattern = pattern
+      @path = path
+      @filters = filters
+      @recursive = recursive
     end
-  end
 
-  private
+    def search_all
+      files.flat_map do |file|
+        CqlRuby.log "File check: #{file}" if CqlRuby::Config.debug_level_3?
+        search(file)
+      end
+    end
 
-  def search(file)
-    ast = Parser::CurrentRuby.parse(File.read(file))
-    source_reader = CqlRuby::SourceReader.new(file)
-    walk(ast, [], source_reader)
+    private
 
-    nil
-  end
+    def search(file)
+      ast = Parser::CurrentRuby.parse(File.read(file))
+      source_reader = CqlRuby::SourceReader.new(file)
+      walk(ast, [], source_reader)
 
-  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))
+      nil
+    rescue => e
+      CqlRuby.log "File #{file} cannot be parsed: #{e}"
+    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 +112,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 +135,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/pattern_matcher.rb

@@ -15,7 +15,7 @@ module CqlRuby
     end
 
     def self.regex?(pattern)
-      pattern[0..1] == 'r:'
+      pattern[0..1] == 'r/'
     end
     private_class_method :regex?
 
@@ -26,7 +26,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.2
+  version: 0.0.7
 platform: ruby
 authors:
 - itarato
@@ -9,13 +9,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-07-05 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
 description: 
 email: it.arato@gmail.com
-executables: []
+executables:
+- cql_ruby
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/cql_ruby
 - lib/cql_ruby.rb
 - lib/cql_ruby/abstract_printer.rb
 - lib/cql_ruby/console_printer.rb
@@ -36,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="