whatsup_github 0.1.1 → 0.4.1

data/Rakefile

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

data/bin/console

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "whatsup_github"
+require 'bundler/setup'
+require 'whatsup_github'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
+require 'pry'
 Pry.start
 
 # require "irb"

data/exe/whatsup_github

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'whatsup_github/cli'
 WhatsupGithub::CLI.start(ARGV)

data/lib/template/.whatsup.yml

@@ -1,16 +1,28 @@
 # Parameters for a GitHub search query
 base_branch: master
 
+# The list of repositories to scan for pull requests
 repos:
   - magento/devdocs
+  - magento-commerce/devdocs
 
 # 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:
   - yaml
 #  - markdown
+
+# The phrase that is used as a separator in the pull request descripion.
+# All the lines that follows this phrase are captured as 'description' for this PR's entry in the resulted data file.
+magic_word: whatsnew
+
+# An organization to check a contributor for membership.
+# Values: 'true', 'false', empry if not configured.
+membership: magento-commerce

data/lib/whatsup_github.rb

@@ -1,6 +1,6 @@
-require "whatsup_github/version"
+# frozen_string_literal: true
 
+require 'whatsup_github/version'
 
 module WhatsupGithub
-
 end

data/lib/whatsup_github/cli.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 require 'thor'
-require "whatsup_github/runner"
+require 'whatsup_github/runner'
 module WhatsupGithub
   class CLI < Thor
-    desc "since DATE", "Filters pull requests since the specified date till now."
+    desc 'since DATE', 'Filters pull requests since the specified date till now.'
 
     def since(date = Date.today - 7)
-
       runner = WhatsupGithub::Runner.new(Date.parse(date.to_s))
       runner.run
     end
     default_task :since
   end
-end
+end

data/lib/whatsup_github/config_reader.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'singleton'
+
+module WhatsupGithub
+  # Creates readable objects from confirurarion files
+  class Config
+    attr_reader :config
+
+    include Singleton
+
+    def initialize
+      @file = '.whatsup.yml'
+      @config = {}
+    end
+
+    def read
+      unless File.exist?(@file)
+        dist_file = File.expand_path("../template/#{@file}", __dir__)
+        FileUtils.cp dist_file, @file
+      end
+      @config = YAML.load_file @file
+      return {} unless @config
+
+      @config
+    end
+
+    def repos
+      read['repos']
+    end
+
+    def base_branch
+      read['base_branch']
+    end
+
+    def output_format
+      read['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
+
+    def membership
+      read['membership']
+    end
+
+    def magic_word
+      read['magic_word']
+    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
+  p config.magic_word
+  p config.membership
+end

data/lib/whatsup_github/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WhatsupGithub
   # Creates the final table
   class Generator
@@ -9,7 +11,7 @@ module WhatsupGithub
       @collector.sort_by_date
     end
 
-    def run formatter, content
+    def run(formatter, content)
       formatter.generate_output_from content
     end
   end

data/lib/whatsup_github/members.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhatsupGithub
+  # Members of an organization
+  class Members
+    def initialize(org)
+      @org = org
+    end
+
+    def client
+      Octokit::Client.new(netrc: true)
+    end
+
+    def members
+      client.org_members @org
+    end
+  end
+end

data/lib/whatsup_github/pulls.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'octokit'
-require_relative 'config-reader'
+require_relative 'config_reader'
 
 module WhatsupGithub
-  # Gets pull filtered pull requests from GitHub
+  # Gets issues found on GitHub by query
   class Pulls
     attr_reader :since, :repo
 
@@ -11,43 +13,94 @@ module WhatsupGithub
       @since = args[:since]
     end
 
-    def filtered
-      issues = []
-      labels.each do |label|
-        issues += search_issues(label).items
+    def data
+      pull_requests = []
+      filtered_numbers.each do |number|
+        pull_requests << client.pull_request(@repo, number)
       end
-      issues
+      pull_requests
     end
 
     private
 
     # def access_token
-    #   credentials.read 'github_token'
+    #   credentials.dig 'github_token'
     # end
 
     def configuration
       Config.instance
     end
 
-    def labels
-      configuration.read 'labels'
+    def optional_labels
+      configuration.optional_labels
+    end
+
+    def required_labels
+      configuration.required_labels
+    end
+
+    def magic_word
+      configuration.magic_word
     end
 
     def base_branch
-      configuration.read 'base_branch'
+      configuration.base_branch
     end
 
+    # Authorize with a GitHub token from $WHATSUP_GITHUB_ACCESS_TOKEN if available
+    # Otherwise, use credentials from ~/.netrc
+    # Otherwise, continue as a Guest
     def client
-      Octokit::Client.new(:netrc => true)
+      return @client if @client
+
+      @client =
+        if ENV['WHATSUP_GITHUB_ACCESS_TOKEN']
+          Octokit::Client.new(access_token: ENV['WHATSUP_GITHUB_ACCESS_TOKEN'])
+        elsif File.exist? "#{ENV['HOME']}/.netrc"
+          Octokit::Client.new(netrc: true)
+        else
+          Octokit::Client.new
+        end
     end
 
     def search_issues(label)
       auto_paginate
-      client.search_issues("repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch}")
+      query = "repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch}"
+      puts "Searching on GitHub by query #{query}"
+      client.search_issues(query)
+    end
+
+    def search_issues_with_magic_word(label)
+      auto_paginate
+      query = "repo:#{repo} label:\"#{label}\" merged:>=#{since} base:#{base_branch} \"#{magic_word}\" in:body"
+      puts "Searching on GitHub by query #{query}"
+      client.search_issues(query)
     end
 
     def auto_paginate
       Octokit.auto_paginate = true
     end
+
+    def filtered_issues
+      issues = []
+      required_labels.each do |label|
+        issues += search_issues(label).items
+      end
+      optional_labels.each do |label|
+        issues += search_issues_with_magic_word(label).items
+      end
+      issues
+    end
+
+    def filtered_numbers
+      filtered_issues.map(&:number)
+    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.data
+end

data/lib/whatsup_github/row.rb

@@ -1,21 +1,48 @@
+# frozen_string_literal: true
+
 module WhatsupGithub
   # Row to be converted to entry in future table
   class Row
-    attr_reader :body, :title, :labels, :pr_number, :assignee, :link
+    attr_reader :body,
+                :title,
+                :labels,
+                :link,
+                :pr_number,
+                :assignee,
+                :author,
+                :author_url,
+                :merge_commit,
+                :is_private,
+                :membership
+
     def initialize(args)
       @repo = args[:repo]
+      @repo_url = args[:repo_url]
+      @is_private = args[:private]
       @title = args[:pr_title]
       @body = args[:pr_body]
       @date = args[:date]
       @labels = args[:pr_labels]
       @assignee = args[:assignee]
+      @author = args[:author]
+      @author_url = args[:author_url]
       @pr_number = args[:pr_number]
       @link = args[:pr_url]
+      @merge_commit = args[:merge_commit_sha]
+      @membership = args[:membership]
       @config = Config.instance
     end
 
     def labels_from_config
-      @config.read('labels')
+      @config.labels
+    end
+
+    def required_labels
+      @config.required_labels
+    end
+
+    def magic_word
+      @config.magic_word
     end
 
     def versions
@@ -32,8 +59,10 @@ module WhatsupGithub
     end
 
     def parse_body
-      whatsnew_splited = body.split('whatsnew')[-1]
-      newline_splited = whatsnew_splited.split("\n")
+      # Split PR description in two parts by 'magic word', and take the second half
+      description_splited = body.split(magic_word)[-1]
+      # Convert new line separators to <br> tags
+      newline_splited = description_splited.split("\n")
       cleaned_array = newline_splited.map { |e| e.delete "\r\*" }
       cleaned_array.delete('')
       striped_array = cleaned_array.map(&:strip)
@@ -41,10 +70,12 @@ module WhatsupGithub
     end
 
     def description
-      if body.include?('whatsnew')
+      # 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?(magic_word)
         parse_body
       else
-        message = "MISSING whatsnew in the #{type} PR \##{pr_number}: \"#{title}\" assigned to #{assignee} (#{link})"
+        message = "MISSING #{magic_word} in the #{type} PR \##{pr_number}: \"#{title}\" assigned to #{assignee} (#{link})"
         puts message
         message
       end

data/lib/whatsup_github/row_collector.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'row'
 require_relative 'pulls'
-require_relative 'config-reader'
+require_relative 'config_reader'
+require_relative 'members'
 
 module WhatsupGithub
   # Creates Row objects for the future table
@@ -8,7 +11,7 @@ module WhatsupGithub
     attr_reader :repos, :since
 
     def initialize(args = {})
-      @repos = config.read('repos')
+      @repos = config.repos
       @since = args[:since]
     end
 
@@ -24,12 +27,19 @@ module WhatsupGithub
       pulls(repo).map do |pull|
         Row.new(
           repo: repo,
+          repo_url: pull.base.repo.html_url,
+          private: pull.base.repo.private?,
           pr_number: pull.number,
           pr_title: pull.title,
           pr_body: pull.body,
-          date: pull.closed_at,
+          date: pull.merged_at,
           pr_labels: label_names(pull.labels),
-          assignee: assignee(pull.assignee),
+          assignee: assignee(pull.assignees),
+          membership: member?(pull.user.login),
+          merger: pull.merged_by.login,
+          merge_commit_sha: pull.merge_commit_sha,
+          author: pull.user.login,
+          author_url: pull.user.html_url,
           pr_url: pull.html_url
         )
       end
@@ -47,20 +57,37 @@ module WhatsupGithub
 
     private
 
-    def assignee(assignee)
-      if assignee.nil?
+    def assignee(assignees)
+      if assignees.empty?
         'NOBODY'
       else
-        assignee.login
+        assignees.map(&:login).join(', ')
       end
     end
 
+    def member?(login)
+      return nil unless config.membership
+
+      member_logins.include? login
+    end
+
     def label_names(labels)
       labels.map(&:name)
     end
 
     def pulls(repo)
-      Pulls.new(repo: repo, since: since).filtered
+      Pulls.new(repo: repo, since: since).data
+    end
+
+    def load_members
+      return if @members
+
+      @members = Members.new(config.membership).members
+    end
+
+    def member_logins
+      load_members
+      @members.map(&:login)
     end
 
     def config