chamber 2.13.0 → 3.0.0rc1

data/lib/chamber/binary/heroku.rb

@@ -5,11 +5,13 @@ require 'chamber/commands/cloud/clear'
 require 'chamber/commands/cloud/push'
 require 'chamber/commands/cloud/pull'
 require 'chamber/commands/cloud/compare'
+require 'chamber/refinements/hash'
 
 module  Chamber
 module  Binary
-class   Heroku < Thor
-  include Thor::Actions
+class   Heroku < ::Thor
+  include ::Thor::Actions
+  using ::Chamber::Refinements::Hash
 
   class_option :app,
                type:     :string,
@@ -18,8 +20,15 @@ class   Heroku < Thor
                desc:     'The name of the Heroku application whose config values will ' \
                          'be affected'
 
-  desc 'clear', 'Removes all Heroku environment variables which match settings that ' \
-                'Chamber knows about'
+  class_option :api_token,
+               type:     :string,
+               aliases:  '-t',
+               required: true,
+               desc:     'The API token to access your Heroku project.'
+
+  desc 'clear',
+       'Removes all Heroku environment variables which match settings that ' \
+       'Chamber knows about'
 
   method_option :dry_run,
                 type:    :boolean,
@@ -28,11 +37,14 @@ class   Heroku < Thor
                          'would change if cleared'
 
   def clear
-    Commands::Cloud::Clear.call(options.merge(shell: self, adapter: 'heroku'))
+    Commands::Cloud::Clear.call(**options
+                                    .deep_transform_keys(&:to_sym)
+                                    .merge(shell: self, adapter: 'heroku'))
   end
 
-  desc 'push', 'Sends settings to Heroku so that they may be used in the application ' \
-               'once it is deployed'
+  desc 'push',
+       'Sends settings to Heroku so that they may be used in the application ' \
+       'once it is deployed'
 
   method_option :dry_run,
                 type:    :boolean,
@@ -57,11 +69,14 @@ class   Heroku < Thor
                          'will be pushed'
 
   def push
-    Commands::Cloud::Push.call(options.merge(shell: self, adapter: 'heroku'))
+    Commands::Cloud::Push.call(**options
+                                   .deep_transform_keys(&:to_sym)
+                                   .merge(shell: self, adapter: 'heroku'))
   end
 
-  desc 'pull', 'Retrieves the environment variables for the application and stores ' \
-               'them in a temporary file'
+  desc 'pull',
+       'Retrieves the environment variables for the application and stores ' \
+       'them in a temporary file'
 
   method_option :into,
                 type: :string,
@@ -69,11 +84,14 @@ class   Heroku < Thor
                       'stored. This file WILL BE OVERRIDDEN.'
 
   def pull
-    Commands::Cloud::Pull.call(options.merge(shell: self, adapter: 'heroku'))
+    Commands::Cloud::Pull.call(**options
+                                   .deep_transform_keys(&:to_sym)
+                                   .merge(shell: self, adapter: 'heroku'))
   end
 
-  desc 'compare', 'Displays the difference between what is currently stored in the ' \
-                  'Heroku application\'s config and what Chamber knows about locally'
+  desc 'compare',
+       'Displays the difference between what is currently stored in the ' \
+       'Heroku application\'s config and what Chamber knows about locally'
 
   method_option :only_sensitive,
                 type:    :boolean,
@@ -84,7 +102,9 @@ class   Heroku < Thor
                          'which are marked as "_secure"'
 
   def compare
-    Commands::Cloud::Compare.call(options.merge(shell: self, adapter: 'heroku'))
+    Commands::Cloud::Compare.call(**options
+                                      .deep_transform_keys(&:to_sym)
+                                      .merge(shell: self, adapter: 'heroku'))
   end
 end
 end

data/lib/chamber/binary/runner.rb

@@ -12,13 +12,15 @@ require 'chamber/commands/sign'
 require 'chamber/commands/verify'
 require 'chamber/commands/compare'
 require 'chamber/commands/initialize'
+require 'chamber/refinements/hash'
 
 module  Chamber
 module  Binary
-class   Runner < Thor
-  include Thor::Actions
+class   Runner < ::Thor
+  include ::Thor::Actions
+  using ::Chamber::Refinements::Hash
 
-  source_root ::File.expand_path('../../../../templates', __FILE__)
+  source_root ::File.expand_path('../../../templates', __dir__)
 
   class_option  :rootpath,
                 type:    :string,
@@ -62,17 +64,17 @@ class   Runner < Thor
 
   ################################################################################
 
-  desc 'travis SUBCOMMAND ...ARGS',   'For manipulating Travis CI environment variables'
+  desc 'travis SUBCOMMAND ...ARGS', 'For manipulating Travis CI environment variables'
   subcommand 'travis', Chamber::Binary::Travis
 
   ################################################################################
 
-  desc 'heroku SUBCOMMAND ...ARGS',   'For manipulating Heroku environment variables'
+  desc 'heroku SUBCOMMAND ...ARGS', 'For manipulating Heroku environment variables'
   subcommand 'heroku', Chamber::Binary::Heroku
 
   ################################################################################
 
-  desc 'circleci SUBCOMMAND ...ARGS',   'For manipulating CircleCI environment variables'
+  desc 'circleci SUBCOMMAND ...ARGS', 'For manipulating CircleCI environment variables'
   subcommand 'circleci', Chamber::Binary::CircleCi
 
   ################################################################################
@@ -92,7 +94,7 @@ class   Runner < Thor
                          'Useful for debugging.'
 
   def show
-    puts Commands::Show.call(options.merge(shell: self))
+    puts Commands::Show.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
   end
 
   ################################################################################
@@ -100,15 +102,16 @@ class   Runner < Thor
   desc 'files', 'Lists the settings files which are parsed with the given options'
 
   def files
-    puts Commands::Files.call(options.merge(shell: self))
+    puts Commands::Files.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
   end
 
   ################################################################################
 
-  desc 'compare', 'Displays the difference between the settings in the first set ' \
-                  'of namespaces and the settings in the second set.  Useful for ' \
-                  'tracking down why there may be issues in development versus test ' \
-                  'or differences between staging and production.'
+  desc 'compare',
+       'Displays the difference between the settings in the first set ' \
+       'of namespaces and the settings in the second set.  Useful for ' \
+       'tracking down why there may be issues in development versus test ' \
+       'or differences between staging and production.'
 
   method_option :keys_only,
                 type:    :boolean,
@@ -117,23 +120,26 @@ class   Runner < Thor
                          'of the two sets of settings'
 
   method_option :first,
-                type: :array,
-                desc: 'The list of namespaces which will be used as the source of ' \
-                      'the comparison'
+                type:     :array,
+                required: true,
+                desc:     'The list of namespaces which will be used as the source of ' \
+                          'the comparison'
 
   method_option :second,
-                type: :array,
-                desc: 'The list of namespaces which will be used as the destination ' \
-                      'of the comparison'
+                type:     :array,
+                required: true,
+                desc:     'The list of namespaces which will be used as the ' \
+                          'destination of the comparison'
 
   def compare
-    Commands::Compare.call(options.merge(shell: self))
+    Commands::Compare.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
   end
 
   ################################################################################
 
-  desc 'secure', 'Secures any values which appear to need to be encrypted in any of ' \
-                 'the settings files which match irrespective of namespaces'
+  desc 'secure',
+       'Secures any values which appear to need to be encrypted in any of ' \
+       'the settings files which match irrespective of namespaces'
 
   method_option :only_sensitive,
                 type:    :boolean,
@@ -146,37 +152,42 @@ class   Runner < Thor
                          'what values would be encrypted'
 
   def secure
-    Commands::Secure.call(options.merge(shell: self))
+    Commands::Secure.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
   end
 
   ################################################################################
 
-  desc 'sign', 'Creates or verifies signatures for all current settings files using ' \
-               'the signature private key.'
+  desc 'sign',
+       'Creates or verifies signatures for all current settings files using ' \
+       'the signature private key.'
 
   method_option :verify,
                 type:    :boolean,
                 default: false
 
+  method_option :signature_name,
+                type:    :string,
+                default: `git config --get 'user.name'`.chomp
+
   def sign
     if options[:verify]
-      Commands::Verify.call(options.merge(shell: self))
+      Commands::Verify.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
     else
-      Commands::Sign.call(options.merge(shell: self))
+      Commands::Sign.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
     end
   end
 
   ################################################################################
 
-  desc 'init', 'Sets Chamber up using best practices for secure configuration ' \
-               'management'
+  desc 'init',
+       'Sets Chamber up using best practices for secure configuration management'
 
   method_option :signature,
                 type:    :boolean,
                 default: false
 
   def init
-    Commands::Initialize.call(options.merge(shell: self))
+    Commands::Initialize.call(**options.deep_transform_keys(&:to_sym).merge(shell: self))
   end
 end
 end

data/lib/chamber/binary/travis.rb

@@ -2,12 +2,16 @@
 
 require 'thor'
 require 'chamber/commands/travis/secure'
+require 'chamber/refinements/hash'
 
 module  Chamber
 module  Binary
-class   Travis < Thor
-  desc 'secure', 'Uses your Travis CI public key to encrypt the settings you have ' \
-                 'chosen not to commit to the repo'
+class   Travis < ::Thor
+  using ::Chamber::Refinements::Hash
+
+  desc 'secure',
+       'Uses your Travis CI public key to encrypt the settings you have ' \
+       'chosen not to commit to the repo'
 
   method_option :dry_run,
                 type:    :boolean,
@@ -24,7 +28,9 @@ class   Travis < Thor
                          'which are marked as "_secure"'
 
   def secure
-    Commands::Travis::Secure.call(options.merge(shell: self))
+    Commands::Travis::Secure.call(**options
+                                    .deep_transform_keys(&:to_sym)
+                                    .merge(shell: self))
   end
 end
 end

data/lib/chamber/commands/base.rb

@@ -6,26 +6,20 @@ require 'chamber/instance'
 module  Chamber
 module  Commands
 class   Base
-  def self.call(options = {})
-    new(options).call
+  def self.call(**args)
+    new(**args).call
   end
 
   attr_accessor :chamber,
-                :shell,
-                :dry_run
-  attr_reader   :rootpath
+                :dry_run,
+                :rootpath,
+                :shell
 
-  def initialize(options = {})
-    self.chamber  = Chamber::Instance.new options
-    self.shell    = options[:shell]
-    self.rootpath = options[:rootpath]
-    self.dry_run  = options[:dry_run]
-  end
-
-  protected
-
-  def rootpath=(other)
-    @rootpath = Pathname.new(other)
+  def initialize(shell: nil, rootpath: nil, dry_run: nil, **args)
+    self.chamber  = Chamber::Instance.new(rootpath: rootpath, **args)
+    self.shell    = shell
+    self.rootpath = chamber.configuration.rootpath
+    self.dry_run  = dry_run
   end
 end
 end

data/lib/chamber/commands/cloud/base.rb

@@ -8,10 +8,10 @@ module  Cloud
 class   Base < Chamber::Commands::Base
   attr_accessor :adapter
 
-  def initialize(options = {})
-    super
+  def initialize(adapter:, **args)
+    super(**args)
 
-    self.adapter = adapter_class(options[:adapter]).new(options)
+    self.adapter = adapter_class(adapter).new(**args)
   end
 
   private

data/lib/chamber/commands/cloud/pull.rb

@@ -9,10 +9,10 @@ module  Cloud
 class   Pull < Chamber::Commands::Cloud::Base
   attr_accessor :target_file
 
-  def initialize(options = {})
+  def initialize(into:, **args)
     super
 
-    self.target_file = options[:into]
+    self.target_file = into
   end
 
   def call

data/lib/chamber/commands/cloud/push.rb

@@ -12,18 +12,18 @@ class   Push < Chamber::Commands::Cloud::Base
 
   attr_accessor :keys
 
-  def initialize(options = {})
-    super
+  def initialize(keys:, **args)
+    super(**args)
 
-    self.keys = options[:keys]
+    self.keys = keys
   end
 
   def call
     environment_variables = if keys
-                              Keys::Decryption.
-                                new(rootpath:   chamber.configuration.rootpath,
-                                    namespaces: chamber.configuration.namespaces).
-                                as_environment_variables
+                              Keys::Decryption
+                                .new(rootpath:   chamber.configuration.rootpath,
+                                     namespaces: chamber.configuration.namespaces)
+                                .as_environment_variables
                             else
                               securable_environment_variables
                             end

data/lib/chamber/commands/comparable.rb

@@ -5,10 +5,10 @@ require 'tempfile'
 module  Chamber
 module  Commands
 module  Comparable
-  def initialize(options = {})
+  def initialize(keys_only:, **args)
     super
 
-    self.keys_only = options[:keys_only]
+    self.keys_only = keys_only
   end
 
   def call

data/lib/chamber/commands/compare.rb

@@ -12,18 +12,15 @@ class   Compare < Chamber::Commands::Base
   attr_accessor :first_settings_instance,
                 :second_settings_instance
 
-  def self.call(options = {})
-    new(options).call
+  def self.call(**args)
+    new(**args).call
   end
 
-  def initialize(options = {})
-    super
+  def initialize(first:, second:, **args)
+    super(**args)
 
-    first_settings_options        = options.merge(namespaces: options[:first])
-    self.first_settings_instance  = Chamber::Instance.new(first_settings_options)
-
-    second_settings_options       = options.merge(namespaces: options[:second])
-    self.second_settings_instance = Chamber::Instance.new(second_settings_options)
+    self.first_settings_instance  = Chamber::Instance.new(args.merge(namespaces: first))
+    self.second_settings_instance = Chamber::Instance.new(args.merge(namespaces: second))
   end
 
   protected

data/lib/chamber/commands/initialize.rb

@@ -11,23 +11,23 @@ require 'chamber/commands/base'
 module  Chamber
 module  Commands
 class   Initialize < Chamber::Commands::Base
-  def self.call(options = {})
-    new(options).call
+  def self.call(**args)
+    new(**args).call
   end
 
   attr_accessor :basepath,
                 :namespaces,
                 :signature
 
-  def initialize(options = {})
-    super
+  def initialize(signature:, namespaces: [], **args)
+    super(**args)
 
     self.basepath   = Chamber.configuration.basepath
-    self.namespaces = options.fetch(:namespaces, [])
-    self.signature  = options.fetch(:signature)
+    self.namespaces = namespaces
+    self.signature  = signature
   end
 
-  # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Metrics/AbcSize
+  # rubocop:disable Layout/LineLength, Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
   def call
     key_pairs = namespaces.map do |namespace|
       Chamber::KeyPair.new(namespace:     namespace,
@@ -78,21 +78,25 @@ class   Initialize < Chamber::Commands::Base
       shell.say 'Your signature keys, which will be used for verification, are located at:'
       shell.say ''
       shell.say '  * Public Key:            '
-      shell.say signature_key_pair.
-                  public_key_filepath.
-                  relative_path_from(Pathname.pwd), :yellow
+      shell.say signature_key_pair
+                  .public_key_filepath
+                  .relative_path_from(Pathname.pwd),
+                :yellow
       shell.say '  * Private Key:           '
-      shell.say signature_key_pair.
-                  unencrypted_private_key_filepath.
-                  relative_path_from(Pathname.pwd), :yellow
+      shell.say signature_key_pair
+                  .unencrypted_private_key_filepath
+                  .relative_path_from(Pathname.pwd),
+                :yellow
       shell.say '  * Encrypted Private Key: '
-      shell.say signature_key_pair.
-                  encrypted_private_key_filepath.
-                  relative_path_from(Pathname.pwd), :yellow
+      shell.say signature_key_pair
+                  .encrypted_private_key_filepath
+                  .relative_path_from(Pathname.pwd),
+                :yellow
       shell.say '  * Encrypted Passphrase:  '
-      shell.say signature_key_pair.
-                  encrypted_private_key_passphrase_filepath.
-                  relative_path_from(Pathname.pwd), :yellow
+      shell.say signature_key_pair
+                  .encrypted_private_key_passphrase_filepath
+                  .relative_path_from(Pathname.pwd),
+                :yellow
 
       shell.say ''
       shell.say 'The signature private keys should be thought of separately from the other'
@@ -153,7 +157,7 @@ class   Initialize < Chamber::Commands::Base
     shell.say '--------------------------------------------------------------------------------'
     shell.say ''
   end
-  # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Metrics/AbcSize
+  # rubocop:enable Layout/LineLength, Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
 
   protected
 
@@ -178,7 +182,7 @@ class   Initialize < Chamber::Commands::Base
   end
 
   def append_to_gitignore
-    ::FileUtils.touch gitignore_filepath
+    ::FileUtils.touch(gitignore_filepath)
 
     gitignore_contents = ::File.read(gitignore_filepath)
 
@@ -206,7 +210,7 @@ class   Initialize < Chamber::Commands::Base
 
   def gem_path
     @gem_path                   ||= Pathname.new(
-                                      ::File.expand_path('../../../..', __FILE__),
+                                      ::File.expand_path('../../..', __dir__),
                                     )
   end