chamber 2.13.1 → 2.14.0

data/lib/chamber/filters/encryption_filter.rb

@@ -10,8 +10,8 @@ require 'chamber/encryption_methods/none'
 module    Chamber
 module    Filters
 class     EncryptionFilter
-  BASE64_STRING_PATTERN     = %r{\A[A-Za-z0-9\+\/]{342}==\z}.freeze
-  BASE64_SUBSTRING_PATTERN  = %r{[A-Za-z0-9\+\/#]*\={0,2}}.freeze
+  BASE64_STRING_PATTERN     = %r{\A[A-Za-z0-9+/]{342}==\z}.freeze
+  BASE64_SUBSTRING_PATTERN  = %r{[A-Za-z0-9+/#]*={0,2}}.freeze
   LARGE_DATA_STRING_PATTERN = /
                                 \A
                                 (#{BASE64_SUBSTRING_PATTERN})
@@ -26,14 +26,14 @@ class     EncryptionFilter
                 :secure_key_token
   attr_reader   :encryption_keys
 
-  def initialize(options = {})
-    self.encryption_keys  = options.fetch(:encryption_keys, {}) || {}
-    self.data             = options.fetch(:data).dup
-    self.secure_key_token = /\A#{Regexp.escape(options.fetch(:secure_key_prefix))}/
+  def initialize(data:, secure_key_prefix:, encryption_keys: {}, **_args)
+    self.encryption_keys  = encryption_keys || {}
+    self.data             = data.dup
+    self.secure_key_token = /\A#{Regexp.escape(secure_key_prefix)}/
   end
 
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   protected

data/lib/chamber/filters/environment_filter.rb

@@ -88,16 +88,16 @@ class   EnvironmentFilter
   #   }
   #
   #
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   attr_accessor :data,
                 :secure_key_token
 
-  def initialize(options = {})
-    self.data             = options.fetch(:data)
-    self.secure_key_token = /\A#{Regexp.escape(options.fetch(:secure_key_prefix))}/
+  def initialize(data:, secure_key_prefix:, **_args)
+    self.data             = data
+    self.secure_key_token = /\A#{Regexp.escape(secure_key_prefix)}/
   end
 
   protected
@@ -138,8 +138,7 @@ class   EnvironmentFilter
     environment_hash
   end
 
-  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-  def convert_environment_value(environment_key, environment_value, settings_value)
+  def convert_environment_value(environment_key, environment_value, settings_value) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
     return settings_value unless environment_value
     return                if %w{___nil___ ___null___}.include?(environment_value)
 
@@ -163,22 +162,21 @@ class   EnvironmentFilter
           fail ArgumentError, "Invalid value for Array: #{environment_value}"
         end
       end
-    when 'Integer'
+    when 'Fixnum', 'Integer'
       Integer(environment_value)
     else
       environment_value
     end
   rescue ArgumentError
-    raise Chamber::Errors::EnvironmentConversion, <<~HEREDOC
-      We attempted to convert '#{environment_key}' from '#{environment_value}' to a '#{settings_value.class.name}'.
+    raise Chamber::Errors::EnvironmentConversion, <<-HEREDOC
+We attempted to convert '#{environment_key}' from '#{environment_value}' to a '#{settings_value.class.name}'.
 
-      Unfortunately, this did not go as planned.  Please either verify that your value is convertable
-      or change the original YAML value to be something more generic (like a String).
+Unfortunately, this did not go as planned.  Please either verify that your value is convertable
+or change the original YAML value to be something more generic (like a String).
 
-      For more information, see https://github.com/thekompanee/chamber/wiki/Environment-Variable-Coercions
+For more information, see https://github.com/thekompanee/chamber/wiki/Environment-Variable-Coercions
     HEREDOC
   end
-  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 end
 end
 end

data/lib/chamber/filters/failed_decryption_filter.rb

@@ -5,18 +5,18 @@ require 'chamber/errors/decryption_failure'
 module  Chamber
 module  Filters
 class   FailedDecryptionFilter
-  BASE64_STRING_PATTERN = %r{\A[A-Za-z0-9\+/]{342}==\z}.freeze
+  BASE64_STRING_PATTERN = %r{\A[A-Za-z0-9+/]{342}==\z}.freeze
 
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   attr_accessor :data,
                 :secure_key_token
 
-  def initialize(options = {})
-    self.data             = options.fetch(:data).dup
-    self.secure_key_token = /\A#{Regexp.escape(options.fetch(:secure_key_prefix))}/
+  def initialize(data:, secure_key_prefix:, **_args)
+    self.data             = data.dup
+    self.secure_key_token = /\A#{Regexp.escape(secure_key_prefix)}/
   end
 
   protected

data/lib/chamber/filters/insecure_filter.rb

@@ -6,8 +6,8 @@ require 'chamber/filters/secure_filter'
 module  Chamber
 module  Filters
 class   InsecureFilter < SecureFilter
-  BASE64_STRING_PATTERN     = %r{\A[A-Za-z0-9\+\/]{342}==\z}.freeze
-  BASE64_SUBSTRING_PATTERN  = %r{[A-Za-z0-9\+\/#]*\={0,2}}.freeze
+  BASE64_STRING_PATTERN     = %r{\A[A-Za-z0-9+/]{342}==\z}.freeze
+  BASE64_SUBSTRING_PATTERN  = %r{[A-Za-z0-9+/#]*={0,2}}.freeze
   LARGE_DATA_STRING_PATTERN = /
                                 \A
                                 (#{BASE64_SUBSTRING_PATTERN})
@@ -20,7 +20,7 @@ class   InsecureFilter < SecureFilter
 
   protected
 
-  def execute(raw_data = data)
+  def execute(raw_data = data) # rubocop:disable Metrics/CyclomaticComplexity
     securable_settings = super
     settings           = Hashie::Mash.new
 

data/lib/chamber/filters/namespace_filter.rb

@@ -5,16 +5,16 @@ require 'hashie/mash'
 module  Chamber
 module  Filters
 class   NamespaceFilter
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   attr_accessor :data,
                 :namespaces
 
-  def initialize(options = {})
-    self.data       = Hashie::Mash.new(options.fetch(:data))
-    self.namespaces = options.fetch(:namespaces)
+  def initialize(data:, namespaces:, **_args)
+    self.data       = Hashie::Mash.new(data)
+    self.namespaces = namespaces
   end
 
   protected

data/lib/chamber/filters/secure_filter.rb

@@ -5,16 +5,16 @@ require 'hashie/mash'
 module  Chamber
 module  Filters
 class   SecureFilter
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   attr_accessor :data,
                 :secure_key_token
 
-  def initialize(options = {})
-    self.data             = Hashie::Mash.new(options.fetch(:data))
-    self.secure_key_token = /\A#{Regexp.escape(options.fetch(:secure_key_prefix))}/
+  def initialize(data:, secure_key_prefix:, **_args)
+    self.data             = Hashie::Mash.new(data)
+    self.secure_key_token = /\A#{Regexp.escape(secure_key_prefix)}/
   end
 
   protected

data/lib/chamber/filters/translate_secure_keys_filter.rb

@@ -5,16 +5,16 @@ require 'hashie/mash'
 module  Chamber
 module  Filters
 class   TranslateSecureKeysFilter
-  def self.execute(options = {})
-    new(options).__send__(:execute)
+  def self.execute(**args)
+    new(**args).__send__(:execute)
   end
 
   attr_accessor :data,
                 :secure_key_token
 
-  def initialize(options = {})
-    self.data             = options.fetch(:data).dup
-    self.secure_key_token = /\A#{Regexp.escape(options.fetch(:secure_key_prefix))}/
+  def initialize(data:, secure_key_prefix:, **_args)
+    self.data             = data.dup
+    self.secure_key_token = /\A#{Regexp.escape(secure_key_prefix)}/
   end
 
   protected

data/lib/chamber/instance.rb

@@ -9,15 +9,19 @@ class   Instance
   attr_accessor :configuration,
                 :files
 
-  def initialize(options = {})
-    self.configuration = Configuration.new  options
-    self.files         = FileSet.new        configuration.to_hash
+  def initialize(**args)
+    self.configuration = Configuration.new(**args)
+    self.files         = FileSet.new(**configuration.to_hash)
   end
 
   def settings
     @settings ||= files.to_settings { |settings| @settings = settings }
   end
 
+  def [](key)
+    settings.[](key)
+  end
+
   def filenames
     files.filenames
   end
@@ -34,26 +38,42 @@ class   Instance
     files.verify
   end
 
-  def encrypt(data, options = {})
-    config = configuration.to_hash.merge(options)
+  def to_environment
+    settings.to_environment
+  end
+
+  def to_s(**args)
+    settings.to_s(**args)
+  end
+
+  def to_hash
+    settings.to_hash
+  end
+
+  def namespaces
+    settings.namespaces
+  end
 
-    Settings.
-      new(
-        config.merge(
+  def encrypt(data, **args)
+    config = configuration.to_hash.merge(**args)
+
+    Settings
+      .new(
+        **config.merge(
           settings:     data,
           pre_filters:  [Filters::EncryptionFilter],
           post_filters: [],
         ),
-      ).
-      to_hash
+      )
+      .to_hash
   end
 
-  def decrypt(data, options = {})
-    config = configuration.to_hash.merge(options)
+  def decrypt(data, **args)
+    config = configuration.to_hash.merge(**args)
 
-    Settings.
-      new(
-        config.merge(
+    Settings
+      .new(
+        **config.merge(
           settings:     data,
           pre_filters:  [Filters::NamespaceFilter],
           post_filters: [
@@ -61,12 +81,8 @@ class   Instance
                           Filters::FailedDecryptionFilter,
                         ],
         ),
-      ).
-      to_hash
-  end
-
-  def to_s(options = {})
-    settings.to_s(options)
+      )
+      .to_hash
   end
 
   def method_missing(name, *args)

data/lib/chamber/key_pair.rb

@@ -9,10 +9,10 @@ class  KeyPair
                 :namespace,
                 :passphrase
 
-  def initialize(options = {})
-    self.namespace     = options[:namespace]
-    self.passphrase    = options.fetch(:passphrase, SecureRandom.uuid)
-    self.key_file_path = Pathname.new(options.fetch(:key_file_path))
+  def initialize(key_file_path:, namespace: nil, passphrase: ::SecureRandom.uuid)
+    self.namespace     = namespace
+    self.passphrase    = passphrase
+    self.key_file_path = Pathname.new(key_file_path)
   end
 
   def encrypted_private_key_passphrase_filepath
@@ -78,9 +78,9 @@ class  KeyPair
     @base_key_filename ||= [
                              '.chamber',
                              namespace ? namespace.tr('-.', '') : nil,
-                           ].
-                             compact.
-                             join('.')
+                           ]
+                             .compact
+                             .join('.')
   end
 end
 end

data/lib/chamber/keys/base.rb

@@ -3,18 +3,18 @@
 module  Chamber
 module  Keys
 class   Base
-  def self.resolve(*args)
-    new(*args).resolve
+  def self.resolve(**args)
+    new(**args).resolve
   end
 
   attr_accessor :rootpath
   attr_reader   :filenames,
                 :namespaces
 
-  def initialize(options = {})
-    self.rootpath   = Pathname.new(options.fetch(:rootpath))
-    self.namespaces = options.fetch(:namespaces)
-    self.filenames  = options[:filenames]
+  def initialize(rootpath:, namespaces:, filenames: nil)
+    self.rootpath   = Pathname.new(rootpath)
+    self.namespaces = namespaces
+    self.filenames  = filenames
   end
 
   def resolve
@@ -41,9 +41,9 @@ class   Base
 
   # rubocop:disable Performance/ChainArrayAllocation
   def filenames=(other)
-    @filenames = Array(other).
-                   map { |o| Pathname.new(o) }.
-                   compact
+    @filenames = Array(other)
+                   .map { |o| Pathname.new(o) }
+                   .compact
   end
   # rubocop:enable Performance/ChainArrayAllocation
 
@@ -52,10 +52,10 @@ class   Base
   end
 
   def namespace_from_path(path)
-    path.
-      basename.
-      to_s.
-      match(self.class::NAMESPACE_PATTERN) { |m| m[1].upcase }
+    path
+      .basename
+      .to_s
+      .match(self.class::NAMESPACE_PATTERN) { |m| m[1].upcase }
   end
 
   def namespace_to_key_path(namespace)

data/lib/chamber/keys/decryption.rb

@@ -22,9 +22,9 @@ class   Decryption < Chamber::Keys::Base
       'CHAMBER',
       namespace_from_path(path),
       'KEY',
-    ].
-      compact.
-      join('_')
+    ]
+      .compact
+      .join('_')
   end
 
   def key_filename_extension

data/lib/chamber/keys/encryption.rb

@@ -22,9 +22,9 @@ class   Encryption < Chamber::Keys::Base
       'CHAMBER',
       namespace_from_path(path),
       'PUBLIC_KEY',
-    ].
-      compact.
-      join('_')
+    ]
+      .compact
+      .join('_')
   end
 
   def key_filename_extension

data/lib/chamber/namespace_set.rb

@@ -71,10 +71,8 @@ class   NamespaceSet
   # Internal: Iterates over each namespace value and allows it to be used in
   # a block.
   #
-  def each
-    namespaces.each do |namespace|
-      yield namespace
-    end
+  def each(&block)
+    namespaces.each(&block)
   end
 
   ###

data/lib/chamber/settings.rb

@@ -16,29 +16,40 @@ require 'chamber/filters/failed_decryption_filter'
 #
 module  Chamber
 class   Settings
-  attr_accessor :pre_filters,
-                :post_filters,
+  attr_accessor :decryption_keys,
                 :encryption_keys,
-                :decryption_keys
+                :post_filters,
+                :pre_filters,
+                :secure_key_prefix
   attr_reader   :namespaces
 
-  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/LineLength
-  def initialize(options = {})
-    self.namespaces      = options[:namespaces]      || []
-    self.raw_data        = options[:settings]        || {}
-    self.decryption_keys = options[:decryption_keys] || {}
-    self.encryption_keys = options[:encryption_keys] || {}
-    self.pre_filters     = options[:pre_filters]     || [
-                                                          Filters::NamespaceFilter,
-                                                        ]
-    self.post_filters    = options[:post_filters]    || [
-                                                          Filters::DecryptionFilter,
-                                                          Filters::EnvironmentFilter,
-                                                          Filters::FailedDecryptionFilter,
-                                                          Filters::TranslateSecureKeysFilter,
-                                                        ]
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(
+                  decryption_keys:   {},
+                  encryption_keys:   {},
+                  namespaces:        [],
+                  pre_filters:       [
+                                       Filters::NamespaceFilter,
+                                     ],
+                  post_filters:      [
+                                       Filters::DecryptionFilter,
+                                       Filters::EnvironmentFilter,
+                                       Filters::FailedDecryptionFilter,
+                                       Filters::TranslateSecureKeysFilter,
+                                     ],
+                  secure_key_prefix: '_secure_',
+                  settings:          {},
+                  **_args
+                )
+    self.decryption_keys   = decryption_keys
+    self.encryption_keys   = encryption_keys
+    self.namespaces        = namespaces
+    self.post_filters      = post_filters
+    self.pre_filters       = pre_filters
+    self.raw_data          = settings
+    self.secure_key_prefix = secure_key_prefix
   end
-  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/LineLength
+  # rubocop:enable Metrics/ParameterLists
 
   ###
   # Internal: Converts a Settings object into a hash that is compatible as an
@@ -79,15 +90,11 @@ class   Settings
   #                 } ).to_s
   #   # => 'MY_KEY="my value" MY_OTHER_KEY="my other value"'
   #
-  def to_s(options = {})
-    hierarchical_separator = options[:hierarchical_separator] || '_'
-    pair_separator         = options[:pair_separator]         || ' '
-    value_surrounder       = options[:value_surrounder]       || '"'
-    name_value_separator   = options[:name_value_separator]   || '='
-
-    concatenated_name_hash = to_concatenated_name_hash(hierarchical_separator)
-
-    pairs = concatenated_name_hash.to_a.map do |key, value|
+  def to_s(hierarchical_separator: '_',
+           pair_separator:         ' ',
+           value_surrounder:       '"',
+           name_value_separator:   '=')
+    pairs = to_concatenated_name_hash(hierarchical_separator).to_a.map do |key, value|
       "#{key.upcase}#{name_value_separator}#{value_surrounder}#{value}#{value_surrounder}"
     end
 
@@ -182,20 +189,21 @@ class   Settings
   # Returns a new Settings object
   #
   def merge(other)
-    other_settings = if other.is_a? Settings
+    other_settings = case other
+                     when Settings
                        other
-                     elsif other.is_a? Hash
+                     when Hash
                        Settings.new(settings: other)
                      end
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     Settings.new(
       encryption_keys: encryption_keys.any? ? encryption_keys : other_settings.encryption_keys,
       decryption_keys: decryption_keys.any? ? decryption_keys : other_settings.decryption_keys,
       namespaces:      (namespaces + other_settings.namespaces),
       settings:        raw_data.merge(other_settings.raw_data),
     )
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   ###
@@ -220,14 +228,14 @@ class   Settings
   end
 
   def securable
-    Settings.new(metadata.merge(
+    Settings.new(**metadata.merge(
                    settings:    raw_data,
                    pre_filters: [Filters::SecureFilter],
                  ))
   end
 
   def secure
-    Settings.new(metadata.merge(
+    Settings.new(**metadata.merge(
                    settings:     raw_data,
                    pre_filters:  [Filters::EncryptionFilter],
                    post_filters: [Filters::TranslateSecureKeysFilter],
@@ -235,7 +243,7 @@ class   Settings
   end
 
   def insecure
-    Settings.new(metadata.merge(
+    Settings.new(**metadata.merge(
                    settings:     raw_data,
                    pre_filters:  [Filters::InsecureFilter],
                    post_filters: [Filters::TranslateSecureKeysFilter],
@@ -265,23 +273,17 @@ class   Settings
   # rubocop:disable Naming/MemoizedInstanceVariableName
   def raw_data
     @filtered_raw_data ||= pre_filters.inject(@raw_data) do |filtered_data, filter|
-      filter.execute({ data: filtered_data }.
-                     merge(metadata))
+      filter.execute(**{ data: filtered_data }.merge(metadata))
     end
   end
   # rubocop:enable Naming/MemoizedInstanceVariableName
 
   def data
     @data ||= post_filters.inject(raw_data) do |filtered_data, filter|
-      filter.execute({ data: filtered_data }.
-                     merge(metadata))
+      filter.execute(**{ data: filtered_data }.merge(metadata))
     end
   end
 
-  def secure_key_prefix
-    '_secure_'
-  end
-
   def metadata
     {
       decryption_keys:   decryption_keys,