chamber 0.0.4 → 1.0.0

data/lib/chamber/system_environment.rb

@@ -0,0 +1,145 @@
+require 'hashie/mash'
+
+###
+# Internal: Gives access to the existing environment for importing/exporting
+# values.
+#
+class   Chamber
+module  SystemEnvironment
+
+  ###
+  # Internal: Allows the existing environment to be injected into the passed in
+  # hash.  The hash that is passed in is *not* modified, instead a new hash is
+  # returned.
+  #
+  # Examples:
+  #
+  #   ###
+  #   # Injects the current environment variables
+  #   #
+  #   ENV['LEVEL_ONE_1_LEVEL_TWO_1']               = 'env value 1'
+  #   ENV['LEVEL_ONE_1_LEVEL_TWO_2_LEVEL_THREE_1'] = 'env value 2'
+  #
+  #   SystemEnvironment.inject_into(
+  #     level_one_1: {
+  #       level_two_1: 'value 1',
+  #       level_two_2: {
+  #         level_three_1: 'value 2' } } )
+  #
+  #   # => {
+  #     'level_one_1' => {
+  #       'level_two_1' => 'env value 1',
+  #       'level_two_2' => {
+  #         'level_three_1' => 'env value 2',
+  #   }
+  #
+  #   ###
+  #   # Can inject environment variables if said variables are prefixed
+  #   #
+  #   ENV['PREFIX_LEVEL_TWO_1'] = 'env value 1'
+  #   ENV['PREFIX_LEVEL_TWO_2'] = 'env value 2'
+  #
+  #   SystemEnvironment.inject_into({
+  #                                   level_two_1: 'value 1',
+  #                                   level_two_2: 'value 2'
+  #                                 },
+  #                                 ['prefix'])
+  #
+  #   # => {
+  #     'level_two_1' => 'env value 1',
+  #     'level_two_2' => 'env value 2',
+  #   }
+  #
+  #
+  def self.inject_into(settings = {}, parent_keys = [])
+    with_environment(settings, parent_keys,
+      ->(key, value, environment_keys) do
+        { key => inject_into(value, environment_keys) }
+      end,
+      ->(key, value, environment_key) do
+        { key => convert_value(ENV[environment_key] || value) }
+      end)
+  end
+
+  ###
+  # Internal: Allows the environment variable-compatible variables to be
+  # extracted from a passed in hash.
+  #
+  # Examples:
+  #
+  #   ###
+  #   # Extracts the environment variables based on the hash keys
+  #   #
+  #   SystemEnvironment.extract_from(
+  #     level_one_1: {
+  #       level_two_1: 'value 1',
+  #       level_two_2: {
+  #         level_three_1: 'value 2' } } )
+  #
+  #   # => {
+  #     'LEVEL_ONE_1_LEVEL_TWO_1'               => 'env value 1',
+  #     'LEVEL_ONE_1_LEVEL_TWO_2_LEVEL_THREE_1' => 'env value 2',
+  #   }
+  #
+  #   ###
+  #   # Can extract environment variables if said variables are prefixed
+  #   #
+  #   SystemEnvironment.extract_from({
+  #                                   level_two_1: 'value 1',
+  #                                   level_two_2: 'value 2'
+  #                                 },
+  #                                 ['prefix'])
+  #
+  #   # => {
+  #     'PREFIX_LEVEL_TWO_1' => 'value 1',
+  #     'PREFIX_LEVEL_TWO_2' => 'value 2',
+  #   }
+  #
+  def self.extract_from(settings, parent_keys = [])
+    with_environment(settings, parent_keys,
+      ->(key, value, environment_keys) do
+        extract_from(value, environment_keys)
+      end,
+      ->(key, value, environment_key) do
+        { environment_key => value.to_s }
+      end)
+  end
+
+  private
+
+  def self.with_environment(settings, parent_keys, hash_block, value_block)
+    environment_hash = Hashie::Mash.new
+
+    settings.each_pair do |key, value|
+      environment_keys = parent_keys.dup.push(key)
+
+      if value.respond_to? :each_pair
+        environment_hash.merge!(hash_block.call(key, value, environment_keys))
+      else
+        environment_key = environment_keys.join('_').upcase
+
+        environment_hash.merge!(value_block.call(key, value, environment_key))
+      end
+    end
+
+    environment_hash
+  end
+
+  def self.convert_value(value)
+    return nil if value.nil?
+
+    if value.is_a? String
+      case value
+      when 'false', 'f', 'no'
+        false
+      when 'true', 't', 'yes'
+        true
+      else
+        value
+      end
+    else
+      value
+    end
+  end
+end
+end

data/lib/chamber/version.rb

@@ -1,3 +1,3 @@
-module Chamber
-  VERSION = "0.0.4"
+class  Chamber
+  VERSION = '1.0.0'
 end

data/spec/lib/chamber/file_set_spec.rb

@@ -0,0 +1,212 @@
+require 'rspectacular'
+require 'chamber/file_set'
+require 'fileutils'
+
+
+class     Chamber
+describe  FileSet do
+  before(:each) { FileUtils.mkdir '/tmp/settings' unless ::File.exist? '/tmp/settings' }
+  after(:each)  { FileUtils.rm_rf '/tmp/settings' if     ::File.exist? '/tmp/settings' }
+
+  it 'can consider directories containing YAML files' do
+    ::File.new('/tmp/settings/some_settings_file.yml', 'w+')
+    ::File.new('/tmp/settings/another_settings_file.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings'
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings/another_settings_file.yml',
+                                         '/tmp/settings/some_settings_file.yml',
+                                       ]
+
+    ::FileUtils.rm_rf('/tmp/settings')
+  end
+
+  it 'can consider globs of files' do
+    ::File.new('/tmp/settings/some_settings_file.yml', 'w+')
+    ::File.new('/tmp/settings/another_settings_file.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings/*.yml'
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings/another_settings_file.yml',
+                                         '/tmp/settings/some_settings_file.yml',
+                                       ]
+
+    ::FileUtils.rm_rf('/tmp/settings')
+  end
+
+  it 'can consider namespaced files' do
+    ::File.new('/tmp/settings/settings-blue.yml', 'w+')
+
+    file_set = FileSet.new files:      '/tmp/settings/settings-blue.yml',
+                           namespaces: ['blue']
+
+    expect(file_set.filenames).to eql [
+                                        '/tmp/settings/settings-blue.yml'
+                                      ]
+
+    ::FileUtils.rm_f('/tmp/settings/settings-blue.yml')
+  end
+
+  it 'does not consider namespaced files which are not relevant' do
+    ::File.new('/tmp/settings/settings-blue.yml', 'w+')
+
+    file_set = FileSet.new files:      '/tmp/settings/settings-blue.yml',
+                           namespaces: ['green']
+
+    expect(file_set.filenames).to be_empty
+
+    ::FileUtils.rm_f('/tmp/settings/settings-blue.yml')
+  end
+
+  it 'removes any duplicate files' do
+    ::File.new('/tmp/settings.yml', 'w+')
+
+    file_set = FileSet.new files: [
+                                    '/tmp/settings.yml',
+                                    '/tmp/settings.yml',
+                                  ]
+
+    expect(file_set.filenames).to eql [
+                                        '/tmp/settings.yml'
+                                      ]
+
+    ::FileUtils.rm_f('/tmp/settings.yml')
+  end
+
+  it 'can consider multiple file paths' do
+    ::File.new('/tmp/settings.yml', 'w+')
+    ::File.new('/tmp/settings/new_file.yml', 'w+')
+
+    file_set = FileSet.new files: [
+                                    '/tmp/settings.yml',
+                                    '/tmp/settings/*.yml',
+                                  ]
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings.yml',
+                                         '/tmp/settings/new_file.yml',
+                                       ]
+
+    ::FileUtils.rm_rf('/tmp/settings*')
+  end
+
+  it 'can consider file paths as Pathnames' do
+    ::File.new('/tmp/settings.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings.yml'
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings.yml',
+                                       ]
+
+    ::FileUtils.rm_rf('/tmp/settings*')
+  end
+
+  it 'can consider multiple namespaced files in the order the namespaces are specified' do
+    ::File.new('/tmp/settings/settings-blue.yml', 'w+')
+    ::File.new('/tmp/settings/settings-green.yml', 'w+')
+
+    file_set = FileSet.new files:      '/tmp/settings/settings*.yml',
+                           namespaces: ['blue', 'green']
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings/settings-blue.yml',
+                                         '/tmp/settings/settings-green.yml',
+                                       ]
+
+    file_set = FileSet.new files:      '/tmp/settings/settings*.yml',
+                           namespaces: ['green', 'blue']
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings/settings-green.yml',
+                                         '/tmp/settings/settings-blue.yml',
+                                       ]
+
+    ::FileUtils.rm_f('/tmp/settings/settings*.yml')
+  end
+
+  it 'considers the generic file prior to any namespaced files' do
+    ::File.new('/tmp/settings.yml', 'w+')
+    ::File.new('/tmp/settings-blue.yml', 'w+')
+
+    file_set = FileSet.new files:      '/tmp/settings*.yml',
+                           namespaces: ['blue']
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings.yml',
+                                         '/tmp/settings-blue.yml',
+                                       ]
+
+    ::FileUtils.rm_f('/tmp/settings*.yml')
+  end
+
+  it 'considers the generic file prior to any namespaced files' do
+    ::File.new('/tmp/settings.yml', 'w+')
+    ::File.new('/tmp/settings-blue.yml', 'w+')
+
+    file_set = FileSet.new files:      '/tmp/settings*.yml',
+                           namespaces: ['blue']
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings.yml',
+                                         '/tmp/settings-blue.yml',
+                                       ]
+
+    ::FileUtils.rm_f('/tmp/settings*.yml')
+  end
+
+  it 'considers each glob independently, placing non-namespaced and namespaced versions of the globs files above those in subsequent globs' do
+    ::File.new('/tmp/settings/credentials-development.yml', 'w+')
+    ::File.new('/tmp/settings/settings.yml', 'w+')
+
+    file_set = FileSet.new files: ['/tmp/settings/credentials*.yml',
+                                   '/tmp/settings/settings*.yml'],
+                           namespaces: ['development']
+
+    expect(file_set.filenames).to eql [
+                                        '/tmp/settings/credentials-development.yml',
+                                        '/tmp/settings/settings.yml',
+                                      ]
+
+    ::FileUtils.rm_rf('/tmp/settings')
+  end
+
+  it 'can display the filenames which were considered for the settings values' do
+    ::File.new('/tmp/settings/some_settings_file.yml', 'w+')
+    ::File.new('/tmp/settings/another_settings_file.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings/*.yml'
+
+    expect(file_set.filenames).to eql  [
+                                         '/tmp/settings/another_settings_file.yml',
+                                         '/tmp/settings/some_settings_file.yml',
+                                       ]
+
+    ::FileUtils.rm_rf('/tmp/settings')
+  end
+
+  it "can yield each file's settings when converting" do
+    ::File.new('/tmp/settings.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings.yml'
+
+    file_set.to_settings do |settings|
+      expect(settings).to eql Settings.new
+    end
+
+    ::FileUtils.rm_f('/tmp/settings.yml')
+  end
+
+  it 'can convert settings without yielding to the block by using an intermediate settings object' do
+    ::File.new('/tmp/settings.yml', 'w+')
+
+    file_set = FileSet.new files: '/tmp/settings.yml'
+
+    expect(file_set.to_settings).to eql Settings.new
+
+    ::FileUtils.rm_f('/tmp/settings.yml')
+  end
+end
+end

data/spec/lib/chamber/file_spec.rb

@@ -0,0 +1,94 @@
+require 'rspectacular'
+require 'chamber/file'
+require 'chamber/settings'
+require 'tempfile'
+
+def create_tempfile_with_content(content)
+  tempfile = Tempfile.new('settings')
+  tempfile.puts content
+  tempfile.rewind
+  tempfile
+end
+
+class     Chamber
+describe  File do
+  it 'can convert file contents to settings' do
+    tempfile      = create_tempfile_with_content %Q({ test: settings })
+    settings_file = File.new path: tempfile.path
+
+    allow(Settings).to receive(:new).
+                       and_return :settings
+
+    file_settings = settings_file.to_settings
+
+    expect(file_settings).to  eql :settings
+    expect(Settings).to       have_received(:new).
+                              with(settings:    {'test' => 'settings'},
+                                   namespaces:  {})
+  end
+
+  it 'can convert a file whose contents are empty' do
+    tempfile      = create_tempfile_with_content ''
+    settings_file = File.new path: tempfile.path
+
+    allow(Settings).to receive(:new).
+                       and_return :settings
+
+    file_settings = settings_file.to_settings
+
+    expect(file_settings).to  eql :settings
+    expect(Settings).to       have_received(:new).
+                              with(settings:    {},
+                                   namespaces:  {})
+  end
+
+  it 'throws an error when the file contents are malformed' do
+    tempfile      = create_tempfile_with_content %Q({ test : )
+    settings_file = File.new path: tempfile.path
+
+    expect { settings_file.to_settings }.to raise_error
+  end
+
+  it 'passes any namespaces through to the settings' do
+    tempfile      = create_tempfile_with_content %Q({ test: settings })
+    settings_file = File.new  path:       tempfile.path,
+                              namespaces: {
+                                environment:  :development }
+
+    allow(Settings).to  receive(:new)
+
+    settings_file.to_settings
+
+    expect(Settings).to have_received(:new).
+                        with( settings:    {'test' => 'settings'},
+                              namespaces: {
+                                environment:  :development })
+  end
+
+  it 'can handle files which contain ERB markup' do
+    tempfile      = create_tempfile_with_content %Q({ test: <%= 1 + 1 %> })
+    settings_file = File.new  path: tempfile.path
+
+    allow(Settings).to      receive(:new)
+
+    settings_file.to_settings
+    expect(Settings).to have_received(:new).
+                        with( settings:   {'test' => 2},
+                              namespaces: {} )
+  end
+
+  it 'does not throw an error when attempting to convert a file which does not exist' do
+    settings_file = File.new path: 'no/path'
+
+    allow(Settings).to receive(:new).
+                       and_return :settings
+
+    file_settings = settings_file.to_settings
+
+    expect(file_settings).to  eql :settings
+    expect(Settings).to       have_received(:new).
+                              with(settings:    {},
+                                   namespaces:  {})
+  end
+end
+end