nutrella 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7add4b79f183553908597ee654ab4b6eab29cbda1b429c6ced3d94da2d533ccc
-  data.tar.gz: b2dbc3a33c1a4c4c65cd377ab9d450a0553b8636d03521d5ef0e8767ec82280c
+  metadata.gz: d8f9d4dd38032bffc0e82c45319e2b5606d5e4b12709fad7f1caf5e904cf540b
+  data.tar.gz: 98cfb7a5e03bc56f461e5c7b62b958a9c58ba82ce82e85573726f52e276e2b7d
 SHA512:
-  metadata.gz: 978a5254670d43a7af9abef50a1878842c84c6dbb022998812d5d4450c6752216c28fa37880ac0a6799dc79b571222d6536cb218da78e8e5aeee4558f5f992aa
-  data.tar.gz: 5b2fc237ef01364c6598715f5889ca4e5dde29978843f8f2f132bbc3c4d2e2cadbf8522aa33bec4c43cc55107b8131a9a38b6fae2e1325c7b88d0850bedc1817
+  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/.gitignore

@@ -5,3 +5,4 @@
 /pkg
 /tmp
 /.bundle
+/*.log

data/.rubocop.yml

@@ -2,24 +2,19 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.6
 
   Exclude:
     - 'bin/**/*'
 
+Layout/LineLength:
+  Max: 120
+
 # Rubocop and I cannot agree.
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
 Metrics/BlockLength:
   Enabled: false
 
@@ -32,9 +27,6 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 
@@ -62,22 +54,10 @@ Style/BlockDelimiters:
   BracesRequiredMethods:
     - 'let'
 
-Style/ExponentialNotation:
-  Enabled: true
-
 # We can ignore this small performance improvement.
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
 # We like to use the hash rocket in rake files.
 Style/HashSyntax:
   Exclude:

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.4

data/CHANGELOG.md

@@ -6,6 +6,34 @@ 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
+
+- Added a configuration option to adjust the cache capacity
+
+## [1.5.3] - 2021-02-18
+
+- Update ruby-trello
+- Update development dependencies
+
+#### Breaking Changes
+
+- Drop support for Ruby 2.5
+
+## [1.5.2] - 2020-04-27
+
+#### New Features
+
+- Added a configuration option to enable logging for easier troubleshooting
+
 ## [1.5.1] - 2020-04-27
 
 #### Bug Fix

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
@@ -57,6 +56,9 @@ The configuration file should look like the following (don't use the keys below,
     organization: 542d76ac2fad4697c3e80448
     launch_command: open $url$
     enable_trello_app: false
+    enable_logging: true
+    cache_capacity: 5
+    cache_first: '^PM-\d+'
 ```
 
 **Step 6**: Adjust configuration file (Optional)
@@ -75,27 +77,66 @@ To open your Trello board in the Trello app change your configuration to:
     enable_trello_app: true
 ```
 
+Adjust the `enable_logging` configuration to start logging diagnostics:
+
+```yaml
+    enable_logging: true
+```
+
+Adjust the `cache_capacity` configuration to increase the capacity of the cache (see `~/.nutrella.cache.yml`):
+
+```yaml
+   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:
 
-```sh
+1. Create or open a Trello board based on the name of the current git branch:
+
+    ```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>
-```
+    ```
 
-Note: you can invoke `nutrella` from your project directory or from any subdirectory.
+
+2. Create or open a previously created Trello board using a JIRA ticket like `PM-9423`:
+
+    ```sh
+    $ nutrella <JIRA Ticket>
+    ```
+
+    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
 
-1. For `method_missing: undefined method 'this'`
+1. If an unexpected Trello board is opening try clearing your cache:
+
+    ```sh
+    rm ~/.nutrella.cache.yml
+    ```
+
+1. If you see `method_missing: undefined method 'this'`
 
     Try updating `RubyGems`
 
@@ -103,7 +144,7 @@ Note: you can invoke `nutrella` from your project directory or from any subdirec
     gem update --system
     ```
 
-1. For `uninitialized constant Gem::Source (NameError)`
+1. If you see `uninitialized constant Gem::Source (NameError)`
 
     Try updating `bundler`
 
@@ -111,7 +152,7 @@ Note: you can invoke `nutrella` from your project directory or from any subdirec
     gem install bundler
     ```
 
-1. For `cannot load such file -- nutrella`
+1. If you see `cannot load such file -- nutrella`
 
     This error may appear after running `irb -rubygems` and you are unable to `require 'nutrella'`.
     Try running `irb -rubygems` from your home directory:

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

@@ -15,6 +15,8 @@ module Nutrella
 
     def run
       launch(board_url)
+    ensure
+      logger.close
     end
 
     private
@@ -22,15 +24,25 @@ module Nutrella
     def launch(url)
       launch_command = configuration_values.fetch(:launch_command).gsub("$url$", url)
 
+      logger.info { "Launch command: '#{launch_command}'" }
+
       system(launch_command)
     end
 
     def board_url
-      enable_trello_app? ? trello_url(cached_url) : cached_url
+      url = enable_trello_app? ? trello_url(cached_url) : cached_url
+
+      logger.info { "Board URL: '#{url}'" }
+
+      url
+    end
+
+    def cache_capacity
+      @_cache_capacity ||= configuration_values.fetch(:cache_capacity)
     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
@@ -41,16 +53,28 @@ module Nutrella
       configuration_values.fetch(:enable_trello_app)
     end
 
+    def logger
+      @_logger ||= Logger.new(log_filename)
+    end
+
+    def log_filename
+      configuration_values.fetch(:enable_logging) ? "nutrella.log" : "/dev/null"
+    end
+
     def trello_url(http_url)
       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
 
     def url_cache
-      Nutrella::Cache.new(cache_filename, 5)
+      Nutrella::Cache.new(cache_filename, cache_capacity)
     end
   end
 end

data/lib/nutrella/configuration.rb

@@ -9,7 +9,7 @@ module Nutrella
   class Configuration
     NULOGY_ORGANIZATION_ID = "542d76ac2fad4697c3e80448"
 
-    INITIAL_CONFIGURATION = <<-YAML.strip_heredoc
+    INITIAL_CONFIGURATION = <<~YAML
       # Trello Developer API Keys
       key: <your developer key>
       secret: <your developer secret>
@@ -18,7 +18,10 @@ module Nutrella
       # Optional Configuration
       organization: #{NULOGY_ORGANIZATION_ID}
       launch_command: open $url$
-      enable_trello_app: False
+      enable_trello_app: false
+      enable_logging: false
+      cache_capacity: 5
+      cache_first: '^PM-\d+'
     YAML
 
     attr_reader :path, :values
@@ -35,14 +38,17 @@ module Nutrella
 
     private
 
-    def load_configuration
+    def load_configuration # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       @values = {
         key: configuration.fetch("key"),
         secret: configuration.fetch("secret"),
         token: configuration.fetch("token"),
         organization: configuration.fetch("organization", NULOGY_ORGANIZATION_ID),
         launch_command: configuration.fetch("launch_command", "open $url$"),
-        enable_trello_app: configuration.fetch("enable_trello_app", "False")
+        enable_trello_app: configuration.fetch("enable_trello_app", "false"),
+        enable_logging: configuration.fetch("enable_logging", "false"),
+        cache_capacity: configuration.fetch("cache_capacity", 5),
+        cache_first: to_reg_exp("cache_first")
       }
     rescue => e
       abort "#{path} #{e}"
@@ -64,7 +70,7 @@ module Nutrella
     end
 
     def configuration_missing_message
-      <<-TEXT.strip_heredoc
+      <<~TEXT
         I see that you don't have a config file '#{path}'.
         So, I created one for you.
 
@@ -73,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.1"
+  VERSION = "1.6.0"
 end

data/nutrella.gemspec

@@ -24,13 +24,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
-  spec.add_runtime_dependency "ruby-trello", "~> 2.1"
+  spec.add_runtime_dependency "ruby-trello", "~> 3.0"
 
-  spec.add_development_dependency "rake", ">= 12.1", "< 13.1"
-  spec.add_development_dependency "rspec", ">= 3.9", "< 4.0"
-  spec.add_development_dependency "rubocop", "~> 0.82"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.38"
-  spec.add_development_dependency "simplecov", "~> 0.17"
+  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-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.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Alistair McKinnell
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello
@@ -16,97 +16,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 
+        version: '0.21'
+description:
 email:
 - alistair.mckinnell@gmail.com
 executables:
@@ -121,7 +109,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -136,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
@@ -153,7 +140,7 @@ metadata:
   changelog_uri: https://github.com/amckinnell/nutrella/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/amckinnell/nutrella
   bug_tracker_uri: https://github.com/amckinnell/nutrella/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,15 +148,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: A command line tool for creating a Trello Board based on the current git
   branch.

data/.travis.yml

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

data/lib/nutrella/string_ext.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Simpler versions of extensions from ActiveSupport.
-#
-class String
-  def strip_heredoc
-    gsub(/^ +/, "")
-  end
-
-  def titleize
-    tr("_-", " ").split(" ").map(&:capitalize).join(" ")
-  end
-end