rsync_config 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cd270330ad8254f82aad7aac5675aa8f4307634
-  data.tar.gz: df548daca589d99d58be213addb1fbb901e10496
+  metadata.gz: b29bfb0dc6303bd3346df954749f4bfb1d4efe23
+  data.tar.gz: 9f0fdb8d6d7e5c73be5661e9e44f4d99369a2309
 SHA512:
-  metadata.gz: ed121211361350f2146251f007d5585499809817aed4c6b8ba2523f268010b50767fb85db35365e055797ee21029273c809d0f8ca6ea008be07bfc588438d928
-  data.tar.gz: 268c974d7e770e068874b69dc665f3559c797fc9896ce80a48c33c29bdc39022866b0da47ada0731642e53775e219cb1c5f92d35a79db79c7fd683996639ebeb
+  metadata.gz: 8e8ff54c7e1a056eec4a465547dc2ab372aa8afd8ba222205737fcc2584c55dd0baab16736e2fd90ea81cdee00dc8fda2c593c5317e16b1bcc7d1184bd41ccce
+  data.tar.gz: fab92e104a5bab0288a1d8866af30342698d81b064afdb183f446898d345cf6094eb6f443c44bffa5b3b8978ed6969502f29badb4976181213ce102b75709761

data/README.md

@@ -79,6 +79,25 @@ This method will automatically try to write the secrets files when defined.
 For a raw String output, just call `RsyncConfig::Config#to_config_file` instead.
 Note that this method will not return the content of the secrets file (not sure if this will be useful).
 
+### Secrets files
+
+Starting with version 0.2.0, it is possible to create secrets files entries using the `RsyncConfig::SecretsFile` class.
+It allows to generate a file in a specific location that actually does not match the content of the entry in the config file itself.
+This is particularly useful in the case of symlinks.
+
+```ruby
+config = RsyncConfig::Config.new
+config.users = {'alice' => 'wonder'}
+config['secrets file'] = RsyncConfig::SecretsFile(
+  '/myapplication/1.0/rsyncd.secrets',
+  value: '/etc/rsyncd.secrets'
+)
+```
+
+`RsyncConfig::SecretsFile` accepts the physical output path as first parameter.
+The `value` parameter is optional (but most likely desired) and defines the value that 
+will be used to generate the config file.
+
 ### Limitations
 
 - currently the gem does not process the directives `&include` and `&merge`.

data/lib/rsync_config.rb

@@ -1,6 +1,8 @@
 require 'polyglot'
 require 'treetop'
 require 'rsync_config/version'
+require 'rsync_config/config_entry'
+require 'rsync_config/secrets_file'
 require 'rsync_config/parser'
 require 'rsync_config/propertiable'
 require 'rsync_config/user_management'

data/lib/rsync_config/config_entry.rb

@@ -0,0 +1,4 @@
+module RsyncConfig
+  module ConfigEntry
+  end
+end

data/lib/rsync_config/propertiable.rb

@@ -48,13 +48,15 @@ module RsyncConfig
       key = sanitize_key(key)
       if value.nil?
         properties.delete key
+      elsif value.is_a? ConfigEntry
+        properties[key] = value
       else
-        properties[key] = value.to_s unless value.nil?
+        properties[key] = value.to_s
       end
     end
 
     def properties_to_a
-      properties.map { |key, value| "#{key} = #{value}" }
+      properties.map { |key, value| "#{key} = #{value.to_s}" }
     end
 
     private 

data/lib/rsync_config/secrets_file.rb

@@ -0,0 +1,23 @@
+module RsyncConfig
+  class SecretsFile
+
+    include ConfigEntry
+
+    attr_accessor :value, :output
+
+    def initialize(output, **options)
+      raise "output cannot be nil or empty" if output.nil? || output.empty?
+
+      self.output = output
+      self.value = options[:value] if options[:value]
+    end
+
+    def value
+      @value.nil? ? output : @value
+    end
+
+    def to_s
+      value
+    end
+  end
+end

data/lib/rsync_config/user_management.rb

@@ -48,8 +48,11 @@ module RsyncConfig
       end 
     end
 
-    def write_secrets_file(file)
-      return if file.nil?
+    def write_secrets_file(secrets_file)
+      return if secrets_file.nil?
+
+      file = secrets_file.respond_to?(:output) ? secrets_file.output : secrets_file.to_s
+
       raise "Cannot write secrets file #{file}" if File.exists?(file) && ! File.writable?(file)
       raise "Cannot create secrets file #{file}" if !File.exist?(file) && ! ( Dir.exists?(File.dirname(file)) && File.writable?(File.dirname(file)))
 

data/lib/rsync_config/version.rb

@@ -1,3 +1,3 @@
 module RsyncConfig
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/rsync_config.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "debugger"
 	
 	spec.add_dependency 'treetop', '~>1.4.14'
 end

data/test/test_rsync_config.rb

@@ -6,7 +6,6 @@ class RsyncConfigTest < Test::Unit::TestCase
   TEST_INPUT_FILE = File.join(__dir__, 'etc', 'rsyncd.conf')
 
   TEST_INPUT_FILE_WITH_SECRETS = File.join(__dir__, 'etc', 'rsyncd_with_secrets.conf')
-
   TEST_OUTPUT_FILE = File.join(__dir__, 'etc', 'out', 'rsyncd.conf')
 
   TEST_SECRETS_FILE = File.join(__dir__, 'etc', 'out', 'secrets.conf')
@@ -257,4 +256,23 @@ EOL
       RsyncConfig.parse content
     end
   end
+
+  def test_using_a_secrets_file_object_outputs_to_different_file
+    config = RsyncConfig::Config.new
+    config.users = {
+      'john' => 'doe'
+    }
+    secrets_output_config = "#{TEST_SECRETS_FILE}.config_value"
+    config['secrets file'] = RsyncConfig::SecretsFile.new(
+      TEST_SECRETS_FILE,
+      value: secrets_output_config
+    )
+
+    config.write_to TEST_OUTPUT_FILE
+    assert File.exists? TEST_SECRETS_FILE
+    assert_false File.exists? secrets_output_config
+    assert_equal secrets_output_config, config['secrets file'].to_s
+
+    File.unlink secrets_output_config if File.exists? secrets_output_config
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsync_config
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillaume Bodi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
@@ -80,12 +94,14 @@ files:
 - Rakefile
 - lib/rsync_config.rb
 - lib/rsync_config/config.rb
+- lib/rsync_config/config_entry.rb
 - lib/rsync_config/module.rb
 - lib/rsync_config/parser.rb
 - lib/rsync_config/parser/config_file.treetop
 - lib/rsync_config/parser/node_extension.rb
 - lib/rsync_config/parser/secrets_file.treetop
 - lib/rsync_config/propertiable.rb
+- lib/rsync_config/secrets_file.rb
 - lib/rsync_config/user_management.rb
 - lib/rsync_config/version.rb
 - rsync_config.gemspec