hubba 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 990a81f63411ae5b97cd3ae1e6892cb8e8f788d3
-  data.tar.gz: 1061e2b8963f97072cbdcedb5c6ba8c23ac3b691
+  metadata.gz: e3e04406b046b751a5eb400e8955417ae99498e7
+  data.tar.gz: 57752bfd47aea766d3db5c467659876216a644a0
 SHA512:
-  metadata.gz: 05efa27d809de02a2e5582abe3c0d9b8f70629246d6d973d640b3fbb648365d7e0c6ecf32359837b06a83b2607d1ed4d9b5799af9c0f27d4244cce4dfe235a23
-  data.tar.gz: 9ad616f2209a6f1c566b895d0e908b5a1cc5706d85626eb0519bb74117d4a6b4dc2f71c40eac2adb3e7caa1cfe4af33cfd1f7de57d96dd2d2390126a99e58899
+  metadata.gz: f96d7fa167b0e7cf8b685674aa80d19eca790ad237a9ea43cd40650d1c799448ce5827b009bb84b9d14c774b991693e1b0570735bf6573f64ed2c0a9e46c1c1f
+  data.tar.gz: 5cbdcd4a949763f19ba6275cec64cc1f3cfda6b05abe02950721befac8df17b1a5a1d64d1e41ae8048d23c06b93f41436d69bde91338e81313aa6e19af89236a

data/Manifest.txt

@@ -11,6 +11,11 @@ lib/hubba/version.rb
 test/cache/users~geraldb~orgs.json
 test/cache/users~geraldb~repos.json
 test/helper.rb
+test/stats/jekyll~minima.json
+test/stats/openblockchains~awesome-blockchains.json
+test/stats/opendatajson~factbook.json.json
+test/stats/poole~hyde.json
 test/test_cache.rb
 test/test_config.rb
 test/test_stats.rb
+test/test_stats_tmp.rb

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'hubba' do
 
   self.version = Hubba::VERSION
 
-  self.summary = 'hubba -  (yet) another (lite) GitHub HTTP API client / library'
+  self.summary = 'hubba - (yet) another (lite) GitHub HTTP API client / library'
   self.description = summary
 
   self.urls    = ['https://github.com/gittiscripts/hubba']

data/lib/hubba/stats.rb

@@ -14,37 +14,156 @@ module Hubba
       @data['full_name'] = full_name  # e.g. poole/hyde etc.
     end
 
-    def full_name()   @data['full_name']; end
 
-    def created_at()  @data['created_at']; end
-    def updated_at()  @data['updated_at']; end
-    def pushed_at()   @data['pushed_at']; end
+    def full_name() @full_name ||= @data['full_name']; end
 
-    def history()     @data['history']; end
+    ## note: return datetime objects (NOT strings); if not present/available return nil/null
+    def created_at() @created_at ||= @data['created_at'] ? DateTime.strptime( @data['created_at'], '%Y-%m-%dT%H:%M:%S') : nil; end
+    def updated_at() @updated_at ||= @data['updated_at'] ? DateTime.strptime( @data['updated_at'], '%Y-%m-%dT%H:%M:%S') : nil; end
+    def pushed_at()  @pushed_at  ||= @data['pushed_at']  ? DateTime.strptime( @data['pushed_at'],  '%Y-%m-%dT%H:%M:%S') : nil; end
 
+    def history()    @history ||= @data['history'] ? build_history( @data['history'] ) : nil; 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??)
+      @size ||= @data['size'] || 0   ## return 0 if not found - why? why not? (return nil - why? why not??)
     end
 
     def stars
       ## return last stargazers_count entry (as number; 0 if not found)
-       t1 = 0
+      @stars ||= history ? history[0].stars : 0
+    end
+
+    def reset_cache
+      ## reset (invalidate) cached values from data hash
+      ##   use after reading or fetching
+      @full_name  = nil
+      @created_at = @updated_at = @pushed_at = nil
+      @history    = nil
+      @size       = nil
+      @stars      = nil
+    end
+
+
+########
+## build history items (structs)
+
+    class HistoryItem
+
+      attr_reader   :date, :stars    ## read-only attributes
+      attr_accessor :prev, :next     ## read/write attributes (for double linked list/nodes/items)
+
+      def initialize( date:, stars: )
+        @date  = date
+        @stars = stars
+      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 ]
 
-       if history
-            history_keys  = history.keys.sort.reverse
-            ## todo/fix: for now assumes one entry per week
-            ##    simple case [0] and [1] for a week later
-            ##   check actual date - why? why not?
-            stats_t1 = history_keys[0] ? history[ history_keys[0] ] : nil
-            if stats_t1
-              t1 = stats_t1['stargazers_count'] || 0
-            end
-       end
-       t1
-    end  # method stars
+        item = HistoryItem.new(
+                 date:  Date.strptime( key, '%Y-%m-%d' ),
+                 stars: h['stargazers_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
+    ## 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
 
 
 ###############################
@@ -89,32 +208,39 @@ module Hubba
       }
 
       ## for now store only the latest commit (e.g. a single commit in an array)
-      @data[ 'commits'] = [commit]
+      @data[ 'commits' ] = [commit]
 
       pp @data
+
+      reset_cache
+      self   ## return self for (easy chaining)
     end
 
 
 
     def write( data_dir: './data' )
       basename = full_name.gsub( '/', '~' )   ## e.g. poole/hyde become poole~hyde
-      puts "writing (saving) to #{basename}..."
+      puts "writing stats to #{basename}..."
       File.open( "#{data_dir}/#{basename}.json", 'w:utf-8' ) do |f|
           f.write JSON.pretty_generate( data )
       end
+      self   ## return self for (easy chaining)
     end
 
-    def read( data_dir: './data' )   ## note: use read instead of load (load is kind of keyword for loading code)
+
+    def read( data_dir: './data' )
       ## note: skip reading if file not present
       basename = full_name.gsub( '/', '~' )   ## e.g. poole/hyde become poole~hyde
       filename = "#{data_dir}/#{basename}.json"
       if File.exist?( filename )
-        puts "reading (loading) from #{basename}..."
+        puts "reading stats from #{basename}..."
         json = File.open( filename, 'r:utf-8' ) { |file| file.read }   ## todo/fix: use read_utf8
         @data = JSON.parse( json )
+        reset_cache
       else
-        puts "skipping reading (loading) from #{basename} -- file not found"
+        puts "skipping reading stats from #{basename} -- file not found"
       end
+      self   ## return self for (easy chaining)
     end
 
   end # class Stats

data/lib/hubba/version.rb

@@ -2,7 +2,7 @@
 
 module Hubba
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 3
+  MINOR = 4
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/stats/jekyll~minima.json

@@ -0,0 +1,21 @@
+{
+  "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": [
+    {
+      "committer": {
+        "date": "2018-01-29T19:02:39Z",
+        "name": "Frank Taillandier"
+      },
+      "message": "Release 💎  v2.3.0 (#195)"
+    }
+  ]
+}

data/test/stats/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/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"
+}

data/test/stats/poole~hyde.json

@@ -0,0 +1,21 @@
+{
+  "full_name": "poole/hyde",
+  "created_at": "2013-02-07T07:01:38Z",
+  "updated_at": "2018-02-12T05:44:07Z",
+  "pushed_at": "2018-01-14T02:41:16Z",
+  "size": 28428,
+  "history": {
+    "2018-02-12": {
+      "stargazers_count": 2125
+    }
+  },
+  "commits": [
+    {
+      "committer": {
+        "date": "2015-05-11T20:21:43Z",
+        "name": "Mark Otto"
+      },
+      "message": "Merge pull request #91 from pborreli/patch-1\n\nFixed typo"
+    }
+  ]
+}

data/test/test_cache.rb

@@ -32,15 +32,14 @@ class TestCache < MiniTest::Test
   def test_cache
      orgs  = @cache.get( '/users/geraldb/orgs' )
      assert_equal 4, orgs.size
-     
+
      repos = @cache.get( '/users/geraldb/repos' )
      assert_equal 3, repos.size
   end  # method test_cache
 
   def test_cache_miss
-     assert_equal nil, @cache.get( '/test/hello' )
-     assert_equal nil, @cache.get( '/test/hola' )
+     assert_nil @cache.get( '/test/hello' )
+     assert_nil @cache.get( '/test/hola' )
   end  # method test_cache_miss
 
 end # class TestCache
-

data/test/test_stats.rb

@@ -10,31 +10,77 @@ require 'helper'
 
 class TestStats < MiniTest::Test
 
-  def setup
-    @gh = Hubba::Github.new( cache_dir: "#{Hubba.root}/test/cache" )
+  def test_awesome_blockchains
+
+    stats = Hubba::Stats.new( 'openblockchains/awesome-blockchains' )
+
+    assert_equal 0, stats.size
+    assert_equal 0, stats.stars
+    assert_nil      stats.history
+
+    stats.read( data_dir: "#{Hubba.root}/test/stats" )
+
+    assert_equal 1620, stats.size
+    assert_equal 1526, stats.stars
+    assert_equal 1526, stats.history[0].stars
+    assert_equal 1411, stats.history[1].stars
+    assert_equal 1084, stats.history[2].stars
+    assert_equal 1084, stats.history[-1].stars
+    assert_equal 3,    stats.history.size
+
+    assert_equal Date.new(2018,  2,  8 ), stats.history[0].date
+    assert_equal Date.new(2018,  1, 28 ), stats.history[1].date
+    assert_equal Date.new(2017, 12, 10 ), stats.history[2].date
+
+    assert_equal 11, stats.history[0].diff_days
+    assert_equal 49, stats.history[1].diff_days
+    assert_nil       stats.history[2].diff_days
+
+    assert_equal 115, stats.history[0].diff_stars
+    assert_equal 327, stats.history[1].diff_stars
+    assert_nil        stats.history[2].diff_stars
+
+    assert_equal 221.0,   stats.calc_diff_stars    ## defaults to samples: 3, days: 30
+    assert_equal  51.566, stats.calc_diff_stars( samples: 5, days: 7 )
+
+    pp stats.history_str   ## pp history pretty printed to string (buffer)
   end
 
-  def test_stats
-    repos = [
-      'henrythemes/jekyll-starter-theme',
-      'poole/hyde',
-      'jekyll/minima'
-    ]
 
-    repos.each do |repo|
-      stats = Hubba::Stats.new( repo )
-      stats.read( data_dir: './tmp' )
+  def test_factbook_json
+
+    stats = Hubba::Stats.new( 'opendatajson/factbook.json' )
+
+    assert_equal 0, stats.size
+    assert_equal 0, stats.stars
+    assert_nil      stats.history
+
+    stats.read( data_dir: "#{Hubba.root}/test/stats" )
+
+    assert_equal 7355, stats.size
+    assert_equal 539, stats.stars
+    assert_equal 539, stats.history[0].stars
+    assert_equal 536, stats.history[1].stars
+    assert_equal 533, stats.history[2].stars
+    assert_equal 457, stats.history[-1].stars
+    assert_equal 7,    stats.history.size
+
+    assert_equal Date.new(2018,  2,  8 ), stats.history[0].date
+    assert_equal Date.new(2018,  1, 28 ), stats.history[1].date
+    assert_equal Date.new(2017, 12, 10 ), stats.history[2].date
+
+    assert_equal 11, stats.history[0].diff_days
+    assert_equal 49, stats.history[1].diff_days
+    assert_nil       stats.history[-1].diff_days
 
-      puts "stars before fetch: #{stats.stars}"
-      puts "size  before fetch: #{stats.size} kb"
-      stats.fetch( @gh )
-      puts "stars after fetch: #{stats.stars}"
-      puts "size  after fetch: #{stats.size} kb"
+    assert_equal 3, stats.history[0].diff_stars
+    assert_equal 3, stats.history[1].diff_stars
+    assert_nil      stats.history[-1].diff_stars
 
-      stats.write( data_dir: './tmp' )
-    end
+    assert_equal 3.0,   stats.calc_diff_stars    ## defaults to samples: 3, days: 30
+    assert_equal 1.012, stats.calc_diff_stars( samples: 5, days: 7 )
 
-    assert true    # for now everything ok if we get here
+    pp stats.history_str   ## pp history pretty printed to string (buffer)
   end
 
 end # class TestStats

data/test/test_stats_tmp.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_stats_tmp.rb
+
+
+require 'helper'
+
+
+class TestStatsTmp < MiniTest::Test
+
+  def setup
+    @gh = Hubba::Github.new( cache_dir: "#{Hubba.root}/test/cache" )
+  end
+
+  def test_stats
+    repos = [
+      'henrythemes/jekyll-starter-theme',
+      'poole/hyde',
+      'jekyll/minima'
+    ]
+
+    repos.each do |repo|
+      stats = Hubba::Stats.new( repo )
+      stats.read( data_dir: './tmp' )
+
+      puts "stars before fetch: #{stats.stars}"
+      puts "size  before fetch: #{stats.size} kb"
+
+      ## note/todo: enable for "live" online testing
+      ## stats.fetch( @gh )
+
+      puts "stars after fetch: #{stats.stars}"
+      puts "size  after fetch: #{stats.size} kb"
+
+      stats.write( data_dir: './tmp' )
+    end
+
+    assert true    # for now everything ok if we get here
+  end
+
+end # class TestStatsTmp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubba
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: hubba -  (yet) another (lite) GitHub HTTP API client / library
+description: hubba - (yet) another (lite) GitHub HTTP API client / library
 email: ruby-talk@ruby-lang.org
 executables: []
 extensions: []
@@ -74,9 +74,14 @@ files:
 - test/cache/users~geraldb~orgs.json
 - test/cache/users~geraldb~repos.json
 - test/helper.rb
+- test/stats/jekyll~minima.json
+- test/stats/openblockchains~awesome-blockchains.json
+- test/stats/opendatajson~factbook.json.json
+- test/stats/poole~hyde.json
 - test/test_cache.rb
 - test/test_config.rb
 - test/test_stats.rb
+- test/test_stats_tmp.rb
 homepage: https://github.com/gittiscripts/hubba
 licenses:
 - Public Domain
@@ -102,5 +107,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: hubba -  (yet) another (lite) GitHub HTTP API client / library
+summary: hubba - (yet) another (lite) GitHub HTTP API client / library
 test_files: []