ptools 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d3894b0714ef0f4a355c42a93c358269507bf5de5762965b632ee1631a2de9
-  data.tar.gz: 3650a31388b4207a99dc0145e599825c05fc9e412199c127f68133b8f98b4b1b
+  metadata.gz: 36d688bdf86ee95a0f1f6d422f75825903fc8ed26d821a69d617134d146a25e3
+  data.tar.gz: 574b230aff9a5b095f59cdbb6f1d7b65bc78b27970d4cc2ecc25a1fd67ecbaf0
 SHA512:
-  metadata.gz: 50097a799553a489ee29cc183f4c89473a827b63c1c3b668e4b2f4b4128099c0b494b24967e2f870717a8cfe3d65e43316cb0fc5b1f78255108db1ac933d0e16
-  data.tar.gz: 1e664973f17ec8b8c55515ffb1e6a8e24be2d3485203bccd5de9e812012fb5c6567a9d1ece397c9d62fbfb1f5fd8ff53dfcd5964c67ebb9670521494da9febe7
+  metadata.gz: 7a6ede88a24e97f927f6dcc81e9887a0d2b260013fe8e14931796489ec35723d9276651ddcd6ebd6d88cad32f65e0f1298234a0626af95b3b3c0ee157cc1c70a
+  data.tar.gz: 4bab6fdf21c8d7f0c3bae158319bb5b2131125d0d757e2d0c24b0d430345b7b7162bcf4b70e44d481c7d7c46aae7b3ead9545f4ad920038023511aa1190dc30d

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 1.5.1 - 27-Nov-2025
+* Refactoring release.
+* The wc('all') method now only does a single read instead of a double read.
+* The nl_convert method simplified to use the block form of File.open.
+* More consistent binary encoding calls.
+* Some magic numbers were replaced with constants.
+* Specs run in documentation mode.
+
 ## 1.5.0 - 5-Dec-2022
 * Change license to Apache-2.0.
 * Altered the File.binary? method. It no longer accepts a second argument,

data/Rakefile

@@ -82,6 +82,7 @@ namespace 'spec' do
 
   RSpec::Core::RakeTask.new(:all) do |t|
     t.pattern = 'spec/*_spec.rb'
+    t.rspec_opts = '-f documentation'
   end
 end
 

data/lib/ptools.rb

@@ -3,7 +3,7 @@ require 'win32/file' if File::ALT_SEPARATOR
 
 class File
   # The version of the ptools library.
-  PTOOLS_VERSION = '1.5.0'.freeze
+  PTOOLS_VERSION = '1.5.1'.freeze
 
   # :stopdoc:
 
@@ -11,7 +11,7 @@ class File
   if File::ALT_SEPARATOR
     MSWINDOWS = true
     if ENV['PATHEXT']
-      WIN32EXTS = ".{#{ENV['PATHEXT'].tr(';', ',').tr('.', '')}}".downcase
+      WIN32EXTS = String.new(".{#{ENV['PATHEXT'].tr(';', ',').tr('.', '')}}").downcase
     else
       WIN32EXTS = '.{exe,com,bat}'.freeze
     end
@@ -26,6 +26,10 @@ class File
 
   IMAGE_EXT = %w[.bmp .gif .jpg .jpeg .png .ico].freeze
 
+  # Constants for file operations
+  BLOCK_SIZE = 512
+  TAIL_CHUNK_SIZE = 2**16  # 64k chunks
+
   # :startdoc:
 
   # Returns whether or not the file is an image. Only JPEG, PNG, BMP,
@@ -90,7 +94,7 @@ class File
   #   File.which('ruby') # => '/usr/local/bin/ruby'
   #   File.which('foo')  # => nil
   #
-  def self.which(program, path = ENV['PATH'])
+  def self.which(program, path = ENV.fetch('PATH', nil))
     raise ArgumentError, 'path cannot be empty' if path.nil? || path.empty?
 
     # Bail out early if an absolute path is provided.
@@ -143,7 +147,7 @@ class File
   #   File.whereis('ruby') # => ['/usr/bin/ruby', '/usr/local/bin/ruby']
   #   File.whereis('foo')  # => nil
   #
-  def self.whereis(program, path = ENV['PATH'])
+  def self.whereis(program, path = ENV.fetch('PATH', nil))
     raise ArgumentError, 'path cannot be empty' if path.nil? || path.empty?
 
     paths = []
@@ -232,13 +236,11 @@ class File
   # to be configured in the future as an optional 3rd argument.
   #
   def self.tail(filename, num_lines = 10, &block)
-    tail_size = 2**16 # 64k chunks
-
     # MS Windows gets unhappy if you try to seek backwards past the
     # end of the file, so we have some extra checks here and later.
     file_size  = File.size(filename)
-    read_bytes = file_size % tail_size
-    read_bytes = tail_size if read_bytes == 0
+    read_bytes = file_size % TAIL_CHUNK_SIZE
+    read_bytes = TAIL_CHUNK_SIZE if read_bytes == 0
 
     line_sep = File::ALT_SEPARATOR ? "\r\n" : "\n"
 
@@ -252,7 +254,7 @@ class File
       while buf.scan(line_sep).size <= num_lines and position >= 0
         fh.seek(position, IO::SEEK_SET)
         buf = fh.read(read_bytes) + buf
-        read_bytes = tail_size
+        read_bytes = TAIL_CHUNK_SIZE
         position -= read_bytes
       end
     end
@@ -288,24 +290,23 @@ class File
     if old_file == new_file
       require 'tempfile'
       temp_name = Time.new.strftime('%Y%m%d%H%M%S')
-      nf = Tempfile.new("ruby_temp_#{temp_name}")
-    else
-      nf = File.new(new_file, 'w')
-    end
-
-    begin
-      nf.open if old_file == new_file
-      File.foreach(old_file) do |line|
-        line.chomp!
-        nf.print("#{line}#{format}")
-      end
-    ensure
-      nf.close if nf && !nf.closed?
-      if old_file == new_file
+      Tempfile.open("ruby_temp_#{temp_name}") do |nf|
+        File.foreach(old_file) do |line|
+          line.chomp!
+          nf.print("#{line}#{format}")
+        end
+        nf.close
         require 'fileutils'
         File.delete(old_file)
         FileUtils.mv(nf.path, old_file)
       end
+    else
+      File.open(new_file, 'w') do |nf|
+        File.foreach(old_file) do |line|
+          line.chomp!
+          nf.print("#{line}#{format}")
+        end
+      end
     end
 
     self
@@ -358,13 +359,13 @@ class File
       n
     else
       bytes, chars, lines, words = 0, 0, 0, 0
-      File.foreach(filename) do |line|
-        lines += 1
-        words += line.split.length
-        chars += line.chars.length
-      end
       File.open(filename) do |f|
-        bytes += 1 while f.getc
+        while (line = f.gets)
+          lines += 1
+          words += line.split.length
+          chars += line.chars.length
+          bytes += line.bytesize
+        end
       end
       [bytes, chars, words, lines]
     end
@@ -382,7 +383,7 @@ class File
     #
     def self.sparse?(file)
       stats = File.stat(file)
-      stats.size > stats.blocks * 512
+      stats.size > stats.blocks * BLOCK_SIZE
     end
   end
 
@@ -423,25 +424,25 @@ class File
   #
   def self.bmp?(file)
     data = File.read(file, 6, nil, :encoding => 'binary')
-    data[0,2] == 'BM' && File.size(file) == data[2,4].unpack('i').first
+    data[0, 2] == 'BM' && File.size(file) == data[2, 4].unpack1('i')
   end
 
   # Is the file a jpeg file?
   #
   def self.jpg?(file)
-    File.read(file, 10, nil, :encoding => 'binary') == "\377\330\377\340\000\020JFIF".force_encoding(Encoding::BINARY)
+    File.read(file, 10, nil, :encoding => 'binary') == "\xFF\xD8\xFF\xE0\x00\x10JFIF".force_encoding(Encoding::BINARY)
   end
 
   # Is the file a png file?
   #
   def self.png?(file)
-    File.read(file, 4, nil, :encoding => 'binary') == "\211PNG".force_encoding(Encoding::BINARY)
+    File.read(file, 4, nil, :encoding => 'binary') == "\x89PNG".force_encoding(Encoding::BINARY)
   end
 
   # Is the file a gif?
   #
   def self.gif?(file)
-    %w[GIF89a GIF97a].include?(File.read(file, 6))
+    %w[GIF89a GIF97a].include?(File.read(file, 6, nil, :encoding => 'binary'))
   end
 
   # Is the file a tiff?
@@ -449,7 +450,7 @@ class File
   def self.tiff?(file)
     return false if File.size(file) < 12
 
-    bytes = File.read(file, 4)
+    bytes = File.read(file, 4, nil, :encoding => 'binary')
 
     # II is Intel, MM is Motorola
     return false if bytes[0..1] != 'II' && bytes[0..1] != 'MM'
@@ -464,6 +465,6 @@ class File
   # Is the file an ico file?
   #
   def self.ico?(file)
-    ["\000\000\001\000", "\000\000\002\000"].include?(File.read(file, 4, nil, :encoding => 'binary'))
+    ["\x00\x00\x01\x00".force_encoding(Encoding::BINARY), "\x00\x00\x02\x00".force_encoding(Encoding::BINARY)].include?(File.read(file, 4, nil, :encoding => 'binary'))
   end
 end

data/ptools.gemspec

@@ -2,7 +2,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.5.0'
+  spec.version    = '1.5.1'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
@@ -25,7 +25,9 @@ Gem::Specification.new do |spec|
     'documentation_uri'     => 'https://github.com/djberg96/ptools/wiki',
     'source_code_uri'       => 'https://github.com/djberg96/ptools',
     'wiki_uri'              => 'https://github.com/djberg96/ptools/wiki',
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/ptools',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96'
   }
 
   spec.add_development_dependency('rake')

data/spec/binary_spec.rb

@@ -10,7 +10,7 @@ require 'ptools'
 
 RSpec.describe File, :binary do
   let(:dirname)  { described_class.dirname(__FILE__) }
-  let(:bin_file) { File::ALT_SEPARATOR ? described_class.join(ENV['windir'], 'notepad.exe') : '/bin/ls' }
+  let(:bin_file) { File::ALT_SEPARATOR ? described_class.join(ENV.fetch('windir', nil), 'notepad.exe') : '/bin/ls' }
 
   before do
     @txt_file = described_class.join(dirname, 'txt', 'english.txt')

data/spec/constants_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe File, :constants do
   let(:windows) { File::ALT_SEPARATOR }
 
   example 'PTOOLS_VERSION constant is set to expected value' do
-    expect(File::PTOOLS_VERSION).to eq('1.5.0')
+    expect(File::PTOOLS_VERSION).to eq('1.5.1')
     expect(File::PTOOLS_VERSION.frozen?).to be true
   end
 

data/spec/head_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe File, :head do
   end
 
   example 'head method returns the expected results' do
-    expect(described_class.head(test_file)).to be_kind_of(Array)
+    expect(described_class.head(test_file)).to be_a(Array)
     expect(described_class.head(test_file)).to eq(@expected_head1)
     expect(described_class.head(test_file, 5)).to eq(@expected_head2)
   end

data/spec/tail_spec.rb

@@ -74,7 +74,7 @@ RSpec.describe File, :tail do
   end
 
   example 'tail returns the expected values' do
-    expect(described_class.tail(test_file1)).to be_kind_of(Array)
+    expect(described_class.tail(test_file1)).to be_a(Array)
     expect(described_class.tail(test_file1)).to eq(@expected_tail1)
     expect(described_class.tail(test_file1, 5)).to eq(@expected_tail2)
   end

data/spec/wc_spec.rb

@@ -35,7 +35,7 @@ RSpec.describe File, :wc do
   end
 
   example 'wc with no option returns expected results' do
-    expect(described_class.wc(test_file)).to be_kind_of(Array)
+    expect(described_class.wc(test_file)).to be_a(Array)
     expect(described_class.wc(test_file)).to eq([166, 166, 25, 25])
   end
 

data/spec/whereis_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe File, :whereis do
   example 'whereis basic functionality' do
     expect(described_class).to respond_to(:whereis)
     expect{ described_class.whereis('ruby') }.not_to raise_error
-    expect(described_class.whereis('ruby')).to be_kind_of(Array).or be_nil
+    expect(described_class.whereis('ruby')).to be_a(Array).or be_nil
   end
 
   example 'whereis accepts an optional second argument' do
@@ -43,7 +43,7 @@ RSpec.describe File, :whereis do
 
   example 'whereis returns expected values' do
     expect{ @actual_locs = described_class.whereis(ruby) }.not_to raise_error
-    expect(@actual_locs).to be_kind_of(Array)
+    expect(@actual_locs).to be_a(Array)
     expect((@expected_locs & @actual_locs).size > 0).to be true
   end
 

data/spec/which_spec.rb

@@ -18,8 +18,8 @@ describe File, :which do
 
     Dir.mkdir(@dir) unless described_class.exist?(@dir)
     FileUtils.touch(@non_exe)
-    described_class.chmod(775, @dir)
-    described_class.chmod(644, @non_exe)
+    described_class.chmod(0775, @dir)
+    described_class.chmod(0644, @non_exe)
 
     @exe = described_class.join(
       RbConfig::CONFIG['bindir'],
@@ -40,7 +40,7 @@ describe File, :which do
   example 'which method basic functionality' do
     expect(described_class).to respond_to(:which)
     expect{ described_class.which(@ruby) }.not_to raise_error
-    expect(described_class.which(@ruby)).to be_kind_of(String)
+    expect(described_class.which(@ruby)).to be_a(String)
   end
 
   example 'which accepts an optional path to search' do
@@ -92,10 +92,10 @@ describe File, :which do
   end
 
   example 'resolves with with ~', :unix_only => true do
-    old_home = ENV['HOME']
+    old_home = Dir.home
     ENV['HOME'] = Dir::Tmpname.tmpdir
     program = Tempfile.new(['program', '.sh'])
-    described_class.chmod(755, program.path)
+    described_class.chmod(0755, program.path)
 
     expect(described_class.which(described_class.basename(program.path), '~/')).not_to be_nil
   ensure

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +34,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2022-12-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -145,7 +144,8 @@ metadata:
   source_code_uri: https://github.com/djberg96/ptools
   wiki_uri: https://github.com/djberg96/ptools/wiki
   rubygems_mfa_required: 'true'
-post_install_message:
+  github_repo: https://github.com/djberg96/ptools
+  funding_uri: https://github.com/sponsors/djberg96
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Extra methods for the File class
 test_files: []

metadata.gz.sig

@@ -1,2 +1 @@
-�ڏ-pY���0�STb��w�����t�Q�+��ǟIU��(�b�,�YTfSB���iL�&�)���
A��lׄ��EE���:y�ۮ���b�*��B�
-�������v� �k>���N�R'7��QaO�Y��#�D���@�	0w�J4�R����4�>�F��
]#�d�}�h��s�Kģ���!?���9�E��ʟDD
+AՇK����p�֑HH]C��Q�m�,hL��e;�ҟ�zƱS�qѶ�[�X���S���WD�sg��NUXm�2��?rDx�&o=�9��a�*X0�8Ӏ��Aml���磰k$5o�S�S���NZ���c+X͙��j�3�=���I
{���_�`W���i�r�Qb���* ��i=�r���Y�