temporary_directory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ce91f96da436d8901e07f982d8736a1c87bc94d
+  data.tar.gz: 6375921dda9418de7fb7b5bb59c25b217b41f590
+SHA512:
+  metadata.gz: 411feed805f0fa06db42da47cc0d16d1401379525a63e2bf9a5473cd4f7216ff2777d3e61ba35fd2388e9fff7920fba0bb69c14c5efeb8f7cfa7eba95398d163
+  data.tar.gz: 4cfd8919efa569537a801e1c1cb06629ba6222192fac43bb8d2603db3614e9ec287e0421349654784c87943114342530b6f45e0e88fdf158c95f8179dc81eee4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+# Project metadata
+/nbproject
+/.idea
+
+/Gemfile.lock
+
+/doc/api
+/coverage
+/pkg
+/.yardoc
+.rbx
+*.rbc

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order random
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - rbx-2
+  - jruby-19mode

data/.yardopts

@@ -0,0 +1,9 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=kramdown
+--markup=markdown
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,25 @@
+# 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
+
+source 'https://rubygems.org'
+
+# Gem dependencies are specified in the .gemspec file
+gemspec
+
+gem 'coveralls', require: false

data/HISTORY.md

@@ -0,0 +1,4 @@
+0.1.0 / 2016-09-04
+
+    1 major enhancement
+        Birthday!

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+TemporaryDirectory is licensed under the following ISC-style license:
+
+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.

data/README.md

@@ -0,0 +1,219 @@
+TemporaryDirectory
+==================
+
+[![Gem Version](https://badge.fury.io/rb/temporary_directory.png)](https://badge.fury.io/rb/temporary_directory)
+[![Dependency Status](https://gemnasium.com/godobject/temporary_directory.png)](https://gemnasium.com/godobject/temporary_directory)
+[![Code Climate](https://codeclimate.com/github/godobject/temporary_directory.png)](https://codeclimate.com/github/godobject/temporary_directory)
+[![Build Status](https://secure.travis-ci.org/godobject/temporary_directory.png)](https://secure.travis-ci.org/godobject/temporary_directory)
+[![Coverage Status](https://coveralls.io/repos/github/godobject/temporary_directory/badge.svg?branch=master)](https://coveralls.io/github/godobject/temporary_directory?branch=master)
+
+* [Documentation][docs]
+* [Project][project]
+
+   [docs]:    http://rdoc.info/github/godobject/temporary_directory/
+   [project]: https://github.com/godobject/temporary_directory/
+
+Description
+-----------
+
+TemporaryDirectory is a Ruby library that contains a service class that
+creates temporary directories and returns Pathname objects to work with them.
+Additionally a helper module for RSpec and Cucumber provides temporary
+directories for examples and scenarios.
+
+Features / Problems
+-------------------
+
+This project tries to conform to:
+
+* [Semantic Versioning (2.0.0)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+
+Additional facts:
+
+* Written purely in Ruby.
+* Documented with Cucumber.
+* Automatically testable through Cucumber and RSpec.
+* Intended to be used with Ruby 2.1.8 or higher.
+* Cryptographically signed git tags.
+
+Requirements
+------------
+
+* Ruby 2.1.8 or higher
+
+Installation
+------------
+
+On *nix systems you may need to prefix the command with `sudo` to get root
+privileges.
+
+### Gem
+
+    gem install temporary_directory
+
+### Automated testing
+
+Go into the root directory of the installed gem and run the following command
+to fetch all development dependencies:
+
+    bundle
+
+Afterwards start the test runner:
+
+    rake spec
+
+If something goes wrong you should be notified through failing examples.
+
+Usage
+-----
+
+This documentation defines the public interface of the software. The version
+number of the software tracks changes to this public interface as described in
+[Semantic Versioning][semver]. Do not use elements that are marked as private.
+These elements are not guaranteed to exist in otherwise compatible future
+versions. Should you really need some parts that are currently marked as
+private, please contact us. We might be able to expose them as public
+interface for your convenience.
+
+This is still experimental software, even the public interface may change
+substantially in future releases.
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+
+### Ruby interface
+
+#### Loading
+
+In most cases you want to load the code by using the following command:
+
+~~~~~ ruby
+require 'temporary_directory'
+~~~~~
+
+In a bundler Gemfile you should use the following:
+
+~~~~~ ruby
+gem 'temporary_directory'
+~~~~~
+
+#### Namespace
+
+This project is contained within a namespace to avoid name collisions with
+other code. If you do not want to specifiy the namespace explicitly you can
+include it into the current scope by executing the following statement:
+
+~~~~~ ruby
+include GodObject::TemporaryDirectory
+~~~~~
+
+Development
+-----------
+
+### Bug reports and feature requests
+
+Please use the [issue tracker][issues] on github.com to let me know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/godobject/temporary_directory/issues/
+
+### Source code
+
+#### Distribution
+
+This software is developed in the source code management system Git. There are
+several synchronized mirror repositories available:
+
+* [GitHub][github] (located in California, USA)
+    
+    URI: https://github.com/godobject/temporary_directory.git
+
+* [GitLab][gitlab] (located in Illinois, USA)
+    
+    URI: https://gitlab.com/godobject/temporary_directory.git
+
+* [BitBucket][bitbucket] (located in California, USA)
+    
+    URI: https://bitbucket.org/godobject/temporary_directory.git
+
+* [Pikacode][pikacode] (located in France)
+
+    URI: https://pikacode.com/godobject/temporary_directory.git
+
+   [github]:    https://github.com/godobject/temporary_directory/
+   [gitlab]:    https://gitlab.com/godobject/temporary_directory/
+   [bitbucket]: https://bitbucket.org/godobject/temporary_directory/
+   [pikacode]:  https://pikacode.com/godobject/temporary_directory/
+
+You can get the latest source code with the following command, while
+exchanging the placeholder for one of the mirror URIs:
+
+    git clone MIRROR_URI
+
+#### Tags and cryptographic verification
+
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v". Every tag will be signed
+by Alexander E. Fischer's [OpenPGP public key][openpgp] which enables you to
+verify your copy of the code cryptographically.
+
+   [openpgp]: https://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag --verify [TAG NAME]
+
+#### Building gems
+
+To package your state of the source code into a gem package use the following
+command:
+
+    rake build
+
+The gem will be generated according to the .gemspec file in the project root
+directory and will be placed into the pkg/ directory.
+
+### Contribution
+
+Help on making this software better is always very appreciated. If you want
+your changes to be included in the official release, please clone the project
+on github.com, create a named branch to commit, push your changes into it and
+send a pull request afterwards.
+
+Please make sure to write tests for your changes so that no one else will break
+them when changing other things. Also notice that an inclusion of your changes
+cannot be guaranteed before reviewing them.
+
+The following people were involved in development:
+
+* Alexander E. Fischer <aef@godobject.net>
+
+License
+-------
+
+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.

data/Rakefile

@@ -0,0 +1,53 @@
+# 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 'bundler/gem_tasks'
+require 'rake'
+require 'pathname'
+require 'yard'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new
+Cucumber::Rake::Task.new
+
+desc 'Run RSpec code examples and Cucumber features'
+task :test => [:spec, :cucumber]
+
+YARD::Rake::YardocTask.new('doc')
+
+desc 'Removes temporary project files'
+task :clean do
+  %w{doc/api coverage pkg .yardoc .rbx Gemfile.lock}.map{|name| Pathname.new(name) }.each do |path|
+    path.rmtree if path.exist?
+  end
+
+  Pathname.glob('*.gem').each(&:delete)
+  Pathname.glob('**/*.rbc').each(&:delete)
+end
+
+desc 'Opens an interactive console with the project code loaded'
+task :console do
+  Bundler.setup
+  require 'pry'
+  require 'temporary_directory'
+  Pry.start(GodObject::TemporaryDirectory)
+end
+
+task default: :test

data/features/step_definitions/execute_cucumber.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
+
+When(/^I run "cucumber ?([^"]*)?"$/) do |arguments|
+  create_gemfile(include_gems: %w(cucumber))
+  create_root_for_subsequent_temporary_directories
+
+  execute_in_separate_environment(
+    %(TMPDIR="#{subsequent_temporary_directory_root_directory}" bundle exec cucumber #{arguments})
+  )
+end
+
+Then(/^all scenarios and their steps should pass$/) do
+  puts output unless $CHILD_STATUS.success?
+
+  expect($CHILD_STATUS).to be_success
+  expect(output).not_to match /failed|skipped/
+end

data/features/step_definitions/execute_rspec.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
+
+When(/^I run "rspec ([^"]*)"$/) do |arguments|
+  create_gemfile(include_gems: %w(rspec))
+  create_root_for_subsequent_temporary_directories
+
+  execute_in_separate_environment(
+    %(TMPDIR="#{subsequent_temporary_directory_root_directory}" bundle exec rspec #{arguments})
+  )
+end
+
+Then(/^all examples should pass$/) do
+  puts output unless $CHILD_STATUS.success?
+
+  expect($CHILD_STATUS).to be_success
+  expect(output).to include '0 failures'
+end

data/features/step_definitions/files.rb

@@ -0,0 +1,24 @@
+# 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
+
+Given(/^a file called "([^"]*)" with the following content:$/) do |relative_path, file_content|
+  file = temporary_directory / relative_path
+  file.parent.mkpath
+  file.write(file_content)
+end