hubba-reports 0.1.0

data/lib/hubba/reports/reports/trending.rb

@@ -0,0 +1,51 @@
+module Hubba
+
+class ReportTrending < Report
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Trending"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs"
+buf << "\n\n"
+
+###
+## todo:
+##   use calc per month (days: 30)
+##   per week is too optimistic (e.g. less than one star/week e.g. 0.6 or something)
+
+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[:created_at].to_date.jd <=> l[:created_at].to_date.jd
+
+  res = r.diff <=> l.diff
+  res = r.stats.stars <=> l.stats.stars  if res == 0
+  res = r.stats.created.jd <=> l.stats.created.jd  if res == 0
+  res
+end
+
+
+## pp repos
+
+
+repos.each_with_index do |repo,i|
+  if repo.diff == 0
+    buf << "-  -/- "
+  else
+    buf << "- #{repo.diff}/month "
+  end
+
+  buf <<  " ★#{repo.stats.stars} **#{repo.full_name}** (#{repo.stats.size} kb) - "
+  buf <<  "#{repo.stats.history_str}\n"
+end
+
+
+buf
+end  # method build
+end  # class ReportTrending
+
+end  # module Hubba

data/lib/hubba/reports/reports/updates.rb

@@ -0,0 +1,60 @@
+module Hubba
+
+
+class ReportUpdates < Report
+
+def build
+
+## note: orgs is orgs+users e.g. geraldb, yorobot etc
+buf = String.new('')
+buf << "# Updates"
+buf << " - #{@stats.repos.size} Repos @ #{@stats.orgs.size} Orgs\n"
+buf << "\n\n"
+
+repos = @stats.repos.sort do |l,r|
+  r.stats.committed.jd <=> l.stats.committed.jd
+end
+
+## pp repos
+
+
+buf << "committed / pushed / updated / created\n\n"
+
+today = Date.today
+
+repos.each_with_index do |repo,i|
+
+  days_ago = today.jd - repo.stats.committed.jd
+
+  diff1 = repo.stats.committed.jd - repo.stats.pushed.jd
+  diff2 = repo.stats.committed.jd - repo.stats.updated.jd
+  diff3 = repo.stats.pushed.jd    - repo.stats.updated.jd
+
+  buf <<  "- (#{days_ago}d) **#{repo.full_name}** ★#{repo.stats.stars} - "
+  buf <<  "#{repo.stats.committed} "
+  buf <<  "("
+  buf <<  (diff1==0 ? '=' : "#{diff1}d")
+  buf <<  "/"
+  buf <<  (diff2==0 ? '=' : "#{diff2}d")
+  buf <<  ")"
+  buf <<  " / "
+  buf <<  "#{repo.stats.pushed} "
+  buf <<  "("
+  buf <<  (diff3==0 ? '=' : "#{diff3}d")
+  buf <<  ")"
+  buf <<  " / "
+  buf <<  "#{repo.stats.updated} / "
+  buf <<  "#{repo.stats.created} - "
+  buf <<  "‹#{repo.stats.last_commit_message}›"
+  buf <<  " (#{repo.stats.size} kb)"
+  buf <<  "\n"
+end
+buf << "<!-- break -->\n"   ## markdown hack: add a list end marker
+buf << "\n\n"
+
+
+buf
+end  # method build
+end  # class ReportUpdates
+
+end  # module Hubba

data/lib/hubba/reports/stats.rb

@@ -0,0 +1,230 @@
+module Hubba
+
+  ####
+  #  keep track of repo stats over time (with history hash)
+
+  class Stats     ## todo/check: rename to GithubRepoStats or RepoStats - why? why not?
+
+    ##  attr_reader :data  - needed - why? why not?
+
+    def full_name()    @data['full_name']; end
+    def description()  @data['description'] || ''; end  ## todo/check: return nil if not found - why? why not?
+    alias_method :descr, :description
+    alias_method :desc,  :description
+
+    def topics()      @data['topics'] || []; end   ## todo/check: return nil if not found - why? why not?
+
+
+    ## note: return datetime objects (NOT strings); if not present/available return nil/null
+    def created_at() @cache['created_at'] ||= parse_datetime( @data['created_at'] ); end
+    def updated_at() @cache['updated_at'] ||= parse_datetime( @data['updated_at'] ); end
+    def pushed_at()  @cache['pushed_at']  ||= parse_datetime( @data['pushed_at'] );  end
+
+    ## date (only) versions
+    def created() @cache['created'] ||= parse_date( @data['created_at'] ); end
+    def updated() @cache['updated'] ||= parse_date( @data['updated_at'] ); end
+    def pushed()  @cache['pushed']  ||= parse_date( @data['pushed_at'] ); end
+
+    def size
+      # size of repo in kb (as reported by github api)
+      @data['size'] || 0   ## return 0 if not found - why? why not? (return nil - why? why not??)
+    end
+
+
+    def history
+      @cache['history'] ||= begin
+                              if @data['history']
+                                build_history( @data['history'] )
+                              else
+                                nil
+                              end
+                            end
+    end
+
+
+    def stars
+      ## return last stargazers_count entry (as number; 0 if not found)
+      @cache['stars'] ||= history ? history[0].stars : 0
+    end
+
+    ###################
+    # traffic
+    def traffic() @data['traffic']; end
+
+
+    ###########
+    # commits
+    def commits() @data['commits']; end
+
+    def last_commit   ## convenience shortcut; get first/last commit (use [0]) or nil
+      if @data['commits'] && @data['commits'][0]
+         @data['commits'][0]
+      else
+         nil
+      end
+    end
+
+
+    def committed   ## last commit date (from author NOT committer)
+      @cache['committed'] ||= parse_date( last_commit_author_date )
+    end
+
+    def committed_at()   ## last commit date (from author NOT committer)
+      @cache['committed_at'] ||= parse_datetime( last_commit_author_date )
+    end
+
+    def last_commit_author_date
+      h = last_commit
+      h ? h['author']['date'] : nil
+    end
+
+
+    def last_commit_message    ## convenience shortcut; last commit message
+      h = last_commit
+
+      committer_name = h['committer']['name']
+      author_name    = h['author']['name']
+      message        = h['message']
+
+      buf = ""
+      buf << message
+      buf << " by #{author_name}"
+
+      if committer_name != author_name
+        buf << " w/ #{committer_name}"
+      end
+    end  # method commit_message
+
+
+
+    ###
+    # helpers
+    def parse_datetime( str ) str ? DateTime.strptime( str, '%Y-%m-%dT%H:%M:%S') : nil; end
+    def parse_date( str )     str ? Date.strptime( str, '%Y-%m-%d') : nil; end
+
+########
+## build history items (structs)
+
+    class HistoryItem
+
+      attr_reader   :date, :stars, :forks    ## read-only attributes
+      attr_accessor :prev, :next     ## read/write attributes (for double linked list/nodes/items)
+
+      def initialize( date:, stars:, forks: )
+        @date  = date
+        @stars = stars
+        @forks = forks
+        @next  = nil
+      end
+
+      ## link items (append item at the end/tail)
+      def append( item )
+        @next = item
+        item.prev = self
+      end
+
+      def diff_days
+        if @next
+          ## note: use jd=julian days for calculation
+          @date.jd - @next.date.jd
+        else
+          nil   ## last item (tail)
+        end
+      end
+
+      def diff_stars
+        if @next
+          @stars - @next.stars
+        else
+          nil   ## last item (tail)
+        end
+      end
+    end  ## class HistoryItem
+
+
+    def build_history( timeseries )
+      items = []
+
+      keys  = timeseries.keys.sort.reverse   ## newest (latest) items first
+      keys.each do |key|
+        h = timeseries[ key ]
+
+        item = HistoryItem.new(
+                 date:  Date.strptime( key, '%Y-%m-%d' ),
+                 stars: h['stargazers_count'] || 0,
+                 forks: h['forks_count'] || 0 )
+
+        ## link items
+        last_item = items[-1]
+        last_item.append( item )   if last_item     ## if not nil? append (note first item has no prev item)
+
+        items << item
+      end
+
+      ## todo/check: return [] for empty items array (items.empty?) - why?? why not??
+      if items.empty?
+        nil
+      else
+        items
+      end
+    end  ## method build_history
+
+
+
+  def calc_diff_stars( samples: 3, days: 30 )
+    ## samples: use n history item samples e.g. 3 samples
+    ## days e.g. 7 days (per week), 30 days (per month)
+
+    if history.nil?
+      nil   ## todo/check: return 0.0 too - why? why not?
+    elsif history.size == 1
+      ## just one item; CANNOT calc diff; return zero
+      0.0
+    else
+      idx   = [history.size, samples].min   ## calc last index
+      last  = history[idx-1]
+      first = history[0]
+
+      diff_days  = first.date.jd - last.date.jd
+      diff_stars = first.stars   - last.stars
+
+      ## note: use factor 1000 for fixed integer division
+      ##  converts to float at the end
+
+      ##  todo: check for better way (convert to float upfront - why? why not?)
+
+      diff = (diff_stars * days * 1000) / diff_days
+      ##  puts "diff=#{diff}:#{diff.class.name}"    ## check if it's a float
+      (diff.to_f/1000.0)
+    end
+  end
+
+
+  def history_str  ## todo/check: rename/change to format_history or fmt_history - why? why not?
+    ## returns "pretty printed" history as string buffer
+    buf = ''
+    buf << "[#{history.size}]: "
+
+    history.each do |item|
+      buf << "#{item.stars}"
+
+      diff_stars = item.diff_stars
+      diff_days  = item.diff_days
+      if diff_stars && diff_days  ## note: last item has no diffs
+        if diff_stars > 0 || diff_stars < 0
+          if diff_stars > 0
+            buf << " (+#{diff_stars}"
+          else
+            buf << " (#{diff_stars}"
+          end
+          buf << " in #{diff_days}d) "
+        else  ## diff_stars == 0
+          buf << " (#{diff_days}d) "
+        end
+      end
+    end
+    buf
+  end # method history_str
+  end # class Stats
+
+end # module Hubba

data/lib/hubba/reports/version.rb

@@ -0,0 +1,18 @@
+module HubbaReports
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "hubba-reports/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )}"
+  end
+end # module HubbaReports

data/test/helper.rb

@@ -0,0 +1,11 @@
+# minitest setup
+require 'minitest/autorun'
+
+
+## note: also use local version of hubba!!!
+$LOAD_PATH.unshift( "../hubba/lib" )
+
+
+## our own code
+require 'hubba/reports'
+

data/test/stats/j/jekyll~minima.json

@@ -0,0 +1,25 @@
+{
+  "full_name": "jekyll/minima",
+  "created_at": "2016-05-20T23:07:56Z",
+  "updated_at": "2018-02-11T16:13:33Z",
+  "pushed_at": "2018-02-07T22:14:11Z",
+  "size": 321,
+  "history": {
+    "2018-02-12": {
+      "stargazers_count": 717
+    }
+  },
+  "commits": [
+    {
+      "author": {
+        "name": "ashmaroli",
+        "date": "2018-02-21T19:35:59Z"
+      },
+      "committer": {
+        "name": "Frank Taillandier",
+        "date": "2018-02-21T19:35:59Z"
+      },
+      "message": "social icons should resolve baseurl properly (#201)"
+    }
+  ]
+}

data/test/stats/o/openblockchains~awesome-blockchains.json

@@ -0,0 +1,27 @@
+{
+  "full_name": "openblockchains/awesome-blockchains",
+  "created_at": "2017-09-13T22:33:56Z",
+  "size": 1620,
+  "history": {
+    "2017-12-10": {
+      "stargazers_count": 1084
+    },
+    "2018-01-28": {
+      "stargazers_count": 1411
+    },
+    "2018-02-08": {
+      "stargazers_count": 1526
+    }
+  },
+  "commits": [
+    {
+      "committer": {
+        "date": "2018-02-08T09:33:28Z",
+        "name": "Gerald Bauer"
+      },
+      "message": "Update README.md\n\nJust a little typo cryto -> crypto."
+    }
+  ],
+  "updated_at": "2018-02-08T19:26:35Z",
+  "pushed_at": "2018-02-08T09:33:29Z"
+}

data/test/stats/o/opendatajson~factbook.json.json

@@ -0,0 +1,39 @@
+{
+  "full_name": "opendatajson/factbook.json",
+  "created_at": "2014-07-12T12:43:52Z",
+  "history": {
+    "2017-02-11": {
+      "stargazers_count": 457
+    },
+    "2017-02-12": {
+      "stargazers_count": 457
+    },
+    "2017-06-18": {
+      "stargazers_count": 505
+    },
+    "2017-07-28": {
+      "stargazers_count": 512
+    },
+    "2017-12-10": {
+      "stargazers_count": 533
+    },
+    "2018-01-28": {
+      "stargazers_count": 536
+    },
+    "2018-02-08": {
+      "stargazers_count": 539
+    }
+  },
+  "commits": [
+    {
+      "committer": {
+        "date": "2017-03-29T17:23:29Z",
+        "name": "GitHub"
+      },
+      "message": "Update MONGO.md"
+    }
+  ],
+  "size": 7355,
+  "updated_at": "2018-02-01T12:35:19Z",
+  "pushed_at": "2017-03-29T17:23:30Z"
+}