pathname 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c42dd90f7949c457dd8225ff9f04ab3919a972ec4c4f41781784ee22e3957c47
-  data.tar.gz: 67971cc891a87efcadb29c62dea3bf429d74c5261711a83b8ccd45bbb2322028
+  metadata.gz: 222ab05e8698152edf5c4d2db5215d1385281d77e408234a03e9417d8f7e33c6
+  data.tar.gz: f267783875853911d60d63e08d7e871ba4562a84a73a335d1b72b453c3665a59
 SHA512:
-  metadata.gz: 0bc313f05de84a963277fb5814202b52c73dec674b195944f4255f80fc35b72a9dd00baea026826438524393baac08da00a723dcdc1fcf24bb49dff24a323be2
-  data.tar.gz: 1f4f1ec1ca815d7e857929ba474378d80b6e36ce5071fac4b3c1c12799a5a38eb951fc68361395274957c02ee67864dca30b8a2310d4521b65c51d97354b4788
+  metadata.gz: 0b2b4a31d31f5e5dc9fe356c6a25a5a8f40b573604c073b9090ec53c09bafac5aafa61339b1396136659ef0ddeb1932955eb4e43f2ab7d83a906509a9412b313
+  data.tar.gz: 789a9cd9d5929793cabecde7d8a023ce153d1b5c11ef85da85aa8e0a74a427c85162c7cc0d09e85c3f33e8ee2f2d43bfeabed665fdd5f2742dec3611662204dd

data/.git-blame-ignore-revs

@@ -0,0 +1,7 @@
+# This is a file used by GitHub to ignore the following commits on `git blame`.
+#
+# You can also do the same thing in your local repository with:
+# $ git config --local blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Expand tabs
+93e8aaadc7c7945895b1b0b6d9909134409517ff

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/test.yml

@@ -7,18 +7,21 @@ jobs:
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
-        os: [ ubuntu-latest, macos-latest ]
+        ruby: [ 2.7, '3.0', 3.1, head ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        exclude:
+        - { os: windows-latest , ruby: head }
+        include:
+        - { os: windows-latest , ruby: mingw }
+        - { os: windows-latest , ruby: mswin }
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
-      run: |
-        gem install bundler --no-document
-        bundle install
+      run: bundle install
     - name: Run test
       run: rake compile test

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
+*.bundle
+*.so

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem "rake"
 gem "rake-compiler"
+gem "test-unit"

data/README.md

@@ -1,8 +1,24 @@
 # Pathname
 
-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/pathname`. To experiment with that code, run `bin/console` for an interactive prompt.
+Pathname represents the name of a file or directory on the filesystem,
+but not the file itself.
 
-TODO: Delete this and the text above, and describe your gem
+The pathname depends on the Operating System: Unix, Windows, etc.
+This library works with pathnames of local OS, however non-Unix pathnames
+are supported experimentally.
+
+A Pathname can be relative or absolute.  It's not until you try to
+reference the file that it even matters whether the file exists or not.
+
+Pathname is immutable.  It has no method for destructive update.
+
+The goal of this class is to manipulate file path information in a neater
+way than standard Ruby provides.  The examples below demonstrate the
+difference.
+
+*All* functionality from File, FileTest, and some from Dir and FileUtils is
+included, in an unsurprising way.  It is essentially a facade for all of
+these, and more.
 
 ## Installation
 
@@ -22,15 +38,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'pathname'
+pn = Pathname.new("/usr/bin/ruby")
+size = pn.size              # 27662
+isdir = pn.directory?       # false
+dir  = pn.dirname           # Pathname:/usr/bin
+base = pn.basename          # Pathname:ruby
+dir, base = pn.split        # [Pathname:/usr/bin, Pathname:ruby]
+data = pn.read
+pn.open { |f| _ }
+pn.each_line { |line| _ }
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to compile this and 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/hsbpathname.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/pathname.

data/Rakefile

@@ -3,9 +3,17 @@ require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test/lib"
+  t.ruby_opts << "-rhelper"
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+task :sync_tool do
+  require 'fileutils'
+  FileUtils.cp "../ruby/tool/lib/core_assertions.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/envutil.rb", "./test/lib"
+  FileUtils.cp "../ruby/tool/lib/find_executable.rb", "./test/lib"
+end
+
 require 'rake/extensiontask'
 Rake::ExtensionTask.new("pathname")
 

data/ext/pathname/pathname.c

@@ -35,6 +35,7 @@ static ID id_lchmod;
 static ID id_lchown;
 static ID id_link;
 static ID id_lstat;
+static ID id_lutime;
 static ID id_mkdir;
 static ID id_mtime;
 static ID id_open;
@@ -360,10 +361,10 @@ path_each_line(int argc, VALUE *argv, VALUE self)
     args[0] = get_strpath(self);
     n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
     if (rb_block_given_p()) {
-        return rb_block_call(rb_cFile, id_foreach, 1+n, args, 0, 0);
+        return rb_block_call_kw(rb_cFile, id_foreach, 1+n, args, 0, 0, RB_PASS_CALLED_KEYWORDS);
     }
     else {
-        return rb_funcallv(rb_cFile, id_foreach, 1+n, args);
+        return rb_funcallv_kw(rb_cFile, id_foreach, 1+n, args, RB_PASS_CALLED_KEYWORDS);
     }
 }
 
@@ -764,6 +765,19 @@ path_utime(VALUE self, VALUE atime, VALUE mtime)
     return rb_funcall(rb_cFile, id_utime, 3, atime, mtime, get_strpath(self));
 }
 
+/*
+ * Update the access and modification times of the file.
+ *
+ * Same as Pathname#utime, but does not follow symbolic links.
+ *
+ * See File.lutime.
+ */
+static VALUE
+path_lutime(VALUE self, VALUE atime, VALUE mtime)
+{
+    return rb_funcall(rb_cFile, id_lutime, 3, atime, mtime, get_strpath(self));
+}
+
 /*
  * Returns the last component of the path.
  *
@@ -834,7 +848,7 @@ path_split(VALUE self)
     VALUE str = get_strpath(self);
     VALUE ary, dirname, basename;
     ary = rb_funcall(rb_cFile, id_split, 1, str);
-    ary = rb_check_array_type(ary);
+    Check_Type(ary, T_ARRAY);
     dirname = rb_ary_entry(ary, 0);
     basename = rb_ary_entry(ary, 1);
     dirname = rb_class_new_instance(1, &dirname, rb_obj_class(self));
@@ -1212,7 +1226,7 @@ path_entries(VALUE self)
     ary = rb_funcall(rb_cDir, id_entries, 1, str);
     ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary");
     for (i = 0; i < RARRAY_LEN(ary); i++) {
-	VALUE elt = RARRAY_AREF(ary, i);
+        VALUE elt = RARRAY_AREF(ary, i);
         elt = rb_class_new_instance(1, &elt, klass);
         rb_ary_store(ary, i, elt);
     }
@@ -1274,6 +1288,7 @@ static VALUE
 path_each_entry(VALUE self)
 {
     VALUE args[1];
+    RETURN_ENUMERATOR(self, 0, 0);
 
     args[0] = get_strpath(self);
     return rb_block_call(rb_cDir, id_foreach, 1, args, each_entry_i, rb_obj_class(self));
@@ -1464,6 +1479,7 @@ path_f_pathname(VALUE self, VALUE str)
  * - #make_symlink(old)
  * - #truncate(length)
  * - #utime(atime, mtime)
+ * - #lutime(atime, mtime)
  * - #basename(*args)
  * - #dirname
  * - #extname
@@ -1512,6 +1528,10 @@ path_f_pathname(VALUE self, VALUE str)
 void
 Init_pathname(void)
 {
+#ifdef HAVE_RB_EXT_RACTOR_SAFE
+    rb_ext_ractor_safe(true);
+#endif
+
     InitVM(pathname);
 
     rb_cPathname = rb_define_class("Pathname", rb_cObject);
@@ -1558,6 +1578,7 @@ Init_pathname(void)
     rb_define_method(rb_cPathname, "make_symlink", path_make_symlink, 1);
     rb_define_method(rb_cPathname, "truncate", path_truncate, 1);
     rb_define_method(rb_cPathname, "utime", path_utime, 2);
+    rb_define_method(rb_cPathname, "lutime", path_lutime, 2);
     rb_define_method(rb_cPathname, "basename", path_basename, -1);
     rb_define_method(rb_cPathname, "dirname", path_dirname, 0);
     rb_define_method(rb_cPathname, "extname", path_extname, 0);
@@ -1641,6 +1662,7 @@ InitVM_pathname(void)
     id_lchown = rb_intern("lchown");
     id_link = rb_intern("link");
     id_lstat = rb_intern("lstat");
+    id_lutime = rb_intern("lutime");
     id_mkdir = rb_intern("mkdir");
     id_mtime = rb_intern("mtime");
     id_open = rb_intern("open");

data/{ext/pathname/lib → lib}/pathname.rb

@@ -338,6 +338,8 @@ class Pathname
 
   #
   # Appends a pathname fragment to +self+ to produce a new Pathname object.
+  # Since +other+ is considered as a path relative to +self+, if +other+ is
+  # an absolute path, the new Pathname object is created from just +other+.
   #
   #   p1 = Pathname.new("/usr")      # Pathname:/usr
   #   p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
@@ -399,6 +401,8 @@ class Pathname
 
   #
   # Joins the given pathnames onto +self+ to create a new Pathname object.
+  # This is effectively the same as using Pathname#+ to append +self+ and
+  # all arguments sequentially.
   #
   #   path0 = Pathname.new("/usr")                # Pathname:/usr
   #   path0 = path0.join("bin/ruby")              # Pathname:/usr/bin/ruby
@@ -574,25 +578,26 @@ class Pathname    # * Find *
 end
 
 
+autoload(:FileUtils, 'fileutils')
+
 class Pathname    # * FileUtils *
   # Creates a full path, including any intermediate directories that don't yet
   # exist.
   #
   # See FileUtils.mkpath and FileUtils.mkdir_p
-  def mkpath
-    require 'fileutils'
-    FileUtils.mkpath(@path)
+  def mkpath(mode: nil)
+    FileUtils.mkpath(@path, mode: mode)
     nil
   end
 
   # Recursively deletes a directory, including all directories beneath it.
   #
-  # See FileUtils.rm_r
-  def rmtree
+  # See FileUtils.rm_rf
+  def rmtree(noop: nil, verbose: nil, secure: nil)
     # The name "rmtree" is borrowed from File::Path of Perl.
     # File::Path provides "mkpath" and "rmtree".
     require 'fileutils'
-    FileUtils.rm_r(@path)
+    FileUtils.rm_rf(@path, noop: noop, verbose: verbose, secure: secure)
     nil
   end
 end

data/pathname.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |spec|
   spec.name          = "pathname"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.1"
   spec.authors       = ["Tanaka Akira"]
   spec.email         = ["akr@fsij.org"]
 
   spec.summary       = %q{Representation of the name of a file or directory on the filesystem}
   spec.description   = %q{Representation of the name of a file or directory on the filesystem}
   spec.homepage      = "https://github.com/ruby/pathname"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     `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.executables   = []
   spec.require_paths = ["lib"]
   spec.extensions    = %w[ext/pathname/extconf.rb]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pathname
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tanaka Akira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Representation of the name of a file or directory on the filesystem
 email:
@@ -18,6 +18,8 @@ extensions:
 - ext/pathname/extconf.rb
 extra_rdoc_files: []
 files:
+- ".git-blame-ignore-revs"
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
@@ -27,8 +29,8 @@ files:
 - bin/console
 - bin/setup
 - ext/pathname/extconf.rb
-- ext/pathname/lib/pathname.rb
 - ext/pathname/pathname.c
+- lib/pathname.rb
 - pathname.gemspec
 homepage: https://github.com/ruby/pathname
 licenses:
@@ -45,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Representation of the name of a file or directory on the filesystem