gem_dating 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240b4b51a3ff7ea51e8f5133c5980b857656499d37cb9dca2e427f084f5d8e9f
-  data.tar.gz: 3bee7a49cb6cff56b5ca793cd49103c2e16f60a74dcb8c98313e83c4c3bde008
+  metadata.gz: ebf7931775d179eea359a6c01e14d3a194a4de2071d32bafbc9571a244459eb0
+  data.tar.gz: 9b24ce47c704e0184cdb426828b8af87171fa7097f268a83ac02992c43131e26
 SHA512:
-  metadata.gz: 350ac78f61900661889eeb66bb3f4ccf9d54d752d8d9034aa910e40827aa3faf0ff8e96c67db75df8a67413e8f18dcdae3359685a45a48d26e68f67133228962
-  data.tar.gz: b03e680f2824c6e8a6a67bc3a8664946e00e5bf881ce1a4977b9e851b5a0596806b55abd6c6272ce737e43c5e499e276e2bb7f3784001c5533c1ad3ffa3cef86
+  metadata.gz: c4284c4873a6e5ec38181b7a09f0ac66830831b7cfe3513b3f30ab3aa8b477825608cb42d3c529f32fa47c3487c6e9bda7a57c303921d26a6f7deca53d8bfab6
+  data.tar.gz: c975b8fb6164e3f99c9049bc59b92d5456b33c2370f91ac32b86539d3227b71646d6648975d6764bd0eb19a56e7575e22ad882c415ef8cf26b9bf47e4904a5fa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gem_dating (0.1.0)
+    gem_dating (0.1.1)
       bundler
       table_print
 
@@ -56,6 +56,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   arm64-darwin-22
   x86_64-linux
 

data/README.md

@@ -1,47 +1,53 @@
 # GemDating
 
-GemDating is a library for determining the relative age of a set of gems.
+`gem_dating` is a library for determining the relative age of a set of gems.
 
-The primary use case is when evaluating a codebase for upgrades - a gem from 2017 may effectively be abandoned and could
-cause trouble if you're targeting an upgrade to Ruby 4.1
+The primary use case is when evaluating a codebase for upgrades - a gem from 2017 may effectively be abandoned and could cause trouble if you're targeting an upgrade to Ruby 4.1
+
+`gem_dating` avoids utilizing Bundler, and intends to be useful where you want to evaluate a set of gems without
+the overhead of a full bundle install. If you've got a valid bundle you should consider the built in
+[bundle-outdated](https://bundler.io/v2.4/man/bundle-outdated.1.html), or other available tools for interacting
+with your Gemfile, like [libyear-bundler](https://github.com/jaredbeck/libyear-bundler).
 
 ## Usage
 
-### Installation
+If you have rubygems 3.4.8 or later installed, you can skip installation and just run via `gem exec gem_dating [[path/to/Gemfile]`
+
+
+### Gem Installation
 
 `gem install gem_dating` or add it to your Gemfile:
 
 ```ruby
-gem 'gem_dating', group: [:development]
+gem 'gem_dating', group: [:development], require: false
 ```
 
 ### Running GemDating
 
-This gem provides a *very* limited command line interface. It may be invoked with:
+This gem provides a small command line interface. It may be invoked with:
 
 ```bash
-$ gem_dating [path/to/Gemfile]
+$ gem_dating
 ```
 
-Given a path to a Gemfile, GemDating will output a list of gems and their relative ages to the stdout stream.
+By default, GemDating will look for a Gemfile in the current directory.
+If it finds one, it will output a list of gems and their relative ages to the stdout stream.
 
-For example:
+You may also pass a path to a Gemfile as an argument:
 
 ```bash
 $ gem_dating ~/code/my_app/Gemfile
 ``` 
-to read the output in your terminal.
 
-Or you can run
+GemDating leans on `$stdout`, so you can pipe the output to a file if you'd like:
 ```bash
 $ gem_dating ~/code/my_app/Gemfile > ~/code/my_app/gem_ages.txt
 ```
-which will pipe the output into a text file. 
 
-The command line output will look something like this:
+[TablePrint](https://github.com/arches/table_print) formats the output to something like this:
 
 ```bash
-NAME        | VERSION | DATE      
+NAME        | VERSION | DATE
 ------------|---------|-----------
 rest-client | 2.1.0   | 2019-08-21
 rails       | 7.0.5   | 2023-05-24
@@ -53,7 +59,7 @@ passing in a string of a gem name, or a path to a Gemfile. You can then parse th
 a minimal hash, or the Table output you'd see in the CLI.
 
 ```ruby
-# irb 
+# irb
 # #:001 >
 
 require "gem_dating"
@@ -64,16 +70,16 @@ more_dating = GemDating.from_file("path/to/Gemfile")
 
 
 dating.to_a
-# => [Gem::Specification.new do |s|                               
+# => [Gem::Specification.new do |s|
 # s.name = "rails"
 # s.version = Gem::Version.new("7.0.5")
 # s.installed_by_version = Gem::Version.new("0") ...etc
 
 dating.to_h
-# =>  {"rails"=>{"name"=>"rails", "version"=>"7.0.5", "date"=>"2023-05-24"}} 
+# =>  {"rails"=>{"name"=>"rails", "version"=>"7.0.5", "date"=>"2023-05-24"}}
 
 more_dating.table_print
-# => 
+# =>
 # NAME        | VERSION | DATE
 # ------------|---------|-----------
 # rails       | 7.0.5   | 2023-05-24

data/lib/gem_dating/cli.rb

@@ -3,19 +3,42 @@ module GemDating
     SUCCESS = 0
     GENERAL_ERROR = 1
 
-    def initialize(argv)
-      @argv = argv
+    HELP_TEXT =
+      <<~HELP
+        gem_dating [--help | -h] [<GEMFILE_FILEPATH>]
+
+        GEMFILE_FILEPATH defaults to ./Gemfile if not provided.
+
+        Options:
+          --help, -h  Show this help message
+      HELP
+
+    def initialize(argv = [])
+      args, file_path = argv.partition { |arg| (arg =~ /--\w+/) || (arg =~ /(-[a-z])/) }
+
+      @args = args
+      @file_path = file_path.first
     end
 
     def run
-      if @argv.empty?
-        $stdout << "Usage: gem_dating [GEMFILE_FILEPATH]\n"
-        return GENERAL_ERROR
+      if (@args & ['-h', '--help']).any?
+        $stdout << HELP_TEXT
+        return SUCCESS
       end
 
-      path = @argv.first
+      unless @file_path
+        current_directory = Dir.pwd
+        file_path = File.join(current_directory, "Gemfile")
+
+        if File.exist?(file_path)
+          @file_path = file_path
+        else
+          $stdout << HELP_TEXT
+          return GENERAL_ERROR
+        end
+      end
 
-      $stdout << GemDating.from_file(path).table_print << "\n"
+      $stdout << GemDating.from_file(@file_path).table_print << "\n"
 
       SUCCESS
     end

data/lib/gem_dating/input.rb

@@ -19,17 +19,18 @@ module GemDating
       lines.each_with_object([]) do |line, gems|
         line = gem_line(line.strip)
         gems << cleanup(line) if line
-      end
+      end.uniq
     end
 
     def gem_line(line)
-      return if line.strip == "end"
+      single_word_ruby_statements = %w{end else # gemspec}
+      return if single_word_ruby_statements.include? line.strip
 
       if line.start_with? "gem("
         line.split("(")[1].split(",")[0]
       elsif line.start_with? "gem"
         line.split[1].split(",")[0]
-      elsif line.split.length == 1
+      elsif line.split.length == 1 # match "just" gemname
         line
       end
     end

data/lib/gem_dating/version.rb

@@ -1,3 +1,3 @@
 module GemDating
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_dating
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steve Jackson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: How old is that anyway?