gem-check 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0cd75e58071bfb04722ffc292166cb654ea869f
-  data.tar.gz: d9145f2303bf8e2e7752d86d04d6f49b4a239f77
+  metadata.gz: 7cd38462be68a3f95d24c40ac3750a1384d4452e
+  data.tar.gz: f8f1c6e79201f42d897004513d6b046d7265ef2d
 SHA512:
-  metadata.gz: 6090011f1a3972b0cd847e55269cd50f40b603f98a3c47e6633c19754f9e6c3fac45c7bbf9cbd141ef3ff60a754badf9cb501e05a0c09fe24092ca8684398528
-  data.tar.gz: 2e237ebb9ff07d67eb0f25c44402fe7fc554b292c1aecfb1b6c12f6dbba41bd15407869f9e1041ad89dc8110946f8b4b0622c9c69cd2e725325402f7a100c648
+  metadata.gz: 67cfb2c72b1dd273d1058423a84f520764710b60bff70b84d1446b629f17b8cfef8bf0eae2c1f11ab9b167c064314c682f9a03c0f77cf95825e7a78227bc87ef
+  data.tar.gz: 02627224be8dcb473e01c0f711a28bb5b1583bd292264dc1255e277045f66c403b14dbf994addc0bb365fc30438edbb383d5d2428ace239aff68cad521685ffc

data/README.md

@@ -9,11 +9,31 @@ A simple ruby utility to see the download count for your owned gems.
 
 ## Usage
 
-Create your gem credentials file as described on [rubygems.org](https://rubygems.org/profile/edit)
+First, create your gem credentials file as described on [rubygems.org](https://rubygems.org/profile/edit)
 ```
 $ gem-check
 ```
-![gem-check](./screenshot-gem-check.png)
+![gem-check](./gem-check.png)  
+
+### Options  
+
+| Flag | Description|
+| :--- | :---:  |
+| -f | Don't save the updated stats for this run.  |
+| -h | Display the help screen.  |  
+
+### Note  
+  Gem stats data stored in ~/gem-check.json  
+
+### Display
+
+| Column | Description |
+| :--- | :---: |
+| Gem Version | Latest available gem version |
+| Version DLs | Download count for the displayed version of the gem |
+| All DLs | Total gem download count |
+| (+number) | New downloads since last recorded program run |
+
 
 ## Dependencies  
 gems ~> 0.8.3  

data/bin/gem-check

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 require_relative '../lib/gem-check'
 include GemCheck
-
-print_table
+if ARGV.include?("-h")
+  Checker.show_help
+else
+  Checker.new(ARGV).check
+end

data/lib/gem-check/cli.rb

@@ -0,0 +1,56 @@
+module GemCheck
+  class Checker
+    def self.show_help
+      puts
+      puts "GemCheck v#{GemCheck::VERSION} - Help"
+      puts "\n  Flags:\n"
+      puts "    -f   Don't save the updated stats for this run."
+      puts "    -h   Display this help screen."
+      puts
+    end
+
+    private
+
+    def commafy(x)
+      i,d = x.to_s.split('.')
+      i.gsub(/(\d)(?=\d{3}+$)/,'\\1,') + (d ? ('.'+d) : '')
+    end
+
+    def decommafy(x)
+      return x unless x.class.eql?(String)
+      x.delete(',')
+    end
+
+    def update_status_string
+      update_available? ? "\n [ Update available: v#{@update_version} ]" : nil
+    end
+
+    def header_string
+      "GemCheck v#{GemCheck::VERSION}#{update_status_string}\n"+
+      "#{current_date_string}\n"+
+      "#{last_run}"
+    end
+
+    # adapted from https://stackoverflow.com/a/195894
+    def last_run
+      time_diff = @previous_date ? (Time.now - @previous_date).to_i : nil
+      time_words =
+      case time_diff
+      when nil then nil
+      when 0 then 'just now'
+      when 1 then 'a second ago'
+      when 2..59 then time_diff.to_s+' seconds ago'
+      when 60..119 then 'a minute ago' #120 = 2 minutes
+      when 120..3540 then (time_diff/60).to_i.to_s+' minutes ago'
+      when 3541..7100 then 'an hour ago' # 3600 = 1 hour
+      when 7101..82800 then ((time_diff+99)/3600).to_i.to_s+' hours ago'
+      when 82801..172000 then 'a day ago' # 86400 = 1 day
+      when 172001..518400 then ((time_diff+800)/(60*60*24)).to_i.to_s+' days ago'
+      when 518400..1036800 then 'a week ago'
+      else ((time_diff+180000)/(60*60*24*7)).to_i.to_s+' weeks ago'
+      end
+
+      time_words ? "#{commafy(@new_downloads)} downloads since #{time_words}" : ''
+    end
+  end
+end

data/lib/gem-check/helpers.rb

@@ -0,0 +1,64 @@
+module GemCheck
+  class Checker
+    private
+
+    # File I/O
+    def clean_stat_line(line)
+      chars_to_filter = %w(\\\" [ ])
+      line.chomp!
+      chars_to_filter.each { |c| line.delete!(c) }
+      line.split(',')
+    end
+
+    def current_date_string
+      Time.now.strftime("%b %d, %H:%M:%S")
+    end
+
+    # Gems API
+    def current_gem_info
+      @current_stats = []
+      Gems.gems.map do |x|
+        x = OpenStruct.new(x)
+        val = [x.name, x.version, commafy(x.version_downloads), commafy(x.downloads)]
+        @current_stats << val
+        val
+      end
+    end
+
+    # Features
+    def add_new_download_info(latest_info)
+      return latest_info if @previous_stats.empty?
+      latest_info.map do |row|
+        prev_info = search_by_column(@previous_stats, COL_NAME, row[COL_NAME])
+        prev_info = search_by_column(prev_info,       COL_VER,  row[COL_VER])
+        return row if prev_info.empty?
+        prev_info = prev_info.first
+        calc_new_downloads(COL_TDL, row, prev_info)
+        calc_new_downloads(COL_VDL, row, prev_info)
+        row
+      end
+    end
+
+    def calc_new_downloads(idx, row, info)
+      new_dls = decommafy(row[idx]).to_i - decommafy(info[idx]).to_i
+      @new_downloads += new_dls
+      row[idx] = new_dls > 0 ? "#{row[idx]} ( +#{commafy(new_dls)} )" : row[idx]
+    end
+
+    # Utils
+    def search_by_column(table, column, search_s)
+      return table if table.empty?
+      table.select{ |r| r[column].eql?(search_s) }
+    end
+
+    # Maintanence
+    def update_available?
+      versions = open(URL_GEMCHECK_INFO_JSON).read
+      @update_version = JSON.parse(versions, object_class: OpenStruct).first.number
+      @update_version > GemCheck::VERSION
+    end
+
+
+
+  end
+end

data/lib/{version.rb → gem-check/version.rb}

@@ -1,3 +1,3 @@
 module GemCheck
-  VERSION = "0.1.2"
+  VERSION = '0.2.0'
 end

data/lib/gem-check.rb

@@ -2,35 +2,78 @@ require 'rubygems'
 require 'ostruct'
 require 'gems'
 require 'terminal-table'
-require_relative 'version'
+require 'open-uri'
+require 'json'
+require 'date'
+require_relative 'gem-check/version'
+require_relative 'gem-check/cli'
+require_relative 'gem-check/helpers'
 
 module GemCheck
-  HEADINGS = ['Gem Name', 'Version', 'Downloads', 'Total']
 
-  def commafy(x)
-    i,d = x.to_s.split('.')
-    i.gsub(/(\d)(?=\d{3}+$)/,'\\1,') + (d ? ('.'+d) : '')
-  end
+  class Checker
+    URL_GEMCHECK_INFO_JSON = 'https://rubygems.org/api/v1/versions/gem-check.json'
+    INFO_FILENAME          = 'gem-check.json'
+
+    REPORT_HEADINGS = ['Gem Name', 'Gem Version', 'Version DLs', 'All DLs']
+    COL_NAME = 0 # Gem Name
+    COL_VER  = 1 # Version
+    COL_VDL  = 2 # Version DLs
+    COL_TDL  = 3 # Total DLs
 
-  def gem_info
-    Gems.gems.map do |x|
-      x = OpenStruct.new(x)
-      [x.name, x.version, commafy(x.version_downloads), commafy(x.downloads)]
+    def initialize(args=[])
+      @new_downloads    = 0
+      @update_version   = nil
+      @current_stats    = nil
+      @previous_stats   = []
+      @previous_date    = Time.now
+      @f_previous_stats = File.join(Dir.home, INFO_FILENAME)
+      @args = args
     end
-  end
 
-  def build_table
-    rows  = gem_info.sort!{|a, b| b[2].to_i <=> a[2].to_i}
-    table = Terminal::Table.new(rows: rows)
-    table.headings = GemCheck::HEADINGS
-    [1].each{ |col| table.align_column(col, :center) }
-    [2,3].each{ |col| table.align_column(col, :right) }
-    table
-  end
+    def check
+      read_previous_info
+      print_table(build_table)
+      store_new_info unless @args.include?('-f')
+    end
+
+    # Read stored gem info
+    def read_previous_info
+      return unless File.exist? @f_previous_stats
+      f = File.read(@f_previous_stats)
+      @previous_date  = Time.parse(f.lines.first.chomp) || nil
+      @previous_stats = []
+      f.lines.drop(1).each { |line| @previous_stats << clean_stat_line(line)}
+      @previous_stats
+    end
+
+    def build_table
+      rows  = current_gem_info.sort!{|a, b| b[2].to_i <=> a[2].to_i}
+      rows  = add_new_download_info(rows)
+      table = Terminal::Table.new(rows: rows)
+      table.title    = header_string
+      table.headings = REPORT_HEADINGS
+      [1  ].each{ |col| table.align_column(col, :left)  }
+      [2,3].each{ |col| table.align_column(col, :center) }
+      table
+    end
 
-  def print_table
-    puts
-    puts build_table
-    puts
+    # Display
+    def print_table(table)
+      puts "\n#{table}\n\n"
+    end
+
+    # Save newest gem info to file @f_previous_stats
+    def store_new_info
+      File.open(@f_previous_stats, 'w') do |file|
+        file.write "#{current_date_string}\n"
+        @current_stats.each do |row|
+          row.each_with_index do |col, idx|
+            row[idx] = decommafy(row[idx]).to_i if idx > 1
+          end
+          file.write row.to_json + "\n"
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Meissa Dia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2017-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gems
@@ -48,9 +48,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/gem-check
+- gem-check.png
 - lib/gem-check.rb
-- lib/version.rb
-- screenshot-gem-check.png
+- lib/gem-check/cli.rb
+- lib/gem-check/helpers.rb
+- lib/gem-check/version.rb
 homepage: https://github.com/meissadia/gem-check
 licenses:
 - MIT
@@ -71,9 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: See the download counts of your owned gems.
 test_files: []
-has_rdoc: