temporary_directory 0.1.0

data/features/step_definitions/temporary_directories.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+Then(/^no temporary directories remain$/) do
+  expect(subsequent_temporary_directory_root_directory).to have(0).children
+end
+
+Then(/^one temporary directory remains$/) do
+  expect(subsequent_temporary_directory_root_directory).to have(1).children
+end
+
+Then(/^(\d+) temporary directories remain$/) do |amount_of_remaining_directories|
+  amount_of_remaining_directories = Integer(amount_of_remaining_directories)
+
+  expect(subsequent_temporary_directory_root_directory).to have(amount_of_remaining_directories).children
+end
+
+Then(/^the remaining temporary directories start with "([^"]*)"$/) do |prefix|
+  expect(subsequent_temporary_directory_root_directory).to have_at_least(1).children
+
+  remaining_file_names = @subsequent_temporary_directory_root_directory
+                           .children
+                           .map(&:basename)
+                           .map(&:to_s)
+
+  expect(remaining_file_names).to all(start_with(prefix))
+end

data/features/support/env.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'temporary_directory'
+require 'rspec/collection_matchers'
+
+# For compatibility with Ruby 2.1.x
+if RUBY_VERSION.start_with?('2.1')
+  class Pathname
+    alias / +
+  end
+end
+
+World(GodObject::TemporaryDirectory::Helper.new(name_prefix: 'temporary_directory_cucumber'))
+
+After do
+  ensure_absence_of_temporary_directory
+end

data/features/support/project.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module Project
+  def project_root_directory
+    @project_root_directory ||= Pathname.new(__dir__) / '..' / '..'
+  end
+end
+
+World(Project)

data/features/support/separate_environment_execution.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'English'
+
+module SeparateEnvironmentExecution
+  attr_reader :output
+
+  def execute_in_separate_environment(command)
+    Bundler.with_clean_env do
+      Dir.chdir(temporary_directory) do
+        @output = `#{command}`
+      end
+    end
+  end
+
+  def create_gemfile(include_gems: [])
+    gemfile = temporary_directory / 'Gemfile'
+
+    gemfile.open('w') do |io|
+      io.puts(%(gem 'temporary_directory', path: '#{project_root_directory}'))
+
+      include_gems.each do |gem_name|
+        io.puts(%(gem '#{gem_name}', '= #{Gem.loaded_specs[gem_name].version}'))
+      end
+    end
+
+    gemfile
+  end
+end
+
+World(SeparateEnvironmentExecution)

data/features/support/subsequent_temporary_directory_root_directory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module SubsequentTemporaryDirectoryRootDirectory
+  attr_reader :subsequent_temporary_directory_root_directory
+
+  def create_root_for_subsequent_temporary_directories
+    @subsequent_temporary_directory_root_directory = temporary_directory / 'subsequent_temporary_directories'
+    @subsequent_temporary_directory_root_directory.mkpath
+    @subsequent_temporary_directory_root_directory
+  end
+end
+
+World(SubsequentTemporaryDirectoryRootDirectory)

data/features/temporary_directories_for_cucumber.feature

@@ -0,0 +1,80 @@
+Feature: Temporary directories for Cucumber
+
+  Background:
+    Given a file called "features/temporary_directory.feature" with the following content:
+    """
+      Feature: Something
+
+        Scenario: Something specific
+          Given some precondition
+          When the temporary directory is referenced
+          Then the state is somehow
+
+        Scenario: Another thing
+          Given some precondition
+          When something else happens
+          Then the state is somehow
+    """
+    And a file called "features/step_definitions/temporary_directory.rb" with the following content:
+    """
+      Given(/^some precondition$/) {}
+      When(/^something else happens$/) {}
+
+      When(/^the temporary directory is referenced$/) do
+        temporary_directory
+      end
+
+      Then(/^the state is somehow$/) {}
+    """
+
+  Scenario: Create a directory for each example
+    Given a file called "features/support/env.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      World(GodObject::TemporaryDirectory::Helper)
+
+      Before do
+        ensure_presence_of_temporary_directory
+      end
+    """
+    When I run "cucumber"
+    Then all scenarios and their steps should pass
+    And 2 temporary directories remain
+
+  Scenario: Create directories just on demand
+    Given a file called "features/support/env.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      World(GodObject::TemporaryDirectory::Helper)
+    """
+    When I run "cucumber"
+    Then all scenarios and their steps should pass
+    And one temporary directory remains
+
+  Scenario: Create directories with specific name prefixes
+    Given a file called "features/support/env.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      World(GodObject::TemporaryDirectory::Helper.new(name_prefix: 'marker'))
+    """
+    When I run "cucumber"
+    Then all scenarios and their steps should pass
+    And the remaining temporary directories start with "marker"
+
+  Scenario: Delete directories afterwards
+    Given a file called "features/support/env.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      World(GodObject::TemporaryDirectory::Helper)
+
+      After do
+        ensure_absence_of_temporary_directory
+      end
+    """
+    When I run "cucumber"
+    Then all scenarios and their steps should pass
+    And no temporary directories remain

data/features/temporary_directories_for_rspec_examples.feature

@@ -0,0 +1,92 @@
+Feature: Temporary directories for RSpec examples
+
+  Scenario: Create a directory for each example
+    Given a file called "temporary_directory_spec.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      describe 'something' do
+        include GodObject::TemporaryDirectory::Helper
+
+        before(:example) { ensure_presence_of_temporary_directory }
+
+        specify { expect(123).to be_a Numeric }
+        specify { expect('abc').to be_a String }
+        specify { expect(temporary_directory).to exist }
+      end
+    """
+    When I run "rspec temporary_directory_spec.rb"
+    Then all examples should pass
+    And 3 temporary directories remain
+
+  Scenario: Create directories just on demand
+    Given a file called "temporary_directory_spec.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      describe 'something' do
+        include GodObject::TemporaryDirectory::Helper
+
+        specify { expect(123).to be_a Numeric }
+        specify { expect('abc').to be_a String }
+        specify do
+          expect(temporary_directory).to exist
+          expect(temporary_directory).to be_a_directory
+        end
+      end
+    """
+    When I run "rspec temporary_directory_spec.rb"
+    Then all examples should pass
+    And one temporary directory remains
+
+  Scenario: Create directories with specific name prefixes
+    Given a file called "temporary_directory_spec.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      describe 'something' do
+        include GodObject::TemporaryDirectory::Helper.new(name_prefix: 'marker')
+
+        before(:example) { ensure_presence_of_temporary_directory }
+
+        specify { expect(123).to be_a Numeric }
+      end
+    """
+    When I run "rspec temporary_directory_spec.rb"
+    Then all examples should pass
+    And the remaining temporary directories start with "marker"
+
+  Scenario: Delete directories afterwards
+    Given a file called "temporary_directory_spec.rb" with the following content:
+    """
+      require 'temporary_directory'
+
+      describe 'something' do
+        include GodObject::TemporaryDirectory::Helper
+
+        after(:example) { ensure_absence_of_temporary_directory }
+
+        specify { expect(123).to be_a Numeric }
+        specify { expect('abc').to be_a String }
+
+        describe 'temporary directory' do
+          subject { temporary_directory }
+
+          it { is_expected.to exist }
+
+          describe 'sub-directory' do
+            let(:sub_directory) do
+              directory = temporary_directory + 'sub'
+              directory.mkpath
+              directory
+            end
+
+            specify { expect(sub_directory).to exist }
+          end
+        end
+      end
+    """
+    When I run "rspec temporary_directory_spec.rb"
+    Then all examples should pass
+    And no temporary directories remain
+

data/lib/god_object/temporary_directory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'tmpdir'
+require 'pathname'
+
+module GodObject
+  module TemporaryDirectory
+
+  end
+end
+
+require_relative 'temporary_directory/service'
+require_relative 'temporary_directory/helper'

data/lib/god_object/temporary_directory/helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of TemporaryDirectory.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module GodObject
+  module TemporaryDirectory
+
+    module Helper
+      def self.new(name_prefix: nil,
+                   base_directory: nil,
+                   temporary_directory_service: Service.new(name_prefix: name_prefix, base_directory: base_directory))
+
+        mixin = Module.new do
+          include Helper
+        end
+
+        mixin.send(:define_method, :temporary_directory_service) do
+          temporary_directory_service
+        end
+
+        mixin
+      end
+
+      def temporary_directory
+        ensure_presence_of_temporary_directory
+      end
+
+      def ensure_presence_of_temporary_directory
+        @temporary_directory ||= create_temporary_directory!
+      end
+
+      def ensure_absence_of_temporary_directory
+        @temporary_directory.rmtree if @temporary_directory
+
+        nil
+      end
+
+      private
+
+      def create_temporary_directory!
+        temporary_directory_service.new
+      end
+
+      def temporary_directory_service
+        @temporary_directory_service ||= Service.new
+      end
+    end
+
+  end
+end