revenc 0.1.2 → 0.1.3

data/.gitignore

@@ -1,30 +1,10 @@
-## mac os
-.DS_Store
-
-## textmate
-*.tmproj
-tmtags
-
-## emacs
-*~
-\#*
-.\#*
-
-## vim
-*.swp
-
-## project::general
+pkg/*
+*.gem
+.bundle
 coverage
 rdoc
-pkg
-*.gemspec
-
-## cucumber
+.yardoc
 rerun.txt
-
-## ctags
 tags
-
-## project::specific
 tmp/fixtures
 tmp/aruba

data/.yardopts

@@ -0,0 +1,6 @@
+--verbose
+--list-undoc
+-
+LICENSE
+HISTORY.markdown
+VERSION

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in the .gemspec file
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    revenc (0.1.3)
+      configatron (>= 2.5.1)
+      mutagem (>= 0.1.3)
+      term-ansicolor (>= 1.0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.3)
+      background_process
+      cucumber (~> 0.9.0)
+    background_process (1.2)
+    builder (2.1.2)
+    configatron (2.6.3)
+      yamler (>= 0.1.0)
+    cucumber (0.9.0)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.4)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+      trollop (~> 1.16.2)
+    json (1.4.6)
+    mutagem (0.1.3)
+    rake (0.8.7)
+    rdiscount (1.6.5)
+    rspec (1.3.0)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+    yamler (0.1.0)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (>= 0.2.0)
+  bundler (>= 1.0.0)
+  configatron (>= 2.5.1)
+  cucumber (>= 0.6)
+  mutagem (>= 0.1.3)
+  rake (>= 0.8.7)
+  rdiscount (>= 1.6.5)
+  revenc!
+  rspec (>= 1.2.9)
+  term-ansicolor (>= 1.0.4)
+  yard (>= 0.6.1)

data/HISTORY.markdown

@@ -0,0 +1,16 @@
+History
+=======
+Most recent changes are at the top
+
+
+Changes
+-------
+
+### 0.1.3 - 10/05/2010 ###
+
+* Using [mutagem](http://github.com/robertwahler/mutagem) for file locking based mutexes
+
+
+### 0.1.2 - 03/12/2010 ###
+
+* Initial release

data/{README.rdoc → README.markdown}

@@ -1,22 +1,26 @@
-= Revenc
+Revenc
+======
 
 Mount an unencrypted folder as encrypted using EncFS and copy/synchronize the 
 encrypted files to untrusted destinations using rsync/cp
 
-== Background
+Background
+----------
 
 EncFS in reverse mode facilitates mounting an encrypted file system 
 from an unencrypted source folder.  This allows keeping your files unencrypted 
 in a trusted environment while gaining the ability to encrypt on demand 
 i.e. when you want to rsync encrypted files off-site to an untrusted system.
 
-== Why Revenc?
+Why Revenc?
+-----------
 
 Revenc facilitates scripting EncFS reverse mounting and synchronizing by 
 providing a configuration framework and validating mounts before running tools 
 like rsync.
 
-=== Benefits 
+Benefits 
+--------
 
 * Provides conventions for EncFS reverse mounting
 * Validates mountpoints before copying to prevent "rsync --delete" commands 
@@ -27,17 +31,20 @@ like rsync.
 * Allow short, easy to remember command lines when used with configuration files.
   i.e. revenc mount, revenc unmount, revenc copy
 
-== Installation
+Installation
+------------
 
-sudo gem install revenc
+gem install revenc
 
-== Usage
+
+Usage
+-----
 
 revenc action [options]
 
-=== Actions
+### Actions ###
 
-==== Mount
+#### Mount ####
 
 Reverse mount using EncFS. Source and mountpoint are not required when
 using a configuration file.
@@ -50,7 +57,7 @@ This calls the executable "encfs" with the following by default:
     <%= executable %> --stdinpass --reverse <%= source.name %> \
     <%= mountpoint.name %> -- -o ro
 
-==== Unmount
+#### Unmount ####
 
 Unmount using EncFS. Mountpoint is required when specified by revenc.conf.
 
@@ -60,7 +67,7 @@ This calls the executable "fusermount" with the following by default:
 
     <%= executable %> -u <%= mountpoint.name %>
 
-==== Copy
+#### Copy ####
 
 Recursive copy with "cp -r", for rsync copy, see examples.  Source and destination
 are not required when specified by revenc.conf.
@@ -71,7 +78,7 @@ This calls the executable "cp" with the following by default:
 
     <%= executable %> -r <%= source.name %> <%= destination.name %>
 
-=== Setup
+### Setup ###
 
 The following is a walk through of the steps used to create the example project
 "simple" in the examples folder.
@@ -85,7 +92,7 @@ The following is a walk through of the steps used to create the example project
     echo "some stuff" > unencrypted_data/test_file1.txt
     echo "some more stuff" > unencrypted_data/test_file2.txt
 
-=== Create the EncFS passphrase file
+### Create the EncFS passphrase file ###
 
 You must supply EncFS with a passphrase in plain text. The passphrase is piped in on the command line
 to EncFS.  This file can be stored anywhere on your trusted system.  Revenc expects it in the 
@@ -94,7 +101,7 @@ current folder, use revenc.conf to supply a different location.
     echo "my_super_secret_PassPHRase" > passphrase
     chmod 600 passphrase
 
-=== Generate the EncFS key file
+### Generate the EncFS key file ###
 
 Generation of your key file is done once.  The same key is used for each mount action on the same 
 unencrypted source folder.  You need to keep a copy of your key available in order to restore encrypted files.
@@ -145,7 +152,7 @@ now work with your encrypted files.
         test_file1.txt  test_file2.txt
 
 
-=== Configuration files
+### Configuration files ###
 
 Revenc expects a passphrase file and the key file "encfs6.xml" to exist in the
 current folder.  You can override these locations using the revenc.conf file.  Revenc
@@ -166,33 +173,32 @@ See the example configuration file examples/rsync/revenc.conf.
 The file features/configuration.feature has more details.
 
 
-== System Requirements
+System Requirements 
+-------------------
 
 * POSIX system
 * EncFS http://www.arg0.net/encfs 
 
-== Runtime Dependencies
 
-* term-ansicolor
-* configatron
+Run-time dependencies 
+---------------------
+The following gems are required by default in applications cloned from BasicApp.
+
+* Term-ansicolor for optional color output <http://github.com/flori/term-ansicolor>
+* Configatron for configuration support <http://github.com/markbates/configatron>
+
 
-== Development Dependencies
+Development dependencies
+------------------------
 
-* rspec for unit testing http://github.com/dchelimsky/rspec
-* cucumber for functional testing http://github.com/tpope/vim-cucumber
-* aruba for CLI testing http://github.com/aslakhellesoy/aruba
+* Bundler for dependency management <http://github.com/carlhuda/bundler>
+* Rspec for unit testing <http://github.com/dchelimsky/rspec>
+* Cucumber for functional testing <http://github.com/aslakhellesoy/cucumber>
+* Aruba for CLI testing <http://github.com/aslakhellesoy/aruba>
+* YARD for documentation generation <http://github.com/lsegal/yard>
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version 
-  in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+Copyright
+---------
 
-Copyright (c) 2010 GearheadForHire, LLC. See LICENSE for details.
+Copyright (c) 2010 GearheadForHire, LLC. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -1,64 +1,55 @@
-require 'rubygems'
-require 'rake'
+# encoding: utf-8
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "revenc"
-    gem.summary = %Q{Helper for reverse mounting encrypted file systems}
-    gem.description = %Q{Mount, unmount, and copy/synchronize encrypted files to 
-                         untrusted destinations using EncFS and rsync}
-    gem.email = "robert@gearheadforhire.com"
-    gem.homepage = "http://github.com/robertwahler/revenc"
-    gem.authors = ["Robert Wahler"]
+# bundler/setup is managing $LOAD_PATH, any gem needed by this Rakefile must 
+# be listed as a development dependency in the gemspec
 
-    gem.add_dependency 'term-ansicolor', '>= 1.0.4'
-    gem.add_dependency 'configatron', '>= 2.5.1'
+require 'rubygems'
+require 'bundler/setup' 
 
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0.6"
-    gem.add_development_dependency "aruba", ">= 0.1.7"
+Bundler::GemHelper.install_tasks
 
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path('../revenc.gemspec', __FILE__)
+    eval(File.read(file), binding, file)
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+require 'spec'
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |task|
+  task.cucumber_opts = ["features"]
 end
 
-task :spec => :check_dependencies
+desc "Run specs and features"
+task :test => [:spec, :features]
 
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
+task :default => :test
 
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
+namespace :doc do
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_destination = File.join(project_root, 'rdoc')
+
+  require 'yard'
+  require 'yard/rake/yardoc_task'
 
-task :default => :spec
+  YARD::Rake::YardocTask.new(:generate) do |yt|
+    yt.options = ['--markup-provider', 'rdiscount', 
+                  '--output-dir', doc_destination
+                 ] +
+                 gemspec.rdoc_options - ['--line-numbers', '--inline-source']
+  end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_destination if File.exists?(doc_destination)
+  end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Revenc #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/TODO.markdown

@@ -0,0 +1,3 @@
+TODO
+====
+

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/bin/revenc

@@ -9,7 +9,7 @@ require 'term/ansicolor'
 available_actions = Revenc::AVAILABLE_ACTIONS
 
 banner = <<BANNER
-Revenc is an encfs helper
+Revenc is an EncFS helper
 
   Usage: revenc action [options]
 BANNER

data/config/cucumber.yml

@@ -3,5 +3,5 @@ rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format pretty features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
 std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
 %>
-default: <%= std_opts %>  --no-diff
+default: <%= std_opts %>
 wip: --tags @wip:3 --wip features

data/features/app.feature

@@ -7,7 +7,7 @@ Feature: Application actions, configuration and error handling
   Scenario: No command line action
     When I run "revenc"
     Then the exit status should be 1
-    And I should see matching: 
+    And the output should match: 
       """
       ^.* action required
       ^.* --help for more information
@@ -16,7 +16,7 @@ Feature: Application actions, configuration and error handling
   Scenario: Invalid action
     When I run "revenc non-existing-action"
     Then the exit status should be 1
-    And I should see matching: 
+    And the output should match: 
       """
       ^.* invalid action: non-existing-action
       ^.* --help for more information
@@ -26,18 +26,18 @@ Feature: Application actions, configuration and error handling
   Scenario: --config FILE (exists)
     Given an empty file named "config.conf"
     When I run "revenc mount --verbose --config config.conf"
-    Then I should see: 
+    Then the output should contain: 
       """
       loading config file: config.conf
       """
 
   Scenario: --config FILE (not found)
     When I run "revenc mount --verbose --config config.conf"
-    Then I should not see: 
+    Then the output should not contain: 
       """
       loading config file: config.conf
       """
-    And I should see: 
+    And the output should contain: 
       """
       config file not found 
       """
@@ -45,7 +45,7 @@ Feature: Application actions, configuration and error handling
   Scenario: Backtrace with --verbose option
     When I run "revenc --verbose mount bad_source bad_dest"
     Then the exit status should be 1
-    And I should see matching: 
+    And the output should match: 
       """
       lib/(.*)/app.rb
       """
@@ -53,7 +53,7 @@ Feature: Application actions, configuration and error handling
   Scenario: No backtrace without --verbose option
     When I run "revenc mount bad_source bad_dest --no-verbose"
     Then the exit status should be 1
-    And I should not see: 
+    And the output should not contain: 
       """
       /app.rb:
       """

data/features/bin.feature

@@ -9,12 +9,12 @@ Feature: Options via a command line interface (CLI)
   Scenario: Version info
     When I run "revenc --version"
     Then the exit status should be 0
-    And I should see matching "revenc, version ([\d]+\.[\d]+\.[\d]+$)"
+    And the output should match /revenc, version ([\d]+\.[\d]+\.[\d]+$)/
 
   Scenario: Help
     When I run "revenc --help"
     Then the exit status should be 0
-    And I should see matching: 
+    And the output should match: 
       """
       .*
         Usage: .*
@@ -27,7 +27,7 @@ Feature: Options via a command line interface (CLI)
   Scenario: Invalid option
     When I run "revenc --non-existing-option"
     Then the exit status should be 1
-    And I should see matching: 
+    And the output should match: 
       """
       ^.* invalid option: --non-existing-option
       ^.* --help for more information

data/features/configuration.feature

@@ -36,7 +36,7 @@ Feature: Configuration via yaml file
 
   Scenario: Mount with a config file
     When I run "revenc --verbose --dry-run mount"
-    Then I should see:
+    Then the output should contain:
       """
       mount: source=source_folder_name
       mount: mountpoint=destination_folder_name
@@ -48,7 +48,7 @@ Feature: Configuration via yaml file
 
   Scenario: Unmount with a config file
     When I run "revenc unmount --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       unmount: mountpoint=defaults_to_mount_mountpoint
       unmount: cmd=/bin/echo -u defaults_to_mount_mountpoint
@@ -63,14 +63,14 @@ Feature: Configuration via yaml file
           name: unmount_mountpoint_defaults_to_me
       """
     When I run "revenc unmount --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       unmount: mountpoint=unmount_mountpoint_defaults_to_me
       """
 
   Scenario: Copy with a config file
     When I run "revenc copy --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       copy: source=copy_source_defaults_to_mount_mountpoint
       copy: destination=copy_to_destination
@@ -89,7 +89,7 @@ Feature: Configuration via yaml file
           name: copy_to_destination
       """
     When I run "revenc copy --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       copy: source=copy_source_defaults_to_me
       copy: destination=copy_to_destination

data/features/copy.feature

@@ -52,7 +52,7 @@ Feature: Copy encrypted data to another location via rsync
       """
     When I run with a lock file present "revenc copy encrypted_source_folder encrypted_destination"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       action failed, lock file present
       """
@@ -60,7 +60,7 @@ Feature: Copy encrypted data to another location via rsync
   Scenario: Source folder not specified
     When I run "revenc copy"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       source folder not specified
       """
@@ -68,7 +68,7 @@ Feature: Copy encrypted data to another location via rsync
   Scenario: Destination not specified
     When I run "revenc copy encrypted_source_folder"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       destination not specified
       """
@@ -76,7 +76,7 @@ Feature: Copy encrypted data to another location via rsync
   Scenario: Source folder doesn't exist
     When I run "revenc copy encrypted_source_folder encrypted_destination"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       source folder not found
       """
@@ -85,7 +85,7 @@ Feature: Copy encrypted data to another location via rsync
     Given a directory named "encrypted_source_folder"
     When I run "revenc copy encrypted_source_folder encrypted_destination"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       source folder is empty
       """
@@ -107,7 +107,7 @@ Feature: Copy encrypted data to another location via rsync
           name: copy_to_destination
       """
     When I run "revenc copy --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       mountpoint is empty
       """
@@ -128,7 +128,7 @@ Feature: Copy encrypted data to another location via rsync
           name: copy_to_destination
       """
     When I run "revenc copy --verbose --dry-run"
-    Then I should see:
+    Then the output should contain:
       """
       mountpoint not found
       """
@@ -146,11 +146,11 @@ Feature: Copy encrypted data to another location via rsync
           name: copy_to_destination
       """
     When I run "revenc copy --verbose --dry-run"
-    Then I should not see:
+    Then the output should not contain:
       """
       mountpoint not found
       """
-    And I should not see:
+    And the output should not contain:
       """
       mountpoint is empty
       """
@@ -163,7 +163,7 @@ Feature: Copy encrypted data to another location via rsync
       """
     When I run "revenc copy encrypted_source_folder encrypted_destination"
     Then the exit status should be 1
-    And I should see:
+    And the output should contain:
       """
       executable not found
       """