Initial commit

Author: Mikhail Georgievskiy

.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

.rubocop.yml

@@ -0,0 +1,139 @@
+AllCops:
+  NewCops: disable
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Security/YAMLLoad:
+  Enabled: false

Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unity-utils.gemspec
+gemspec
+
+gem 'pry', '~> 3.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21.0'
+
+gem 'ruby-progressbar', '~> 1.11.0'

Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    unity-utils (0.1.0)
+      ruby-progressbar
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  pry
+  rspec
+  rubocop
+  ruby-progressbar
+  unity-utils!
+
+BUNDLED WITH
+   2.2.12

README.md

@@ -0,0 +1,71 @@
+# UnityUtils
+
+Gem with utilities used by Unity team
+
+# Documentation
+
+- ### Utils:
+  - **Retrier** - Restarting passed block.
+    ```ruby
+    Unity::Utils::Retrier.call { 5 / 0 }
+    ```
+
+  - **ThreadPool** - Working with multithreading.
+    ```ruby
+    result = []
+    pool = Unity::Utils::ThreadPool.new(50)
+
+    10.times { |n| pool.schedule { result << n * n } }
+
+    pool.run!
+    ```
+
+- ### Modules:
+    - **CliModeable** - Wrapper over the ruby-progressbar.
+        ```ruby
+        elements = (1..10).to_a
+        @cli_mode  = true
+
+        init_progressbar(elements.count)
+
+        elements.each do |element|
+        incr_progressbar
+
+        # do something and look on great progress bar :)
+        end
+        ```
+
+    - **Loggable** - Wrapper over logger.
+        ```ruby
+        @log_file = 'some_file.log'
+        @logger = Logger.new(@log_file)
+
+        clean_logfile
+
+        begin
+            5 / 0
+        rescue StandardError => e
+            pretty_e = exception_to_array(e)
+            logger.error(pretty_e)
+        end
+        ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unity-utils'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install unity-utils
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

lib/unity-utils.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'unity/utils'

lib/unity/modules/cli_modeable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'ruby-progressbar'
+
+module Unity
+  module Modules
+    module CliModeable
+      private
+
+      def cli_mode?
+        @cli_mode == true
+      end
+
+      def init_progressbar(amount, title = self.class.to_s)
+        return unless cli_mode?
+
+        @progressbar = ProgressBar.create(title: title, format: '%t, %c/%C,%e: |%B|')
+        @progressbar.total = amount
+      end
+
+      def incr_progressbar
+        @progressbar.increment if cli_mode?
+      end
+    end
+  end
+end

lib/unity/modules/loggable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Unity
+  module Modules
+    module Logable
+      attr_reader :log_file, :logger
+
+      def clean_logfile
+        return if log_file.kind_of?(IO)
+
+        File.open(log_file, 'w') {}
+      end
+
+      def puts_log_path
+        $stdout.puts("All logs in #{log_file}")
+      end
+
+      private
+
+      def exception_to_array(exception)
+        [
+          "exception=#{exception.class}",
+          "msg='#{exception.message}'",
+          "backtrace='#{exception.backtrace.first(4).join('; ')}'"
+        ]
+      end
+    end
+  end
+end

lib/unity/utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Dir['./lib/unity/**/**.rb'].sort.each { |file_path| require(file_path) }
+
+module Unity
+  module Utils
+    class Error < StandardError; end
+  end
+end