smart_todo 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4daea874da20235bc9b20d315058644bafb73e78b14c6c266f6252f4b346bcf1
-  data.tar.gz: feb305070b73a03e2481515a914cca2fcaad264f3871cd65e242bf58ccb3612f
+  metadata.gz: c17d1471d893e5a764dda2fa9adcfc73049b5c5a45d6678feca40104879065fc
+  data.tar.gz: 85411f13bc189f060372e90a72fc1a545cd0030b6f67cf0fd75f1ff97dbeb755
 SHA512:
-  metadata.gz: 7fcba36662ce881114aafa3f5bba320d767c3e299a1d9d91f06a505107815d631c008ed87a1e853d1bb2766c1e9bdce756125ccc9c5ed65917264f962da62814
-  data.tar.gz: 981c7785a6c5e4d2805d004f6ec1411a953ec9d68005314bc8fe52bf1deb5f6c036a73ea4a08cf3346a120f765971c4fbb0049bdc4ebf97c867bf7e14f7690b8
+  metadata.gz: bfe190ce26c9b3e65aea86f3d23e40a400c14edcac8c465b361341ac00a7ab7d59498c9c3edda92d7e180659cad96240148bce26dc3a1db77a92ee2e03575204
+  data.tar.gz: f1c0386fbb5346a74c3f9c0c3b6228a9af29a810241793a5f44db5cbe7d7873c24e9dda987b65aff0d4984193be3652bec472431a48407badb2eb7610da506d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.5.0)
+    smart_todo (1.6.0)
       rexml
 
 GEM

data/lib/smart_todo/events/issue_close.rb

@@ -11,6 +11,11 @@ module SmartTodo
     # If the Pull Request or Issue is on a private repository, exporting a token
     # with the `repos` scope in the +SMART_TODO_GITHUB_TOKEN+ environment variable
     # is required.
+    #
+    # You can also set a per-org or per-repo token by exporting more specific environment variables:
+    # +SMART_TODO_GITHUB_TOKEN__<ORG>+ and +SMART_TODO_GITHUB_TOKEN__<ORG>__<REPO>+
+    # The +<ORG>+ and +<REPO>+ parts should be uppercased and use underscores.
+    # For example, +Shopify/my-repo+ would become +SMART_TODO_GITHUB_TOKEN__SHOPIFY__MY_REPO=...+.
     class IssueClose
       TOKEN_ENV = "SMART_TODO_GITHUB_TOKEN"
 
@@ -78,8 +83,30 @@ module SmartTodo
       # @return [Hash]
       def default_headers
         { "Accept" => "application/vnd.github.v3+json" }.tap do |headers|
-          headers["Authorization"] = "token #{ENV[TOKEN_ENV]}" if ENV[TOKEN_ENV]
+          token = authorization_token
+          headers["Authorization"] = "token #{token}" if token
+        end
+      end
+
+      # @return [String, nil]
+      def authorization_token
+        # Will look in order for:
+        # SMART_TODO_GITHUB_TOKEN__ORG__REPO
+        # SMART_TODO_GITHUB_TOKEN__ORG
+        # SMART_TODO_GITHUB_TOKEN
+        parts = [
+          TOKEN_ENV,
+          @organization.upcase.gsub(/[^A-Z0-9]/, "_"),
+          @repo.upcase.gsub(/[^A-Z0-9]/, "_"),
+        ]
+
+        (parts.size - 1).downto(0).each do |i|
+          key = parts[0..i].join("__")
+          token = ENV[key]
+          return token unless token.nil? || token.empty?
         end
+
+        nil
       end
     end
   end

data/lib/smart_todo/events/ruby_version.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  module Events
+    # An event that checks the currently installed ruby version.
+    # @example
+    #   RubyVersion.new(['>= 2.3', '< 3'])
+    class RubyVersion
+      def initialize(requirements)
+        @requirements = Gem::Requirement.new(requirements)
+      end
+
+      # @param requirements [Array<String>] a list of version specifiers
+      # @return [String, false]
+      def met?
+        if @requirements.satisfied_by?(Gem::Version.new(installed_ruby_version))
+          message(installed_ruby_version)
+        else
+          false
+        end
+      end
+
+      # @param installed_ruby_version [String], requirements [String]
+      # @return [String]
+      def message(installed_ruby_version)
+        "The currently installed version of Ruby #{installed_ruby_version} is #{@requirements}."
+      end
+
+      private
+
+      def installed_ruby_version
+        RUBY_VERSION
+      end
+    end
+  end
+end

data/lib/smart_todo/events.rb

@@ -66,5 +66,13 @@ module SmartTodo
     def pull_request_close(organization, repo, pr_number)
       IssueClose.new(organization, repo, pr_number, type: "pulls").met?
     end
+
+    # Check if the installed ruby version meets requirements.
+    #
+    # @param requirements [Array<String>] a list of version specifiers
+    # @return [false, String]
+    def ruby_version(*requirements)
+      RubyVersion.new(requirements).met?
+    end
   end
 end

data/lib/smart_todo/parser/metadata_parser.rb

@@ -37,7 +37,7 @@ module SmartTodo
       # @param args [Array]
       # @return [Array, MethodNode]
       def on_method_add_arg(method, args)
-        if method == "TODO"
+        if method.start_with?(/TODO\W?/)
           args
         else
           MethodNode.new(method, args)

data/lib/smart_todo/version.rb

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

data/lib/smart_todo.rb

@@ -18,6 +18,7 @@ module SmartTodo
     autoload :GemBump,                "smart_todo/events/gem_bump"
     autoload :GemRelease,             "smart_todo/events/gem_release"
     autoload :IssueClose,             "smart_todo/events/issue_close"
+    autoload :RubyVersion,            "smart_todo/events/ruby_version"
   end
 
   module Dispatchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -118,6 +118,7 @@ files:
 - lib/smart_todo/events/gem_bump.rb
 - lib/smart_todo/events/gem_release.rb
 - lib/smart_todo/events/issue_close.rb
+- lib/smart_todo/events/ruby_version.rb
 - lib/smart_todo/parser/comment_parser.rb
 - lib/smart_todo/parser/metadata_parser.rb
 - lib/smart_todo/parser/todo_node.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.16
 signing_key: 
 specification_version: 4
 summary: Enhance todo's comments in your codebase.