file_type_detector_sfedu 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a5b6d66dd409a03792b309a5a50070c32ec1cb8a3578d0d9f791511425013d5
-  data.tar.gz: 3a714ef0dd6ef17e4e05c562c4a3f4b10bceb11d8c8f297469c6c7063d7d3ebb
+  metadata.gz: 58a8d37d3931c29954f7870c6125905261def1d31d71bcd4ebcba1e7499b4a61
+  data.tar.gz: f9201f1e4bfec70f6a63dce6fa652cbac8e215f82078e47f93daff2b4bc661cd
 SHA512:
-  metadata.gz: 99e503196037d1ca0fb09ae51011f4f510ad81ff03045b356ee1e2df0eb7f4fc81d3aec90d20b9f7ee9b7a460ebf2aa65d71f59ffe8393d51d7bb884a0b1a49c
-  data.tar.gz: b4b0bd07b6ed8d92204dff6ee187d5375bdcbe44294b94b0a9d84526ed905ca1484c003d93c09ee6cc6404a104e94d02c0b575fb22ecd4d2b5604ffca127ebea
+  metadata.gz: 1251c06470e171d5fda3eff3a1514253e80305a5cbe8d3e24c190f522e4f445dcd9de2ddbd8f75668737e5c108173bfafaa39b3f4a9daffcaaf2b438acf7e4bf
+  data.tar.gz: 7aed639f2d0f518aa09dbdb711b79695551f5f47e9336df265d8344294d8379ee66ad7b2e3141d342211550803f05dfe4f49f1aa0e8da5982a22e611937a6b1b

data/CHANGELOG.md

@@ -6,7 +6,7 @@
 - Initial release
 
 
-## [0.2.0] - 2024-03-2
+## [0.2.0] - 2024-04-5
 
 - Tests have been updated to test functions more correctly
 - The existing code has been significantly improved:
@@ -16,4 +16,14 @@
   - Improved code style
   - Added functions for checking new types of extensions: png, jpeg/jpg, gif, json, xml
 - Updated the readme file
+- Other minor improvements
+
+## [0.2.1] - 2024-04-6
+
+- Added documentation to all functions
+- Other minor improvements
+
+## [0.2.2] - 2024-04-08
+
+- Bug fixed
 - Other minor improvements

data/README.md

@@ -28,13 +28,21 @@ puts FileTypeDetector.check("path/to/your/file.pdf") # if it's truly pdf, value
 
 You can also use a specific detector:
 ```ruby
-puts FileTypeDetector.pdf_check("path/to/your/real_pdf.pdf") # true
-puts FileTypeDetector.pdf_check("path/to/your/fake_pdf.pdf") # false
+puts FileTypeDetector.pdf_check("path/to/your/real_pdf.pdf")    # true
+puts FileTypeDetector.pdf_check("path/to/your/fake_pdf.pdf")    # false
 
 puts FileTypeDetector.docx_check("path/to/your/real_docx.docx") # true
 puts FileTypeDetector.docx_check("path/to/your/fake_docx.docx") # false
 ```
 
+You can also run all the detectors on the file to determine its type using the `identify` method:
+```ruby
+puts FileTypeDetector.identify("path/to/your/real_pdf.pdf")   # "pdf"
+puts FileTypeDetector.identify("path/to/your/real_xml.pdf")   # "xml"
+puts FileTypeDetector.identify("path/to/your/real_docx.docx") # docx
+puts FileTypeDetector.identify("path/to/your/real_jpeg.png")  # jpeg
+puts FileTypeDetector.identify("path/to/your/unknown.png")    # nil
+```
 ## Supported File Types
 The gem provides support for detecting the following file types:
 

data/lib/file_type_detector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FileTypeDetector
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/file_type_detector.rb

@@ -2,9 +2,12 @@
 
 require_relative "file_type_detector/version"
 
+# Provides methods for detecting file types based on their content.
 module FileTypeDetector
-  # @param [String] file_path
-  # @return [Boolean]
+  # Determines the file type based on its content.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file type is recognized, otherwise false.
   def self.check(file_path)
     if error_handling(file_path)
       file_extension = File.extname(file_path).downcase
@@ -17,8 +20,21 @@ module FileTypeDetector
     false
   end
 
+  # Identifies the file type based on its content.
+  #
+  # @param [String] file_path The path to the file to be identified.
+  # @return [String] Returns the identified file type.
+  def self.identify(file_path)
+    return unless error_handling(file_path)
+
+    FILE_CHECKS.find { |fn| fn.call(file_path)}.name.to_s.split("_")[0]
+  end
+
   # =============================================
-  # Error handling
+  # Error handling for file operations.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if no errors are encountered, otherwise raises IOError.
   def self.error_handling(file_path)
     raise IOError, "File '#{file_path}' not found" unless File.exist?(file_path)
     raise IOError, "File '#{file_path}' is not a file" unless File.file?(file_path)
@@ -28,37 +44,52 @@ module FileTypeDetector
   end
 
   # =============================================
-  # Write your methods here
+  # Checks if the file has a PDF format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a PDF format, otherwise false.
   def self.pdf_check(file_path)
     return unless error_handling(file_path)
 
     File.read(file_path, 5) == "%PDF-"
-
   end
 
+  # Checks if the file has a DOCX format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a DOCX format, otherwise false.
   def self.docx_check(file_path)
     return unless error_handling(file_path)
 
     File.open(file_path, "rb") { |file| file.read(4) } == "PK\x03\x04"
-
   end
 
+  # Checks if the file has a PNG format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a PNG format, otherwise false.
   def self.png_check(file_path)
     return unless error_handling(file_path)
 
     first_bytes = File.open(file_path, "rb") { |file| file.read(16) }
-    first_bytes.start_with?("\x89PNG\r\n\x1A\n".b)
-
+    first_bytes&.start_with?("\x89PNG\r\n\x1A\n".b)
   end
 
+  # Checks if the file has a GIF format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a GIF format, otherwise false.
   def self.gif_check(file_path)
     return unless error_handling(file_path)
 
     first_bytes = File.open(file_path, "rb") { |file| file.read(6) }
     %w[GIF87a GIF89a].include?(first_bytes)
-
   end
 
+  # Checks if the file has a JPEG format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a JPEG format, otherwise false.
   def self.jpeg_check(file_path)
     return unless error_handling(file_path)
 
@@ -67,10 +98,18 @@ module FileTypeDetector
 
   end
 
+  # Checks if the file has a JPG format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a JPG format, otherwise false.
   def self.jpg_check(file_path)
     jpeg_check(file_path)
   end
 
+  # Checks if the file has a JSON format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a JSON format, otherwise false.
   def self.json_check(file_path)
     return unless error_handling(file_path)
 
@@ -78,14 +117,18 @@ module FileTypeDetector
     first_chars.start_with?("{") || first_chars.start_with?("[")
   end
 
+  # Checks if the file has a XML format.
+  #
+  # @param [String] file_path The path to the file to be checked.
+  # @return [Boolean] Returns true if the file has a XML format, otherwise false.
   def self.xml_check(file_path)
     return unless error_handling(file_path)
 
-    (File.open(file_path, "rb") { |file| file.read(2) }) == "<?"
-
+    File.open(file_path, "rb") { |file| file.read(2) } == "<?"
   end
 
   # =============================================
+  # Array containing check functions for different file types.
   FILE_CHECKS = [
     method(:pdf_check),
     method(:docx_check),
@@ -94,7 +137,7 @@ module FileTypeDetector
     method(:jpeg_check),
     method(:jpg_check),
     method(:json_check),
-    method(:xml_check),
+    method(:xml_check)
     # Add your methods here
   ].freeze
 

data/ruby_gem.gemspec

@@ -5,7 +5,7 @@ require_relative "lib/file_type_detector/version"
 Gem::Specification.new do |spec|
   spec.name = "file_type_detector_sfedu"
   spec.version = FileTypeDetector::VERSION
-  spec.authors = ["Garik", "watermelon0guy", "synthematikj", "kamchatnaya"]
+  spec.authors = ["Garik Mnacakanyan", "Mikhail Babichev", "Maria Putrova", "Elena Kamchatnaya"]
   spec.email = ["garfild_2003@mail.ru"]
 
   spec.summary = "A gem for detecting file types based on their extensions or content."

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: file_type_detector_sfedu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
-- Garik
-- watermelon0guy
-- synthematikj
-- kamchatnaya
+- Garik Mnacakanyan
+- Mikhail Babichev
+- Maria Putrova
+- Elena Kamchatnaya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies: []
 description: FileTypeDetector is a Ruby gem that provides functionality for determining
   the type of a file based on its extension or content.