nutrella 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e66cfc7e3e0b2cf58e7ecb47d16d2689c417e60f4c499bf7ecf777a6e08015
-  data.tar.gz: 53d417160b545b06988e41c1d6b434d0d61822e04cb54dd7482d725e11e450a7
+  metadata.gz: d8f9d4dd38032bffc0e82c45319e2b5606d5e4b12709fad7f1caf5e904cf540b
+  data.tar.gz: 98cfb7a5e03bc56f461e5c7b62b958a9c58ba82ce82e85573726f52e276e2b7d
 SHA512:
-  metadata.gz: 44e1e12f2f85e870b7d48324450e6d42fa109d606760b31b8a5f0ff70b22b4109a4b304bd00eb765f69b0dc8f40db1ee2571e60014346ea509cf0573cfa4beea
-  data.tar.gz: 874d0d22d8fc5a51fc27712226927363a3e1c0883b029d0dd449f2b245c4a47073c64f98ad25a45a08ec150fb36bea16b473d43c08ac146d4c063adb5ac903fd
+  metadata.gz: 58be0c5fe2c1063ee726927b183e0fc1e9c0ca821988a47cc65100ec7180cb33df23b7d79457e2f1965c60de97072f0b17e3520997638167f22620e841ce5cbd
+  data.tar.gz: 70da9a7fc7034c9c62ade428e5e1b65258ca66d3a218b898de8ca074b76bdc7984b1b2adca693d255268a137748c7a78ae3bb9ed6c0bed56c5ec138fafe58c10

data/.codeclimate.yml

@@ -7,11 +7,6 @@ engines:
       - ruby
   fixme:
     enabled: true
-  rubocop:
-    enabled: true
-    checks:
-      Rubocop/Rails/Output:
-        enabled: false
   reek:
     enabled: true
 ratings:

data/.rubocop.yml

@@ -1,5 +1,4 @@
 require:
-  - rubocop-rake
   - rubocop-rspec
 
 AllCops:
@@ -9,6 +8,9 @@ AllCops:
   Exclude:
     - 'bin/**/*'
 
+Layout/LineLength:
+  Max: 120
+
 # Rubocop and I cannot agree.
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
@@ -19,18 +21,12 @@ Metrics/BlockLength:
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
-Rake/Desc:
-  Enabled: false
-
 RSpec/AnyInstance:
   Enabled: false
 
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.6.0] - 2021-07-30
+
+#### New Features
+
+- Allow opening a previously created Trello board based on a JIRA ticket
+- Added a configuration option to specify exactly how to search in the cache first
+
 ## [1.5.4] - 2021-07-29
 
 #### New Features

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](http://img.shields.io/gem/v/nutrella.svg?style=flat)](https://rubygems.org/gems/nutrella)
 [![Code Climate](https://codeclimate.com/github/amckinnell/nutrella/badges/gpa.svg)](https://codeclimate.com/github/amckinnell/nutrella)
-[![Build Status](https://travis-ci.org/amckinnell/nutrella.svg?branch=master)](https://travis-ci.org/amckinnell/nutrella)
 
 A command line tool for associating a Trello board with the current git branch.
 
@@ -45,7 +44,7 @@ Insert your `token` into your `~/.nutrella.yml` file.
 
 If your haven't already done so, insert your `key`, `secret`, and `token` into your `~/.nutrella.yml` file.
 
-The configuration file should look like the following (don't use the keys below, they won't work):
+The configuration file should look like the following (don't use the keys below as they won't work for you):
 
 ```yaml
     # Trello Developer API Keys
@@ -59,6 +58,7 @@ The configuration file should look like the following (don't use the keys below,
     enable_trello_app: false
     enable_logging: true
     cache_capacity: 5
+    cache_first: '^PM-\d+'
 ```
 
 **Step 6**: Adjust configuration file (Optional)
@@ -89,22 +89,43 @@ Adjust the `cache_capacity` configuration to increase the capacity of the cache
    cache_capacity: 15
 ```
 
+Adjust the `cache_first` configuration to allow searching the cache first before creating or opening a Trello board:
+
+```yaml
+   cache_first: '^(PM|QC)-\d+'
+```
+
+The string that you specify will be treated as a regular expression.
+
+
 
 ## Usage
 
-Create or open a Trello board based on the name of the current git branch:
+There are three ways to invoke the nutrella command:
+
+1. Create or open a Trello board based on the name of the current git branch:
 
-```sh
+    ```sh
     $ nutrella
-```
+    ```
+   
+    This is the command invocation that should meet your needs 90% of the time.
 
-Create or open a named Trello board:
 
-```sh
+1. Create or open a named Trello board using the full git branch name:
+
+    ```sh
     $ nutrella <git-branch-name>
-```
+    ```
+
+
+2. Create or open a previously created Trello board using a JIRA ticket like `PM-9423`:
+
+    ```sh
+    $ nutrella <JIRA Ticket>
+    ```
 
-Note: you can invoke `nutrella` from your project directory or from any subdirectory.
+    This behaviour relies on the `cache_first` configuration setting. Invoking `nutrella` with a JIRA ticket number is for those situations where you make multiple git branches for the same JIRA ticket with a different suffix.
 
 
 ## Troubleshooting

data/exe/nutrella

@@ -2,6 +2,6 @@
 
 require "nutrella"
 
-board_name = Nutrella::TaskBoardName.board_name(ARGV)
+board_name = Nutrella::TaskBoardName.board_name_from_git_branch(ARGV)
 
 Nutrella::Command.new(Dir.home, board_name).run

data/lib/nutrella.rb

@@ -1,5 +1,4 @@
-require "nutrella/string_ext"
-
+require "nutrella/board_name_resolver"
 require "nutrella/cache"
 require "nutrella/command"
 require "nutrella/configuration"

data/lib/nutrella/board_name_resolver.rb

@@ -0,0 +1,29 @@
+module Nutrella
+  #
+  # Knows how to take the supplied board name and resolve it to a Trello board url.
+  #
+  class BoardNameResolver
+    def initialize(url_cache, search_specification)
+      @url_cache = url_cache
+      @search_specification = search_specification
+    end
+
+    def resolve(board_name, &block)
+      matching_url(board_name) || cached_url(board_name, &block)
+    end
+
+    private
+
+    def matching_url(board_name)
+      return nil unless @search_specification.match?(board_name)
+
+      search_reg_exp = Regexp.new(board_name, Regexp::IGNORECASE)
+
+      @url_cache.search(search_reg_exp)
+    end
+
+    def cached_url(board_name, &block)
+      @url_cache.fetch(board_name, &block)
+    end
+  end
+end

data/lib/nutrella/cache.rb

@@ -20,6 +20,12 @@ module Nutrella
       value
     end
 
+    def search(search_reg_exp)
+      cache_contents.find { |k, _v| search_reg_exp.match?(k) }.last
+    rescue
+      nil
+    end
+
     private
 
     def lookup(key)
@@ -41,7 +47,11 @@ module Nutrella
     end
 
     def cache_contents
-      @_cache_contents ||= YAML.load_file(path)
+      @_cache_contents ||= begin
+        YAML.load_file(path)
+      rescue
+        nil
+      end
     end
   end
 end

data/lib/nutrella/command.rb

@@ -42,7 +42,7 @@ module Nutrella
     end
 
     def cached_url
-      @_cached_url ||= url_cache.fetch(@board_name) { task_board.lookup_or_create(@board_name).url }
+      @_cached_url ||= board_name_resolver.resolve(@board_name) { task_board.lookup_or_create(@board_name).url }
     end
 
     def configuration_values
@@ -65,6 +65,10 @@ module Nutrella
       http_url.gsub(/^http.?:/, "trello:")
     end
 
+    def board_name_resolver
+      Nutrella::BoardNameResolver.new(url_cache, configuration_values.fetch(:cache_first, ""))
+    end
+
     def task_board
       Nutrella::TaskBoard.new(configuration_values)
     end

data/lib/nutrella/configuration.rb

@@ -21,6 +21,7 @@ module Nutrella
       enable_trello_app: false
       enable_logging: false
       cache_capacity: 5
+      cache_first: '^PM-\d+'
     YAML
 
     attr_reader :path, :values
@@ -46,7 +47,8 @@ module Nutrella
         launch_command: configuration.fetch("launch_command", "open $url$"),
         enable_trello_app: configuration.fetch("enable_trello_app", "false"),
         enable_logging: configuration.fetch("enable_logging", "false"),
-        cache_capacity: configuration.fetch("cache_capacity", 5)
+        cache_capacity: configuration.fetch("cache_capacity", 5),
+        cache_first: to_reg_exp("cache_first")
       }
     rescue => e
       abort "#{path} #{e}"
@@ -77,5 +79,9 @@ module Nutrella
         See https://github.com/amckinnell/nutrella for instructions.
       TEXT
     end
+
+    def to_reg_exp(key)
+      Regexp.new(configuration.fetch(key, '^PM-\d+'), Regexp::IGNORECASE)
+    end
   end
 end

data/lib/nutrella/task_board_name.rb

@@ -9,7 +9,7 @@ module Nutrella
   # Note: will also accept the name of a branch as an argument.
   #
   class TaskBoardName
-    def self.board_name(args)
+    def self.board_name_from_git_branch(args)
       git_branch_name = args[0]
       return git_branch_name if git_branch_name.present?
 

data/lib/nutrella/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nutrella
-  VERSION = "1.5.4"
+  VERSION = "1.6.0"
 end

data/nutrella.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rubocop", "~> 1.18"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6"
   spec.add_development_dependency "rubocop-rspec", "~> 2.4"
   spec.add_development_dependency "simplecov", "~> 0.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutrella
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +109,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -138,11 +123,11 @@ files:
 - bin/setup
 - exe/nutrella
 - lib/nutrella.rb
+- lib/nutrella/board_name_resolver.rb
 - lib/nutrella/cache.rb
 - lib/nutrella/command.rb
 - lib/nutrella/configuration.rb
 - lib/nutrella/developer_keys.rb
-- lib/nutrella/string_ext.rb
 - lib/nutrella/task_board.rb
 - lib/nutrella/task_board_name.rb
 - lib/nutrella/version.rb

data/.travis.yml

@@ -1 +0,0 @@
-language: ruby

data/lib/nutrella/string_ext.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# Simpler versions of an extension from ActiveSupport.
-#
-class String
-  def titleize
-    tr("_-", " ").split.map(&:capitalize).join(" ")
-  end
-end