codebot 1.2.0

data/lib/codebot/formatters/gitlab_push_hook.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: false
+
+module Codebot
+  module Formatters
+    module Gitlab
+      # This class formats Push events from Gitlab
+      class PushHook < Formatter
+        def before_commit
+          extract(:before)
+        end
+
+        def after_commit
+          extract(:after)
+        end
+
+        def repository_name
+          extract(:repository, :name)
+        end
+
+        def repository_url
+          extract(:repository, :homepage)
+        end
+
+        def compare_url
+          commits = "#{before_commit}...#{before_commit}"
+          shorten_url "#{repository_url}/compare/#{commits}"
+        end
+
+        def commit_default_format
+          '%<repository>s/%<branch>s %<hash>s %<author>s: %<title>s'
+        end
+
+        def commit_author(commit)
+          return nil unless commit['author'].is_a? Hash
+
+          commit['author']['name']
+        end
+
+        def commit_summary(commit)
+          commit_default_format % {
+            repository: format_repository(repository_name),
+            branch: format_branch(branch),
+            hash: format_hash(commit['id']),
+            author: format_user(commit_author(commit)),
+            title: prettify(commit['message'])
+          }
+        end
+
+        def branch
+          extract(:ref).split('/')[2..-1].join('/')
+        end
+
+        def num_commits
+          format_number(extract(:total_commits_count).to_i,
+                        'new commit', 'new commits')
+        end
+
+        def summary_format
+          '[%<repository>s] %<user>s pushed %<num_commits>s ' \
+            'to %<branch>s: %<url>s'
+        end
+
+        def default_summary
+          user_name = extract(:user_name)
+
+          summary_format % {
+            repository: format_repository(repository_name),
+            user: format_user(user_name),
+            num_commits: num_commits,
+            branch: format_branch(branch),
+            url: compare_url
+          }
+        end
+
+        def format
+          [default_summary] + extract(:commits).map do |commit|
+            commit_summary(commit)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codebot/formatters/gitlab_wiki_page_hook.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Codebot
+  module Formatters
+    module Gitlab
+      # Triggers on a Wiki Page Hook event
+      class WikiPageHook < Formatter
+        def format
+          ["#{summary}: #{format_url url}"]
+        end
+
+        def summary
+          default_format % {
+            repository: format_repository(repository_name),
+            sender: format_user(sender_name),
+            action: action,
+            title: wiki_title
+          }
+        end
+
+        def default_format
+          '[%<repository>s] %<sender>s %<action>s page \'%<title>s\''
+        end
+
+        def repository_name
+          extract(:project, :path_with_namespace)
+        end
+
+        def sender_name
+          extract(:user, :name)
+        end
+
+        def summary_url
+          extract(:object_attributes, :url)
+        end
+
+        def action
+          case wiki_action
+          when 'create' then 'created'
+          when 'delete' then 'deleted'
+          when 'update', nil then 'updated'
+          else wiki_action
+          end
+        end
+
+        def wiki_action
+          extract(:object_attributes, :action)
+        end
+
+        def wiki_title
+          extract(:object_attributes, :title)
+        end
+      end
+    end
+  end
+end

data/lib/codebot/formatters/gollum.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Portions (c) 2008 Logical Awesome, LLC (released under the MIT license).
+# See the LICENSE file for the full MIT license text.
+
+module Codebot
+  module Formatters
+    # This class formats gollum events.
+    class Gollum < Formatter
+      # Formats IRC messages for a gollum event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"]
+      end
+
+      def summary
+        default_format % {
+          repository: format_repository(repository_name),
+          sender: format_user(sender_name),
+          summary: (pages.one? ? single_page_summary : multi_page_summary)
+        }
+      end
+
+      def default_format
+        '[%<repository>s] %<sender>s %<summary>s'
+      end
+
+      def single_page_summary
+        page = pages.first.to_h
+        short = prettify page['summary']
+        suffix = ": #{short}" unless short.empty?
+        "#{page['action']} wiki page #{page['title']}#{suffix}"
+      end
+
+      def multi_page_summary
+        actions = []
+        counts = action_counts
+        counts.each { |verb, num| actions << "#{verb} #{format_number num}" }
+        changes = ary_to_sentence(
+          actions,
+          'pushed an empty commit that did not affect any'
+        )
+        singular_noun = counts.last.to_a.last.to_i.eql?(1)
+        "#{changes} wiki #{singular_noun ? 'page' : 'pages'}"
+      end
+
+      def action_counts
+        Hash.new(0).tap do |hash|
+          pages.each { |page| hash[page['action']] += 1 }
+        end.sort
+      end
+
+      def summary_url
+        if pages.one?
+          pages.first['html_url'].to_s
+        else
+          "#{repository_url}/wiki"
+        end
+      end
+
+      def pages
+        extract(:pages).to_a
+      end
+    end
+  end
+end

data/lib/codebot/formatters/issue_comment.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Codebot
+  module Formatters
+    # This class formats issue_comment events.
+    class IssueComment < Formatter
+      # Formats IRC messages for an issue_comment event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"]
+      end
+
+      def summary
+        default_format % {
+          repository: format_repository(repository_name),
+          sender: format_user(sender_name),
+          number: issue_number,
+          summary: prettify(comment_body)
+        }
+      end
+
+      def default_format
+        '[%<repository>s] %<sender>s commented on issue' \
+          ' #%<number>s: %<summary>s'
+      end
+
+      def summary_url
+        extract(:comment, :html_url).to_s
+      end
+
+      def comment_body
+        extract(:comment, :body).to_s
+      end
+
+      def issue_number
+        extract(:issue, :number)
+      end
+    end
+  end
+end

data/lib/codebot/formatters/issues.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Codebot
+  module Formatters
+    # This class formats issues events.
+    class Issues < Formatter
+      # Formats IRC messages for an issue event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"] if opened? || closed?
+      end
+
+      def summary
+        default_format % {
+          repository: format_repository(repository_name),
+          sender: format_user(sender_name),
+          action: action,
+          number: issue_number,
+          title: issue_title
+        }
+      end
+
+      def default_format
+        '[%<repository>s] %<sender>s %<action>s issue #%<number>s: %<title>s'
+      end
+
+      def summary_url
+        extract(:issue, :html_url).to_s
+      end
+
+      def issue_number
+        extract(:issue, :number)
+      end
+
+      def issue_title
+        extract(:issue, :title)
+      end
+    end
+  end
+end

data/lib/codebot/formatters/ping.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Codebot
+  module Formatters
+    # This class formats ping events.
+    class Ping < Formatter
+      # Formats IRC messages for a ping event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"]
+      end
+
+      def summary
+        default_format % {
+          scope: format_scope,
+          sender: format_user(sender_name),
+          events: format_events
+        }
+      end
+
+      def default_format
+        '[%<scope>s] %<sender>s added a webhook for %<events>s'
+      end
+
+      def summary_url
+        case extract(:hook, :type)
+        when /\Aorganization\z/i
+          login = extract(:organization, :login).to_s
+          "https://github.com/#{login}"
+        when /\Arepository\z/i
+          extract(:repository, :html_url).to_s
+        end
+      end
+
+      def format_events
+        if hook_events.empty?
+          'no events'
+        elsif hook_events.include? '*'
+          format_event 'all events'
+        else
+          format_events_some
+        end
+      end
+
+      def format_events_some
+        if hook_events.length > 5
+          "#{format_number(hook_events.length)} events"
+        elsif hook_events.one?
+          "the #{format_event hook_events.first} event"
+        else
+          "the #{formatted_hook_events} events"
+        end
+      end
+
+      def hook_events
+        extract(:hook, :events).to_a.uniq
+      end
+
+      def formatted_hook_events
+        ary_to_sentence(hook_events.sort.map { |event| format_event event })
+      end
+
+      # Formats the name of the repository or organization the webhook belongs
+      # to.
+      #
+      # @return [String] the formatted scope
+      def format_scope
+        case extract(:hook, :type)
+        when /\Aorganization\z/i
+          format_user extract(:organization, :login)
+        when /\Arepository\z/i
+          login = extract(:repository, :owner, :login)
+          "#{format_user login}/#{format_repository repository_name}"
+        end
+      end
+    end
+  end
+end

data/lib/codebot/formatters/public.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Codebot
+  module Formatters
+    # This class formats public events.
+    class Public < Formatter
+      # Formats IRC messages for a public event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"]
+      end
+
+      def summary
+        default_format % {
+          repository: format_repository(repository_name),
+          sender: format_user(sender_name)
+        }
+      end
+
+      def default_format
+        '[%<repository>s] %<sender>s open-sourced the repository'
+      end
+
+      def summary_url
+        repository_url
+      end
+    end
+  end
+end

data/lib/codebot/formatters/pull_request.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Portions (c) 2008 Logical Awesome, LLC (released under the MIT license).
+# See the LICENSE file for the full MIT license text.
+
+module Codebot
+  module Formatters
+    # This class formats pull_request events.
+    class PullRequest < Formatter
+      # Formats IRC messages for a pull_request event.
+      #
+      # @return [Array<String>] the formatted messages
+      def format
+        ["#{summary}: #{format_url url}"] if opened? || closed?
+      end
+
+      def summary
+        default_format % {
+          repository: format_repository(repository_name),
+          sender: format_user(sender_name),
+          action: action,
+          number: pull_number,
+          title: pull_title,
+          base_ref: pull_base_ref,
+          head_title: pull_head_title
+        }
+      end
+
+      def default_format
+        '[%<repository>s] %<sender>s %<action>s pull request #%<number>s: ' \
+        '%<title>s (%<base_ref>s...%<head_title>s)'
+      end
+
+      def pull_number
+        extract(:pull_request, :number)
+      end
+
+      def pull_title
+        extract(:pull_request, :title)
+      end
+
+      def pull_base_label
+        extract(:pull_request, :base, :label)
+      end
+
+      def pull_base_ref
+        pull_base_label.to_s.split(':').last
+      end
+
+      def pull_head_label
+        extract(:pull_request, :head, :label)
+      end
+
+      def pull_head_ref
+        pull_head_label.to_s.split(':').last
+      end
+
+      def pull_head_title
+        if pull_head_ref == pull_base_ref
+          pull_head_ref
+        else
+          pull_head_label
+        end
+      end
+
+      def summary_url
+        extract(:pull_request, :html_url).to_s
+      end
+    end
+  end
+end