gemstory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66652c50f8e1074651114aad547f9d51cc32cb14b1b578ace9d33bb4a235920d
-  data.tar.gz: 2699c4d3c9bf92f8ce695e0ca42aef0ec5aa7b8f960a61954f3c04518935586d
+  metadata.gz: 003afca4f263042d29645b9deadcbc4088afad853bae518baf1caae0a65fdd3b
+  data.tar.gz: b93fe764dac7bbc3c3916736cdff1cdf5fee874183aebc845268c59b8bba3918
 SHA512:
-  metadata.gz: 4d51b6e2eefc119be82487cabcc4767a09b7dffd78306b73c8b57d58fb0a188ac8e9fda24124e9de15777f7e46645dea42f38fa54822eb0efe191f6d097e8695
-  data.tar.gz: 05cd3ce1949cd798cdee608c2a84b41ae1778404c0dd490fe4a2d400730814a5cfcd9893a2cbc1be6d3a86382af10d1125697519c046efff94dae702686d7fbf
+  metadata.gz: d3d9ec0457ee85800b737eb0adafaa7e5af0124df866d9d2c7d700b2dcc32eeceb67c814ca2b31e0a9388ec7fa8d2f5f68e9615b9064be818efacc58d86a073e
+  data.tar.gz: bba45f2a5f5c34a2cf31dc52af561c6fb9beae6240410aa5dbc362fdefd0252ce82037a56ad5a9ca23daafe5713096507c10a2c3631ccdd43ff918e1dafd95c0

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gemstory (0.1.0.beta3)
+    gemstory (0.1.1)
       thor (~> 0.20.0)
 
 GEM

data/README.md

@@ -1,22 +1,32 @@
 # Gemstory
-Gemstory tells the story of gems in your project. Its a command line tool that will read the history of the Gemfile.lock and project the output in terminal.
+Gemstory tells the history of gems in your project. Its a command line tool that will read the history of the Gemfile.lock and project the output in terminal.
 
 ## Installation
 
-    $ gem install gemstory --pre
+    $ gem install gemstory
 
 ## Usage
 
-Rub `gemstory` in your project root folder
+Run `gemstory` in your project root folder. This will return the history of Gem upgrades of the project.
+
+#### Options
+
+A single Gem name can be passed as an option. This will return details information about the Gem history, commits and authors.
+
+`gemstory rails`
+
+Or multiple Gems can be passed as options so that history can be compared.
+
+`gemstory rails thin`
 
 ## Development
 
-This gem is at a beta state now. More CLI options are under construction. Output can be a json file or an HTML file in the future
+More CLI options are under construction. Output can be a json file or an HTML file in the future.
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemstory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/EdwinRozario/gemstory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/gemstory.gemspec

@@ -40,4 +40,3 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'pry', '~> 0.11.3'
 end
- 

data/lib/gemstory.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'gemstory/version'
 require 'gemstory/reader'
 require 'gemstory/printer/helpers'
 require 'gemstory/printer/horizontal'
 require 'gemstory/printer/vertical'
-require 'gemstory/cli'
+require 'gemstory/cli'

data/lib/gemstory/cli.rb

@@ -1,26 +1,29 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module Gemstory
+  # Handles the CLI commands
   class Cli < Thor
     attr_reader :history, :printer
 
     def initialize(argv)
       @history = Reader.new(argv)
 
-      if argv.empty?
-        @printer = Printer::Horizontal
-      elsif argv.length == 1
-        @printer = Printer::Vertical
-      else
-        @printer = Printer::Horizontal
-      end
+      @printer = if argv.empty?
+                   Printer::Horizontal
+                 elsif argv.length == 1
+                   Printer::Vertical
+                 else
+                   Printer::Horizontal
+                 end
     end
 
-    desc "execute", "Will print the history of your gems"
+    desc 'execute', 'Will print the history of your gems'
     def execute
       @history.call
 
       @printer.new(@history).call
     end
   end
-end
+end

data/lib/gemstory/printer/helpers.rb

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 module Gemstory
   module Printer
+    # Helper methods for printers
     module Helpers
       def compare_version(current_version, last_version)
         last_version = Gem::Version.new(last_version)
         current_version = Gem::Version.new(current_version)
 
-        if last_version < current_version 
+        if last_version < current_version
           :up
         elsif last_version > current_version
           :down
         else
           :same
         end
-      
-      rescue
+      rescue ArgumentError
         :up
       end
 
       def status_code
-        { up: " \u2191 ", down: " \u2193 ", next: "   \u2192   " }
+        { up: " \033[0;32m\u2191\033[0;m ",
+          down: " \033[0;31m\u2193\033[0;m ",
+          next: " \033[0;34m \u2192 \033[0;m " }
       end
     end
   end
-end
+end

data/lib/gemstory/printer/horizontal.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Gemstory
   module Printer
+    # Prints history vertically
     class Horizontal
       include Helpers
 
@@ -10,27 +13,27 @@ module Gemstory
       end
 
       def call
-        @history.history.sort.each do |name, changes|
-          print "#{name}"
-
-          (@history.max_gem_name_size - name.to_s.length).times { print ' ' }
-          
-          print ":  "
-          
-          changes.each do |change|
+        @history.history.sort.each do |gem_name, commits|
+          print "\033[0;33m#{gem_name}\033[0;m"
+
+          (@history.max_gem_name_size - gem_name.length).times { print ' ' }
+
+          print ':  '
+
+          commits.each_with_index do |commit, index|
             version_status = :up
+            current_version = commit[:version]
 
-            unless changes.index(change).zero?
+            unless index.zero?
               print status_code[:next]
 
-              current_version = change[:version]
-              last_version = changes[changes.index(change) - 1][:version]
+              last_version = commits[index - 1][:version]
               version_status = compare_version(current_version, last_version)
             end
 
-            date_string = change[:date].strftime('%d.%m.%Y')
+            date_string = commit[:date].strftime('%d.%m.%Y')
 
-            print "#{change[:version]}#{status_code[version_status]}(#{date_string})"
+            print "#{current_version}#{status_code[version_status]}(#{date_string})"
           end
 
           puts ' '
@@ -38,4 +41,4 @@ module Gemstory
       end
     end
   end
-end
+end

data/lib/gemstory/printer/vertical.rb

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
+
 module Gemstory
   module Printer
+    # Prints hostory of a single gem verticalling through commits
     class Vertical
       include Helpers
 
       attr_reader :history
 
       def initialize(history)
-        @history = history
+        @history = history.history
       end
 
       def call
-        if @history.history.empty?
+        if @history.empty?
           puts 'Requested gem dosent exist in the Gemfile.lock'
         else
-          gem_name = @history.history.first.first
-          commits = @history.history.first.last
+          gem_name, commits = @history.first
 
-          puts gem_name
+          puts "\033[0;33m#{gem_name}\033[0;m"
           puts ' '
 
-          commits.each do |commit|
+          commits.each_with_index do |commit, index|
             version_status = :up
+            current_version = commit[:version]
 
-            unless commits.index(commit).zero?
-              current_version = commit[:version]
-              last_version = commits[commits.index(commit) - 1][:version]
+            unless index.zero?
+              last_version = commits[index - 1][:version]
               version_status = compare_version(current_version, last_version)
             end
 
             date_string = commit[:date].strftime('%d.%m.%Y')
 
-            puts "#{status_code[version_status]}  #{commit[:version]}  #{date_string}  #{commit[:commit]}  #{commit[:author]}"
+            puts "#{status_code[version_status]}  #{current_version}  #{date_string}  #{commit[:commit]}  #{commit[:author]}"
           end
         end
       end
     end
   end
-end
+end

data/lib/gemstory/reader.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Gemstory
+  # Reads the git logs and produce and Hash
   class Reader
     attr_reader :logs, :line, :date, :max_gem_name_size,
                 :commit, :history, :author, :requested_gems
@@ -23,37 +26,35 @@ module Gemstory
 
       ruby_gem.strip!
       gem_name_part = ruby_gem.match(/(.*)(?= \()/)
-      
+
       if gem_name_part
-        gem_name = gem_name_part[0]
+        gem_name = gem_name_part[0].to_sym
         version = ruby_gem.match(/(?<=\()(.*?)(?=\))/)[0]
       else
-        gem_name = ruby_gem
+        gem_name = ruby_gem.to_sym
         version = nil
       end
 
       unless @requested_gems.empty?
-        return unless @requested_gems.include? gem_name
+        return unless @requested_gems.include? gem_name.to_s
       end
 
       @max_gem_name_size = gem_name.length if gem_name.length > @max_gem_name_size
-
-      @history[gem_name.to_sym] ||= []
-
-      @history[gem_name.to_sym] << { date: @date, commit: @commit,
-                                     version: version, author: @author }
+      @history[gem_name] ||= []
+      @history[gem_name] << { date: date, commit: commit,
+                                     version: version, author: author }
     end
 
     def gem?
-      @line.match(/(.*)(\()(.*?)(\))/)
+      line.match(/(.*)(\()(.*?)(\))/)
     end
 
     def new_line?
-      @line.match(/^\+ /)
+      line.match(/^\+ /)
     end
 
     def author?
-      matches = @line.match(/(?<=^Author: )(.*)/)
+      matches = line.match(/(?<=^Author: )(.*)/)
 
       if matches
         @author = matches[0]
@@ -64,7 +65,7 @@ module Gemstory
     end
 
     def date?
-      matches = @line.match(/(?<=^Date: )(.*)/)
+      matches = line.match(/(?<=^Date: )(.*)/)
 
       if matches
         @date = Date.parse(matches[0])
@@ -75,7 +76,7 @@ module Gemstory
     end
 
     def commit?
-      matches = @line.match(/(?<=^commit )(.*)/)
+      matches = line.match(/(?<=^commit )(.*)/)
 
       if matches
         @commit = matches[0]
@@ -91,7 +92,7 @@ module Gemstory
 
       @logs.each_line do |line|
         @line = line.strip
-        
+
         next if commit?
         next if date?
         next if author?
@@ -110,7 +111,6 @@ module Gemstory
           end
         end.compact
       end
-
-    end    
+    end
   end
 end

data/lib/gemstory/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gemstory
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemstory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Edwin Rozario
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -91,6 +91,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile