hubba-reports 0.1.0

data/lib/hubba/reports/reports/stars.rb

@@ -0,0 +1,37 @@
+module Hubba
+
+
+class ReportStars < Report
+
+def build
+
+##  add stars, last_updates, etc.
+##  org description etc??
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Stars"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+
+repos = @stats.repos.sort do |l,r|
+  ## note: use reverse sort (right,left) - e.g. most stars first
+  r.stats.stars <=> l.stats.stars
+end
+
+## pp repos
+
+repos.each_with_index do |repo,i|
+  buf << "#{i+1}. ★#{repo.stats.stars} **#{repo.full_name}** (#{repo.stats.size} kb)\n"
+end
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+buf
+end  # method build
+end  # class ReportStars
+
+
+end  # module Hubba

data/lib/hubba/reports/reports/summary.rb

@@ -0,0 +1,39 @@
+module Hubba
+
+
+class ReportSummary < Report
+
+def build
+## create a (summary report)
+##
+##  add stars, last_updates, etc.
+##  org description etc??
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Summary"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+
+@stats.orgs.each do |org|
+  name  = org[0]
+  repos = org[1]
+  buf << "### #{name} _(#{repos.size})_\n"
+  buf << "\n"
+
+  ### add stats for repos
+  entries = []
+  repos.each do |repo|
+    entries << "**#{repo.name}** ★#{repo.stats.stars} (#{repo.stats.size} kb)"
+  end
+
+  buf << entries.join( ' · ' )   ## use interpunct? - was: • (bullet)
+  buf << "\n\n"
+end
+
+buf
+end  # method build
+end  # class ReportSummary
+
+end # module Hubba

data/lib/hubba/reports/reports/timeline.rb

@@ -0,0 +1,53 @@
+module Hubba
+
+
+class ReportTimeline < Report
+
+def build
+## create a (timeline report)
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Timeline"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+
+repos = @stats.repos.sort do |l,r|
+  ## note: use reverse sort (right,left) - e.g. most stars first
+  ## r[:stars] <=> l[:stars]
+
+  ## sort by created_at (use julian days)
+  r.stats.created.jd <=> l.stats.created.jd
+end
+
+
+## pp repos
+
+
+last_year  = -1
+last_month = -1
+
+repos.each_with_index do |repo,i|
+  year       = repo.stats.created.year
+  month      = repo.stats.created.month
+
+  if last_year != year
+    buf << "\n## #{year}\n\n"
+  end
+
+  if last_month != month
+    buf << "\n### #{month}\n\n"
+  end
+
+  last_year  = year
+  last_month = month
+
+  buf << "- #{repo.stats.created_at.strftime('%Y-%m-%d')} ★#{repo.stats.stars} **#{repo.full_name}** (#{repo.stats.size} kb)\n"
+end
+
+buf
+end  # method build
+end  # class ReportTimeline
+
+end  # module Hubba

data/lib/hubba/reports/reports/topics.rb

@@ -0,0 +1,48 @@
+module Hubba
+
+
+class ReportTopics < Report
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Topics"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+
+topics = {}   ## collect all topics with refs to repos
+
+@stats.repos.each do |repo|
+  repo.stats.topics.each do |topic|
+    repos = topics[ topic ] ||= []
+    repos << repo
+  end
+end
+
+topics = topics.sort {|(ltopic,_),(rtopic,_)|
+                       ltopic <=> rtopic   ## sort topic by a-z
+                     }
+               .to_h    # convert back to hash (from array)
+
+
+topics.each do |topic,repos|
+  buf << "`#{topic}` _(#{repos.size})_\n"
+end
+buf << "\n"
+
+
+topics.each do |topic,repos|
+  buf << "## `#{topic}` _(#{repos.size})_\n"
+
+  buf << repos.map {|repo| repo.full_name }.join( ' · ' )   ## use interpunct? - was: • (bullet)
+  buf << "\n\n"
+end
+
+
+buf
+end  # method build
+end  # class ReportTopics
+
+end # module Hubba

data/lib/hubba/reports/reports/traffic.rb

@@ -0,0 +1,112 @@
+module Hubba
+
+
+class ReportTraffic < Report
+
+def build
+
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Traffic"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+buf << "traffic over the last 14 days - page views / unique, clones / unique\n"
+buf << "\n"
+
+
+### step 1: filter all repos w/o traffic summary
+repos = @stats.repos.select do |repo|
+  traffic = repo.stats.traffic || {}
+  summary = traffic['summary'] || {}
+
+  res = summary['views'] && summary['clones']  ## return true if present
+  puts "    no traffic/summary/{views,clones} - skipping >#{repo.full_name}<..."   unless res
+  res
+end
+
+
+repos = repos.sort do |l,r|
+  lsummary = l.stats.traffic['summary']
+  rsummary = r.stats.traffic['summary']
+
+  ## note: use reverse sort (right,left) - e.g. most page views first
+  res = rsummary['views']['count']    <=> lsummary['views']['count']
+  res = rsummary['views']['uniques']  <=> lsummary['views']['uniques']    if res == 0
+  res = rsummary['clones']['count']   <=> lsummary['clones']['count']     if res == 0
+  res = rsummary['clones']['uniques'] <=> lsummary['clones']['uniques']   if res == 0
+  res = l.full_name                   <=> r.full_name                     if res == 0
+  res
+end
+
+
+repos_by_org = repos.group_by { |repo|
+                                 #  csvreader/csvreader" =>
+                                 #   csvreader
+                                 repo.owner   # user username / org | login
+                               }
+                         .sort { |(lowner,lrepos), (rowner,rrepos)|
+                                 lviews  = lrepos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['views']['count'] }
+                                 rviews  = rrepos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['views']['count'] }
+                                 lclones = lrepos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['clones']['count'] }
+                                 rclones = rrepos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['clones']['count'] }
+                                 res = rviews      <=> lviews
+                                 res = rclones     <=> lclones     if res == 0
+                                 res = lrepos.size <=> rrepos.size if res == 0
+                                 res = lowner      <=> rowner      if res == 0
+                                 res
+                              }
+                        .to_h  ## convert back to hash
+
+
+repos_by_org.each_with_index do |(owner, repos),i|
+  views  = repos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['views']['count'] }
+  clones = repos.reduce(0) {|sum,repo| sum+repo.stats.traffic['summary']['clones']['count'] }
+
+  buf << "#{i+1}. **#{owner}** views: #{views}, clones: #{clones}  _(#{repos.size})_"
+  buf << "\n"
+
+  ### todo - sort by count / uniques !!
+  repos.each do |repo|
+
+    summary = repo.stats.traffic['summary']
+
+    ## note: sublist indent four (4) spaces
+    buf << "    - #{repo.name} -- "
+    buf << " views: #{summary['views']['count']} / #{summary['views']['uniques']} - "
+    buf << " clones: #{summary['clones']['count']} / #{summary['clones']['uniques']}"
+    buf << "\n"
+  end
+end
+
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+
+### all page paths
+buf << "All repos:"
+buf << "\n\n"
+
+
+## pp repos
+
+repos.each_with_index do |repo,i|
+  summary = repo.stats.traffic['summary']
+
+  buf << "#{i+1}.  **#{repo.full_name}** -- "
+  buf << " views: #{summary['views']['count']} / #{summary['views']['uniques']} - "
+  buf << " clones: #{summary['clones']['count']} / #{summary['clones']['uniques']}"
+  buf << "\n"
+end
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+buf
+end  # method build
+end  # class ReportTraffic
+
+
+end # module Hubba

data/lib/hubba/reports/reports/traffic_pages.rb

@@ -0,0 +1,133 @@
+module Hubba
+
+
+class ReportTrafficPages < Report   ## todo/check: rename to TrafficPaths - why? why not?
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Traffic Pages"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+buf << "popular pages over the last 14 days - page views / unique\n"
+buf << "\n"
+
+
+### step 1: filter all repos w/o traffic summary
+repos = @stats.repos.select do |repo|
+  traffic = repo.stats.traffic || {}
+  summary = traffic['summary'] || {}
+
+  paths = summary['paths']
+  res = paths && paths.size > 0  ## return true if present and non-empty array too
+  puts "    no traffic/summary/paths - skipping >#{repo.full_name}<..."   unless res
+  res
+end
+
+## collect all paths entries
+lines = []
+repos.each do |repo|
+  summary = repo.stats.traffic['summary']
+  # e.g.
+  # "paths": [
+  #  {
+  #    "path": "/csvreader/csvreader",
+  #    "title": "GitHub - csvreader/csvreader: csvreader library / gem - read tabular data in ...",
+  #    "count": 33,
+  #    "uniques": 25
+  #  },
+
+  paths  = summary['paths']
+  if paths
+    ### clean (normalize) paths
+    paths.each do |line|
+      # "/csvreader/csvreader" =>
+      #   csvreader/csvreader
+      path = line['path'][1..-1]  ## cut of leading slash (/)
+
+      ## /blob/master, /tree/master, /master
+      path = path.sub( %r{/blob/(master|gh-pages)(?=/)}, '' )
+      path = path.sub( %r{/tree/(master|gh-pages)(?=/)}, '' )
+      path = path.sub( %r{/(master|gh-pages)(?=/|$)}, '' )   ## ending in master (e.g. /search/master)
+
+      line['path'] = path
+    end
+    lines += paths
+  end
+end
+
+
+## sort by 1) count
+##         2) uniques
+##         3) a-z path
+lines = lines.sort do |l,r|
+  res =   r['count']   <=> l['count']
+  res =   r['uniques'] <=> l['uniques']  if res == 0
+  res =   l['path']    <=> r['path']     if res == 0
+  res
+end
+
+
+lines_by_path = lines.group_by { |line|
+                                 parts = line['path'].split( '/' )
+                                 parts[0]
+                               }
+                         .sort { |(lpath,llines), (rpath,rlines)|
+                                 lcount = llines.reduce(0) {|sum,line| sum+line['count'] }
+                                 rcount = rlines.reduce(0) {|sum,line| sum+line['count'] }
+                                 res = rcount      <=> lcount
+                                 res = llines.size <=> rlines.size if res == 0
+                                 res = lpath       <=> rpath       if res == 0
+                                 res
+                              }
+                        .to_h  ## convert back to hash
+
+
+lines_by_path.each_with_index do |(path, lines),i|
+  count   = lines.reduce(0) {|sum,line| sum+line['count']}
+  uniques = lines.reduce(0) {|sum,line| sum+line['uniques']}
+  buf << "#{i+1}. **#{path}** #{count} / #{uniques}  _(#{lines.size})_"
+  buf << "\n"
+
+  ### todo - sort by count / uniques !!
+  lines.each do |line|
+    ## e.g. convert
+    ##        openfootball/football.json/tree/master/2020  =>
+    ##                     football.json/tree/master/2020
+    parts = line['path'].split( '/' )
+    path =  parts[1..-1].join( '/' )
+
+    ## note: sublist indent four (4) spaces
+    buf << "    - #{line['count']} / #{line['uniques']} -- #{path}"
+    buf << "\n"
+  end
+end
+
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+### all page paths
+buf << "All pages:"
+buf << "\n\n"
+
+lines.each_with_index do |line,i|
+  buf <<  "#{i+1}. #{line['count']} / #{line['uniques']} -- #{line['path']}"
+  buf <<  "\n"
+end
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+buf
+end  # method build
+
+
+
+
+end  # class ReportTrafficPages
+
+
+end  # module Hubba

data/lib/hubba/reports/reports/traffic_referrers.rb

@@ -0,0 +1,115 @@
+module Hubba
+
+
+class ReportTrafficReferrers < Report
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Traffic Referrers"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+
+buf << "popular referrer sources over the last 14 days - page views / unique\n"
+buf << "\n"
+
+
+### step 1: filter all repos w/o traffic summary
+repos = @stats.repos.select do |repo|
+  traffic = repo.stats.traffic || {}
+  summary = traffic['summary'] || {}
+
+  referrers = summary['referrers']
+  res = referrers && referrers.size > 0  ## return true if present and non-empty array too
+  puts "    no traffic/summary/referrers - skipping >#{repo.full_name}<..."   unless res
+  res
+end
+
+## collect all referrers entries
+lines = []
+repos.each do |repo|
+  summary = repo.stats.traffic['summary']
+  # e.g.
+  # "referrers" =>
+  #   [{"referrer"=>"github.com", "count"=>327, "uniques"=>198},
+  #    {"referrer"=>"openfootball.github.io", "count"=>71, "uniques"=>54},
+  #    {"referrer"=>"Google", "count"=>5, "uniques"=>5},
+  #    {"referrer"=>"reddit.com", "count"=>4, "uniques"=>4}]
+
+
+  referrers  = summary['referrers']
+  if referrers
+    lines += referrers.map do |referrer|
+                # note: return a new copy with (repo) path added
+                referrer.merge( 'path' => repo.full_name )
+             end
+  end
+end
+
+
+
+## sort by 1) count
+##         2) uniques
+##         3) a-z referrer
+##         4) a-z path
+lines = lines.sort do |l,r|
+  res =   r['count']    <=> l['count']
+  res =   r['uniques']  <=> l['uniques']     if res == 0
+  res =   l['referrer'] <=> r['referrer']    if res == 0
+  res =   l['path']     <=> r['path']        if res == 0
+  res
+end
+
+
+lines_by_referrer = lines.group_by { |line| line['referrer'] }
+                         .sort { |(lreferrer,llines),
+                                  (rreferrer,rlines)|
+                                    lcount = llines.reduce(0) {|sum,line| sum+line['count'] }
+                                    rcount = rlines.reduce(0) {|sum,line| sum+line['count'] }
+                                   res =  rcount <=> lcount
+                                   res = llines.size <=> rlines.size if res == 0
+                                   res = lreferrer   <=> rreferrer   if res == 0
+                                   res
+                               }
+                          .to_h  ## convert back to hash
+
+
+lines_by_referrer.each_with_index do |(referrer, lines),i|
+  count   = lines.reduce(0) {|sum,line| sum+line['count']}
+  uniques = lines.reduce(0) {|sum,line| sum+line['uniques']}
+  buf << "#{i+1}. **#{referrer}** #{count} / #{uniques}  _(#{lines.size})_"
+  buf << "\n"
+
+  ### todo - sort by count / uniques !!
+  lines.each do |line|
+    ## note: sublist indent four (4) spaces
+    buf << "    - #{line['count']} / #{line['uniques']} -- #{line['path']}"
+    buf << "\n"
+  end
+end
+
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+### all referrer sources / records by page views
+buf << "All referrers:"
+buf << "\n\n"
+
+lines.each_with_index do |line,i|
+  buf <<  "- #{line['referrer']} -- #{line['count']} / #{line['uniques']} -- #{line['path']}"
+  buf <<  "\n"
+end
+
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+
+buf
+end  # method build
+end  # class ReportTrafficReferrers
+
+end  # module Hubba