RubyGems - hiddengems - Versions diffs - 0.3.0 → 0.3.1 - Mend

hiddengems 0.3.0 → 0.3.1

Files changed (10) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ca9fbd2ce6b45ccfafd3ee33feac087833e5f4ec40b8255134ce38523b2bee
-  data.tar.gz: 332a46385eb03d77ee543a87792d2a5674ed2e629bc8ebdf95c863461bb59c2f
+  metadata.gz: e29968b1a0adad5f4dd2a9157d3fed7230731bbe6c0c4c280e76651ffe1386ba
+  data.tar.gz: cdacc9d81bd931e81ee5f163a463f646703f0f8204b55c5835c430145bbfc4ef
 SHA512:
-  metadata.gz: 267c90327e59a508b1a1d8933bd569d6aa614a2f2d0702473ef9afcb239854d92ff9a80d48fec59a7de3d6faedb47a489592f94ed43fa3a7bab57084fe3f7035
-  data.tar.gz: 5c3221b36b09e2d364538db18e04381f8910b920a6b94eacfc76e3f42f29f299b2d47e6f73f4eec31658767bd38f7a10b18279842c6abcce968fbe166a138a3d
+  metadata.gz: b6b8cefd2cd498838b7ccb91126ccd9aba5e94c1965c5dd89bcdcc16be4c2ed6f76f6d81e3470278d910788daeaadefa6a16cec8bb506d3d010b21b32d73d748
+  data.tar.gz: 0dcc45deb33d553985583bc2c3478cac6dedbf8e2a7d2ce8998123fb5c5ee53a2f8cb1d87b4b62a06ff13771d1b46f17430eb890534c369cf287e86a224a5d0e

data/LICENSE ADDED Viewed

@@ -0,0 +1,7 @@
+Copyright 2022 David Parker
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md CHANGED Viewed

@@ -15,12 +15,21 @@ The first is comprised of 5 lists of individual rankings sorted best -> worst fo
 The second table contains a list of gems and their descriptions sorted by the *sum* of all a given gems ranks from the first table.  The lowest overall score is best.   By default each individual ranking is given a weight of 1, but you can alter this with command line options (see below)
+![illustration of how scoring works by default](img/2022-09-04_13-40.png "Scoring example")
 The rationale for this is that ranking based on download count alone (e.g. http://bestgems.org) doesn't always give you a good sense of where things stand for a given search term.  Looking at download count alone, a gem that has been around for many years and has garnered many downloads but has stagnated will tend to retain its top ranking due to the fact that people will tend to download the top ranking gem first.  In other words: it invites a positive feedback situation.
 hiddengems.rb attempts to do a better job of ranking for a given search term.  As it's grabbing all the requisite data at run time, it's not as fast as using an indexing site, but it's definitely "smarter".
 The program supports options that allow you to adjust the weights of the metrics that are used to calculate the rank sum table.  By default all metrics are given equal weight, but you can tweak this as you see fit.
+Example:
+```
+hiddengems.rb 'zabbix sender' --links --downloads 0 --avg-version-date 3 --download-slope 3 --latest-version-date 2
+```
+gives:
+![illustration of how scoring works with weight adjustments](img/2022-09-04_13-51.png "Weighted Scoring example")
 The program also includes a link validation function.  If you use it (--links), hiddengems.rb will first audit each gem's homepage_uri and source_code_uri links to ensure that (a) at least one of those URIs is populated and (b) that the links that are defined are valid.  If both (a) and (b) fail, the gem is removed from the list of found gems before ranking is calculated.
 The --links option can add a bunch of time to processing so it's not on by default, but it does a good job of weeding out dead projects.
@@ -44,18 +53,17 @@ Where [options] are:
   -h, --help                       Show this message
-$ ./hiddengems.rb --links --avg-version-date 2  'zabbix sender'
+$ hiddengems.rb 'zabbix sender' --links
 Option values:
 {
-                     :links => true,
-                 :downloads => 1,
-                  :versions => 1,
-       :latest_version_date => 1,
-          :avg_version_date => 2,
-            :download_slope => 1,
-                      :help => false,
-               :links_given => true,
-    :avg_version_date_given => true
+                  :links => true,
+              :downloads => 1,
+               :versions => 1,
+    :latest_version_date => 1,
+       :avg_version_date => 1,
+         :download_slope => 1,
+                   :help => false,
+            :links_given => true
 }
 Search term: zabbix sender
@@ -73,13 +81,13 @@ Attempting https://github.com/englishm/zabbix_send
 Attempting https://github.com/englishm/zabbix_send
 Rejecting zabbix_receiver due to lack of valid URIs
-5 remain gems after link validation
+5 remaining gems after link validation
 Calculating rankings...
 Individual Rankings (best -> worst)
 +-----+------------------------------+------------------------------+------------------------------+------------------------------+------------------------------+
-|rank |downloads                     |versions                      |latest_version_date           |avg_version_date              |download_slope                |
+|rank |downloads (1)                 |versions (1)                  |latest_version_date (1)       |avg_version_date (1)          |download_slope (1)            |
 +-----+------------------------------+------------------------------+------------------------------+------------------------------+------------------------------+
 |0    |zabbix-ruby-client (51536)    |zabbix-ruby-client (24)       |zabbix_sender_api (2022)      |zabbix_sender_api (2021)      |zabbix_send (1289)            |
 |1    |zabbix_sender (35317)         |zabbix_sender_api (11)        |zabbix_sender (2020)          |zabbix_sender (2017)          |zabbix_sender (320)           |
@@ -92,11 +100,11 @@ Rank sums (best -> worst)
 +-----+-----------------------------------+----------------------------------------------------------------------------------------------------+
 |score|name                               |info                                                                                                |
 +-----+-----------------------------------+----------------------------------------------------------------------------------------------------+
-|7    |zabbix_sender                      |Zabbix Sender gem                                                                                   |
+|6    |zabbix_sender                      |Zabbix Sender gem                                                                                   |
 |7    |zabbix_sender_api                  |This gem implements an api that abstracts the zabbix sender/trapper mechanism. It saves tons of ti… |
-|13   |zabbix-ruby-client                 |A zabbix alternative to zabbix-agent using zabbix-sender.                                           |
-|15   |zabbix_sender_legacy               |Improved zabbix_sender gem just for legacy ruby &lt; 2.0 like in Debian Wheezy                      |
-|18   |zabbix_send                        |Send data to Zabbix trappers from Ruby                                                              |
+|10   |zabbix-ruby-client                 |A zabbix alternative to zabbix-agent using zabbix-sender.                                           |
+|13   |zabbix_sender_legacy               |Improved zabbix_sender gem just for legacy ruby &lt; 2.0 like in Debian Wheezy                      |
+|14   |zabbix_send                        |Send data to Zabbix trappers from Ruby                                                              |
 +-----+-----------------------------------+----------------------------------------------------------------------------------------------------+
@@ -130,4 +138,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hiddengems.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/svdasein/hiddengems.

data/exe/hiddengems.rb CHANGED Viewed

@@ -161,7 +161,7 @@ if opts[:links]
       false
     end
   }
-  puts "\n#{gems.size} remain gems after link validation"
+  puts "\n#{gems.size} remaining gems after link validation"
 end
 puts "\nCalculating rankings..."
@@ -186,7 +186,7 @@ gems.each_index {|index|
 }
 puts
 puts "Individual Rankings (best -> worst)"
-puts  TTY::Table.new(header: [:rank]+data.keys, rows: report).render(:ascii, resize: false, column_widths: [5] + [30] * data.keys.size)
+puts  TTY::Table.new(header: [:rank]+data.keys.collect {|each| "#{each} (#{opts[each]})" }, rows: report).render(:ascii, resize: false, column_widths: [5] + [30] * data.keys.size)
 puts "\nRank sums (best -> worst)"
 puts TTY::Table.new(header: [:score, :name,:info], rows: gems.sort {|a,b| a.rank<=>b.rank}.collect {|each| [each.rank,each.name,each.info]}).render(:ascii,  column_widths: [5,35,100],resize: false)

data/hiddengems.gemspec CHANGED Viewed

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["dparker@svdasein.org"]
   spec.summary       = "Search for ruby gems with a search term (like bestgems.org) with better ranking"
-  spec.description   = "Provides a cli that lets you search rubygems for a search term.  Displays multiple ranking criteria with emphasis on project vitality"
+  spec.description   = "Provides a cli that lets you search rubygems for a search term.  Displays multiple ranking criteria with emphasis on project vitality. Alternative to rubygems.org"
   spec.homepage      = "https://gitlab.com/svdasein/hiddengems"
   spec.required_ruby_version = ">= 2.4.0"
+  spec.license = 'MIT'
   spec.metadata["allowed_push_host"] = "https://rubygems.org"

data/img/2022-09-04_12-37.png ADDED Viewed

Binary file

data/img/2022-09-04_13-40.png ADDED Viewed

Binary file

data/img/2022-09-04_13-51.png ADDED Viewed

Binary file

data/lib/hiddengems/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Hiddengems
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiddengems
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dave Parker
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides a cli that lets you search rubygems for a search term.  Displays
-  multiple ranking criteria with emphasis on project vitality
+  multiple ranking criteria with emphasis on project vitality. Alternative to rubygems.org
 email:
 - dparker@svdasein.org
 executables:
@@ -161,16 +161,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - exe/hiddengems.rb
 - hiddengems.gemspec
+- img/2022-09-04_12-37.png
+- img/2022-09-04_13-40.png
+- img/2022-09-04_13-51.png
 - lib/hiddengems.rb
 - lib/hiddengems/version.rb
 homepage: https://gitlab.com/svdasein/hiddengems
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://gitlab.com/svdasein/hiddengems