memfs 0.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d538c6d82cd4bab8b5771b26592034f441692420
-  data.tar.gz: ef508f4172de7d3ab3c263dc147f70648178b0a7
+SHA256:
+  metadata.gz: 27052207df96c7c9a518a8bcc018c62de8a72c388cb4d6c7bd241186ec2783c4
+  data.tar.gz: 61071eb92a7564fe81153161a7c3cca8f70e3193c8a4df4fc81342afcc5a13c9
 SHA512:
-  metadata.gz: 96938d69ddeac5089c3524d7981d32f318df8dac36d60d74c79936588e1f6be79a3c17975c2f853fb604395115248329a269b9b86c0fbd2c3671523637f8e630
-  data.tar.gz: e7858942b018d861c17b6c15b680409f86e247b14242f38ffad7a7b89f5a17e8fa3fc1dfc1c09579e54fa706016f1169945ca28622c355c76556d480a1a4cf10
+  metadata.gz: 326ca1b9bd8a07852236436122cd88ab8f4feb43a4b5ae89f75e7a39e41b7e9734d676833aa3fe9145472d5453824f4d307b1a073694d17269106ae3903e93bc
+  data.tar.gz: a6a10d22ca624cf414851f1af6a5b644b3d2778d2ef984707c0bb93097be8be803d6e4f71fd24c2b33a4a590bd0c5ee0b3453fbdb845907bd28cc8cc1361ef0e

data/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+      time: '00:00'
+    target-branch: main
+    versioning-strategy: increase-if-necessary
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+      time: '00:00'
+    target-branch: main

data/.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: CI Workflow
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  # Run workflow manually
+  workflow_dispatch:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bin/rubocop
+
+  specs:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+        ruby:
+          - "4.0"
+          - "3.4"
+          - "3.3"
+          - "3.2"
+
+    env:
+      # Check for frozen strings
+      RUBYOPT: "--enable=frozen-string-literal --debug=frozen-string-literal"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: RSpec
+        run: bundle exec rspec
+
+      - name: Coverage Summary
+        if: success() || failure()
+        run: ruby bin/coverage_summary

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -1,29 +1,98 @@
-AlignParameters:
-  Enabled: false
+---
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
-Blocks:
-  Enabled: false
+AllCops:
+  Exclude:
+    - bin/*
+    - memfs.gemspec
+    - spec/**/*
+    - vendor/bundle/**/*
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
 
-ClassLength:
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
-Documentation:
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Exclude:
+    - Rakefile
+  Max: 100
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/ClassLength:
   Enabled: false
 
-DoubleNegation:
+Metrics/MethodLength:
+  Max: 10
+
+Naming/PredicatePrefix:
+  ForbiddenPrefixes:
+    - is_
+
+Security/Open:
   Enabled: false
 
-EmptyLinesAroundBody:
+Style/AccessModifierDeclarations:
   Enabled: false
 
-LineLength:
+Style/AndOr:
   Enabled: false
 
-PercentLiteralDelimiters:
+Style/Documentation:
   Enabled: false
 
-SpecialGlobalVars:
+Style/DoubleNegation:
   Enabled: false
 
-TrivialAccessors:
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': '[]'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '{}'
+    '%w': '[]'
+    '%W': '[]'
+    '%x': '{}'
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/SpecialGlobalVars:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -1,27 +1,58 @@
 # Changelog
 
-## HEAD
+## 2.0.0 (2026-02-03)
 
-## 0.5.0
+* ADD: Support for Ruby 3.x and 4.x
+* ADD: `Dir.empty?`
+* ADD: `IO#fileno` and `Dir#fileno` raise `NotImplementedError`
+* ADD: `File.birthtime` and `File#birthtime`
+* ADD: `File.empty?`
+* ADD: `File::Stat#nlink` (#39 by @djberg96)
+* ADD: `Dir.mktmpdir` (#52 by @djberg96)
+* ADD: Support for `Tempfile.create`
+* FIX: Fixing the inverted _read_ and _execute_ bitmasks (#41 by @micahlee)
+* ADD: Dependabot configuration
+* CHG: Replacing Travis CI with GitHub Actions
+* ADD: Adding Windows support
+
+### Breaking
+
+* **DEL: Dropping support for Ruby < 3.2**
+* CHG: Renaming the `master` branch to `main`
+
+## 1.0.0 (2017-01-01)
+
+: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 (2015-09-13)
 
 * ADD: Support for _mode_ to `Dir.mkdir`, `FileUtils.mkdir` and `FileUtils.mkdir_p` (@raeno)
 * ADD: Support for Ruby 2.2 (@raeno)
 
-## 0.4.3
+## 0.4.3 (2015-02-14)
 
 * ADD: `File::SEPARATOR` and `File::ALT_SEPARATOR`
 * FIX: Support `YAML.load_file` by handling `r:bom|utf-8` open mode
 
-## 0.4.2
+## 0.4.2 (2015-02-14)
 
 * ADD: `File#external_encoding`
 * FIX: Undefined local variable or method `fs' for MemFs::File
 
-## 0.4.1
+## 0.4.1 (2014-07-24)
 
 * FIX: Support for 1.9.3 broken by File::FNM_EXTGLOB
 
-## 0.4.0
+## 0.4.0 (2014-07-18)
 
 * ADD: `Dir.chroot`
 * ADD: `Dir.glob` and `Dir[]`
@@ -38,11 +69,11 @@
 * ADD: `Dir#to_path`
 * FIX: Internal implementation methods are now private
 
-## 0.3.0
+## 0.3.0 (2014-03-08)
 
 * FIX: The gem is now Ruby 1.9 compatible
 
-## 0.2.0
+## 0.2.0 (2014-03-07)
 
 * ADD: Allowing magic creation of files with `MemFs.touch`
 * ADD: `Dir#each`
@@ -54,10 +85,10 @@
 * ADD: `Dir.unlink`
 * FIX: File.new now truncates a file when opening mode says so
 
-## 0.1.0
+## 0.1.0 (2013-08-25)
 
 * ADD: Adding `File` missing methods - #3
 
-## 0.0.2
+## 0.0.2 (2013-07-12)
 
 * ADD: Adding the MIT license to the gemspec file - #2

data/Gemfile

@@ -1,4 +1,23 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in memfs.gemspec
 gemspec
+
+# Dev libs
+gem 'irb'
+gem 'listen', '~> 3.1'
+gem 'rake', '~> 13.0'
+gem 'rb-fchange', '~> 0.0'
+gem 'rb-fsevent', '~> 0.9'
+gem 'rb-inotify', '~> 0.8'
+gem 'rspec', '~> 3.0'
+gem 'simplecov'
+
+# Dev tools / linter
+gem 'guard-rspec',         require: false
+gem 'rubocop',             require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rake',        require: false
+gem 'rubocop-rspec',       require: false

data/Guardfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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/#{m[1]}_spec.rb" }
+  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' }
+  watch('lib/memfs/io.rb') { 'spec/memfs/file_spec.rb' }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

data/README.md

@@ -1,9 +1,9 @@
-![MemFs Logo](https://raw.github.com/simonc/memfs/master/memfs.png)
+![MemFs Logo](https://raw.github.com/simonc/memfs/main/memfs.png)
+
+[![Gem Version](https://badge.fury.io/rb/memfs.svg)](https://badge.fury.io/rb/memfs)
+[![Build Status](https://github.com/simonc/memfs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/simonc/memfs/actions/workflows/ci.yml)
+[![Code Climate](https://codeclimate.com/github/simonc/memfs/badges/gpa.svg)](https://codeclimate.com/github/simonc/memfs)
 
-[![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)
 
 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'memfs'
@@ -6,8 +8,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-desc 'Compares a MemFs class to the original Ruby one ' \
-     '(set CLASS to the compared class)'
+desc 'Compares a MemFs class to the original Ruby one (set CLASS to the compared class)'
 task :compare do
   class_name = ENV['CLASS'] || 'File'
   klass = Object.const_get(class_name)
@@ -37,6 +38,7 @@ task :compare do
   puts implemented_i_methods - original_i_methods
 end
 
+desc 'Starts a console session with the gem context loaded'
 task :console do
   require 'irb'
   require 'irb/completion'

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/coverage_summary

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+
+FileCoverage = Data.define(:path, :total, :covered, :missed) do
+  def percent = total.positive? ? (covered.to_f / total * 100).round(2) : 100.0
+end
+
+file = "coverage/.resultset.json"
+unless File.exist?(file)
+  warn "No coverage data found at #{file}"
+  exit
+end
+
+data = JSON.parse(File.read(file))
+coverage_data = data.values.first&.dig("coverage") || {}
+
+project_root = "#{Dir.pwd}/"
+
+files = coverage_data.map do |filepath, line_data|
+  lines = line_data.is_a?(Hash) ? line_data["lines"] : line_data
+  relevant = lines.compact.select { _1.is_a?(Integer) }
+
+  FileCoverage.new(
+    path: filepath.delete_prefix(project_root),
+    total: relevant.size,
+    covered: relevant.count(&:positive?),
+    missed: relevant.count(&:zero?)
+  )
+end
+
+files.sort_by!(&:percent)
+
+total_lines = files.sum(&:total)
+total_covered = files.sum(&:covered)
+total_missed = files.sum(&:missed)
+overall = total_lines.positive? ? (total_covered.to_f / total_lines * 100).round(2) : 100.0
+
+puts "Coverage: #{overall}% (#{total_covered}/#{total_lines} lines, #{total_missed} missed)"
+
+summary_path = ENV["GITHUB_STEP_SUMMARY"] or exit
+
+File.open(summary_path, "a") do |f|
+  f.puts "### Code Coverage: #{overall}%"
+  f.puts ""
+  f.puts "| File | Lines | Missed | Coverage |"
+  f.puts "|------|------:|-------:|---------:|"
+  files.each { f.puts "| #{_1.path} | #{_1.total} | #{_1.missed} | #{_1.percent}% |" }
+  f.puts "| **Total** | **#{total_lines}** | **#{total_missed}** | **#{overall}%** |"
+end

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")