github-calendar 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 856e63c23cb5514fbc7977cbb20c65b0e4124c7f
-  data.tar.gz: 09737875de871692c12bceb518d5d9f7c8f86311
+  metadata.gz: fbf50a1eafa4c9bc2d866e025534f0d01ee71ba5
+  data.tar.gz: 4d734ac9bf923934cca3d082f422ba1e01ba1d5e
 SHA512:
-  metadata.gz: 50c57e384c669352a51e2a69d6cdb23972135d7fc2ef7799a6efe9ba99c6f212a496479a693f09f4e4bbdc34cf5d3bc86b1bb2fda8fe986a59ecff52f95de455
-  data.tar.gz: 854848db35f10e0ead23a74e28b286fd78b10809abf77daae168d14ef81667d21c1ec97bc5bfb73289a05b7543f6c139636c2d8e853dde0b65e823df08eec131
+  metadata.gz: 275737388b653d3f376f3693c1cb504e4aa9777588b8c28253e8c0a2da4f0bedbc3c23111c25672ff5eff9542c77bc0d52973fc9896b65f5176e9ed89b026294
+  data.tar.gz: 1c24863ea5beb5276cf4c11d78952055aebbfca58de6539428acc57f48f4656a42242a51ceb98e841fa5651fc88a8573c93c27fc76295941dfca4d55bb4b8cbe

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
 ## Version 1
+### Version 1.1.0
+* Bump Ruby to 2.3.0, Nokogiri to 1.6.7.2, and StringUtility to 2.7.1.
+* Improve some redundant regex.
+* Improve some documentation.
+
 ### Version 1.0.0
 * Initial release.

data/lib/github/calendar.rb

@@ -10,7 +10,7 @@ module GitHub
 
     # Gets the total number of contributions for the past year.
     # @param user [String] The username to get this data for.
-    # @return [Int] An integer value of their total contributions this year.
+    # @return [Integer] An integer value of their total contributions this year.
     def get_total_year(user)
       source = get_page_source(user)
       string = source.css('span.contrib-number')[0].text
@@ -19,7 +19,7 @@ module GitHub
 
     # Gets the longest contribution streak (in days) that the user has had.
     # @param user [String] See #get_total_year
-    # @return [Int] The user's longest contribution streak in days.
+    # @return [Integer] The user's longest contribution streak in days.
     def get_longest_streak(user)
       source = get_page_source(user)
       string = source.css('span.contrib-number')[1].text
@@ -28,7 +28,7 @@ module GitHub
 
     # Gets the current contribution streak (in days) that the user is in.
     # @param user [String] See #get_total_year
-    # @return [Int] The user's current contribution streak in days.
+    # @return [Integer] The user's current contribution streak in days.
     def get_current_streak(user)
       source = get_page_source(user)
       string = source.css('span.contrib-number')[2].text
@@ -37,15 +37,14 @@ module GitHub
 
     # Gets the weekly contribution count for the past year.
     # @param user [String] See #get_total_year
-    # @return [Hash] How many contributions they have done each week. Example:
-    # { 0: 0, 1: 8, etc. }
+    # @return [Hash] How many contributions they have done each week. Example: { 0: 0, 1: 8, etc. }
     def get_weekly(user)
       weeks = get_calendar(user)
       ret = {}
       count = 0
       weeks[1..-1].each do |k|
         data = 0
-        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        capture = k.to_s.scan(/data-count="(.*?)"/)
         capture[1..-1].each do |ints|
           data += ints[0].to_i
         end
@@ -57,14 +56,13 @@ module GitHub
 
     # Gets the daily contribution count for the past year.
     # @param user [String] See #get_total_year
-    # @return [Hash] How many contributions they have performed each day. See
-    # #get_weekly
+    # @return [Hash] How many contributions they have performed each day. See #get_weekly
     def get_daily(user)
       weeks = get_calendar(user)
       ret = {}
       count = 0
       weeks[1..-1].each do |k|
-        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        capture = k.to_s.scan(/data-count="(.*?)"/)
         capture[1..-1].each do |i|
           ret[count] = i[0].to_i
           count += 1
@@ -75,9 +73,8 @@ module GitHub
 
     # Gets the monthly contribution count for the past year.
     # @param user [String] See #get_total_year
-    # @return [Hash] How many contributions they have performed each month.
-    # Months are listed as their string integers, e.g., 01 is January and
-    # 12 is December.
+    # @return [Hash] How many contributions they have performed each month. Months are listed as their string integers,
+    # e.g., 01 is January and 12 is December.
     def get_monthly(user)
       weeks = get_calendar(user)
       ret = {
@@ -95,8 +92,8 @@ module GitHub
         '12' => 0
       }
       weeks[1..-1].each do |k|
-        date = k.to_s.scan(/data-date=\".*-(.*?)-/)
-        capture = k.to_s.scan(/data-count=\"(.*?)\"/)
+        date = k.to_s.scan(/data-date=".*-(.*?)-/)
+        capture = k.to_s.scan(/data-count="(.*?)"/)
         capture[1..-1].each do |i|
           ret[date[0][0]] += i[0].to_i
         end
@@ -106,7 +103,7 @@ module GitHub
 
     # Gets the average weekly number of contributions by the user.
     # @param user [String] See #get_total_year
-    # @return [Int] The average number of contributions.
+    # @return [Integer] The average number of contributions.
     def get_average_week(user)
       weekly = get_weekly(user)
       get_average(weekly)
@@ -114,7 +111,7 @@ module GitHub
 
     # Gets the average daily number of contributions by the user.
     # @param user [String] See #get_total_year
-    # @return [Int] See #get_average_week
+    # @return [Integer] See #get_average_week
     def get_average_day(user)
       daily = get_daily(user)
       get_average(daily)
@@ -122,7 +119,7 @@ module GitHub
 
     # Gets the average monthly number of contributions by the user.
     # @param user [String] See #get_total_year
-    # @return [Int] See #get_average_week
+    # @return [Integer] See #get_average_week
     def get_average_month(user)
       monthly = get_monthly(user)
       get_average(monthly)
@@ -144,18 +141,16 @@ module GitHub
 
     # Gets the parsed calendar HTML source for the user profile.
     # @param user [String] See #get_total_year
-    # @return [Nokogiri::XML::NodeSet] The NodeSet for all the g's in the
-    # calendar. Consider this as an array of all the weeks. In iteration,
-    # you will probably want to skip the first, as it is the total yearly.
-    # @return [Nil] See #get_total_year
+    # @return [Nokogiri::XML::NodeSet] The NodeSet for all the g's in the calendar. Consider this as an array of all
+    # the weeks. In iteration, you will probably want to skip the first, as it is the total yearly.
     def get_calendar(user)
       source = get_page_source(user)
       source.css('svg.js-calendar-graph-svg g')
     end
 
     # Gets an average for all the integer values in a hash.
-    # @param [Hash] The hash to get the average for.
-    # @return [Int] The average of the values.
+    # @param hash [Hash] The hash to get the average for.
+    # @return [Integer] The average of the values.
     def get_average(hash)
       hash_max = hash.length
       hash_total = 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-calendar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
+        version: 1.6.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
+        version: 1.6.7.2
 - !ruby/object:Gem::Dependency
   name: string-utility
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.7.1
 description: A library that allows for quick HTML parsing of GitHub user profile contribution
   calendars. This project is part of the GitHub User Language Statistics project.
 email: elifosterwy@gmail.com
@@ -59,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -67,9 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Getting GitHub user profile calendar data through HTML parsing.
 test_files: []
-has_rdoc: