filesystem_cleaner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c89edfaacfe07d71c9bbb6fbfd87c2dfea1125be
+  data.tar.gz: c453a5267031e7c0e5716006dbb7cd59f4c954fe
+SHA512:
+  metadata.gz: 5673aed62a26c418fec4051e20c3840aa70bc34a3988b7bbb8d9e02e12179a5fc79d0c7089e14ff7e25d1062dc5918ebf9155aaabd9f58689450231766cba1a1
+  data.tar.gz: e95e818143a8996b2aaf2929ff114c000f35bc03a35e7e9a0983e1e093bcde14c6bc992b84034abbc85c1ce7f17b7c3362953cb0236a3027dc893a89d27945e7

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 filesystem_cleaner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Lorenz
+
+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,102 @@
+# FilesystemCleaner
+
+Like [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner), but for tests that do file manipulation.
+
+## Installation
+
+Add this line to your application's Gemfile and bundle:
+
+```ruby
+group :test do
+  gem 'filesystem_cleaner'
+end
+```
+
+## Usage
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+ fs_cleaner = FileSystemCleaner.new(
+   Rails.root.join("public", "system", "test", "files"),
+   Rails.root.join("tmp, "files.bak")
+ )
+
+ config.before(:each) { fs_cleaner.save_files!(example) }
+ config.after(:each)  { fs_cleaner.restore_files!(example) }
+end
+```
+
+```ruby
+# spec/some_spec.rb
+
+describe "a filesystem modification", file: true do  # `file: true` activates the cleaner
+  before do
+    test_file    = Rails.root.join("public", "system", "test", "files", "#{filename}.txt")
+    `cp #{fixture_file} #{test_file}`
+  end
+
+  it "reads the file" do
+    expect(MyFileReader.new(filename).to_s).to eq(File.read(fixture_file))
+  end
+
+  let(:filename)     { SecureRandom.uuid }
+  let(:fixture_file) { Rails.root.join("spec", "fixtures", "some_data.txt") }
+end
+```
+
+After the test runs, `public/system/test/files` is restored to it's pre-test state.
+
+## Bonus
+
+This has nothing to do with filesystem cleaner, but is a neat trick if you have to look at the files after the test to know if they were modified correctly (e.g. pdfs)
+
+```ruby
+describe "applying a signature", file: true do
+
+  before do
+    `cp #{Settings.fixture_drawing} #{working_file}`
+    post "/documents/#{document.id}/sign"
+  end
+
+  it "applies the engineer's signature" do
+     # `quality_assurance_dir` is _not_ cleaned by filesystem_cleaner
+    `cp #{working_file} #{Settings.quality_assurance_dir}`
+
+    fname = filename
+    RSpec.configure do |config|
+      config.after(:suite) do
+        qa_file_path = "#{Settings.quality_assurance_dir}/#{fname}"
+        message      = "ssh me@my-host cat #{qa_file_path} | display - "
+        puts
+        puts
+        print message
+      end
+    end
+  end
+
+end
+```
+
+Produces a nice output:
+```
+$ bundle exec rspec
+............*.......
+
+ssh me@my-host cat /home/me/app/spec/support/qa/b5f69a0-aa53-c39e0c27e2 | display -
+
+Pending:
+  Some spec is pending for some reason or other
+    # No reason given
+    # ./spec/mailers/mailer_spec.rb:8
+```
+
+Now you can just copy and paste that ssh command to view the file locally.
+
+## 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 @@
+require "bundler/gem_tasks"

data/filesystem_cleaner.gemspec

@@ -0,0 +1,59 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filesystem_cleaner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filesystem_cleaner"
+  spec.version       = FilesystemCleaner::VERSION
+  spec.authors       = ["Mark Lorenz"]
+  spec.email         = ["markjlorenz@dapplebeforedawn.com"]
+  spec.description   = %q{For tests that need to modify files}
+  spec.summary       = <<-SUMMARY
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+ fs_cleaner = FileSystemCleaner.new(
+   Rails.root.join("public", "system", "test", "files"),
+   Rails.root.join("tmp, "files.bak")
+ )
+
+ config.before(:each) { fs_cleaner.save_files!(example) }
+ config.after(:each)  { fs_cleaner.restore_files!(example) }
+end
+```
+
+```ruby
+# spec/some_spec.rb
+
+describe "a filesystem modification", file: true do  # `file: true` activates the cleaner
+  before do
+    test_file    = Rails.root.join("public", "system", "test", "files", "\#{filename}.txt")
+    `cp \#{fixture_file} \#{test_file}`
+  end
+
+  it "reads the file" do
+    expect(MyFileReader.new(filename).to_s).to eq(File.read(fixture_file))
+  end
+
+  let(:filename)     { SecureRandom.uuid }
+  let(:fixture_file) { Rails.root.join("spec", "fixtures", "some_data.txt") }
+end
+```
+
+After the test runs, `public/system/test/files` is restored to it's pre-test state.
+  SUMMARY
+  spec.homepage      = "https://github.com/dapplebeforedawn/filesystem-cleaner-gem"
+  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_dependency "rspec", "~>2.0"
+end

data/lib/filesystem_cleaner.rb

@@ -0,0 +1,40 @@
+require "filesystem_cleaner/version"
+
+# Usage:
+#
+# RSpec.configure do |config|
+#   fs_cleaner = FileSystemCleaner.new(
+#     Rails.root.join("public", "system", "test", "files"),
+#     Rails.root.join("tmp", "files.bak")
+#   )
+#
+#   config.before(:each) { fs_cleaner.save_files!(example) }
+#   config.after(:each)  { fs_cleaner.restore_files!(example) }
+# end
+#
+class FileSystemCleaner
+
+  attr_reader :filesystem_under_test, :backup_location
+
+  def initialize filesystem_under_test, backup_location
+    @filesystem_under_test = filesystem_under_test
+    @backup_location       = backup_location
+  end
+
+  def save_files!(example)
+    return unless should_perform?(example)
+    `rsync -a #{filesystem_under_test}/ #{backup_location}`
+  end
+
+  def restore_files!(example)
+    return unless should_perform?(example)
+    `rsync -a --delete #{backup_location}/ #{filesystem_under_test}/`
+  end
+
+  private
+
+  def should_perform?(example)
+    example.metadata[:file]
+  end
+
+end

data/lib/filesystem_cleaner/version.rb

@@ -0,0 +1,3 @@
+class FilesystemCleaner
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: filesystem_cleaner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Lorenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: For tests that need to modify files
+email:
+- markjlorenz@dapplebeforedawn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filesystem_cleaner.gemspec
+- lib/filesystem_cleaner.rb
+- lib/filesystem_cleaner/version.rb
+homepage: https://github.com/dapplebeforedawn/filesystem-cleaner-gem
+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.2.2
+signing_key: 
+specification_version: 4
+summary: '```ruby # spec/spec_helper.rb  RSpec.configure do |config| fs_cleaner =
+  FileSystemCleaner.new( Rails.root.join("public", "system", "test", "files"), Rails.root.join("tmp,
+  "files.bak") )  config.before(:each) { fs_cleaner.save_files!(example) } config.after(:each)  {
+  fs_cleaner.restore_files!(example) } end ```  ```ruby # spec/some_spec.rb  describe
+  "a filesystem modification", file: true do  # `file: true` activates the cleaner
+  before do test_file    = Rails.root.join("public", "system", "test", "files", "#{filename}.txt")
+  `cp #{fixture_file} #{test_file}` end  it "reads the file" do expect(MyFileReader.new(filename).to_s).to
+  eq(File.read(fixture_file)) end  let(:filename)     { SecureRandom.uuid } let(:fixture_file)
+  { Rails.root.join("spec", "fixtures", "some_data.txt") } end ```  After the test
+  runs, `public/system/test/files` is restored to it''s pre-test state.'
+test_files: []