end_of_life 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66851fa78b32b4451ef40ef58f02c25386f6badd5d216a8bd360ed0dba84feed
-  data.tar.gz: 2f0c53b0a7d125b7ed0b408501a9a754c846b8d84e45821f70dd07ae1de13c1c
+  metadata.gz: 5e058c01c970e9fde4fdceeabde71c29a623374ef989987d5b5ab10e1e247ca4
+  data.tar.gz: 58adcd9c3aa9fbf64b1adb7a7f2f68d1d551ee41925ff9f06c03ce9e21298448
 SHA512:
-  metadata.gz: 0cfee4bc90cae86ebb57baa7d48b1aa4cc4f9a521effffc4e0cbea29029fbcdfafd5a09b219639b30ae688792030102f91011b0960899d56a1e8e4aee4583f8d
-  data.tar.gz: b2a3556b924c0fbfb8968ef8ff2c64359b9b66f2659acef55442a3579d35a3877a8805ae4f62192be5d9f3a3d1ea5a91fa0413a9ebf96386d86d4564ec2c7df4
+  metadata.gz: 87d59b8b0d1aa556bf0b2bc7295a617fe5890bb0056437c7728d497468a05df6b57150f13680ac0be0ae9a400d40d02dac05331a5999d59943bcce7821d767f9
+  data.tar.gz: 38acbd80942af304503ec510b666f2b18ce1de8a728d92254c5fd3acd1393d6eadeb3c8e24aa1de242bc6a7f5243226a446a11e529c03d5e6443adcd571408a6

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-01-07
+### Added
+
+- Allow searching a specific repository.
+
+```sh
+$ end_of_life --repo=MatheusRich/ez_attributes
+```
+
+- Allow specifying the user used on the repository search.
+
+```sh
+$ end_of_life --user=matz # searches on matz's repositories
+```
+
+### Fixed
+
+- Load end_of_life JSON database from dynamic path [#10](https://github.com/MatheusRich/end_of_life/pull/10).
+
+  When installed on a fresh Ruby installation without the source code cloned,
+  the JSON file couldn't be found because it was looking at the cwd of the
+  running process instead of the Gem's lib directory path.
+
+### Changed
+
+- Exit with -1 if EOL repos are present.
+
+- Upgrade `octokit` to v4.22, which fixes [a Faraday warning], so we can remove the dependency on the `warning` gem.
+
+[a faraday warning]: https://github.com/octokit/octokit.rb/pull/1359
+
+## [0.1.0] - 2022-01-17
 
 - Initial release
+
+[unreleased]: https://github.com/MatheusRich/end_of_life/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/MatheusRich/end_of_life/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    end_of_life (0.1.0)
+    end_of_life (0.2.0)
       dry-monads (~> 1.3)
       octokit (~> 4.0)
       pastel (~> 0.8.0)
       tty-spinner (~> 0.9.0)
       tty-table (~> 0.12.0)
-      warning (~> 1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -48,7 +47,7 @@ GEM
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
     multipart-post (2.1.1)
-    octokit (4.21.0)
+    octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.21.0)
@@ -118,7 +117,6 @@ GEM
       tty-screen (~> 0.8)
     unicode-display_width (2.1.0)
     unicode_utils (1.4.0)
-    warning (1.2.1)
 
 PLATFORMS
   x86_64-darwin-20

data/README.md

@@ -1,7 +1,9 @@
-# End Of Life
+# End of Life
 
 This gem lists GitHub repositories using end-of-life Ruby versions.
 
+![End of Life Demo](demo.gif)
+
 ## Installation
 
 ```sh

data/end_of_life.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors = ["Matheus Richard"]
   spec.email = ["matheusrichardt@gmail.com"]
 
-  spec.summary = "Lists repositories using end-of-life Ruby versions"
+  spec.summary = "Lists repositories using end-of-life Ruby versions."
   spec.description = "Searches your GitHub repositores and lists the ones using end-of-life, i.e. " \
-                     "unmaintained, Ruby versions"
+                     "unmaintained, Ruby versions."
   spec.homepage = "https://github.com/MatheusRich/end_of_life"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.7.0"
@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monads", "~> 1.3"
   spec.add_dependency "tty-spinner", "~> 0.9.0"
   spec.add_dependency "tty-table", "~> 0.12.0"
-  spec.add_dependency "warning", "~> 1.2.1"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/end_of_life/repository.rb

@@ -5,19 +5,23 @@ module EndOfLife
     class << self
       include Dry::Monads[:result, :maybe]
 
-      def fetch(language:, user: nil)
-        github_client.fmap do |github|
+      def fetch(language:, user:, repository: nil)
+        github_client.bind do |github|
           user ||= github.user.login
-          response = github.search_repositories("user:#{user} language:#{language}", per_page: 100)
+          query = search_query_for(language: language, user: user, repository: repository)
+
+          response = github.search_repositories(query, per_page: 100)
           warn "Incomplete results: we only search 100 repos at a time" if response.incomplete_results
 
-          response.items.map do |repo|
-            Repository.new(
-              full_name: repo.full_name,
-              url: repo.html_url,
-              github_client: github
-            )
-          end
+          Success(
+            response.items.map do |repo|
+              Repository.new(
+                full_name: repo.full_name,
+                url: repo.html_url,
+                github_client: github
+              )
+            end
+          )
         rescue => e
           Failure("Unexpected error: #{e}")
         end
@@ -29,6 +33,17 @@ module EndOfLife
           .fmap { |token| Octokit::Client.new(access_token: token) }
           .or { Failure("Please set GITHUB_TOKEN environment variable") }
       end
+
+      def search_query_for(language:, user:, repository:)
+        query = "language:#{language}"
+        query += if repository
+          " repo:#{repository}"
+        else
+          " user:#{user}"
+        end
+
+        query
+      end
     end
 
     attr :full_name, :url

data/lib/end_of_life/ruby_version.rb

@@ -1,10 +1,13 @@
+require "rubygems"
 require_relative "ruby_version/parser"
 
 module EndOfLife
   class RubyVersion
     include Comparable
 
-    EOL = File.read("lib/end_of_life.json")
+    DB_PATH = File.join(__dir__, "../end_of_life.json")
+
+    EOL = File.read(DB_PATH)
       .then { |json| JSON.parse(json, symbolize_names: true) }
       .filter { |version| Date.parse(version[:eol]) <= Date.today }
       .map { |version| Gem::Version.new(version[:latest]) }

data/lib/end_of_life/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EndOfLife
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/end_of_life.rb

@@ -2,7 +2,7 @@
 
 require "json"
 require "octokit"
-require "warning"
+require "optparse"
 require_relative "end_of_life/repository"
 require_relative "end_of_life/ruby_version"
 require_relative "end_of_life/terminal_helper"
@@ -11,23 +11,70 @@ require_relative "end_of_life/version"
 module EndOfLife
   extend TerminalHelper
 
-  Warning.ignore(/Faraday::Connection#authorization/)
-
   class CLI
     include TerminalHelper
 
     def call(argv)
-      fetch_repositories
+      parse_options(argv)
+        .then { |options| execute_command(options) }
+    end
+
+    private
+
+    def execute_command(options)
+      case options[:command]
+      when :help
+        puts options[:parser]
+      when :version
+        puts "end_of_life v#{EndOfLife::VERSION}"
+      when :print_error
+        puts error_msg(options[:error])
+        exit(-1)
+      else
+        check_eol_ruby_on_repositories(options)
+      end
+    end
+
+    def check_eol_ruby_on_repositories(options)
+      fetch_repositories(user: options[:user], repository: options[:repository])
         .fmap { |repositories| filter_repositories_with_end_of_life(repositories) }
         .fmap { |repositories| print_diagnose_for(repositories) }
         .or { |error| puts "\n#{error_msg(error)}" }
     end
 
-    private
+    def parse_options(argv)
+      options = {}
+
+      OptionParser.new do |opts|
+        options[:parser] = opts
+
+        opts.banner = "Usage: end_of_life [options]"
+
+        opts.on("--repo=USER/REPO", "--repository=USER/REPO", "Searches a specific repostory") do |repository|
+          options[:repository] = repository
+        end
+
+        opts.on("-u NAME", "--user=NAME", "Sets the user used on the repository search") do |user|
+          options[:user] = user
+        end
+
+        opts.on("-v", "--version", "Displays end_of_life version") do
+          options[:command] = :version
+        end
+
+        opts.on("-h", "--help", "Displays this help") do
+          options[:command] = :help
+        end
+      end.parse!(argv)
+
+      options
+    rescue OptionParser::ParseError => e
+      {command: :print_error, error: e}
+    end
 
-    def fetch_repositories
+    def fetch_repositories(user:, repository:)
       with_loading_spinner("Fetching repositories...") do |spinner|
-        result = Repository.fetch(language: "ruby")
+        result = Repository.fetch(language: "ruby", user: user, repository: repository)
 
         spinner.error if result.failure?
 
@@ -51,6 +98,7 @@ module EndOfLife
 
       puts "Found #{repositories.size} repositories using EOL Ruby (<= #{RubyVersion::EOL}):"
       puts end_of_life_table(repositories)
+      exit(-1)
     end
 
     def end_of_life_table(repositories)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: end_of_life
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matheus Richard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -80,22 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: warning
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 description: Searches your GitHub repositores and lists the ones using end-of-life,
-  i.e. unmaintained, Ruby versions
+  i.e. unmaintained, Ruby versions.
 email:
 - matheusrichardt@gmail.com
 executables:
@@ -115,6 +101,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- demo.gif
 - end_of_life.gemspec
 - exe/end_of_life
 - exe/eol
@@ -150,5 +137,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Lists repositories using end-of-life Ruby versions
+summary: Lists repositories using end-of-life Ruby versions.
 test_files: []