memfs 0.4.1 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70a8628ef207a62b0e968c52b562a999eb9b17eb
+  data.tar.gz: da534038352ee4290851b8dc4f2f7aef7bed7cf5
+SHA512:
+  metadata.gz: c47dc6fe5eb179d3ee6d4e1e439e714d19920af0d474fa6166c1c8d75eb0c6a9c37d5115cf9db627e1801e0318dcb077620f05c87387428698061282610541a5
+  data.tar.gz: 218c397cacf5071ea1f83cfa06b12b8420bfef293390c652066f5548f6f9b7e9fba78e6d19af76f6d73a59bf0939a3ffdbcb66f7b649a9073ce9406c04fd5da0

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AlignParameters:
+  Enabled: false
+
+Blocks:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## HEAD
+
+## 0.4.2
+
+* ADD: `File#external_encoding`
+* FIX: Undefined local variable or method `fs' for MemFs::File
+
 ## 0.4.1
 
 * FIX: Support for 1.9.3 broken by File::FNM_EXTGLOB

data/Guardfile

@@ -1,8 +1,7 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
+guard :rspec, cmd: 'bundle exec rspec', all_after_pass: true, all_on_start: true do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+
+  watch('lib/memfs/io.rb')      { |m| 'spec/memfs/file_spec.rb' }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,4 +1,4 @@
-# MemFs
+![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)
@@ -83,7 +83,7 @@ you `spec_helper.rb` file:
 ``` ruby
 Rspec.configure do |c|
   c.around(:each, memfs: true) do |example|
-  MemFs.activate { example.run }
+    MemFs.activate { example.run }
   end
 end
 ```
@@ -93,7 +93,7 @@ And then write your specs like this:
 ``` ruby
 it "creates a file", memfs: true do
   subject.create_file('test.rb')
-  expect(File.exists?('test.rb')).to be_true
+  expect(File.exists?('test.rb')).to be true
 end
 ```
 
@@ -107,7 +107,7 @@ describe FileCreator do
     it "creates a file" do
       MemFs.activate do
         subject.create_file('test.rb')
-        expect(File.exists?('test.rb')).to be_true
+        expect(File.exists?('test.rb')).to be true
       end
     end
   end
@@ -126,7 +126,7 @@ describe FileCreator do
   describe '.create_file' do
     it "creates a file" do
       subject.create_file('test.rb')
-      expect(File.exists?('test.rb')).to be_true
+      expect(File.exists?('test.rb')).to be true
     end
   end
 end
@@ -145,7 +145,7 @@ end
 
 ## Requirements
 
-* Ruby 2.0+
+* Ruby 1.9.3 or newer
 
 ## Known issues
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'memfs'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 desc 'Compares a MemFs class to the original Ruby one ' \
      '(set CLASS to the compared class)'
@@ -36,3 +36,11 @@ task :compare do
   puts
   puts implemented_i_methods - original_i_methods
 end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'memfs'
+  ARGV.clear
+  IRB.start
+end

data/lib/memfs.rb

@@ -16,8 +16,6 @@ require 'fileutils'
 #   MemFs.deactivate!
 #   # Everything back to normal
 module MemFs
-  extend self
-
   # Keeps track of the original Ruby Dir class.
   OriginalDir  = ::Dir
 
@@ -56,6 +54,7 @@ module MemFs
   ensure
     deactivate!
   end
+  module_function :activate
 
   # Activates the fake file system.
   #
@@ -76,12 +75,13 @@ module MemFs
       remove_const :Dir
       remove_const :File
 
-      const_set :Dir,  MemFs::Dir
+      const_set :Dir, MemFs::Dir
       const_set :File, MemFs::File
     end
 
     MemFs::FileSystem.instance.clear!
   end
+  module_function :activate!
 
   # Deactivates the fake file system.
   #
@@ -94,10 +94,11 @@ module MemFs
       remove_const :Dir
       remove_const :File
 
-      const_set :Dir,  MemFs::OriginalDir
+      const_set :Dir, MemFs::OriginalDir
       const_set :File, MemFs::OriginalFile
     end
   end
+  module_function :deactivate!
 
   # Creates a file and all its parent directories.
   #
@@ -114,4 +115,5 @@ module MemFs
       FileUtils.touch path
     end
   end
+  module_function :touch
 end

data/lib/memfs/dir.rb

@@ -4,6 +4,7 @@ module MemFs
   class Dir
     extend FilesystemAccess
     include Enumerable
+    include FilesystemAccess
 
     attr_reader :pos
 
@@ -13,13 +14,11 @@ module MemFs
 
     def self.chdir(path, &block)
       fs.chdir path, &block
-      return 0
+      0
     end
 
     def self.chroot(path)
-      unless Process.uid.zero?
-        raise Errno::EPERM, path
-      end
+      fail Errno::EPERM, path unless Process.uid.zero?
 
       dir = fs.find_directory!(path)
       dir.name = '/'
@@ -27,14 +26,14 @@ module MemFs
       0
     end
 
-    def self.entries(dirname, opts = {})
+    def self.entries(dirname, _opts = {})
       fs.entries(dirname)
     end
 
     def self.exists?(path)
       File.directory?(path)
     end
-    class << self; alias :exist? :exists?; end
+    class << self; alias_method :exist?, :exists?; end
 
     def self.foreach(dirname, &block)
       return to_enum(__callee__, dirname) unless block
@@ -45,19 +44,20 @@ module MemFs
     def self.getwd
       fs.getwd
     end
-    class << self; alias :pwd :getwd; end
+    class << self; alias_method :pwd, :getwd; end
 
     def self.glob(patterns, flags = 0)
       patterns = [*patterns]
       list = fs.paths.select do |path|
-               patterns.any? do |pattern|
-                 File.fnmatch?(pattern, path, flags | GLOB_FLAGS)
-               end
-             end
+        patterns.any? do |pattern|
+          File.fnmatch?(pattern, path, flags | GLOB_FLAGS)
+        end
+      end
       # FIXME: ugly special case for /* and /
       list.delete('/') if patterns.first == '/*'
       return list unless block_given?
-      list.each { |path| yield path } and nil
+      list.each { |path| yield path }
+      nil
     end
 
     def self.home(*args)
@@ -89,8 +89,8 @@ module MemFs
     end
 
     class << self
-      alias :delete :rmdir
-      alias :unlink :rmdir
+      alias_method :delete, :rmdir
+      alias_method :unlink, :rmdir
     end
 
     def initialize(path)
@@ -101,9 +101,7 @@ module MemFs
     end
 
     def close
-      if state == :closed
-        fail IOError, 'closed directory'
-      end
+      fail IOError, 'closed directory' if state == :closed
       self.state = :closed
     end
 
@@ -115,7 +113,7 @@ module MemFs
     def path
       entry.path
     end
-    alias :to_path :path
+    alias_method :to_path, :path
 
     def pos=(position)
       seek(position)
@@ -135,9 +133,7 @@ module MemFs
     end
 
     def seek(position)
-      if (0..max_seek).cover?(position)
-        @pos = position
-      end
+      @pos = position if (0..max_seek).cover?(position)
       self
     end
 

data/lib/memfs/fake/entry.rb

@@ -50,8 +50,8 @@ module MemFs
         @dev ||= rand(1000)
       end
 
-      def find(path)
-        raise Errno::ENOTDIR, self.path
+      def find(_path)
+        fail Errno::ENOTDIR, path
       end
 
       def initialize(path = nil)

data/lib/memfs/fake/file/content.rb

@@ -1,4 +1,4 @@
-require "delegate"
+require 'delegate'
 
 module MemFs
   module Fake
@@ -20,7 +20,8 @@ module MemFs
         def puts(*strings)
           strings.each do |str|
             @string << str
-            @string << $/ unless str.end_with?($/)
+            next if str.end_with?($/)
+            @string << $/
           end
         end
 

data/lib/memfs/file.rb

@@ -1,25 +1,31 @@
 require 'forwardable'
 require 'memfs/filesystem_access'
+require 'memfs/io'
 
 module MemFs
   class File
     extend FilesystemAccess
     extend SingleForwardable
+    extend IO::ClassMethods
+
     include Enumerable
     include FilesystemAccess
     include OriginalFile::Constants
+    include IO::InstanceMethods
 
     MODE_MAP = {
       'r'  => RDONLY,
       'r+' => RDWR,
-      'w'  => CREAT|TRUNC|WRONLY,
-      'w+' => CREAT|TRUNC|RDWR,
-      'a'  => CREAT|APPEND|WRONLY,
-      'a+' => CREAT|APPEND|RDWR
+      'w'  => CREAT | TRUNC | WRONLY,
+      'w+' => CREAT | TRUNC | RDWR,
+      'a'  => CREAT | APPEND | WRONLY,
+      'a+' => CREAT | APPEND | RDWR
     }
 
     SUCCESS = 0
 
+    @umask = nil
+
     def_delegators :original_file_class,
                    :basename,
                    :dirname,
@@ -45,8 +51,6 @@ module MemFs
       :setuid?,
       :socket?,
       :sticky?,
-      :world_readable?,
-      :world_writable?,
       :writable?,
       :writable_real?,
       :zero?
@@ -56,6 +60,15 @@ module MemFs
       end                                                # end
     end
 
+    [
+      :world_readable?,
+      :world_writable?
+    ].each do |query_method|
+      define_singleton_method(query_method) do |path|    # def directory?(path)
+        stat_query(path, query_method, false)            #   stat_query(path, :directory?, false)
+      end                                                # end
+    end
+
     def self.absolute_path(path, dir_string = fs.pwd)
       original_file_class.absolute_path(path, dir_string)
     end
@@ -84,7 +97,7 @@ module MemFs
     def self.exists?(path)
       !!fs.find(path)
     end
-    class << self; alias :exist? :exists?; end
+    class << self; alias_method :exist?, :exists?; end
 
     def self.expand_path(file_name, dir_string = fs.pwd)
       original_file_class.expand_path(file_name, dir_string)
@@ -94,7 +107,7 @@ module MemFs
       fs.find!(path) && lstat(path).ftype
     end
 
-    class << self; alias :fnmatch? :fnmatch; end
+    class << self; alias_method :fnmatch?, :fnmatch; end
 
     def self.identical?(path1, path2)
       fs.find!(path1).dereferenced === fs.find!(path2).dereferenced
@@ -126,7 +139,7 @@ module MemFs
     end
 
     def self.open(filename, mode = RDONLY, *perm_and_opt)
-      file = self.new(filename, mode, *perm_and_opt)
+      file = new(filename, mode, *perm_and_opt)
 
       if block_given?
         yield file
@@ -137,21 +150,6 @@ module MemFs
       file.close if file && block_given?
     end
 
-    def self.read(path, *args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      options = { mode: RDONLY, encoding: nil, open_args: nil }.merge(options)
-      open_args = options[:open_args] ||
-                  [options[:mode], encoding: options[:encoding]]
-
-      length, offset = args
-
-      file = open(path, *open_args)
-      file.seek(offset || 0)
-      file.read(length)
-    ensure
-      file.close if file
-    end
-
     def self.readlink(path)
       fs.find!(path).target
     end
@@ -179,7 +177,11 @@ module MemFs
 
     def self.size?(path)
       file = fs.find(path)
-      file && file.size > 0 && file.size
+      if file && file.size > 0
+        file.size
+      else
+        false
+      end
     end
 
     def self.stat(path)
@@ -214,7 +216,7 @@ module MemFs
       end
       paths.size
     end
-    class << self; alias :delete :unlink; end
+    class << self; alias_method :delete, :unlink; end
 
     def self.utime(atime, mtime, *file_names)
       file_names.each do |file_name|
@@ -226,13 +228,17 @@ module MemFs
 
     attr_reader :path
 
-    def initialize(filename, mode = RDONLY, perm = nil, opt = nil)
-      unless opt.nil? || opt.is_a?(Hash)
-        raise ArgumentError, "wrong number of arguments (4 for 1..3)"
+    def initialize(filename, mode = File::RDONLY, *perm_and_or_opt)
+      opt = perm_and_or_opt.last.is_a?(Hash) ? perm_and_or_opt.pop : {}
+      perm = perm_and_or_opt.shift
+      if perm_and_or_opt.size > 0
+        fail ArgumentError, 'wrong number of arguments (4 for 1..3)'
       end
 
       @path = filename
+      @external_encoding = opt[:external_encoding] && Encoding.find(opt[:external_encoding])
 
+      self.closed = false
       self.opening_mode = str_to_mode_int(mode)
 
       fs.touch(filename) if create_file?
@@ -242,6 +248,10 @@ module MemFs
       entry.content.clear if truncate_file?
     end
 
+    def atime
+      File.atime(path)
+    end
+
     def chmod(mode_int)
       fs.chmod(mode_int, path)
       SUCCESS
@@ -252,76 +262,35 @@ module MemFs
       SUCCESS
     end
 
-    def close
-      self.closed = true
+    def ctime
+      File.ctime(path)
     end
 
-    def closed?
-      closed
+    def flock(*)
+      SUCCESS
     end
 
-    def each(sep = $/, &block)
-      return to_enum(__callee__) unless block_given?
-      fail IOError, 'not opened for reading' unless readable?
-      content.each_line(sep) { |line| block.call(line) }
-      self
+    def mtime
+      File.mtime(path)
     end
 
     def lstat
       File.lstat(path)
     end
 
-    def pos
-      entry.pos
-    end
-
-    def puts(text)
-      raise IOError, 'not opened for writing' unless writable?
-
-      content.puts text
-    end
-
-    def read(length = nil, buffer = '')
-      default = length ? nil : ''
-      content.read(length, buffer) || default
-    end
-
-    def seek(amount, whence = IO::SEEK_SET)
-      new_pos = case whence
-      when IO::SEEK_CUR then entry.pos + amount
-      when IO::SEEK_END then content.to_s.length + amount
-      when IO::SEEK_SET then amount
-      end
-
-      if new_pos.nil? || new_pos < 0
-        raise Errno::EINVAL, path
-      end
-
-      entry.pos = new_pos and 0
-    end
-
     def size
       entry.size
     end
 
-    def stat
-      File.stat(path)
-    end
-
-    def write(string)
-      raise IOError, 'not opened for writing' unless writable?
-
-      content.write(string.to_s)
+    def truncate(integer)
+      File.truncate(path, integer)
     end
 
     private
 
-    attr_accessor :closed,
-                  :entry,
-                  :opening_mode
-
     def self.dereference_name(path)
-      if entry = fs.find(path)
+      entry = fs.find(path)
+      if entry
         entry.dereferenced_name
       else
         basename(path)
@@ -349,47 +318,16 @@ module MemFs
     end
     private_class_method :original_file_class
 
-    def self.stat_query(path, query)
-      fs.find(path) && stat(path).public_send(query)
+    def self.stat_query(path, query, force_boolean = true)
+      response = fs.find(path) && stat(path).public_send(query)
+      force_boolean ? !!(response) : response
     end
     private_class_method :stat_query
 
     def self.lstat_query(path, query)
-      fs.find(path) && lstat(path).public_send(query)
+      response = fs.find(path) && lstat(path).public_send(query)
+      !!(response)
     end
     private_class_method :lstat_query
-
-    def content
-      entry.content
-    end
-
-    def str_to_mode_int(mode)
-      return mode unless mode.is_a?(String)
-
-      unless mode =~ /\A([rwa]\+?)([bt])?\z/
-        raise ArgumentError, "invalid access mode #{mode}"
-      end
-
-      mode_str = $~[1]
-      MODE_MAP[mode_str]
-    end
-
-    def create_file?
-      (opening_mode & File::CREAT).nonzero?
-    end
-
-    def readable?
-      (opening_mode & File::RDWR).nonzero? ||
-      (opening_mode | File::RDONLY).zero?
-    end
-
-    def truncate_file?
-      (opening_mode & File::TRUNC).nonzero?
-    end
-
-    def writable?
-      (opening_mode & File::WRONLY).nonzero? ||
-      (opening_mode & File::RDWR).nonzero?
-    end
   end
 end