ptools 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f02ac0737f1acf24a7edccb33f60990b5690259fe715520eeb803badc514ae
-  data.tar.gz: 469380e8d9f7107868b0ec17e8ca7aa4c8e5e1db19a7263c88995e1346f9c634
+  metadata.gz: 36406684b5e92604183390f36512e57d842143d4f7cdc29f9f728cb8085c99f6
+  data.tar.gz: 736ef4ab5f6ff12ec22e4158eeb09f1a5d3db94f969ae4991ac7732fa2d4b0e5
 SHA512:
-  metadata.gz: 114dec925795c5ebfc3f84209602490d22d54031fede8cf9914d635c4bb4180cce1d77dcb3f87d970f491a43b307f7017a29a1239b7d23442aaa01f701d13071
-  data.tar.gz: 60b1f3ad73a5019ed89b24ae82b0032f014b8770d8feb6b447ad72f459a6029cf678fa0fe96c5e8ec23eb1dc2818a66dbbabc499d4bc8ac858c256ad786236b0
+  metadata.gz: 872ba6353a2e52e845bb2b2e6b1fced1e334873b5da3edcd9764d481f4db1434b07d8b85e5e60e222e467b9ca67e36b019aac639a172c414f64398a1a29cf463
+  data.tar.gz: b38ac907b048d378c89807fae43e3a6d5c38e2f34b3afbfbacd333cb0860393e2be4faab59bcb0f800cb2f02f49e5110b05fc21b6a870ce2f2829560fdf1759e

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 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.
+* Minor tweak to one of the touch specs.
+* The Gemfile now just uses the gemspec.
+* The image? singleton method was effectively ignoring filename extensions. This
+  has been fixed, though with the option to disable that check if desired.
+
 ## 1.4.1 - 29-Dec-2020
 * Switch from rdoc to markdown since github is not rendering rdoc properly.
 * Added metadata to gemspec.

data/Gemfile

@@ -1,12 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'structured_warnings'
-
-group :production do
-  gem 'win32-file' if File::ALT_SEPARATOR
-end
-
-group :test do
-  gem 'rake'
-  gem 'rspec'
-end
+gemspec

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.1'.freeze
+  PTOOLS_VERSION = '1.4.2'.freeze
 
   # :stopdoc:
 
@@ -19,17 +19,26 @@ class File
     MSWINDOWS = false
   end
 
-  IMAGE_EXT = %w[.bmp .gif .jpg .jpeg .png]
+  if File::ALT_SEPARATOR
+    private_constant :WIN32EXTS
+    private_constant :MSWINDOWS
+  end
+
+  IMAGE_EXT = %w[.bmp .gif .jpg .jpeg .png .ico]
 
   # :startdoc:
 
   # Returns whether or not the file is an image. Only JPEG, PNG, BMP,
   # GIF, and ICO are checked against.
   #
-  # This method does some simple read and extension checks. For a version
+  # This reads and checks the first few bytes of the file. For a version
   # that is more robust, but which depends on a 3rd party C library (and is
   # difficult to build on MS Windows), see the 'filemagic' library.
   #
+  # By default the filename extension is also checked. You can disable this
+  # by passing false as the second argument, in which case only the contents
+  # are checked.
+  #
   # Examples:
   #
   #    File.image?('somefile.jpg') # => true
@@ -38,9 +47,13 @@ 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)
-    bool = IMAGE_EXT.include?(File.extname(file).downcase)
+  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
   end
 
@@ -402,8 +415,6 @@ class File
     end
   end
 
-  private
-
   # Returns whether or not the given +text+ contains a BOM marker.
   # If present, we can generally assume it's a text file.
   #
@@ -418,6 +429,10 @@ class File
     bool
   end
 
+  private_class_method :check_bom?
+
+  # Returns the newline characters for the given platform.
+  #
   def self.nl_for_platform(platform)
     platform = RbConfig::CONFIG["host_os"] if platform == 'local'
 
@@ -433,22 +448,32 @@ class File
     end
   end
 
+  # Is the file a bitmap file?
+  #
   def self.bmp?(file)
     IO.read(file, 3) == "BM6"
   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)
   end
 
+  # Is the file a png file?
+  #
   def self.png?(file)
     IO.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))
   end
 
+  # Is the file a tiff?
+  #
   def self.tiff?(file)
     return false if File.size(file) < 12
 
@@ -470,6 +495,8 @@ class File
     true
   end
 
+  # 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'))
   end

data/ptools.gemspec

@@ -2,7 +2,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.4.1'
+  spec.version    = '1.4.2'
   spec.license    = 'Artistic-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'

data/spec/constants_spec.rb

@@ -13,21 +13,11 @@ 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.4.1')
+    expect(File::PTOOLS_VERSION).to eq('1.4.2')
     expect(File::PTOOLS_VERSION.frozen?).to be true
   end
 
   example "IMAGE_EXT constant is set to array of values" do
-    expect(File::IMAGE_EXT.sort).to eq(%w[.bmp .gif .jpeg .jpg .png])
-  end
-
-  example "WINDOWS constant is defined on MS Windows" do
-    skip "skipped unless MS Windows" unless windows
-    expect(File::MSWINDOWS).not_to be_nil
-  end
-
-  example "WIN32EXTS constant is defined on MS Windows" do
-    skip "skipped unless MS Windows" unless windows
-    expect(File::WIN32EXTS).not_to be_nil
+    expect(File::IMAGE_EXT).to match_array(%w[.bmp .gif .ico .jpeg .jpg .png])
   end
 end

data/spec/touch_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe File, :touch do
 
   example "touch an existing file returns expected results" do
     stat = File.stat(xfile)
-    sleep 0.5
+    sleep 1
     expect{ File.touch(xfile) }.not_to raise_error
     expect(File.size(xfile) == stat.size).to be true
     expect(File.mtime(xfile) == stat.mtime).to be false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Extra methods for the File class