deploy_log 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67646e644643f0513c6ebc267c9756962286826edc0bd112600d360634ccc895
-  data.tar.gz: '083ff6d06a088404a2422e3a02afdf5d9f09b9a7630e7e5fd195415c7d2f13d4'
+  metadata.gz: 2a41d5f5eec9fe419b26fb29d1b274bd8b4fb18e896258a2b61b193d8e7f9cb0
+  data.tar.gz: 063f3f25f4b06e99dc1c2158ee34b6e839a7d79884f9ef7ea7e7713b9638c277
 SHA512:
-  metadata.gz: 80025004e29c251b4c20463b52cfb507f4cbc950b65beb902077d30451fe5a7ae3aa3ee84b1df0593a1a5d40f223c6e9b5f8c940bc4bbed9caa3f8d2524db7de
-  data.tar.gz: b213197ba88431f9891b78e00c84ef6dd7ba52b7bb6ddfd534dfe4abcbd9e8b03060bde5e9e63b25cfe211d6f9f708e78d707dcf5cc97a761fb730106e8da2f5
+  metadata.gz: 70506d200f36f6c8d1edfdc5cde156a74d957103f38db0c17fb24fe909658cdbba42a6246f51fcc2efd412afc7df386bdf59224c0065f5be6332faaf13183827
+  data.tar.gz: 54959d81e9786443f1d8ce20089f2fc8d66f8fac709e362244c1365ca5e67ce0c170c2fa50e72278e26be48bdd474029ed4470b0d37b08d719ddfed61fd61da4

data/bin/deploy_log

@@ -26,6 +26,10 @@ OptionParser.new do |opt|
     branch = br
   end
 
+  opt.on('-u', '--user=USER', 'Name of the Github user you want to search by') do |br|
+    branch = br
+  end
+
   opt.on('-w', '--week=WEEK', 'Get PRs merged during week number X') do |w|
     week = w
   end

data/lib/deploy_log.rb

@@ -7,7 +7,9 @@ require 'time'
 require 'date'
 require 'deploy_log/version'
 require 'deploy_log/calendar'
+require 'deploy_log/cache'
 require 'deploy_log/github/helper'
+require 'deploy_log/github/api'
 require 'deploy_log/github/deploys'
 
 module DeployLog

data/lib/deploy_log/cache.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module DeployLog
+  class Cache
+    attr_reader :filename
+
+    class FileNotFound < StandardError; end
+
+    def initialize(fmt, options = {})
+      fmt ||= 'deploy_%s.log'
+      dir = options[:dir] || '/tmp'
+
+      @repo = options[:repo]
+      @file_name_template = "#{dir}/#{fmt}"
+    end
+
+    def create(*args)
+      hash = Digest::MD5.hexdigest(@repo + args.join('|'))
+      path = FileUtils.touch format(@file_name_template, hash)
+
+      @filename = path.first
+    end
+
+    def exists?
+      File.exist?(@filename) && !File.size(@filename).zero?
+    end
+
+    def contents
+      raise FileNotFound unless exists?
+
+      File.read(@filename)
+    end
+
+    def write_object(pool, message)
+      File.open(@filename, 'w+') do |file|
+        pool.each do |pr|
+          line = yield(pr)
+
+          file.write(line)
+        end
+
+        file.write "============================================================\n"
+        file.write "#{message}\n"
+        file.write "============================================================\n"
+      end
+    end
+  end
+end

data/lib/deploy_log/github/api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'octokit'
+
+module DeployLog
+  module Github
+    attr_reader :repo
+
+    class Api
+      def initialize(repo)
+        @client = Octokit::Client.new(login: ENV['GITHUB_USER'], password: ENV['GITHUB_TOKEN'])
+        @client.auto_paginate = true
+
+        @repo = repo
+      end
+
+      def pull_requests(options = {})
+        default_opts = {
+          state: :closed,
+          per_page: 500,
+          sort: 'long-running'
+        }
+
+        begin
+          @client.pull_requests(@repo, default_opts.merge(options))
+        rescue Octokit::NotFound => e
+          Notify.error e.message
+        end
+      end
+
+      def pull_request(id)
+        begin
+          @client.pull_request(@repo, id)
+        rescue Octokit::NotFound => e
+          Notify.error e.message
+        end
+      end
+
+      def commits_for(id)
+        begin
+          @client.pull_request_commits(@repo, id)
+        rescue Octokit::NotFound => e
+          Notify.error e.message
+        end
+      end
+    end
+  end
+end

data/lib/deploy_log/github/helper.rb

@@ -1,132 +1,89 @@
 # frozen_string_literal: true
 
-require 'octokit'
 require 'fileutils'
 
 module DeployLog
   module Github
-    class FileNotFound < StandardError; end
-
     class Helper
       LINE_FORMAT = "%s (%s)\n - Created by %s\n - Branch: %s\n - Merged by %s on %s\n - Changes: %s\n -- %s\n\n"
 
       def initialize(user_repo)
-        @client = ::Octokit::Client.new(login: ENV['GITHUB_USER'], password: ENV['GITHUB_TOKEN'])
-        @repo_location = user_repo
+        @api = Api.new(user_repo)
+        @cache = DeployLog::Cache.new('github-deploys-%s.log', repo: user_repo)
       end
 
-      def pulls_in_timeframe(date_start = nil, date_end = nil)
-        cache_path = cache(date_start, date_end)
-        return cat(cache_path) if should_show_cache(cache_path)
-
-        @client.auto_paginate = true
-        list = @client.pull_requests(@repo_location,
-          state: :closed,
-          per_page: 500,
-          sort: 'long-running'
-        )
-
-        prs_covered = 0
-
-        File.open(cache_path, 'w+') do |f|
-          list.each do |pr|
-            next unless (date_start..date_end).cover? pr.merged_at
-
-            prs_covered += 1
-
-            f.write(
-              sprintf(
-                LINE_FORMAT,
-                pr.title,
-                pr.html_url,
-                pr.user.login,
-                pr.head.ref,
-                user_who_merged(pr.number),
-                formatted_time(pr.merged_at, true),
-                pr.diff_url,
-                committers_for(pr.number).join("\n -- ")
-              )
-            )
-          end
-
-          f.write("============================================================\n#{prs_covered} PR(s) merged from #{date_start} to #{date_end}\n============================================================\n")
+      def pulls_in_timeframe(date_start, date_end)
+        @cache.create(date_start, date_end)
+        return @cache.contents if @cache.exists?
+
+        pool = timeframe_pool(date_start, date_end)
+        message = "#{pool.size} PR(s) merged from #{date_start} to #{date_end}"
+
+        @cache.write_object(pool, message) do |item|
+          format(LINE_FORMAT,
+            item.title,
+            item.html_url,
+            item.user.login,
+            item.head.ref,
+            user_who_merged(item.number),
+            formatted_time(item.merged_at, true),
+            item.diff_url,
+            committers_for(item.number).join("\n -- ")
+          )
         end
 
-        return ::Notify.warning("No pull requests have been merged in the requested date range (#{date_start} - #{date_end})") if prs_covered.zero?
-
-        cat(cache_path)
+        @cache.contents
       end
 
       def search_pulls_by(value, field = :title)
-        cache_path = cache(value, field)
-        return cat(cache_path) if should_show_cache(cache_path)
-
-        list = @client.pull_requests(@repo_location,
-          :state => :all,
-          :per_page => 100
+        @cache.create(field, value)
+        return @cache.contents if @cache.exists?
+
+        pool = search_pool(field, value)
+        message = "#{pool.size} PR(s) matched"
+
+        @cache.write_object(pool, message) do |item|
+          format(LINE_FORMAT,
+            item.title,
+            item.html_url,
+            item.user.login,
+            item.head.ref,
+            user_who_merged(item.number),
+            formatted_time(item.merged_at, true),
+            item.diff_url,
+            committers_for(item.number).join("\n -- ")
           )
-        prs_covered = 0
-
-        File.open(cache_path, 'w+') do |f|
-          list.each do |pr|
-            next unless nested_hash_value(pr, field).match?(/#{value}\b/)
-
-            prs_covered += 1
-
-            f.write(
-              sprintf(
-                LINE_FORMAT,
-                pr.title,
-                pr.html_url,
-                pr.user.login,
-                pr.head.ref,
-                user_who_merged(pr.number),
-                formatted_time(pr.merged_at, true),
-                pr.diff_url,
-                committers_for(pr.number).join("\n -- ")
-              )
-            )
-          end
-
-          f.write("============================================================\n#{prs_covered} PR(s) matched\n============================================================\n")
         end
 
-        return ::Notify.warning("No pull requests match the requested term (#{value})") if prs_covered.zero?
-
-        cat(cache_path)
+        @cache.contents
       end
 
       private
 
+      def timeframe_pool(date_start, date_end)
+        pool = @api.pull_requests
+        pool.select! { |pr| (date_start..date_end).cover?(pr.merged_at) }
+        pool
+      end
+
+      def search_pool(field, value)
+        pool = @api.pull_requests(state: :all, per_page: 100)
+        pool.select! { |pr| nested_hash_value(pr, field).match?(/#{value}\b/) }
+        pool
+      end
+
       def user_who_merged(num)
-        pr = @client.pull_request(@repo_location, num)
+        pr = @api.pull_request(num)
         pr.merged_by.login
       end
 
       def committers_for(num)
-        commits = @client.pull_request_commits(@repo_location, num)
+        commits = @api.commits_for(num)
         commits.map do |c|
           "#{c.author.login} committed '#{c.commit.message}' at #{formatted_time(c.commit.committer.date, true)}"
         end
       end
 
-      def cache(*args)
-        hash = Digest::MD5.hexdigest(@repo_location + args.join('|'))
-        path = FileUtils.touch "/tmp/github-deploys-#{hash}.log"
-
-        path.first
-      end
-
-      def should_show_cache(cache_file_path)
-        File.exist?(cache_file_path) && !File.size(cache_file_path).zero?
-      end
-
-      def cat(path)
-        raise FileNotFound unless should_show_cache(path)
-
-        File.read(path)
-      end
-
       def formatted_time(time, use_local_time = false)
         time = Time.now if time.nil?
         time = time.localtime if use_local_time

data/lib/deploy_log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeployLog
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_log
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Priebe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,7 +161,9 @@ files:
 - docs/js/searcher.js.gz
 - docs/table_of_contents.html
 - lib/deploy_log.rb
+- lib/deploy_log/cache.rb
 - lib/deploy_log/calendar.rb
+- lib/deploy_log/github/api.rb
 - lib/deploy_log/github/deploys.rb
 - lib/deploy_log/github/helper.rb
 - lib/deploy_log/version.rb