RubyGems - how_is - Versions diffs - 18.0.4 → 18.0.5 - Mend

how_is 18.0.4 → 18.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

checksums.yaml +5 -5
data/.github_changelog_generator +3 -0
data/.gitignore +1 -1
data/.rspec +1 -1
data/.rubocop.yml +22 -9
data/.rubocop_todo.yml +21 -0
data/CHANGELOG.md +266 -140
data/Gemfile +12 -1
data/Rakefile +33 -14
data/exe/how_is +6 -11
data/fixtures/vcr_cassettes/how_is_contributions_all_contributors.yml +78 -0
data/fixtures/vcr_cassettes/how_is_contributions_new_contributors.yml +219 -0
data/how_is.gemspec +2 -1
data/lib/how_is/analyzer.rb +53 -47
data/lib/how_is/contributions.rb +46 -0
data/lib/how_is/fetcher.rb +10 -10
data/lib/how_is/pulse.rb +20 -19
data/lib/how_is/report/base_report.rb +15 -12
data/lib/how_is/report/html.rb +59 -52
data/lib/how_is/report/json.rb +2 -2
data/lib/how_is/report.rb +9 -6
data/lib/how_is/version.rb +1 -1
data/lib/how_is.rb +19 -16
metadata +24 -6
data/Gemfile.lock +0 -110

data/exe/how_is CHANGED Viewed

@@ -8,11 +8,9 @@ require "how_is/cli"
 begin
   result = HowIs::CLI.parse(ARGV)
 rescue HowIs::CLI::OptionsError => e
-  if ENV['SHOW_TRACE']
-    raise
-  else
-    abort "Error: #{e.message}"
-  end
+  raise if ENV["SHOW_TRACE"]
+  abort "Error: #{e.message}"
 end
 options = result[:options]
@@ -45,10 +43,7 @@ begin
     )
   end
 rescue => e
-  if ENV['SHOW_TRACE']
-    raise
-  else
-    abort "Error: #{e.message}"
-  end
-end
+  raise if ENV["SHOW_TRACE"]
+  abort "Error: #{e.message}"
+end

data/fixtures/vcr_cassettes/how_is_contributions_all_contributors.yml ADDED Viewed

@@ -0,0 +1,78 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/repos/how-is/example-repository/commits?since=2017-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github API Ruby Gem 0.17.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 05 Aug 2017 21:05:34 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '6'
+      X-Ratelimit-Reset:
+      - '1501967489'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Vary:
+      - Accept
+      Etag:
+      - W/"c4e64de253131e8983284594017e505c"
+      Last-Modified:
+      - Sat, 05 Aug 2017 20:39:01 GMT
+      X-Github-Media-Type:
+      - github.v3; format=json
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Security-Policy:
+      - default-src 'none'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Runtime-Rack:
+      - '0.046194'
+      X-Github-Request-Id:
+      - DA1A:795E:9C82C1:19614C6:5986331E
+    body:
+      encoding: ASCII-8BIT
+      string: '[{"sha":"40c01ab6ebec6cbd8ad9e521a732f941c169e557","commit":{"author":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2017-08-05T20:39:01Z"},"committer":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2017-08-05T20:39:01Z"},"message":"meep","tree":{"sha":"6911e0637822f44b83f04f47821adab56fdbc0b9","url":"https://api.github.com/repos/how-is/example-repository/git/trees/6911e0637822f44b83f04f47821adab56fdbc0b9"},"url":"https://api.github.com/repos/how-is/example-repository/git/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557","comment_count":0},"url":"https://api.github.com/repos/how-is/example-repository/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557","html_url":"https://github.com/how-is/example-repository/commit/40c01ab6ebec6cbd8ad9e521a732f941c169e557","comments_url":"https://api.github.com/repos/how-is/example-repository/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557/comments","author":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"committer":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"parents":[{"sha":"3794aa1c4b76623748faf280abe5760b76823162","url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162","html_url":"https://github.com/how-is/example-repository/commit/3794aa1c4b76623748faf280abe5760b76823162"}]},{"sha":"3794aa1c4b76623748faf280abe5760b76823162","commit":{"author":{"name":"fake
+        author","email":"fake@duckinator.net","date":"2017-08-05T20:23:10Z"},"committer":{"name":"fake
+        author","email":"fake@duckinator.net","date":"2017-08-05T20:23:10Z"},"message":"test
+        commit","tree":{"sha":"8286e548e330cfe01efcf7189f4df1fa53e777a7","url":"https://api.github.com/repos/how-is/example-repository/git/trees/8286e548e330cfe01efcf7189f4df1fa53e777a7"},"url":"https://api.github.com/repos/how-is/example-repository/git/commits/3794aa1c4b76623748faf280abe5760b76823162","comment_count":0},"url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162","html_url":"https://github.com/how-is/example-repository/commit/3794aa1c4b76623748faf280abe5760b76823162","comments_url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162/comments","author":null,"committer":null,"parents":[{"sha":"9e29405efa433529b86722542b8fb4b34dfd9edd","url":"https://api.github.com/repos/how-is/example-repository/commits/9e29405efa433529b86722542b8fb4b34dfd9edd","html_url":"https://github.com/how-is/example-repository/commit/9e29405efa433529b86722542b8fb4b34dfd9edd"}]}]'
+    http_version:
+  recorded_at: Sat, 05 Aug 2017 21:05:34 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/how_is_contributions_new_contributors.yml ADDED Viewed

@@ -0,0 +1,219 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/repos/how-is/example-repository/commits?since=2017-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github API Ruby Gem 0.17.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 05 Aug 2017 21:08:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '5'
+      X-Ratelimit-Reset:
+      - '1501967489'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Vary:
+      - Accept
+      Etag:
+      - W/"c4e64de253131e8983284594017e505c"
+      Last-Modified:
+      - Sat, 05 Aug 2017 20:39:01 GMT
+      X-Github-Media-Type:
+      - github.v3; format=json
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Security-Policy:
+      - default-src 'none'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Runtime-Rack:
+      - '0.044265'
+      X-Github-Request-Id:
+      - DA58:795D:BB06DF:178487C:598633E1
+    body:
+      encoding: ASCII-8BIT
+      string: '[{"sha":"40c01ab6ebec6cbd8ad9e521a732f941c169e557","commit":{"author":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2017-08-05T20:39:01Z"},"committer":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2017-08-05T20:39:01Z"},"message":"meep","tree":{"sha":"6911e0637822f44b83f04f47821adab56fdbc0b9","url":"https://api.github.com/repos/how-is/example-repository/git/trees/6911e0637822f44b83f04f47821adab56fdbc0b9"},"url":"https://api.github.com/repos/how-is/example-repository/git/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557","comment_count":0},"url":"https://api.github.com/repos/how-is/example-repository/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557","html_url":"https://github.com/how-is/example-repository/commit/40c01ab6ebec6cbd8ad9e521a732f941c169e557","comments_url":"https://api.github.com/repos/how-is/example-repository/commits/40c01ab6ebec6cbd8ad9e521a732f941c169e557/comments","author":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"committer":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"parents":[{"sha":"3794aa1c4b76623748faf280abe5760b76823162","url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162","html_url":"https://github.com/how-is/example-repository/commit/3794aa1c4b76623748faf280abe5760b76823162"}]},{"sha":"3794aa1c4b76623748faf280abe5760b76823162","commit":{"author":{"name":"fake
+        author","email":"fake@duckinator.net","date":"2017-08-05T20:23:10Z"},"committer":{"name":"fake
+        author","email":"fake@duckinator.net","date":"2017-08-05T20:23:10Z"},"message":"test
+        commit","tree":{"sha":"8286e548e330cfe01efcf7189f4df1fa53e777a7","url":"https://api.github.com/repos/how-is/example-repository/git/trees/8286e548e330cfe01efcf7189f4df1fa53e777a7"},"url":"https://api.github.com/repos/how-is/example-repository/git/commits/3794aa1c4b76623748faf280abe5760b76823162","comment_count":0},"url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162","html_url":"https://github.com/how-is/example-repository/commit/3794aa1c4b76623748faf280abe5760b76823162","comments_url":"https://api.github.com/repos/how-is/example-repository/commits/3794aa1c4b76623748faf280abe5760b76823162/comments","author":null,"committer":null,"parents":[{"sha":"9e29405efa433529b86722542b8fb4b34dfd9edd","url":"https://api.github.com/repos/how-is/example-repository/commits/9e29405efa433529b86722542b8fb4b34dfd9edd","html_url":"https://github.com/how-is/example-repository/commit/9e29405efa433529b86722542b8fb4b34dfd9edd"}]}]'
+    http_version:
+  recorded_at: Sat, 05 Aug 2017 21:08:49 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/how-is/example-repository/commits?author=me@duckie.co&until=2017-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github API Ruby Gem 0.17.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 05 Aug 2017 21:08:50 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '4'
+      X-Ratelimit-Reset:
+      - '1501967489'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Vary:
+      - Accept
+      Etag:
+      - W/"63ec50619f12827a37594ae87db65a6d"
+      Last-Modified:
+      - Sun, 07 Aug 2016 03:52:54 GMT
+      X-Github-Media-Type:
+      - github.v3; format=json
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Security-Policy:
+      - default-src 'none'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Runtime-Rack:
+      - '0.044928'
+      X-Github-Request-Id:
+      - DA59:795E:9CC15F:196C854:598633E2
+    body:
+      encoding: ASCII-8BIT
+      string: '[{"sha":"9e29405efa433529b86722542b8fb4b34dfd9edd","commit":{"author":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2016-08-07T03:52:54Z"},"committer":{"name":"Ellen
+        Marie Dash","email":"me@duckie.co","date":"2016-08-07T03:52:54Z"},"message":"Initial
+        commit","tree":{"sha":"7bee2a10cc8c7c036d5006fa0aacadd869d09c4e","url":"https://api.github.com/repos/how-is/example-repository/git/trees/7bee2a10cc8c7c036d5006fa0aacadd869d09c4e"},"url":"https://api.github.com/repos/how-is/example-repository/git/commits/9e29405efa433529b86722542b8fb4b34dfd9edd","comment_count":0},"url":"https://api.github.com/repos/how-is/example-repository/commits/9e29405efa433529b86722542b8fb4b34dfd9edd","html_url":"https://github.com/how-is/example-repository/commit/9e29405efa433529b86722542b8fb4b34dfd9edd","comments_url":"https://api.github.com/repos/how-is/example-repository/commits/9e29405efa433529b86722542b8fb4b34dfd9edd/comments","author":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"committer":{"login":"duckinator","id":39698,"avatar_url":"https://avatars3.githubusercontent.com/u/39698?v=4","gravatar_id":"","url":"https://api.github.com/users/duckinator","html_url":"https://github.com/duckinator","followers_url":"https://api.github.com/users/duckinator/followers","following_url":"https://api.github.com/users/duckinator/following{/other_user}","gists_url":"https://api.github.com/users/duckinator/gists{/gist_id}","starred_url":"https://api.github.com/users/duckinator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/duckinator/subscriptions","organizations_url":"https://api.github.com/users/duckinator/orgs","repos_url":"https://api.github.com/users/duckinator/repos","events_url":"https://api.github.com/users/duckinator/events{/privacy}","received_events_url":"https://api.github.com/users/duckinator/received_events","type":"User","site_admin":false},"parents":[]}]'
+    http_version:
+  recorded_at: Sat, 05 Aug 2017 21:08:50 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/how-is/example-repository/commits?author=fake@duckinator.net&until=2017-01-01
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github API Ruby Gem 0.17.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 05 Aug 2017 21:08:51 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '2'
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '3'
+      X-Ratelimit-Reset:
+      - '1501967489'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Vary:
+      - Accept
+      Etag:
+      - '"fafd06a937c504cece6726ba7201b0a1"'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Security-Policy:
+      - default-src 'none'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Runtime-Rack:
+      - '0.033466'
+      X-Github-Request-Id:
+      - DA5A:795A:69CBD4:E6BF0D:598633E2
+    body:
+      encoding: UTF-8
+      string: "[]"
+    http_version:
+  recorded_at: Sat, 05 Aug 2017 21:08:51 GMT
+recorded_with: VCR 3.0.3

data/how_is.gemspec CHANGED Viewed

@@ -31,5 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.8.1"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "rubocop", "~> 0.47.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  spec.add_development_dependency "github_changelog_generator"
 end

data/lib/how_is/analyzer.rb CHANGED Viewed

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require 'contracts'
-require 'ostruct'
-require 'date'
-require 'json'
+require "contracts"
+require "ostruct"
+require "date"
+require "json"
 class HowIs
   ##
@@ -11,11 +11,12 @@ class HowIs
   class Analysis < OpenStruct
   end
+  # Creates Analysis objects with input data formatted in useful ways.
   class Analyzer
     include Contracts::Core
     ##
-    # Raised when attempting to export to an unsupported format.
+    # Raised when attempting to import to an unsupported format.
     class UnsupportedImportFormat < StandardError
       def initialize(format)
         super("Unsupported import format: #{format}")
@@ -23,7 +24,7 @@ class HowIs
     end
     ##
-    # Generates and returns an analysis.i
+    # Generates and returns an analysis.
     #
     # @param data [Fetcher::Results] The results gathered by Fetcher.
     # @param analysis_class (You don't need this.) A class to use instead of
@@ -43,7 +44,7 @@ class HowIs
         number_of_pulls:   pulls.length,
         issues_with_label: with_label_links(num_with_label(issues), data.repository),
-        issues_with_no_label: {'link' => nil, 'total' => num_with_no_label(issues)},
+        issues_with_no_label: {"link" => nil, "total" => num_with_no_label(issues)},
         average_issue_age: average_age_for(issues),
         average_pull_age:  average_age_for(pulls),
@@ -64,15 +65,15 @@ class HowIs
     # @param data [Hash] The hash to generate an Analysis from.
     def self.from_hash(data)
       hash = data.map { |k, v|
-        v = DateTime.parse(v) if k.end_with?('_date')
+        v = DateTime.parse(v) if k.end_with?("_date")
         [k, v]
       }.to_h
       hash.keys.each do |key|
-        next unless hash[key].is_a?(Hash) && hash[key]['date']
+        next unless hash[key].is_a?(Hash) && hash[key]["date"]
-        hash[key]['date'] = DateTime.parse(hash[key]['date'])
+        hash[key]["date"] = DateTime.parse(hash[key]["date"])
       end
       Analysis.new(hash)
@@ -90,10 +91,10 @@ class HowIs
       hash = Hash.new(0)
       issues_or_pulls.each do |iop|
-        next unless iop['labels']
+        next unless iop["labels"]
-        iop['labels'].each do |label|
-          hash[label['name']] += 1
+        iop["labels"].each do |label|
+          hash[label["name"]] += 1
         end
       end
       hash
@@ -101,16 +102,16 @@ class HowIs
     # Returns the number of issues with no label.
     def num_with_no_label(issues)
-      issues.select { |x| x['labels'].empty? }.length
+      issues.select { |x| x["labels"].empty? }.length
     end
     # Given an Array of dates, average the timestamps and return the date that
     # represents.
     def average_date_for(issues_or_pulls)
-      timestamps = issues_or_pulls.map { |iop| Date.parse(iop['created_at']).strftime('%s').to_i }
+      timestamps = issues_or_pulls.map { |iop| Date.parse(iop["created_at"]).strftime("%s").to_i }
       average_timestamp = timestamps.reduce(:+) / issues_or_pulls.length
-      DateTime.strptime(average_timestamp.to_s, '%s')
+      DateTime.strptime(average_timestamp.to_s, "%s")
     end
     # Given an Array of issues or pulls, return the average age of them.
@@ -118,32 +119,11 @@ class HowIs
     def average_age_for(issues_or_pulls)
       return nil if issues_or_pulls.empty?
-      ages = issues_or_pulls.map { |iop| time_ago_in_seconds(iop['created_at']) }
-      raw_average = ages.reduce(:+) / ages.length
+      ages = issues_or_pulls.map { |iop| time_ago_in_seconds(iop["created_at"]) }
+      average_age_in_seconds = ages.reduce(:+) / ages.length
-      seconds_in_a_year = 31_556_926
-      seconds_in_a_month = 2_629_743
-      seconds_in_a_week = 604_800
-      seconds_in_a_day = 86_400
-      years = raw_average / seconds_in_a_year
-      years_remainder = raw_average % seconds_in_a_year
-      months = years_remainder / seconds_in_a_month
-      months_remainder = years_remainder % seconds_in_a_month
-      weeks = months_remainder / seconds_in_a_week
-      weeks_remainder = months_remainder % seconds_in_a_week
-      days = weeks_remainder / seconds_in_a_day
-      values = [
-        [years, "year"],
-        [months, "month"],
-        [weeks, "week"],
-        [days, "day"],
-      ].reject { |(v, _)| v == 0 }.map { |(v, k)|
-        k += 's' if v != 1
+      values = period_pairs_for(average_age_in_seconds).reject { |(v, _)| v.zero? }.map { |(v, k)|
+        k += "s" if v != 1
         [v, k]
       }
@@ -160,7 +140,7 @@ class HowIs
     end
     def sort_iops_by_created_at(issues_or_pulls)
-      issues_or_pulls.sort_by { |x| DateTime.parse(x['created_at']) }
+      issues_or_pulls.sort_by { |x| DateTime.parse(x["created_at"]) }
     end
     # Given an Array of issues or pulls, return the oldest.
@@ -181,7 +161,7 @@ class HowIs
     # Given an issue or PR, returns the date it was created.
     def date_for(issue_or_pull)
-      DateTime.parse(issue_or_pull['created_at'])
+      DateTime.parse(issue_or_pull["created_at"])
     end
     private
@@ -192,7 +172,7 @@ class HowIs
       labels.map { |label, num_issues|
         label_link = "https://github.com/#{repository}/issues?q=" + CGI.escape("is:open is:issue label:\"#{label}\"")
-        [label, {'link' => label_link, 'total' => num_issues}]
+        [label, {"link" => label_link, "total" => num_issues}]
       }.to_h
     end
@@ -206,11 +186,37 @@ class HowIs
       ret = {}
-      ret['html_url'] = iop['html_url']
-      ret['number'] = iop['number']
-      ret['date'] = date_for(iop)
+      ret["html_url"] = iop["html_url"]
+      ret["number"] = iop["number"]
+      ret["date"] = date_for(iop)
       ret
     end
+    SECONDS_IN_A_YEAR = 31_556_926
+    SECONDS_IN_A_MONTH = 2_629_743
+    SECONDS_IN_A_WEEK = 604_800
+    SECONDS_IN_A_DAY = 86_400
+    # Calculates a list of pairs of value and period label.
+    #
+    # @param age_in_seconds [Float]
+    #
+    # @return [Array<Array>] The input age_in_seconds expressed as different
+    #                        units, as pairs of value and unit name.
+    def period_pairs_for(age_in_seconds)
+      years_remainder = age_in_seconds % SECONDS_IN_A_YEAR
+      months_remainder = years_remainder % SECONDS_IN_A_MONTH
+      weeks_remainder = months_remainder % SECONDS_IN_A_WEEK
+      [
+        [age_in_seconds / SECONDS_IN_A_YEAR, "year"],
+        [years_remainder / SECONDS_IN_A_MONTH, "month"],
+        [months_remainder / SECONDS_IN_A_WEEK, "week"],
+        [weeks_remainder / SECONDS_IN_A_DAY, "day"],
+      ]
+    end
   end
 end

data/lib/how_is/contributions.rb ADDED Viewed

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+class HowIs
+  # Investigates who is a new committer since given date
+  #
+  #   # /repos/:owner/:repo/commits?since=<start date for the report>
+  class Contributions
+    # @param github [Github] configured github client
+    # @param since_date [String] A value which fits Repos.Commits "since" and
+    #                            "until" fields. This supports many formats, for
+    #                            example a timestamp in ISO 8601 format:
+    #                            YYYY-MM-DDTHH:MM:SSZ.
+    # @param user [String] GitHub user of repository
+    # @param repo [String] GitHub repository name
+    def initialize(github:, since_date:, user:, repo:)
+      @github = github
+      @since_date = since_date
+      @user = user
+      @repo = repo
+    end
+    # Returns a list of contributors that have zero commits before the @since_date.
+    #
+    # @return [Hash{String => Hash] Committers keyed by GitHub login name
+    def new_contributors
+      # author: GitHub login, name or email by which to filter by commit author.
+      all_contributors.select do |email, _committer|
+        @github.repos.commits.list(user: @user,
+                                   repo: @repo,
+                                   until: @since_date,
+                                   author: email).count.zero?
+      end
+    end
+    # @return [Hash{String => Hash}] Author information keyed by author's email
+    def all_contributors
+      commits.map { |api_response|
+        [api_response.commit.author.email, api_response.commit.author.to_h]
+      }.to_h
+    end
+    def commits
+      @github.repos.commits.list(user: @user, repo: @repo, since: @since_date)
+    end
+  end
+end

data/lib/how_is/fetcher.rb CHANGED Viewed

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-require 'contracts'
-require 'github_api'
-require 'how_is/pulse'
+require "contracts"
+require "github_api"
+require "how_is/pulse"
-##
-# Fetches data from GitHub.
 class HowIs
+  ##
+  # Fetches data from GitHub.
   class Fetcher
     include Contracts::Core
@@ -15,7 +15,7 @@ class HowIs
     #
     # Implemented as a class instead of passing around a Hash so that it can
     # be more easily referenced by Contracts.
-    class Results < Struct.new(:repository, :issues, :pulls, :pulse)
+    Results = Struct.new(:repository, :issues, :pulls, :pulse) do
       include Contracts::Core
       Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash], String => nil
@@ -37,12 +37,12 @@ class HowIs
              pulse = nil)
       github ||= Github.new(auto_pagination: true)
       pulse ||= HowIs::Pulse.new(repository)
-      user, repo = repository.split('/', 2)
+      user, repo = repository.split("/", 2)
       unless user && repo
-        raise HowIs::CLI::OptionsError, 'To generate a report from GitHub, ' \
-          'provide the repository ' \
-          'username/project. Quitting!'
+        raise HowIs::CLI::OptionsError, "To generate a report from GitHub, " \
+          "provide the repository " \
+          "username/project. Quitting!"
       end
       issues  = github.issues.list user: user, repo: repo