confswap 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bec574be3e75c3c3c48fc0d197b14950858589fa
-  data.tar.gz: 767d089e13677553e48d6794f396a531cec85a29
+  metadata.gz: 3f792ae191b624dc16a9c682d7076b4b4dd36991
+  data.tar.gz: a891d0741a8e1e6a3d0b27fa0cc624f063aa7b1e
 SHA512:
-  metadata.gz: 48becfecd91dabdb948fcbbdbaecc18da43c1c6f53e8677958c13007b74ab6d81cae3023ad5ef66e9acb20822b76625eda20e8baa089d697d5acfa2495ce1fcc
-  data.tar.gz: 8f45a1492502985c4dbe6a6373e833ac6997e67ab81066cbefe362423e87eaccce679621263012b139886cd7c05f0a42a51707403b440ffc17faeadde3a1e392
+  metadata.gz: 2236b56d692b3eb394c54619112dc9c35a244fb1410595521d2d116b74c5e9a815d9ac109f89f4442fc65fca858ca0867338894c8bc4ff0e248dd4fb0a08149e
+  data.tar.gz: f5e6573966e0135f9028c135a18defea9e61ff3de3b2ea49955a111d5f0317e157911fb4de2c6d3076126aaea921e802f4688f4d1a07b84687108668b3fef832

data/.gitignore

@@ -7,8 +7,11 @@ test.conf.out
 test.out
 test.txt
 test.txt.out
+test.yaml
 sample.properties
 pfile.txt
+your.conf
+spec/tmp/*
 
 ## Ignore Vim swp
 *.swp

data/README.md

@@ -22,7 +22,7 @@ lang=%{LANG}
 
 ### Environment Variables
 
-```confswap --output=sample1.conf sample1.template```
+```confswap -t sample1.template sample.conf
 
 will use the USER and LANG variables in your shell to populate the template.  You can use ``env`` to see your current environment variables.
 
@@ -30,11 +30,11 @@ additionally you can add additional variables to use, or overwrite extisting env
 
 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
+```confswap --envvar USER=something --envvar LANG=en_US.UTF-8 -t sample1.template sample2.conf 
 
 2. explicit setting:
 
-```USER=someoneelse LANG=en_IE.UTF-8 confswap --output=sample3.conf sample1.template```
+```USER=someoneelse LANG=en_IE.UTF-8 confswap -t sample1.template sample3.conf```
 
 ### Properties File
 
@@ -47,8 +47,21 @@ USER: anotherone
 
 Then read it using
 
-```confswap --output=sample3.conf -p sample.properties sample1.template```
+```confswap -p sample.properties -t sample1.template sample3.conf```
 
+You can also save templates as yaml files!
+
+Pass in variables as you would normally then choose to make a yaml file config
+
+```confswap -e test=giblets -e user=alsogiblets -e array='["1","3","4"]' --yaml your_conf.yaml```
+
+1. Note array must be passed as a json string)
+2. Also note that by default this will also save the environment variables currently saved in the shell, to ignore these, please use the ignore shell vars (-i) flag, i.e. 
+
+```confswap -e test=giblets -e user=alsogiblets -e array='["1","3","4"]' --ignore-shell-vars --force --yaml your_conf.yaml```
+
+
+should create a conf.yaml file with the environments
 
 ## Requirements
 
@@ -78,7 +91,14 @@ I originally used this approach but the script grew unwieldy, maybe I don't do g
 
 - ~~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
+- ~~verbose command~~ Version 0.0.5
+- ~~YAML~~ Version 0.1.0
+
+### Roadmap
+- JSON Version 0.1.1
+- improved logging 0.1.2
+
+- improve verbose messages
 - summary of what will change?  dry-run maybe?
 - diff on what has changed in a config if overwriting?
 - test command.rb

data/confswap.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'confswap'
-  s.version     = '0.0.5'
+  s.version     = '0.1.0'
   s.licenses    = ['APACHE2']
-  s.summary     = "Confswap swaps conf variables!"
-  s.description = "Create a configuration from a template using environment variables"
+  s.summary     = "Programmatic configuration file maker"
+  s.description = "Create configuration files from templates using environment variables or property lists.  Save as text, yaml and json"
   s.authors     = ["Tom Cowling"]
   s.email       = 'tom.cowling@gmail.com'
   s.homepage    = 'https://www.tlcowling.com/gems/confswap'

data/features/env_variable_should_overwrite_properties.feature

@@ -0,0 +1,31 @@
+Feature: Add environment variables with command line
+  Background: 
+    Given a file named "test.conf" with:
+      """
+      # This is a test config
+      # that has some variables in it
+      %{TEST}
+      %{USER}
+      """
+    And a file named "test.properties" with:
+      """
+      TEST: not giblets
+      USER: not alsogiblets
+      """
+  Scenario: Single environment variable
+    When I run `confswap -p test.properties -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:
+    """
+    giblets
+    """
+
+  Scenario: Multiple environment variable
+    When I run `confswap -p test.properties -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/save_conf_yaml.feature

@@ -0,0 +1,23 @@
+Feature: Create a yaml file from the variables passed to confswap
+  Scenario: Use default name for yaml
+    When I run `confswap -e TEST=giblets -e array=[1,2,3] --yaml --ignore-shell-vars`
+    Then a file named "your.conf" should exist
+    And the file "your.conf" should contain:
+    """
+    ---
+    TEST: giblets
+    array:
+    - 1
+    - 2
+    - 3
+    """
+
+  Scenario: Specify yaml file name and ignore persisted shell variables
+    When I run `confswap -e TEST=giblets -e USER=alsogiblets --ignore-shell-vars --yaml test.yaml`
+    Then a file named "test.yaml" should exist
+    And the file "test.yaml" should contain:
+    """
+    TEST: giblets
+    USER: alsogiblets
+    """
+

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.5
+    0.1.0
     """

data/lib/confswap.rb

@@ -1,4 +1,5 @@
 require 'confswap/env_reader'
 require 'confswap/conf_reader'
 require 'confswap/property_reader'
+require 'confswap/bash_parser'
 require 'confswap/version'

data/lib/confswap/bash_parser.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module Confswap
+  class BashParser
+    def self.parse_user_input user_input
+      parsed_input = {}
+      user_input.each { |k,v|
+        parsed_input[k.to_s] = self.parse v
+      }
+      parsed_input
+    end
+
+    def self.parse text
+      parsed_text = text
+      parsed_text = parse_as_array text if text.start_with? "["
+      parsed_text = parse_as_object text if text.start_with? "{"
+      parsed_text
+    end
+
+    private
+    def self.parse_as_array text
+      parse_as_json_string text
+    end
+
+    def self.parse_as_object text
+      parse_as_json_string text
+    end
+
+    def self.parse_as_json_string text
+      begin
+        return JSON.parse text
+      rescue JSON::ParserError
+        return text
+      end
+    end
+  end
+end

data/lib/confswap/command.rb

@@ -1,12 +1,12 @@
 require 'clamp'
 require 'confswap'
+require 'yaml'
 
 module Confswap
   class Command < Clamp::Command
 
-    @env_variables
-
     def initialize *args
+      @env_variables = {}
       super *args
     end
 
@@ -27,6 +27,11 @@ module Confswap
         return 0 
       end
 
+      if yaml?
+        save_as_yaml()
+        return 0
+      end
+
       if configuration_filename.nil?
         puts 'Specify a template file or use --help for usage information'
         return 0
@@ -41,19 +46,22 @@ module Confswap
       end
     end
 
-    def swap_config configuration_filename
-      output_filename_default = configuration_filename + '.out' if output_filename.nil?
-
-      configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
-      @env_variables = Confswap::EnvironmentVariableReader.read_variables
-
-      process_envvars() if envvars
+    def gather_variables
+      @env_variables = Confswap::EnvironmentVariableReader.read_variables unless ignore_persisted_shell_variables?
 
       if !property_file.nil? and File.exists? property_file
-        puts 'pfile specified'
         @env_variables = Confswap::PropertyFileVariableReader.read_variables_from_file property_file
         puts @env_variables
       end
+
+      process_envvars() if envvars
+    end
+
+    def swap_config configuration_filename
+      output_filename_default = configuration_filename + '.out' if output_filename.nil?
+
+      configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
+      gather_variables()
       
       begin
         output = configuration_template % @env_variables
@@ -86,6 +94,24 @@ module Confswap
       end
     end
 
+    def save_as_yaml
+      gather_variables()
+
+      @env_variables = parse_envvars()
+
+      output_filename_yaml = output_filename || 'conf.yaml'
+      puts "Writing #{output_filename_yaml}"
+      env_variables_yaml = @env_variables.to_yaml
+
+      write_file env_variables_yaml, output_filename_yaml
+    end
+
+    def parse_envvars
+      parsed_variables = Confswap::BashParser.parse_user_input @env_variables
+      puts "Interpreted user variables: #{parsed_variables}" if verbose?
+      parsed_variables
+    end
+
     def write_file output_file_contents, output_filename
       return File.write output_filename, output_file_contents unless File.exists? output_filename
       
@@ -103,6 +129,8 @@ module Confswap
     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 ['--verbose'], :flag, "Be more verbose"
+    option ['-i', '--ignore-shell-vars'], :flag, "Ignore persisted shell variables", :attribute_name => :ignore_persisted_shell_variables
+    option ['-y', '--yaml'], :flag, "Create yaml config from variables", :attribute_name => :yaml
     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.5'
+  VERSION = '0.1.0'
 end

data/spec/bash_parser_spec.rb

@@ -0,0 +1,54 @@
+require 'confswap/bash_parser'
+
+describe 'Confswap::BashParser' do
+  describe 'normal string' do
+    it 'should not try to parse a normal string' do
+      normal_string = Confswap::BashParser.parse 'normal_string'
+      expect(normal_string).to be_kind_of String
+      expect(normal_string).to_not be_nil
+    end
+  end
+  describe 'Parsing arrays' do
+    it 'should attempt to convert a string starting with a [ to a ruby array object' do
+      parsed_array = Confswap::BashParser.parse '[1,2,3,4]'
+      expect(parsed_array).to be_kind_of Array
+      expect(parsed_array).to eq([1,2,3,4])
+    end
+
+    it 'should leave unparseable array as a string' do
+      invalid_array_string = Confswap::BashParser.parse '[1,2'
+      expect(invalid_array_string).to be_kind_of String
+      expect(invalid_array_string).to eq("[1,2")
+    end
+  end
+
+  describe 'Ruby hash' do
+    it 'should attempt to convert a string starting with a { to a ruby hash, but leave as a string if not possible' do
+      parsed_array = Confswap::BashParser.parse '{"a": "1", "b": "2", "c": "3", "d": "4"}'
+      expect(parsed_array).to be_kind_of Hash
+      expect(parsed_array).to eq({"a" => "1", "b" => "2", "c" => "3", "d" => "4"})
+    end
+    it 'should leave unparseable object as string' do
+      parsed_array = Confswap::BashParser.parse '{a: 1, b: 2, c: 3, d:'
+      expect(parsed_array).to be_kind_of String
+      expect(parsed_array).to eq('{a: 1, b: 2, c: 3, d:')
+    end
+  end
+
+  describe 'Whole User Input' do
+    it 'should parse envvars and convert array strings and hash strings to ruby object' do
+      user_input = {
+        :ARRAY   => "[1,2,3,4]",
+        :TEST    => "test",
+        :OBJECT  => "{}",
+      }
+      parsed_input = Confswap::BashParser.parse_user_input user_input
+      expect(parsed_input).to be_kind_of Hash
+      expect(parsed_input).to eq({
+        "ARRAY"  => [1,2,3,4],
+        "TEST"   => "test",
+        "OBJECT" => {},
+      })
+    end
+  end
+end

data/spec/conf_reader_spec.rb

@@ -3,11 +3,11 @@ require_relative './spec_helper.rb'
 
 describe 'Confswap::ConfigFileReader' do
   before(:each) do
-    File.write('/tmp/test.txt', sample_config)
+    File.write(tmp_dir + '/test.txt', sample_config)
   end
 
   it 'should read the contents of a file specified' do 
-    expect(Confswap::ConfigurationFileReader.read '/tmp/test.txt').to eql(sample_config)
+    expect(Confswap::ConfigurationFileReader.read tmp_dir + '/test.txt').to eql(sample_config)
   end
 
   it 'should return nil if the file does not exist' do
@@ -15,6 +15,6 @@ describe 'Confswap::ConfigFileReader' do
   end
 
   after(:each) do
-    File.delete('/tmp/test.txt') if File.exists?('/tmp/test.txt')
+    File.delete(tmp_dir + '/test.txt') if File.exists?(tmp_dir + '/test.txt')
   end
 end

data/spec/property_reader_spec.rb

@@ -3,8 +3,8 @@ require 'confswap/property_reader'
 describe 'Confswap::PropertyFileVariableReader' do
   it 'should split only on first colon and extra newlines' do
     variables = "VAR1: 192.168.0.1\n\n\nVAR2: giblets\nVAR3: this should : : have: colons"
-    File.write 'tmp/property_vars', variables
-    vars = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/property_vars'
+    File.write tmp_dir + '/property_vars', variables
+    vars = Confswap::PropertyFileVariableReader.read_variables_from_file tmp_dir + '/property_vars'
 
     expect(vars).to be_instance_of Hash
     expect(vars.length).to equal(3)
@@ -18,8 +18,8 @@ describe 'Confswap::PropertyFileVariableReader' do
 
   it 'should ignore comments in a property file' do
     file_contents = "# this is a comment \nVAR1: 192.168.0.1\n\n\nVAR2: giblets\nVAR3: this should : : have: colons" 
-    File.write 'tmp/property_file_with_comments', file_contents
-    vars = Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/property_file_with_comments'
+    File.write tmp_dir + '/property_file_with_comments', file_contents
+    vars = Confswap::PropertyFileVariableReader.read_variables_from_file tmp_dir + '/property_file_with_comments'
     expect(vars.length).to eq(3)
     expect(vars).to eq({
       :VAR1 => '192.168.0.1',
@@ -30,17 +30,17 @@ describe 'Confswap::PropertyFileVariableReader' do
 
   it 'should warn for invalid property file when property file is empty' do
     file_contents = ""
-    File.write 'tmp/invalid_property_file', file_contents
+    File.write tmp_dir + '/invalid_property_file', file_contents
     expect {
-      Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/invalid_property_file'
+      Confswap::PropertyFileVariableReader.read_variables_from_file tmp_dir + '/invalid_property_file'
     }.to raise_exception Confswap::PropertyFileVariableReader::InvalidPropertyFileException
   end
 
   pending 'should warn for invalid property file when property file is invalid' do
     file_contents = "# this is a comment \nVAR1: "
-    File.write 'tmp/invalid_property_file', file_contents
+    File.write tmp_dir + '/invalid_property_file', file_contents
     expect {
-      Confswap::PropertyFileVariableReader.read_variables_from_file 'tmp/invalid_property_file'
+      Confswap::PropertyFileVariableReader.read_variables_from_file tmp_dir + '/invalid_property_file'
     }.to raise_exception Confswap::PropertyFileVariableReader::InvalidPropertyFileException
   end
 end

data/spec/spec_helper.rb

@@ -14,3 +14,7 @@ end
 def sample_variables
   { :ITEM1 => "localhost", :ITEM2 => "8.8.8.8", :ITEM3 => 1 }
 end
+
+def tmp_dir
+  File.expand_path(File.dirname(__FILE__)) + '/tmp'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confswap
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Tom Cowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Create a configuration from a template using environment variables
+description: Create configuration files from templates using environment variables
+  or property lists.  Save as text, yaml and json
 email: tom.cowling@gmail.com
 executables:
 - confswap
@@ -54,22 +55,27 @@ files:
 - Rakefile
 - bin/confswap
 - confswap.gemspec
+- features/env_variable_should_overwrite_properties.feature
 - features/pass_environment_variables_with_command_line.feature
 - features/property_file.feature
+- features/save_conf_yaml.feature
 - features/support/env.rb
 - features/support/hooks.rb
 - features/variable_replace.feature
 - features/version.feature
 - lib/confswap.rb
+- lib/confswap/bash_parser.rb
 - lib/confswap/command.rb
 - lib/confswap/conf_reader.rb
 - lib/confswap/env_reader.rb
 - lib/confswap/property_reader.rb
 - lib/confswap/version.rb
+- spec/bash_parser_spec.rb
 - spec/conf_reader_spec.rb
 - spec/env_reader_spec.rb
 - spec/property_reader_spec.rb
 - spec/spec_helper.rb
+- spec/tmp/.gitkeep
 homepage: https://www.tlcowling.com/gems/confswap
 licenses:
 - APACHE2
@@ -93,15 +99,19 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Confswap swaps conf variables!
+summary: Programmatic configuration file maker
 test_files:
+- features/env_variable_should_overwrite_properties.feature
 - features/pass_environment_variables_with_command_line.feature
 - features/property_file.feature
+- features/save_conf_yaml.feature
 - features/support/env.rb
 - features/support/hooks.rb
 - features/variable_replace.feature
 - features/version.feature
+- spec/bash_parser_spec.rb
 - spec/conf_reader_spec.rb
 - spec/env_reader_spec.rb
 - spec/property_reader_spec.rb
 - spec/spec_helper.rb
+- spec/tmp/.gitkeep