end_of_life 0.5.1 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19209199d1886b9a553b2ce566a075a162fc0f877073aad2c63739f99d32f0ee
-  data.tar.gz: 9ef0fbd8ef557d73c0a6739b29fa4f40edb3dbba4e6b306f4e132ae160ed815e
+  metadata.gz: 31c4b9042f127a4857ab815c550b47c84a749d079a7661778180527094f3ebb9
+  data.tar.gz: 7c5ec81d9f45348408fb73bb0c218080ef0f5b6da60eb7b1541300ec0124c373
 SHA512:
-  metadata.gz: 66fe59b2626bf7656eed917b4fa8e196b15e81dd327f19636af914359956b318648e334f8655d249a979f8d50c94ece93fde880ac241fc497985ba06f18ab55f
-  data.tar.gz: 924eed863de214be0a8ac4a91fccfa964f1349efa13631acec507a6b59a481811885f9dbdc6ff3cd4473e6d460f42a1cffb4400bf6f1297707d83b23b422ffda
+  metadata.gz: cc4cdf54b0ac364cbcc8560b43697c14e340c9ff6cbb912a69260559339a5dd064e762844ab41f0430a212cc309960f78f84467f8fefe47f110edf299a591909
+  data.tar.gz: 65815bb7004eee6f7579c39cdc4453a4aa85da248f4e5efa1656ff8f118af6b40246f9c3f3b85656587abb14f4efeaa313d4798ed1d1a46652b228b7e234d7c4

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - '**/*':
+    - Style/ItAssignment

data/CHANGELOG.md

@@ -1,4 +1,22 @@
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [1.0.0.alpha] - 2025-10-24
+
+- Revamp CLI
+  - Now the main command is `end_of_life scan <product>` instead of `end_of_life scan --product=<product>`
+- 🎉 Add support for scanning EOL Node.js versions!
+- Add support for detecting versions from `mise.toml`.
+- Add `check` command to check if specific product releases are EOL:
+
+```sh
+$ end_of_life check ruby@3 nodejs@18
+┌─────────────────┬───────────┬───────────────────────────┐
+│ Product Release │ Status    │ EOL Date                  │
+├─────────────────┼───────────┼───────────────────────────┤
+│ ruby@3.4.7      │ Supported │ 2028-03-31 (in 2 years)   │
+│ nodejs@18.20.8  │ EOL       │ 2025-04-30 (5 months ago) │
+└─────────────────┴───────────┴───────────────────────────┘
+```
 
 ## [0.5.1] - 2025-09-10
 

data/Gemfile

@@ -6,10 +6,11 @@ source "https://rubygems.org"
 gemspec
 
 gem "climate_control", "~> 1.0"
+gem "ostruct"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.10"
 gem "rspec-mocks", "~> 3.10"
 gem "simplecov", "~> 0.22.0"
 gem "standard", github: "testdouble/standard"
-gem "vcr", "~> 6.0"
+gem "vcr", github: "vcr/vcr"
 gem "webmock", "~> 3.13"

data/Gemfile.lock

@@ -9,15 +9,25 @@ GIT
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.8)
 
+GIT
+  remote: https://github.com/vcr/vcr.git
+  revision: ce35c236fe48899f02ddf780973b44cdb756c0ee
+  specs:
+    vcr (6.3.1)
+
 PATH
   remote: .
   specs:
-    end_of_life (0.5.1)
+    end_of_life (1.0.0.alpha)
+      argument_parser (~> 0.1.0)
       async
-      bundler (>= 2.3.0, < 3)
+      base64
+      bundler (>= 2.7.2, < 3)
       dry-monads (~> 1.3)
+      faraday-retry (~> 2.0)
       octokit (~> 9.0)
       pastel (~> 0.8.0)
+      perfect_toml (~> 0.9.0)
       tty-spinner (~> 0.9.0)
       tty-table (~> 0.12.0)
       zeitwerk (~> 2.7)
@@ -27,14 +37,15 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    argument_parser (0.1.3)
     ast (2.4.3)
-    async (2.31.0)
+    async (2.32.0)
       console (~> 1.29)
       fiber-annotation
       io-event (~> 1.11)
       metrics (~> 0.12)
       traces (~> 0.18)
-    base64 (0.2.0)
+    base64 (0.3.0)
     bigdecimal (3.1.9)
     climate_control (1.2.0)
     concurrent-ruby (1.3.5)
@@ -61,6 +72,8 @@ GEM
       logger
     faraday-net_http (3.4.1)
       net-http (>= 0.5.0)
+    faraday-retry (2.3.2)
+      faraday (~> 2.0)
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
@@ -77,19 +90,21 @@ GEM
     octokit (9.2.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
+    ostruct (0.6.3)
     parallel (1.27.0)
     parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
     pastel (0.8.0)
       tty-color (~> 0.5)
+    perfect_toml (0.9.0)
     prism (1.4.0)
     public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.11.2)
-    rexml (3.4.0)
+    rexml (3.4.4)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -155,8 +170,6 @@ GEM
     unicode-display_width (2.6.0)
     unicode_utils (1.4.0)
     uri (1.0.3)
-    vcr (6.3.1)
-      base64
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -169,13 +182,14 @@ PLATFORMS
 DEPENDENCIES
   climate_control (~> 1.0)
   end_of_life!
+  ostruct
   rake (~> 13.0)
   rspec (~> 3.10)
   rspec-mocks (~> 3.10)
   simplecov (~> 0.22.0)
   standard!
-  vcr (~> 6.0)
+  vcr!
   webmock (~> 3.13)
 
 BUNDLED WITH
-   2.3.9
+   2.7.2

data/README.md

@@ -1,18 +1,24 @@
 # End of Life
 
-This gem lists GitHub repositories using end-of-life versions of various
-products.
+This tool lists GitHub repositories using end-of-life software.
+
+We currently support Ruby, Rails, and Node.js. If you want to add support for
+more products, please check out the [Contributing](#contributing) section.
 
 ![End of Life Demo](demo.gif)
 
 ## Installation
 
+If you have Ruby installed, you can install End of Life as a gem with:
+
 ```sh
 gem install end_of_life
 ```
 
 ## Usage
 
+### Scanning your repositories
+
 1. Set up a [GitHub access token][] (we recommend using a read-only token);
 
 [github access token]:
@@ -21,12 +27,12 @@ gem install end_of_life
 2. Export the `GITHUB_TOKEN` environment variable or set it when calling
    `end_of_life`;
 
-3. Use the `end_of_life` command to list the repositories:
+3. Use the `end_of_life scan` command to list the repositories:
 
 ```sh
-$ GITHUB_TOKEN=something end_of_life # if your platform supports symlinks, you can use the `eol` command instead
-[✔] Searching repositories with Ruby...
-[✔] Searching for EOL Ruby in repositories...
+$ GITHUB_TOKEN=something end_of_life scan ruby
+[✔] Searching repositories that might use Ruby...
+[✔] Scanning 27 repositories for EOL Ruby...
 
 Found 2 repositories using EOL Ruby (<= 3.1.7):
 ┌───┬──────────────────────────────────────────────┬──────────────┐
@@ -37,44 +43,94 @@ Found 2 repositories using EOL Ruby (<= 3.1.7):
 └───┴──────────────────────────────────────────────┴──────────────┘
 ```
 
-### Options
+> [!TIP]
+> You can use the shorthand `eol` instead of `end_of_life` if your platform
+> supports symlinks.
+
+#### Options for `scan`
 
 There are some options to help you filter down the results:
 
+```sh
+Usage: end_of_life scan PRODUCT [OPTIONS]
+      --exclude=NAME,NAME2            Exclude repositories containing a certain word in their name. You can specify up to five words.
+      --public-only                   Searches only public repositories
+      --private-only                  Searches only private repositories
+      --repo, --repository=USER/REPO  Searches a specific repository
+      --org, --organization=ORG,ORG2  Searches within specific organizations
+  -u, --user=NAME                     Sets the user used on the repository search
+      --max-eol-days-away NUMBER      Sets the maximum number of days away a version can be from EOL.
+      --include-archived              Includes archived repositories on the search
+  -h, --help                          Show this help message
+```
+
+### Checking if a specific product version is EOL
+
+> [!IMPORTANT]
+> You don't need a GitHub token to use this command.
+
+You can also check if a specific product version is end-of-life with the
+`end_of_life check` command:
+
+```sh
+$ end_of_life check ruby@2.5.8 # exits with status code 1 on EOL
+┌─────────────────┬────────┬──────────────────────────┐
+│ Product Release │ Status │ EOL Date                 │
+├─────────────────┼────────┼──────────────────────────┤
+│ ruby@2.5.9      │ EOL    │ 2021-03-31 (4 years ago) │
+└─────────────────┴────────┴──────────────────────────┘
 ```
-Usage: end_of_life [options]
-    -p, --product NAME                 Sets the product to scan for (default: ruby). Supported products are: ruby, rails.
-        --exclude=NAME,NAME2           Exclude repositories containing a certain word in its name. You can specify up to five words.
-        --public-only                  Searches only public repositories
-        --private-only                 Searches only private repositories
-        --repo, --repository=USER/REPO Searches a specific repository
-        --org, --organization=ORG,ORG2 Searches within specific organizations
-    -u, --user=NAME                    Sets the user used on the repository search
-        --max-eol-days-away NUMBER     Sets the maximum number of days away a version can be from EOL. It defaults to 0.
-        --include-archived             Includes archived repositories on the search
-    -v, --version                      Displays end_of_life version
-    -h, --help                         Displays this help
+
+You can pass multiple products to check at once:
+
+```sh
+$ end_of_life check ruby@2.5.8 nodejs@18
+┌─────────────────┬────────┬───────────────────────────┐
+│ Product Release │ Status │ EOL Date                  │
+├─────────────────┼────────┼───────────────────────────┤
+│ ruby@2.5.9      │ EOL    │ 2021-03-31 (4 years ago)  │
+│ nodejs@18.20.8  │ EOL    │ 2025-04-30 (4 months ago) │
+└─────────────────┴────────┴───────────────────────────┘
+```
+
+#### Options for `check`
+
+```sh
+Usage: end_of_life check PRODUCT@VERSION PRODUCT2@VERSION... [OPTIONS]
+      --max-eol-days-away NUMBER      Sets the maximum number of days away a version can be from EOL.
+  -h, --help                          Show this help message
+```
+
+> [!TIP]
+> You can use check with the `--max-eol-days-away` option on your CI to be
+> alerted when your current version is close to its end-of-life date:
+
+```sh
+$ end_of_life check ruby@$(ruby -v | awk '{print $2}') --max-eol-days-away=365
+┌─────────────────┬──────────┬──────────────────────────┐
+│ Product Release │ Status   │ EOL Date                 │
+├─────────────────┼──────────┼──────────────────────────┤
+│ ruby@3.2.9      │ Near EOL │ 2026-03-31 (in 6 months) │
+└─────────────────┴──────────┴──────────────────────────┘
 ```
 
 ## How it works
 
 This gem fetches all your GitHub repositories that contain code for the
 specified product, then searches for files that may contain version information.
-For Ruby, those files are: `.ruby-version`, `Gemfile`, `Gemfile.lock`, and
-`.tool-version`. End of Life parses these files and extracts the minimum version
-used in the repository.
+For Ruby, those files include `.ruby-version`, `Gemfile`, `Gemfile.lock`,
+`mise.toml`, and `.tool-version`. End of Life parses these files and extracts
+the minimum version used in each repository.
 
-The EOL version information is provided by https://endoflife.date/, with a file
-[fallback].
+The EOL version information is provided by https://endoflife.date/.
 
-> [!ATTENTION]
+> [!CAUTION]
 > To parse Gemfiles, we need to execute the code inside them.
 > **Be careful** because this may be a security risk. We plan to add secure
 > parsers for these files in the future.
 
 Some other limitations are listed on the [issues page].
 
-[fallback]: ./lib/end_of_life.json
 [issues page]: https://github.com/MatheusRich/end_of_life/issues
 
 ## Development
@@ -95,7 +151,19 @@ Bug reports and pull requests are welcome on GitHub at
 https://github.com/MatheusRich/end_of_life. If you want to add a new product,
 [check out this commit for reference].
 
-[check out this commit for reference]: ba9a92a690e0d61ea09e508c1cd76b8309fb89df
+[check out this commit for reference]: https://github.com/MatheusRich/end_of_life/commit/bfb6f9ceb5afb338fa5553a1266aa2c063e61200
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
+
+The development of this project is funded by thoughtbot, inc.
+
+We love open source software! See [our other projects][community]. We are
+[available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
 
 ## License
 

data/bin/end_of_life

@@ -0,0 +1 @@
+exe/end_of_life

data/end_of_life.gemspec

@@ -34,10 +34,14 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "argument_parser", "~> 0.1.0"
   spec.add_dependency "async"
-  spec.add_dependency "bundler", ">= 2.3.0", "< 3"
+  spec.add_dependency "base64"
+  spec.add_dependency "bundler", ">= 2.7.2", "< 3"
   spec.add_dependency "dry-monads", "~> 1.3"
+  spec.add_dependency "perfect_toml", "~> 0.9.0"
   spec.add_dependency "octokit", "~> 9.0"
+  spec.add_dependency "faraday-retry", "~> 2.0"
   spec.add_dependency "pastel", "~> 0.8.0"
   spec.add_dependency "tty-spinner", "~> 0.9.0"
   spec.add_dependency "tty-table", "~> 0.12.0"

data/lib/end_of_life/api.rb

@@ -1,3 +1,6 @@
+require "json"
+require "net/http"
+
 module EndOfLife
   module API
     extend self

data/lib/end_of_life/check.rb

@@ -0,0 +1,46 @@
+require "argument_parser"
+
+module EndOfLife
+  module Check
+    include Helpers::Terminal
+    include Helpers::Time
+    extend self
+
+    def run(releases, options)
+      report_for releases.map { |release_string| build_row(release_string, options) }
+    end
+
+    private
+
+    def build_row(release_string, options)
+      product_release = Product::Release.parse!(release_string)
+      cycle_release = product_release.latest_release_in_cycle or raise(
+        ArgumentError,
+        "Unknown product release: #{release_string}"
+      )
+
+      status = if cycle_release.supported?(at: options[:max_eol_date])
+        "Supported"
+      elsif cycle_release.supported?(at: Date.today)
+        "Near EOL"
+      else
+        "EOL"
+      end
+
+      eol_date = if cycle_release.eol_date
+        eol_days_away = relative_time_in_words(cycle_release.eol_date)
+        "#{cycle_release.eol_date} (#{eol_days_away})"
+      else
+        "N/A"
+      end
+
+      [cycle_release.to_s, status, eol_date]
+    end
+
+    HEADERS = ["Product Release", "Status", "EOL Date"].freeze
+    def report_for(rows)
+      puts table(HEADERS, rows)
+      exit 1 if rows.any? { |_, status, _| status != "Supported" }
+    end
+  end
+end

data/lib/end_of_life/cli/command/registry.rb

@@ -0,0 +1,46 @@
+require "optparse"
+
+module EndOfLife
+  class CLI
+    module Command::Registry
+      Command = Data.define(:name, :summary, :parser, :action) do
+        include Helpers::Terminal
+
+        def run(argv)
+          action.call(argv, parser)
+        rescue OptionParser::ParseError, ArgumentParser::ParseError => e
+          abort "#{error_msg(e.message.capitalize)}\n\n#{parser}"
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def command_registry
+          @command_registry ||= {}
+        end
+
+        def command(name, summary, &action)
+          option_parser = OptionParser.new("", 35, " " * 2) do |opt_parser|
+            opt_parser.on_tail("-h", "--help", "Show this help message") do
+              puts "#{summary}\n\n#{opt_parser}"
+              exit
+            end
+          end
+          command_registry[name.to_s] = Command.new(name: name.to_s, summary:, parser: option_parser, action:)
+        end
+
+        def commands = command_registry.values
+
+        def summarize_commands
+          max_length = commands.map { |cmd| cmd.name.length }.max
+          commands.map { |it| "  #{it.name.ljust(max_length)}    #{it.summary}" }.join("\n")
+        end
+      end
+
+      def command(name) = self.class.command_registry.fetch(name.to_s)
+    end
+  end
+end

data/lib/end_of_life/cli.rb

@@ -1,29 +1,124 @@
+require "argument_parser"
+require "date"
+
 module EndOfLife
   class CLI
+    include Command::Registry
+    extend Helpers::Terminal
     include Helpers::Terminal
 
+    command :scan, "Find projects using end-of-life software" do |argv, opt_parser|
+      options = {max_eol_date: Date.today, skip_archived: true}
+
+      opt_parser.banner = "Usage: end_of_life scan PRODUCT [OPTIONS]"
+      opt_parser.on("--exclude=NAME,NAME2", Array, "Exclude repositories containing a certain word in their name. You can specify up to five words.") do |excludes|
+        options[:excludes] = excludes.first(5)
+      end
+
+      opt_parser.on("--public-only", "Searches only public repositories") do
+        options[:visibility] = :public
+      end
+
+      opt_parser.on("--private-only", "Searches only private repositories") do
+        options[:visibility] = :private
+      end
+
+      opt_parser.on("--repo=USER/REPO", "--repository=USER/REPO", "Searches a specific repository") do |repository|
+        options[:repository] = repository
+      end
+
+      opt_parser.on("--org=ORG,ORG2...", "--organization=ORG,ORG2", Array, "Searches within specific organizations") do |organizations|
+        options[:organizations] = organizations
+      end
+
+      opt_parser.on("-u NAME", "--user=NAME", "Sets the user used on the repository search") do |user|
+        options[:user] = user
+      end
+
+      opt_parser.on("--max-eol-days-away NUMBER", "Sets the maximum number of days away a version can be from EOL.") do |days|
+        options[:max_eol_date] = Date.today + days.to_i.abs
+      end
+
+      opt_parser.on("--include-archived", "Includes archived repositories on the search") do
+        options[:skip_archived] = false
+      end
+      opt_parser.parse!(argv)
+
+      argument_parser = ArgumentParser.build do
+        required :product, pattern: EndOfLife.products_pattern
+      end
+      name = argument_parser.parse!(argv).fetch(:product)
+
+      Scanner.scan(Product.find(name), options)
+    end
+
+    command :check, "Check if specific product releases are end-of-life" do |argv, opt_parser|
+      options = {max_eol_date: Date.today}
+      opt_parser.banner = "Usage: end_of_life check PRODUCT@VERSION PRODUCT2@VERSION... [OPTIONS]"
+      opt_parser.on("--max-eol-days-away NUMBER", "Sets the maximum number of days away a version can be from EOL.") do |days|
+        options[:max_eol_date] = Date.today + days.to_i.abs
+      end
+      opt_parser.parse!(argv)
+
+      argument_parser = ArgumentParser.build do
+        rest :releases, pattern: EndOfLife.products_pattern(suffix: "@"), min: 1
+      end
+      args = argument_parser.parse!(argv)
+
+      Check.run(args[:releases], options)
+    end
+
+    command :help, "Show this help message" do |args, _|
+      io = args.include?("--error") ? $stderr : $stdout
+
+      io.puts <<~HELP
+        Usage: end_of_life COMMAND [OPTIONS]
+
+        Commands:
+        #{summarize_commands}
+
+        Options:
+          -h, --help       Show this help message
+          -v, --version    Show end_of_life version
+
+        Pass -h/--help to commands to see their specific options.
+      HELP
+    end
+
+    command :version, "Show end_of_life version" do
+      puts "end_of_life v#{EndOfLife::VERSION}"
+    end
+
     def call(argv)
-      parse_options(argv)
-        .then { |options| execute_command(options) }
+      find_command(argv).run(argv)
+    rescue ArgumentError, ArgumentParser::ParseError => e
+      abort_with(e.message.capitalize)
     end
 
     private
 
-    def parse_options(argv)
-      Options.from(argv)
+    def find_command(argv)
+      parse_args(argv).then { |args| command(args[:command]) }
     end
 
-    def execute_command(options)
-      case options[:command]
-      when :help
-        puts options[:parser]
-      when :version
-        puts "end_of_life v#{EndOfLife::VERSION}"
-      when :print_error
-        abort error_msg(options[:error])
-      else
-        Scanner.scan(options)
+    def parse_args(argv)
+      argument_parser = ArgumentParser.build do
+        required :command, pattern: {
+          "-h" => :help,
+          "-v" => :version,
+          "--help" => :help,
+          "--version" => :version,
+          **EndOfLife::CLI.commands.to_h { |cmd| [cmd.name, cmd.name] }
+        }
       end
+
+      argument_parser.parse!(argv)
+    end
+
+    def abort_with(message)
+      warn error_msg(message)
+      command(:help).run(["--error"])
+      exit 1
     end
   end
 end

data/lib/end_of_life/helpers/terminal.rb

@@ -26,11 +26,11 @@ module EndOfLife
     end
 
     def paint
-      @paint ||= Pastel.new
+      Pastel.new(enabled: TTY::Color.support?)
     end
 
-    def new_spinner(message, options = {success_mark: paint.green("✔"), error_mark: paint.red("✖")})
-      TTY::Spinner.new("[:spinner] #{message}", options)
+    def new_spinner(message)
+      TTY::Spinner.new("[:spinner] #{message}", success_mark: paint.green("✔"), error_mark: paint.red("✖"))
     end
   end
 end

data/lib/end_of_life/helpers/text.rb

@@ -0,0 +1,11 @@
+module EndOfLife
+  module Helpers::Text
+    def pluralize(count, singular, plural = nil)
+      if count == 1
+        "#{count} #{singular}"
+      else
+        "#{count} #{plural || "#{singular}s"}"
+      end
+    end
+  end
+end

data/lib/end_of_life/helpers/time.rb

@@ -0,0 +1,35 @@
+module EndOfLife
+  module Helpers::Time
+    include Helpers::Text
+
+    def relative_time_in_words(date)
+      days_away = (date - Date.today).to_i
+      return "today" if days_away.zero?
+
+      duration = duration_in_words(days_away.abs)
+
+      if days_away.positive?
+        "in #{duration}"
+      else
+        "#{duration} ago"
+      end
+    end
+
+    private
+
+    def duration_in_words(number_of_days)
+      if number_of_days >= 365
+        years = (number_of_days / 365.0).floor
+        pluralize(years, "year")
+      elsif number_of_days >= 30
+        months = (number_of_days / 30.0).floor
+        pluralize(months, "month")
+      elsif number_of_days >= 14
+        weeks = (number_of_days / 7.0).floor
+        pluralize(weeks, "week")
+      else
+        pluralize(number_of_days, "day")
+      end
+    end
+  end
+end