cql_ruby 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e03910538e8b57539419210406155ba4a9d0aed14f0852edfd1867e6fbccbe
-  data.tar.gz: acb0f56f0faefb1f39613f2805b25cbee66e61d0a715138007c021036e05e03a
+  metadata.gz: e75a456d8dff7bb1b1affde452bfc7df1e01508a2514ca1729cf996e28c3bff6
+  data.tar.gz: 57d5bdbfe2991ba0ed0c529373405885cc4382c8cf2f6cec3c86117b65fc31bf
 SHA512:
-  metadata.gz: 71feb8dab0a500e27989d7a96117b2f558b09f1eade1db44503a69ee3cadf6f21bec65d7e921ae219a39835ded528fc62cf91216989a9121006343636098b81b
-  data.tar.gz: e3fdf1a7ecdc01fb7f5f3174d932a60e4718d2c08534414ec0627666590df1d29985cc113763423a3eb913a0d7994b789d1ad7c8baed645e04fe2b8104ecdb98
+  metadata.gz: b56ead4780a2823d1e327c7ab24e5d73923d21096a5b95832cdfbe7bc499a335bdc2ea5d252efaff96e2ba4fd6471b4ca6e12c9c18f90249116bff509217b66d
+  data.tar.gz: 1b30aedc86c325e1cc6fdd8813abe2d46f5d76d34f542e0d9f0446b0a7fa42721c4f76dfec376c477287eff46d71311f2b86b20c1dea6c9658cfe8b04207b775

data/bin/cql_ruby

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'parser'
 require 'cql_ruby'
 
 def show_help
@@ -14,14 +15,25 @@ def show_help
     \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?
 
     \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 -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
@@ -34,6 +46,9 @@ def extract_options
     show_file: true,
     show_source: true,
     recursive_search: true,
+    surrounding_lines: 0,
+    include_pattern: nil,
+    exclude_pattern: nil,
   }
 
   ARGV.delete_if do |arg|
@@ -51,6 +66,12 @@ def extract_options
         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
@@ -78,7 +99,6 @@ begin
   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?
 
@@ -92,6 +112,7 @@ begin
   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(
@@ -101,8 +122,10 @@ begin
     path: path,
     filters: filters,
     recursive: options[:recursive_search],
+    include: options[:include_pattern],
+    exclude: options[:exclude_pattern],
   ).search_all
-rescue => e
-  puts "Error: #{e}"
+rescue
+  puts "Error: #{$!}"
   show_help
 end

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

@@ -33,7 +33,9 @@ module CqlRuby
       pattern:,
       path:,
       filters: [],
-      recursive: true
+      recursive: true,
+      include: nil,
+      exclude: nil
     )
       @collector = collector
       @filter_reader = filter_reader
@@ -41,10 +43,15 @@ module CqlRuby
       @path = path
       @filters = filters
       @recursive = recursive
+      @include = include
+      @exclude = exclude
     end
 
     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)
+
         CqlRuby.log "File check: #{file}" if CqlRuby::Config.debug_level_3?
         search(file)
       end
@@ -58,6 +65,9 @@ module CqlRuby
       walk(ast, [], source_reader)
 
       nil
+    rescue
+      CqlRuby.log "File #{file} cannot be parsed"
+      CqlRuby.log "Reason: #{$!}" if CqlRuby::Config.debug_level_1?
     end
 
     def walk(node, ancestors, source_reader)
@@ -110,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
@@ -129,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)

metadata

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