pleasant_path 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ddfbea700d9c72193add267fe9a09e88bc5d99ff
-  data.tar.gz: 7b5bce70e3faad80ac3296767a6cbd8b398a454e
+SHA256:
+  metadata.gz: 56365c199042c351833d072a2e26985b4aceea7cb37fdd4fe8f21c038bdee6ed
+  data.tar.gz: dea582a2684edab33b60b3f4e3e624ff610d0a23a78fe17c62fbc71476e4c88e
 SHA512:
-  metadata.gz: fdf0eb05a7e27313ec2f0a9016319952c65a0931371b575fa4b72dd8959efc124db7272d3fd4c2d9bc35bde095839594110ce52be48de2ec467a6439f1b0a9bc
-  data.tar.gz: e67312af4aa40ed25954d05979983fe45a38f727c9810184e2a63eb45e7b6fb0c340ea5d765c10848143ad46cdccdd01ebefa199d06cbc576cc35fd0ae3df195
+  metadata.gz: 9242bc111208a89cad99db62ab0d1b01290ee9d9e59e63e2fe9a15a96fc736b67aea03b0f972cdceac46a0e95680b755db5524033357b711b128a38f0497be84
+  data.tar.gz: 8ee6d00eb11286b9d1e0fce25e69ced19c73e8135d2db58f24c4562184ca5a4baa56e3866f29fe522c1e3c032046e6805095f1717564f5e5beacc51d0f00da9e

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 1.2.0
+
+* Added `Pathname#existence`.
+* Added `Pathname#chdir`.
+* Fixed `Object#write_to_yaml` to make parent directories as necessary.
+
+## 1.1.0
+
+* Added `Pathname#copy` and `Pathname#copy_into`.
+* Added `Pathname#rename_basename` and `Pathname#rename_extname`.
+* Added `File.common_path` and `Pathname#common_path`.
+* Added `Pathname::NULL`.
+* Added JSON-related and YAML-related APIs.
+* Fixed `File.edit_text` and `File.edit_lines` to properly truncate.
+
+## 1.0.0
+
+* Initial release

data/README.md

@@ -30,6 +30,7 @@ The following methods are available:
   - [#append_file](http://www.rubydoc.info/gems/pleasant_path/Pathname:append_file)
   - [#append_lines](http://www.rubydoc.info/gems/pleasant_path/Pathname:append_lines)
   - [#append_text](http://www.rubydoc.info/gems/pleasant_path/Pathname:append_text)
+  - [#chdir](http://www.rubydoc.info/gems/pleasant_path/Pathname:chdir)
   - [#common_path](http://www.rubydoc.info/gems/pleasant_path/Pathname:common_path)
   - [#copy](http://www.rubydoc.info/gems/pleasant_path/Pathname:copy)
   - [#copy_into](http://www.rubydoc.info/gems/pleasant_path/Pathname:copy_into)
@@ -40,6 +41,7 @@ The following methods are available:
   - [#dirs_r](http://www.rubydoc.info/gems/pleasant_path/Pathname:dirs_r)
   - [#edit_lines](http://www.rubydoc.info/gems/pleasant_path/Pathname:edit_lines)
   - [#edit_text](http://www.rubydoc.info/gems/pleasant_path/Pathname:edit_text)
+  - [#existence](http://www.rubydoc.info/gems/pleasant_path/Pathname:existence)
   - [#files](http://www.rubydoc.info/gems/pleasant_path/Pathname:files)
   - [#files_r](http://www.rubydoc.info/gems/pleasant_path/Pathname:files_r)
   - [#make_dir](http://www.rubydoc.info/gems/pleasant_path/Pathname:make_dir)

data/lib/pleasant_path/file.rb

@@ -43,7 +43,7 @@ class File
   # @yieldreturn [String] new contents
   # @return [String]
   def self.edit_text(filename)
-    self.open(filename, 'r+') do |f|
+    self.open(filename, "r+") do |f|
       text = yield f.read
       f.seek(0, IO::SEEK_SET)
       f.write(text)
@@ -73,7 +73,7 @@ class File
   # @yieldreturn [Array<String>] new contents
   # @return [Array<String>]
   def self.edit_lines(filename)
-    self.open(filename, 'r+') do |f|
+    self.open(filename, "r+") do |f|
       lines = yield f.read_lines
       f.seek(0, IO::SEEK_SET)
       f.write_lines(lines)

data/lib/pleasant_path/io.rb

@@ -18,7 +18,7 @@ class IO
       self.write(line)
       self.write($/)
     end
-    self.write('') # write something even if no lines
+    self.write("") # write something even if no lines
     lines
   end
 

data/lib/pleasant_path/json/pathname.rb

@@ -52,7 +52,7 @@ class Pathname
   # @param options [Hash]
   # @return deserialized object
   def load_json(options = {})
-    self.open('r'){|f| JSON.load(f, nil, options) }
+    self.open("r"){|f| JSON.load(f, nil, options) }
   end
 
 end

data/lib/pleasant_path/pathname.rb

@@ -14,7 +14,7 @@ class Pathname
   end
 
   # Joins the parent (+dirname+) of the Pathname with the argument.  The
-  # mnenomic for this operator is that the resultant path goes up one
+  # mnemonic for this operator is that the resultant path goes up one
   # directory level from the original, then goes down to the directory
   # specified by the argument.
   #
@@ -37,6 +37,22 @@ class Pathname
     self.dirname.basename
   end
 
+  # Returns the Pathname if +exist?+ returns true, otherwise returns
+  # nil.
+  #
+  # @example
+  #   FileUtils.mkdir("dir1")
+  #   FileUtils.touch("dir1/file1")
+  #
+  #   Pathname.new("dir1/file1").existence  # == Pathname.new("dir1/file1")
+  #
+  #   Pathname.new("dir1/file2").existence  # == nil
+  #
+  # @return [Pathname, nil]
+  def existence
+    self if self.exist?
+  end
+
   # Computes the longest path that the Pathname and +other+ have in
   # common.  See also {File.common_path}.
   #
@@ -164,6 +180,48 @@ class Pathname
     self.find.select(&:file?)
   end
 
+  # Changes the current working directory to the directory indicated by
+  # the Pathname.  If a block is given, it is called with the Pathname,
+  # and the original working directory is restored after the block
+  # exits.
+  #
+  # Returns the return value of the block, if one is given.  Otherwise,
+  # returns the Pathname.
+  #
+  # Raises an exception if the directory indicated by the Pathname does
+  # not exist.
+  #
+  # See also +Dir::chdir+.
+  #
+  # @example
+  #   FileUtils.mkdir("dir1")
+  #   FileUtils.mkdir("dir2")
+  #
+  #   Pathname.new("dir1").chdir  # == Pathname.new("dir1")
+  #   Pathname.pwd                # == Pathname.new("dir1")
+  #
+  #   Pathname.new("dir2").chdir{|path| "in #{path}" }  # == "in dir2"
+  #   Pathname.pwd                                      # == Pathname.new("dir1")
+  #
+  # @overload chdir()
+  #   @return [Pathname]
+  # @overload chdir()
+  #   @yieldparam path [Pathname]
+  #   @yieldreturn [Object] block_retval
+  #   @return [block_retval]
+  # @raise [SystemCallError]
+  #   if the directory does not exist
+  def chdir
+    if block_given?
+      Dir.chdir(self) do |dir|
+        yield dir.to_pathname
+      end
+    else
+      Dir.chdir(self)
+      self
+    end
+  end
+
   # Alias of +Pathname#mkpath+, but this method returns the Pathname.
   #
   # @example
@@ -361,7 +419,9 @@ class Pathname
   # @param new_basename [String]
   # @return [Pathname]
   def rename_basename(new_basename)
-    self.move(self.dirname / new_basename)
+    new_path = self.dirname / new_basename
+    self.rename(new_path)
+    new_path
   end
 
   # Renames the file extension of the file indicated by the Pathname.
@@ -391,7 +451,9 @@ class Pathname
     unless new_extname.start_with?(".") || new_extname.empty?
       new_extname = ".#{new_extname}"
     end
-    self.move(self.sub_ext(new_extname))
+    new_path = self.sub_ext(new_extname)
+    self.rename(new_path)
+    new_path
   end
 
   # Writes given text to the file indicated by the Pathname, and returns
@@ -411,7 +473,7 @@ class Pathname
   # @param text [String]
   # @return [Pathname]
   def write_text(text)
-    self.make_dirname.open('w'){|f| f.write(text) }
+    self.make_dirname.open("w"){|f| f.write(text) }
     self
   end
 
@@ -432,7 +494,7 @@ class Pathname
   # @param text [String]
   # @return [Pathname]
   def append_text(text)
-    self.make_dirname.open('a'){|f| f.write(text) }
+    self.make_dirname.open("a"){|f| f.write(text) }
     self
   end
 
@@ -452,7 +514,7 @@ class Pathname
   # @param lines [Enumerable<#to_s>]
   # @return [Pathname]
   def write_lines(lines)
-    self.make_dirname.open('w'){|f| f.write_lines(lines) }
+    self.make_dirname.open("w"){|f| f.write_lines(lines) }
     self
   end
 
@@ -472,7 +534,7 @@ class Pathname
   # @param lines [Enumerable<#to_s>]
   # @return [Pathname]
   def append_lines(lines)
-    self.make_dirname.open('a'){|f| f.write_lines(lines) }
+    self.make_dirname.open("a"){|f| f.write_lines(lines) }
     self
   end
 
@@ -496,7 +558,7 @@ class Pathname
   #
   # @return [Array<String>]
   def read_lines
-    self.open('r'){|f| f.read_lines }
+    self.open("r"){|f| f.read_lines }
   end
 
   # Reads the contents of the file indicated by the Pathname into memory
@@ -563,7 +625,7 @@ class Pathname
   # @param source [String, Pathname]
   # @return [Pathname]
   def append_file(source)
-    self.open('a'){|destination| IO::copy_stream(source, destination) }
+    self.open("a"){|destination| IO::copy_stream(source, destination) }
     self
   end
 

data/lib/pleasant_path/string.rb

@@ -29,7 +29,7 @@ class String
 
   # Treating the string as a path, joins the parent (+dirname+) of the
   # path with the argument, and returns the result as a +Pathname+
-  # object.  The mnenomic for this operator is that the resultant path
+  # object.  The mnemonic for this operator is that the resultant path
   # goes up one directory level from the original, then goes down to the
   # directory specified by the argument.  See also {Pathname#^}.
   #

data/lib/pleasant_path/version.rb

@@ -1,3 +1,3 @@
 module PleasantPath
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/pleasant_path/yaml/object.rb

@@ -15,7 +15,9 @@ class Object
   # @param options [Hash]
   # @return [self]
   def write_to_yaml(file, options = {})
-    File.open(file, 'w'){|f| YAML.dump(self, f, options) }
+    file.to_pathname.make_dirname.open("w") do |f|
+      YAML.dump(self, f, options)
+    end
     self
   end
 

data/lib/pleasant_path/yaml/pathname.rb

@@ -12,7 +12,7 @@ class Pathname
   #
   # @return [nil, true, false, Numeric, String, Array, Hash]
   def read_yaml
-    self.open('r'){|f| YAML.safe_load(f, [], [], false, self) }
+    self.open("r"){|f| YAML.safe_load(f, [], [], false, self) }
   end
 
   # Reads the contents of the file indicated by the Pathname, and parses

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pleasant_path
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonathan Hefner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2018-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A fluent API for pleasant file IO.