nutrella 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7add4b79f183553908597ee654ab4b6eab29cbda1b429c6ced3d94da2d533ccc
-  data.tar.gz: b2dbc3a33c1a4c4c65cd377ab9d450a0553b8636d03521d5ef0e8767ec82280c
+  metadata.gz: '048802727749f75d0574ca96e6049f9a50e9e07593f0f9be6bb1dd2b3960691e'
+  data.tar.gz: c7e3409c81c7eca40460f827a649f18ab8246bd98759eaf57a29ff4ffd1c4f97
 SHA512:
-  metadata.gz: 978a5254670d43a7af9abef50a1878842c84c6dbb022998812d5d4450c6752216c28fa37880ac0a6799dc79b571222d6536cb218da78e8e5aeee4558f5f992aa
-  data.tar.gz: 5b2fc237ef01364c6598715f5889ca4e5dde29978843f8f2f132bbc3c4d2e2cadbf8522aa33bec4c43cc55107b8131a9a38b6fae2e1325c7b88d0850bedc1817
+  metadata.gz: 2b1edcfb213175f8360135e326166f235782be1351bed8c7d1b27e4ee45abf2f693ed6fa56554adcec711c3efb1057a022b60e893dac4911ca27c1a1f27ca1d0
+  data.tar.gz: c83f869b34a624f5e39b16408e07a6afc7a1c69c575c6f454b37570c1da4bab6892bfef5f09fbab1f83e77295aef07a82aa50edffcd4b23daa36e4472926b9a8

data/.gitignore

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

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

@@ -75,6 +75,12 @@ 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
+```
+
 
 ## Usage
 
@@ -95,7 +101,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 +115,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 +123,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,17 @@ 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 cached_url
@@ -41,6 +49,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

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,8 @@ module Nutrella
       # Optional Configuration
       organization: #{NULOGY_ORGANIZATION_ID}
       launch_command: open $url$
-      enable_trello_app: False
+      enable_trello_app: false
+      enable_logging: false
     YAML
 
     attr_reader :path, :values
@@ -35,14 +36,15 @@ 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")
       }
     rescue => e
       abort "#{path} #{e}"
@@ -64,7 +66,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,12 +1,8 @@
 # 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(" ")
   end

data/lib/nutrella/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutrella
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-trello