gemlens 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e74316581d6c5d398840ca97854991e86a18a84f6e24ff8ac17e060e2878371
-  data.tar.gz: d1224fa3378a9f4bf11800f3c9ed11cfa9f3a0a2002ca0dc92005f5fb1fbb8a8
+  metadata.gz: c6106a3dd7bed953c122eab3044de5e900f07db400c1b3791d4140a3f04ff711
+  data.tar.gz: f62f3c32cc9c7e5da07bf9748aa98e50041a0414549027ceda1d1afaef0b3294
 SHA512:
-  metadata.gz: b80c10dcf884caf541e832d7a36a6a1a4bf5921e4b6893a8f10b6c7ff61c1f19aceb5c421049d4cc20cf5ebb92d2c37fe63d2461cd5d77a848a0494d2500149e
-  data.tar.gz: 26fd74d4b129cc45acb4c2454ebcc19232af7fae38e519c8ce7cf316c5ed66c32869447c9c7edcf01f23e5b6cc20be813b3d0c262b23d74357d0d061e2277354
+  metadata.gz: 20a1273a451de9ecfc6afce47ee3cd8e58c92f066bc0d40406b4f6d44285ed7d24019b37595f60aa0932bf9e0c043aac2692c064f697908857f27676c62cf0b4
+  data.tar.gz: 8d73560c244c6dabd76341148a7586783e7b73900615ce7e95a1fc0ff6ce1974001ea60140595b563a74140ea2261b875ca50454e4914f22df7647f5aed3b124

data/.rubocop.yml

@@ -1,3 +1,36 @@
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 30
+  Details: >
+    Code that involves a lot of branches can be very hard to wrap your head
+    around.
+
+Metrics/ClassLength:
+  Max: 110
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 30
+  Details: >
+    Long methods can be very hard to review. Consider splitting this method up
+    into separate methods.
+
+Metrics/ParameterLists:
+  Max: 6
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 14
+  Description: >
+    A complexity metric geared towards measuring complexity for a
+    human reader.
+
+Style/Documentation:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -5,6 +38,3 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/README.md

@@ -1,5 +1,7 @@
 # GemLens
 
+[![Gem Version](https://badge.fury.io/rb/gemlens.svg)](https://rubygems.org/gems/gemlens)
+
 **Gemlens** is a CLI tool to analyze the evolution of your `Gemfile` over time. It helps you track when gems were added, removed, or updated in a project — great for audits, debugging, or historical exploration.
 
 ---

data/bin/gemlens

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #!/usr/bin/env ruby
 
 require "bundler/setup"

data/gemlens.gemspec

@@ -3,15 +3,18 @@
 require_relative "lib/gemlens/version"
 
 Gem::Specification.new do |s|
-  s.name          = "gemlens"
-  s.version       = Gemlens::VERSION
-  s.authors       = ["Fai Wong"]
-  s.email         = ["wongwf82@gmail.com"]
+  s.name = "gemlens"
+  s.version = Gemlens::VERSION
+  s.authors = ["Fai Wong"]
+  s.email = ["wongwf82@gmail.com"]
 
-  s.summary     = "Track and visualize changes to your Gemfile over time."
-  s.description = "GemLens is a developer tool that analyzes the history of your Gemfile using Git and presents a timeline of gem additions, removals, and version updates. It's useful for auditing dependency changes, generating changelogs, and understanding how your project's gem dependencies evolved. Built for maintainers, teams, and curious developers."
-  s.license       = "MIT"
-  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  s.summary = "Track and visualize changes to your Gemfile over time."
+  s.description = "GemLens is a developer tool that analyzes the history of your Gemfile using Git " \
+                  "and presents a timeline of gem additions, removals, and version updates. It's useful " \
+                  "for auditing dependency changes, generating changelogs, and understanding how your " \
+                  "project's gem dependencies evolved."
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.4.0"
 
   s.homepage = "https://github.com/BestBitsLab/gemlens"
   s.metadata["source_code_uri"] = "https://github.com/BestBitsLab/gemlens"
@@ -21,8 +24,8 @@ Gem::Specification.new do |s|
   s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  s.bindir        = "bin"
-  s.executables   = s.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  s.bindir = "bin"
+  s.executables = s.files.grep(%r{\Abin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency "colorize", "~> 1.1.0"

data/lib/gemlens/history.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "date"
 require "json"
 require "open3"
@@ -5,7 +7,7 @@ require "colorize"
 require "yaml"
 
 module Gemlens
-  GEMS_YML_PATH = File.expand_path("../../../data/gems.yml", __FILE__)
+  GEMS_YML_PATH = File.expand_path("../../data/gems.yml", __dir__)
   GEMS_YML = File.exist?(GEMS_YML_PATH) ? YAML.load_file(GEMS_YML_PATH) : []
 
   GEM_TO_REPOS = GEMS_YML.each_with_object({}) do |entry, hash|
@@ -17,91 +19,119 @@ module Gemlens
       @repo_path = repo_path
     end
 
-    def gemfile_commits
-      Dir.chdir(@repo_path) do
-        unless system("git rev-parse HEAD > /dev/null 2>&1")
-          puts "⚠️  No commits found in the repository yet.".colorize(:yellow)
-          return []
-        end
+    def analyze
+      return not_enough_history if gemfile_commits.size < 2
 
-        `git log --follow --format="%H|%an|%ad|%s" --date=iso Gemfile`.lines.map do |line|
-          sha, author, date, message = line.strip.split("|", 4)
+      history = Hash.new { |h, k| h[k] = [] }
 
-          # Extract PR number if present
-          pr = message[/(?:#|PR\s*)(\d+)/i, 1]
+      gemfile_commits.reverse.each_cons(2) do |older, newer|
+        before = parse_gemfile_at(older[:sha])
+        after  = parse_gemfile_at(newer[:sha])
 
-          {
-            sha: sha,
-            author: author,
-            date: DateTime.parse(date),
-            message: message.strip,
-            pr: pr
-          }
-        end
+        process_changes(before, after, newer, history)
       end
+
+      history
     end
 
-    def parse_gemfile_at(commit_sha)
-      content = Dir.chdir(@repo_path) do
-        `git show #{commit_sha}:Gemfile`
-      end
+    def not_enough_history
+      puts "📘 Only one commit related to Gemfile found. Not enough history to analyze changes.".colorize(:light_blue)
+      {}
+    end
 
-      gems = {}
-      content.each_line do |line|
-        if line =~ /^\s*gem\s+["']([^"']+)["'](?:\s*,\s*["']([^"']+)["'])?/
-          name = $1
-          version = $2
-          gems[name] = version
-        end
+    def process_changes(before, after, commit, history)
+      added   = after.keys - before.keys
+      removed = before.keys - after.keys
+      common  = before.keys & after.keys
+
+      handle_added(added, after, commit, history)
+      handle_removed(removed, before, commit, history)
+      handle_updated(common, before, after, removed, commit, history)
+    end
+
+    def handle_added(added, after, commit, history)
+      added.each do |gem_name|
+        history[gem_name] << build_event(
+          "added", gem_name,
+          commit.merge(version: after[gem_name])
+        )
       end
-      gems
     end
 
-    def analyze
-      history = Hash.new { |h, k| h[k] = [] }
+    def handle_removed(removed, before, commit, history)
+      removed.each do |gem_name|
+        history[gem_name] << build_event(
+          "removed", gem_name,
+          commit.merge(version: before[gem_name])
+        )
+      end
+    end
 
-      if gemfile_commits.size < 2
-        puts "📘 Only one commit related to Gemfile found. Not enough history to analyze changes.".colorize(:light_blue)
-        return history
+    def handle_updated(common, before, after, removed, commit, history)
+      updated = common.select do |gem_name|
+        before[gem_name] != after[gem_name] && !removed.include?(gem_name)
       end
 
-      gemfile_commits.reverse.each_cons(2) do |older, newer|
-        before = parse_gemfile_at(older[:sha])
-        after  = parse_gemfile_at(newer[:sha])
+      updated.each do |gem_name|
+        history[gem_name] << build_event(
+          "updated", gem_name,
+          commit.merge(
+            version_from: before[gem_name],
+            version_to: after[gem_name]
+          )
+        )
+      end
+    end
 
-        added   = after.keys - before.keys
-        removed = before.keys - after.keys
-        common  = before.keys & after.keys
+    def gemfile_commits
+      return [] unless valid_git_repo?
 
-        added.each do |gem_name|
-          history[gem_name] << build_event("added", gem_name, newer.merge(version: after[gem_name]))
-        end
+      Dir.chdir(@repo_path) do
+        parse_git_log(`git log --follow --format="%H|%an|%ad|%s" --date=iso Gemfile`)
+      end
+    end
 
-        # Only gems that exist in both and changed version count as updated
-        updated = common.select do |gem_name|
-          before[gem_name] != after[gem_name]
+    def valid_git_repo?
+      Dir.chdir(@repo_path) do
+        system("git rev-parse HEAD > /dev/null 2>&1") || begin
+          puts "⚠️  No commits found in the repository yet.".colorize(:yellow)
+          false
         end
+      end
+    end
 
-        removed.each do |gem_name|
-          history[gem_name] << build_event("removed", gem_name, newer.merge(
-            version: before[gem_name]
-          ))
-        end
+    def parse_git_log(log_output)
+      log_output.lines.map do |line|
+        sha, author, date, message = line.strip.split("|", 4)
+        pr = message[/(?:#|PR\s*)(\d+)/i, 1]
 
-        updated -= removed
+        {
+          sha: sha,
+          author: author,
+          date: DateTime.parse(date),
+          message: message.strip,
+          pr: pr
+        }
+      end
+    end
 
-        updated.each do |gem_name|
-          history[gem_name] << build_event("updated", gem_name, newer.merge(
-            version_from: before[gem_name],
-            version_to:   after[gem_name]
-          ))
-        end
+    def parse_gemfile_at(commit_sha)
+      content = Dir.chdir(@repo_path) do
+        `git show #{commit_sha}:Gemfile`
       end
 
-      history
+      gems = {}
+      content.each_line do |line|
+        next unless (match = line.match(/^\s*gem\s+["'](?<name>[^"']+)["'](?:\s*,\s*["'](?<version>[^"']+)["'])?/))
+
+        name = match[:name]
+        version = match[:version]
+        gems[name] = version
+      end
+      gems
     end
 
-    def build_event(action, gem_name, commit)
+    def build_event(action, _gem_name, commit)
       {
         action: action,
         by: commit[:author],
@@ -125,8 +155,7 @@ module Gemlens
     end
   end
 
-  def self.print_timeline(history)
-    puts "\n📜 Gemfile History Timeline\n\n"
+  def self.flatten_and_sort(history)
     flattened = history.flat_map do |gem, events|
       events.map do |e|
         {
@@ -144,37 +173,66 @@ module Gemlens
           repo: e[:repo]
         }
       end
-    end.sort_by { |e| e[:date] }
-
-    flattened.each do |e|
-      label = e[:action].capitalize.ljust(8)
-
-      version_str =
-        if e[:action] == "updated" && e[:version_from] && e[:version_to]
-          " (#{e[:version_from]} → #{e[:version_to]})"
-        elsif e[:version]
-          " (#{e[:version]})"
-        else
-          ""
-        end
+    end
+
+    flattened.sort_by { |e| e[:date] }
+  end
 
-      gem_label = case e[:action]
-                  when "added"   then (e[:gem] + version_str).ljust(20).colorize(:green)
-                  when "removed" then (e[:gem] + version_str).ljust(20).colorize(:red)
-                  when "updated" then (e[:gem] + version_str).ljust(20).colorize(:blue)
-                  else                (e[:gem] + version_str).ljust(20)
-                  end
-
-      pr_info = if e[:pr]
-                  "PR ##{e[:pr].rjust(4)}"
-                elsif e[:sha]
-                  e[:sha][0..6]
-                else
-                  "—"
-                end
-
-      puts "#{color_tag(e[:action])} #{e[:date].strftime('%Y-%m-%d')}  " \
-           "#{label} #{gem_label} by #{e[:author].ljust(10)} ➜ #{pr_info} | #{e[:message]}"
+  def self.format_event_line(event)
+    [
+      color_tag(event[:action]),
+      event[:date].strftime("%Y-%m-%d"),
+      format_label(event),
+      format_gem(event),
+      "by #{event[:author].ljust(10)}",
+      "➜ #{format_pr(event)}",
+      "| #{event[:message]}"
+    ].join(" ").strip
+  end
+
+  def self.format_label(event)
+    event[:action].capitalize.ljust(8)
+  end
+
+  def self.format_gem(event)
+    version_str = format_version(event)
+    text = (event[:gem] + version_str).ljust(20)
+    colorize_by_action(text, event[:action])
+  end
+
+  def self.format_version(event)
+    if event[:action] == "updated" && event[:version_from] && event[:version_to]
+      " (#{event[:version_from]} → #{event[:version_to]})"
+    elsif event[:version]
+      " (#{event[:version]})"
+    else
+      ""
+    end
+  end
+
+  def self.colorize_by_action(text, action)
+    case action
+    when "added"   then text.colorize(:green)
+    when "removed" then text.colorize(:red)
+    when "updated" then text.colorize(:blue)
+    else text
+    end
+  end
+
+  def self.format_pr(event)
+    if event[:pr]
+      "PR ##{event[:pr].rjust(4)}"
+    elsif event[:sha]
+      event[:sha][0..6]
+    else
+      "—"
+    end
+  end
+
+  def self.print_timeline(history)
+    puts "\n📜 Gemfile History Timeline\n\n"
+    flatten_and_sort(history).each do |e|
+      puts format_event_line(e)
     end
   end
 

data/lib/gemlens/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemlens
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fai Wong
@@ -27,8 +27,7 @@ dependencies:
 description: GemLens is a developer tool that analyzes the history of your Gemfile
   using Git and presents a timeline of gem additions, removals, and version updates.
   It's useful for auditing dependency changes, generating changelogs, and understanding
-  how your project's gem dependencies evolved. Built for maintainers, teams, and curious
-  developers.
+  how your project's gem dependencies evolved.
 email:
 - wongwf82@gmail.com
 executables:
@@ -41,7 +40,6 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- 1git
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -69,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/1git

@@ -1,6 +0,0 @@
-fatal: ambiguous argument 'log': unknown revision or path not in the working tree.
-Use '--' to separate paths from revisions, like this:
-'git <command> [<revision>...] -- [<file>...]'
-fatal: ambiguous argument 'log': unknown revision or path not in the working tree.
-Use '--' to separate paths from revisions, like this:
-'git <command> [<revision>...] -- [<file>...]'