smart_todo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a61dfef2e6101321b34f154e8143441b3f28502709b26cb2db504fe83251ba1a
-  data.tar.gz: 3f12eef19063ed2f8585b56be3b483f1312dc44a7c96cc93931c8ae89a4ac7c5
+  metadata.gz: f43df881f5ab5894069683abbe3d09571232a896a429d0d2795d57e8102e42dc
+  data.tar.gz: 070dc363e6e1aa44e605e1fe53126bfc613af23985cfc7cdb48a145fe93362e0
 SHA512:
-  metadata.gz: 25d629887ac69968359d5bd26a15736adebad37c881eeec2c5b05432be1a05fca0d69cf9c978c638b7033e9deffcc2f24111fee307359325f70c07d6905d6b04
-  data.tar.gz: 7a5472d3ad8d69187ccc5d46975b1f3ac0368886259c1f42d2303c4a0e8cb6f4de34a33f08b12d205ddde13f8ba5184a423eba95dece54335f0e7ed405861a15
+  metadata.gz: 69d9f4f170b854769a3141a41135c25463b2839274be7a6cea062b2d524fa5cee37e64c0a134f9de10944b9fce9e3580ed8f3b5ca4c8a8101528c3f9691a1c36
+  data.tar.gz: c5b66f439a2176728ca2f8ef4297fceeaa6d9f08c1ba190d4a255b8e3164264262536681d34a9cab4a9837c2455e75ecdf1dd9dc6b7b8b9877e37ef026719c01

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2019-11-25
+### Fixed
+- Fixed crash with badly formated TODO(on:) (i.e. `TODO(on: 'blabla'))
+
+### Added
+- Added the `on: gem_bump` event which will remind you when a gem inside your
+  Gemfile.lock snapshot gets updated to a specific version.
+
+  ```ruby
+  # TODO(on: gem_bump('rails', '6.1'), to: '...')
+  ```
+
 ## [1.1.0] - 2019-09-06
 ### Fixed
 - Fixed the SmartTodo cop to add an offense in case a SmartTodo has a wrong event.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.1.0)
+    smart_todo (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/smart_todo.rb

@@ -15,6 +15,7 @@ module SmartTodo
 
   module Events
     autoload :Date,                   'smart_todo/events/date'
+    autoload :GemBump,                'smart_todo/events/gem_bump'
     autoload :GemRelease,             'smart_todo/events/gem_release'
     autoload :IssueClose,             'smart_todo/events/issue_close'
   end

data/lib/smart_todo/events.rb

@@ -38,6 +38,15 @@ module SmartTodo
       GemRelease.new(gem_name, requirements).met?
     end
 
+    # Check if +gem_name+ was bumped to the +requirements+ expected
+    #
+    # @param gem_name [String]
+    # @param requirements [Array<String>] a list of version specifiers
+    # @return [false, String]
+    def gem_bump(gem_name, *requirements)
+      GemBump.new(gem_name, requirements).met?
+    end
+
     # Check if the issue +issue_number+ is closed
     #
     # @param organization [String] the GitHub organization name

data/lib/smart_todo/events/gem_bump.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+gem('bundler')
+require 'bundler'
+
+module SmartTodo
+  module Events
+    # An event that compare the version of a gem specified in your Gemfile.lock
+    # with the expected version specifiers.
+    class GemBump
+      # @param gem_name [String]
+      # @param requirements [Array] a list of version specifiers.
+      #   The specifiers are the same as the one used in Gemfiles or Gemspecs
+      #
+      # @example Expecting a specific version
+      #   GemBump.new('rails', ['6.0'])
+      #
+      # @example Expecting a version in the 5.x.x series
+      #   GemBump.new('rails', ['> 5.2', '< 6'])
+      def initialize(gem_name, requirements)
+        @gem_name = gem_name
+        @requirements = Gem::Requirement.new(requirements)
+      end
+
+      # @return [String, false]
+      def met?
+        return error_message if spec_set[@gem_name].empty?
+
+        installed_version = spec_set[@gem_name].first.version
+        if @requirements.satisfied_by?(installed_version)
+          message(installed_version)
+        else
+          false
+        end
+      end
+
+      # Error message send to Slack in case a gem couldn't be found
+      #
+      # @return [String]
+      def error_message
+        "The gem *#{@gem_name}* is not in your dependencies, I can't determine if your TODO is ready to be addressed."
+      end
+
+      # @return [String]
+      def message(version_number)
+        "The gem *#{@gem_name}* was updated to version *#{version_number}* and your TODO is now ready to be addressed."
+      end
+
+      private
+
+      # @return [Bundler::SpecSet] an instance of Bundler::SpecSet
+      def spec_set
+        @spec_set ||= Bundler.load.specs
+      end
+    end
+  end
+end

data/lib/smart_todo/parser/metadata_parser.rb

@@ -103,6 +103,8 @@ module SmartTodo
       # @param method_node [MethodNode]
       # @return [void]
       def on_todo_event(method_node)
+        return unless method_node.is_a?(MethodNode)
+
         events << method_node
       end
 

data/lib/smart_todo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartTodo
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - lib/smart_todo/dispatchers/slack.rb
 - lib/smart_todo/events.rb
 - lib/smart_todo/events/date.rb
+- lib/smart_todo/events/gem_bump.rb
 - lib/smart_todo/events/gem_release.rb
 - lib/smart_todo/events/issue_close.rb
 - lib/smart_todo/parser/comment_parser.rb