gitmarshal 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1136a825070f9c33c0a3288175c2d1df3bc56c861a2c4612d1e91728b54eff
-  data.tar.gz: 27de3ae232d1d9e8694cb3433f3a3f74853a67a1a5b34987ff9995a872e96b53
+  metadata.gz: 9bc50deb927f02f10f347bbd1bc95f5d20c072418b802a5092793b2366766e98
+  data.tar.gz: '06686a6845fa97a86fd42097ed14e8770c047a65a36c56be3487fc6eb88b0cc7'
 SHA512:
-  metadata.gz: d223482bd2ff8d5b20d62bb98402f974073ab02ca98f845df36b0dea27ab5d2c8c863d90d61c450b5d21430e3ff3e906006a117056cf26bfd1aabcec0dbd9cab
-  data.tar.gz: 967f16553443e6ba49828f2cbabfb8b267784e3b02279540b8c420fc41be227e7eec5d6a79682b798c5990025df8e24c1d0a135b41aebf900bd0a6d7a327ae6f
+  metadata.gz: 98df05341cf9c9bdda1bfbf7164ddb08642c2d5d38563c9e9c5edc92e98fce97421d2caae599b396b78c681660313029afeebfac3b96ef003e624871675dd54f
+  data.tar.gz: b57340f5c83b753e6d95af988236a5120d199e5912fa7ee07ae666ea9fbaf4e463815b65584c8d38bcc2dc14c529baedff75d6e621b387d7ad71b20c06446cc1

data/README.md

@@ -1,9 +1,23 @@
-# GitMarshal
-[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Maintainability](https://api.codeclimate.com/v1/badges/a9c81f4f449374df1e0c/maintainability)](https://codeclimate.com/github/nagstler/gitmarshal/maintainability) [![CI Build](https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml/badge.svg?branch=main)](https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml)
+<h1 align="center">
+  GitMarshal
+</h1>
 
+<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.
+</p>
+
+
+<p align="center">
+  <a href="https://badge.fury.io/rb/gitmarshal"><img src="https://badge.fury.io/rb/gitmarshal.svg" alt="Gem Version"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a>
+  <a href="https://codeclimate.com/github/nagstler/gitmarshal/maintainability"><img src="https://api.codeclimate.com/v1/badges/a9c81f4f449374df1e0c/maintainability" alt="Maintainability"></a>
+  <a href="https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml"><img src="https://github.com/nagstler/gitmarshal/actions/workflows/gem-push.yml/badge.svg?branch=main" alt="CI Build"></a>
+</p>
+
+
+
+
 
 ## :sparkles: Features
 
@@ -28,22 +42,42 @@ Whether you're a developer interested in the activity of a repository or a manag
 - [License](#license)
 
 ## Prerequisites
+### 1. Verify Ruby Installation
 
-Before installing GitMarshal, make sure you have Ruby installed in your system. If you're unsure, you can check this by running the following command in your terminal:
+Before installing GitMarshal, ensure Ruby (version 2.5 or later) is installed on your system. Check your Ruby version using:
 
 ```bash
 ruby -v
 ```
 
-If Ruby is installed, you should see its version. GitMarshal requires Ruby version 2.5 or later.
+### 2. Install Ruby (If Not Installed)
+
+If Ruby is not installed or the version is below 2.5, follow the instructions below to install or upgrade Ruby:
+#### Ubuntu
+
+```bash
+sudo apt-get update
+sudo apt-get install ruby-full
+```
+
+#### MacOS
+
+```bash
+brew install ruby
+```
+
+#### Windows
 
-In addition to Ruby, you will need a GitHub access token to use GitMarshal. Here's how you can generate one: 
-1. Visit the following URL: [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new)
-2. Enter a Note (this can be anything, e.g., "For GitMarshal").
-3. Under "Select scopes", check the "repo" option.
-4. Click on "Generate token" at the bottom.
+Follow the instructions on the [Ruby Installer download page](https://rubyinstaller.org/downloads/) .
+### 3. Generate GitHub Access Token
 
-Remember to save the generated token as you will need it during the configuration step.
+To use GitMarshal, generate a GitHub access token: 
+1. Visit [GitHub Tokens New](https://github.com/settings/tokens/new)
+2. Enter a Note (e.g., "For GitMarshal").
+3. Check the "repo" option under "Select scopes".
+4. Click "Generate token" and save the generated token for configuration.
+
+Now, with Ruby installed and a GitHub token generated, you are ready to install and configure GitMarshal.
 
 ## Installation
 
@@ -52,6 +86,7 @@ GitMarshal can be installed directly as a Ruby gem. To do so, simply run the fol
 ```bash
 gem install gitmarshal
 ```
+
 This command will download and install the GitMarshal gem onto your system.
 
 ## Configuration
@@ -76,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
@@ -86,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/gitmarshal.gemspec

@@ -3,19 +3,19 @@
 require_relative "lib/gitmarshal/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "gitmarshal"
-  spec.version       = Gitmarshal::VERSION
-  spec.authors       = ["Nagendra Dhanakeerthi"]
-  spec.email         = ["nagendra.dhanakeerthi@gmail.com"]
+  spec.name = "gitmarshal"
+  spec.version = Gitmarshal::VERSION
+  spec.authors = ["Nagendra Dhanakeerthi"]
+  spec.email = ["nagendra.dhanakeerthi@gmail.com"]
 
-  spec.summary       = "Command-line tool for fetching and displaying GitHub repository metrics"
-  spec.description   = <<-DESC
+  spec.summary = "Command-line tool for fetching and displaying GitHub repository metrics"
+  spec.description = <<-DESC
     GitMarshal is a command-line tool that allows developers to fetch and display various metrics
     about GitHub repositories. It provides insights into issues, stargazers, forks, commits,
     pull requests, and more.
   DESC
-  spec.homepage      = "https://github.com/nagstler/gitmarshal"
-  spec.license       = "MIT"
+  spec.homepage = "https://github.com/nagstler/gitmarshal"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
@@ -31,14 +31,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json", "~> 2.5"
   spec.add_dependency "thor", "~> 1.1"
   spec.add_dependency "terminal-table", "~> 3.0.0"
-  spec.add_dependency 'colorize', '~> 0.8'
-  spec.add_dependency 'octokit', '~> 4.0'
-  spec.add_dependency 'faraday-retry', '~> 2.0'
+  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_dependency "octokit", "~> 4.0"
+  spec.add_dependency "faraday-retry", "~> 2.0"
 
   # Development Dependencies
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rubocop", "~> 1.22"
-  
+
   spec.post_install_message = <<-MSG
 
 #################################################################
@@ -58,5 +58,4 @@ Enjoy using GitMarshal!
 #################################################################
 
 MSG
-
 end

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"
 
@@ -27,7 +29,7 @@ module GitMarshal
           ]
         end
 
-        table = Terminal::Table.new :title => "Repositories".colorize(:green).bold,
+        table = Terminal::Table.new :title => "Repositories".colorize(:blue).bold,
                                     :headings => ["Name", "Issues", "Stargazers", "Forks"].map { |i| i.colorize(:magenta).bold },
                                     :rows => rows
 
@@ -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(:green).bold
-      table.headings = ['Command', 'Description'].map { |i| i.colorize(:magenta).bold }
+      table.title = "GitMarshal Commands".colorize(:blue).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.1.0"
+  VERSION = "1.3.0"
 end

data/lib/gitmarshal.rb

@@ -4,6 +4,6 @@ require_relative "gitmarshal/version"
 
 module Gitmarshal
   class Error < StandardError; end
-  
-  GITHUB_TOKEN = ENV['GITHUB_TOKEN']
+
+  GITHUB_TOKEN = ENV["GITHUB_TOKEN"]
 end

metadata

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