lita-jira-issues 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35aac2c646137a72b605110012083c2d97750f3f
-  data.tar.gz: fe01278b2923c44cd638ae6d3ded73fc3a1a087b
+  metadata.gz: 396330464997beb026d473b31a774c71595bc662
+  data.tar.gz: 7b0bee27654d8115df7d3a618957f62d5f796376
 SHA512:
-  metadata.gz: 1f0496574cadd911e313cd13eb77a053ebfdb0092faa3644b933654353eacf2861c6e71231c386cbfd2042157456474ca961b51f59adc39669081f4fc9becc9b
-  data.tar.gz: 7c057167cd2cbaaec896e6f9990187685405af33cbf867bd88aa986e50ef9feea9e4f2b5918aa17706b59083426c88d4d6e8c86fc699cec74f117d061b2743d5
+  metadata.gz: b3a51c8f7c7c43700a07b0d9dbedc2fadd3ead1b2eac519144760e3ffe8f251a71e7aa750f3d5baca350da99d74093012ccaf89808c5f3243527deba8554fdc2
+  data.tar.gz: 75e9b4693393632ba3589ec6b05fb933163056974ea100416fa156be319512427c22bea8d11955db4f298150bbf8214779f6fdac686944f595785a003682c54d

data/CHANGELOG.md

@@ -4,6 +4,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [0.3.0] - 2015-06-21
+### Added
+- Fully customized response of the JIRA issue via templates. See the extensive
+  [documentation](https://github.com/amaltson/lita-jira-issues#customize-output)
+  on how to customize the formatting. Huge thanks to @hickey for the
+  contribution.
+
 ## [0.2.3] - 2015-04-29
 ### Added
 - Optional TTL feature for silencing the same JIRA for a period of time. Thanks
@@ -29,7 +36,8 @@ to @johntdyer for the contribution.
   https://github.com/github/hubot-scripts/blob/master/src/scripts/jira-issues.coffee)
 
 
-[unreleased]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.3...HEAD
+[unreleased]: https://github.com/amaltson/lita-jira-issues/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.3...v0.3.0
 [0.2.3]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.0...v0.2.1

data/README.md

@@ -23,6 +23,8 @@ gem "lita-jira-issues"
 
 ## Configuration
 
+### Base Configuration
+
 The `jira_issues` handler needs to be configured with your JIRA instance. Add
 the following configurations to your `lita_config.rb`.
 
@@ -31,11 +33,14 @@ config.handlers.jira_issues.url = 'http://jira.local'
 config.handlers.jira_issues.username = ENV['JIRA_USER'] || 'user'
 config.handlers.jira_issues.password = ENV['JIRA_PASSWORD'] || 'password'
 config.handlers.jira_issues.issue_ttl = 0 #optional
+config.handlers.jira_issues.format = '[%I] %S::%t'  #optional
 ```
 
 As in the example above, you can always use environment variables for sensitive
 information like the JIRA user's password.
 
+### Ignoring Users
+
 Optionally you can prevent JIRA issue lookups from certain users using the ignore
 configuration parameter
 
@@ -43,6 +48,8 @@ configuration parameter
 config.handlers.jira_issues.ignore = [ 'Jira', 'Github' ]
 ```
 
+### Avoid A Spamming Bot
+
 Optionally you can set a timer for how long to sleep prior to posting an issue to chat again.  This is accomplished by setting an expiring key in Redis. That timeout is governed by the following config
 
 ```ruby
@@ -51,6 +58,46 @@ config.handlers.jira_issues.issue_ttl = 120
 
 The default for this config is 0 which serves to disables the feature entirely.
 
+### Customize Output
+
+You can now change the displayed format using keyword expansion. The following table of keywords can be used to create the response when a JIRA issue is referenced. Each keyword needs to be enclosed in %{} just as the Ruby `%` operator requires.
+
+Each keyword can take one of 3 forms. If the keyword is specified in all CAPS, then the resulting text will be in all caps (i.e. 'KEY' => 'ABC-123'). If the keyword has an initial capital letter, then resulting text will be proper case (i.e. 'Key' => 'Abc-123'). Finally if the keyword is all lower case, then the resulting text will be the native format that the text was received in.
+
+There is also a conditional syntax that can be use should the keyword not return a value. The conditional syntax roughly approximates a ternary operator found in several programming languages such as C, Java and Perl with slight modification to make pattern matching easier.
+
+```
+#(%{assignee}?Assigned to %{assignee}|UNASSIGNED)
+```
+
+In the above example, the start of the conditional syntax starts with the `#(` and is completed with the closing `)`. The first part (what is preceding the question mark) is what is evaluated. If the evaluation is not an empty string (i.e. ''), then the conditional syntax is replaced with the text between the question and the pipe (`|`) symbol. If the evaluation does return an empty string (i.e. assignee is not set), then the text following the pipe symbol will replace the conditional syntax. As one would expect, keyword substitutions occur within the conditional syntax.
+
+By default the format is set to the original text displayed by the lita-jira-issues module.
+
+```
+[%{KEY}] %{summary}
+Status: %{status}, #(%{assignee}?assigned to %{assignee}|unassigned), rep. by %{reporter}, fixVersion: #(%{version}?%{version}|NONE)#(%{priority}?, priority: %{priority}|)
+%{link}
+```
+
+The response to referenced JIRA tickets are left up to you, but shortened formats are now available like:
+
+```
+[%{KEY}] %{PRIORITY}/%{Summary} - %{STATUS}\n%{link}
+```
+
+Pattern  | Substitution
+---------|-------------
+key      | Issue number
+status   | Issue status
+summary  | Issue summary
+assignee | Assignee
+reporter | Reporter
+version  | Version
+priority | Priority
+link     | URL to JIRA issue page
+url      | Same as %{link}
+
 ## Usage
 
 Simply mention any JIRA valid key in upper or lower case, eg. JIRA-123, proj-8,

data/lib/lita/handlers/jira_issues.rb

@@ -5,11 +5,19 @@ module Lita
   module Handlers
     class JiraIssues < Handler
 
+      FORMAT = <<-FORMATTER
+[%{KEY}] %{summary}
+Status: %{status}, #(%{assignee}?assigned to %{assignee}|unassigned), rep. by %{reporter}, fixVersion: #(%{version}?%{version}|NONE)#(%{priority}?, priority: %{priority}|)
+%{link}
+FORMATTER
+
       config :url, required: true, type: String
       config :username, required: true, type: String
       config :password, required: true, type: String
       config :ignore, default: [], type: Array
       config :issue_ttl, default: 0, type: Integer
+      config :format, default: FORMAT.chomp, type: String
+      
 
       route /[a-zA-Z]+-\d+/, :jira_message, help: {
         "KEY-123" => "Replies with information about the given JIRA key"
@@ -34,53 +42,71 @@ module Lita
       def issue_details(data)
         key = data[:key]
         data = data[:fields]
-        issue = summary(key, data)
-        issue << status(data)
-        issue << assignee(data)
-        issue << reporter(data)
-        issue << fix_version(data)
-        issue << priority(data)
-        issue << issue_link(key)
-      end
-
-      def summary(key, data)
-        "[#{key}] #{data[:summary]}"
+        
+        # build out the response from the configured format
+        text = config.format % {
+          KEY: key.upcase, Key: key.capitalize, key: key,
+          SUMMARY: summary(data).upcase, Summary: summary(data).capitalize, summary: summary(data),
+          ASSIGNEE: assignee(data).upcase, Assignee: assignee(data).capitalize, assignee: assignee(data),
+          REPORTER: reporter(data).upcase, Reporter: reporter(data).capitalize, reporter: reporter(data),
+          STATUS: status(data).upcase, Status: status(data).capitalize, status: status(data),
+          PRIORITY: priority(data).upcase, Priority: priority(data).capitalize, priority: priority(data),
+          VERSION: fix_version(data).upcase, Version: fix_version(data).capitalize, version: fix_version(data),
+          LINK: issue_link(key), link: issue_link(key),
+          URL: issue_link(key), url: issue_link(key)
+        }
+        
+        # evaluate conditional syntax
+        text.gsub!(/#\(.*?\?.*?\|.*?\)/) do |cond_stmt|
+          vals = cond_stmt.match(/#\((?<value>.*?)\?(?<true_text>.*?)\|(?<false_text>.*?)\)/)
+          if vals[:value].empty?
+            vals[:false_text].gsub("\|", "|").gsub("\?", "?")
+          else
+            vals[:true_text].gsub("\|", "|").gsub("\?", "?")
+          end
+        end
+        
+        return text
       end
 
       def status(data)
-        "\nStatus: #{data[:status][:name]}"
+        data[:status][:name]
       end
 
+      def summary(data)
+        data[:summary]
+      end
+      
       def assignee(data)
         if assigned_to = data[:assignee]
-          return ", assigned to #{assigned_to[:displayName]}"
+          return assigned_to[:displayName]
         end
-        ', unassigned'
+        ''
       end
 
       def reporter(data)
-        ", rep. by #{data[:reporter][:displayName]}"
+        data[:reporter][:displayName]
       end
 
       def fix_version(data)
         fix_versions = data[:fixVersions]
         if fix_versions and fix_versions.first
-          ", fixVersion: #{fix_versions.first[:name]}"
+          fix_versions.first[:name]
         else
-          ', fixVersion: NONE'
+          ''
         end
       end
 
       def priority(data)
         if data[:priority]
-          ", priority: #{data[:priority][:name]}"
+          data[:priority][:name]
         else
-          ""
+          ''
         end
       end
 
       def issue_link(key)
-        "\n#{config.url}/browse/#{key}"
+        "#{config.url}/browse/#{key}"
       end
 
       def silenced?(key)

data/lita-jira-issues.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-jira-issues"
-  spec.version       = "0.2.3"
+  spec.version       = "0.3.0"
   spec.authors       = ["Arthur Maltson"]
   spec.email         = ["arthur@maltson.com"]
   spec.description   = "Lita handler to show JIRA issue details"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-jira-issues
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Arthur Maltson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Lita handler that looks for JIRA issue keys and helpfully inserts details