any_good 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fe801250f6e51612d255456a8ad2d7e7cea083b
+  data.tar.gz: b8db3eb675a42e1ca7bc9f9ece8e70ddd275da63
+SHA512:
+  metadata.gz: 985c456c6133c922c904176719795fc1fc737deba31b90fe33c5c514fb5e504f8015019b39452638c2f21283e78375055c2b129d087f5284eb00ef9b1b213f51
+  data.tar.gz: d457b7e29bf41e278beac08b949c9c473d9e917f879548ffe063ab04b31430d493563c91492475c24426a9c09d07bdf355ccf4ec0f2556d87632fca1874d9854

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-15 Victor 'Zverok' Shepelev
+
+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

@@ -0,0 +1,61 @@
+[![Gem Version](https://badge.fury.io/rb/any_good.svg)](http://badge.fury.io/rb/any_good)
+
+## What's this?
+
+A thing to quickly evaluate Ruby gem maturity and answer "Is it any good?". Like this:
+
+![](https://raw.githubusercontent.com/zverok/any_good/master/doc/example.png)
+
+Just a report of some numbers and facts from rubygems.org and GitHub repo of the gem in
+question, to understand how risky it would be to use it.
+
+## Usage
+
+```
+$ gem install any_good
+$ any_good <gem_name>
+```
+
+## Why?
+
+I find myself constantly repeating this process for some new gems I spotted somewhere: going to
+their gem page and repo page to understand how well it maintained or is it abandoned, and is it
+something new that still have to get its ways and popularity.
+
+This gem is just a quick one-evening experiment on whether it can be automated in a helpful manner.
+
+## What are the colors? Are you criticizing gems?..
+
+The colors (green-yellow-red) are just based on my own subjective "thresholds". Maybe they could become
+configurable in future versions, if any. "Yellow" and "red" aren't, in fact, "bad", it is "point
+of attention" when judging whether you'll give a chance to some gem, and how important are they,
+depends on the situation.
+
+The colors DO NOT mean to "score" the gems (this gem is bad) or to compare "which gem is better",
+but the typically DO give some insights on the gem's current status in the community.
+
+Those insights aren't that accurate: for example, [tzinfo](https://rubygems.org/gems/tzinfo)
+is used by literally everyone, yet its GitHub repo has just ~200 stars. For another,
+[inflecto](https://rubygems.org/gems/inflecto) is explicitly abandoned by its author, the last version
+was released four years ago, yet it is robust and widely used.
+
+## GitHub?
+
+A large part of stats is taken from gem's GitHub repo.
+
+Yes, the gem is not required to have the link to sources published. Yes, there are gems with sources
+on GitLab, BitBucket, or even SourceForge, God forbid. But again, as with colors, my _subjective_
+experience says me to check its GitHub if it is accessible. So the `any_good` does.
+
+BTW, `any_good` connects to GitHub API anonymously, and anonymous connections are subject to harsh
+rate limiting, so if you use it a lot through one day, you may want to provide `GITHUB_ACCESS_TOKEN`
+environment variable (tokens are obtained [here](https://github.com/settings/tokens)).
+
+## Is it any good?
+
+Well, it is a quick one-evening experiment. So, no tests, no docs except this README, no config,
+and just hard-coded thresholds. But it works for me.
+
+## Who are you anyways?
+
+Just a humble [@zverok](http://zverok.github.io).

data/exe/any_good

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative '../lib/any_good'
+
+abort 'Usage: `any_good <gemname>`' if ARGV.empty?
+
+AnyGood.new(ARGV.shift).fetch.report

data/lib/any_good/meters.rb

@@ -0,0 +1,73 @@
+class AnyGood
+  class Meter < Struct.new(:name, :thresholds, :block)
+    def call(data)
+      Metric.new(name, value(data), *thresholds)
+    end
+
+    private
+
+    attr_reader :data
+
+    def value(data)
+      @data = data
+      instance_eval(&block)
+    rescue NoMethodError
+      nil
+    ensure
+      @data = nil
+    end
+  end
+
+  class Metric
+    attr_reader :value, :name, :color
+
+    def initialize(name, value, *thresholds)
+      @name = name
+      @value = value
+      @color = deduce_color(*thresholds)
+    end
+
+    def format
+      '%20s: %s' % [name, colorized_value]
+    end
+
+    private
+
+    def colorized_value
+      Pastel.new.send(color, formatted_value)
+    end
+
+    def formatted_value
+      case value
+      when nil
+        '—'
+      when String
+        value
+      when Numeric
+        value.to_s.chars.reverse.each_slice(3).to_a.map(&:join).join(',').reverse
+      when Date, Time
+        diff = TimeMath.measure(value, Time.now)
+        unit, num = diff.detect { |_, v| !v.zero? }
+        "#{num} #{unit} ago"
+      else
+        fail ArgumentError, "Unformattable #{value.inspect}"
+      end
+    end
+
+    def deduce_color(yellow = nil, red = nil)
+      return :dark if value.nil?
+      return :white if !yellow # no thresholds given
+
+      # special trick to tell "lower is better" from "higher is better" situations
+      val = red.is_a?(Numeric) && red < 0 ? -value : value
+
+      if val < red
+        :red
+      elsif val < yellow
+        :yellow
+      else
+        :green
+      end
+    end
+  end
+end

data/lib/any_good.rb

@@ -0,0 +1,94 @@
+require 'gems'
+require 'octokit'
+require 'pp'
+require 'date'
+require 'time_math'
+require 'pastel'
+
+class AnyGood
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+    @github_client =
+      if (token = ENV['GITHUB_ACCESS_TOKEN'])
+        Octokit::Client.new(access_token: token).tap { |client| client.user.login }
+      else
+        Octokit::Client.new
+      end
+  end
+
+  def fetch
+    data = {
+      gem: Gems.info(name),
+      gem_versions: Gems.versions(name),
+      gem_rev_deps: Gems.reverse_dependencies(name)
+    }
+
+    repo_id = [data[:gem]['source_code_uri'], data[:gem]['homepage_uri']]
+      .grep(%r{^https?://github\.com/}).first&.sub(%r{^https?://github\.com/}, '')
+
+    if repo_id
+      data.merge!(
+        repo: @github_client.repository(repo_id).to_h,
+        open_issues: @github_client.issues(repo_id, state: 'open', per_page: 50).map(&:to_h),
+        closed_issues: @github_client.issues(repo_id, state: 'closed', per_page: 50).map(&:to_h),
+        last_commit: @github_client.commits(repo_id, per_page: 1).first.to_h
+        # open_prs: @github_client.issues(repo_id, state: 'open').map(&:to_h)
+        # closed_prs: @github_client.issues(repo_id, state: 'closed').map(&:to_h)
+      )
+    end
+
+    @data = OpenStruct.new(data)
+
+    self
+  end
+
+  def report
+    self.class.meters.each do |meter|
+      puts meter.call(@data).format
+    end
+    self
+  end
+
+  require_relative 'any_good/meters'
+
+  def self.meters
+    @meters ||= []
+  end
+
+  def self.metric(name, thresholds: nil, &block)
+    meters << Meter.new(name, thresholds, block)
+  end
+
+  T = TimeMath
+  now = Time.now
+
+  metric('Downloads', thresholds: [5_000, 10_000]) { data.gem['downloads'] }
+  metric('Latest version', thresholds: [T.month.decrease(now, 2), T.year.decrease(now)]) {
+    Time.parse(data.gem_versions.first['created_at'])
+  }
+  metric('Used by', thresholds: [10, 100]) { data.gem_rev_deps.count }
+
+  metric('Stars', thresholds: [100, 500]) { data.repo[:stargazers_count] }
+  metric('Forks', thresholds: [5, 20]) { data.repo[:forks_count] }
+  metric('Last commit', thresholds: [T.month.decrease(now), T.month.decrease(now, 4)]) {
+    data.last_commit.dig(:commit, :committer, :date)
+  }
+
+  metric('Open issues') {
+    res = data.open_issues.count
+    res == 50 ? '50+' : res
+  }
+  metric('...without reaction', thresholds: [-5, -20]) {
+    data.open_issues.reject { |i| i[:labels].any? || i[:comments] > 0 }.count
+  }
+  metric('...last reaction', thresholds: [T.week.decrease(now), T.month.decrease(now)]) {
+    data.open_issues.detect { |i| i[:labels].any? || i[:comments] > 0 }&.fetch(:updated_at)
+  }
+  metric('Closed issues') {
+    res = data.closed_issues.count
+    res == 50 ? '50+' : res
+  }
+  metric('...last closed') { data.closed_issues.first&.fetch(:closed_at) }
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: any_good
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: time_math2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: zverok.offline@gmail.com
+executables:
+- any_good
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/any_good
+- lib/any_good.rb
+- lib/any_good/meters.rb
+homepage: https://github.com/zverok/any_good
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Is that gem any good?
+test_files: []