whatsup_github 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f70d20f66860466a71e5f253d75db911d24bfd91c7403d8351bc6f62b9ba7e
-  data.tar.gz: 43fd5d4cf2d8d29f150a2bbe61aeb1b92a7fdd76e099138622786db4a191e058
+  metadata.gz: da5ac25ee48ecbeb1219dae8e22c966ea1d3954b04c6cec344b1698095020671
+  data.tar.gz: f11b3a4b544675cc37cde564950b30b9162f3933335d44ae6e831408b8ed53db
 SHA512:
-  metadata.gz: ea289b8d727aaed1ce88219250ccd41b30cf77c3417a3ca16e185afdcbcf5575f8f14554ebcf60196ca001e44b8fc140b11b2e4108a91032ec9bd30beed2b97a
-  data.tar.gz: fa873b26c9faa0559c877904c10d33eae35dab773acf0a1eb0025964dd35fd69a314554b060eb33015be0b4cbe85096974ff6ceff672fc53e82ff18ed42eabb5
+  metadata.gz: f159bfdf36cd305cdbf2bfb7c16ce0aeae27e8405a87c0cc999fb0866f7a395d7de68e20e622a8b2dd69483a54bf2d7f7ab415b2523fa3b6af9241d179fe005a
+  data.tar.gz: 19275e16e836a8ef676cf03a8e0a98fd41b60699772c7d3890efd15f01cf67a08bdc54ebc808ef45af46d5875c2a47b912db4dc317b9d726565152b2a64db36d

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.travis.yml

@@ -2,6 +2,4 @@
 sudo: false
 language: ruby
 cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2
+before_install: gem install bundler -v 1.17.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsup_github (0.0.1)
+    whatsup_github (0.1.1)
       netrc (~> 0.10)
       octokit (~> 4.14)
       thor (~> 0.20)
@@ -9,19 +9,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    aruba (0.14.10)
-      childprocess (>= 0.6.3, < 1.1.0)
+    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)
-    backports (3.15.0)
-    builder (3.2.3)
-    childprocess (1.0.1)
-      rake (< 13.0)
+      thor (>= 0.19, < 2.0)
+    backports (3.17.0)
+    builder (3.2.4)
+    childprocess (3.0.0)
     coderay (1.1.2)
     contracts (0.16.0)
     cucumber (3.1.2)
@@ -41,35 +40,36 @@ GEM
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    faraday (0.15.4)
+    faraday (1.0.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.11.1)
+    ffi (1.12.2)
     gherkin (5.1.0)
-    method_source (0.9.2)
-    multi_json (1.13.1)
+    method_source (1.0.0)
+    multi_json (1.14.1)
     multi_test (0.1.2)
     multipart-post (2.1.1)
     netrc (0.11.0)
-    octokit (4.14.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.1.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    pry (0.13.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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -83,9 +83,9 @@ DEPENDENCIES
   bundler (~> 1.17)
   cucumber (~> 3.1)
   pry (~> 0.12)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   whatsup_github!
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -1,13 +1,52 @@
 # WhatsupGithub
 
-The tool helps to update the [Whats New on DevDocs](http://devdocs.magento.com/whats-new.html).
-It filters by labels the pull requests merged into repositories and generates an output in a specified format (`markdown` or/and `yaml`).
-In the command line, provide the date since when you want to check changes.
-By default, the tool filters results for the passed week.
+[![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).
+It filters GitHub pull requests and generates a data file.
+One pull request - 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
+
+The resulting data file is generated from data pulled from GitHub.
+
+### `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.
+
+```
+This pull request adds ...
+
+...
+
+whatsnew
+Added documentation about [New Magento feature](https://devdocs.magento.com/new-magento-feature.html).
+```
+
+### `type`
+
+Set as a list of `labels` in `.whatsup.yml`.
+
+### `versions`
+
+Any GitHub label that starts from a digit followed by a dot (see regex `\d\.`).
+Examples: `2.3.x`, `1.0.3-msi`, `2.x`
+
+### `date`
+
+The date when pull request was merged.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Same as any other gem.
+
+### Using Bundler as a part of your project
+
+Add to your Gemfile:
 
 ```ruby
 gem 'whatsup_github'
@@ -19,21 +58,27 @@ And then execute:
 bundle
 ```
 
-Or install it yourself as:
+### Separately
 
-```bash
+```
 gem install whatsup_github
 ```
 
-## Usage
+## Configuration
+
+The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be created automatically after first run unless it's already there.
+
+## Authentication
+
+Use [`~/.netrc`](https://github.com/octokit/octokit.rb#using-a-netrc-file) file for authentication.
 
-Generate the output with recent updates since April 2 of the current year till today:
+## Usage
 
 ```bash
 whatsup_github since 'apr 2'
 ```
 
-By default, it generates recent updates for the passed week:
+If run with no arguments, it generates data for the past week:
 
 ```bash
 whatsup_github
@@ -41,20 +86,48 @@ whatsup_github
 
 You can use different date formats like `'April 2'`, `'2 April'`, `'apr 2'`, `'2 Apr'`, `2018-04-02`.
 
-The result is returned into _tmp/whats-new.yml_ or _tmp/whats-new.md_ files, depending on the format specified in configuration.
+## Development
 
-## Configuration
+To install dependencies:
 
-The configuration file [`.whatsup.yml`](lib/template/.whatsup.yml) will be created during the first run.
+```
+bin/setup
+```
 
-## Authentication
+To install the package:
 
-You can use the tool as anonymous user until you'll need to scan private repositories or merely reach the [rate limit of unauthenticted requests](https://developer.github.com/v3/#rate-limiting).
-In this case, use [`~/.netrc`](https://github.com/octokit/octokit.rb#using-a-netrc-file) file for authentication.
+```
+rake install
+```
 
-## Development
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Testing
+
+The project contains [rspec](https://rspec.info/) tests in `spec` and [cucumber](https://app.cucumber.pro/p/af1681aa-415f-44f0-8260-5454a69c472a/aruba/documents/branch/master/features/03_testing_frameworks/cucumber/steps/filesystem/check_existence_of_file.feature) tests in `features`.
+
+#### specs
+
+To run rspec tests:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the Ruby tests, and `bundle exec cucumber features` to run CLI tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+rake spec
+```
+
+#### features
+
+To run cucumber tests:
+
+```
+rake features
+```
+
+To pass the `output_file.feature` tests, you need to generate a non-empty `whats-new.yml`.
+To test just file:
+
+```
+bundle exec cucumber features/output_file.feature
+```
 
 ## Contributing
 
@@ -63,7 +136,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/dshevt
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the WhatsupGithub project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dshevtsov/whatsup_github/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,14 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'cucumber'
+require 'cucumber/rake/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty" # Any valid command line option can go here.
+end
+
+task :test => [:spec, :features]

data/lib/template/.whatsup.yml

@@ -1,18 +1,16 @@
-# Name of the base branch in GitHub PRs
+# Parameters for a GitHub search query
 base_branch: master
 
-# Repositories for scanning. If you want to search private repositories, use credentials to specify 
 repos:
   - magento/devdocs
 
-# Labels for filtering (currently, hard-coded)
+# Labels also will be used as a 'type' value in the output file
 labels:
-  - New doc
-  - Major update
+  - New Topic
+  - Major Update
   - Technical
 
-# Output format
+# Format of output file
 output_format:
-#  - markdown
   - yaml
-  
+#  - markdown

data/lib/whatsup_github/config-reader.rb

@@ -22,7 +22,7 @@ module WhatsupGithub
 
     def load_from_yaml
       @config = YAML.load_file @file
-      return {} unless @config
+      return {} if !@config
       @config
     end
   end

data/lib/whatsup_github/row.rb

@@ -11,14 +11,12 @@ module WhatsupGithub
       @assignee = args[:assignee]
       @pr_number = args[:pr_number]
       @link = args[:pr_url]
+      @config = Config.instance
     end
 
-    UPDATED_MASK = 'Major update'.freeze
-    UPDATED_PHRASE = 'Major update'.freeze
-    NEW_MASK = 'New topic'.freeze
-    NEW_PHRASE = 'New topic'.freeze
-    TECHNICAL_MASK = 'Technical'.freeze
-    TECHNICAL_PHRASE = 'Technical changes'.freeze
+    def labels_from_config
+      @config.read('labels')
+    end
 
     def versions
       label_versions = labels.select { |label| label.start_with?(/\d\./) }
@@ -30,16 +28,7 @@ module WhatsupGithub
     end
 
     def type
-      labels_string = labels.join(' ')
-      label_type = /#{ UPDATED_MASK }|#{ NEW_MASK }|#{ TECHNICAL_MASK }/.match(labels_string)
-      case label_type.to_s
-      when /#{ UPDATED_MASK }/
-        UPDATED_PHRASE
-      when /#{ NEW_MASK }/
-        NEW_PHRASE
-      when /#{ TECHNICAL_MASK }/
-        TECHNICAL_PHRASE
-      end
+      (labels & labels_from_config).join(', ')
     end
 
     def parse_body

data/lib/whatsup_github/version.rb

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

data/whatsup_github.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "netrc", "~> 0.10"
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "cucumber", "~> 3.1"
   spec.add_development_dependency "aruba", "~> 0.14"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsup_github
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Dima Shevtsov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +146,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
-- ".whatsnew.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Collect info from GitHub pull requests.

data/.whatsnew.yml

@@ -1,17 +0,0 @@
-# Name of the base branch in GitHub PRs
-base_branch: master
-
-# Repos for scanning
-repos:
-  - magento/devdocs
-
-# Labels for filtering
-labels:
-  - New doc
-  - Major update
-  - Technical
-
-# Output format
-output_format:
-#  - markdown
-  - yaml