hubba-reports 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3457b7a9fc6910bbe26fa50975203b0123eee0e6
+  data.tar.gz: b3229be480bad757b65a987add58e1d78ddec955
+SHA512:
+  metadata.gz: e609a974ebca9b84cef071a7661a4d4ba85738432baba7a8c52de3538062ddc3ecd8fd6ca4632b8f88a428f3d201d7d9db49540b372a6140836af1908ecdeb0c
+  data.tar.gz: '091fe8391851921111298102ad2670f39f82c3b4e50db072f28350a9424a477dadb34c40f462780cd0bd107f38a9501971074eaf38a4e962786238c28bd00409'

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.0.1 / 2020-10-14
+
+* Everything is new. First release.
+

data/Manifest.txt

@@ -0,0 +1,27 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/hubba/reports.rb
+lib/hubba/reports/folio.rb
+lib/hubba/reports/reports/base.rb
+lib/hubba/reports/reports/catalog.rb
+lib/hubba/reports/reports/size.rb
+lib/hubba/reports/reports/stars.rb
+lib/hubba/reports/reports/summary.rb
+lib/hubba/reports/reports/timeline.rb
+lib/hubba/reports/reports/topics.rb
+lib/hubba/reports/reports/traffic.rb
+lib/hubba/reports/reports/traffic_pages.rb
+lib/hubba/reports/reports/traffic_referrers.rb
+lib/hubba/reports/reports/trending.rb
+lib/hubba/reports/reports/updates.rb
+lib/hubba/reports/stats.rb
+lib/hubba/reports/version.rb
+test/helper.rb
+test/stats/j/jekyll~minima.json
+test/stats/o/openblockchains~awesome-blockchains.json
+test/stats/o/opendatajson~factbook.json.json
+test/stats/p/poole~hyde.json
+test/test_stats.rb
+test/test_stats_tmp.rb

data/README.md

@@ -0,0 +1,177 @@
+# hubba-reports
+
+hubba-reports gem - auto-generate github statistics / analytics reports from github api data (stars, timeline, traffic, top pages, top referrers, etc.)
+
+* home  :: [github.com/rubycoco/git](https://github.com/rubycoco/git)
+* bugs  :: [github.com/rubycoco/git/issues](https://github.com/rubycoco/git/issues)
+* gem   :: [rubygems.org/gems/hubba-reports](https://rubygems.org/gems/hubba-reports)
+* rdoc  :: [rubydoc.info/gems/hubba-reports](http://rubydoc.info/gems/hubba-reports)
+
+
+
+## Usage
+
+### Step 0: Data, Data, Data
+
+See the [hubba gem](https://github.com/rubycoco/git/tree/master/hubba) on how to collect github data (daily, weekly, monthly, etc.).
+
+
+
+###  Generate some statistics / reports
+
+
+Hubba has four built-in reports (for now):
+
+- `ReportSummary`  - A-Z list of your repos by orgs with stars and size in kb
+- `ReportStars`    - your repos ranked by stars
+- `ReportTimeline` - your repos in reverse chronological order by creation
+- `ReportUpdates`  - your repos in reverse chronological order by last commit
+
+
+If you only generate a single report, use:
+
+``` ruby
+require 'hubba/reports'
+
+report = Hubba::ReportSummary.new( './repos.yml' )
+report.save( './SUMMARY.md' )
+```
+
+
+If you generate more reports, (re)use the in-memory statistics cache / object:
+
+``` ruby
+stats = Hubba.stats( './repos.yml' )
+
+report = Hubba::ReportSummary.new( stats )
+report.save( './SUMMARY.md' )
+
+report = Hubba::ReportStars.new( stats )
+report.save( './STARS.md' )
+
+report = Hubba::ReportTimeline.new( stats )
+report.save( './TIMELINE.md' )
+
+report = Hubba::ReportUpdates.new( stats )
+report.save( './UPDATES.md' )
+```
+
+
+### Report Examples
+
+#### Report Example - Summary
+
+A-Z list of your repos by orgs with stars and size in kb.
+Results in:
+
+---
+
+> ### geraldb _(11)_
+>
+> **austria** ★1 (552 kb) · **catalog** ★3 (156 kb) · **chelitas** ★1 (168 kb) · **geraldb.github.io** ★1 (520 kb) · **logos** ★1 (363 kb) · **sandbox** ★2 (529 kb) · **talks** ★200 (16203 kb) · **web-proxy-win** ★8 (152 kb) · **webcomponents** ★1 (164 kb) · **webpub-reader** ★3 (11 kb) · **wine.db.tools** ★1 (252 kb)
+>
+> ...
+
+---
+
+(Live Example - [`SUMMARY.md`](https://github.com/yorobot/backup/blob/master/SUMMARY.md))
+
+
+#### Report Example - Stars
+
+Your repos ranked by stars. Results in:
+
+---
+
+> 1. ★2936 **openblockchains/awesome-blockchains** (2514 kb)
+> 2. ★851 **planetjekyll/awesome-jekyll-plugins** (148 kb)
+> 3. ★604 **factbook/factbook.json** (7355 kb)
+> 4. ★593 **openfootball/football.json** (2135 kb)
+> 5. ★570 **openmundi/world.db** (1088 kb)
+> 6. ★552 **openblockchains/programming-blockchains** (552 kb)
+> 7. ★547 **mundimark/awesome-markdown** (83 kb)
+> 8. ★532 **planetjekyll/awesome-jekyll** (110 kb)
+> 9. ★489 **cryptocopycats/awesome-cryptokitties** (4154 kb)
+> 10. ★445 **openfootball/world-cup** (638 kb)
+>
+> ...
+
+---
+
+(Live Example: [`STARS.md`](https://github.com/yorobot/backup/blob/master/STARS.md))
+
+
+#### Report Example - Timeline
+
+Your repos in reverse chronological order by creation.
+Results in:
+
+---
+
+> ## 2020
+>
+> ### 9
+>
+> - 2020-09-18 ★1 **yorobot/workflow** (83 kb)
+>
+> ### 6
+>
+> - 2020-06-27 ★2 **yorobot/sport.db.more** (80 kb)
+> - 2020-06-24 ★1 **yorobot/stage** (554 kb)
+> - 2020-06-11 ★1 **yorobot/cache.csv** (336 kb)
+>
+> ...
+
+---
+
+(Live Example: [`TIMELINE.md`](https://github.com/yorobot/backup/blob/master/TIMELINE.md))
+
+
+
+#### Report Example - Updates
+
+Your repos in reverse chronological order by last commit. Results in:
+
+---
+
+> committed / pushed / updated / created
+>
+> - (1d) **yorobot/backup** ★4 - 2020-10-08 (=/=) / 2020-10-08 (=) / 2020-10-08 / 2015-04-04 - ‹› (1595 kb)
+> - (1d) **yorobot/logs** ★1 - 2020-10-08 (=/=) / 2020-10-08 (=) / 2020-10-08 / 2016-09-13 - ‹› (172 kb)
+> - (1d) **rubycoco/git** ★9 - 2020-10-08 (=/=) / 2020-10-08 (=) / 2020-10-08 / 2015-11-16 - ‹› (88 kb)
+> - (1d) **openfootball/football.json** ★593 - 2020-10-08 (=/=) / 2020-10-08 (=) / 2020-10-08 / 2015-09-17 - ‹› (2135 kb)
+> - (2d) **yorobot/workflow** ★1 - 2020-10-07 (=/=) / 2020-10-07 (=) / 2020-10-07 / 2020-09-18 - ‹› (83 kb)
+> - (2d) **rubycoco/webclient** ★5 - 2020-10-07 (=/=) / 2020-10-07 (=) / 2020-10-07 / 2012-06-02 - ‹› (39 kb)
+> - (3d) **footballcsv/belgium** ★1 - 2020-10-06 (=/=) / 2020-10-06 (=) / 2020-10-06 / 2014-07-25 - ‹› (314 kb)
+> - (3d) **footballcsv/england** ★105 - 2020-10-06 (=/=) / 2020-10-06 (=) / 2020-10-06 / 2014-07-23 - ‹› (8666 kb)
+> - (3d) **footballcsv/austria** ★1 - 2020-10-06 (=/=) / 2020-10-06 (=) / 2020-10-06 / 2018-07-16 - ‹› (91 kb)
+> - (3d) **footballcsv/espana** ★15 - 2020-10-06 (=/=) / 2020-10-06 (=) / 2020-10-06 / 2014-07-23 - ‹› (1107 kb)
+> - (3d) **footballcsv/deutschland** ★5 - 2020-10-06 (=/=) / 2020-10-06 (=) / 2020-10-06 / 2014-07-25 - ‹› (1343 kb)
+>
+> ...
+
+---
+
+(Live Example: [`UPDATES.md`](https://github.com/yorobot/backup/blob/master/UPDATES.md))
+
+
+
+That's all for now.
+
+
+
+## Installation
+
+Use
+
+    gem install hubba-reports
+
+or add the gem to your Gemfile
+
+    gem 'hubba-reports'
+
+
+## License
+
+The `hubba` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'hoe'
+require './lib/hubba/reports/version.rb'
+
+Hoe.spec 'hubba-reports' do
+
+  self.version = HubbaReports::VERSION
+
+  self.summary = 'hubba-reports - auto-generate github statistics / analytics reports from github api data (stars, timeline, traffic, top pages, top referrers, etc.)'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycoco/git' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'ruby-talk@ruby-lang.org'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['hubba', '>= 0.7.0']
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/hubba/reports.rb

@@ -0,0 +1,42 @@
+require 'hubba'
+
+
+######
+# our own code
+require 'hubba/reports/version'   # note: let version always go first
+require 'hubba/reports/stats'
+require 'hubba/reports/folio'
+
+require 'hubba/reports/reports/base'
+require 'hubba/reports/reports/catalog'
+require 'hubba/reports/reports/size'
+require 'hubba/reports/reports/stars'
+require 'hubba/reports/reports/summary'
+require 'hubba/reports/reports/timeline'
+require 'hubba/reports/reports/topics'
+require 'hubba/reports/reports/traffic_pages'
+require 'hubba/reports/reports/traffic_referrers'
+require 'hubba/reports/reports/traffic'
+require 'hubba/reports/reports/trending'
+require 'hubba/reports/reports/updates'
+
+
+
+
+module Hubba
+  def self.stats( hash_or_path='./repos.yml' )   ## use read_stats or such - why? why not?
+    h = if hash_or_path.is_a?( String )    ## assume it is a file path!!!
+          path = hash_or_path
+          YAML.load_file( path )
+        else
+          hash_or_path  # assume its a hash / reposet already!!!
+        end
+
+    Folio.new( h )  ## wrap in "easy-access" facade / wrapper
+  end  ## method stats
+end # module Hubba
+
+
+# say hello
+puts HubbaReports.banner
+

data/lib/hubba/reports/folio.rb

@@ -0,0 +1,60 @@
+module Hubba
+
+class Folio    # todo/check: use a different name e.g (Port)Folio, Cache, Summary, (Data)Base, Census, Catalog, Collection, Index, Register or such???
+class Repo  ## (nested) class
+
+  attr_reader :owner,
+              :name
+
+  def initialize( owner, name )
+    @owner = owner   ## rename to login, username - why? why not?
+    @name  = name    ## rename to reponame ??
+  end
+
+  def full_name() "#{owner}/#{name}"; end
+
+  def stats
+    ## note: load stats on demand only (first access) for now - why? why not?
+    @stats ||= begin
+                 stats = Stats.new( full_name )
+                 stats.read
+                 stats
+               end
+  end
+
+  def diff
+    @diff ||= stats.calc_diff_stars( samples: 3, days: 30 )
+  end
+end  # (nested) class Repo
+
+
+attr_reader :orgs, :repos
+
+def initialize( h )
+  @orgs     = []    # orgs and users -todo/check: use better name - logins or owners? why? why not?
+  @repos    = []
+  add( h )
+
+  puts "#{@repos.size} repos @ #{@orgs.size} orgs"
+end
+
+#############
+## private helpes
+def add( h )   ## add repos.yml set
+  h.each do |org_with_counter, names|
+    ## remove optional number from key e.g.
+    ##   mrhydescripts (3)    =>  mrhydescripts
+    ##   footballjs (4)       =>  footballjs
+    ##   etc.
+    org = org_with_counter.sub( /\([0-9]+\)/, '' ).strip
+    repos = []
+    names.each do |name|
+      repo = Repo.new( org, name )
+      repos << repo
+    end
+    @orgs << [org, repos]
+    @repos += repos
+  end
+end
+end  # class Folio
+end  # module Hubba

data/lib/hubba/reports/reports/base.rb

@@ -0,0 +1,36 @@
+module Hubba
+
+class Report
+  def initialize( stats_or_hash_or_path=Hubba.stats )
+    ## puts "[debug] Report#initialize:"
+    ## pp  stats_or_hash_or_path   if stats_or_hash_or_path.is_a?( String )
+
+    @stats = if stats_or_hash_or_path.is_a?( String ) ||
+                stats_or_hash_or_path.is_a?( Hash )
+                  hash_or_path = stats_or_hash_or_path
+                  Hubba.stats( hash_or_path )
+             else
+                  stats_or_hash_or_path  ## assume Summary/Stats - todo/fix: double check!!!
+             end
+  end
+
+
+  def save( path )
+    buf = build
+
+    banner =<<TXT
+Auto-generated github (statistics) report;
+built with [Hubba v#{HubbaReports::VERSION}](https://github.com/rubycoco/git/tree/master/hubba-reports).
+
+
+TXT
+
+    puts "writing report >#{path}< ..."
+    File.open( path, "w:utf-8" ) do |f|
+      f.write( banner )   ## add banner for now - why? why not?
+      f.write( buf )
+    end
+  end
+end  ## class Report
+
+end # module Hubba

data/lib/hubba/reports/reports/catalog.rb

@@ -0,0 +1,44 @@
+module Hubba
+
+
+class ReportCatalog < Report
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Catalog"
+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
+  repos.each do |repo|
+
+    buf << "**#{repo.name}** ★#{repo.stats.stars} (#{repo.stats.size} kb)"
+    buf << "  <br>\n"
+
+    buf << "_#{repo.stats.description}_"
+
+    if repo.stats.topics && repo.stats.topics.size > 0
+      buf << "  <br>\n"
+      ## wrap in backtip (verbatim code)
+      buf << repo.stats.topics.map {|topic| "`#{topic}`" }.join( ' · ' )  ## use interpunct? - was: • (bullet)
+    end
+    buf << "\n\n"
+  end
+
+  buf << "\n"
+end
+
+buf
+end  # method build
+end  # class ReportCatalog
+
+end # module Hubba

data/lib/hubba/reports/reports/size.rb

@@ -0,0 +1,38 @@
+module Hubba
+
+
+class ReportSize < 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 << "# Size in KB"
+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
+  res = r.stats.size <=> l.stats.size
+  res = l.full_name  <=> r.full_name    if res == 0
+  res
+end
+
+
+repos.each_with_index do |repo,i|
+  buf << "#{i+1}. #{repo.stats.size} kb - **#{repo.full_name}**\n"
+end
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+buf
+end  # method build
+end  # class ReportSize
+
+
+end  # module Hubba