onlyoffice_file_helper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7754ee429ce8e9954dd7c3343650bb29564dd44f762cd35c1de5b922773a2e47
-  data.tar.gz: 832ae50c2ea5275ef193887e88611626c7c7f365c90536711f6db3df8b1c6938
+  metadata.gz: 960f7f59f836fb2dbbdb528ce155c265cb92e380557fa758465686612d4e7176
+  data.tar.gz: c0b2363e46bbf0ec44824caa4ba9a6085b0eab20597d9e021fe9f4f2447281ed
 SHA512:
-  metadata.gz: 295ec48c909d4c48081f62b99d6631ae206926ef6a10a08b725ae3de3ea58e50740e260cb6e9ac9c2a4993bc0d0dbfc6dace4075f13ffc249115635c4f652a3f
-  data.tar.gz: fce67d533563eaba672b4346f41a779fee4861e6372d752964052f6e2c105a2151dfd4fa97918d89a6321b2d5296a4f1a48c33821015aa63055e86f14de88889
+  metadata.gz: 5483180cd580bd34697f23787630bad8eb72e1b879cbde1af1e22473829c07d36dfe73d0bb5834c4897d9e95d808f12cff6daeb5cb0f42c819abc99152185f3e
+  data.tar.gz: be52527e07d845c960724fa3a2ddbac3a7e31465bd3d8be6792a91a30a3663a673193bd5d7aeeb64d51caab1d62427cca33bd49f3cdc426bf9ce6d14a9b18e76

data/lib/onlyoffice_file_helper.rb

@@ -10,8 +10,10 @@ require 'onlyoffice_file_helper/directory_methods'
 require 'onlyoffice_file_helper/read_methods'
 require 'onlyoffice_file_helper/version'
 require 'onlyoffice_file_helper/linux_helper'
+require 'onlyoffice_file_helper/ruby_helper'
 require 'onlyoffice_file_helper/string_helper'
 
+# Namespace of project
 module OnlyofficeFileHelper
   # Stuff for working with Files
   class FileHelper
@@ -29,6 +31,10 @@ module OnlyofficeFileHelper
         name.to_s
       end
 
+      # Wait for downloading file
+      # @param path [String] path to waiting download
+      # @param timeout [Integer] timeout to wait
+      # @return [True, False] result
       def wait_file_to_download(path, timeout = 300)
         timer = 0
         OnlyofficeLoggerHelper.log("Start waiting to download file: #{path}")
@@ -42,6 +48,10 @@ module OnlyofficeFileHelper
         timer <= timeout
       end
 
+      # Extract archive to folder
+      # @param path_to_archive [String] path of file
+      # @param path_to_extract [String] result path
+      # @return [Void]
       def extract_to_folder(path_to_archive,
                             path_to_extract = path_to_archive.chomp(File.basename(path_to_archive)))
         raise 'File not found: ' + path_to_archive.to_s unless wait_file_to_download(path_to_archive)
@@ -57,6 +67,10 @@ module OnlyofficeFileHelper
         end
       end
 
+      # Save string to file
+      # @param string [String] string to save
+      # @param file_name [String] file to save
+      # @return [Void]
       def output_string_to_file(string, file_name)
         File.open(file_name, 'a+') do |f1|
           f1.write(string)

data/lib/onlyoffice_file_helper/create_methods.rb

@@ -3,6 +3,9 @@
 module OnlyofficeFileHelper
   # Methods used to create something
   module CreateMethods
+    # Gracefully create folder. Do not fail if already exists
+    # @param path [String] path to folder
+    # @return [Void]
     def create_folder(path)
       FileUtils.mkdir_p(path) unless File.directory?(path)
     rescue Errno::EEXIST

data/lib/onlyoffice_file_helper/directory_methods.rb

@@ -3,10 +3,16 @@
 module OnlyofficeFileHelper
   # Methods used to work with directories
   module DirectoryMethods
+    # Delete directory only if it exists
+    # @param path [String] directory to delete
+    # @return [Void]
     def delete_directory(path)
       FileUtils.rm_rf(path) if Dir.exist?(path)
     end
 
+    # List of files in directory as array
+    # @param path [String] path to directory
+    # @return [Array<String>] list of all files
     def directory_hash(path)
       files = []
       Dir.foreach(path).sort.each do |entry|
@@ -19,6 +25,10 @@ module OnlyofficeFileHelper
       files
     end
 
+    # List all files in directory
+    # @param directory [String] path to directory
+    # @param extension [String] filter extension
+    # @return [Array<String>] list of all files
     def list_file_in_directory(directory, extension = nil)
       paths = []
       Find.find(directory) do |path|

data/lib/onlyoffice_file_helper/linux_helper.rb

@@ -8,27 +8,38 @@ module OnlyofficeFileHelper
   class LinuxHelper
     extend XdotoolHelper
 
+    # Download file by link using
+    # @param link [String] url to download
+    # @param full_name_file [String] path to save file
+    # @return [Void]
     def self.download_file(link, full_name_file)
       `wget -O #{full_name_file} #{link}`
     end
 
+    # Kill All process with specified pattern name
+    # @param process [String] names of process
+    # @return [Void]
     def self.kill_all(process)
       OnlyofficeLoggerHelper.log("killall -9 #{process} 2>&1")
       `killall -9 #{process} 2>&1`
     end
 
+    # Just kill all known browsers
+    # @return [Void]
     def self.kill_all_browsers
       kill_all('firefox')
       kill_all('chrome')
       kill_all('opera')
     end
 
+    # @return [String] current user name
     def self.user_name
       `id -u -n`
     end
 
     singleton_class.send(:alias_method, :get_user_name, :user_name)
 
+    # @return [String] current computer name
     def self.computer_name
       computer_name = Socket.gethostname
       OnlyofficeLoggerHelper.log("`LinuxHelper.get_computer_name` # #{computer_name}")
@@ -37,6 +48,7 @@ module OnlyofficeFileHelper
 
     singleton_class.send(:alias_method, :get_computer_name, :computer_name)
 
+    # @return [String] content of clipboard
     def self.clipboard_content
       `xclip -o`
     end
@@ -50,6 +62,7 @@ module OnlyofficeFileHelper
       `xdg-user-dir #{name.to_s.upcase}`.strip
     end
 
+    # @return [String] external ip of system
     def self.my_external_ip
       `curl "http://myexternalip.com/raw"`.chomp
     end

data/lib/onlyoffice_file_helper/name.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OnlyofficeFileHelper
+  # @return [String] name of gem
+  NAME = 'onlyoffice_file_helper'
+end

data/lib/onlyoffice_file_helper/read_methods.rb

@@ -3,6 +3,9 @@
 module OnlyofficeFileHelper
   # Methods used to read something
   module ReadMethods
+    # Read file content to string
+    # @param file_name [String] file to read
+    # @return [String] result of read
     def read_file_to_string(file_name)
       result_string = ''
       raise 'File not found: ' + file_name.to_s unless File.exist?(file_name)
@@ -15,6 +18,9 @@ module OnlyofficeFileHelper
       result_string
     end
 
+    # Read file content to array, split by newline
+    # @param file_name [String] path to file
+    # @return [Array<String>] result of read
     def read_array_from_file(file_name)
       result_array = []
       return [] unless File.exist?(file_name)

data/lib/onlyoffice_file_helper/ruby_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OnlyofficeFileHelper
+  # Class for method for ruby
+  class RubyHelper
+    # @return [True, False] is current processs run in debug
+    def self.debug?
+      ENV['RUBYLIB'].to_s.include?('ruby-debug')
+    end
+  end
+end

data/lib/onlyoffice_file_helper/string_helper.rb

@@ -4,10 +4,16 @@ module OnlyofficeFileHelper
   # Helper for Strings
   class StringHelper
     class << self
+      # Random string with specific length
+      # @param length_string [Integer] length of string
+      # @return [String] string with length
       def generate_random_string(length_string = 32)
         (0...length_string).map { (('a'..'z').to_a + ('A'..'Z').to_a)[rand(52)] }.join
       end
 
+      # Generate random number with prefix
+      # @param value [String, Integer] prefix to generate
+      # @return [String] result of random number
       def generate_random_number(value = nil)
         "#{value}: #{Time.now.nsec}"
       end
@@ -17,7 +23,10 @@ module OnlyofficeFileHelper
       # @param [String] first_element 1'st element to compare
       # @param [String] second_element 2'st element to compare
       # @return [String] String with result of comparison
-      def get_result_string_of_comparison(compare_parameter, first_element, second_element, accuracy = 0.01)
+      def get_result_string_of_comparison(compare_parameter,
+                                          first_element,
+                                          second_element,
+                                          accuracy = 0.01)
         if first_element.is_a?(Float) && second_element.is_a?(Float)
           difference = (first_element - second_element).abs
           difference >= accuracy ? "Difference between parameters in #{compare_parameter} is #{difference}" : ''
@@ -28,6 +37,9 @@ module OnlyofficeFileHelper
         end
       end
 
+      # Convert string to boolean value
+      # @param string [String] to convert
+      # @return [True, False]
       def to_bool(string)
         str = string.to_s
         if str.casecmp('false').zero?

data/lib/onlyoffice_file_helper/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module OnlyofficeFileHelper
-  VERSION = '0.2.0'
+  # @return [String] version of gem
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_file_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onlyoffice_logger_helper
@@ -45,6 +45,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: ONLYOFFICE Helper Gem for File operation. Used in QA
 email:
 - shockwavenn@gmail.com
@@ -52,19 +66,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - lib/onlyoffice_file_helper.rb
 - lib/onlyoffice_file_helper/create_methods.rb
 - lib/onlyoffice_file_helper/directory_methods.rb
 - lib/onlyoffice_file_helper/linux_helper.rb
 - lib/onlyoffice_file_helper/linux_helper/xdotool_helper.rb
+- lib/onlyoffice_file_helper/name.rb
 - lib/onlyoffice_file_helper/read_methods.rb
+- lib/onlyoffice_file_helper/ruby_helper.rb
 - lib/onlyoffice_file_helper/string_helper.rb
 - lib/onlyoffice_file_helper/version.rb
 homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_file_helper
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_file_helper/issues
+  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_file_helper/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_file_helper
+  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_file_helper
+  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_file_helper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -80,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ONLYOFFICE Helper Gem for File operation

data/README.md

@@ -1,39 +0,0 @@
-# OnlyofficeFileHelper
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/onlyoffice_file_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'onlyoffice_file_helper'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install onlyoffice_file_helper
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/onlyoffice_file_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Code of Conduct
-
-Everyone interacting in the OnlyofficeFileHelper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/onlyoffice_file_helper/blob/master/CODE_OF_CONDUCT.md).