nya_pr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74fef078ebf20c6a46a8596b5001a66b744436a33ee407d14168699e577fa7e1
-  data.tar.gz: 3e686721cb075eead9c7cd7070cf49ee6d0b9eca7ce879b8555380c6d1a52626
+  metadata.gz: 72276bc9090fe6feb1925b4d56948ca6521d3d6ddf218b8bde737010d29ed923
+  data.tar.gz: b69b2671887a606a6cb09434f7eb242bb6b1c79075755d7492590a7adac8ce22
 SHA512:
-  metadata.gz: 40aa1079ac60ac7d0de2d79135eeb75f7b1854e4299277a94ec424268d0fb59719be1f8832546fb6fd28abeac63786b4043a2128ea60749daa183839850658f3
-  data.tar.gz: 0377b72b765df89b9da1ff33d92224431a1ebe16c10c70e457f4ebdb93381479d9c1a6e0122366075363f1d550ca1491647d9f0cd9b44347d9cca6304249806e
+  metadata.gz: 62623d0683a5c23143c219724f980194e2cf6e88d5b1b090c8d34d83494f2d4fb5340b1ee693d2c8464f7bfa8f13b925df714f52a6f0bdefe8b1f634bd8b2019
+  data.tar.gz: 02fba8805b5d75b461fad1580e4fb70b71f709c91bc8d10e48d6fe3bdc11203ae48c051a57a67b68689947ca1f0613d7dc36b44873fa988aceb9d22e57c72754

data/README.md

@@ -1,11 +1,42 @@
 # NyaPr ฅ^•ﻌ•^ฅ
 
+![Gem Version](https://img.shields.io/gem/v/nya_pr)
+![CI](https://github.com/bodrovis/nya_pr/actions/workflows/ci.yml/badge.svg)
+
 **NyaPr** is a tiny Ruby tool for people who have too many GitHub repositories, too many organizations, too many pull requests, and absolutely no desire to click through all that manually.
 
 It collects repositories you own or contribute to, finds their open pull requests, and puts everything into one place.
 
 For maximum kawaii.
 
+## Quick start
+
+Install the gem:
+
+```bash
+gem install nya_pr
+```
+
+Set your GitHub token:
+
+```bash
+export GITHUB_TOKEN=your_token
+```
+
+Run NyaPr:
+
+```bash
+nya-pr --user your-github-username
+```
+
+To include additional users or organizations:
+
+```bash
+nya-pr --user your-github-username --owners org-one,org-two
+```
+
+NyaPr will collect relevant repositories, find open pull requests, print them to the terminal, and save the results under `data/`.
+
 ## Why NyaPr?
 
 GitHub is perfectly happy to show you:
@@ -270,6 +301,7 @@ Logs are written to `stderr`, while actual pull request output goes to `stdout`.
 -l, --limit N                    Maximum number of pull requests to collect
 -r, --refresh                    Refresh repositories from GitHub
     --skip-archived              Ignore archived repositories
+    --skip-drafts                Ignore draft pull requests
     --[no-]progress              Show or hide progress bars
     --log-level LEVEL            Logging level
 -v, --version                    Show NyaPr version

data/lib/nya_pr/cli/command.rb

@@ -3,14 +3,6 @@
 module NyaPr
   module Cli
     class Command < Dry::CLI::Command
-      LOG_LEVELS = {
-        'debug' => Logger::DEBUG,
-        'info' => Logger::INFO,
-        'warn' => Logger::WARN,
-        'error' => Logger::ERROR,
-        'fatal' => Logger::FATAL
-      }.freeze
-
       desc 'Collect open GitHub pull requests'
 
       option :username,
@@ -34,7 +26,7 @@ module NyaPr
 
       option :limit,
              aliases: ['-l'],
-             default: PullRequest::Finder::MAX_PULL_REQUESTS,
+             default: PullRequest::Config::DEFAULT_LIMIT,
              desc: 'Maximum number of pull requests'
 
       option :refresh,
@@ -48,13 +40,18 @@ module NyaPr
              default: false,
              desc: 'Skip archived repositories'
 
+      option :skip_drafts,
+             type: :boolean,
+             default: false,
+             desc: 'Ignore draft pull requests'
+
       option :progress,
              type: :boolean,
              default: true,
              desc: 'Show progress bars'
 
       option :log_level,
-             values: LOG_LEVELS.keys,
+             values: Config::LOG_LEVELS.keys,
              default: 'info',
              desc: 'Log level'
 
@@ -69,41 +66,7 @@ module NyaPr
           return
         end
 
-        normalize_options!(options)
-        validate_username!(options)
-
-        Runner.new(options).run
-      end
-
-      private
-
-      def normalize_options!(options)
-        options[:owners] = normalize_owners(options[:owners])
-        options[:limit] = normalize_limit(options[:limit])
-        options[:log_level] = LOG_LEVELS.fetch(options[:log_level])
-      end
-
-      def normalize_owners(owners)
-        Array(owners).
-          flat_map { |owner| owner.split(',') }.
-          map(&:strip).
-          reject(&:empty?)
-      end
-
-      def normalize_limit(value)
-        limit = Integer(value)
-
-        return limit if limit.positive?
-
-        raise NyaPr::Error, 'limit must be greater than 0'
-      rescue ArgumentError, TypeError
-        raise NyaPr::Error, 'limit must be a positive integer'
-      end
-
-      def validate_username!(options)
-        return unless options[:username].to_s.empty?
-
-        raise NyaPr::Error, 'GitHub username is required'
+        Runner.new(Config.from_options(options)).run
       end
     end
   end

data/lib/nya_pr/config.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module NyaPr
+  class Config < Data.define(
+    :username,
+    :owners,
+    :token,
+    :repositories_csv,
+    :pull_requests_dir,
+    :limit,
+    :refresh,
+    :skip_archived,
+    :skip_drafts,
+    :progress,
+    :log_level
+  )
+    LOG_LEVELS = {
+      'debug' => Logger::DEBUG,
+      'info' => Logger::INFO,
+      'warn' => Logger::WARN,
+      'error' => Logger::ERROR,
+      'fatal' => Logger::FATAL
+    }.freeze
+
+    class << self
+      def from_options(options)
+        username = options[:username].to_s
+        validate_username!(username)
+
+        new(
+          username: username,
+          owners: normalize_owners(options[:owners]),
+          token: options[:token],
+          repositories_csv: options[:repositories_csv],
+          pull_requests_dir: options[:pull_requests_dir],
+          limit: normalize_limit(options[:limit]),
+          refresh: options[:refresh],
+          skip_archived: options[:skip_archived],
+          skip_drafts: options[:skip_drafts],
+          progress: options[:progress],
+          log_level: LOG_LEVELS.fetch(options[:log_level])
+        )
+      end
+
+      private
+
+      def normalize_owners(owners)
+        Array(owners).
+          flat_map { |owner| owner.split(',') }.
+          map(&:strip).
+          reject(&:empty?)
+      end
+
+      def normalize_limit(value)
+        limit = Integer(value)
+
+        return limit if limit.positive?
+
+        raise NyaPr::Error, 'limit must be greater than 0'
+      rescue ArgumentError, TypeError
+        raise NyaPr::Error, 'limit must be a positive integer'
+      end
+
+      def validate_username!(username)
+        return unless username.empty?
+
+        raise NyaPr::Error, 'GitHub username is required'
+      end
+    end
+  end
+end

data/lib/nya_pr/pull_request/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module NyaPr
+  module PullRequest
+    class Config < Data.define(
+      :limit,
+      :skip_drafts,
+      :progress_enabled
+    )
+      DEFAULT_LIMIT = 100
+
+      def self.from_app(config)
+        new(
+          limit: config.limit,
+          skip_drafts: config.skip_drafts,
+          progress_enabled: config.progress
+        )
+      end
+    end
+  end
+end

data/lib/nya_pr/pull_request/filter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module NyaPr
+  module PullRequest
+    class Filter
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def match?(pull_request)
+        return false if config.skip_drafts && pull_request['draft']
+
+        true
+      end
+
+      def ===(pull_request)
+        match?(pull_request)
+      end
+    end
+  end
+end

data/lib/nya_pr/pull_request/finder.rb

@@ -5,29 +5,23 @@ module NyaPr
     class Finder
       include NyaPr::Request
 
-      MAX_PULL_REQUESTS = 100
       MAX_PER_PAGE = 100
 
       attr_reader :client,
                   :repositories,
-                  :limit,
-                  :progress_enabled
-
-      def initialize(
-        client,
-        repositories,
-        limit: MAX_PULL_REQUESTS,
-        progress_enabled: true
-      )
+                  :config,
+                  :filter
+
+      def initialize(client, repositories, config, filter: nil)
         @client = client
         @repositories = repositories
-        @limit = limit
-        @progress_enabled = progress_enabled
+        @config = config
+        @filter = filter || Filter.new(config)
       end
 
       def find
         NyaPr.logger.info(
-          "Searching for up to #{limit} open pull requests " \
+          "Searching for up to #{config.limit} open pull requests " \
           "in #{repositories.size} repositories"
         )
 
@@ -49,55 +43,84 @@ module NyaPr
         pull_requests = []
 
         repositories.each do |repository|
-          break if pull_requests.size >= limit
-
-          begin
-            next unless repository.fetch('has_pull_requests', true)
+          break if pull_requests.size >= config.limit
 
-            remaining = limit - pull_requests.size
-
-            pull_requests.concat(
-              pull_requests_for(repository, remaining)
-            )
-          ensure
-            progress_bar.advance
-          end
+          process_repository(
+            repository,
+            pull_requests,
+            progress_bar
+          )
         end
 
         pull_requests
       end
 
+      def process_repository(repository, pull_requests, progress_bar)
+        return unless pull_requests_enabled?(repository)
+
+        remaining = config.limit - pull_requests.size
+
+        pull_requests.concat(
+          pull_requests_for(repository, remaining)
+        )
+      ensure
+        progress_bar.advance
+      end
+
+      def pull_requests_enabled?(repository)
+        repository.fetch('has_pull_requests', true)
+      end
+
       def pull_requests_for(repository, remaining)
         NyaPr.logger.debug(
           "Checking pull requests in #{repository.fetch('full_name')}"
         )
 
         pull_requests = []
+        per_page = [remaining, MAX_PER_PAGE].min
+
+        each_batch(repository, per_page) do |batch|
+          append_matches(
+            pull_requests,
+            repository,
+            batch,
+            remaining
+          )
+
+          break if pull_requests.size >= remaining
+        end
+
+        pull_requests
+      end
+
+      def each_batch(repository, per_page)
         page = 1
 
         loop do
-          per_page = page_size(remaining, pull_requests.size)
           batch = get_batch(repository, per_page, page)
 
           break if batch.empty?
 
-          pull_requests.concat(
-            batch.map do |pull_request|
-              normalize(repository, pull_request)
-            end
-          )
+          yield batch
 
           break if batch.size < per_page
-          break if pull_requests.size >= remaining
 
           page += 1
         end
+      end
 
-        pull_requests
+      def append_matches(pull_requests, repository, batch, limit)
+        needed = limit - pull_requests.size
+
+        pull_requests.concat(
+          filter_batch(repository, batch).first(needed)
+        )
       end
 
-      def page_size(remaining, collected)
-        [remaining - collected, MAX_PER_PAGE].min
+      def filter_batch(repository, batch)
+        batch.
+          map { |pull_request| normalize(repository, pull_request) }.
+          grep(filter)
       end
 
       def get_batch(repository, per_page, page)
@@ -115,7 +138,7 @@ module NyaPr
         Progress.new(
           '🐾 Checking pull requests',
           total: repositories.size,
-          enabled: progress_enabled && $stderr.tty?
+          enabled: config.progress_enabled && $stderr.tty?
         )
       end
 

data/lib/nya_pr/repository/collector.rb

@@ -3,14 +3,12 @@
 module NyaPr
   module Repository
     class Collector
-      attr_reader :client, :username, :owners, :store, :options
+      attr_reader :client, :store, :config
 
-      def initialize(client, username, owners, store, **options)
+      def initialize(client, store, config)
         @client = client
-        @username = username
-        @owners = owners
         @store = store
-        @options = options
+        @config = config
       end
 
       def collect
@@ -37,10 +35,12 @@ module NyaPr
         )
 
         repositories = Finder.
-                       new(client, username).
-                       repositories_for(owners)
+                       new(client, config).
+                       repositories_for
 
-        repositories = filter_contributed(reject_archived(repositories))
+        repositories = filter_contributed(
+          reject_archived(repositories)
+        )
 
         store.write(repositories)
 
@@ -53,14 +53,14 @@ module NyaPr
 
       def filter_contributed(repositories)
         own, external = repositories.partition do |repository|
-          repository_owner(repository).casecmp?(username)
+          repository_owner(repository).casecmp?(config.username)
         end
 
-        own + Filter.new(client, username, progress_enabled: options[:progress]).contributed(external)
+        own + Filter.new(client, config).contributed(external)
       end
 
       def reject_archived(repositories)
-        return repositories unless options[:skip_archived]
+        return repositories unless config.skip_archived
 
         filtered = repositories.reject do |repository|
           repository['archived']
@@ -78,7 +78,7 @@ module NyaPr
       end
 
       def use_cache?
-        store.available? && !options[:refresh]
+        store.available? && !config.refresh
       end
     end
   end

data/lib/nya_pr/repository/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NyaPr
+  module Repository
+    class Config < Data.define(
+      :username,
+      :owners,
+      :refresh,
+      :skip_archived,
+      :progress_enabled,
+      :workers
+    )
+      DEFAULT_WORKERS = 10
+
+      def self.from_app(config)
+        new(
+          username: config.username,
+          owners: ([config.username] + config.owners).uniq,
+          refresh: config.refresh,
+          skip_archived: config.skip_archived,
+          progress_enabled: config.progress,
+          workers: DEFAULT_WORKERS
+        )
+      end
+    end
+  end
+end

data/lib/nya_pr/repository/filter.rb

@@ -5,15 +5,11 @@ module NyaPr
     class Filter
       include NyaPr::Request
 
-      DEFAULT_WORKERS = 10
+      attr_reader :client, :config
 
-      attr_reader :client, :username, :workers, :progress_enabled
-
-      def initialize(client, username, workers: DEFAULT_WORKERS, progress_enabled: true)
+      def initialize(client, config)
         @client = client
-        @username = username
-        @workers = workers
-        @progress_enabled = progress_enabled
+        @config = config
       end
 
       def contributed(repositories)
@@ -30,6 +26,18 @@ module NyaPr
 
       private
 
+      def username
+        config.username
+      end
+
+      def workers
+        config.workers
+      end
+
+      def progress_enabled
+        config.progress_enabled
+      end
+
       def log_start(repositories)
         NyaPr.logger.info(
           "Checking contributions in #{repositories.size} repositories " \
@@ -81,20 +89,23 @@ module NyaPr
         loop do
           index, repository = queue.pop(true)
 
-          if contributed_to?(repository)
-            result[index] = repository
-
-            NyaPr.logger.debug(
-              "Found contributions in #{repository.fetch('full_name')}"
-            )
-          end
-
+          process_repository(repository, index, result)
           progress_bar.advance
         rescue ThreadError
           break
         end
       end
 
+      def process_repository(repository, index, result)
+        return unless contributed_to?(repository)
+
+        result[index] = repository
+
+        NyaPr.logger.debug(
+          "Found contributions in #{repository.fetch('full_name')}"
+        )
+      end
+
       def contributed_to?(repository)
         commits = get(
           "/repos/#{repository.fetch('full_name')}/commits",

data/lib/nya_pr/repository/finder.rb

@@ -5,16 +5,14 @@ module NyaPr
     class Finder
       include NyaPr::Request
 
-      attr_reader :client, :username
+      attr_reader :client, :config
 
-      def initialize(client, username)
+      def initialize(client, config)
         @client = client
-        @username = username
+        @config = config
       end
 
-      def repositories_for(owners)
-        owners = Array(owners)
-
+      def repositories_for
         NyaPr.logger.info(
           "Starting repository collection for #{owners.size} owners"
         )
@@ -32,6 +30,14 @@ module NyaPr
 
       private
 
+      def owners
+        config.owners
+      end
+
+      def username
+        config.username
+      end
+
       def collect_repositories_for(owner)
         NyaPr.logger.info("Collecting repositories for #{owner}")
 

data/lib/nya_pr/runner.rb

@@ -4,10 +4,10 @@ require 'dotenv'
 
 module NyaPr
   class Runner
-    attr_reader :options
+    attr_reader :config
 
-    def initialize(options)
-      @options = options
+    def initialize(config)
+      @config = config
     end
 
     def run
@@ -15,7 +15,6 @@ module NyaPr
       configure_logger
 
       pull_requests = find_pull_requests
-
       pull_request_printer.print(pull_requests)
       save_pull_requests(pull_requests)
     end
@@ -24,13 +23,13 @@ module NyaPr
 
     def paths
       @paths ||= Paths.new(
-        repositories_path: options[:repositories_csv],
-        pull_requests_dir: options[:pull_requests_dir]
+        repositories_path: config.repositories_csv,
+        pull_requests_dir: config.pull_requests_dir
       )
     end
 
     def configure_logger
-      NyaPr.logger.level = options[:log_level]
+      NyaPr.logger.level = config.log_level
     end
 
     def target_repositories
@@ -40,15 +39,15 @@ module NyaPr
     def repository_collector
       @repository_collector ||= Repository::Collector.new(
         client,
-        username,
-        owners,
         repository_store,
-        refresh: options[:refresh],
-        skip_archived: options[:skip_archived],
-        progress: options[:progress]
+        repository_config
       )
     end
 
+    def repository_config
+      @repository_config ||= Repository::Config.from_app(config)
+    end
+
     def save_pull_requests(pull_requests)
       pull_request_store.write(pull_requests)
 
@@ -62,12 +61,15 @@ module NyaPr
         new(
           client,
           target_repositories,
-          limit: options[:limit],
-          progress_enabled: options[:progress]
+          pull_request_config
         ).
         find
     end
 
+    def pull_request_config
+      @pull_request_config ||= PullRequest::Config.from_app(config)
+    end
+
     def repository_store
       @repository_store ||= Repository::CsvStore.new(paths.repositories_csv)
     end
@@ -85,17 +87,10 @@ module NyaPr
     end
 
     def token
-      options[:token] || ENV.fetch('GITHUB_TOKEN') do
-        raise NyaPr::Error, 'GitHub token is required (--token or GITHUB_TOKEN)'
+      config.token || ENV.fetch('GITHUB_TOKEN') do
+        raise NyaPr::Error,
+              'GitHub token is required (--token or GITHUB_TOKEN)'
       end
     end
-
-    def username
-      options[:username]
-    end
-
-    def owners
-      ([username] + options[:owners]).uniq
-    end
   end
 end

data/lib/nya_pr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NyaPr
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nya_pr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Elijah S. Krukowski
@@ -109,14 +109,18 @@ files:
 - lib/nya_pr.rb
 - lib/nya_pr/cli/command.rb
 - lib/nya_pr/client.rb
+- lib/nya_pr/config.rb
 - lib/nya_pr/connection.rb
 - lib/nya_pr/error.rb
 - lib/nya_pr/paths.rb
 - lib/nya_pr/progress.rb
+- lib/nya_pr/pull_request/config.rb
 - lib/nya_pr/pull_request/csv_store.rb
+- lib/nya_pr/pull_request/filter.rb
 - lib/nya_pr/pull_request/finder.rb
 - lib/nya_pr/pull_request/printer.rb
 - lib/nya_pr/repository/collector.rb
+- lib/nya_pr/repository/config.rb
 - lib/nya_pr/repository/csv_store.rb
 - lib/nya_pr/repository/filter.rb
 - lib/nya_pr/repository/finder.rb