gem_dating 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 240b4b51a3ff7ea51e8f5133c5980b857656499d37cb9dca2e427f084f5d8e9f
+  data.tar.gz: 3bee7a49cb6cff56b5ca793cd49103c2e16f60a74dcb8c98313e83c4c3bde008
+SHA512:
+  metadata.gz: 350ac78f61900661889eeb66bb3f4ccf9d54d752d8d9034aa910e40827aa3faf0ff8e96c67db75df8a67413e8f18dcdae3359685a45a48d26e68f67133228962
+  data.tar.gz: b03e680f2824c6e8a6a67bc3a8664946e00e5bf881ce1a4977b9e851b5a0596806b55abd6c6272ce737e43c5e499e276e2bb7f3784001c5533c1ad3ffa3cef86

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2.1'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-23
+
+- Initial release
+- Ability to parse a string or file for gems
+- Three output formats: [Gem::Specification], hash, table representation
+- CLI wrapper (thanks @Daniel-N-Huss)

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gem_dating.gemspec
+gemspec
+
+gem "rake"
+gem "minitest"
+gem "standard"
+gem "m"
+gem "mocktail"

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    gem_dating (0.1.0)
+      bundler
+      table_print
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    mocktail (1.2.2)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    table_print (1.5.7)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  gem_dating!
+  m
+  minitest
+  mocktail
+  rake
+  standard
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Steve Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# GemDating
+
+GemDating 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
+
+## Usage
+
+### Installation
+
+`gem install gem_dating` or add it to your Gemfile:
+
+```ruby
+gem 'gem_dating', group: [:development]
+```
+
+### Running GemDating
+
+This gem provides a *very* limited command line interface. It may be invoked with:
+
+```bash
+$ gem_dating [path/to/Gemfile]
+```
+
+Given a path to a Gemfile, GemDating will output a list of gems and their relative ages to the stdout stream.
+
+For example:
+
+```bash
+$ gem_dating ~/code/my_app/Gemfile
+``` 
+to read the output in your terminal.
+
+Or you can run
+```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:
+
+```bash
+NAME        | VERSION | DATE      
+------------|---------|-----------
+rest-client | 2.1.0   | 2019-08-21
+rails       | 7.0.5   | 2023-05-24
+graphql     | 2.0.22  | 2023-05-17
+```
+
+gem_dating also includes some other useable patterns, if you invoke it within an IRB session. It currently supports
+passing in a string of a gem name, or a path to a Gemfile. You can then parse those to an array of `Gem::Specifications`,
+a minimal hash, or the Table output you'd see in the CLI.
+
+```ruby
+# irb 
+# #:001 >
+
+require "gem_dating"
+
+dating = GemDating.from_string("rails")
+
+more_dating = GemDating.from_file("path/to/Gemfile")
+
+
+dating.to_a
+# => [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"}} 
+
+more_dating.table_print
+# => 
+# NAME        | VERSION | DATE
+# ------------|---------|-----------
+# rails       | 7.0.5   | 2023-05-24
+# ...etc
+```
+
+
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem_dating"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gem_dating

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "gem_dating"
+
+exit GemDating::Cli.new(ARGV).run

data/gem_dating.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gem_dating/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem_dating"
+  spec.version       = GemDating::VERSION
+  spec.authors       = ["Steve Jackson", "Daniel Huss"]
+  spec.email         = ["steve@testdouble.com"]
+
+  spec.summary       = "How old is that anyway?"
+  spec.homepage      = "https://github.com/testdouble/gem_dating"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler"
+  spec.add_dependency "table_print"
+end

data/lib/gem_dating/cli.rb

@@ -0,0 +1,23 @@
+module GemDating
+  class Cli
+    SUCCESS = 0
+    GENERAL_ERROR = 1
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      if @argv.empty?
+        $stdout << "Usage: gem_dating [GEMFILE_FILEPATH]\n"
+        return GENERAL_ERROR
+      end
+
+      path = @argv.first
+
+      $stdout << GemDating.from_file(path).table_print << "\n"
+
+      SUCCESS
+    end
+  end
+end

data/lib/gem_dating/input.rb

@@ -0,0 +1,43 @@
+module GemDating
+  class Input
+    def self.string(s)
+      new(s)
+    end
+
+    def self.file(path)
+      new(IO.read(path))
+    end
+
+    attr_reader :contents
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def gems
+      lines = contents.split("\n")
+      lines.each_with_object([]) do |line, gems|
+        line = gem_line(line.strip)
+        gems << cleanup(line) if line
+      end
+    end
+
+    def gem_line(line)
+      return if line.strip == "end"
+
+      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
+        line
+      end
+    end
+
+    def cleanup(line)
+      # "foo",
+      # 'hi'
+      line.strip.chomp(",").chomp("'").chomp('"').delete_prefix("'").delete_prefix('"')
+    end
+  end
+end

data/lib/gem_dating/result.rb

@@ -0,0 +1,28 @@
+require "table_print"
+
+module GemDating
+  class Result
+    attr_reader :specs
+    def initialize(specs)
+      @specs = specs
+    end
+
+    def to_a
+      specs
+    end
+
+    def to_h
+      specs.each_with_object({}) do |spec, result|
+        result[spec.name] = {
+          "name" => spec.name,
+          "version" => spec.version.to_s,
+          "date" => spec.date.strftime("%Y-%m-%d")
+        }
+      end
+    end
+
+    def table_print
+      TablePrint::Printer.table_print(specs, [:name, :version, {date: {time_format: "%Y-%m-%d", width: 10}}]).encode("utf-8")
+    end
+  end
+end

data/lib/gem_dating/rubygems.rb

@@ -0,0 +1,21 @@
+module GemDating
+  class Rubygems
+    def self.fetch(...)
+      new.fetch(...)
+    end
+
+    def fetch(gems)
+      gems.map do |gem|
+        Gem.latest_spec_for(gem) || unknown_version(gem)
+      end
+    end
+
+    def unknown_version(gemname)
+      Gem::Specification.new do |s|
+        s.name = gemname
+        s.version = "0.0.0.UNKNOWN"
+        s.date = "1970-01-01"
+      end
+    end
+  end
+end

data/lib/gem_dating/version.rb

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

data/lib/gem_dating.rb

@@ -0,0 +1,19 @@
+require "gem_dating/version"
+require_relative "gem_dating/input"
+require_relative "gem_dating/rubygems"
+require_relative "gem_dating/result"
+require_relative "gem_dating/cli"
+
+module GemDating
+  def self.from_string(s)
+    gems = Input.string(s).gems
+    specs = Rubygems.fetch(gems)
+    Result.new(specs)
+  end
+
+  def self.from_file(path)
+    gems = Input.file(path).gems
+    specs = Rubygems.fetch(gems)
+    Result.new(specs)
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: gem_dating
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Jackson
+- Daniel Huss
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- steve@testdouble.com
+executables:
+- gem_dating
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gem_dating
+- gem_dating.gemspec
+- lib/gem_dating.rb
+- lib/gem_dating/cli.rb
+- lib/gem_dating/input.rb
+- lib/gem_dating/result.rb
+- lib/gem_dating/rubygems.rb
+- lib/gem_dating/version.rb
+homepage: https://github.com/testdouble/gem_dating
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/testdouble/gem_dating
+  source_code_uri: https://github.com/testdouble/gem_dating
+  changelog_uri: https://github.com/testdouble/gem_dating/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: How old is that anyway?
+test_files: []