ptools 1.4.2-universal-mingw32 → 1.4.3-universal-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9694f9c933387b24ebb3d67fd25dd3f317d1f770fb3a60cf6dad28d4f377d478
-  data.tar.gz: 1cc7c6ac40de18d9d1681399b15d6a911a19e0ae546f7e350824c18358e706fb
+  metadata.gz: 62ddf1987bbb18bc423f29d935e20c777be8a4c7b8761868dea85e2b0dfd34b0
+  data.tar.gz: 0c159601c5f2c369c6dea2a5690c852f1bd4f2f2758a56a46bfe68aac5634558
 SHA512:
-  metadata.gz: 4af9fe9d5e99b81958b6bc50c45fa0deb8a0fd9362c8dbe9aafb157a9d5054519827d2f912521ee5b7e8d40fe17838d72e800b1ae9d7f2218f1ba21c87feb23f
-  data.tar.gz: 48e8ea182f3b809bb1c732082274f0568593f720964566718ea4bd61f7302e57b3917e6700fc0504b14b377a78fd77c25e97abf5ffdc19550b63bbabee311846
+  metadata.gz: 8e555a0fb96caedb8f3dbc19d932aa4399ba21f711f0b7fc1cdddc585d0b6623fbb59a81f5ec204e44bafc3f0ebeea2138556cc2b2755042a82f8b9827c118a9
+  data.tar.gz: 6beaaabc8fe9dd953153adf0a0a03727584a9abd905c09b52b22d7881ff8eb30155b415e46375a64e750c9016cb2bb2fb04482f98bfa1e4dd59e5b4d2845a16b

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 1.4.3 - 26-Nov-2022
+* Added more image specs.
+* Updated the File.bmp? method. It now looks at the first six bytes, and
+  uses four of those bytes to verify the file size.
+
 ## 1.4.2 - 6-Jan-2021
 * Fixed a private access modifier that wasn't actually working as intended.
 * Two Windows constants that were never meant for public consumption have been marked private.

data/MANIFEST.md

@@ -17,6 +17,7 @@
 * spec/wc_spec.rb
 * spec/whereis_spec.rb
 * spec/which_spec.rb
+* spec/img/jpg_no_ext
 * spec/img/test.gif
 * spec/img/test.ico
 * spec/img/test.jpg

data/README.md

@@ -1,13 +1,18 @@
+[![Ruby](https://github.com/djberg96/ptools/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/ptools/actions/workflows/ruby.yml)
+
 ## Description
-  The ptools (power tools) library is an additional set of commands for the
-  File class based on Unix command line tools.
+The ptools (power tools) library is an additional set of commands for the
+File class based on Unix command line tools.
    
 ## Prerequisites
-  On MS Windows you will need the win32-file gem.
+On MS Windows you will need the win32-file gem.
 
 ## Installation
 `gem install ptools`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/ptools/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
 ```ruby
 require "ptools"
@@ -29,42 +34,42 @@ File.nl_convert("myfile", "newfile", "dos")
 ```
    
 ## Known Bugs
-  The File.which and File.whereis methods may fail when using JRuby on Windows.
-  See https://github.com/jruby/jruby/issues/2291 for details.
+The File.which and File.whereis methods may fail when using JRuby on Windows.
+See https://github.com/jruby/jruby/issues/2291 for details.
 
-  Please report any other issues on the github project page.
+Please report any other issues on the github project page.
 
-  http://www.github.com/djberg96/ptools
+http://www.github.com/djberg96/ptools
 
 ## Acknowledgements
-  The File.which method was originally adopted from the FileWhich code posted
-  by Michael Granger on the now defunct rubygarden.org website. That code was
-  later replaced by a version based on the ruby-which library.
+The `File.which` method was originally adopted from the `FileWhich` code posted
+by Michael Granger on the now defunct rubygarden.org website. That code was
+later replaced by a version based on the `ruby-which` library.
 
-  The File.nl_convert method is based on the nlcvt program found at
-  http://www.perl.com/language/ppt/src/nlcvt/nlcvt, written by Tom Christiansen.
+The `File.nl_convert` method is based on the nlcvt program found at
+http://www.perl.com/language/ppt/src/nlcvt/nlcvt, written by Tom Christiansen.
     
-  The binary?() method was based almost entirely on a blog post by Ryan
-  Davis (who, in turn, based his code on Perl's -B switch).
+The `binary?` method was based almost entirely on a blog post by Ryan
+Davis (who, in turn, based his code on Perl's -B switch).
 
-  Thanks go to Matt Hoyle for help with the File.tail method.
+Thanks go to Matt Hoyle for help with the File.tail method.
 
-  And thanks to any and all contributors!
+And thanks to any and all contributors!
 
 ## Future Plans
-  Add whatever other tools people think might be useful.
+Add whatever other tools people think might be useful.
    
 ## License
-  Artistic-2.0
+Artistic-2.0
     
 ## Copyright
-  (C) 2003-2020 Daniel J. Berger
-  All Rights Reserved.
+(C) 2003-2022 Daniel J. Berger
+All Rights Reserved.
     
 ## Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
 
 ## Author
-  Daniel J. Berger
+Daniel J. Berger

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 include RbConfig
 
 CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*", "**/*.lock")
@@ -18,7 +19,7 @@ namespace 'gem' do
   desc 'Create the ptools gem'
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('ptools.gemspec'))
+    spec = Gem::Specification.load('ptools.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -84,4 +85,6 @@ namespace 'spec' do
   end
 end
 
+RuboCop::RakeTask.new
+
 task :default => 'spec:all'

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.4.2'.freeze
+  PTOOLS_VERSION = '1.4.3'.freeze
 
   # :stopdoc:
 
@@ -11,9 +11,9 @@ class File
   if File::ALT_SEPARATOR
     MSWINDOWS = true
     if ENV['PATHEXT']
-      WIN32EXTS = ('.{' + ENV['PATHEXT'].tr(';', ',').tr('.','') + '}').downcase
+      WIN32EXTS = ".{#{ENV['PATHEXT'].tr(';', ',').tr('.', '')}}".downcase
     else
-      WIN32EXTS = '.{exe,com,bat}'
+      WIN32EXTS = '.{exe,com,bat}'.freeze
     end
   else
     MSWINDOWS = false
@@ -24,7 +24,7 @@ class File
     private_constant :MSWINDOWS
   end
 
-  IMAGE_EXT = %w[.bmp .gif .jpg .jpeg .png .ico]
+  IMAGE_EXT = %w[.bmp .gif .jpg .jpeg .png .ico].freeze
 
   # :startdoc:
 
@@ -47,12 +47,10 @@ class File
   # The approach I used here is based on information found at
   # http://en.wikipedia.org/wiki/Magic_number_(programming)
   #
-  def self.image?(file, check_file_extension = true)
+  def self.image?(file, check_file_extension: true)
     bool = bmp?(file) || jpg?(file) || png?(file) || gif?(file) || tiff?(file) || ico?(file)
 
-    if check_file_extension
-      bool = bool && IMAGE_EXT.include?(File.extname(file).downcase)
-    end
+    bool &&= IMAGE_EXT.include?(File.extname(file).downcase) if check_file_extension
 
     bool
   end
@@ -78,11 +76,12 @@ class File
     return false if File.stat(file).zero?
     return false if image?(file)
     return false if check_bom?(file)
+
     bytes = File.stat(file).blksize
     bytes = 4096 if bytes > 4096
-    s = (File.read(file, bytes) || "")
-    s = s.encode('US-ASCII', :undef => :replace).split(//)
-    ((s.size - s.grep(" ".."~").size) / s.size.to_f) > percentage
+    s = (File.read(file, bytes) || '')
+    s = s.encode('US-ASCII', :undef => :replace).chars
+    ((s.size - s.grep(' '..'~').size) / s.size.to_f) > percentage
   end
 
   # Looks for the first occurrence of +program+ within +path+.
@@ -98,10 +97,8 @@ class File
   #   File.which('ruby') # => '/usr/local/bin/ruby'
   #   File.which('foo')  # => nil
   #
-  def self.which(program, path=ENV['PATH'])
-    if path.nil? || path.empty?
-      raise ArgumentError, "path cannot be empty"
-    end
+  def self.which(program, path = ENV['PATH'])
+    raise ArgumentError, 'path cannot be empty' if path.nil? || path.empty?
 
     # Bail out early if an absolute path is provided.
     if program =~ /^\/|^[a-z]:[\\\/]/i
@@ -115,16 +112,17 @@ class File
     end
 
     # Iterate over each path glob the dir + program.
-    path.split(File::PATH_SEPARATOR).each{ |dir|
+    path.split(File::PATH_SEPARATOR).each do |dir|
       dir = File.expand_path(dir)
 
       next unless File.exist?(dir) # In case of bogus second argument
+
       file = File.join(dir, program)
 
       # Dir[] doesn't handle backslashes properly, so convert them. Also, if
       # the program name doesn't have an extension, try them all.
       if MSWINDOWS
-        file = file.tr("\\", "/")
+        file = file.tr(File::ALT_SEPARATOR, File::SEPARATOR)
         file += WIN32EXTS if File.extname(program).empty?
       end
 
@@ -135,7 +133,7 @@ class File
         found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
         return found
       end
-    }
+    end
 
     nil
   end
@@ -152,21 +150,19 @@ class File
   #   File.whereis('ruby') # => ['/usr/bin/ruby', '/usr/local/bin/ruby']
   #   File.whereis('foo')  # => nil
   #
-  def self.whereis(program, path=ENV['PATH'])
-    if path.nil? || path.empty?
-      raise ArgumentError, "path cannot be empty"
-    end
+  def self.whereis(program, path = ENV['PATH'])
+    raise ArgumentError, 'path cannot be empty' if path.nil? || path.empty?
 
     paths = []
 
     # Bail out early if an absolute path is provided.
     if program =~ /^\/|^[a-z]:[\\\/]/i
       program += WIN32EXTS if MSWINDOWS && File.extname(program).empty?
-      program = program.tr("\\", '/') if MSWINDOWS
+      program = program.tr(File::ALT_SEPARATOR, File::SEPARATOR) if MSWINDOWS
       found = Dir[program]
       if found[0] && File.executable?(found[0]) && !File.directory?(found[0])
         if File::ALT_SEPARATOR
-          return found.map{ |f| f.tr('/', "\\") }
+          return found.map{ |f| f.tr(File::SEPARATOR, File::ALT_SEPARATOR) }
         else
           return found
         end
@@ -176,14 +172,15 @@ class File
     end
 
     # Iterate over each path glob the dir + program.
-    path.split(File::PATH_SEPARATOR).each{ |dir|
+    path.split(File::PATH_SEPARATOR).each do |dir|
       next unless File.exist?(dir) # In case of bogus second argument
+
       file = File.join(dir, program)
 
       # Dir[] doesn't handle backslashes properly, so convert them. Also, if
       # the program name doesn't have an extension, try them all.
       if MSWINDOWS
-        file = file.tr("\\", "/")
+        file = file.tr(File::ALT_SEPARATOR, File::SEPARATOR)
         file += WIN32EXTS if File.extname(program).empty?
       end
 
@@ -194,7 +191,7 @@ class File
         found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
         paths << found
       end
-    }
+    end
 
     paths.empty? ? nil : paths.uniq
   end
@@ -210,20 +207,21 @@ class File
   #  # Use a block
   #  File.head('somefile.txt'){ |line| puts line }
   #
-  def self.head(filename, num_lines=10)
+  def self.head(filename, num_lines = 10)
     a = []
 
-    IO.foreach(filename){ |line|
+    File.foreach(filename) do |line|
       break if num_lines <= 0
+
       num_lines -= 1
       if block_given?
         yield line
       else
         a << line
       end
-    }
+    end
 
-    return a.empty? ? nil : a # Return nil in block form
+    a.empty? ? nil : a # Return nil in block form
   end
 
   # In block form, yields the last +num_lines+ of file +filename+.
@@ -240,7 +238,7 @@ class File
   # Internally I'm using a 64 chunk of memory at a time. I may allow the size
   # to be configured in the future as an optional 3rd argument.
   #
-  def self.tail(filename, num_lines=10)
+  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
@@ -254,7 +252,7 @@ class File
     buf = ''
 
     # Open in binary mode to ensure line endings aren't converted.
-    File.open(filename, 'rb'){ |fh|
+    File.open(filename, 'rb') do |fh|
       position = file_size - read_bytes # Set the starting read position
 
       # Loop until we have the lines or run out of file
@@ -264,12 +262,12 @@ class File
         read_bytes = tail_size
         position -= read_bytes
       end
-    }
+    end
 
     lines = buf.split(line_sep).pop(num_lines)
 
     if block_given?
-      lines.each{ |line| yield line  }
+      lines.each(&block)
     else
       lines
     end
@@ -290,47 +288,33 @@ class File
   # ArgumentError is raised.
   #
   def self.nl_convert(old_file, new_file = old_file, platform = 'local')
-    unless File::Stat.new(old_file).file?
-      raise ArgumentError, 'Only valid for plain text files'
-    end
+    raise ArgumentError, 'Only valid for plain text files' unless File::Stat.new(old_file).file?
 
     format = nl_for_platform(platform)
 
-    orig = $\ # $OUTPUT_RECORD_SEPARATOR
-    $\ = format
-
     if old_file == new_file
-      require 'fileutils'
       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
-        temp_name = Time.new.strftime("%Y%m%d%H%M%S")
-        tf = Tempfile.new('ruby_temp_' + temp_name)
-        tf.open
-
-        IO.foreach(old_file){ |line|
-          line.chomp!
-          tf.print line
-        }
-      ensure
-        tf.close if tf && !tf.closed?
+    begin
+      nf.open if old_file == new_file
+      File.foreach(old_file) do |line|
+        line.chomp!
+        nf.print("#{line}#{format}")
       end
-
-      File.delete(old_file)
-      FileUtils.mv(tf.path, old_file)
-    else
-      begin
-        nf = File.new(new_file, 'w')
-        IO.foreach(old_file){ |line|
-          line.chomp!
-          nf.print line
-        }
-      ensure
-        nf.close if nf && !nf.closed?
+    ensure
+      nf.close if nf && !nf.closed?
+      if old_file == new_file
+        require 'fileutils'
+        File.delete(old_file)
+        FileUtils.mv(nf.path, old_file)
       end
     end
 
-    $\ = orig
     self
   end
 
@@ -353,49 +337,43 @@ class File
   # Valid options are 'bytes', 'characters' (or just 'chars'), 'words' and
   # 'lines'.
   #
-  def self.wc(filename, option='all')
+  def self.wc(filename, option = 'all')
     option.downcase!
-    valid = %w/all bytes characters chars lines words/
+    valid = %w[all bytes characters chars lines words]
 
-    unless valid.include?(option)
-      raise ArgumentError, "Invalid option: '#{option}'"
-    end
+    raise ArgumentError, "Invalid option: '#{option}'" unless valid.include?(option)
 
     n = 0
 
     if option == 'lines'
-      IO.foreach(filename){ n += 1 }
-      return n
+      File.foreach(filename){ n += 1 }
+      n
     elsif option == 'bytes'
-      File.open(filename){ |f|
+      File.open(filename) do |f|
         f.each_byte{ n += 1 }
-      }
-      return n
-    elsif option == 'characters' || option == 'chars'
-      File.open(filename){ |f|
-        while f.getc
-          n += 1
-        end
-      }
-      return n
+      end
+      n
+    elsif %w[characters chars].include?(option)
+      File.open(filename) do |f|
+        n += 1 while f.getc
+      end
+      n
     elsif option == 'words'
-      IO.foreach(filename){ |line|
+      File.foreach(filename) do |line|
         n += line.split.length
-      }
-      return n
+      end
+      n
     else
-      bytes,chars,lines,words = 0,0,0,0
-      IO.foreach(filename){ |line|
+      bytes, chars, lines, words = 0, 0, 0, 0
+      File.foreach(filename) do |line|
         lines += 1
         words += line.split.length
-        chars += line.split('').length
-      }
-      File.open(filename){ |f|
-        while f.getc
-          bytes += 1
-        end
-      }
-      return [bytes,chars,words,lines]
+        chars += line.chars.length
+      end
+      File.open(filename) do |f|
+        bytes += 1 while f.getc
+      end
+      [bytes, chars, words, lines]
     end
   end
 
@@ -422,9 +400,9 @@ class File
     text = File.read(file, 4).force_encoding('utf-8')
 
     bool = false
-    bool = true if text[0,3] == "\xEF\xBB\xBF"
-    bool = true if text[0,4] == "\x00\x00\xFE\xFF" || text[0,4] == "\xFF\xFE\x00\x00"
-    bool = true if text[0,2] == "\xFF\xFE" || text[0,2] == "\xFE\xFF"
+    bool = true if text[0, 3] == "\xEF\xBB\xBF"
+    bool = true if text[0, 4] == "\x00\x00\xFE\xFF" || text[0, 4] == "\xFF\xFE\x00\x00"
+    bool = true if text[0, 2] == "\xFF\xFE" || text[0, 2] == "\xFE\xFF"
 
     bool
   end
@@ -434,42 +412,43 @@ class File
   # Returns the newline characters for the given platform.
   #
   def self.nl_for_platform(platform)
-    platform = RbConfig::CONFIG["host_os"] if platform == 'local'
+    platform = RbConfig::CONFIG['host_os'] if platform == 'local'
 
     case platform
       when /dos|windows|win32|mswin|mingw/i
-        return "\cM\cJ"
+        "\cM\cJ"
       when /unix|linux|bsd|cygwin|osx|darwin|solaris|sunos/i
-        return "\cJ"
+        "\cJ"
       when /mac|apple|macintosh/i
-        return "\cM"
+        "\cM"
       else
-        raise ArgumentError, "Invalid platform string"
+        raise ArgumentError, 'Invalid platform string'
     end
   end
 
   # Is the file a bitmap file?
   #
   def self.bmp?(file)
-    IO.read(file, 3) == "BM6"
+    data = File.read(file, 6, nil, :encoding => 'binary')
+    data[0,2] == 'BM' && File.size(file) == data[2,4].unpack('i').first
   end
 
   # Is the file a jpeg file?
   #
   def self.jpg?(file)
-    IO.read(file, 10, nil, :encoding => 'binary') == "\377\330\377\340\000\020JFIF".force_encoding(Encoding::BINARY)
+    File.read(file, 10, nil, :encoding => 'binary') == "\377\330\377\340\000\020JFIF".force_encoding(Encoding::BINARY)
   end
 
   # Is the file a png file?
   #
   def self.png?(file)
-    IO.read(file, 4, nil, :encoding => 'binary') == "\211PNG".force_encoding(Encoding::BINARY)
+    File.read(file, 4, nil, :encoding => 'binary') == "\211PNG".force_encoding(Encoding::BINARY)
   end
 
   # Is the file a gif?
   #
   def self.gif?(file)
-    ['GIF89a', 'GIF97a'].include?(IO.read(file, 6))
+    %w[GIF89a GIF97a].include?(File.read(file, 6))
   end
 
   # Is the file a tiff?
@@ -477,20 +456,14 @@ class File
   def self.tiff?(file)
     return false if File.size(file) < 12
 
-    bytes = IO.read(file, 4)
+    bytes = File.read(file, 4)
 
     # II is Intel, MM is Motorola
-    if bytes[0..1] != 'II' && bytes[0..1] != 'MM'
-      return false
-    end
+    return false if bytes[0..1] != 'II' && bytes[0..1] != 'MM'
 
-    if bytes[0..1] == 'II' && bytes[2..3].ord != 42
-      return false
-    end
+    return false if bytes[0..1] == 'II' && bytes[2..3].ord != 42
 
-    if bytes[0..1] == 'MM' && bytes[2..3].reverse.ord != 42
-      return false
-    end
+    return false if bytes[0..1] == 'MM' && bytes[2..3].reverse.ord != 42
 
     true
   end
@@ -498,6 +471,6 @@ class File
   # Is the file an ico file?
   #
   def self.ico?(file)
-    ["\000\000\001\000", "\000\000\002\000"].include?(IO.read(file, 4, nil, :encoding => 'binary'))
+    ["\000\000\001\000", "\000\000\002\000"].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.4.2'
+  spec.version    = '1.4.3'
   spec.license    = 'Artistic-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
@@ -19,16 +19,19 @@ Gem::Specification.new do |spec|
   EOF
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/ptools',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/ptools/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/ptools/blob/master/CHANGES.md',
-    'documentation_uri' => 'https://github.com/djberg96/ptools/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/ptools',
-    'wiki_uri'          => 'https://github.com/djberg96/ptools/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/ptools',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/ptools/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/ptools/blob/main/CHANGES.md',
+    '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'
   }
 
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   if File::ALT_SEPARATOR
     spec.platform = Gem::Platform.new(['universal', 'mingw32'])