github_contribs 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e0e43a97f55f9a06e5dadb7cd30fb5744cee79acff1b8a0c8f1000e663ddd7'
-  data.tar.gz: ef5db7d36c652b2e7b995eab7cceabb98110424357a37c7abff510a178e34526
+  metadata.gz: 77816e7a617476af27562ba5ec816996cf8a965780c8c317d8d44fc48f6e4758
+  data.tar.gz: 3b448123b525319b886f64b0b7f12f9945b2b4595f57634d53b56e8ba724a8a1
 SHA512:
-  metadata.gz: 57aebaadfaeb71598070f6fbd7289b6540f7713345b9bb7f6b06ca4a591cc9bc50040f70ddb3145c8ec4d9f3dfe9ba666e1c7eaf81b1437e86de2924be45fcfc
-  data.tar.gz: e274e2f64bba8b4af46f1ccbe3dd1c7a0bfa1a69826536f6414a0c279de0f5b7d7da418fca901433137024784fc97f0b41104e57e118fffdb9faff352d9e43f7
+  metadata.gz: aade65668beea1d2ab92abc531c2e45d292b2fcd23a597669501ed2d9f7ba52b372a8d570b26a41da8aed58b394bf6c5c2771d1797ef70c2623268ffc80e5250
+  data.tar.gz: 2dac0658a3f8dac10067e2ec00b7a8d4144167b55a48c2b9458082d5fd6f4678a18fe903b154316801fd7813187c9727c2fddad231ecb27483b0441943e2fac9

data/History.rdoc

@@ -1,3 +1,23 @@
+=== 2.0.0 / 2024-07-01
+
+* 2 major enhancements:
+
+  * Completely rewrote data gathering to use graphql. Caches json per year.
+  * Completely rewrote html generation to be from scratch. Much cleaner.
+
+* 4 minor enhancements:
+
+  * Built a legend and non-intrusive popups to provide better UI.
+  * Dropped nokogiri as a dependency. Now using gh cmdline instead of scraping. This might change.
+  * No longer defaults to the last 10 years. Now does *all* years if start is not specified.
+  * Scale all contributions against min/max to make it easier to compare.
+
+=== 1.1.0 / 2022-10-05
+
+* 1 minor enhancement:
+
+  * Added support for $GITHUB_TOKEN env var for auth. (Fryguy)
+
 === 1.0.0 / 2022-09-17
 
 * 1 major enhancement

data/README.rdoc

@@ -12,7 +12,7 @@ from github and assembles them into a unified view.
 
 * Helps visualize patterns across the years.
 * See the effects of major life events (eg marriage, baby, depression).
-* Uses ~/.config/gh/hosts.yml for authentication (generate via `gh auth login`).
+* Uses GITHUB_TOKEN env var or ~/.config/gh/hosts.yml for authentication (generate via `gh auth login`).
 * Caches all previous years (current year is always generated).
 * Defaults to 10 years, but takes an optional year.
 

data/Rakefile

@@ -10,16 +10,14 @@ Hoe.plugin :rdoc
 Hoe.spec "github_contribs" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
 
-  dependency "nokogiri", "~> 1.12"
-
   self.isolate_multiruby = true # for nokogiri
 
   license "MIT"
 end
 
 task :run => :isolate do
-  WHO = ENV["U"] || "zenspider 1998"
-  ruby "-Ilib bin/github_contribs #{WHO}"
+  WHO = ENV["U"] || "zenspider"
+  ruby "-Ilib bin/github_contribs -v #{WHO}"
 end
 
 # vim: syntax=ruby

data/bin/github_contribs

@@ -9,7 +9,7 @@ if ARGV.empty? then
 end
 
 name = ARGV.shift
-last = (ARGV.shift || (Time.now.year - 10)).to_i
+last = ARGV.shift
 
 gh = GithubContribs.new
 

data/lib/github_contribs.rb

@@ -1,77 +1,252 @@
-require "pp"
-require "nokogiri"
 require "fileutils"
-require "open-uri"
-require "yaml"
+require "json"
+require "date"
 
 class GithubContribs
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 
-  def oauth_token
-    @token ||= begin
-                 data = YAML.load_file File.expand_path "~/.config/gh/hosts.yml"
-                 data && data.dig("github.com", "oauth_token")
-               end
+  def graphql(*args)
+    IO.popen(["gh", "api", "graphql", *args]) { |io| JSON.parse(io.read) }
   end
 
+  QUERY = <<~EOQ.strip
+    query($userName: String!, $from: DateTime!) {
+      user(login: $userName) {
+        contributionsCollection(from: $from) {
+          contributionCalendar {
+            totalContributions
+            weeks {
+              contributionDays {
+                contributionCount
+                date
+              }
+            }
+          }
+        }
+      }
+    }
+  EOQ
+
   def get name, year
-    base_url = "https://github.com/#{name}?"
-    path = ".#{name}.#{year}.html"
+    path = ".#{name}.#{year}.json"
 
     unless File.exist? path then
       warn "#{name} #{year}" if $v
 
-      uri = URI.parse "#{base_url}from=%4d-01-01&to=%4d-12-31" % [year, year]
-
-      File.open path, "w" do |f|
-        f.puts uri.read("authorization" => "Bearer #{oauth_token}")
-      end
+      data = graphql("--paginate", "--slurp",
+                     "-F", "userName=#{name}",
+                     "-F", "from=#{year}-01-01T00:00:00",
+                     "-f", "query=%s" % [QUERY])
+        .dig(0, "data", "user", # JFC
+             "contributionsCollection", "contributionCalendar",
+             "weeks")
+
+      data = data.map { |h| h["contributionDays"] }
+      data = data.map { |a| a.to_h { |h| [h["date"], h["contributionCount"]] } }
+      data = data.reduce(&:merge).sort.to_h
+      data = data.select { |k,v| k.start_with? "#{year}" } # edges of calendar
+      data = data.select { |k,v| v > 0 }
+
+      File.write path, JSON.pretty_generate(data)
     end
 
-    Nokogiri::HTML File.read path
+    JSON.parse File.read path
+  end
+
+  YEARS_QUERY = <<~EOQ.strip
+    query($userName: String!) {
+      user(login: $userName) {
+        contributionsCollection {
+          contributionYears
+        }
+      }
+    }
+  EOQ
+
+  def years name
+    graphql("-F", "userName=#{name}", "-f", "query=%s" % [YEARS_QUERY])
+      .dig("data", "user", "contributionsCollection", "contributionYears")
+  end
+
+  def load_all name, years
+    years.map { |year| get name, year }.reduce(&:merge)
   end
 
   def generate name, last, io = $stdout, testing = false
-    io.puts <<~EOM
-      <!DOCTYPE html>
-      <html lang="en">
-    EOM
+    last ||= years(name).min
+    last = last.to_i # string from cmdline
 
     unless testing then
-      FileUtils.rm_f ".#{name}.#{Time.now.year}.html" # always fetch this fresh
+      FileUtils.rm_f ".#{name}.#{Time.now.year}.json" # always fetch this fresh
     end
-    html = get name, Time.now.year
 
-    io.puts html.at_css("head").to_html
-    io.puts %(  <body>)
-    io.puts html.css("script").to_html
+    steps = 16
 
-    Time.now.year.downto(last).each do |year|
-      graph = get(name, year)
-        .at_css("div.graph-before-activity-overview")
+    # HACK: make it know the years automatically
+    contribs = load_all name, last..Time.now.year
 
-      graph.css("div.float-right").remove # NEW!...
+    d0, dN = Date.new(last), Date.today
 
-      graph.css("div.float-left").first   # Learn how we count...
-        .content = graph.previous.previous.content.strip.gsub(/\s+/, " ")
+    min, max = contribs.values.minmax
 
-      graph.at_css("div.js-calendar-graph")
-        .remove_class("d-flex")
-        .remove_class("text-center")
-        .remove_class("flex-xl-items-center")
+    max1 = Math.log(max+1)
 
-      io.puts graph.to_html
-    end # years
+    scale = ->(n) { [n, (steps * Math.log(n) / max1).floor] }
+
+    total_contributions = contribs.values.sum
+
+    range = (min..max) # used for legend below
+      .group_by { |n| scale[n].last }
+      .transform_values { |ary|
+        m, n = ary.minmax
+        m == n ? m : Range.new(m, n)
+      }
+
+    contribs.transform_values!(&scale)
+
+    years = (d0.year..dN.year).to_a.reverse.to_h { |year|
+      d0 = Date.new year
+      d1 = Date.new year+1
+
+      d0 -= d0.wday # back it up to sunday to square everything off
+      d1 += (7-d1.wday) # unless d1.wday == 0
+
+      days = (d0...d1).map { |d| d.year == year ? [d.to_s, contribs[d.to_s]] : [] }
+
+      by_week = days.each_slice(7).to_a.transpose
 
-    io.puts <<~EOM
-      <div class="Popover js-hovercard-content position-absolute" style="display: none; outline: none;" tabindex="0">
-        <div class="Popover-message Popover-message--bottom-left Popover-message--large Box box-shadow-large" style="width:360px;"></div>
-      </div>
-    EOM
+      [ year, by_week ]
+    }
+
+    def io.td day, code, count
+      if code && count then
+        print '<td class="entry day green-color-%d tooltip">' % [code]
+        print '<div class="right">%s = %s</div>' % [day, count]
+        puts '</td>'
+      else
+        puts '<td class="entry day nocolor"></td>'
+      end
+    end
+
+    io.puts "<html>"
+    io.puts "<head>"
+    io.puts "<title>%s's contribution calendar</title>" % [name]
+    io.puts <<~CSS
+      <style>
+        body { background-color: #ffffff; font-family: system-ui; }
+
+        .entry {
+            font-size: 0.8rem;
+            display: inline-block;
+            margin: 1px;
+            width:  12px;
+            height: 12px;
+            border-radius: 2px;
+            outline: 1px solid rgba(0, 0, 0, 10%);
+            outline-offset: -1px;
+        }
+
+        .entry.day:hover { outline: 2px solid rgba(0, 0, 0, 10%); }
+
+        .non-day { outline: none; } /* cancel out entry's outline for non-days */
+
+        .tooltip {
+            display: inline-block;
+            position: relative;
+        }
+
+        .tooltip .right {
+            font-family: monospace;
+            font-size: 1.2rem;
+            min-width: 11em; # "yyyy-mm-dd = xyz" = 16 chars? but em calculation is wack
+            top: 50%;
+            left: 100%;
+            margin-left: 20px;
+            transform: translate(0, -);
+            padding: 5px 5px;
+            color: #444;
+            background-color: #ccc;
+            border-radius: 8px;
+            position: absolute;
+            z-index: 99999999;
+            box-sizing: border-box;
+            border: 1px solid #fff;
+            display: none;
+        }
+
+        .tooltip:hover .right { display: block; }
+
+        .nocolor { background-color: hsl(120, 10%, 99%); }
+
+        .green-color-0  { background-color: hsl(120 70% 95%); }
+        .green-color-1  { background-color: hsl(120 70% 90%); }
+        .green-color-2  { background-color: hsl(120 70% 85%); }
+        .green-color-3  { background-color: hsl(120 70% 80%); }
+        .green-color-4  { background-color: hsl(120 70% 75%); }
+        .green-color-5  { background-color: hsl(120 70% 70%); }
+        .green-color-6  { background-color: hsl(120 70% 65%); }
+        .green-color-7  { background-color: hsl(120 70% 60%); }
+        .green-color-8  { background-color: hsl(120 70% 55%); }
+        .green-color-9  { background-color: hsl(120 70% 50%); }
+        .green-color-10 { background-color: hsl(120 70% 45%); }
+        .green-color-11 { background-color: hsl(120 70% 40%); }
+        .green-color-12 { background-color: hsl(120 70% 35%); }
+        .green-color-13 { background-color: hsl(120 70% 30%); }
+        .green-color-14 { background-color: hsl(120 70% 25%); }
+        .green-color-15 { background-color: hsl(120 70% 20%); }
+      </style>
+    CSS
+    io.puts "</head>"
+
+    io.puts "<body>"
+
+    io.puts "<h1>#{name}'s complete github contributions</h1>"
+    io.puts "<p><small>Total contributions = %d</small>" % [total_contributions]
+
+    io.puts "<div><small>Legend: </small>"
+    io.puts "<table>"
+    io.puts "<tr>"
+    io.puts '<td class="entry day nocolor"></td>'
+    steps.times.each do |code|
+      io.td "level #{code}", code, range[code]
+    end
+    io.puts "</tr>"
+    io.puts "</table>"
+    io.puts "</div>"
+
+    years.each do |year, by_week|
+      total = contribs
+        .select { |date, (count, code)| date.start_with?(year.to_s) && count }
+        .values
+        .map(&:first)
+        .sum
+
+      io.puts "<h2>%d</h2>" % [year]
+
+      io.puts '<table class="heatmap calendar">'
+
+      by_week.each_with_index do |weekdays, idx|
+        io.puts "<!-- #{year} #{Date::ABBR_DAYNAMES[idx]} -->"
+        io.puts "<tr>"
+
+        io.puts '<td class="entry non-day">%s</td>' % [[1, 3, 5].include?(idx) ? Date::ABBR_DAYNAMES[idx][0] : nil]
+
+        weekdays.each_with_index do |(day, (count, code)), wday|
+          if day then
+            io.td day, code, count
+          else
+            io.puts '<td class="entry non-day"></td>'
+          end
+        end
+
+        io.puts "</tr>"
+      end
+
+      io.puts "</table>"
+      io.puts "<small>%d contributions</small>" % [total]
+    end # years
 
-    io.puts <<~EOM
-        </body>
-      </html>
-    EOM
+    io.puts "</body>"
+    io.puts "</html>"
   end
 end

data/test/test_github_contribs.rb

@@ -2,23 +2,18 @@ require "minitest/autorun"
 require "github_contribs"
 
 class TestGithubContribs < Minitest::Test
-  def test_oauth_token
-    gh = GithubContribs.new
-    assert_match(/^gho_\w{36}/, gh.oauth_token, "if this fails, they all fail")
-  end
-
   def test_generate
     name = "zenspider"
     last = Time.now.year
 
     gh = GithubContribs.new
 
-    str = ""
+    str = +""
     io = StringIO.new str
 
     gh.generate name, last, io, :testing
 
-    assert_includes str, "<title>zenspider (Ryan Davis) · GitHub</title>"
-    assert_match(/<svg width="\d+" height="\d+" class="js-calendar-graph-svg">/, str)
+    assert_includes str, "<title>zenspider's contribution calendar</title>"
+    assert_match(/<table class="heatmap calendar">/, str)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_contribs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBCDANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTIxMTIyMzIzMTkwNFoXDTIyMTIyMzIzMTkwNFowRTETMBEGA1UE
+  GRYDY29tMB4XDTI0MDEwMjIxMjEyM1oXDTI1MDEwMTIxMjEyM1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,29 +22,15 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQCKB5jfsuSnKb+t/Wrh3UpdkmX7TrEsjVmERC0pPqzQ5GQJgmEXDD7oMgaKXaAq
-  x2m+KSZDrqk7c8uho5OX6YMqg4KdxehfSLqqTZGoeV78qwf/jpPQZKTf+W9gUSJh
-  zsWpo4K50MP+QtdSbKXZwjAafpQ8hK0MnnZ/aeCsW9ov5vdXpYbf3dpg6ADXRGE7
-  lQY2y1tJ5/chqu6h7dQmnm2ABUqx9O+JcN9hbCYoA5i/EeubUEtFIh2w3SpO6YfB
-  JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
-  YsuyUzsMz6GQA4khyaMgKNSD
+  AQCygvpmncmkiSs9r/Kceo4bBPDszhTv6iBi4LwMReqnFrpNLMOWJw7xi8x+3eL2
+  XS09ZPNOt2zm70KmFouBMgOysnDY4k2dE8uF6B8JbZOO8QfalW+CoNBliefOTcn2
+  bg5IOP7UoGM5lC174/cbDJrJnRG9bzig5FAP0mvsgA8zgTRXQzIUAZEo92D5K7p4
+  B4/O998ho6BSOgYBI9Yk1ttdCtti6Y+8N9+fZESsjtWMykA+WXWeGUScHqiU+gH8
+  S7043fq9EbQdBr2AXdj92+CDwuTfHI6/Hj5FVBDULufrJaan4xUgL70Hvc6pTTeW
+  deKfBjgVAq7EYHu1AczzlUly
   -----END CERTIFICATE-----
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -71,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '4.2'
 description: |-
   A simple commandline tool that downloads yearly contribution graphs
   from github and assembles them into a unified view.
@@ -122,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: A simple commandline tool that downloads yearly contribution graphs from