Add fixtures to aruba

README.md

@@ -238,6 +238,69 @@ end
 
 Refer to http://blog.headius.com/2010/03/jruby-startup-time-tips.html for other tips on startup time.
 
+## Fixtures
+
+Sometimes your tests need existing files to work - e.g binary data files you
+cannot create programmatically. Since `aruba` >= 0.6.3 includes some basic
+support for fixtures. All you need to do is the following:
+
+1. Create a `fixtures`-directory
+2. Create fixture files in this directory
+
+The `expand_path`-helper will expand `%` to the path of your fixtures
+directory:
+
+```ruby
+expand_path('%/song.mp3')
+# => /home/user/projects/my_project/fixtures/song.mp3
+```
+
+*Example*
+
+1. Create fixtures directory
+
+  ```bash
+  cd project
+
+  mkdir -p fixtures/
+  # or
+  mkdir -p test/fixtures/
+  # or
+  mkdir -p spec/fixtures/
+  # or
+  mkdir -p features/fixtures/
+  ```
+
+2. Store `song.mp3` in `fixtures`-directory
+
+  ```bash
+  cp song.mp3 fixtures/
+  ```
+
+3. Add fixture to vcs-repository - e.g. `git`, `mercurial`
+
+4. Create test
+
+  ```ruby
+  RSpec.describe 'My Feature' do
+    describe '#read_music_file' do
+      context 'when the file exists' do
+        let(:path) { expand_path('%/song.mp3') }
+
+        before :each do
+          in_current_directory { FileUtils.cp path, 'file.mp3' }
+        end
+
+        before :each do
+          run 'my_command'
+        end
+
+        it { expect(all_stdout).to include('Rate is 128 KB') }
+      end
+    end
+  end
+  ```
+
 ## Reporting
 
 *Important* - you need [Pygments](http://pygments.org/) installed to use this feature.

lib/aruba/api.rb

@@ -3,6 +3,8 @@
 require 'rspec/expectations'
 require 'aruba'
 require 'aruba/config'
+require 'ostruct'
+require 'pathname'
 
 Dir.glob( File.join( File.expand_path( '../matchers' , __FILE__ )  , '*.rb' ) ).each { |rb| require rb }
 
@@ -21,20 +23,32 @@ module Api
     # @example Single file name
     #
     #   # => <path>/tmp/aruba/file
-    #   absolute_path('file')
+    #   expand_path('file')
     #
     # @example Single Dot
     #
     #   # => <path>/tmp/aruba
-    #   absolute_path('.')
+    #   expand_path('.')
     #
     # @example Join and Expand path
     #
     #   # => <path>/tmp/aruba/path/file
-    #   absolute_path('path', 'file')
+    #   expand_path('path', 'file')
     #
+    def expand_path(*args)
+      if %r{^#{fixtures_path_prefix}/} === args.first
+        File.join fixtures_directory, args.shift.sub(%r{^#{fixtures_path_prefix}/}, ''), *args
+      else
+        in_current_directory { File.expand_path File.join(*args) }
+      end
+    end
+
+    # @private
+    # @deprecated
     def absolute_path(*args)
-      in_current_directory { File.expand_path File.join(*args) }
+      warn('The use of "absolute_path" is deprecated. Use "expand_path" instead')
+
+      expand_path(*args)
     end
 
     # Execute block in current directory
@@ -126,7 +140,7 @@ def touch_file(*args)
                   {}
                 end
 
-      args = args.map { |p| absolute_path(p) }
+      args = args.map { |p| expand_path(p) }
       args.each { |p| _mkdir(File.dirname(p)) }
 
       FileUtils.touch(args, options)
@@ -194,7 +208,7 @@ def filesystem_permissions(*args)
                mode
              end
 
-      args = args.map { |p| absolute_path(p) }
+      args = args.map { |p| expand_path(p) }
       args.each { |p| raise "Expected #{p} to be present" unless FileTest.exists?(p) }
 
       FileUtils.chmod(mode, args, options)
@@ -224,7 +238,7 @@ def check_filesystem_permissions(*args)
       expected_permissions = args.shift
       expected_result      = args.pop
 
-      args = args.map { |p| absolute_path(p) }
+      args = args.map { |p| expand_path(p) }
 
       args.each do |p|
         raise "Expected #{p} to be present" unless FileTest.exists?(p)
@@ -269,7 +283,7 @@ def remove_file(*args)
                   {}
                 end
 
-      args = args.map { |p| absolute_path(p) }
+      args = args.map { |p| expand_path(p) }
 
       FileUtils.rm(args, options)
     end
@@ -322,7 +336,7 @@ def remove_directory(*args)
                   {}
                 end
 
-      args = args.map { |p| absolute_path(p) }
+      args = args.map { |p| expand_path(p) }
 
       FileUtils.rm_r(args, options)
     end
@@ -788,6 +802,40 @@ def io_wait
       @aruba_io_wait_seconds || DEFAULT_IO_WAIT_SECONDS
     end
 
+    DEFAULT_ROOT_DIRECTORY = Dir.getwd
+
+    # The root directory of aruba
+    def root_directory
+      @aruba_root_directory ||= DEFAULT_ROOT_DIRECTORY
+    end
+
+    # Path prefix for fixtures
+    def fixtures_path_prefix
+      '%'
+    end
+
+    DEFAULT_FIXTURES_DIRECTORY = 'fixtures'
+
+    # The path to the directory which contains fixtures
+    # You might want to overwrite this method to place your data else where.
+    #
+    # @return [String]
+    #   The directory to where your fixtures are stored
+    def fixtures_directory
+      return @fixtures_directory if @fixtures_directory
+
+      default_path = proc { File.join(root_directory, DEFAULT_FIXTURES_DIRECTORY) }
+
+      candidates   = %w(
+        fixtures
+        spec/fixtures
+        features/fixtures
+        test/fixtures
+      ).map { |dir| File.join(root_directory, dir) }
+
+      @fixtures_directory = candidates.find(default_path) { |dir| File.directory? dir }
+    end
+
     # Run a command with aruba
     #
     # Checks for error during command execution and checks the output to detect

lib/aruba/matchers/file.rb

@@ -2,8 +2,8 @@
 RSpec::Matchers.define :have_same_file_content_like do |expected|
   match do |actual|
     FileUtils.compare_file(
-      absolute_path(actual),
-      absolute_path(expected)
+      expand_path(actual),
+      expand_path(expected)
     )
   end
 

lib/aruba/matchers/mode.rb

@@ -8,21 +8,21 @@
 
   match do |actual|
     file_name = actual
-    actual_permissions = sprintf( "%o", File::Stat.new(absolute_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
+    actual_permissions = sprintf( "%o", File::Stat.new(expand_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
 
     actual_permissions == expected_permissions
   end
 
   failure_message do |actual|
     file_name = actual
-    actual_permissions = sprintf( "%o", File::Stat.new(absolute_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
+    actual_permissions = sprintf( "%o", File::Stat.new(expand_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
 
     format("expected that file \"%s\" would have permissions \"%s\", but has \"%s\".", file_name, expected_permissions, actual_permissions)
   end
 
   failure_message_when_negated do |actual|
     file_name = actual
-    actual_permissions = sprintf( "%o", File::Stat.new(absolute_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
+    actual_permissions = sprintf( "%o", File::Stat.new(expand_path(file_name)).mode )[-4,4].gsub(/^0*/, '')
 
     format("expected that file \"%s\" would not have permissions \"%s\", but has \"%s\".", file_name, expected_permissions, actual_permissions)
   end

spec/aruba/api_spec.rb

@@ -61,9 +61,9 @@ def announce_or_puts(*args)
       @directory_path = File.join(@aruba.current_directory, @directory_name)
     end
 
-    context '#create_dir' do
+    context '#create_directory' do
       it 'creates a directory' do
-        @aruba.create_dir @directory_name
+        @aruba.create_directory @directory_name
         expect(File.exist?(File.expand_path(@directory_path))).to be_truthy
       end
     end
@@ -171,21 +171,37 @@ def announce_or_puts(*args)
       end
     end
 
-    context '#absolute_path' do
+    context '#expand_path' do
       it 'expands and returns path' do
-        expect(@aruba.absolute_path(@file_name)).to eq File.expand_path(@file_path)
+        expect(@aruba.expand_path(@file_name)).to eq File.expand_path(@file_path)
       end
 
       it 'removes "."' do
-        expect(@aruba.absolute_path('.')).to eq File.expand_path(current_directory)
+        expect(@aruba.expand_path('.')).to eq File.expand_path(current_directory)
       end
 
       it 'removes ".."' do
-        expect(@aruba.absolute_path('..')).to eq File.expand_path(File.join(current_directory, '..'))
+        expect(@aruba.expand_path('..')).to eq File.expand_path(File.join(current_directory, '..'))
       end
 
       it 'joins multiple arguments' do
-        expect(@aruba.absolute_path('path', @file_name)).to eq File.expand_path(File.join(current_directory, 'path', @file_name))
+        expect(@aruba.expand_path('path', @file_name)).to eq File.expand_path(File.join(current_directory, 'path', @file_name))
+      end
+
+      it 'resolves fixtures path' do
+        klass = Class.new do
+          include Aruba::Api
+
+          def root_directory
+            File.expand_path(current_directory)
+          end
+        end
+
+        aruba = klass.new
+
+        aruba.touch_file 'fixtures/file1'
+
+        expect(aruba.expand_path('%/file1')).to eq File.expand_path(File.join(current_directory, 'fixtures', 'file1'))
       end
     end
 
@@ -665,6 +681,50 @@ def actuctual_permissions
     end
   end
 
+  describe 'fixtures' do
+    let(:aruba) do
+      klass = Class.new do
+        include Aruba::Api
+
+        def root_directory
+          expand_path('.')
+        end
+      end
+
+      klass.new
+    end
+
+    describe '#fixtures_directory' do
+      context 'when "/fixtures"-directory exist' do
+        before(:each) { aruba.create_directory('fixtures') }
+
+        it { expect(aruba.fixtures_directory).to eq expand_path('fixtures') }
+      end
+
+      context 'when "/features/fixtures"-directory exist' do
+        before(:each) { aruba.create_directory('features/fixtures') }
+
+        it { expect(aruba.fixtures_directory).to eq expand_path('features/fixtures') }
+      end
+
+      context 'when "/spec/fixtures"-directory exist' do
+        before(:each) { aruba.create_directory('spec/fixtures') }
+
+        it { expect(aruba.fixtures_directory).to eq expand_path('spec/fixtures') }
+      end
+
+      context 'when "/test/fixtures"-directory exist' do
+        before(:each) { aruba.create_directory('test/fixtures') }
+
+        it { expect(aruba.fixtures_directory).to eq expand_path('test/fixtures') }
+      end
+    end
+
+    context '#fixture_path_prefix' do
+      it { expect(@aruba.fixtures_path_prefix).to eq '%' }
+    end
+  end
+
   describe "#set_env" do
     after(:each) do
       @aruba.stop_processes!