given_filesystem 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.rspec

data/.rspec

@@ -0,0 +1 @@
+--color

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Cornelius Schumacher <schumacher@kde.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,188 @@
+# GivenFilesystem
+
+GivenFilesystem is a set of helpers for testing code which operates on file
+systems. It lets you create temporary directories and files with given content as
+test data. You can write to these directories and GivenFilesystem takes care of
+cleaning up after the test. It only assumes that you can set the path to your
+file system data in your tests.
+
+GivenFilesystem provides helpers for RSpec and a standalone class.
+
+## Usage with RSpec
+
+### Setup
+
+To use the GivenFilesystem helpers in a RSpec test you have to include the
+`GivenFileSystemSpecHelpers` module to get access to the helper methods, and
+set up the temporary test directory by calling `use_given_filesystem`:
+
+```ruby
+include GivenFileSystemSpecHelpers
+
+describe "some test" do
+  use_given_filesystem
+
+  it "tests something" do
+    ...
+  end
+end
+```
+
+The activation with `use_given_filesystem` gives you fine-grained control
+about in which scope the test directories are created. It takes a parameter to
+optionally keep the created test files around:
+
+```ruby
+use_given_filesystem( :keep_files => true )
+```
+
+This can be useful when debugging tests.
+
+
+### File fixtures
+
+With GivenFilesystem you can create directories and files with pre-defined
+content. These can be used as test fixtures for code reading from a file
+system.
+
+File fixtures, i.e. files containing test content, are stored in the
+`spec/data/` directory. GivenFilesystem provides helper functions to create
+temporary directories with defined structure and content using the file
+fixtures. The file names can be taken directly from the name of the file
+fixtures or be defined when creating the test directory structure.
+
+
+### Creating directories
+
+Create a temporary directory for writing test data:
+
+```ruby
+path = given_directory
+```
+
+Use the returned path to access the directory.
+
+Create an empty temporary directory with a given name for writing test data:
+
+```ruby
+path = given_directory "myname"
+```
+
+Create a temporary directory with a given from data you provide in the
+directory `spec/data` of your project:
+
+```ruby
+path = given_directory_from_data "myname"
+```
+
+This copies the directory `spec/data/myname` to a temporary test directory
+and returns the path to the `myname` directory.
+
+You can also create the directory under a different name:
+
+```ruby
+path = given_directory_from_data "myothername", :from => "myname"
+```
+
+This will copy the same data, but put it into a directory named `myothername`.
+
+
+### Creating files
+
+Create a temporary file with arbitrary content:
+
+```ruby
+path = given_dummy_file
+```
+
+Use the returned path to access the file.
+
+Create a temporary file with given content taken from a file fixture:
+
+```ruby
+path = given_file "myfixture"
+```
+
+The content of the file is taken from a file fixture stored in your `spec/data`
+directory. The name of the created file is the same as the name of the file
+containing the test content.
+
+Create a temporary file with given content under a different name:
+
+```ruby
+path = given_file "myspecialfile", :from => "myfixture"
+```
+
+The content of the file is taken from the file `spec/data/myfixture` and stored
+under the name `myspecialfile` in a temporary directory. You can access it under
+the returned path.
+
+
+### Creating structures of directories and files
+
+You can combine `given_directory` and `given_file` to create file system
+structures as input for you tests. Here is an example:
+
+```ruby
+path = given_directory "mydir" do
+  given_directory "one" do
+    given_file "myfile"
+    given_file "myotherfile"
+  end
+  given_directory "two" do
+    given_file "myfile2", :from => "myfile"
+  end
+end
+```
+
+This will create the following file system structure and return the path to the
+temporary directory `mydir`, which you can then use in your tests to access the
+data:
+
+```
+/tmp/
+  given_filesystem/
+    3845-20140216-74592/
+      mydir/
+        one/
+          myfile
+          myotherfile
+        two/
+          myfile2
+```
+
+### Using directory structures in name parameters
+
+All directory or file name parameters can contain additional directory
+structure. The required nested directories are automatically created. For
+example the call
+
+```ruby
+  given_directory( "a/b/c" )
+```
+
+will create the following structure:
+
+```
+/tmp/
+  given_filesystem/
+    7373-2014-03-15-98223/
+      a/
+        b/
+          c/
+```
+
+and return the path to the directory `a`.
+
+## License
+
+You may use GivenFilesystem under the terms of the MIT license.
+
+## Contact
+
+If you have questions or comments about GivenFilesystem don't hesitate to get in
+touch with [Cornelius Schumacher](mailto:schumacher@kde.org).
+
+## Thanks
+
+Thanks to David Majda for reviewing code and documentation.

data/lib/given_filesystem/spec_helpers.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2014 Cornelius Schumacher <schumacher@kde.org>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative "../given_filesystem"
+
+module GivenFilesystemSpecHelpers
+  def self.included(example_group)
+    example_group.extend(self)
+  end
+
+  def use_given_filesystem options = {}
+    before do
+      @__given_filesystem = GivenFilesystem.new
+    end
+
+    if !options[:keep_files]
+      after do
+        @__given_filesystem.cleanup
+      end
+    end
+  end
+  
+  def given_directory directory_name = nil
+    check_initialization
+    if block_given?
+      path = @__given_filesystem.directory directory_name do
+        yield
+      end
+    else
+      path = @__given_filesystem.directory directory_name
+    end
+    path
+  end
+  
+  def given_directory_from_data directory_name, options = {}
+    check_initialization
+    path = @__given_filesystem.directory_from_data directory_name, options[:from]
+  end
+  
+  def given_file file_name, options = {}
+    check_initialization
+    if !options[:from]
+      options[:from] = file_name
+    end
+    @__given_filesystem.file file_name, options
+  end
+  
+  def given_dummy_file file_name = nil
+    check_initialization
+    @__given_filesystem.file file_name
+  end
+  
+  private
+  
+  def check_initialization
+    if !@__given_filesystem
+      raise "Call use_given_filesystem before calling other methods"
+    end
+  end
+end

data/lib/given_filesystem.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2014 Cornelius Schumacher <schumacher@kde.org>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require "tmpdir"
+
+class GivenFilesystem
+  def initialize
+    @path_elements = [ Dir.tmpdir, "given_filesystem" ]
+    @base_paths = Array.new
+  end
+  
+  def cleanup
+    @base_paths.each do |base_path|
+      # Better safe than sorry, so do sanity check on path before removing it
+      if base_path =~ /given_filesystem/
+        FileUtils.rm_r base_path
+      end
+    end
+  end
+
+  def directory dir_name = nil
+    create_random_base_path unless path_has_base?
+
+    @path_elements.push dir_name || random_name
+
+    created_path = path
+    FileUtils.mkdir_p created_path
+    yield if block_given?
+    @path_elements.pop
+    created_path
+  end
+  
+  def directory_from_data to, from = nil
+    from ||= to
+
+    create_random_base_path unless path_has_base?
+
+    FileUtils.mkdir_p path
+    @path_elements.push to
+    FileUtils.cp_r test_data_path(from), path
+    path
+  end
+
+  def file file_name = nil, options = {}
+    create_random_base_path unless path_has_base?
+    
+    if file_name
+      @path_elements.push file_name
+    else
+      @path_elements.push random_name
+    end
+ 
+    FileUtils.mkdir_p File.dirname(path)
+ 
+    created_path = path
+    File.open(created_path,"w") do |file|
+      if options[:from]
+        test_data = test_data_path(options[:from])
+        if !File.exists? test_data
+          raise "Test data file '#{test_data}' doesn't exist"
+        end
+        file.write File.read(test_data)
+      else
+        file.puts "GivenFilesystem was here"
+      end
+    end
+    @path_elements.pop
+    created_path
+  end
+
+  private
+  
+  def create_random_base_path
+    @path_elements.push random_name
+    @base_paths.push path
+  end
+  
+  def random_name
+    "#{Process.pid}-#{Time.now.strftime("%Y%m%d")}-#{rand(99999).to_s}"
+  end
+  
+  def path
+    @path_elements.join("/")
+  end
+  
+  def path_has_base?
+    @path_elements.count > 2
+  end
+  
+  def test_data_path name
+    File.expand_path('spec/data/' + name)
+  end
+end

data/spec/data/testcontent

@@ -0,0 +1 @@
+This is my test content.

data/spec/data/welcome/universe

@@ -0,0 +1 @@
+I was here

data/spec/given_filesystem_spec.rb

@@ -0,0 +1,158 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe GivenFilesystem do
+  
+  before(:each) do
+    @given = GivenFilesystem.new
+  end
+  
+  after(:each) do
+    @given.cleanup
+  end
+  
+  it "creates directory" do
+    path = @given.directory
+    expect( File.exists? path ).to be_true
+    expect( File.directory? path ).to be_true
+    expect( path ).to match /tmp/
+    expect( path.split("/").length).to be > 3
+  end
+  
+  it "creates nested unnamed directories" do
+    nested_path = nil
+    path = @given.directory do
+      nested_path = @given.directory
+    end
+    expect( File.exists? nested_path ).to be_true
+    expect( nested_path.split("/").count ).to eq path.split("/").count + 1
+  end
+  
+  it "creates named directory" do
+    path = @given.directory "abc"
+    expect( File.exists? path ).to be_true
+    expect( path ).to match /tmp/
+    expect( path.split("/").length).to be > 4
+    expect( path ).to match /abc$/    
+  end
+  
+  it "creates named directory including path" do
+    path = @given.directory "abc"
+    deep_path = @given.directory "x/y/z"
+    expect( File.exists? deep_path ).to be_true
+    expect( File.directory? deep_path ).to be_true
+    expect( deep_path.split("/").count ).to eq path.split("/").count + 2
+  end
+  
+  it "creates file" do
+    path = @given.file
+    expect( path ).to match /tmp/
+    expect( path.split("/").length).to be > 3
+    expect( File.exists? path ).to be_true
+    expect( File.directory? path ).to be_false
+  end
+  
+  it "creates named file" do
+    path = @given.file "def"
+    expect( path ).to match /tmp/
+    expect( path.split("/").length).to be > 4
+    expect( path ).to match /def$/
+  end
+  
+  it "creates named file including path" do
+    path = @given.file "def"
+    deep_path = @given.file "x/y/z"
+    expect( File.exists? deep_path ).to be_true
+    expect( File.directory? deep_path ).to be_false
+    expect( deep_path.split("/").count ).to eq path.split("/").count + 2    
+  end
+  
+  it "throws error on invalid test data file name" do
+    expect{@given.file "def", :from => "invalidname"}.to raise_error
+  end
+  
+  it "creates file with content" do
+    path = @given.file "def", :from => "testcontent"
+    expect( path ).to match /tmp/
+    expect( path.split("/").length).to be > 4
+    expect( path ).to match /def$/
+    expect( File.read(path) ).to eq "This is my test content.\n"
+  end
+  
+  it "creates directory tree" do
+    path = @given.directory do
+      @given.directory "one" do
+	@given.file "first"
+      end
+      @given.directory "two" do
+	@given.file "second"
+	@given.file "third"
+      end
+    end
+    
+    expect( File.exists? path).to be_true
+    expect( File.directory? path).to be_true
+    expect( File.exists? File.join(path,"one")).to be_true
+    expect( File.exists? File.join(path,"one")).to be_true
+    expect( File.directory? File.join(path,"one")).to be_true
+    expect( File.directory? File.join(path,"two")).to be_true
+    expect( File.exists? File.join(path,"one","first")).to be_true
+    expect( File.exists? File.join(path,"two","second")).to be_true
+    expect( File.exists? File.join(path,"two","third")).to be_true
+  end
+  
+  it "creates directory from data" do
+    path = @given.directory_from_data( "welcome" )
+    expect( path ).to match /\/welcome$/
+    expect( File.exists? path ).to be_true
+    expect( File.directory? path ).to be_true
+    
+    expect( File.exist? File.join( path, "universe" ) ).to be_true
+    expect( File.directory? File.join( path, "universe" ) ).to be_false
+    expect( File.read( File.join( path, "universe" ) ) ).to eq "I was here\n"
+    
+    expect( File.exist? File.join( path, "space" ) ).to be_true
+    expect( File.directory? File.join( path, "space" ) ).to be_true
+  end
+  
+  it "creates directory from data under different name" do
+    path = @given.directory_from_data( "hi", "welcome" )
+    expect( path ).to match /\/hi$/
+    expect( File.exists? path ).to be_true
+    expect( File.directory? path ).to be_true
+    
+    expect( File.exist? File.join( path, "universe" ) ).to be_true
+    expect( File.directory? File.join( path, "universe" ) ).to be_false
+    expect( File.read( File.join( path, "universe" ) ) ).to eq "I was here\n"
+    
+    expect( File.exist? File.join( path, "space" ) ).to be_true
+    expect( File.directory? File.join( path, "space" ) ).to be_true
+  end
+  
+  it "returns paths" do
+    path1 = @given.directory "one"
+    expect( path1 ).to match /^\/tmp\/given_filesystem\/[\d-]+\/one$/
+
+    path2 = @given.directory "two"
+    expect( path2 ).to match /^\/tmp\/given_filesystem\/[\d-]+\/two$/
+    
+    path3 = @given.directory "three" do
+      @given.file "first"
+    end
+    expect( path3 ).to match /^\/tmp\/given_filesystem\/[\d-]+\/three$/
+  end
+
+  it "cleans up directory tree" do
+    given = GivenFilesystem.new
+    path1 = given.directory
+    path2 = given.directory
+    
+    expect( File.exists? path1).to be_true
+    expect( File.exists? path2).to be_true
+    
+    given.cleanup
+    
+    expect( File.exists? path1).to be_false
+    expect( File.exists? path2).to be_false
+  end
+
+end

data/spec/given_filesystem_spec_helpers_spec.rb

@@ -0,0 +1,108 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe GivenFilesystem do
+
+  include GivenFilesystemSpecHelpers
+
+  context "not initialized" do
+    describe "#given_directory" do
+      it "raises error" do
+        expect{ given_directory }.to raise_error /given_filesystem/
+      end
+    end
+    
+    describe "#given_file" do
+      it "raises error" do
+        expect{ given_directory }.to raise_error /given_filesystem/
+      end
+    end
+  end
+  
+  context "with keeping of files enabled" do
+    use_given_filesystem :keep_files => true
+    
+    it "creates directories" do
+      path = given_directory "hello"
+      expect( File.exists? path ).to be_true
+      
+      # Manually clean up, so test doesn't leave files around
+      @__given_filesystem.cleanup
+    end  
+  end
+  
+  context "using the module" do
+    use_given_filesystem
+
+    describe "#given_directory" do
+      it "creates unnamed directory" do
+        path = given_directory
+        expect( File.exists? path ).to be_true
+        expect( File.directory? path ).to be_true
+      end
+      
+      it "creates directory" do
+        path = given_directory "hello"
+        expect( path ).to match /\/hello$/      
+      end
+      
+      it "creates nested directory" do
+        path = nil
+        given_directory "hello" do
+          path = given_directory "world"
+        end
+        expect( path ).to match /\/hello\/world$/
+      end
+    end
+    
+    describe "#give_directory_from_data" do
+      it "creates directory with content from data" do
+        path = given_directory_from_data "welcome"
+        expect( path ).to match /\/welcome$/
+      end
+      
+      it "creates directory with content from named data" do
+        path = given_directory_from_data "hi", :from => "welcome"
+        expect( path ).to match /\/hi$/
+      end
+    end
+
+    describe "#given_dummy_file" do
+      it "creates unnamed dummy file" do
+        path = given_dummy_file
+        expect( File.exists? path ).to be_true
+        expect( File.directory? path ).to be_false
+      end
+      
+      it "creates named dummy file" do
+        path = given_dummy_file "welcome"
+        expect( path ).to match /\/welcome$/
+        expect( File.exists? path ).to be_true
+        expect( File.directory? path ).to be_false
+      end
+    end
+
+    describe "#given_file" do
+      it "creates file with content" do
+        path = given_file "testcontent"
+        expect( path ).to match /\/testcontent$/
+        expect( File.read( path ) ).to eq "This is my test content.\n"
+      end
+      
+      it "creates file with content and given filename" do
+        path = given_file "welcome", :from => "testcontent"
+        expect( path ).to match /\/welcome$/
+        expect( File.read( path ) ).to eq "This is my test content.\n"
+      end
+      
+      it "creates file in directory" do
+        path = nil
+        given_directory "hello" do
+          path = given_file "world", :from => "testcontent"
+        end
+        expect( File.exists? path ).to be_true
+        expect( File.read( path ) ).to eq "This is my test content.\n"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative('../lib/given_filesystem/spec_helpers')

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: given_filesystem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Cornelius Schumacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GivenFilesystem is a set of helpers for testing code which operates on
+  file systems.
+email:
+- schumacher@kde.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- MIT-LICENSE
+- README.md
+- lib/given_filesystem.rb
+- lib/given_filesystem/spec_helpers.rb
+- spec/data/testcontent
+- spec/data/welcome/universe
+- spec/given_filesystem_spec.rb
+- spec/given_filesystem_spec_helpers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cornelius/given_filesystem
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: given_filesystem
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A library for setting up files as test data
+test_files: []