fake_home 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a003250068366fcfa4f37a0bf370e8e0c2e6516
+  data.tar.gz: 68b801ad71065df8429f6201e0cb770dd78e049f
+SHA512:
+  metadata.gz: 2b30c0320f890e955a4c110e7ddcb42ed93ea3ce99a4b41c428467145b0cdec2e11c9231fdd72f0cfab4204a1e69326f9ac27a70ec9cf7e6d56fe596eee745df
+  data.tar.gz: 7ae37d20668b22002b574a3cedfa6676c400db98c903a8564c2981102ba8a9d2afcac6985ebdf0640071140a63eb14a570973bd9f8bbd7bf4ddba7f45b2b8866

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fake_home.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 DSIW
+
+MIT License
+
+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,35 @@
+# FakeHome
+
+It manipulates and restores your environment variable $HOME. I recommend to use it in your test suite.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fake_home'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake_home
+
+## Usage
+
+``` ruby
+include FakeHome
+
+Home.new("/tmp/fake_home").fake_home do |new_home|
+  new_home == ENV["HOME"]
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+
+require 'rake/clean'
+require 'rake/version_task'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+Rake::VersionTask.new
+
+task :doc => [ 'doc:clean', 'doc:api' ]
+
+CLOBBER << "doc"
+CLEAN << "doc"
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new(:api) do |t|
+    t.files = ['lib/**/*.rb']
+    t.options = [
+      '--output-dir', 'doc/api',
+      '--markup', 'markdown'
+    ]
+  end
+
+  desc 'Remove YARD Documentation'
+  task :clean do
+    system("rm -rf #{File.dirname(__FILE__)}/doc/api")
+  end
+end
+
+task :default => [:spec]

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/fake_home.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_home/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_home"
+  spec.version       = FakeHome::VERSION
+  spec.authors       = ["DSIW"]
+  spec.email         = ["dsiw@dsiw-it.de"]
+  spec.description   = %q{Manipulates your HOME environment variable.}
+  spec.summary       = %q{Manipulates and restores your HOME environment variable for test suites.}
+  spec.homepage      = "https://github.com/DSIW/fake_home"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('version')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('yard')
+end

data/lib/fake_home.rb

@@ -0,0 +1,2 @@
+require "fake_home/version"
+require "fake_home/fake_home"

data/lib/fake_home/fake_home.rb

@@ -0,0 +1,149 @@
+module FakeHome
+  require 'tempfile'
+  require 'tmpdir'
+
+  # Will be thrown if your HOME isn't prepared for restoring.
+  class PreparationError < StandardError; end
+
+  # It manipulates and restores your environment variable $HOME. I recommend to use it in your test suite.
+  #
+  # More examples are in each method. Take a look!
+  #
+  # @example
+  #   include FakeHome
+  #
+  #   Home.new("/tmp/fake_home").fake_home do |new_home|
+  #     new_home == ENV["HOME"]
+  #   end
+  class Home
+    # Default options for contructor
+    DEFAULT_OPTIONS = {prefix: "test", suffix: "home"}
+
+    # Prefix are the first few characters in the generated temporary directory.
+    attr_reader :prefix
+
+    # Suffix are the last few characters in the generated temporary directory.
+    attr_reader :suffix
+
+    # Stores your original HOME after preparation.
+    attr_reader :original_home
+
+    # Creates a new Home. If no explicit path is set, it will be generated a temporary one in your `/tmp` (see `@prepare`).
+    #
+    # @example
+    #   Home.new("/tmp/fake_home")
+    # @example
+    #   Home.new(prefix: "new_prefix").prefix #=> "new_prefix"
+    # @example
+    #   Home.new(suffix: "new_suffix").suffix #=> "new_suffix"
+    # @example
+    #   Home.new("/tmp/fake_home", suffix: "new_suffix")
+    def initialize(*args)
+      @fake_home = args.first if args.first.is_a? String
+      options = extract_init_options(args)
+      options = DEFAULT_OPTIONS.merge(options)
+      @prefix, @suffix = options[:prefix], options[:suffix]
+    end
+
+    # Prepares your new HOME. Old HOME will be saved and can be restored.
+    #
+    # @example
+    #   Home.new("/tmp/fake_home").prepare #=> "/tmp/fake_home"
+    #   Home.new.prepare #=> "/tmp/test_20130311-6400-1ku43dk_home"
+    #
+    # @example
+    #   home = Home.new("/tmp/fake_home")
+    #   ENV["HOME"] #=> "/home/username"
+    #   home.prepare
+    #   ENV["HOME"] #=> "/tmp/fake_home"
+    #
+    # @return new home path
+    def prepare
+      @original_home = ENV["HOME"]
+      @fake_home = mkdir
+      ENV["HOME"] = @fake_home
+    end
+
+    # Does your fake HOME exist?
+    #
+    # @example
+    #   home = Home.new
+    #   home.prepared? #=> false
+    #   home.prepare
+    #   home.prepared? #=> true
+    def prepared?
+      ENV["HOME"] == @fake_home
+    end
+
+    # Restores your original HOME.
+    #
+    # @raise PreparationError if not prepared
+    #
+    # @example
+    #   home = Home.new("/tmp/fake_home")
+    #   home.prepare
+    #   ENV["HOME"] #=> "/tmp/fake_home"
+    #   home.restore
+    #   ENV["HOME"] #=> "/home/username"
+    #
+    # @return original home path
+    def restore
+      raise PreparationError, "You have to prepare first." unless prepared?
+
+      FileUtils.rm_rf @fake_home
+      ENV["HOME"] = @original_home
+    end
+
+    # Does your orginial HOME exist?
+    #
+    # @example
+    #   home = Home.new
+    #   home.prepare
+    #   home.restored? #=> false
+    #   home.restore
+    #   home.restored? #=> true
+    def restored?
+      ENV["HOME"] == @original_home
+    end
+
+    # Gets your fake HOME path. If a block is set, you can work in it with your fake home. Everything outside will be
+    # your original home.
+    #
+    # @example
+    #   home = Home.new("/tmp/fake_home")
+    #   ENV["HOME"] #=> "/home/username"
+    #   home.fake_home do |home|
+    #     ENV["HOME"] #=> "/tmp/fake_home"
+    #   end
+    #   ENV["HOME"] #=> "/home/username"
+    #
+    # @return path of your fake home
+    def fake_home
+      if block_given?
+        prepare
+        yield @fake_home
+        restore
+      end
+      @fake_home
+    end
+
+    private
+
+    def extract_init_options(args)
+      last = args.last
+      if args && last && last.is_a?(Hash)
+        options = last
+      end
+      options ||= {}
+    end
+
+    def mkdir
+      if @fake_home
+        FileUtils.mkdir_p(@fake_home)
+        @fake_home
+      else
+        Dir.mktmpdir([@prefix+"_", "_"+@suffix], Dir.tmpdir)
+      end
+    end
+  end
+end

data/lib/fake_home/version.rb

@@ -0,0 +1,3 @@
+module FakeHome
+  VERSION = File.read(File.absolute_path("../../../VERSION", __FILE__))
+end

data/spec/fake_home_spec.rb

@@ -0,0 +1,149 @@
+require "spec_helper"
+
+describe Home do
+  let!(:old_home) { ENV["HOME"] }
+  let(:explicit_path) { "/tmp/fake_home" }
+  let(:tmp_path) { %r{/tmp/test_.+_home} }
+
+  subject { Home.new(*args) }
+  let(:args) { nil }
+
+  describe "#init" do
+    context "with set prefix and default suffix" do
+      let(:args) { [{prefix: "new_prefix"}] }
+
+      its(:prefix) { should == "new_prefix" }
+      its(:suffix) { should == "home" }
+    end
+
+    context "with default prefix and set suffix" do
+      let(:args) { [{suffix: "new_suffix"}] }
+
+      its(:prefix) { should == "test" }
+      its(:suffix) { should == "new_suffix" }
+    end
+
+    context "with explicit home path" do
+      let(:args) { explicit_path }
+
+      its(:fake_home) { should == explicit_path}
+    end
+
+    context "with explicit path and prefix" do
+      let(:args) { [explicit_path, prefix: "new_prefix"] }
+      its(:fake_home) { should == explicit_path}
+      its(:prefix) { should == "new_prefix" }
+    end
+  end
+
+  describe "#original_home" do
+    its(:original_home) { should be_nil }
+
+    context "after prepare" do
+      before { subject.prepare }
+      it "should be the old $HOME" do
+        subject.original_home.should == old_home
+      end
+    end
+  end
+
+  describe "#prepare" do
+    let(:args) { explicit_path }
+    before { subject.prepare }
+    it "should set new home in ENV" do
+      ENV["HOME"].should == explicit_path
+    end
+  end
+
+  describe "#prepared?" do
+    it "should not be prepared" do
+      subject.should_not be_prepared
+    end
+
+    context "after prepare" do
+      before { subject.prepare }
+      it "should be prepared" do
+        subject.should be_prepared
+      end
+    end
+  end
+
+  describe "#restore" do
+    it "should raise error if not prepared" do
+      expect{ subject.restore }.to raise_error PreparationError
+    end
+
+    context "when prepared and restored" do
+      before :each do
+        subject.prepare
+        subject.restore
+      end
+
+      it "should restore old home path in ENV" do
+        ENV["HOME"].should == old_home
+      end
+
+      it "should remove recursive fake_home directory" do
+        File.exist?(subject.fake_home).should be_false
+        subject.fake_home.should =~ tmp_path
+      end
+    end
+  end
+
+  describe "#restored?" do
+    it "should be restored" do
+      subject.should_not be_restored
+    end
+
+    context "after prepare" do
+      before { subject.prepare }
+      it "should not be restored" do
+        subject.should_not be_restored
+      end
+
+      context "after restore" do
+        before { subject.restore }
+        it "should be restored" do
+          subject.should be_restored
+        end
+      end
+    end
+  end
+
+  describe "#fake_home" do
+    let(:args) { explicit_path }
+
+    its(:fake_home) { should == explicit_path }
+
+    context "when block is given then" do
+      it "should not be prepared before fake_home call" do
+        subject.should_not be_prepared
+      end
+      it "should yield fake_home directory" do
+        expect { |b| subject.fake_home(&b) }.to yield_with_args(explicit_path)
+      end
+      it "should be restored after fake_home" do
+        subject.fake_home { |fake_home| }
+        subject.should be_restored
+      end
+    end
+  end
+
+  describe "Private methods" do
+    describe "#mkdir" do
+      its(:mkdir) { should =~ tmp_path }
+      it "should create the directory in filesystem" do
+        File.exist?(subject.send(:mkdir)).should be_true
+      end
+
+      context "when explicit path is set then" do
+        let(:args) { explicit_path }
+        before { subject.send(:mkdir) }
+        its(:mkdir) { should == explicit_path }
+        it "should create the directory in filesystem" do
+          File.exist?(subject.send(:mkdir)).should be_true
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'fake_home'
+
+RSpec.configure do |config|
+  include FakeHome
+
+  config.mock_with :rspec
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: fake_home
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DSIW
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manipulates your HOME environment variable.
+email:
+- dsiw@dsiw-it.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fake_home.gemspec
+- lib/fake_home.rb
+- lib/fake_home/fake_home.rb
+- lib/fake_home/version.rb
+- spec/fake_home_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DSIW/fake_home
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Manipulates and restores your HOME environment variable for test suites.
+test_files:
+- spec/fake_home_spec.rb
+- spec/spec_helper.rb
+has_rdoc: