RubyGems - onlyoffice_mysql_helper - Versions diffs - 0.1.0 → 0.2.0 - Mend

onlyoffice_mysql_helper 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/lib/onlyoffice_mysql_helper/mysql_helper.rb +31 -3
data/lib/onlyoffice_mysql_helper/mysql_logger.rb +7 -0
data/lib/onlyoffice_mysql_helper/name.rb +2 -0
data/lib/onlyoffice_mysql_helper/version.rb +2 -1
metadata +123 -11

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dc9f484d18654ce5d10d7302fac2d193c650069b84fb7bc28f57d41fa5cf64
-  data.tar.gz: f3ca7face439c1bd4a5c47b6487c4dccf3be0a8ca584a3a1dde1273628d6556e
+  metadata.gz: 3e45241a0729e8f4cfd398e86f8e9db10f367c4e7f6fa3f29baec5bd3fd993cc
+  data.tar.gz: 56aa406ba03ea18c088946a3ffd2361bd3507e85c021bf8daf6b391f68d20bf8
 SHA512:
-  metadata.gz: 368edb533b097c7febd99784aa209ad13e3550dcf28834888ace3815677fe301a76b479452d5fbfd6f9c098921253b82c74525425dad4b2b51e2b9e7820d6dc1
-  data.tar.gz: 384af581103aa4b1d149c421acbabb0d1a4cea0892166fdc9f02c2c3ab9d4adc2e69eb63dbab7374c7729d19d0f99372fba429ae60d3f213c6a9351dcfc40630
+  metadata.gz: 1605b39c83e3a5627d6a12b1ecda3016c3554e02a8af75f823c79c609be3e9e81eb856caa800373efa32dd935dd3f81ac29fd91d3d21a7e734fecc89a78dd6b8
+  data.tar.gz: 07ff87464a0a6eddbe7c87265503ed49634825fce091601674325deb36146dfec0b10dc729afe3e6bb454b28dd1c1fda330ec8794c6c6c23de2c007258bf7b77

data/lib/onlyoffice_mysql_helper/mysql_helper.rb CHANGED

@@ -4,22 +4,33 @@ require 'mysql2'
 module OnlyofficeMysqlHelper
   # Class for using mysql
   class MySQLHelper
-    attr_accessor :mysql
+    # @return [String] database name
     attr_accessor :database
+    # @return [String] default sql address
     SQL_SERVER_ADDRESS_LOCAL = '127.0.0.1'
+    # @return [String] default sql user
     SQL_SERVER_USER_LOCAL = 'root'
+    # @return [String] default sql password
     SQL_SERVER_PASSWORD_LOCAL = ''
     def initialize(address: SQL_SERVER_ADDRESS_LOCAL,
                    database: 'performance_test',
                    user: SQL_SERVER_USER_LOCAL,
                    password: SQL_SERVER_PASSWORD_LOCAL)
+      port = ENV['DB_PORT'] || 3306
       @connection = Mysql2::Client.new(host: address,
+                                       port: port,
                                        username: user,
-                                       password: password, database: database)
+                                       password: password,
+                                       database: database)
       @database = database
     end
+    # Add hash record to table
+    # @param [String] table_name to add hash
+    # @param [Hash] hash to add
+    # @return [nil]
     def add_record(table_name, hash)
       send_query do
         "INSERT INTO `#{table_name}` (`id`, #{from_query_keys(hash)}) "\
@@ -27,26 +38,43 @@ module OnlyofficeMysqlHelper
       end
     end
+    # Create specific table if not exists
+    # @param [String] name of table
+    # @param [String] columns of table
+    # @return [nil]
     def create_table(name, columns = 'id INT PRIMARY KEY AUTO_INCREMENT')
       send_query { "CREATE TABLE IF NOT EXISTS `#{name}`(#{columns});" }
     end
+    # Select table records
+    # @param [String] table_name of table
+    # @param [String] condition to filter
+    # @return [Object] result of select
     def select_records(table_name, condition = '')
       send_query do
         query = "SELECT * FROM `#{table_name}`"
         query += " #{condition}" unless condition == ''
-        query + ';'
+        "#{query};"
       end
     end
+    # List all tables in base
+    # @return [Object] table list
     def tables
       send_query { 'SHOW TABLES;' }
     end
+    # Delete record by condition
+    # @param [String] table_name of table
+    # @param [String] condition to delete
+    # @return [nil]
     def delete_record(table_name, condition)
       send_query { "DELETE FROM `#{table_name}` WHERE #{condition};" }
     end
+    # Drop whole table
+    # @param [String] table_name of table
+    # @return [nil]
     def drop_table(table_name)
       send_query { "DROP TABLE `#{table_name}`;" }
     end

data/lib/onlyoffice_mysql_helper/mysql_logger.rb CHANGED

@@ -3,8 +3,11 @@
 module OnlyofficeMysqlHelper
   # Log action in mysql
   class MySQLLogger
+    # @return [MySQLHelper] instance of helper
     attr_accessor :mysql
+    # @return [String] table name
     attr_accessor :table
+    # @return [Hash] hash to add to DB
     attr_accessor :hash
     def initialize(mysql = MySQLHelper.new, table = nil, hash = {})
@@ -24,6 +27,10 @@ module OnlyofficeMysqlHelper
       @mysql.create_table(table_name, table_command)
     end
+    # Log ant actions in DB
+    # @param [String] action name for log
+    # @param [Hash] hash with additional options
+    # @return [nil]
     def log_actions(action, hash)
       mysql_hash = hash.merge(@hash)
       mysql_hash[:time] = Time.now

data/lib/onlyoffice_mysql_helper/name.rb CHANGED

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+# Main module for project
 module OnlyofficeMysqlHelper
+  # @return [String] name of gem
   NAME = 'onlyoffice_mysql_helper'
 end

data/lib/onlyoffice_mysql_helper/version.rb CHANGED

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

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_mysql_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -39,20 +39,132 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: 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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        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: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !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: '13.0'
+        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: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
 description: Simple MySQL wrapper. Used in QA of ONLYOFFICE
 email:
 - shockwavenn@gmail.com
@@ -65,15 +177,15 @@ files:
 - lib/onlyoffice_mysql_helper/mysql_logger.rb
 - lib/onlyoffice_mysql_helper/name.rb
 - lib/onlyoffice_mysql_helper/version.rb
-homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_mysql_helper
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_mysql_helper
 licenses:
 - AGPL-3.0
 metadata:
-  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_mysql_helper/issues
-  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_mysql_helper/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_mysql_helper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_mysql_helper/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_mysql_helper
-  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_mysql_helper
-  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_mysql_helper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_mysql_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_mysql_helper
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -82,14 +194,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Simple MySQL wrapper