file_type_detector_sfedu 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd4c402e08497af69516d8d8c5626a9c4fa40e36fc357348a45395b4fdc00c0f
-  data.tar.gz: f0cb62187c310f14573ce1964b4459c68e27a75164c633f0485c5614e9566221
+  metadata.gz: 9449915d78b7866c453a5a8cb813839d83f3f96e39beac2f2c15dd5f94df712b
+  data.tar.gz: a52208251fa8436adb24a6b15b051cc6fa730de720c05774e83d14beafa36602
 SHA512:
-  metadata.gz: 2917a5ee6c5226b02cc0d794cdbe2509f05161cb8f89d07438e6630ecdf1bc227299209748d2717177e9db01aa2741e98dbb0c74e225231c91deeaae46b7713c
-  data.tar.gz: caeda6a5ffbd575493f1ef284838fed004e4b66ce217eafbe08a34a6d8b69ec120a6e273fb6d4a134873566c2f3f579f13518d817f467fc25939f60ff0a87c13
+  metadata.gz: 3c90836cd61fa5af87721f74abdc53687fa5cc35a3bbb9587de1eecbf8be00f922d80d4e9b128c79318248fb3e472554cd4f5257f65986169e8e73feb0aebb2e
+  data.tar.gz: 00abb630169031a53cc78834f3f711d4235ae1fb3c3b698e85e9f743b956fda39af44fafd49fb847a23321c21bac4a7fb902a26f667593955e5b0c60881ba92f

data/CHANGELOG.md

@@ -1,5 +1,24 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2024-03-18
+
+## [0.1.1] - 2024-03-31
 
 - Initial release
+
+
+## [0.2.0] - 2024-04-5
+
+- Tests have been updated to test functions more correctly
+- The existing code has been significantly improved:
+  - The functions have been optimized
+  - Removed unnecessary code
+  - Added error handling
+  - 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

data/README.md

@@ -1,43 +1,56 @@
-# file_type_detector
-
-**file_type_detector** is a Ruby gem that allows you to determine the type of files based on their extension or content.
-
-## Installation
-
-Add this gem to your Gemfile and run `bundle install`:
-
-```ruby
-gem 'file_type_detector'
-```
-
-Alternatively, install it directly using the gem command:
-
-```ruby
-gem install file_type_detector
-```
-
-## Usage
-
-To use the gem, you need to create an instance of FileTypeDetector::FileTypeDetector, specifying the path to the file as the constructor argument. Then call the detect method to determine the file type.
-
-```ruby
-require 'file_type_detector'
-
-detector = FileTypeDetector::FileTypeDetector.new('path/to/your/file.pdf')
-puts detector.detect
-```
-Please replace `"path/to/your/file.pdf"` with the path to your file that you want to check.
-
-## Supported File Types
-The gem provides support for detecting the following file types:
-
-- PDF
-- PNG
-
-## Contributing
-
-You can contribute to the development of the gem by creating new detectors for other file types and improving existing code. Report bugs and submit feature requests through the [GitHub repository](https://github.com/synthematik/file_type_detector_gem).
-
-## License
-
-This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# file_type_detector_sfedu
+
+**file_type_detector_sfedu** is a Ruby gem that allows you to determine the type of files based on their extension or content.
+
+## Installation
+
+Add this gem to your Gemfile and run `bundle install`:
+
+```ruby
+gem "file_type_detector_sfedu"
+```
+
+Alternatively, install it directly using the gem command:
+
+```ruby
+gem install file_type_detector_sfedu
+```
+
+## Usage
+
+To use the gem, you need to call the `check` method with a parameter in the form of a file path:
+```ruby
+require "file_type_detector_sfedu"
+
+puts FileTypeDetector.check("path/to/your/file.pdf") # if it's truly pdf, value will be true, unless - false
+```
+`check` method will automatically detect the file type by its extension and tell if its contents match the extension.
+
+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.docx_check("path/to/your/real_docx.docx") # true
+puts FileTypeDetector.docx_check("path/to/your/fake_docx.docx") # false
+```
+
+## Supported File Types
+The gem provides support for detecting the following file types:
+
+- PDF
+- DOCX
+- PNG
+- GIF
+- JPEG/JPG
+- JSON
+- XML
+
+## Contributing and links
+
+You can contribute to the development of the gem by creating new detectors for other file types and improving existing code. Report bugs and submit feature requests through the [GitHub repository](https://github.com/synthematik/file_type_detector_gem).
+
+You can visit our gem's page here - [Rubygems.org](https://rubygems.org/gems/file_type_detector_sfedu)
+## License
+
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/file_type_detector/version.rb

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

data/lib/file_type_detector.rb

@@ -2,94 +2,143 @@
 
 require_relative "file_type_detector/version"
 
+# Provides methods for detecting file types based on their content.
 module FileTypeDetector
-  class Error < StandardError; end
+  # 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
+
+      FILE_CHECKS.each do |check_function|
+        return check_function.call(file_path) if file_extension == ".#{check_function.name.to_s.split("_")[0]}"
+      end
+    end
 
-  # file_type_detector.rb
+    false
+  end
 
-  class FileTypeDetector
-    def initialize(file_path)
-      @file_path = file_path
-    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)
 
-    def detect
-      detector.detect
-    end
+    FILE_CHECKS.find { |fn| fn.call(file_path)}.name.to_s.split("_")[0][1..]
+  end
 
-    private
+  # =============================================
+  # 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)
+    raise IOError, "File '#{file_path}' is not available for reading" unless File.readable?(file_path)
+
+    true
+  end
 
-    def detector
-      detectors.detect { |detector| detector.supported? }
-    end
+  # =============================================
+  # 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)
 
-    def detectors
-      [
-        PDFDetector.new(@file_path),
-        PNGDetector.new(@file_path),
-      # Добавьте сюда новые детекторы для других типов файлов по мере необходимости
-      ]
-    end
+    File.read(file_path, 5) == "%PDF-"
   end
 
-  # Base Detector class
-  class Detector
-    def initialize(file_path)
-      @file_path = file_path
-    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)
 
-    def supported?
-      raise NotImplementedError, "#{self.class} must implement supported?"
-    end
+    File.open(file_path, "rb") { |file| file.read(4) } == "PK\x03\x04"
+  end
 
-    def detect
-      raise NotImplementedError, "#{self.class} must implement detect"
-    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)
   end
 
-  # Detector for PDF files
-  class PDFDetector < Detector
-    def supported?
-      File.extname(@file_path).downcase == '.pdf'
-    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)
 
-    def detect
-      # Определяем тип PDF-файла
-      if File.read(@file_path, 5) == '%PDF-'
-        'PDF'
-      else
-        'Unknown' # Если содержимое файла не соответствует формату PDF
-      end
-    end
+    first_bytes = File.open(file_path, "rb") { |file| file.read(6) }
+    %w[GIF87a GIF89a].include?(first_bytes)
   end
 
-  # Detector for PNG files
-  class PNGDetector < Detector
-    def supported?
-      File.extname(@file_path).downcase == '.png'
-    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)
+
+    first_bytes = File.open(file_path, "rb") { |file| file.read(2) }
+    first_bytes == "\xFF\xD8".b
 
-    def detect
-      # Определяем тип PNG-файла, возможно, с помощью какой-то библиотеки для работы с изображениями
-      # В данном примере просто возвращаем строку 'PNG'
-      'PNG'
-    end
   end
 
-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
 
-def detect_file_type(file_path)
-  File.open(file_path, 'rb') do |file|
-    header = file.read(4)
-    if header.start_with?('%PDF')
-      return 'PDF'
-    elsif header.start_with?('GIF8')
-      return 'GIF'
-    elsif header.start_with?("\x89PNG\r\n\x1A\n")
-      return 'PNG'
-    elsif header.start_with?("\xFF\xD8\xFF")
-      return 'JPEG'
-    else
-      return 'Неизвестный тип файла'
-    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)
+
+    first_chars = File.open(file_path, "rb") { |file| file.read(2) }
+    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) } == "<?"
+  end
+
+  # =============================================
+  # Array containing check functions for different file types.
+  FILE_CHECKS = [
+    method(:pdf_check),
+    method(:docx_check),
+    method(:png_check),
+    method(:gif_check),
+    method(:jpeg_check),
+    method(:jpg_check),
+    method(:json_check),
+    method(:xml_check)
+    # Add your methods here
+  ].freeze
+
 end

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.1.1
+  version: 0.2.1
 platform: ruby
 authors:
-- Garik
-- watermelon0guy
-- synthematikj
-- kamchatnaya
+- Garik Mnacakanyan
+- Mikhail Babichev
+- Maria Putrova
+- Elena Kamchatnaya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-30 00:00:00.000000000 Z
+date: 2024-04-06 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.
@@ -30,7 +30,6 @@ files:
 - lib/file_type_detector.rb
 - lib/file_type_detector/version.rb
 - ruby_gem.gemspec
-- sig/ruby_gem.rbs
 homepage: https://github.com/synthematik/file_type_detector_gem
 licenses:
 - MIT

data/sig/ruby_gem.rbs

@@ -1,4 +0,0 @@
-module RubyGem
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end