revenc 0.1.3 → 0.2.1

data/features/settings.feature

@@ -0,0 +1,119 @@
+@announce
+Feature: Configuration via yaml file
+
+  In order to configure options, as an interactive user or automated script,
+  the program should process configuration options via yaml. These options
+  should override hard coded defaults but not command line options.
+
+  Config files are read from multiple locations in order of priority.  Once a
+  config file is found, all other config files are ignored.
+
+  All command line options can be read from the config file from the "options:"
+  block. The "options" block is optional.
+
+  NOTE: All file system testing is done via the Aruba gem.  The home folder
+  config file is stubbed to prevent testing contamination in case it exists.
+
+
+  Scenario: Specified config file exists
+    Given an empty file named "config.conf"
+    When I run `revenc action --verbose --config config.conf`
+    Then the output should contain:
+      """
+      config file: config.conf
+      """
+
+  Scenario: Specified config file option but not given on command line
+    When I run `revenc action --verbose --config`
+    Then the exit status should be 1
+    And the output should contain:
+      """
+      missing argument: --config
+      """
+
+  Scenario: Specified config file not found
+    When I run `revenc path --verbose --config config.conf`
+    Then the exit status should be 1
+    And the output should contain:
+      """
+      config file not found
+      """
+
+ Scenario: Reading options from specified config file, ignoring the
+    default config file
+    Given a file named "revenc.conf" with:
+      """
+      ---
+      options:
+        coloring: true
+      """
+    And a file named "no_coloring.conf" with:
+      """
+      ---
+      options:
+        coloring: false
+      """
+    When I run `revenc action --verbose --config no_coloring.conf`
+    Then the output should contain:
+      """
+      :coloring=>false
+      """
+    And the output should not contain:
+      """
+      :coloring=>true
+      """
+
+  Scenario: Reading options from specified config file, ignoring the
+    default config file with override on command line
+    Given a file named "revenc.conf" with:
+      """
+      ---
+      options:
+        coloring: true
+      """
+    And a file named "no_coloring.conf" with:
+      """
+      ---
+      options:
+        coloring: false
+      """
+    When I run `revenc action --verbose --config no_coloring.conf --coloring`
+    Then the output should contain:
+      """
+      :coloring=>"AUTO"
+      """
+    And the output should not contain:
+      """
+      :coloring=>false
+      """
+    And the output should not contain:
+      """
+      :coloring=>true
+      """
+
+ Scenario: Reading options from config file with negative override on command line
+    And a file named "with_coloring.conf" with:
+      """
+      ---
+      options:
+        coloring: true
+      """
+    When I run `revenc action --verbose --config with_coloring.conf --no-coloring`
+    Then the output should contain:
+      """
+      :coloring=>false
+      """
+
+  Scenario: Reading text options from config file
+    Given a file named "with_always_coloring.conf" with:
+      """
+      ---
+      options:
+        coloring: ALWAYS
+      """
+    When I run `revenc action --verbose --config with_always_coloring.conf`
+    Then the output should contain:
+      """
+      :coloring=>"ALWAYS"
+      """
+

data/features/step_definitions/revenc_steps.rb

@@ -47,7 +47,7 @@
 When /^I run with a lock file present "(.*)"$/ do |cmd|
   lockfile = File.join(current_dir, 'revenc.lck')
   Mutagem::Mutex.new(lockfile).execute do
-    run(unescape(cmd), false)
+    run_simple(unescape(cmd), false)
   end
 end
 
@@ -62,4 +62,3 @@
   folder.exists?.should be_true
   folder.should_not be_empty
 end
-

data/features/support/aruba.rb

@@ -1,21 +1,21 @@
-require 'aruba'
+require 'aruba/api'
 require 'fileutils'
 
-APP_BIN_PATH = File.join(ENV['PWD'], 'bin', 'revenc')
+APP_BIN_PATH = File.join(FileUtils.pwd, 'bin', 'revenc')
 
 module Aruba
   module Api
 
-   alias_method :old_run, :run
+   alias_method :old_run_simple, :run_simple
+
+    # override aruba
+    def run_simple(cmd, fail_on_error=true)
 
-    # override aruba 
-    def run(cmd, fail_on_error=true)
-      
       # run development version in verbose mode
-      cmd = cmd.gsub(/^revenc/, "#{APP_BIN_PATH} --verbose")
+      cmd = cmd.gsub(/^revenc/, "ruby -S #{APP_BIN_PATH} --verbose")
 
-      # run original aruba 'run' 
-      old_run(cmd, fail_on_error)
+      # run original aruba 'run'
+      old_run_simple(cmd, fail_on_error)
     end
   end
 end

data/features/support/env.rb

@@ -1,4 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rubygems'
 require 'revenc'
-require 'aruba'
-require 'spec/expectations'
+require 'aruba/cucumber'
+require 'rspec/expectations'
+require File.expand_path(File.dirname(__FILE__) + '/../../spec/aruba_helper')
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/features/unmount.feature

@@ -14,21 +14,21 @@ Feature: Unmounting a reverse mounted encrypted folder using encfs
       """
       test
       """
-    And I successfully run "revenc mount unencrypted_source_folder encrypted_destination_folder"
-    
+    And I successfully run `revenc mount unencrypted_source_folder encrypted_destination_folder`
+
   Scenario: Successful unmount
-    When I run "revenc unmount encrypted_destination_folder"
+    When I run `revenc unmount encrypted_destination_folder`
     Then the exit status should be 0
     And the folder "encrypted_destination_folder" should not be mounted
-    
+
 
   Scenario: Successful unmount dry run
-    When I run "revenc --dry-run unmount encrypted_destination_folder"
+    When I run `revenc --dry-run unmount encrypted_destination_folder`
     Then the exit status should be 0
     And the folder "encrypted_destination_folder" should be mounted
 
   Scenario: Unmount folder not specified
-    When I run "revenc unmount"
+    When I run `revenc unmount`
     Then the exit status should be 1
     And the output should contain:
       """
@@ -37,7 +37,7 @@ Feature: Unmounting a reverse mounted encrypted folder using encfs
 
   Scenario: Unmount folder doesn't exist
     Given a directory named "encrypted_destination_folder"
-    When I run "revenc unmount unencrypted_source_folder"
+    When I run `revenc unmount unencrypted_source_folder`
     Then the exit status should be 1
     And the output should contain:
       """
@@ -50,7 +50,7 @@ Feature: Unmounting a reverse mounted encrypted folder using encfs
       unmount:
         executable: missing_bin_file
       """
-    When I run "revenc unmount unencrypted_source_folder"
+    When I run `revenc unmount unencrypted_source_folder`
     Then the exit status should be 1
     And the output should contain:
       """

data/lib/revenc.rb

@@ -1,6 +1,9 @@
 # require all files here
-require 'rubygems'
+require 'rbconfig'
+require 'revenc/core/hash'
+require 'revenc/core/array'
 require 'revenc/app'
+require 'revenc/settings'
 require 'revenc/io'
 require 'revenc/errors'
 require 'revenc/encfs_wrapper'
@@ -16,9 +19,15 @@ module Revenc
   def self.version
     version_info_file = File.join(File.dirname(__FILE__), *%w[.. VERSION])
     File.open(version_info_file, "r") do |f|
-      f.read
+      f.read.strip
     end
   end
- 
+
+  # Platform constants
+  unless defined?(Revenc::WINDOWS)
+    WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/i
+    CYGWIN = RbConfig::CONFIG['host_os'] =~ /cygwin/i
+  end
+
 end
 

data/lib/revenc/app.rb

@@ -1,4 +1,3 @@
-require 'configatron'
 require 'term/ansicolor'
 
 class String
@@ -11,21 +10,26 @@ module Revenc
 
   class App
 
-    def initialize(base_dir, options={})
-      @base_dir = base_dir
+    def initialize(working_dir, argv=[], options={})
+      @working_dir = working_dir
       @options = options
+      @argv = argv
       if @options[:verbose]
-        puts "base_dir: #{@base_dir}".cyan
+        puts "working_dir: #{@working_dir}".cyan
         puts "options: #{@options.inspect}".cyan
+        puts "base_dir: #{@options[:base_dir]}".cyan if @options[:base_dir]
+        puts "config file: #{@options[:config]}".cyan if @options[:config]
       end
-      configure(options)
+      $stdout.sync = true
     end
 
-    def run
+    def execute
       begin
 
         if action_argument_required?
-          action = ARGV.shift
+          action = @argv.shift
+          args = @argv
+
           unless AVAILABLE_ACTIONS.include?(action)
             if action.nil?
               puts "revenc action required"
@@ -35,9 +39,9 @@ def run
             puts "revenc --help for more information"
             exit 1
           end
-          puts "revenc run action: #{action}".cyan if @options[:verbose]
+          puts "revenc run action: #{action} #{args.join(' ')}".cyan if @options[:verbose]
           raise "action #{action} not implemented" unless respond_to?(action)
-          result = send(action)
+          result = send(action, args)
         else
           #
           # default action if action_argument_required? is false
@@ -45,7 +49,12 @@ def run
           result = 0
         end
 
-        exit(result ? 0 : 1)
+        if result.is_a?(Numeric)
+          exit(result)
+        else
+          # handle all other return types
+          exit(result ? 0 : 1)
+        end
 
       rescue SystemExit => e
         # This is the normal exit point, exit code from the send result
@@ -55,6 +64,7 @@ def run
       rescue Exception => e
         STDERR.puts("revenc command failed, error(s) follow:")
         STDERR.puts("#{e.message}".red)
+        STDERR.puts("Use '--verbose' for backtrace.") unless @options[:verbose]
         STDERR.puts(e.backtrace.join("\n")) if @options[:verbose]
         exit(1)
       end
@@ -65,18 +75,18 @@ def run
     #
     # TODO: Add status command, use encfsctl
 
-    def mount
-      EncfsWrapper.new(@base_dir, @options).mount(ARGV.shift, ARGV.shift)
+    def mount(args)
+      EncfsWrapper.new(@base_dir, @options).mount(args.shift, args.shift)
     end
 
-    def unmount
-      EncfsWrapper.new(@base_dir, @options).unmount(ARGV.shift)
+    def unmount(args)
+      EncfsWrapper.new(@base_dir, @options).unmount(args.shift)
     end
 
-    def copy
-      EncfsWrapper.new(@base_dir, @options).copy(ARGV.shift, ARGV.shift)
+    def copy(args)
+      EncfsWrapper.new(@base_dir, @options).copy(args.shift, args.shift)
     end
-    
+
     #
     # app commands end
     #
@@ -88,41 +98,5 @@ def action_argument_required?
       !AVAILABLE_ACTIONS.empty?
     end
 
-    # read options for YAML config with ERB processing and initialize configatron
-    def configure(options)
-      # TODO: read ~/.revenc.conf before looking in the current folder for revenc.conf, read BOTH files
-      config = @options[:config]
-      config = File.join(@base_dir, 'revenc.conf') unless config
-      if File.exists?(config)
-        # load configatron options from the config file
-        puts "loading config file: #{config}".cyan if @options[:verbose]
-        configatron.configure_from_yaml(config)
-      else
-        # user specified a config file?
-        raise "config file not found" if @options[:config]
-        # no error if user did not specify config file
-        puts "#{config} not found".yellow if @options[:verbose]
-      end
-      
-      # 
-      # set defaults, these will NOT override setting read from YAML
-      #
-      configatron.mount.source.set_default(:name, nil)
-      configatron.mount.mountpoint.set_default(:name, nil)
-      configatron.mount.passphrasefile.set_default(:name, 'passphrase')
-      configatron.mount.keyfile.set_default(:name, 'encfs6.xml')
-      configatron.mount.set_default(:cmd, nil)
-      configatron.mount.set_default(:executable, nil)
-
-      configatron.unmount.mountpoint.set_default(:name, nil)
-      configatron.unmount.set_default(:cmd, nil)
-      configatron.unmount.set_default(:executable, nil)
-
-      configatron.copy.source.set_default(:name, nil)
-      configatron.copy.destination.set_default(:name, nil)
-      configatron.copy.set_default(:cmd, nil)
-      configatron.copy.set_default(:executable, nil)
-    end
-
   end
 end

data/lib/revenc/core/array.rb

@@ -0,0 +1,11 @@
+class Array
+  def recursively_symbolize_keys!
+    self.each do |item|
+      if item.is_a? Hash
+        item.recursively_symbolize_keys!
+      elsif item.is_a? Array
+        item.recursively_symbolize_keys!
+      end
+    end
+  end
+end

data/lib/revenc/core/hash.rb

@@ -0,0 +1,45 @@
+class Hash
+
+  # sorted yaml
+  def to_yaml( opts = {} )
+    YAML::quick_emit( object_id, opts ) do |out|
+      out.map( taguri, to_yaml_style ) do |map|
+        sorted_keys = keys
+        sorted_keys = begin
+          sorted_keys.sort
+        rescue
+          sorted_keys.sort_by {|k| k.to_s} rescue sorted_keys
+        end
+
+        sorted_keys.each do |k|
+          map.add( k, fetch(k) )
+        end
+      end
+    end
+  end
+
+  # active_support hash key functions
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  def recursively_symbolize_keys!
+    self.symbolize_keys!
+    self.values.each do |v|
+      if v.is_a? Hash
+        v.recursively_symbolize_keys!
+      elsif v.is_a? Array
+        v.recursively_symbolize_keys!
+      end
+    end
+    self
+  end
+
+end