gitmarshal 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351dad1ba766260604fdb167d697a209b9d2b4ad45782f7bf3b738520541ce31
-  data.tar.gz: 1980015eef8a3cc130ec2eb6b20d56736b78c8a2ab5e3e85c01281de239a205c
+  metadata.gz: 9d1136a825070f9c33c0a3288175c2d1df3bc56c861a2c4612d1e91728b54eff
+  data.tar.gz: 27de3ae232d1d9e8694cb3433f3a3f74853a67a1a5b34987ff9995a872e96b53
 SHA512:
-  metadata.gz: 594847b1f1427ec8bdc359475090cb71faa23e27224f9032c16341c9bb6d58b6b66ee39b278226f78cc9844a090875f04c7de700792d1759425edd55d1aba6de
-  data.tar.gz: 50404ba54d11d352929f646c40e77f19eaf2af86a399bf4bf7d0b1ba3c74306fb07b6617b1ff5bb8e7d20c39903f9ad0966f6f25cd1b764bab37c59ce5f43614
+  metadata.gz: d223482bd2ff8d5b20d62bb98402f974073ab02ca98f845df36b0dea27ab5d2c8c863d90d61c450b5d21430e3ff3e906006a117056cf26bfd1aabcec0dbd9cab
+  data.tar.gz: 967f16553443e6ba49828f2cbabfb8b267784e3b02279540b8c420fc41be227e7eec5d6a79682b798c5990025df8e24c1d0a135b41aebf900bd0a6d7a327ae6f

data/README.md

@@ -1,17 +1,21 @@
 # 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)
+[![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)
 
 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.
 
-## Features
+## :sparkles: Features
 
-- Fetch and display a summary of your GitHub repositories.
-- Fetch and display detailed metrics for a specific repository, including number of commits, pull requests, issues, stars, and contributors.
-- Easy-to-use command-line interface.
-- Configurable through environment variables.
-- Available as a Ruby gem for easy installation.
+:octocat: Fetch and display a summary of your GitHub repositories.
+
+:bar_chart: Fetch and display detailed metrics for a specific repository, including number of commits, pull requests, issues, stars, and contributors.
+
+:computer: Easy-to-use command-line interface.
+
+:wrench: Configurable through environment variables.
+
+:gem: Available as a Ruby gem for easy installation.
 
 
 ## Table of Contents 
@@ -61,6 +65,7 @@ export GITHUB_TOKEN=your_github_token_here
 Be sure to replace `your_github_token_here` with the token you generated in the Prerequisites step.
 
 ## Usage
+
 Once installed and configured, GitMarshal can be used directly from the command-line as follows:
 
 ### List All Repositories
@@ -75,13 +80,33 @@ This will provide you with a comprehensive list of your repositories and will sh
 
 ### Fetch Metrics for a Specific Repository
 
-To fetch and display metrics for a specific repository, use:
+To fetch and display overall metrics for a specific repository, use:
 
 ```bash
 gitmarshal repo-name
 ```
 
-Replace `repo_name` with the name of the repository for which you wish to fetch metrics.
+Replace `repo-name` with the name of the repository for which you wish to fetch metrics. 
+
+### Fetch Today's Metrics for a Specific Repository
+
+To fetch and display metrics for a specific repository for today only, use:
+
+```bash
+gitmarshal repo-name --today
+```
+
+Replace `repo-name` with the name of the repository for which you wish to fetch today's metrics. 
+
+### Help Command
+
+If you need help with the commands or if you are unsure about the functionality of GitMarshal, use the help command:
+
+```bash
+gitmarshal help
+```
+
+This will display a helpful guide on how to use GitMarshal, its options, and commands.
 
 ## Development
 
@@ -93,8 +118,6 @@ cd gitmarshal
 bundle install
 ```
 
-
-
 You can then run the tests with:
 
 ```bash

data/lib/gitmarshal/base_fetcher.rb

@@ -1,5 +1,5 @@
-require 'json'
-require 'net/http'
+require "json"
+require "net/http"
 
 class BaseFetcher
   GITHUB_API_BASE_URL = "https://api.github.com"
@@ -7,16 +7,15 @@ class BaseFetcher
   protected
 
   def execute_http_request(req)
-    Net::HTTP.start(req.uri.hostname, req.uri.port, :use_ssl => req.uri.scheme == 'https') do |http|
+    Net::HTTP.start(req.uri.hostname, req.uri.port, :use_ssl => req.uri.scheme == "https") do |http|
       http.request(req)
     end
   end
 
   def create_request(uri)
     Net::HTTP::Get.new(uri,
-      "Content-Type" => "application/json",
-      "Authorization" => "Bearer #{ENV['GITHUB_TOKEN']}"
-    )
+                       "Content-Type" => "application/json",
+                       "Authorization" => "Bearer #{ENV["GITHUB_TOKEN"]}")
   end
 
   def parse_response(response)

data/lib/gitmarshal/cli.rb

@@ -1,110 +1,140 @@
-require 'thor'
-require 'terminal-table'
-require 'colorize'
-require_relative 'github_fetcher'
+require "thor"
+require "terminal-table"
+require "colorize"
+require_relative "github_fetcher"
 
 module GitMarshal
   class CLI < Thor
-    class_option :help, type: :boolean, aliases: '-h', desc: 'Display usage information'
+    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'
 
     desc "repos", "Prints a summary of the authenticated user's GitHub repositories"
+
     def repos
       begin
         fetcher = GithubFetcher.new
         user = fetcher.fetch_user
         repos = fetcher.fetch_repos
-    
+
         puts "GitHub Repositories for #{user}".colorize(:blue).bold
-    
+
         rows = repos.map do |repo|
           [
-            repo['name'],
-            repo['issues'],
-            repo['stargazers'],
-            repo['forks']
+            repo["name"],
+            repo["issues"],
+            repo["stargazers"],
+            repo["forks"],
           ]
         end
-    
+
         table = Terminal::Table.new :title => "Repositories".colorize(:green).bold,
-                                    :headings => ['Name', 'Issues', 'Stargazers', 'Forks'].map { |i| i.colorize(:magenta).bold },
+                                    :headings => ["Name", "Issues", "Stargazers", "Forks"].map { |i| i.colorize(:magenta).bold },
                                     :rows => rows
-    
+
         table.style = { :border_x => "=", :border_i => "x", :alignment => :center }
         puts table
       rescue StandardError => e
         puts "An error occurred: #{e.message}"
       end
     end
-    
 
     def help(*)
-      puts "You can either call ./bin/gitmarshal to list all repositories or ./bin/gitmarshal repo-name to show the metrics of the given repository."
+      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"]
+    
+      table = Terminal::Table.new :rows => rows
+      table.title = "GitMarshal Commands".colorize(:green).bold
+      table.headings = ['Command', 'Description'].map { |i| i.colorize(:magenta).bold }
+      table.style = { :border_x => "=", :border_i => "x", :alignment => :left }
+      puts table
     end
 
     private
 
-    def metrics(repo_name)
+    def metrics(repo_name, today_option = false)
       fetcher = GithubFetcher.new
       user = fetcher.fetch_user
-    
-      repo = fetcher.fetch_repo_metrics(user, repo_name)
-    
-      # Print repository name and other details as introduction
-      puts "GitHub Repository: #{repo['name']}".colorize(:blue).bold
-      puts "Description: #{repo['description']}"
-      puts "Default Branch: #{repo['default_branch']}"
-      puts "Last Updated At: #{repo['last_updated_at']}"
-
-      puts "x======================================x"
-
-      # Display latest commit
-      latest_commit = fetcher.fetch_latest_commit(user, repo_name)
-      if latest_commit
-        puts "Latest Commit:".colorize(:blue).bold
-        puts "Commit Date: #{latest_commit['commit']['committer']['date']}"
-        puts "Commit Message: #{latest_commit['commit']['message']}"
+
+      repo = today_option ? fetcher.fetch_today_repo_metrics(user, repo_name) : fetcher.fetch_repo_metrics(user, repo_name)
+
+      if today_option
+        rows = prepare_table_rows_for_today(repo)
+        # Display latest commit
+        latest_commit = fetcher.fetch_latest_commit(user, repo_name)
+        if latest_commit
+          rows << ["Latest Commit Date", latest_commit["commit"]["committer"]["date"]]
+          rows << ["Latest Commit Message", wrap_text(latest_commit["commit"]["message"])]
+        end
+        # Display today's metrics in a table
+        display_table("Today's Repository Metrics", rows)
+      else
+        rows = prepare_table_rows(repo)
+        # Display latest commit
+        latest_commit = fetcher.fetch_latest_commit(user, repo_name)
+        if latest_commit
+          rows << ["Latest Commit Date", latest_commit["commit"]["committer"]["date"]]
+          rows << ["Latest Commit Message", wrap_text(latest_commit["commit"]["message"])]
+        end
+        # Display overall metrics in a table
+        display_table("Repository Metrics", rows)
       end
-      
-      # Display repository metrics in a table
-      rows = [
-        ['Total Commits', repo['commits_count']],
-        ['Pull Requests', repo['pull_requests_count']],
-        ['Forks', repo['forks_count']],
-        ['Watchers', repo['watchers_count']],
-        ['Issues', repo['issues_count']],
-        ['Open Issues', repo['open_issues_count']],
-        ['Closed Issues', repo['closed_issues_count']],
-        ['Open Pull Requests', repo['open_pull_requests_count']],
-        ['Closed Pull Requests', repo['closed_pull_requests_count']],
-        ['Contributors', repo['contributors_count']],
-        ['Stargazers', repo['stargazers_count']]
+    end
+
+    private
+
+    def wrap_text(text, max_width = 50)
+      text.gsub(/(.{1,#{max_width}})(\s+|\Z)/, "\\1\n")
+    end
+
+    def prepare_table_rows_for_today(repo)
+      [
+        ["Repository Name", repo["name"]],
+        ["Total Commits", repo["commits_count"].to_s],
+        ["Pull Requests", repo["pull_requests_count"].to_s],
+        ["Forks", repo["forks_count"].to_s],
+        ["Issues", repo["issues_count"].to_s],
+        ["Open Issues", repo["open_issues_count"].to_s],
+        ["Closed Issues", repo["closed_issues_count"].to_s],
+        ["Open Pull Requests", repo["open_pull_requests_count"].to_s],
+        ["Closed Pull Requests", repo["closed_pull_requests_count"].to_s],
       ]
-    
-      table = Terminal::Table.new :title => "Repository Metrics".colorize(:blue).bold, :headings => ['Metric', 'Count'].map { |i| i.colorize(:magenta).bold }, :rows => rows
+    end
+
+    def prepare_table_rows(repo)
+      [
+        ["Repository Name", repo["name"]],
+        ["Default Branch", repo["default_branch"]],
+        ["Last Updated At", repo["last_updated_at"]],
+        ["Total Commits", repo["commits_count"].to_s],
+        ["Pull Requests", repo["pull_requests_count"].to_s],
+        ["Forks", repo["forks_count"].to_s],
+        ["Watchers", repo["watchers_count"].to_s],
+        ["Issues", repo["issues_count"].to_s],
+        ["Open Issues", repo["open_issues_count"].to_s],
+        ["Closed Issues", repo["closed_issues_count"].to_s],
+        ["Open Pull Requests", repo["open_pull_requests_count"].to_s],
+        ["Closed Pull Requests", repo["closed_pull_requests_count"].to_s],
+        ["Contributors", repo["contributors_count"].to_s],
+        ["Stargazers", repo["stargazers_count"].to_s],
+      ]
+    end
+
+    def display_table(title, rows)
+      table = Terminal::Table.new :title => title.colorize(:blue).bold,
+                                  :headings => ["Metric", "Data"].map { |i| i.colorize(:magenta).bold },
+                                  :rows => rows
+
       table.style = { :border_x => "=", :border_i => "x", :alignment => :center }
-      puts table
 
-      # # Display today's repository metrics in a table
-      # today_rows = [
-      #   ['Today\'s Total Commits', fetcher.fetch_today_commits_count(user, repo_name)],
-      #   ['Today\'s Pull Requests', fetcher.fetch_today_pull_requests_count(user, repo_name)],
-      #   ['Today\'s Closed Pull Requests', fetcher.fetch_today_closed_pull_requests_count(user, repo_name)],
-      #   ['Today\'s Open Pull Requests', fetcher.fetch_today_open_pull_requests_count(user, repo_name)],
-      #   ['Today\'s Issues', fetcher.fetch_today_issues_count(user, repo_name)],
-      #   ['Today\'s Closed Issues', fetcher.fetch_today_closed_issues_count(user, repo_name)],
-      #   ['Today\'s Open Issues', fetcher.fetch_today_open_issues_count(user, repo_name)]
-      # ]
-
-      # today_table = Terminal::Table.new :title => "Today's Repository Metrics".colorize(:green).bold, :headings => ['Metric', 'Count'].map { |i| i.colorize(:magenta).bold }, :rows => today_rows
-      # today_table.style = { :border_x => "=", :border_i => "x", :alignment => :center }
-      # puts today_table
+      puts table
     end
-    
-    
-    
-    def method_missing(method, *_args, &_block)
+
+    def method_missing(method, *args, &_block)
       if method =~ /[-a-zA-Z0-9_.]+/
-        metrics(method.to_s)
+        today_option = args.include?("--today")
+        metrics(method.to_s, today_option)
       else
         super
       end

data/lib/gitmarshal/github_fetcher.rb

@@ -1,10 +1,10 @@
-require_relative 'metric_fetcher'
-require 'octokit'
+require_relative "metric_fetcher"
+require "octokit"
 
 class GithubFetcher
   def initialize
     Octokit.configure do |config|
-      config.access_token = ENV['GITHUB_TOKEN']
+      config.access_token = ENV["GITHUB_TOKEN"]
     end
   end
 
@@ -15,32 +15,51 @@ class GithubFetcher
   def fetch_repos
     Octokit.repositories.map do |repo|
       {
-        'name' => repo.name,
-        'issues' => repo.open_issues_count,
-        'stargazers' => repo.stargazers_count,
-        'forks' => repo.forks_count
+        "name" => repo.name,
+        "issues" => repo.open_issues_count,
+        "stargazers" => repo.stargazers_count,
+        "forks" => repo.forks_count,
       }
     end
   end
 
+  def fetch_today_repo_metrics(user, repo_name)
+    {
+      "name" => repo_name,
+      "forks_count" => fetch_today_forks_count(user, repo_name),
+      "open_issues_count" => fetch_today_open_issues_count(user, repo_name),
+      "commits_count" => fetch_today_commits_count(user, repo_name),
+      "pull_requests_count" => fetch_today_pull_requests_count(user, repo_name),
+      "closed_pull_requests_count" => fetch_today_closed_pull_requests_count(user, repo_name),
+      "open_pull_requests_count" => fetch_today_open_pull_requests_count(user, repo_name),
+      "issues_count" => fetch_today_issues_count(user, repo_name),
+      "closed_issues_count" => fetch_today_closed_issues_count(user, repo_name),
+    }
+  end
+
   def fetch_repo_metrics(user, repo_name)
-    repo = Octokit.repository("#{user}/#{repo_name}")
+    begin
+      repo = Octokit.repository("#{user}/#{repo_name}")
+    rescue Octokit::NotFound
+      puts "The repository #{user}/#{repo_name} was not found. Please check the repository name and try again."
+      exit
+    end
     {
-      'name' => repo.name,
-      'description' => repo.description,
-      'default_branch' => repo.default_branch,
-      'last_updated_at' => repo.updated_at,
-      'watchers_count' => repo.watchers_count,
-      'forks_count' => repo.forks_count,
-      'open_issues_count' => repo.open_issues_count,
-      'commits_count' => Octokit.commits("#{user}/#{repo_name}").count,
-      'pull_requests_count' => Octokit.pull_requests("#{user}/#{repo_name}").count,
-      'closed_pull_requests_count' => Octokit.pull_requests("#{user}/#{repo_name}", state: 'closed').count,
-      'open_pull_requests_count' => Octokit.pull_requests("#{user}/#{repo_name}", state: 'open').count,
-      'issues_count' => Octokit.issues("#{user}/#{repo_name}").count,
-      'closed_issues_count' => Octokit.issues("#{user}/#{repo_name}", state: 'closed').count,
-      'stargazers_count' => repo.stargazers_count,
-      'contributors_count' => Octokit.contributors("#{user}/#{repo_name}").count
+      "name" => repo.name,
+      "description" => repo.description,
+      "default_branch" => repo.default_branch,
+      "last_updated_at" => repo.updated_at,
+      "watchers_count" => repo.watchers_count,
+      "forks_count" => repo.forks_count,
+      "open_issues_count" => repo.open_issues_count,
+      "commits_count" => Octokit.commits("#{user}/#{repo_name}").count,
+      "pull_requests_count" => Octokit.pull_requests("#{user}/#{repo_name}").count,
+      "closed_pull_requests_count" => Octokit.pull_requests("#{user}/#{repo_name}", state: "closed").count,
+      "open_pull_requests_count" => Octokit.pull_requests("#{user}/#{repo_name}", state: "open").count,
+      "issues_count" => Octokit.issues("#{user}/#{repo_name}").count,
+      "closed_issues_count" => Octokit.issues("#{user}/#{repo_name}", state: "closed").count,
+      "stargazers_count" => repo.stargazers_count,
+      "contributors_count" => Octokit.contributors("#{user}/#{repo_name}").count,
     }
   end
 
@@ -61,13 +80,13 @@ class GithubFetcher
   end
 
   def fetch_today_closed_pull_requests_count(user, repo_name)
-    Octokit.pull_requests("#{user}/#{repo_name}", state: 'closed').count do |pr|
+    Octokit.pull_requests("#{user}/#{repo_name}", state: "closed").count do |pr|
       pr.closed_at.to_date == Date.today
     end
   end
 
   def fetch_today_open_pull_requests_count(user, repo_name)
-    Octokit.pull_requests("#{user}/#{repo_name}", state: 'open').count do |pr|
+    Octokit.pull_requests("#{user}/#{repo_name}", state: "open").count do |pr|
       pr.created_at.to_date == Date.today
     end
   end
@@ -79,14 +98,20 @@ class GithubFetcher
   end
 
   def fetch_today_closed_issues_count(user, repo_name)
-    Octokit.issues("#{user}/#{repo_name}", state: 'closed').count do |issue|
+    Octokit.issues("#{user}/#{repo_name}", state: "closed").count do |issue|
       issue.closed_at.to_date == Date.today
     end
   end
 
   def fetch_today_open_issues_count(user, repo_name)
-    Octokit.issues("#{user}/#{repo_name}", state: 'open').count do |issue|
+    Octokit.issues("#{user}/#{repo_name}", state: "open").count do |issue|
       issue.created_at.to_date == Date.today
     end
   end
+
+  def fetch_today_forks_count(user, repo_name)
+    Octokit.forks("#{user}/#{repo_name}").count do |fork|
+      fork.created_at.to_date == Date.today
+    end
+  end
 end

data/lib/gitmarshal/metric_fetcher.rb

@@ -1,4 +1,4 @@
-require_relative 'base_fetcher'
+require_relative "base_fetcher"
 
 class MetricFetcher < BaseFetcher
   def fetch_today_commits_count(owner, repo_name)
@@ -43,6 +43,6 @@ class MetricFetcher < BaseFetcher
     response = execute_http_request(req)
     star_data = parse_response(response)
 
-    star_data['stargazers_count']
+    star_data["stargazers_count"]
   end
 end

data/lib/gitmarshal/version.rb

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

metadata

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