onlyoffice_pdf_parser 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661dfba5483c4463abeac412e29aef2c7813ac31edf78e17ca3593ed879e10aa
-  data.tar.gz: 5bcabaa8c35ecf07a814f555693c64720234bffd1e9ee2e82b831e8c65f72a09
+  metadata.gz: 0b9aae5d167a597a5a3ed130df76fdf6556f56a0584e37f0d8cb1628072efb53
+  data.tar.gz: 504d27e360ad224a8c8d81c03f7d7acd8a21cbb6742d5260a5cd0f03653a98c6
 SHA512:
-  metadata.gz: a91f4477b8d9a32de8459856a6e3e965380f5143be90cea0c67b1b94367ecfc1e4961f34be916dc5ae9bfbdf634d0f331d3a45f0b7c34261cf6d7ad9ddc392eb
-  data.tar.gz: b0960da736c0e12c99f02c7dc8c8dc3c08569b25f81b5995b858fd060322e77ab7c3145c4aeca9670be3ef12e8247d8550b410335c3b407bdc5a5a0b7aaf8f55
+  metadata.gz: 93f18f9b66233ad8164def6ac45e41b8ed8ca4a72da22ada40b45df5678856031e49839084ae72571c62f036c5c9b44e85f1c7951099c0116993b6fd255c29ba
+  data.tar.gz: ec867fb44f95b59a28a32dc290bef278698d92ecbf49697672b5ac2a1ffa3879684a64d6652ce87f0c97941408262c015cfdf3c7ab0adaf66594c23648248f10

data/lib/onlyoffice_pdf_parser.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require_relative 'onlyoffice_pdf_parser/bmp_image.rb'
-require_relative 'onlyoffice_pdf_parser/pdf_structure.rb'
+require_relative 'onlyoffice_pdf_parser/bmp_image'
+require_relative 'onlyoffice_pdf_parser/pdf_structure'

data/lib/onlyoffice_pdf_parser/bmp_image.rb

@@ -13,7 +13,9 @@ module OnlyofficePdfParser
     # @return [String] binary dat of file
     attr_reader :data
 
-    def initialize(param = nil)
+    def initialize(param = nil, width: nil, height: nil)
+      @width = width
+      @height = height
       return unless param
 
       init_data(param)
@@ -24,10 +26,14 @@ module OnlyofficePdfParser
       fetch_pixels
     end
 
+    # @return [String] convert object to string
     def to_s
       path_to_image
     end
 
+    # Compare object with other
+    # @param other [Object] object to compare
+    # @return [True, False] result of comparison
     def ==(other)
       return false unless other.width == width && other.height == height
 
@@ -41,8 +47,13 @@ module OnlyofficePdfParser
       true
     end
 
+    # Get sub image from coordinates
+    # @param start_point [CursorPoint] top left coordinates to get
+    # @param width [Integer] width to get
+    # @param height [Integer] height to get
+    # @return [BmpImage] result
     def get_sub_image(start_point = CursorPoint.new(0, 0), width = 0, height = 0)
-      sub_image = BmpImage.new
+      sub_image = BmpImage.new(nil, width: width, height: height)
       pixels_array = []
       height.times do |current_height|
         line_array = []
@@ -56,11 +67,12 @@ module OnlyofficePdfParser
         pixels_array << line_array
       end
       sub_image.pixels = pixels_array
-      sub_image.width = width
-      sub_image.height = height
       sub_image
     end
 
+    # Get sub image from file pattern coordinates
+    # @param path_to_sub_image [String] path to pattern to find
+    # @return [Array<CursorPoint>] result
     def get_sub_image_array(path_to_sub_image)
       coordinates_array = []
       sub_image = BmpImage.new(path_to_sub_image)

data/lib/onlyoffice_pdf_parser/helpers/cursor_point.rb

@@ -15,14 +15,20 @@ module OnlyofficePdfParser
     alias x left
     alias y top
 
+    # Make a copy of object
+    # @return [CursorPoint] another object
     def dup
       CursorPoint.new(@left, @top)
     end
 
+    # @return [String] convert object to string
     def to_s
       "[#{@left}, #{@top}]"
     end
 
+    # Compare object with other
+    # @param other [Object] object to compare
+    # @return [True, False] result of comparison
     def ==(other)
       if other.respond_to?(:left) && other.respond_to?(:top)
         @left == other.left && @top == other.top
@@ -31,6 +37,9 @@ module OnlyofficePdfParser
       end
     end
 
+    # Accessor of attributes like hash
+    # @param name [Symbol] attribute name
+    # @return [Object] value of attribute
     def [](name)
       case name
       when :width
@@ -43,5 +52,6 @@ module OnlyofficePdfParser
     end
   end
 
+  # Alias for this object
   Dimensions = CursorPoint
 end

data/lib/onlyoffice_pdf_parser/name.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Namespace of gem
+module OnlyofficePdfParser
+  # Module with name of Gem
+  module Name
+    # @return [String] name of gem
+    STRING = 'onlyoffice_pdf_parser'
+  end
+end

data/lib/onlyoffice_pdf_parser/pdf_structure.rb

@@ -24,6 +24,9 @@ module OnlyofficePdfParser
       @pages_in_bmp = []
     end
 
+    # Accessor of attributes like hash
+    # @param parameter [Symbol] attribute name
+    # @return [Object] value of attribute
     def [](parameter)
       case parameter
       when :pages
@@ -70,6 +73,7 @@ module OnlyofficePdfParser
       @page_size ||= "Landscape #{PAGE_SIZE_FOR_PDF.key(page_size_points.reverse)}"
     end
 
+    # @return [Hash] list of default page size and names
     PAGE_SIZE_FOR_PDF = { 'US Letter' => [612, 792],
                           'US Legal' => [612, 1008],
                           'A4' => [595, 842],
@@ -84,6 +88,9 @@ module OnlyofficePdfParser
                           'Envelope Choukei 3' => [340, 666],
                           'Super B/A3' => [936, 1368] }.freeze
 
+    # Parse file
+    # @param filename [String] path to file
+    # @return [PdfStructure] result of parse
     def self.parse(filename)
       file = PdfStructure.new(pages: [], file_path: filename)
       file.pdf_reader_parse
@@ -93,5 +100,6 @@ module OnlyofficePdfParser
     end
   end
 
+  # Alias for object
   PdfParser = PdfStructure
 end

data/lib/onlyoffice_pdf_parser/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module OnlyofficePdfParser
+  # Module with version of Gem
   module Version
-    STRING = '0.1.0'
+    # @return [String] version of gem
+    STRING = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_pdf_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pavel Lobashov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: image_size
@@ -43,23 +43,157 @@ dependencies:
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-    - - "<"
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
-    - - "<"
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-description: Wrapper for Testrail by OnlyOffice
+        version: 0.9.20
+description: Library for parsing, converting and extracting PDF data
 email:
 - shockwavenn@gmail.com
 - kvazilife@gmail.com
@@ -67,20 +201,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - lib/onlyoffice_pdf_parser.rb
 - lib/onlyoffice_pdf_parser/bmp_image.rb
 - lib/onlyoffice_pdf_parser/helpers/array_helper.rb
 - lib/onlyoffice_pdf_parser/helpers/cursor_point.rb
 - lib/onlyoffice_pdf_parser/helpers/file_helper.rb
+- lib/onlyoffice_pdf_parser/name.rb
 - lib/onlyoffice_pdf_parser/pdf_structure.rb
 - lib/onlyoffice_pdf_parser/pdf_structure/pdf_convert_to_bmp_helper.rb
 - lib/onlyoffice_pdf_parser/pdf_structure/pdf_reader_helper.rb
 - lib/onlyoffice_pdf_parser/version.rb
-homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_pdf_parser
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_pdf_parser
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_pdf_parser/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_pdf_parser/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_pdf_parser
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_pdf_parser
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_pdf_parser
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -89,15 +228,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: ONLYOFFICE Testrail Wrapper Gem
+summary: ONLYOFFICE PDF Parser Gem
 test_files: []

data/README.md

@@ -1,12 +0,0 @@
-# Onlyoffice PDF Parser
-
-It is gem for parsing pdf files.
-
-### Example
-
-```
-require 'onlyoffice_pdf_parser'
-
-OnlyofficePdfParser::PdfParser.parse('Text.pdf')
-
-```