githubstats 1.3.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 334ee21ca7fb6938f1db4dee0c756a4271bb95e8
-  data.tar.gz: 34c665d0aae762ea44fd9226aef25f66880aaeda
+SHA256:
+  metadata.gz: cbc52fb43a7ea21f49af181e9fceac0aaa61953ee1d2891029ba0678cdc50e38
+  data.tar.gz: 91cb1ba5ca68c13dd6b451ed20c1bf1d484fa52633b76c4ab8ef11c045bc98ce
 SHA512:
-  metadata.gz: 19935983f0ab101ff208d2e0f1be1979368ccf83020c38292f03ecd4aff695901d719073a775638564a2b218c2f858b722d0913a67e73cb4510d7a282cb7e14d
-  data.tar.gz: 10f8db4278cf6c2836c8544727ff780f9788a760dad1b01f7f9b1b7921611269c163f90bd9e5c2b8e59384f5c8d66eb935c6b5959b359c6e945499569e28db90
+  metadata.gz: 3ff5c12de669ffdc4ef973d7301a513364a56ac41e923bf41e7d77a029c63240709363de30ca43d684d9fd13ebd72e67222c7e16a45d62e9dd1497dc9332909e
+  data.tar.gz: 0ca40694b1d8f656697128a9b2b49a3f3a796eb68e4226e9e8bc57cb83b46cdf70edfc5d0562950d9f114f76058a2be789f4f9a90746cb6eb64d5cde3586587a

data/.circle-ruby

@@ -1,3 +1,4 @@
-2.3.1
-2.2.5
-2.1.10
+2.6.1
+2.5.3
+2.4.5
+2.3.8

data/.prospectus

@@ -1,11 +1,11 @@
+my_slug = 'akerl/githubstats'
+
+Prospectus.extra_dep('file', 'prospectus_travis')
+Prospectus.extra_dep('file', 'prospectus_gems')
+
 item do
-  expected do
-    static
-    set 'green'
-  end
+  noop
 
-  actual do
-    gemnasium
-    slug 'akerl/githubstats'
-  end
+  extend ProspectusGems::Gemspec.new
+  extend ProspectusTravis::Build.new(my_slug)
 end

data/.rubocop.yml

@@ -1,2 +1,5 @@
-Encoding:
-    Enabled: false
+inherit_gem:
+  goodcop: .rubocop.yml
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,10 @@
+dist: xenial
+install:
+- for i in $(cat .circle-ruby) ; do rvm install $i || exit 1 ; done
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done
+script:
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done
+notifications:
+  email: false
+  slack:
+    secure: PQOCIfuacnmF9MMGmZseYwGn8HfxmL1m7qqftoWhDkkp8oKLKVaSfoMPGAADWQsWLBl4JQC+z/lRH8I2gXChQjZhKZBz15bFH6mwFBI82DXidVNVxt27g/uR3RMT8GfGw8CkgW8DsSpNF+E4pBPOKONFLhj9Y0xdpAID7slrPwd6wDdpi4oDXvnfTO4ZfUZbB3OGT0nnzcH4gCiKXKijv4MRzHTVpvbwe+P3TOKkTY0V21B++YSBpX1tIYt6cLOHaDFQT4DScwFajtvynpwWf3PCRMCATganpyEqEpkiUp+dSg1h2WjYilAwVHkLnNaESUFKeTLQGIXpKMj4+3yHlIPPG6M2MawgwhSDuYy1IAE/81+Y06V9Sn9PPnICsjV1+W0LxnCms13t1JcVWrzVOtlzyCInKr8ENAX6Ku6SSQaouuqYghm1maG8ZtNhqyByqGctov7noLUH6T+lHS8ODr22cLg6f0lzVn5d13/aha9OvTZV7DN6uVCfwpbAL9S+u1TNtjrDhJQFohSe7X+jb+KxN7sLZR5Z5RKwM8sx6Tadf3rrvVRF5+jQxpb2IgjakV2QgxmVDrZDu3XXWbRUYMlGbmR4EEwDaKPJsjKh8KIu6GS6rhrQHiwvwDH6FQcXdeQsieLaVTBoKnE1slYvRMVTMZxFkAbI2dIt+H06c7c=

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 3.0.1 / 2018-08-19
+
+* [BUGFIX] Fix cap used to decide when to use real_streak GitHub polling
+
+# 3.0.0 / 2018-07-18
+
+* [BUGFIX] Update to work with recent GitHub changes for historic streak lookup API
+* [FEATURE] Historic GitHub streaks now show actual stats instead of `-1` placeholders
+* [FEATURE] It is now possible to convert a datapoint back to its original format with `.to_a`
+* [FEATURE] Added `.start_date` and `.end_date` to Data object
+
+# 2.0.0 / 2017-09-29
+
+* [BUGFIX] Fail cleanly if Github responds with a bad HTTP code
+
+# 1.4.0 / 2017-06-09
+
+* [ENHANCEMENT] Cache more data methods
+* [ENHANCEMENT] Upgrade to latest Nokogiri minor release
+
 # 1.3.0 / 2016-09-14
 
 * [FEATURE] Re-adds support for streak lookups longer than 366 days from GitHub, now that they've brought back older commit info

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-

data/README.md

@@ -2,8 +2,7 @@ GithubStats
 =========
 
 [![Gem Version](https://img.shields.io/gem/v/githubstats.svg)](https://rubygems.org/gems/githubstats)
-[![Dependency Status](https://img.shields.io/gemnasium/akerl/githubstats.svg)](https://gemnasium.com/akerl/githubstats)
-[![Build Status](https://img.shields.io/circleci/project/akerl/githubstats.svg)](https://circleci.com/gh/akerl/githubstats)
+[![Build Status](https://img.shields.io/travis/com/akerl/githubstats.svg)](https://travis-ci.com/akerl/githubstats)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/githubstats.svg)](https://codecov.io/github/akerl/githubstats)
 [![Code Quality](https://img.shields.io/codacy/d25d2521df3f4a6b8369edd419438d97.svg)](https://www.codacy.com/app/akerl/githubstats)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)

data/Rakefile

@@ -7,8 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Rubocop on the gem'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
   task.fail_on_error = true
 end
 
-task default: [:spec, :rubocop, :build, :install]
+task default: %i[spec rubocop build install]

data/bin/githubstats

@@ -3,7 +3,7 @@
 require 'githubstats'
 require 'optparse'
 
-opt = OptionParser.new do |opts|
+OptionParser.new do |opts|
   opts.banner = 'Usage: githubstats [-h] [USER]'
   opts.on_tail('-v', '--version', 'Show version') do
     puts GithubStats::VERSION

data/githubstats.gemspec

@@ -1,13 +1,14 @@
-$:.unshift File.expand_path('../lib/', __FILE__)
+require 'English'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'githubstats/version'
 
 Gem::Specification.new do |s|
   s.name        = 'githubstats'
   s.version     = GithubStats::VERSION
-  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Present Github contributions stats in a consumable format'
-  s.description = "Pulls the statistics from Github's user contribution chart and provides an interface for analyzing that data"
+  s.description = 'Pulls the statistics from Github\'s user contribution chart and provides an interface for analyzing that data' # rubocop:disable Metrics/LineLength
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/githubstats'
@@ -17,14 +18,15 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['githubstats']
 
-  s.add_runtime_dependency 'curb', '~> 0.9.0'
   s.add_runtime_dependency 'basiccache', '~> 1.0.0'
-  s.add_runtime_dependency 'nokogiri', '~> 1.6.5'
+  s.add_runtime_dependency 'curb', '~> 0.9.0'
+  s.add_runtime_dependency 'nokogiri', '~> 1.10.8'
 
-  s.add_development_dependency 'timecop', '~> 0.8.0'
-  s.add_development_dependency 'rubocop', '~> 0.42.0'
-  s.add_development_dependency 'rake', '~> 11.2.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.5.0'
-  s.add_development_dependency 'fuubar', '~> 2.2.0'
+  s.add_development_dependency 'fuubar', '~> 2.5.0'
+  s.add_development_dependency 'goodcop', '~> 0.8.0'
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'rubocop', '~> 0.76.0'
+  s.add_development_dependency 'timecop', '~> 0.9.0'
 end

data/lib/githubstats.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'curb'
 require 'json'
 require 'nokogiri'
@@ -33,14 +34,14 @@ module GithubStats
   ##
   # Default URL for grabbing data
 
-  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions".freeze
+  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions"
 
   ##
   # User object
   class User
     include MethodCacher
 
-    attr_reader :name, :url, :data, :last_updated
+    attr_reader :name, :url, :last_updated
 
     ##
     # Creates a new user object
@@ -50,8 +51,7 @@ module GithubStats
       @name = params[:name] || guess_user
       @url = (params[:url] || DEFAULT_URL) % @name
       @last_updated = nil
-      enable_caching [:streak, :longest_streak, :streaks, :real_streak,
-                      :real_streak_start]
+      enable_caching %i[streak longest_streak streaks]
     end
 
     ##
@@ -73,7 +73,7 @@ module GithubStats
 
     def streaks
       naive = data.streaks
-      return naive if naive.last.nil? || naive.last.size < 365
+      return naive if naive.last.nil? || naive.last.size < 364
       [real_streak]
     end
 
@@ -81,7 +81,7 @@ module GithubStats
     # Set a custom longest_streak to account for the overriden streak
 
     def longest_streak
-      return data.longest_streak if data.longest_streak.size < 365
+      return data.longest_streak if data.longest_streak.size < 364
       streak
     end
 
@@ -117,40 +117,38 @@ module GithubStats
 
     def load_data
       @data = GithubStats::Data.new download
-      @last_updated = DateTime.now
+      @last_updated = Time.now
     end
 
     ##
-    # Set a custom longest_streak that takes into account GitHub,
-    # which reports full length but only gives data for a year
-
-    def real_streak_start(chart_start)
-      res = GithubStats::Data.new download(chart_start.strftime('%Y-%m-%d'))
-      last_streak_start = res.streaks.last.first.date
-      new_chart_start = res.raw.first.date
-      return last_streak_start unless last_streak_start == new_chart_start
-      real_streak_start(new_chart_start)
+    # Set a custom longest_streak that takes into account GitHub's
+    # historical records
+
+    def real_streak_rewind(partial_streak)
+      new_data = download(partial_streak.first.date - 1)
+      old_data = partial_streak.map(&:to_a)
+      new_stats = GithubStats::Data.new(new_data + old_data)
+      partial_streak = new_stats.streaks.last
+      return partial_streak if partial_streak.first.date != new_stats.start_date
+      real_streak_rewind partial_streak
     end
 
     def real_streak
-      existing = data.streaks.last
-      first_date = existing.first.date
-      extra_size = (first_date - real_streak_start(first_date))
-      [-1] * extra_size + existing
+      @real_streak ||= real_streak_rewind(data.streaks.last)
     end
 
     ##
     # Downloads new data from Github
 
-    def download(from = nil)
-      url = from ? @url + "?from=#{from}" : @url
-      svg = Curl::Easy.perform(url).body_str
-      html = Nokogiri::HTML(svg)
+    def download(to_date = nil)
+      url = to_date ? @url + "?to=#{to_date.strftime('%Y-%m-%d')}" : @url
+      res = Curl::Easy.perform(url)
+      code = res.response_code
+      raise("Failed loading data from GitHub: #{url} #{code}") if code != 200
+      html = Nokogiri::HTML(res.body_str)
       html.css('.day').map do |x|
         x.attributes.values_at('data-date', 'data-count').map(&:value)
       end
-    rescue
-      raise 'Unable to load data from Github'
     end
 
     def method_missing(sym, *args, &block)

data/lib/githubstats/data.rb

@@ -12,7 +12,11 @@ module GithubStats
   ##
   # Helper struct for defining datapoints
 
-  Datapoint = Struct.new(:date, :score)
+  Datapoint = Struct.new(:date, :score) do
+    def to_a
+      [date.strftime('%Y-%m-%d'), score.to_s]
+    end
+  end
 
   ##
   # Data class for calculations
@@ -30,15 +34,31 @@ module GithubStats
 
     def initialize(data)
       @raw = data.map { |d, s| Datapoint.new(Date.parse(d), s.to_i) }
-      enable_caching [:to_h, :today, :streaks, :longest_streak, :streak, :max,
-                      :mean, :std_var, :quartile_boundaries, :quartiles]
+      enable_caching %i[to_h today streaks longest_streak streak max mean
+                        std_var quartile_boundaries quartiles start_date
+                        end_date]
     end
 
     ##
     # The data as a hash where the keys are dates and values are scores
 
     def to_h
-      @raw.reduce(Hash.new(0)) { |a, e| a.merge(e.date => e.score) }
+      @raw.reduce(Hash.new(0)) do |acc, elem|
+        acc.merge(elem.date => elem.score)
+      end
+    end
+
+    ##
+    # The start of the dataset
+
+    def start_date
+      @raw.first.date
+    end
+
+    ##
+    # The end of the dataset
+    def end_date
+      @raw.last.date
     end
 
     ##
@@ -78,7 +98,7 @@ module GithubStats
 
     def longest_streak
       return [] if streaks.empty?
-      streaks.max { |a, b| a.length <=> b.length }
+      streaks.max_by(&:length)
     end
 
     ##
@@ -93,7 +113,7 @@ module GithubStats
     # The highest scoring day
 
     def max
-      @raw.max { |a, b| a.score <=> b.score }
+      @raw.max_by(&:score)
     end
 
     ##
@@ -107,7 +127,9 @@ module GithubStats
     # The standard variance (two pass)
 
     def std_var
-      first_pass = @raw.reduce(0) { |a, e| (e.score.to_f - mean)**2 + a }
+      first_pass = @raw.reduce(0) do |acc, elem|
+        (elem.score.to_f - mean)**2 + acc
+      end
       Math.sqrt(first_pass / (@raw.size - 1))
     end
 
@@ -124,7 +146,7 @@ module GithubStats
     # They only consider the first 3 or 1, based on the mean and max of the set
 
     def gh_outliers
-      outliers.take(6 > max.score - mean || 15 > max.score ? 1 : 3)
+      outliers.take(max.score - mean < 6 || max.score < 15 ? 1 : 3)
     end
 
     ##
@@ -149,14 +171,16 @@ module GithubStats
 
     def quartiles
       quartiles = Array.new(5) { [] }
-      @raw.reduce(quartiles) { |a, e| a[quartile(e.score)] << e && a }
+      @raw.each_with_object(quartiles) do |elem, acc|
+        acc[quartile(elem.score)] << elem
+      end
     end
 
     ##
     # Return the quartile of a given score
 
     def quartile(score)
-      return nil if score < 0 || score > max.score
+      return nil if score.negative? || score > max.score
       quartile_boundaries.count { |bound| score > bound }
     end
 

data/lib/githubstats/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 ##
 # Define the version
 module GithubStats
-  VERSION = '1.3.1'.freeze
+  VERSION = '3.0.2'
 end

data/spec/githubstats/data_spec.rb

@@ -7,8 +7,8 @@ describe GithubStats do
   end
 
   it 'defines a Datapoint object' do
-    a = GithubStats::Datapoint.new(DateTime.now, 4)
-    expect(a.date).to be_an_instance_of DateTime
+    a = GithubStats::Datapoint.new(Time.now, 4)
+    expect(a.date).to be_an_instance_of Time
     expect(a.score).to eql 4
   end
 

data/spec/githubstats_spec.rb

@@ -39,7 +39,7 @@ describe GithubStats do
       expect(named_user.last_updated).to be_nil
       named_user.data
       expect(named_user.instance_variables).to include(:@data)
-      expect(named_user.last_updated).to be_an_instance_of DateTime
+      expect(named_user.last_updated).to be_an_instance_of Time
     end
 
     it 'raises an exception if it cannot load data' do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: githubstats
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Les Aker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: basiccache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
@@ -25,117 +39,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: basiccache
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
-  type: :runtime
+        version: 0.1.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.76.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.76.0
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.9.0
 description: Pulls the statistics from Github's user contribution chart and provides
   an interface for analyzing that data
 email: me@lesaker.org
@@ -149,13 +163,13 @@ files:
 - ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/githubstats
-- circle.yml
 - githubstats.gemspec
 - lib/githubstats.rb
 - lib/githubstats/data.rb
@@ -175,7 +189,7 @@ homepage: https://github.com/akerl/githubstats
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,9 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Present Github contributions stats in a consumable format
 test_files:

data/circle.yml

@@ -1,6 +0,0 @@
-dependencies:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
-test:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'