confswap 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf14a7b12e576ef8ed3a80def9604890cb741567
-  data.tar.gz: a2460ccf7e5e02b1759d2f549633529e849bab01
+  metadata.gz: bec574be3e75c3c3c48fc0d197b14950858589fa
+  data.tar.gz: 767d089e13677553e48d6794f396a531cec85a29
 SHA512:
-  metadata.gz: e3d8797cd327f6314d0bb4d529efac96be10e590f4fd59f81dd5b33f2ed9e99a3cd83385cb839cfa9c7e3130526f1695b89343d6242b330059d26fd55317ce9f
-  data.tar.gz: 93491351e0d1b33ad9c2ff34cb66211abd6fcaf442356c11b9876a0ad88066c3a2f24d5af0585c3f4af5c57c43b5f03e02be268f6119309d3e5e6c79d7815cab
+  metadata.gz: 48becfecd91dabdb948fcbbdbaecc18da43c1c6f53e8677958c13007b74ab6d81cae3023ad5ef66e9acb20822b76625eda20e8baa089d697d5acfa2495ce1fcc
+  data.tar.gz: 8f45a1492502985c4dbe6a6373e833ac6997e67ab81066cbefe362423e87eaccce679621263012b139886cd7c05f0a42a51707403b440ffc17faeadde3a1e392

data/README.md

@@ -1,8 +1,6 @@
 # confswap [![Build Status](https://travis-ci.org/tlcowling/confswap.svg?branch=master)](https://travis-ci.org/tlcowling/confswap) [![Dependency Status](https://gemnasium.com/tlcowling/confswap.svg)](https://gemnasium.com/tlcowling/confswap) [![Code Climate](https://codeclimate.com/github/tlcowling/confswap/badges/gpa.svg)](https://codeclimate.com/github/tlcowling/confswap) [![Gem Version](https://badge.fury.io/rb/confswap.svg)](http://badge.fury.io/rb/confswap)
 :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow:
 
-
-
 A simple command line tool to take a configuration file with template placeholders and replace those placeholders with environment variables.
 
 The variables can come explicitly from the command, or read from a properties file.
@@ -11,23 +9,50 @@ The variables can come explicitly from the command, or read from a properties fi
 
 Configuration files come in different shapes and forms, confswap doesn't care if its toml or yaml
 
+At the moment, you can run confswap in a few different ways.  By default it uses any environment varables that are available as it runs.
+
+So, given the following template
+
+```
+# sample1.template
+# Template to use environment variables
+user=%{USER}
+lang=%{LANG}
+```
+
+### Environment Variables
+
+```confswap --output=sample1.conf sample1.template```
+
+will use the USER and LANG variables in your shell to populate the template.  You can use ``env`` to see your current environment variables.
+
+additionally you can add additional variables to use, or overwrite extisting env variables during the running of the command via 
+
+1. The envvar flag (which takes multiple variables which must be separated by an = sign
+
+```confswap --output=sample2.conf --envvar USER=something --envvar LANG=en_US.UTF-8 sample1.template
+
+2. explicit setting:
+
+```USER=someoneelse LANG=en_IE.UTF-8 confswap --output=sample3.conf sample1.template```
+
+### Properties File
+
+You can specify a property file containing keys and values such as
 ```
-# example.conf|.toml|.yaml
+# sample.properties
 
-# This is a configuration file
+USER: anotherone
+```
 
-giblet_status=%{GIBLETS_STATUS}
-splenetic_juice_factor=%{SPLENETIC_JUICE_FACTOR}
-``` 
+Then read it using
 
-Then run confswap on the file
+```confswap --output=sample3.conf -p sample.properties sample1.template```
 
-confswap 
 
 ## Requirements
 
-Requires ruby version > 2.0
-Bundle install the gems
+Requires ruby version >= 2.0
 
 ## Developments
 
@@ -38,8 +63,12 @@ Get the dependencies
 
 Run the tests
 ``rake spec`` 
+``rake features``
 
 ## Thoughts?
+The point?
+
+I had the need to procedurally create configuration files when automating the deployment of particular services.
 
 Why not just use sed and replace in some kind of bash script?
 
@@ -47,12 +76,10 @@ I originally used this approach but the script grew unwieldy, maybe I don't do g
 
 ## Tasks to do and improvement ideas
 
-- ~~error message when config contains env variable that doesnt exist~~
-- ~~acceptance tests~~
-- Read config from properties file
+- ~~error message when config contains env variable that doesnt exist~~ Version 0.0.2
+- ~~Read config from properties file~~ Version 0.0.4
 - verbose command
 - summary of what will change?  dry-run maybe?
 - diff on what has changed in a config if overwriting?
 - test command.rb
-- document...
 

data/confswap.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'confswap'
-  s.version     = '0.0.4'
+  s.version     = '0.0.5'
   s.licenses    = ['APACHE2']
   s.summary     = "Confswap swaps conf variables!"
   s.description = "Create a configuration from a template using environment variables"

data/features/pass_environment_variables_with_command_line.feature

@@ -5,9 +5,10 @@ Feature: Add environment variables with command line
       # This is a test config
       # that has some variables in it
       %{TEST}
+      %{USER}
       """
   Scenario: Single environment variable
-    When I run `confswap -e TEST=giblets test.conf`
+    When I run `confswap -e TEST=giblets -t test.conf test.conf.out`
     Then a file named "test.conf.out" should exist
     And the file "test.conf.out" should contain:
     """
@@ -15,3 +16,11 @@ Feature: Add environment variables with command line
     """
 
   Scenario: Multiple environment variable
+    When I run `confswap -e TEST=giblets -e USER=alsogiblets -t test.conf test.conf.out`
+    Then a file named "test.conf.out" should exist
+    And the file "test.conf.out" should contain:
+    """
+    giblets
+    alsogiblets
+    """
+

data/features/property_file.feature

@@ -19,7 +19,7 @@ Feature: Confswap should read template variables from a properties file
       # This is a descriptive comment
       VAR3: so many giblets
       """
-    When I run `confswap -p sample.properties -o sample.conf config_template_for_properties.conf`
+    When I run `confswap -p sample.properties -t config_template_for_properties.conf sample.conf`
     Then a file named "sample.conf" should exist
     And the file "sample.conf" should contain:
     """

data/features/variable_replace.feature

@@ -1,6 +1,6 @@
 Feature: Confswap should replace variables in config template with environment variables
   Background:
-    Given a file named "test.conf" with:
+    Given a file named "config.template" with:
     """
     # This is a test config
     # that has some variables in it
@@ -11,16 +11,9 @@ Feature: Confswap should replace variables in config template with environment v
       | TEST           | giblets  |
 
   Scenario: Config file should be created with a default name and contain environment variables
-    When I run `confswap test.conf`
-    Then a file named "test.conf.out" should exist
-    And the file "test.conf.out" should contain:
-    """
-    giblets
-    """
-  Scenario: Config file should be created with a specific name and contain environment variables
-    When I run `confswap --output=named.conf test.conf`
-    Then a file named "named.conf" should exist
-    And the file "named.conf" should contain:
+    When I run `confswap -t config.template config.template.out`
+    Then a file named "config.template.out" should exist
+    And the file "config.template.out" should contain:
     """
     giblets
     """
@@ -29,6 +22,6 @@ Feature: Confswap should replace variables in config template with environment v
     """
     # This is an exising config 
     """
-    When I run `confswap --output=existing.conf test.conf`
+    When I run `confswap -t config.template existing.conf`
     Then a file named "existing.conf" should exist
 

data/features/version.feature

@@ -3,5 +3,5 @@ Feature: See what version of confswap you're running
     Given I run `confswap --version` 
     Then the output should contain:
     """
-    0.0.4
+    0.0.5
     """

data/lib/confswap/command.rb

@@ -4,11 +4,13 @@ require 'confswap'
 module Confswap
   class Command < Clamp::Command
 
+    @env_variables
+
     def initialize *args
       super *args
     end
 
-    def help(*args)
+    def help *args
       return [
         "This is confswap version #{Confswap::VERSION}",
         super
@@ -43,37 +45,18 @@ module Confswap
       output_filename_default = configuration_filename + '.out' if output_filename.nil?
 
       configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
-      env_variables = Confswap::EnvironmentVariableReader.read_variables
-
-      if envvars
-        envvars.each {|envvar|
-          key_and_value = envvar.split(/=/, 2)
-          key = key_and_value.first
-          value = key_and_value.last
-          if key_and_value.count != 2
-            puts "Invalid envvar specified #{key} and #{value}"
-            return 1 
-          end
-
-          env_variables[key.to_sym]=value
-        }   
-
-        if verbose?
-          puts "Environment variables:"
-          env_variables.each { |var|
-            puts "#{var.first} = #{var.last}"
-          }
-        end
-      end
+      @env_variables = Confswap::EnvironmentVariableReader.read_variables
+
+      process_envvars() if envvars
 
       if !property_file.nil? and File.exists? property_file
         puts 'pfile specified'
-        env_variables = Confswap::PropertyFileVariableReader.read_variables_from_file property_file
-        p env_variables
+        @env_variables = Confswap::PropertyFileVariableReader.read_variables_from_file property_file
+        puts @env_variables
       end
       
       begin
-        output = configuration_template % env_variables
+        output = configuration_template % @env_variables
       rescue KeyError => error
         puts "#{error.message}.  Your configuration requires this variable, but no environment variable was found or specified."
         exit(1)
@@ -82,6 +65,27 @@ module Confswap
       write_file output, output_filename || output_filename_default
     end
 
+    def process_envvars
+      envvars.each { |envvar|
+        key_and_value = envvar.split(/=/, 2)
+        key = key_and_value.first
+        value = key_and_value.last
+        if key_and_value.count != 2
+          puts "Invalid envvar specified #{key} and #{value}"
+          return 1
+        end
+
+        @env_variables[key.to_sym]=value
+      }
+
+      if verbose?
+        puts "Environment variables:"
+        @env_variables.each { |var|
+          puts "#{var.first} = #{var.last}"
+        }
+      end
+    end
+
     def write_file output_file_contents, output_filename
       return File.write output_filename, output_file_contents unless File.exists? output_filename
       
@@ -93,12 +97,12 @@ module Confswap
       end
     end
 
+    option ['-t', '--template'], "TEMPLATE PATH", 'The path to the configuration template', :attribute_name => :configuration_filename
     option ['-p', '--property-file'], "FILE PATH", 'A path to a property file to use for your template variables', :attribute_name => :property_file
-    option ['-e', '--envvar'], "VARIABLE", 'Specify one or more additional environment variables', :multivalued => true, :attribute_name => :envvars
+    option ['-e', '--envvar'], "VARIABLE", 'Specify one or more additional environment variables in the form KEY=VALUE', :multivalued => true, :attribute_name => :envvars
     option ['-f','--force'], :flag, "Overwrite file if it already exists", :attribute_name => :force
     option ['-v', '--version'], :flag, "The version of confswap you are running", :attribute_name => :version
-    option ['-o', '--output'], "FILE PATH", "Specifies the filepath for the file", :attribute_name => :output_filename
     option ['--verbose'], :flag, "Be more verbose"
-    parameter "[TEMPLATE_FILE]", "Path to the configuration file", :attribute_name => :configuration_filename
+    parameter "[OUTPUT FILE]", "Path to the configuration file", :attribute_name => :output_filename, :default => "your.conf"
   end
 end

data/lib/confswap/version.rb

@@ -1,3 +1,3 @@
 module Confswap
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confswap
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tom Cowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp