githubstats 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c24647a4f63470021797a9309535a4438a830c1b
-  data.tar.gz: 7c42bba5c6566f54cab50f0e8873e0e1c3506a44
+SHA256:
+  metadata.gz: b7e43001571c1bb4b2d76b82925a2a3a7421822e66cc0f59cc8d1ad9925621ca
+  data.tar.gz: 1402a5f8d73b405a3bc7dcbb331a6cf8cfb00e8722ba9ccac16ec5e023a4040e
 SHA512:
-  metadata.gz: ca040015df256cea023906e5504f59b38ca5fe552e2b3f4e44956e8faf9793be060896afa655252699e1f7d84d84673b3ebce091b8a53aac5ab7466ba9a787bb
-  data.tar.gz: 5cff21515fdd91ebba43d39cdb9fb6a3c95122f95a9f5fb2e1d205e98f0dc7ad72b64628a52bfeacc86d6721ff5af82109f2d7e952b1291fb162477802ce7085
+  metadata.gz: 418dff84a32e2aefa9282ff636f3bb18540058cff3e3c542fbb485382021734351e593c26fb56c29a0a4e995b4e29a74153c1f253cc9a1f833d1af4ba50b6047
+  data.tar.gz: 9b3077bd88e29ae5074220960c2748a53261117d478125e2a4d6e9419b53f1f02231f76caeeff5132b216d19e5e66821ea83ae32d5adf202ab6f78e3d3013a5f

data/.circle-ruby

@@ -1,3 +1,3 @@
-2.4.2
-2.3.5
-2.2.8
+2.5.1
+2.4.4
+2.3.7

data/.prospectus

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

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 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

data/githubstats.gemspec

@@ -1,5 +1,5 @@
 require 'English'
-$LOAD_PATH.unshift File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'githubstats/version'
 
 Gem::Specification.new do |s|
@@ -18,15 +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 'curb', '~> 0.9.0'
   s.add_runtime_dependency 'nokogiri', '~> 1.8.0'
 
-  s.add_development_dependency 'timecop', '~> 0.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.add_development_dependency 'goodcop', '~> 0.1.0'
-  s.add_development_dependency 'rake', '~> 12.1.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.6.0'
-  s.add_development_dependency 'fuubar', '~> 2.2.0'
+  s.add_development_dependency 'fuubar', '~> 2.3.0'
+  s.add_development_dependency 'goodcop', '~> 0.5.0'
+  s.add_development_dependency 'rake', '~> 12.3.0'
+  s.add_development_dependency 'rspec', '~> 3.7.0'
+  s.add_development_dependency 'rubocop', '~> 0.58.0'
+  s.add_development_dependency 'timecop', '~> 0.9.0'
 end

data/lib/githubstats.rb

@@ -51,8 +51,7 @@ module GithubStats
       @name = params[:name] || guess_user
       @url = (params[:url] || DEFAULT_URL) % @name
       @last_updated = nil
-      enable_caching %i[streak longest_streak streaks real_streak
-                        real_streak_start]
+      enable_caching %i[streak longest_streak streaks]
     end
 
     ##
@@ -118,33 +117,31 @@ 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
+    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

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
@@ -31,7 +35,8 @@ module GithubStats
     def initialize(data)
       @raw = data.map { |d, s| Datapoint.new(Date.parse(d), s.to_i) }
       enable_caching %i[to_h today streaks longest_streak streak max mean
-                        std_var quartile_boundaries quartiles]
+                        std_var quartile_boundaries quartiles start_date
+                        end_date]
     end
 
     ##
@@ -43,6 +48,19 @@ module GithubStats
       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
+
     ##
     # The score for today
 

data/lib/githubstats/version.rb

@@ -3,5 +3,5 @@
 ##
 # Define the version
 module GithubStats
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'.freeze
 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,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: githubstats
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2018-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: curb
+  name: basiccache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: basiccache
+  name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -53,103 +53,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 12.3.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.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.58.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
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Present Github contributions stats in a consumable format