file_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca21025c22dcba12e7baf4d9143e621eeec2f53e
+  data.tar.gz: c176bae86df4299a01bf9578f8b576e6330118a5
+SHA512:
+  metadata.gz: 584e278157a2ea0ae5cd628f88211ad416a5e545d79ff6d993d7e83edc97f22068536b464725befc7c080f356ea33d009bb785eca7e21aab687b3a313f4ac004
+  data.tar.gz: edaf395bf18e3baa12e11a33cf77a841bde035056bcd2f94b1183dbb4d05e838c562d1a03382b7ea780ed7d407a8a9e5e984f7fe012d12406224d5a78f9e68ae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=redcarpet
+--markup=markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at raymondzane@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    file_spec (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  file_spec!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ray Zane
+
+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,43 @@
+# FileSpec
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/file_spec`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'file_spec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_spec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/file_spec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FileSpec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/file_spec/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file_spec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file_spec.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "file_spec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_spec"
+  spec.version       = FileSpec::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+
+  spec.summary       = %q{RSpec helpers and matchers for testing the filesystem.}
+  spec.homepage      = "https://github.com/rzane/file_spec"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rzane/file_spec"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/file_spec.rb

@@ -0,0 +1,182 @@
+require "open3"
+require "tmpdir"
+require "fileutils"
+require "file_spec/version"
+
+# A set of RSpec utilities for testing files
+#
+# @example
+#   RSpec.configure do |config|
+#     config.include FileSpec
+#   end
+module FileSpec
+  # Include everything in the top-level by default
+  def self.included(base)
+    base.include FileSpec::Setup
+    base.include FileSpec::Helpers
+    base.include FileSpec::Matchers
+  end
+
+  # Include this module to automatically switch to a temporary
+  # directory before each test.
+  #
+  # @example
+  #   RSpec.configure do |config|
+  #     config.include FileSpec::Setup
+  #   end
+  module Setup
+    def self.included(base)
+      base.around :each do |example|
+        Dir.mktmpdir do |tmp|
+          Dir.chdir tmp do
+            example.run
+          end
+        end
+      end
+    end
+  end
+
+  # A set of helper methods for interacting with files
+  #
+  # @example
+  #   RSpec.configure do |config|
+  #     config.include FileSpec::Helpers
+  #   end
+  module Helpers
+    IGNORE = %w[.git .svn .venv .DS_Store node_modules *.o *.pyc *.class *.lock *.log]
+
+    # Create a directories if they do not exist.
+    # @param path [String,Pathname]
+    def mkdir(path)
+      FileUtils.mkdir_p(path)
+    end
+
+    # Write a file. This will automatically create directories if necessary.
+    # @param path [String,Pathname]
+    # @param content [String]
+    def write(path, content = "")
+      mkdir(File.dirname(path))
+      File.write(path, content)
+    end
+
+    # Read a file.
+    # @param path [String,Pathname]
+    def read(path)
+      File.read(path)
+    end
+
+    # Get the diff between two files or directories
+    # @param before [String,Pathname] file path of inital file or files
+    # @param after [String,Pathname] file path of changed file or files
+    # @param exclude [Array<String>] list of paths to ignore
+    def diff(before, after, exclude: [], **opts)
+      cmd = %w[diff --unified --new-file --recursive]
+      cmd += (exclude + IGNORE).flat_map { |path| ["--exclude", path] }
+      cmd += [before.to_s, after.to_s]
+
+      diff, _status = Open3.capture2e(*cmd, **opts)
+      diff = diff.gsub(/^diff --unified.*\n/, "")
+      diff.gsub(/^([+-]{3})\s(.*)\t\d{4}-.*$/, "\\1 \\2")
+    end
+
+    # Record changes to a file or directory over time
+    # @param path [String,Pathname] the path to observe
+    # @param opts [Hash] additional options passed to {#diff}
+    def record_changes(path, **opts)
+      basename = File.basename(path)
+
+      Dir.mktmpdir do |tmp|
+        before = File.join(tmp, "before", basename)
+        after = File.join(tmp, "after", basename)
+
+        unless File.directory?(path)
+          mkdir File.dirname(before)
+          mkdir File.dirname(after)
+        end
+
+        FileUtils.cp_r(path, before)
+        yield
+        FileUtils.cp_r(path, after)
+
+        diff("before", "after", chdir: tmp, **opts)
+      end
+    end
+  end
+
+  # A collection of RSpec matchers for making file assertions
+  #
+  # @example
+  #   RSpec.configure do |config|
+  #     config.include FileSpec::Matchers
+  #   end
+  module Matchers
+    extend ::RSpec::Matchers::DSL
+
+    # @!method have_content
+    # Determine if a file has matching content
+    #
+    # @example
+    #   expect("foo.txt").to have_content("bar")
+    #   expect("foo.txt").to have_content(/ba/)
+    matcher :have_content do |expected|
+      match do |actual|
+        @actual = File.read(actual)
+        values_match?(expected, @actual)
+      end
+
+      diffable if expected.is_a?(String)
+      description { "have content: #{description_of(expected)}" }
+    end
+
+    # @!method be_a_file
+    # Determine if a file exists
+    #
+    # @example
+    #   expect("foo.txt").to be_a_file
+    #   expect("bar.txt").not_to be_a_file
+    matcher :be_a_file do
+      match { |actual| File.file?(actual) }
+    end
+
+    # @!method be_a_directory
+    # Determine if a directory exists
+    #
+    # @example
+    #   expect("foo").to be_a_directory
+    #   expect("bar").not_to be_a_directory
+    matcher :be_a_directory do
+      match { |actual| File.directory?(actual) }
+    end
+
+    # @!method be_executable
+    # Test if a file is executable
+    #
+    # @example
+    #   expect("bin/rails").to be_executable
+    #   expect("Gemfile").not_to be_executable
+    matcher :be_executable do
+      match { |actual| File.executable?(actual) }
+    end
+
+    # @!method have_entries
+    # Find the files in a directory
+    #
+    # @example
+    #   expect("foo").to have_entries(%w[foo.txt bar.txt])
+    matcher :have_entries do |expected|
+      match do |actual|
+        root = Pathname.new(actual)
+
+        @expected = expected.sort
+        @actual = root.glob("**/*", File::FNM_DOTMATCH)
+          .select(&:file?)
+          .map { |path| path.relative_path_from(root).to_s }
+          .sort
+
+        values_match?(@expected, @actual)
+      end
+
+      description { "contain files: #{description_of(@expected)}" }
+    end
+  end
+end

data/lib/file_spec/version.rb

@@ -0,0 +1,3 @@
+module FileSpec
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: file_spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- file_spec.gemspec
+- lib/file_spec.rb
+- lib/file_spec/version.rb
+homepage: https://github.com/rzane/file_spec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rzane/file_spec
+  source_code_uri: https://github.com/rzane/file_spec
+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.6.14
+signing_key: 
+specification_version: 4
+summary: RSpec helpers and matchers for testing the filesystem.
+test_files: []