memfs 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d538c6d82cd4bab8b5771b26592034f441692420
-  data.tar.gz: ef508f4172de7d3ab3c263dc147f70648178b0a7
+  metadata.gz: 3fb81cdc4d216ab47c2b1ffde22a27e9004e0fa2
+  data.tar.gz: 6736cda24f5ac40ed805dc60e1ee277e34b7014f
 SHA512:
-  metadata.gz: 96938d69ddeac5089c3524d7981d32f318df8dac36d60d74c79936588e1f6be79a3c17975c2f853fb604395115248329a269b9b86c0fbd2c3671523637f8e630
-  data.tar.gz: e7858942b018d861c17b6c15b680409f86e247b14242f38ffad7a7b89f5a17e8fa3fc1dfc1c09579e54fa706016f1169945ca28622c355c76556d480a1a4cf10
+  metadata.gz: 2b0832e3983bb55fa9993a376ed07cc3495109cbc627a1942d833068436c042ad29845b4722245f6ebf2046507d3c46ce1e8231c902323bbbe043d226a2713a9
+  data.tar.gz: 46bbea1467b7e6179c5ce60505d6de756acc7324eb68613d3e07e54781e4a4ef0fde50a21363569fe5052b77dcce580117aa33caccb9079b1c21d69b7ed48dee

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 lib/fileutils.rb
+spec/examples.txt

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .ruby-style.yml

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format=documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+./.ruby-style.yml

data/.ruby-style.yml

@@ -0,0 +1,335 @@
+AllCops:
+  Exclude:
+    - Guardfile
+    - lib/fileutils.rb
+    - "*.gemspec"
+    - "db/schema.rb"
+    - "vendor/**/*"
+  UseCache: false
+
+Metrics/LineLength:
+  Exclude:
+  - Rakefile
+  - "spec/**/*"
+Style/BlockDelimiters:
+  Description: abc
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
+  Enabled: true
+  EnforcedStyle: braces_for_chaining
+  SupportedStyles:
+  - braces_for_chaining
+  - line_count_based
+  - semantic
+  ProceduralMethods:
+  - around
+  - before
+  - benchmark
+  - bm
+  - bmbm
+  - create
+  - each_with_object
+  - measure
+  - new
+  - realtime
+  - tap
+  - with_object
+  FunctionalMethods:
+  - let
+  - let!
+  - subject
+  - watch
+  IgnoredMethods:
+  - context
+  - describe
+  - it
+  - lambda
+  - proc
+Style/CaseEquality:
+  Description: Avoid explicit use of the case equality operator(===).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-case-equality
+  Enabled: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "[]"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "[]"
+    "%W": "[]"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/RegexpLiteral:
+  Description: Checks if uses of regexps match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-r
+  Enabled: true
+  EnforcedStyle: mixed
+  SupportedStyles:
+    - mixed
+    - percent_r
+    - slashes
+  AllowInnerSlashes: false
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Style/TrailingCommaInArguments:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Style/TrivialAccessors:
+  Description: Prefer attr_* methods to trivial readers/writers.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr_family
+  Enabled: false
+  ExactNameMatch: true
+  AllowPredicates: false
+  AllowDSLWriters: false
+  IgnoreClassMethods: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+Style/ZeroLengthPredicate:
+  Exclude:
+    - lib/memfs/file.rb
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/MultilineOperationIndentation:
+  Description: Checks indentation of binary operations that span more than
+    one line.
+  Enabled: false
+  EnforcedStyle: aligned
+  SupportedStyles:
+  - aligned
+  - indented
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,9 @@
+# before_install:
+#   - gem update --system '2.4.5'
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.2
-  - 2.2.2
+  - 2.1.10
+  - 2.2.5
+  - 2.3.3
+  - 2.4.0

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## HEAD
+## 1.0.0
+
+:warning: This version drops support for Ruby 1.9.
+
+* ADD: Support for Ruby 2.4.0
+* ADD: Support for _Pathname_ in `Dir.glob` (PR #21 by @craigw)
+* ADD: `MemFs.halt` to switch back to the real file-system (PR #24 by @thsur)
+* ADD: Basic support for `IO.write` (PR #20 by @rmm5t)
+* FIX: Reset the file position when reopened (PR #23 by @jimpo)
+* FIX: Ignore trailing slashes when searching an entry (issue #26)
+* FIX: Making `File` inherit from `IO` to fix 3rd-party related issues
+* FIX: Ensure `File.new` on a symlink raises if target is absent
 
 ## 0.5.0
 

data/README.md

@@ -1,9 +1,9 @@
 ![MemFs Logo](https://raw.github.com/simonc/memfs/master/memfs.png)
 
-[![Gem Version](https://badge.fury.io/rb/memfs.png)](http://badge.fury.io/rb/memfs)
-[![Build Status](https://secure.travis-ci.org/simonc/memfs.png?branch=master)](http://travis-ci.org/simonc/memfs)
-[![Code Climate](https://codeclimate.com/github/simonc/memfs.png)](https://codeclimate.com/github/simonc/memfs)
-[![Coverage Status](https://coveralls.io/repos/simonc/memfs/badge.png?branch=master)](https://coveralls.io/r/simonc/memfs?branch=master)
+[![Gem Version](https://badge.fury.io/rb/memfs.svg)](https://badge.fury.io/rb/memfs)
+[![Build Status](https://api.travis-ci.org/simonc/memfs.svg?branch=master)](http://travis-ci.org/simonc/memfs)
+[![Code Climate](https://codeclimate.com/github/simonc/memfs/badges/gpa.svg)](https://codeclimate.com/github/simonc/memfs)
+[![Coverage Status](https://coveralls.io/repos/github/simonc/memfs/badge.svg?branch=master)](https://coveralls.io/github/simonc/memfs?branch=master)
 
 MemFs is an in-memory filesystem that can be used for your tests.
 
@@ -161,13 +161,14 @@ end
 
 ## Requirements
 
-* Ruby 1.9.3 or newer
+* Ruby 2.0 or newer
 
 ## Known issues
 
 * MemFs doesn't implement IO so methods like `FileUtils.copy_stream` and `IO.write` are still the originals.
 * Similarly, MemFs doesn't implement Kernel, so don't use a naked `open()` call. This uses the `Kernel` class via `method_missing`, which MemFs will not intercept.
 * Pipes and Sockets are not handled for now.
+* ~`require "pp"` will raise a _superclass mismatch_ exception since MemFs::File does not inherit from IO. The best thing to do is to require pp _before_ MemFs.~
 
 ## TODO
 

data/lib/memfs.rb

@@ -22,6 +22,9 @@ module MemFs
   # Keeps track of the original Ruby File class.
   OriginalFile = ::File
 
+  # Keeps track of the original Ruby IO class.
+  OriginalIO = ::IO
+
   require 'memfs/file_system'
   require 'memfs/dir'
   require 'memfs/file'
@@ -70,16 +73,18 @@ module MemFs
   #
   # @see #deactivate!
   # @return nothing.
-  def activate!
+  def activate!(clear: true)
     Object.class_eval do
       remove_const :Dir
       remove_const :File
+      remove_const :IO
 
       const_set :Dir, MemFs::Dir
+      const_set :IO, MemFs::IO
       const_set :File, MemFs::File
     end
 
-    MemFs::FileSystem.instance.clear!
+    MemFs::FileSystem.instance.clear! if clear
   end
   module_function :activate!
 
@@ -93,13 +98,35 @@ module MemFs
     Object.class_eval do
       remove_const :Dir
       remove_const :File
+      remove_const :IO
 
       const_set :Dir, MemFs::OriginalDir
+      const_set :IO, MemFs::OriginalIO
       const_set :File, MemFs::OriginalFile
     end
   end
   module_function :deactivate!
 
+  # Switches back to the original file system, calls the given block (if any),
+  # and switches back afterwards.
+  #
+  # If a block is given, all file & dir operations (like reading dir contents or
+  # requiring files) will operate on the original fs.
+  #
+  # @example
+  #   MemFs.halt do
+  #     puts Dir.getwd
+  #   end
+  # @return nothing
+  def halt
+    deactivate!
+
+    yield if block_given?
+  ensure
+    activate!(clear: false)
+  end
+  module_function :halt
+
   # Creates a file and all its parent directories.
   #
   # @param path: The path of the file to create.