whatsup_github 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c5a5193535cbcad7a2e79333943ca9761e7b6bc06a867fffacaf3abac90ce47
-  data.tar.gz: e0f92a5c0619da8911035a61b3cb0e17dab44344b99db02986da0fbb67cf4c76
+  metadata.gz: 47baad7941df565f9c94827246aac88071c87bda1a975500e7365f0e225ec558
+  data.tar.gz: de4dc002c57c8a5cf7adb7a440ece5cbd135ba0941b450c3406308838a492ddc
 SHA512:
-  metadata.gz: 43c4beaa0b90f93aeb01ab7a2f2643702ac8d078bd3b21801a250a7918dba077ecee5f9138d731e3817ad78719769bc4167f32ce7bdfad480c374e790a498251
-  data.tar.gz: 9247198a00d96c500236f093dc7b458e256220b8763ab6831207c014f1da6acd5d24aa95f3fc47b45cf5850e727543e8d53515a0684432b07f0d58d96fb9dff5
+  metadata.gz: 83358141ba037b13e106d49e9d1bf23c22b2f41ddada945e87c8e3a5319c9f26e664f67e3db68a27799786f866d93b634cf6f9949ef3e0266a91dd2bfa65d3d6
+  data.tar.gz: 55babd4c4a276620f8c4ba198c1e6cd0e40eabc9385b674d6567d6f4607be2bb8b2ba19fa25164fae49c5f327f5b52dae55022f7defc09c6f93f3d1a3f8ec1b1

data/.github/linters/.ruby-lint.yml

@@ -0,0 +1,11 @@
+---
+#######################
+# Rubocop Config file #
+#######################
+
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.github/workflows/linter.yml

@@ -0,0 +1,48 @@
+---
+###########################
+###########################
+## Linter GitHub Actions ##
+###########################
+###########################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+###################################
+# Start the job on a pull request #
+###################################
+on:
+  pull_request
+
+###############
+# Set the Job #
+###############
+jobs:
+  super-lint:
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+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,50 @@
+# Changelog
+
+## 0.4.2
+
+Fixes:
+
+- Fixed a bug with non-working membership
+
+Maintenance:
+
+- Added code linting
+
+## 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'.

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,92 +1,129 @@
 PATH
   remote: .
   specs:
-    whatsup_github (0.2.0)
-      netrc (~> 0.10)
-      octokit (~> 4.14)
-      thor (~> 0.20)
+    whatsup_github (0.4.2)
+      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.1)
+    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.5)
-    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

@@ -20,7 +20,7 @@ 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.
@@ -32,6 +32,7 @@ Added documentation about [New Magento feature](https://devdocs.magento.com/new-
 ### `type`
 
 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.
 
@@ -48,13 +49,29 @@ Date when the pull request was merged.
 
 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
 
 This gem can be installed as a system command-line tool or as a command-line tool available in a project.
 
 ### System installation
 
-```
+```bash
 gem install whatsup_github
 ```
 
@@ -78,9 +95,11 @@ The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be creat
 
 ## 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>
@@ -88,12 +107,22 @@ machine api.github.com
 
 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
@@ -112,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
 ```
 
@@ -132,7 +161,7 @@ The project contains [rspec](https://rspec.info/) tests in `spec` and [cucumber]
 
 To run rspec tests:
 
-```
+```bash
 rake spec
 ```
 
@@ -140,14 +169,14 @@ rake spec
 
 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
 ```
 
@@ -166,7 +195,7 @@ end
 To run such test, run the corresponding file:
 
 ```bash
-ruby lib/whatsup_github/config-reader.rb 
+ruby lib/whatsup_github/config_reader.rb 
 ```
 
 The tests use the root `.whatsup.yml` file to read configuration.