whatsup_github 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5ac25ee48ecbeb1219dae8e22c966ea1d3954b04c6cec344b1698095020671
-  data.tar.gz: f11b3a4b544675cc37cde564950b30b9162f3933335d44ae6e831408b8ed53db
+  metadata.gz: d76d974b6feb2663b6234906cde7aee2011f6fe1c87c2e90f7e4791e4f2b04a7
+  data.tar.gz: fb62023682520d065cfdf326300f576b38e85fea9fcf7e203b8105cae4278b94
 SHA512:
-  metadata.gz: f159bfdf36cd305cdbf2bfb7c16ce0aeae27e8405a87c0cc999fb0866f7a395d7de68e20e622a8b2dd69483a54bf2d7f7ab415b2523fa3b6af9241d179fe005a
-  data.tar.gz: 19275e16e836a8ef676cf03a8e0a98fd41b60699772c7d3890efd15f01cf67a08bdc54ebc808ef45af46d5875c2a47b912db4dc317b9d726565152b2a64db36d
+  metadata.gz: d50707d1f9eb818a36aec8bdc46d19d3543b037b94f9452b3734888184cf77c319364bdd5dc1a5675a4cd90718c808ad7b12052ffcba80d0ac43bd4652eb3d70
+  data.tar.gz: 2032e86160a162ba96521fcb3f7f4ae042c9494e12786e22e28ac4a75d0fcb0ae5c3154f03fe69c1616e0f1cd81eacc2c4166393287708d9535dd1e79eaf46cd

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.5
+ruby-2.5.8

data/.travis.yml

@@ -2,4 +2,5 @@
 sudo: false
 language: ruby
 cache: bundler
-before_install: gem install bundler -v 1.17.3
+before_install: gem install bundler -v 2.2.15
+script: bundle exec rake spec features

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+# Changelog
+
+## 0.4.1
+
+- Added authentication via an environment variable `WHATSUP_GITHUB_ACCESS_TOKEN`
+
+## 0.4.0
+
+### General
+
+- Loading more data about pull requests via API
+- Loading data about configured organization members via API
+- Upgraded gem specs
+- Removed non-working tests. TODO: Add tests for the output file.
+
+### New configuration option
+
+Added `membership` to configuration. Value: name of an organization to check membership of a contributor.
+
+### New output data
+
+Added `merge_commit`, `labels`, and `membership` to YAML output.
+Values for `membership`:
+    - `true` if contributor is a member of the configured organization
+    - `false` if not a member
+    - empty if not configured
+
+## 0.3.1
+
+- Added `contributor` and `profile` output data.
+
+## 0.3.0
+
+- Added "magic word" to configuration file
+- Added the requested GitHub query to terminal output (#13)
+- Fixed the issue with empty description (#21)
+
+## 0.2.0
+
+- Implemented two types of labels in configuration: 'optional' and 'required'.
+
 ## 0.0.1
 
 The tool is released as a gem.

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in whatsup_github.gemspec
 gemspec

data/Gemfile.lock

@@ -1,91 +1,129 @@
 PATH
   remote: .
   specs:
-    whatsup_github (0.1.1)
-      netrc (~> 0.10)
-      octokit (~> 4.14)
-      thor (~> 0.20)
+    whatsup_github (0.4.1)
+      netrc (~> 0.11)
+      octokit (~> 4.20)
+      thor (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    aruba (0.14.14)
-      childprocess (>= 0.6.3, < 4.0.0)
-      contracts (~> 0.9)
-      cucumber (>= 1.3.19)
-      ffi (~> 1.9)
-      rspec-expectations (>= 2.99)
-      thor (>= 0.19, < 2.0)
-    backports (3.17.0)
+    aruba (1.0.4)
+      childprocess (>= 2.0, < 5.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 6.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
     builder (3.2.4)
-    childprocess (3.0.0)
-    coderay (1.1.2)
+    childprocess (4.0.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
     contracts (0.16.0)
-    cucumber (3.1.2)
-      builder (>= 2.1.2)
-      cucumber-core (~> 3.2.0)
-      cucumber-expressions (~> 6.0.1)
-      cucumber-wire (~> 0.0.1)
-      diff-lcs (~> 1.3)
-      gherkin (~> 5.1.0)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.2)
-    cucumber-core (3.2.1)
-      backports (>= 3.8.0)
-      cucumber-tag_expressions (~> 1.1.0)
-      gherkin (~> 5.0)
-    cucumber-expressions (6.0.1)
-    cucumber-tag_expressions (1.1.1)
-    cucumber-wire (0.0.1)
-    diff-lcs (1.3)
-    faraday (1.0.0)
+    cucumber (5.3.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-create-meta (~> 2.0, >= 2.0.2)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-html-formatter (~> 9.0, >= 9.0.0)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      cucumber-wire (~> 4.0, >= 4.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-core (8.0.1)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (2.0.4)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-html-formatter (9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-messages (13.2.1)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (4.0.1)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
-    gherkin (5.1.0)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    ffi (1.15.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    multi_json (1.14.1)
+    middleware (0.1.0)
+    minitest (5.14.4)
     multi_test (0.1.2)
     multipart-post (2.1.1)
     netrc (0.11.0)
-    octokit (4.18.0)
+    octokit (4.20.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pry (0.13.0)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.3)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    thor (0.20.3)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  aruba (~> 0.14)
-  bundler (~> 1.17)
-  cucumber (~> 3.1)
-  pry (~> 0.12)
+  aruba (~> 1.0)
+  bundler (~> 2.2)
+  cucumber (~> 5.3)
+  pry (~> 0.14)
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.10)
   whatsup_github!
 
 BUNDLED WITH
-   1.17.3
+   2.2.15

data/README.md

@@ -1,27 +1,29 @@
-# WhatsupGithub
+# whatsup_github
 
 [![Build status](https://travis-ci.com/dshevtsov/whatsup_github.svg?branch=master)](https://travis-ci.com/dshevtsov/whatsup_github)
 [![Gem version](https://img.shields.io/gem/v/whatsup_github.svg?style=flat)](https://rubygems.org/gems/whatsup_github)
 
-This tool helps to update data for [Whats New on DevDocs](http://devdocs.magento.com/whats-new.html).
+This tool helps updating data for [Whats New on DevDocs](http://devdocs.magento.com/whats-new.html).
 It filters GitHub pull requests and generates a data file.
-One pull request - one data entity.
+One pull request sources one data entity.
 All filtering parameters are set in a configuration file, except dates.
 _Since_ date is set as a CLI argument and the _till_ date is always the moment when the command is run.
 
-## Prerequisite
+## What's generated
 
-The resulting data file is generated from data pulled from GitHub.
+A resulting YAML file `tmp/whats-new.yml` is generated from GitHub data.
 
 ### `description`
 
-Pull requests that will appear in search must have text that will fill out the _Description_ cell.
-The text must follow the `whatsnew` keyword and be located at the very bottom of a pull request description field.
+Text for `description` is taken from individual pull request's description (same as body).
+The text must follow the `whatsnew` keyword and be located at the end.
 
-```
+Example:
+
+```console
 This pull request adds ...
 
-...
+Some other details about this pull request.
 
 whatsnew
 Added documentation about [New Magento feature](https://devdocs.magento.com/new-magento-feature.html).
@@ -29,22 +31,51 @@ Added documentation about [New Magento feature](https://devdocs.magento.com/new-
 
 ### `type`
 
-Set as a list of `labels` in `.whatsup.yml`.
+Set as a list of `labels` in `.whatsup.yml`. There are two types of labels in configuration:
+
+- `required` are labels that must include `whatsnew`. Otherwise, resulting output will warn about missing `whatsnew`.
+- `optional` are labels that may include `whatsnew`. If `whatsnew` is missing, you won't get any notification about this.
 
 ### `versions`
 
-Any GitHub label that starts from a digit followed by a dot (see regex `\d\.`).
+Any GitHub label that starts from a digit followed by a period like in regex `\d\.`.
 Examples: `2.3.x`, `1.0.3-msi`, `2.x`
 
 ### `date`
 
-The date when pull request was merged.
+Date when the pull request was merged.
+
+### `link`
+
+URL of the pull request.
+
+### `contributor`
+
+An author of a pull request.
+
+### `merge_commit`
+
+Merge commit SHA of the pull request.
+
+### `membership`
+
+Memebership of the contributor in a configured organization.
+
+### `labels`
+
+All labels added to the pull request.
 
 ## Installation
 
-Same as any other gem.
+This gem can be installed as a system command-line tool or as a command-line tool available in a project.
 
-### Using Bundler as a part of your project
+### System installation
+
+```bash
+gem install whatsup_github
+```
+
+### Project installation
 
 Add to your Gemfile:
 
@@ -52,26 +83,46 @@ Add to your Gemfile:
 gem 'whatsup_github'
 ```
 
-And then execute:
+And install:
 
 ```bash
 bundle
 ```
 
-### Separately
-
-```
-gem install whatsup_github
-```
-
 ## Configuration
 
 The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be created automatically after first run unless it's already there.
 
 ## Authentication
 
+### With the .netrc file
+
 Use [`~/.netrc`](https://github.com/octokit/octokit.rb#using-a-netrc-file) file for authentication.
 
+```config
+machine api.github.com
+  login <GitHub login>
+  password <GitHub token>
+```
+
+Example:
+
+```config
+machine api.github.com
+  login dshevtsov
+  password y9o6YvEoa7IukRWUFdnkpuxNjJ3uwiDQp4zkAdU0
+```
+
+### With an environment variable
+
+Assign the `WHATSUP_GITHUB_ACCESS_TOKEN` to the GitHub token you want to use, prior the `whatsup_github` command.
+
+Example:
+
+```bash
+WHATSUP_GITHUB_ACCESS_TOKEN=askk494nmfodic68mk whatsup_github since 'apr 2'
+```
+
 ## Usage
 
 ```bash
@@ -90,13 +141,13 @@ You can use different date formats like `'April 2'`, `'2 April'`, `'apr 2'`, `'2
 
 To install dependencies:
 
-```
+```bash
 bin/setup
 ```
 
 To install the package:
 
-```
+```bash
 rake install
 ```
 
@@ -110,25 +161,45 @@ The project contains [rspec](https://rspec.info/) tests in `spec` and [cucumber]
 
 To run rspec tests:
 
-```
+```bash
 rake spec
 ```
 
 #### features
 
-To run cucumber tests:
+To run Cucumber tests:
 
-```
+```bash
 rake features
 ```
 
 To pass the `output_file.feature` tests, you need to generate a non-empty `whats-new.yml`.
 To test just file:
 
+```bash
+bundle exec cucumber features/since.feature
 ```
-bundle exec cucumber features/output_file.feature
+
+NOTE: Cucumber tests will use the configuration file from code `lib/template/.whatsup.yml`.
+
+#### Individual files
+
+Individual files can have tests at the end of a file in a format like:
+
+```ruby
+if $PROGRAM_NAME == __FILE__
+  # test code here
+end
+```
+
+To run such test, run the corresponding file:
+
+```bash
+ruby lib/whatsup_github/config_reader.rb 
 ```
 
+The tests use the root `.whatsup.yml` file to read configuration.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dshevtsov/whatsup_github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.