gitmarshal 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d90917df2e1981597d8b13ed42de81a096e70afdb82c9861659d14d1bfa7fe06
-  data.tar.gz: 90a6709426c96fc7799d14ff700540e295206463cd7e2ee29f06088f55b01185
+  metadata.gz: 9bc50deb927f02f10f347bbd1bc95f5d20c072418b802a5092793b2366766e98
+  data.tar.gz: '06686a6845fa97a86fd42097ed14e8770c047a65a36c56be3487fc6eb88b0cc7'
 SHA512:
-  metadata.gz: 7e90700eac894369e3bfe07fef83cbb2515e58d8db30b37667b3aadcd8e15ff180750b4b99081ac6c71ecf6ec74e66f7af2880a4503a31e9b52c93d11f93f18f
-  data.tar.gz: 2c09785145ab76e52124c0ab1edd67313159ed1371c6d3bb60608ad4194dfd98022186c5c2da8fdc7c219a814f4bd266389363ab47ecebdabd1ff788ce11f77f
+  metadata.gz: 98df05341cf9c9bdda1bfbf7164ddb08642c2d5d38563c9e9c5edc92e98fce97421d2caae599b396b78c681660313029afeebfac3b96ef003e624871675dd54f
+  data.tar.gz: b57340f5c83b753e6d95af988236a5120d199e5912fa7ee07ae666ea9fbaf4e463815b65584c8d38bcc2dc14c529baedff75d6e621b387d7ad71b20c06446cc1

data/README.md

@@ -2,11 +2,6 @@
   GitMarshal
 </h1>
 
-<p align="center">
-  <img src="https://github.com/nagstler/gitmarshal/assets/1298480/b488174b-7a33-4932-ada8-1b34f641b2a5.gif" alt="animated" />
-</p>
-
-
 <p align="center">
 GitMarshal is a command-line interface (CLI) to extract and display various statistics about GitHub repositories. The metrics it retrieves include the number of commits, pull requests, issues, stars, and contributors.
 Whether you're a developer interested in the activity of a repository or a manager tracking the progress of your project, GitMarshal provides an easy way to fetch this data directly from your command line.
@@ -116,6 +111,8 @@ To fetch and display a summary of all your GitHub repositories, run:
 gitmarshal
 ```
 
+![list-all](https://github.com/nagstler/gitmarshal/assets/1298480/e9f25862-dca6-42e2-9089-25859fe3fab0)
+
 This will provide you with a comprehensive list of your repositories and will show the number of issues, stars, and forks for each repository.
 
 ### Fetch Metrics for a Specific Repository
@@ -126,17 +123,32 @@ To fetch and display overall metrics for a specific repository, use:
 gitmarshal repo-name
 ```
 
+![repo-metrics](https://github.com/nagstler/gitmarshal/assets/1298480/d30e9a1c-9c63-4d28-824e-4c73a95997a7)
+
 Replace `repo-name` with the name of the repository for which you wish to fetch metrics. 
 
-### Fetch Today's Metrics for a Specific Repository
+### Available Options
+
+#### `-t`
+
+Fetch Today's Metrics
+
+```bash
+gitmarshal repo-name -t
+```
+
+![today](https://github.com/nagstler/gitmarshal/assets/1298480/45b62c48-4c01-46e7-9180-5f6b63046df9)
+
+
+#### `-ch` 
 
-To fetch and display metrics for a specific repository for today only, use:
+Fetch Commit History 
 
 ```bash
-gitmarshal repo-name --today
+gitmarshal repo-name -ch
 ```
 
-Replace `repo-name` with the name of the repository for which you wish to fetch today's metrics. 
+![ch](https://github.com/nagstler/gitmarshal/assets/1298480/ae690aab-9625-410a-812f-73a736e13949)
 
 ### Help Command
 

data/lib/gitmarshal/cli.rb

@@ -1,12 +1,14 @@
 require "thor"
 require "terminal-table"
 require "colorize"
+require "unicode_plot"
 require_relative "github_fetcher"
 
 module GitMarshal
   class CLI < Thor
     class_option :help, type: :boolean, aliases: "-h", desc: "Display usage information"
     class_option :today, type: :boolean, aliases: "-t", desc: 'Display today\'s repository metrics instead of overall metrics'
+    class_option :commit_history, type: :boolean, aliases: "-ch", desc: "Display the commit history of the repository"
 
     desc "repos", "Prints a summary of the authenticated user's GitHub repositories"
 
@@ -40,20 +42,21 @@ module GitMarshal
 
     def help(*)
       rows = []
-      rows << ["gitmarshal", "List all repositories of the authenticated user"]
-      rows << ["gitmarshal repo-name", "Show the overall metrics of the given repository"]
-      rows << ["gitmarshal repo-name --today", "Show today's metrics of the given repository"]
+      rows << ["gitmarshal", " ", "Display all repositories associated with the authenticated user."]
+      rows << ["gitmarshal repo-name", " ", "Display the overall metrics for the specified repository."]
+      rows << ["gitmarshal repo-name", "-t", "Display the current day's metrics for the specified repository."]
+      rows << ["gitmarshal repo-name", "-ch", "Display the commit history grouped by days for the given repository."]
 
       table = Terminal::Table.new :rows => rows
       table.title = "GitMarshal Commands".colorize(:blue).bold
-      table.headings = ["Command", "Description"].map { |i| i.colorize(:magenta).bold }
+      table.headings = ["Command", "Options", "Description"].map { |i| i.colorize(:magenta).bold }
       table.style = { :border_x => "=", :border_i => "x", :alignment => :left }
       puts table
     end
 
     private
 
-    def metrics(repo_name, today_option = false)
+    def metrics(repo_name, today_option = false, commit_history_option = false)
       fetcher = GithubFetcher.new
       user = fetcher.fetch_user
 
@@ -69,6 +72,19 @@ module GitMarshal
         end
         # Display today's metrics in a table
         display_table("Today's Repository Metrics", rows)
+      elsif commit_history_option
+        commit_history = fetcher.fetch_commit_history(user, repo_name)
+
+        # Prepare table rows for commit history
+        rows = commit_history.map do |date, commit_count|
+          [date, commit_count]
+        end
+
+        # Sort rows by date in descending order
+        rows.sort_by! { |row| -Date.parse(row.first).to_time.to_i }
+
+        # Display commit history in a table
+        display_commit_history_table(rows)
       else
         rows = prepare_table_rows(repo)
         # Display latest commit
@@ -88,6 +104,21 @@ module GitMarshal
       text.gsub(/(.{1,#{max_width}})(\s+|\Z)/, "\\1\n")
     end
 
+    def display_commit_history_table(rows)
+      # Limit to last 30 days
+      rows = rows.last(30)
+
+      if rows.size == 0
+        puts "No data found for commits in the last 30 days."
+      else
+        dates = rows.map { |row| row[0] }
+        commit_counts = rows.map { |row| row[1] }
+
+        plot = UnicodePlot.barplot(dates, commit_counts, title: "Commit History")
+        puts plot.render
+      end
+    end
+
     def prepare_table_rows_for_today(repo)
       [
         ["Repository Name", repo["name"]],
@@ -133,8 +164,9 @@ module GitMarshal
 
     def method_missing(method, *args, &_block)
       if method =~ /[-a-zA-Z0-9_.]+/
-        today_option = args.include?("--today")
-        metrics(method.to_s, today_option)
+        today_option = args.include?("-t") ? args.include?("-t") : args.include?("--today")
+        commit_history_option = args.include?("-ch") ? args.include?("-ch") : args.include?("--commit-history")
+        metrics(method.to_s, today_option, commit_history_option)
       else
         super
       end

data/lib/gitmarshal/github_fetcher.rb

@@ -23,6 +23,16 @@ class GithubFetcher
     end
   end
 
+  def fetch_commit_history(user, repo_name)
+    commit_history = {}
+    since_date = (Date.today - 30).to_s
+    Octokit.commits_since("#{user}/#{repo_name}", since_date).each do |commit|
+      date = commit.commit.committer.date.to_date.to_s
+      commit_history[date] = commit_history.fetch(date, 0) + 1
+    end
+    commit_history
+  end
+
   def fetch_today_repo_metrics(user, repo_name)
     {
       "name" => repo_name,

data/lib/gitmarshal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitmarshal
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitmarshal
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json