whatsup_github 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5ac25ee48ecbeb1219dae8e22c966ea1d3954b04c6cec344b1698095020671
-  data.tar.gz: f11b3a4b544675cc37cde564950b30b9162f3933335d44ae6e831408b8ed53db
+  metadata.gz: 3c5a5193535cbcad7a2e79333943ca9761e7b6bc06a867fffacaf3abac90ce47
+  data.tar.gz: e0f92a5c0619da8911035a61b3cb0e17dab44344b99db02986da0fbb67cf4c76
 SHA512:
-  metadata.gz: f159bfdf36cd305cdbf2bfb7c16ce0aeae27e8405a87c0cc999fb0866f7a395d7de68e20e622a8b2dd69483a54bf2d7f7ab415b2523fa3b6af9241d179fe005a
-  data.tar.gz: 19275e16e836a8ef676cf03a8e0a98fd41b60699772c7d3890efd15f01cf67a08bdc54ebc808ef45af46d5875c2a47b912db4dc317b9d726565152b2a64db36d
+  metadata.gz: 43c4beaa0b90f93aeb01ab7a2f2643702ac8d078bd3b21801a250a7918dba077ecee5f9138d731e3817ad78719769bc4167f32ce7bdfad480c374e790a498251
+  data.tar.gz: 9247198a00d96c500236f093dc7b458e256220b8763ab6831207c014f1da6acd5d24aa95f3fc47b45cf5850e727543e8d53515a0684432b07f0d58d96fb9dff5

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.5
+ruby-2.7.1

data/CHANGELOG.md

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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsup_github (0.1.1)
+    whatsup_github (0.2.0)
       netrc (~> 0.10)
       octokit (~> 4.14)
       thor (~> 0.20)
@@ -40,7 +40,7 @@ GEM
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.12.2)
     gherkin (5.1.0)
@@ -55,7 +55,7 @@ GEM
     pry (0.13.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.5)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -77,6 +77,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   aruba (~> 0.14)

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:
 
 ```
 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,34 @@ 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.
 
 ## 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.
+
+### System installation
+
+```
+gem install whatsup_github
+```
 
-### Using Bundler as a part of your project
+### Project installation
 
 Add to your Gemfile:
 
@@ -52,18 +66,12 @@ 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.
@@ -72,6 +80,20 @@ The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be creat
 
 Use [`~/.netrc`](https://github.com/octokit/octokit.rb#using-a-netrc-file) file for authentication.
 
+```
+machine api.github.com
+  login <GitHub login>
+  password <GitHub token>
+```
+
+Example:
+
+```
+machine api.github.com
+  login dshevtsov
+  password y9o6YvEoa7IukRWUFdnkpuxNjJ3uwiDQp4zkAdU0
+```
+
 ## Usage
 
 ```bash
@@ -116,7 +138,7 @@ rake spec
 
 #### features
 
-To run cucumber tests:
+To run Cucumber tests:
 
 ```
 rake features
@@ -126,9 +148,29 @@ To pass the `output_file.feature` tests, you need to generate a non-empty `whats
 To test just file:
 
 ```
-bundle exec cucumber features/output_file.feature
+bundle exec cucumber features/since.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.

data/lib/template/.whatsup.yml

@@ -6,9 +6,11 @@ repos:
 
 # Labels also will be used as a 'type' value in the output file
 labels:
-  - New Topic
-  - Major Update
-  - Technical
+  required:
+    - New Topic
+    - Major Update
+  optional:
+    - Technical
 
 # Format of output file
 output_format:

data/lib/whatsup_github/config-reader.rb

@@ -12,18 +12,52 @@ module WhatsupGithub
       @config = {}
     end
 
-    def read(*options)
+    def read
       unless File.exist?(@file)
         dist_file = File.expand_path("../template/#{@file}", __dir__)
         FileUtils.cp dist_file, @file
       end
-      load_from_yaml.dig options.join ','
-    end
-
-    def load_from_yaml
       @config = YAML.load_file @file
       return {} if !@config
       @config
     end
+
+    def repos
+      read.dig 'repos'
+    end
+
+    def base_branch
+      read.dig 'base_branch'
+    end
+
+    def output_format
+      read.dig 'output_format'
+    end
+
+    def labels
+      required_labels + optional_labels
+    end
+
+    def required_labels
+      res = read.dig 'labels', 'required'
+      return [] unless res
+      res
+    end
+
+    def optional_labels
+      res = read.dig 'labels', 'optional'
+      return [] unless res
+      res
+    end
   end
 end
+
+if $PROGRAM_NAME == __FILE__
+  config = WhatsupGithub::Config.instance
+  p config.repos
+  p config.base_branch
+  p config.output_format
+  p config.labels
+  p config.required_labels
+  p config.optional_labels
+end

data/lib/whatsup_github/pulls.rb

@@ -22,7 +22,7 @@ module WhatsupGithub
     private
 
     # def access_token
-    #   credentials.read 'github_token'
+    #   credentials.dig 'github_token'
     # end
 
     def configuration
@@ -30,11 +30,11 @@ module WhatsupGithub
     end
 
     def labels
-      configuration.read 'labels'
+      configuration.labels
     end
 
     def base_branch
-      configuration.read 'base_branch'
+      configuration.base_branch
     end
 
     def client
@@ -51,3 +51,10 @@ module WhatsupGithub
     end
   end
 end
+
+if $PROGRAM_NAME == __FILE__
+  require 'date'
+  two_weeks_ago = (Date.today - 14).to_s
+  pulls = WhatsupGithub::Pulls.new(repo: 'magento/devdocs', since: two_weeks_ago)
+  p pulls.filtered
+end

data/lib/whatsup_github/row.rb

@@ -15,7 +15,11 @@ module WhatsupGithub
     end
 
     def labels_from_config
-      @config.read('labels')
+      @config.labels
+    end
+
+    def required_labels
+      @config.required_labels
     end
 
     def versions
@@ -41,9 +45,11 @@ module WhatsupGithub
     end
 
     def description
+      # If a PR body includes a phrase 'whatsnew', then parse the body.
+      # If there are at least one required label but PR body does not include what's new, warn about missing 'whatsnew'
       if body.include?('whatsnew')
         parse_body
-      else
+      elsif !(labels & required_labels).empty? && !body.include?('whatsnew')
         message = "MISSING whatsnew in the #{type} PR \##{pr_number}: \"#{title}\" assigned to #{assignee} (#{link})"
         puts message
         message

data/lib/whatsup_github/row_collector.rb

@@ -8,7 +8,7 @@ module WhatsupGithub
     attr_reader :repos, :since
 
     def initialize(args = {})
-      @repos = config.read('repos')
+      @repos = config.repos
       @since = args[:since]
     end
 

data/lib/whatsup_github/runner.rb

@@ -14,7 +14,7 @@ module WhatsupGithub
     end
 
     def run
-      format = @config.read 'output_format'
+      format = @config.output_format
       raise 'Cannot find "output_format" in config.yml' unless format
       table if format.include? 'markdown'
       data if format.include? 'yaml'

data/lib/whatsup_github/version.rb

@@ -1,3 +1,3 @@
 module WhatsupGithub
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/whatsup_github.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.4.0'
+
   spec.add_dependency "octokit", "~> 4.14"
   spec.add_dependency "thor", "~> 0.20"
   spec.add_dependency "netrc", "~> 0.10"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsup_github
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dima Shevtsov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-description: 
+description:
 email:
 - shevtsov@adobe.com
 executables:
@@ -177,7 +177,7 @@ metadata:
   homepage_uri: https://github.com/dshevtsov/whatsup_github
   source_code_uri: https://github.com/dshevtsov/whatsup_github
   changelog_uri: https://github.com/dshevtsov/whatsup_github/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,15 +185,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Collect info from GitHub pull requests.
 test_files: []