nutrella 1.5.0 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ada2f552730cbf6221835584e054c6e11e97772d0a31ea615b82216555d4b09
-  data.tar.gz: 199bdf1116434ed92d25c718fa8aee98e96c998427176508a55b81acf59bee01
+  metadata.gz: 24e66cfc7e3e0b2cf58e7ecb47d16d2689c417e60f4c499bf7ecf777a6e08015
+  data.tar.gz: 53d417160b545b06988e41c1d6b434d0d61822e04cb54dd7482d725e11e450a7
 SHA512:
-  metadata.gz: 9d4bf1688c192e4a6b0f669d610931ec99c1ff95c9147b09e8a88e66933e8f53957cca69040cbd9462f867d6084bea00beb787e27f22fec8da227a18186ee8db
-  data.tar.gz: f57b83dfb937e477a8f56d71bda8a6b3414252bab313d6c1f1c501b3d504ce691a99f5f4b0db3f2c4b7708bf96a87127ab6d53a6462c386f13cfea763f889731
+  metadata.gz: 44e1e12f2f85e870b7d48324450e6d42fa109d606760b31b8a5f0ff70b22b4109a4b304bd00eb765f69b0dc8f40db1ee2571e60014346ea509cf0573cfa4beea
+  data.tar.gz: 874d0d22d8fc5a51fc27712226927363a3e1c0883b029d0dd449f2b245c4a47073c64f98ad25a45a08ec150fb36bea16b473d43c08ac146d4c063adb5ac903fd

data/.gitignore

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

data/.rubocop.yml

@@ -1,8 +1,10 @@
 require:
+  - rubocop-rake
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.6
 
   Exclude:
     - 'bin/**/*'
@@ -11,21 +13,15 @@ AllCops:
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
 Metrics/BlockLength:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
+Rake/Desc:
+  Enabled: false
+
 RSpec/AnyInstance:
   Enabled: false
 
@@ -62,22 +58,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,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- Honour the specified named Trello board argument over the Trello board derived from the current git branch
+
 ## [1.5.0] - 2020-04-26
 
 #### New Features
@@ -26,7 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.3.0] - 2019-05-20
 
-#### Yanked
+- Yanked
 
 ## [1.2.2] - 2019-04-27
 

data/README.md

@@ -57,25 +57,39 @@ 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
 ```
 
-Finally, you can tweak your configuration:
+**Step 6**: Adjust configuration file (Optional)
 
-1. Adjust the launch_command configuration to fit your needs. For example, on macOS to open
-your Trello board in Firefox change your configuration to:
+Adjust the `launch_command` configuration to fit your needs.
+For example, to open your Trello board in Firefox change your configuration to:
 
 ```yaml
     launch_command: open -a firefox $url$
 ```
 
-1. Adjust the enable_trello_app configuration to open boards in the Trello app. For example,
-if you have installed the Trello app on macOS to open your Trello board in the Trello app
-change your configuration to:
+Adjust the `enable_trello_app` configuration to open boards in the Trello app.
+To open your Trello board in the Trello app change your configuration to:
 
 ```yaml
     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
+```
+
+
 ## Usage
 
 Create or open a Trello board based on the name of the current git branch:
@@ -95,7 +109,13 @@ Note: you can invoke `nutrella` from your project directory or from any subdirec
 
 ## 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 +123,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 +131,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/lib/nutrella/command.rb

@@ -15,6 +15,8 @@ module Nutrella
 
     def run
       launch(board_url)
+    ensure
+      logger.close
     end
 
     private
@@ -22,11 +24,21 @@ 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
@@ -41,6 +53,14 @@ 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
@@ -50,7 +70,7 @@ module Nutrella
     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,9 @@ 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
     YAML
 
     attr_reader :path, :values
@@ -35,14 +37,16 @@ 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)
       }
     rescue => e
       abort "#{path} #{e}"
@@ -64,7 +68,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.
 

data/lib/nutrella/string_ext.rb

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

data/lib/nutrella/task_board_name.rb

@@ -10,12 +10,12 @@ module Nutrella
   #
   class TaskBoardName
     def self.board_name(args)
-      git_branch_name, status = Open3.capture2("git rev-parse --abbrev-ref HEAD")
-      return git_branch_name.chomp if status.success?
-
       git_branch_name = args[0]
       return git_branch_name if git_branch_name.present?
 
+      git_branch_name, status = Open3.capture2("git rev-parse --abbrev-ref HEAD")
+      return git_branch_name.chomp if status.success?
+
       abort "Sorry. Can't figure out a name for the board."
     end
   end

data/lib/nutrella/version.rb

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

data/nutrella.gemspec

@@ -24,13 +24,14 @@ 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-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.0
+  version: 1.5.4
 platform: ruby
 authors:
 - Alistair McKinnell
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello
@@ -16,97 +16,99 @@ 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: '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.82'
+        version: '0.6'
 - !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:
@@ -153,7 +155,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 +163,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.