remind_me 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea5c318524b2dd5b11cb96b2ff7870e469a38bab9c895f3b62eb86c2e229c57
-  data.tar.gz: ac8c013b669d56012c1a3cbac04eb7f363dfc0c1e3a22540800ef6dd7e938acf
+  metadata.gz: ad4645fc24e7238a0722f828cd63edac243c528dd649d52752067488a5777f72
+  data.tar.gz: 3ebd1346fc2391ff256fa99994aea089255ffa30692057f3b4e5bbb03dc4c0be
 SHA512:
-  metadata.gz: f6a200f413d221cd864a1b33ea2b890fd04c4f4573575c3c48500311c02a148fc7726e50d7c2929c56071e688d609b00fdcd651517e2c5136bb8989d9cb1528b
-  data.tar.gz: c192d2ea83b3f41e003b769d662cb5c3c1df9ee0d03404370f5033f0f8825417c2596755997ae522bc50168b2e5e4f22f4a6ea788def5e65ca401f9c95cc5a20
+  metadata.gz: 63ad32bbb05678a25fef45ec2bdc975d6926494b441b294ce715e187d6c0737f0ebb9dea40c34c1869091a492ebcefe0d528f39c8907ebb2ebccd399ba47970e
+  data.tar.gz: b7ae5dcb4acc4c4c71a02d320a1408aa167b97cf7e4c28223da1010ba8aafaf6d80da26100750ec39148b7d7f978c6d8bbe00f2d23e10c78e8235885f5fddaae

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .ruby-version
+/*.gem

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    remind_me (0.2.0)
+    remind_me (0.3.0)
+      parallel (~> 1.19.2)
       parser (~> 3.0.2.0)
 
 GEM

data/README.md

@@ -1,5 +1,6 @@
 # Remind Me
 [![Tests](https://github.com/nikola-maric/remind_me/workflows/Tests/badge.svg?branch=master)](https://github.com/nikola-maric/remind_me/actions?query=workflow%3ATests+branch%3Amaster)
+[![Gem Version](https://badge.fury.io/rb/remind_me.svg)](https://badge.fury.io/rb/remind_me)
 
 This gem's main purpose is to scan a file or directory for specific comments in the code. Comments are
 specified as a hash with `REMIND_ME:` (with a colon) prefixed to it, for example: 
@@ -71,8 +72,6 @@ end
 **Important note**: in order to find and parse those comments properly, there are some limitations on how comments are used:
 - Entire `REMIND_ME: {}` comment needs to be on a single line, don't break it into multiple lines.
 - Thing after `REMIND_ME:` needs to have ruby hash structure
-- Both keys and values should be strings, symbols or strings/symbols, depending on reminder (for example, keys can
-be given as symbols, but for `version` values strings are only allowed)
 
 Each reminder type has a specific key that it "targets", for example `ruby_version`. If comment is found that does not 
 match any reminder, we will print out error message specifying that + location where that reminder is found.
@@ -87,7 +86,7 @@ to any known reminder processor.
 
 Has following structure: 
 `REMIND_ME: { gem: 'rails', version: '6', condition: :gte, message: 'Check this once rails 6 is available'}`.  
-It targets all comment hash-es that have `gem/'gem'` in them as a key. 
+It targets all comment hash-es that have `:gem/'gem'` in them as a key. 
 It will look at currently installed gems and compare that version to target version specified in comment.
 
 If version is omitted, we will only check if gem is installed or not (can be used to trigger
@@ -101,7 +100,7 @@ if message is omitted, it will default to `'Condition met!'`
 
 Has following structure:
 `REMIND_ME: { missing_gem: 'thor', message: 'Check this once we remove 'thor' gem'}`.  
-It targets all comment hash-es that have `missing_gem/'missing_gem'` in them as a key.
+It targets all comment hash-es that have `:missing_gem/'missing_gem'` in them as a key.
 It will look at currently installed gems and check to see if gem is installed, and will be triggered
 if its not.
 
@@ -111,7 +110,7 @@ if message is omitted, it will default to `'Condition met!'`
 
 Has following structure:
 `REMIND_ME: { ruby_version: '3', condition: :gte, message: 'Check this once we start using Ruby 3.0+'}`.  
-It targets all comment hash-es that have `ruby_version/'ruby_version'` in them as a key.
+It targets all comment hash-es that have `:ruby_version/'ruby_version'` in them as a key.
 It will look at currently used ruby version and compare that version to target version specified in comment.
 
 If condition is omitted, it will default to `eq`.
@@ -127,7 +126,7 @@ require 'remind_me'
 
 desc 'picks up REMIND_ME comments from codebase and checks if their conditions are met'
 task custom_check_reminders: :environment do
-  RemindMe::Runner.new.check_reminders('/some/other/directory/')
+  RemindMe::Runner.new.check_reminders(check_path: '/some/other/directory/')
 end
 ```
 
@@ -138,8 +137,7 @@ is configured to work properly from within rake task.
 You can define custom reminders in your code by registering your reminder class with `RemindMe::Reminder::Generator`. For example:
 ```ruby
 # in initializers/timed_reminder.rb
-module Timed
-  class Reminder < RemindMe::Reminder::BaseReminder
+class TimedReminder < RemindMe::Reminder::BaseReminder
     apply_to_hash_with %i[after_time]
     validate_hash_ast key: :message, value_types: %i[str], default_value: 'Condition met!'
 
@@ -148,11 +146,10 @@ module Timed
     end
 
     def validation_errors
-      Time.parse(hash_after_time)
+      Time.parse(hash_after_time) && []
     rescue StandardError => e
       ["'after_time' holds value that can't be parsed into time (#{e.message})"]
     end
-  end
 end
 ```
 Subclassing `RemindMe::Reminder::BaseReminder` will automatically register it as one of potential reminder processors.

data/lib/remind_me/runner.rb

@@ -2,6 +2,8 @@
 
 require 'parser/current'
 require 'find'
+require 'parallel/processor_count'
+require 'parallel'
 
 require_relative 'version'
 require_relative 'bail_out'
@@ -11,41 +13,32 @@ require_relative 'utils/result_printer'
 
 module RemindMe
   class Runner
-    include BailOut
-    include Utils::Logger
+    extend BailOut
+    extend Utils::Logger
+    extend Parallel::ProcessorCount
 
-    attr_reader :parser
-
-    def initialize
-      @parser = Parser::CurrentRuby.new
-      parser.diagnostics.consumer = ->(_message) {  }
-      parser.diagnostics.ignore_warnings = true
-    end
-
-    def check_reminders(check_path: '.')
-      log_info "Checking #{check_path} for any REMIND_ME comments..."
-      all_reminders = collect_reminders(check_path)
-      Utils::ResultPrinter.new(all_reminders).print_results
+    def self.check_reminders(check_path: '.')
+      Utils::ResultPrinter.new(collect_reminders(check_path)).print_results
     end
 
-    def collect_reminders(parse_path)
-      files = collect_ruby_files(parse_path)
+    def self.collect_reminders(path)
+      files = relevant_ruby_files(path)
       bail_out!('Need something to parse!') if files.empty?
-      log_info "Found #{files.size} ruby files"
-      raw_comments = collect_relevant_comments(files)
-      raw_comments.flat_map { |raw_comment| RemindMe::Reminder::Generator.generate(raw_comment[0], raw_comment[1], parser) }
+      Parallel.flat_map(in_groups(files, processor_count, false)) do |files|
+        parser = silent_parser
+        raw_comments = collect_relevant_comments(files, parser)
+        raw_comments.flat_map { |raw_comment| RemindMe::Reminder::Generator.generate(raw_comment[0], raw_comment[1], parser) }
+      end
     end
 
-    private
-
-    def collect_relevant_comments(files)
-      files.flat_map { |file| all_file_comments(file) }
-           .map { |x| [x.location.expression.to_s, x.text.split('REMIND_ME:', 2)] }
-           .select { |x| x[1].size == 2 }
-           .map { |x| [x[0], x[1][1].split("\n").first] }
+    def self.silent_parser
+      parser = Parser::CurrentRuby.new
+      parser.diagnostics.consumer = ->(_message) {}
+      parser.diagnostics.ignore_warnings = true
+      parser
     end
 
-    def all_file_comments(file)
+    def self.all_file_comments(file, parser)
       parser.reset
       source = File.read(file).force_encoding(parser.default_encoding)
       buffer = Parser::Source::Buffer.new(file)
@@ -53,7 +46,22 @@ module RemindMe
       parser.parse_with_comments(buffer).last
     end
 
-    def collect_ruby_files(parse_path)
+    def self.collect_relevant_comments(files, parser)
+      files.flat_map { |file| all_file_comments(file, parser) }
+           .map { |x| [x.location.expression.to_s, x.text.split('REMIND_ME:', 2)] }
+           .select { |x| x[1].size == 2 }
+           .map { |x| [x[0], x[1][1].split("\n").first] }
+    end
+
+    def self.relevant_ruby_files(parse_path)
+      Parallel.flat_map(in_groups(collect_ruby_files(parse_path), processor_count, false)) do |files|
+        files.select do |file|
+          IO.foreach(file).any? { |line| line.include?('REMIND_ME:') }
+        end
+      end
+    end
+
+    def self.collect_ruby_files(parse_path)
       files = []
       if File.directory?(parse_path)
         Find.find(parse_path) do |path|
@@ -64,6 +72,24 @@ module RemindMe
       end
       files
     end
+
+    def self.in_groups(array, number, fill_with = nil)
+      division = array.size.div number
+      modulo = array.size % number
+      groups = []
+      start = 0
+      number.times do |index|
+        length = division + (modulo.positive? && modulo > index ? 1 : 0)
+        groups << last_group = array.slice(start, length)
+        last_group << fill_with if fill_with != false && modulo.positive? && length == division
+        start += length
+      end
+      groups
+    end
+
+    private_class_method :in_groups,
+                         :collect_ruby_files,
+                         :collect_relevant_comments
   end
 end
 

data/lib/remind_me/tasks/remind_me.rake

@@ -3,6 +3,6 @@ require 'remind_me'
 namespace :remind_me do
   desc 'picks up REMIND_ME comments from codebase and checks if their conditions are met'
   task check_reminders: :environment do
-    RemindMe::Runner.new.check_reminders
+    RemindMe::Runner.check_reminders
   end
 end

data/lib/remind_me/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemindMe
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/remind_me.gemspec

@@ -32,5 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
 
+  spec.add_dependency 'parallel', '~> 1.19.2'
   spec.add_dependency 'parser', '~> 3.0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remind_me
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nikola Marić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.2
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement