gitmarshal 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1136a825070f9c33c0a3288175c2d1df3bc56c861a2c4612d1e91728b54eff
-  data.tar.gz: 27de3ae232d1d9e8694cb3433f3a3f74853a67a1a5b34987ff9995a872e96b53
+  metadata.gz: d90917df2e1981597d8b13ed42de81a096e70afdb82c9861659d14d1bfa7fe06
+  data.tar.gz: 90a6709426c96fc7799d14ff700540e295206463cd7e2ee29f06088f55b01185
 SHA512:
-  metadata.gz: d223482bd2ff8d5b20d62bb98402f974073ab02ca98f845df36b0dea27ab5d2c8c863d90d61c450b5d21430e3ff3e906006a117056cf26bfd1aabcec0dbd9cab
-  data.tar.gz: 967f16553443e6ba49828f2cbabfb8b267784e3b02279540b8c420fc41be227e7eec5d6a79682b798c5990025df8e24c1d0a135b41aebf900bd0a6d7a327ae6f
+  metadata.gz: 7e90700eac894369e3bfe07fef83cbb2515e58d8db30b37667b3aadcd8e15ff180750b4b99081ac6c71ecf6ec74e66f7af2880a4503a31e9b52c93d11f93f18f
+  data.tar.gz: 2c09785145ab76e52124c0ab1edd67313159ed1371c6d3bb60608ad4194dfd98022186c5c2da8fdc7c219a814f4bd266389363ab47ecebdabd1ff788ce11f77f

data/README.md

@@ -1,9 +1,28 @@
-# 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">
+  <img src="https://github.com/nagstler/gitmarshal/assets/1298480/b488174b-7a33-4932-ada8-1b34f641b2a5.gif" alt="animated" />
+</p>
 
-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.
 
+<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 +47,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 +91,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

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

@@ -27,7 +27,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
 
@@ -43,10 +43,10 @@ module GitMarshal
       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.title = "GitMarshal Commands".colorize(:blue).bold
+      table.headings = ["Command", "Description"].map { |i| i.colorize(:magenta).bold }
       table.style = { :border_x => "=", :border_i => "x", :alignment => :left }
       puts table
     end

data/lib/gitmarshal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitmarshal
-  VERSION = "1.1.0"
+  VERSION = "1.2.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.2.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json