revenc 0.1.3 → 0.2.1

data/lib/revenc/encfs_wrapper.rb

@@ -9,21 +9,18 @@ def initialize(base_dir, options)
     end
 
     def mount(source=nil, mount_point_folder=nil)
+      mount_point_options = @options || {}
+      mount_point_options = mount_point_options.merge(@options[:mount].dup) if @options[:mount]
 
       # add params from config file if not specified
-      source = configatron.mount.source.name unless source
-      mount_point_folder = configatron.mount.mountpoint.name unless mount_point_folder
+      source = (mount_point_options[:source] ? mount_point_options[:source][:name] : nil) unless source
+      mount_point_folder = (mount_point_options[:mountpoint] ? mount_point_options[:mountpoint][:name] : nil) unless mount_point_folder
 
       # sanity check params
       raise "source folder not specified" unless source
       raise "mountpoint not specified" unless mount_point_folder
 
-      mount_point_options = @options.merge(:passphrasefile => configatron.mount.passphrasefile.name)
-      mount_point_options = mount_point_options.merge(:keyfile => configatron.mount.keyfile.name)
-      mount_point_options = mount_point_options.merge(:cmd => configatron.mount.cmd) if configatron.mount.cmd
-      mount_point_options = mount_point_options.merge(:executable => configatron.mount.executable) if configatron.mount.executable
-
-      mount_point = MountPoint.new(mount_point_folder, source, mount_point_options)
+      mount_point = MountPoint.new(mount_point_folder, source, mount_point_options.merge(@options))
 
       if @options[:verbose]
         puts "mount: source=#{mount_point.source.name}".cyan
@@ -38,18 +35,18 @@ def mount(source=nil, mount_point_folder=nil)
     end
 
     def unmount(foldername = nil)
-      
+      unmount_point_options = @options || {}
+      unmount_point_options = unmount_point_options.merge(@options[:unmount].dup) if @options[:unmount]
+      mount_point_options = @options[:mount] ? @options[:mount].dup : {}
+
       # add param from config file if not specified, try specific unmount
-      foldername = configatron.unmount.mountpoint.name unless foldername
+      foldername = (unmount_point_options[:mountpoint] ? unmount_point_options[:mountpoint][:name] : nil) unless foldername
       # fallback to mount.mountpoint if specified
-      foldername = configatron.mount.mountpoint.name unless foldername
-      
+      foldername = (mount_point_options[:mountpoint] ? mount_point_options[:mountpoint][:name] : nil) unless foldername
+
       # sanity check params
       raise "mountpoint not specified" unless foldername
 
-      unmount_point_options = @options || {}
-      unmount_point_options = unmount_point_options.merge(:cmd => configatron.unmount.cmd) if configatron.umount.cmd
-      unmount_point_options = unmount_point_options.merge(:executable => configatron.unmount.executable) if configatron.umount.executable
       unmount_point = UnmountPoint.new(foldername, unmount_point_options)
 
       if @options[:verbose]
@@ -62,23 +59,22 @@ def unmount(foldername = nil)
     end
 
     def copy(source=nil, destination=nil)
+      copy_options = @options || {}
+      copy_options = copy_options.merge(@options[:copy].dup) if @options[:copy]
+      mount_point_options = @options[:mount] ? @options[:mount].dup : {}
 
       # add params from config file if not specified
-      source = configatron.copy.source.name unless source
+      source = (copy_options[:source] ? copy_options[:source][:name] : nil) unless source
       # fallback
-      source = configatron.mount.mountpoint.name unless source
-      destination = configatron.copy.destination.name unless destination
+      source = (mount_point_options[:mountpoint] ? mount_point_options[:mountpoint][:name] : nil) unless source
+      destination = (copy_options[:destination] ? copy_options[:destination][:name] : nil)  unless destination
 
       # sanity check params
       raise "source folder not specified" unless source
       raise "destination not specified" unless destination
 
-      copy_options = @options || {}
-      copy_options = copy_options.merge(:cmd => configatron.copy.cmd) if configatron.copy.cmd
-      copy_options = copy_options.merge(:executable => configatron.copy.executable) if configatron.copy.executable
-      copy_options = copy_options.merge(:mountpoint => configatron.mount.mountpoint.name) if configatron.mount.mountpoint.name
-
-      copy_folder = CopySourceFolder.new( source, destination, copy_options)
+      copy_options = copy_options.merge(:mountpoint => mount_point_options[:mountpoint][:name]) if mount_point_options[:mountpoint]
+      copy_folder = CopySourceFolder.new(source, destination, copy_options)
 
       if @options[:verbose]
         puts "copy: source=#{copy_folder.name}".cyan

data/lib/revenc/errors.rb

@@ -20,7 +20,7 @@ def add(error_on, message = "Unknown error")
        error_on_str = error_on_str.gsub(/_/, ' ')
        error_on_str = error_on_str.gsub(/^revenc/, '').strip
        #error_on_str = error_on_str.capitalize
-       
+
        @errors[error_on_str] ||= []
        @errors[error_on_str] << message.to_s
     end
@@ -28,7 +28,7 @@ def add(error_on, message = "Unknown error")
     def empty?
       @errors.empty?
     end
- 
+
     def clear
       @errors = {}
     end
@@ -40,7 +40,7 @@ def each
     def size
       @errors.values.inject(0) { |error_count, attribute| error_count + attribute.size }
     end
- 
+
     alias_method :count, :size
     alias_method :length, :size
 

data/lib/revenc/io.rb

@@ -1,4 +1,5 @@
 require 'mutagem'
+require 'erb'
 
 module Revenc
 
@@ -61,7 +62,6 @@ def system_cmd(cmd=nil)
       system cmd
     end
 
-    # Runs the YAML file through ERB
     def render(value, b = binding)
       ERB.new(value).result(b)
     end
@@ -91,7 +91,7 @@ def empty?
       contents = nil
       File.open(@name, "r") do |f|
         contents = f.read
-      end 
+      end
       contents.empty?
     end
 
@@ -108,7 +108,7 @@ def initialize(name='passphrase', options={})
     end
 
     def validate
-      super 
+      super
       errors.add(self, "is empty") if empty?
     end
   end
@@ -120,7 +120,7 @@ def initialize(name='encfs6.xml', options={})
     end
 
     def validate
-      super 
+      super
       errors.add(self, "is empty") if exists? && empty?
     end
   end
@@ -155,8 +155,8 @@ class ActionFolder < FileFolder
 
     def initialize(name=nil, options={})
       super
-      @passphrasefile = PassphraseFile.new(options[:passphrasefile])
-      @keyfile = KeyFile.new(options[:keyfile])
+      @passphrasefile = PassphraseFile.new(options[:passphrasefile] ? options[:passphrasefile][:name] : nil)
+      @keyfile = KeyFile.new(options[:keyfile] ? options[:keyfile][:name] : nil)
       @cmd = options[:cmd]
       @executable = options[:executable]
     end
@@ -177,17 +177,17 @@ def executable
     # run the action if valid and return true if successful
     def execute
       raise errors.to_sentences unless valid?
-      
+
       # default failing command
       result = false
-      
+
       # protect command from recursion
       mutex = Mutagem::Mutex.new('revenc.lck')
-      lock_sucessful = mutex.execute do
+      lock_successful = mutex.execute do
         result = system_cmd(cmd)
       end
-      
-      raise "action failed, lock file present" unless lock_sucessful
+
+      raise "action failed, lock file present" unless lock_successful
       result
     end
   end
@@ -225,7 +225,7 @@ def initialize(name=nil, options={})
       @cmd = options[:cmd] || "<%= executable %> -u <%= mountpoint.name %>"
       @executable = options[:executable] || 'fusermount'
     end
-    
+
     # allow clarity in config files, instead of <%= name %> you can use <%= mountpoint.name %>
     def mountpoint
       self
@@ -247,7 +247,7 @@ def initialize(name=nil, destination_name=nil, options={})
       @cmd = options[:cmd] || "<%= executable %> -r <%= source.name %> <%= destination.name %>"
       @executable = options[:executable] || 'cp'
     end
-    
+
     # allow clarity in config files, instead of <%= name %> you can use <%= source.name %>
     def source
       self

data/lib/revenc/settings.rb

@@ -0,0 +1,98 @@
+require 'yaml'
+
+module Revenc
+
+  class Settings
+
+    def initialize(working_dir, options={})
+      @working_dir = working_dir
+      @options = options
+      configure
+    end
+
+    def options
+      @options
+    end
+
+  private
+
+    # read options from YAML config
+    def configure
+
+      # config file default options
+      configuration = {
+                        :options => {
+                          :verbose => false,
+                          :coloring => 'AUTO'
+                        },
+                        :mount => {
+                          :source => {
+                            :name => nil
+                          },
+                          :mountpoint => {
+                            :name => nil
+                          },
+                          :passphrasefile => {
+                            :name => 'passphrase'
+                          },
+                          :keyfile => {
+                            :name => 'encfs6.xml'
+                          },
+                          :cmd => nil,
+                          :executable => nil
+                        },
+                        :unmount => {
+                          :mountpoint => {
+                            :name => nil
+                          },
+                          :cmd => nil,
+                          :executable => nil
+                        },
+                        :copy => {
+                          :source => {
+                            :name => nil
+                          },
+                          :destination => {
+                            :name => nil
+                          },
+                          :cmd => nil,
+                          :executable => nil
+                        }
+                      }
+
+      # set default config if not given on command line
+      config = @options[:config]
+      unless config
+        config = [
+                   File.join(@working_dir, "revenc.conf"),
+                   File.join(@working_dir, ".revenc.conf"),
+                   File.join(@working_dir, "config", "revenc.conf"),
+                   File.expand_path(File.join("~", ".revenc.conf"))
+                 ].detect { |filename| File.exists?(filename) }
+      end
+
+      if config && File.exists?(config)
+        # rewrite options full path for config for later use
+        @options[:config] = config
+
+        # load options from the config file, overwriting hard-coded defaults
+        config_contents = YAML::load(File.open(config))
+        configuration.merge!(config_contents.symbolize_keys!) if config_contents && config_contents.is_a?(Hash)
+      else
+        # user specified a config file?, no error if user did not specify config file
+        raise "config file not found" if @options[:config]
+      end
+
+      # the command line options override options read from the config file
+      @options = configuration[:options].merge!(@options)
+      @options.symbolize_keys!
+
+      # mount, unmount and copy configuration hashes
+      @options[:mount] = configuration[:mount].recursively_symbolize_keys! if configuration[:mount]
+      @options[:unmount] = configuration[:unmount].recursively_symbolize_keys! if configuration[:unmount]
+      @options[:copy] = configuration[:copy].recursively_symbolize_keys! if configuration[:copy]
+    end
+
+  end
+
+end

data/revenc.gemspec

@@ -1,10 +1,25 @@
 # -*- encoding: utf-8 -*-
 #
 #
-
 Gem::Specification.new do |s|
+
+  # avoid shelling out to run git every time the gemspec is evaluated
+  #
+  # @see spec/gemspec_spec.rb
+  #
+  gemfiles_cache = File.join(File.dirname(__FILE__), '.gemfiles')
+  if File.exists?(gemfiles_cache)
+    gemfiles = File.open(gemfiles_cache, "r") {|f| f.read}
+    # normalize EOL
+    gemfiles.gsub!(/\r\n/, "\n")
+  else
+    # .gemfiles missing, run 'rake gemfiles' to create it
+    # falling back to 'git ls-files'"
+    gemfiles = `git ls-files`
+  end
+
   s.name        = "revenc"
-  s.version     = File.open(File.join(File.dirname(__FILE__), *%w[VERSION]), "r") { |f| f.read } 
+  s.version     = File.open(File.join(File.dirname(__FILE__), 'VERSION'), "r") { |f| f.read }
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Robert Wahler"]
   s.email       = ["robert@gearheadforhire.com"]
@@ -17,26 +32,22 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'mutagem', '>= 0.1.3'
   s.add_dependency 'term-ansicolor', '>= 1.0.4'
-  s.add_dependency 'configatron', '>= 2.5.1'
 
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rspec", ">= 1.2.9"
-  s.add_development_dependency "cucumber", ">= 0.6"
-  s.add_development_dependency "aruba", ">= 0.2.0"
+  s.add_development_dependency "bundler", ">= 1.0.14"
+  s.add_development_dependency "rspec", ">= 2.6.0"
+  s.add_development_dependency "cucumber", "~> 1.0"
+  s.add_development_dependency "aruba", "~> 0.4.2"
   s.add_development_dependency "rake", ">= 0.8.7"
-  s.add_development_dependency "yard", ">= 0.6.1"
-  s.add_development_dependency "rdiscount", ">= 1.6.5"
 
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_path = 'lib'
+  s.files        = gemfiles.split("\n")
+  s.executables  = gemfiles.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_paths = ["lib"]
 
   s.has_rdoc = 'yard'
-  s.rdoc_options     = [ 
-                         '--title', 'Revenc Documentation', 
-                         '--main', 'README.markdown', 
+  s.rdoc_options     = [
+                         '--title', 'Revenc Documentation',
+                         '--main', 'README.markdown',
                          '--line-numbers',
-                         '--inline-source' 
+                         '--inline-source'
                        ]
 end

data/spec/aruba_helper.rb

@@ -0,0 +1,25 @@
+module Aruba
+  module Api
+
+    # @return full path to files in the aruba tmp folder
+    def fullpath(filename)
+      path = File.expand_path(File.join(current_dir, filename))
+      if path.match(/^\/cygdrive/)
+        # match /cygdrive/c/path/to and return c:\\path\\to
+        path = `cygpath -w #{path}`.chomp
+      elsif path.match(/.\:/)
+        # match c:/path/to and return c:\\path\\to
+        path = path.gsub(/\//, '\\')
+      end
+      path
+    end
+
+    # @return the contents of "filename" in the aruba tmp folder
+    def get_file_contents(filename)
+      in_current_dir do
+        IO.read(filename)
+      end
+    end
+
+  end
+end

data/spec/basic_app/array_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Array do
+
+  describe 'recursively_symbolize_keys!' do
+
+    it "should recursively convert a hash with string keys to a hash with symbol keys" do
+      hash_symbols = {
+                        :options => {
+                          :verbose => false,
+                        },
+                          :repos => {
+                             :repo1 => {:path => "something"}
+                        }
+                      }
+
+      hash_strings = {
+                        'options' => {
+                          'verbose' => false,
+                        },
+                          'repos' => {
+                             'repo1' => {'path' => "something"}
+                        }
+                      }
+
+      hash_symbols.should == hash_strings.recursively_symbolize_keys!
+    end
+
+    it "should should handle hashes that are already symbolized" do
+      hash_symbols = {
+                        :options => {
+                          :verbose => false,
+                        },
+                          :repos => {
+                             :repo1 => {:path => "something"}
+                        }
+                      }
+
+      hash_copy = hash_symbols.dup
+
+      hash_copy.should == hash_symbols.recursively_symbolize_keys!
+      hash_symbols[:repos][:repo1].should == {:path => "something"}
+    end
+
+  end
+
+end
+

data/spec/basic_gem/aruba_helper_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Revenc  do
+
+  before(:each) do
+    @filename = 'input.txt'
+    write_file(@filename, "the quick brown fox")
+  end
+
+  describe 'Aruba::API.current_dir' do
+
+    it "should return the current dir as 'tmp/aruba'" do
+      current_dir.should match(/^tmp\/aruba$/)
+    end
+  end
+
+  describe "aruba_helper fullpath('input.txt')" do
+
+    it "should return a valid expanded path to 'input.txt'" do
+      path = fullpath('input.txt')
+      path.should match(/tmp..*aruba/)
+      File.exists?(path).should == true
+    end
+  end
+
+  describe "aruba_helper get_file_contents('input.txt')" do
+
+    it "should return the contents of 'input.txt' as a String" do
+      get_file_contents('input.txt').should == 'the quick brown fox'
+    end
+  end
+
+end