onlyoffice_pdf_parser 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a697279502703e39f149142d8c2db8dfd0ec6339896cecdbec8f091fea63c6f
-  data.tar.gz: 011565b90b198dd993bce278a8a1336d143bfc01ca41a49e8cc9d1258e100319
+  metadata.gz: 6212798444987cba5c3430c125dafe40d3478f63ea2d15d0b09a2369a569d6d8
+  data.tar.gz: 5efb6bb19820c51ad65668ac10918388953b152d82dbbd24335b5fd281b0949d
 SHA512:
-  metadata.gz: 1af64743d41cb0629a9582dd2f9ad8cbb162a3a59e045bbb3f3866cbfcd93378ded503f189464bc1a1f33985c9b4fb285aa7e393c3f89b5ccaae7270f27faf37
-  data.tar.gz: d1bf15f86cce7de63f60e42c66ab98fdc8a0972047492ef50182f7e7aca3a5dac04f3d6ad4a0fefe0ffc1413a9d0e495c8f3dda0bbdf0844cc810f6e10927ae4
+  metadata.gz: e16d59adb7d67b3c603ab14445d06767c41d16ff6c6079d85880d0c92f7236b6c1414522801f369a94bd76f0fc58845ef918a0c898fb60e7e840cb0ba7148b10
+  data.tar.gz: 681e14dd31f14a6ec45302e0646ba82d45e926490e79601445dfd6db1550bb8baccd950394a3646c84126f7448e5c49a4c1c983b17595abccecabf861f20357f

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.2'
+    # @return [String] version of gem
+    STRING = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_pdf_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.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-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: image_size
@@ -59,20 +59,146 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
 description: Library for parsing, converting and extracting PDF data
 email:
 - shockwavenn@gmail.com
@@ -86,6 +212,7 @@ files:
 - 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
@@ -107,14 +234,14 @@ 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 PDF Parser Gem