subvisual-utils 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e8becccaf7396ede4dae0b495394f830089cd0dc4b6bc422bb52d268f7929f7
+  data.tar.gz: 888fd5ca1b5ed5205d0997b9d2541cd5d050ec77eed9c0a10ff42b10df397f35
+SHA512:
+  metadata.gz: d21f6ed2583a8a8f0cbaf5bd1a7fcb6bc090c4ba1ebd0bde7481bafcef20da3ae6a7d5dd8c23142ce5fb2fd77f9ca7a8d8538b79bb0e737038edf58c54cbc814
+  data.tar.gz: 7c5cfc76288b4aa836079650e04df7f4dcacd151e1fca0de2963ff31d186393521581355bd1236db9a8aaa78503f638b844c9d90e452bb2892d372d04a11b544

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,60 @@
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+    - have_
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+Changelog
+=========
+
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+
+Unreleased
+----------
+
+- Added `StringUtils.replace_at(string, index, replacement)`.
+
+
+v0.2.0 - 2020-05-07
+-------------------
+
+- Added `ArrayUtils.pad_right(array, size, padding = nil)`.
+
+
+v0.1.0 - 2020-05-06
+-------------------
+
+- Added `MathUtils.least_common_denominator(a,b)`.
+- Added `MathUtils.greatest_common_divisor(a,b)`.
+
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "faker", "~> 2.x"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.82.x"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    subvisual-utils (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    faker (2.11.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.x)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.82.x)
+  subvisual-utils!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Subvisual, Lda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,107 @@
+Subvisual::Utils
+================
+
+Collection  of reusable Ruby utilities. Made with :heart: by Subvisual.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "subvisual-utils"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install subvisual-utils
+
+
+Usage
+-----
+
+Utilities are exposed as module methods grouped by the type of utility.
+
+
+### `Subvisual::ArrayUtils.pad_right(array, size, padding = nil)`
+
+Fills an array with some padding up to the specified size.
+
+```ruby
+Subvisual::ArrayUtils.pad_right([1, 2, 3], 5, 0) # => [1, 2, 3, 0, 0]
+```
+
+
+### `Subvisual::MathUtils.greatest_common_divisor(a,b)`
+
+Computes the Greatest Common Divisor of two numbers.
+
+```ruby
+Subvisual::MathUtils.greatest_common_divisor(48, 18) # => 6
+```
+
+
+### `Subvisual::MathUtils.least_common_denominator(a,b)`
+
+Computes the Least Common Denominator of two numbers.
+
+```ruby
+Subvisual::MathUtils.least_common_denominator(21, 6) # => 42
+```
+
+
+### `Subvisual::StringUtils.replace_at(string, index, replacement)`
+
+Replaces the character at a specific index in a String.
+
+```ruby
+Subvisual::StringUtils.replace_at("Hello", 1, "a") # => "Hallo"
+```
+
+
+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/subvisual/ruby-utils.
+
+
+License
+-----
+
+Subvisual::Utils is copyright :copy: 2020 Subvisual, Lda.
+
+It is open-source, made available for free, and is subject to the terms in
+its [license].
+
+
+About
+-----
+
+Subvisual::Utils is maintained with :heart: by [Subvisual][subvisual].
+
+[![Subvisual][subvisual-logo]][subvisual]
+
+
+[license]: ./LICENSE.txt
+[subvisual]: http://subvisual.com
+[subvisual-logo]: https://raw.githubusercontent.com/subvisual/guides/master/github/templates/logos/blue.png

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/subvisual/array_utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "subvisual/array_utils/pad"
+
+module Subvisual
+  module ArrayUtils
+    extend Pad
+  end
+end

data/lib/subvisual/array_utils/pad.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Subvisual
+  module ArrayUtils
+    module Pad
+      def pad_right(array, size, padding = nil)
+        return array if array.size >= size
+
+        array + Array.new(size - array.size, padding)
+      end
+    end
+  end
+end

data/lib/subvisual/math_utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "subvisual/math_utils/greatest_common_divisor"
+require "subvisual/math_utils/least_common_denominator"
+
+module Subvisual
+  module MathUtils
+    extend GreatestCommonDivisor
+    extend LeastCommonDenominator
+  end
+end

data/lib/subvisual/math_utils/greatest_common_divisor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Subvisual
+  module MathUtils
+    module GreatestCommonDivisor
+      def greatest_common_divisor(a, b)
+        d = 0
+
+        while a.even? && b.even?
+          a /= 2
+          b /= 2
+          d += 1
+        end
+
+        while a != b
+          if a.even?
+            a /= 2
+          elsif b.even?
+            b /= 2
+          elsif a > b
+            a = (a - b) / 2
+          else
+            b = (b - a) / 2
+          end
+        end
+
+        2**d * a
+      end
+    end
+  end
+end

data/lib/subvisual/math_utils/least_common_denominator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Subvisual
+  module MathUtils
+    module LeastCommonDenominator
+      def least_common_denominator(a, b)
+        (a * b).abs / MathUtils.greatest_common_divisor(a, b)
+      end
+    end
+  end
+end

data/lib/subvisual/string_utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "subvisual/string_utils/replace_at"
+
+module Subvisual
+  module StringUtils
+    extend ReplaceAt
+  end
+end

data/lib/subvisual/string_utils/replace_at.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Subvisual
+  module StringUtils
+    module ReplaceAt
+      def replace_at(string, index, replacement)
+        string.chars.tap do |characters|
+          characters[index] = replacement
+        end.join
+      end
+    end
+  end
+end

data/lib/subvisual/utils.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Subvisual
+  module Utils
+    VERSION = "0.3.0"
+  end
+end

data/subvisual-utils.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/subvisual/utils"
+
+Gem::Specification.new do |spec|
+  spec.name          = "subvisual-utils"
+  spec.version       = Subvisual::Utils::VERSION
+  spec.authors       = ["Pedro Costa"]
+  spec.email         = ["pedro@subvisual.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Collection of reusable Ruby utilities by Subvisual"
+  spec.homepage      = "https://github.com/subvisual/ruby-utils"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/subvisual/ruby-utils"
+  spec.metadata["changelog_uri"] = "https://github.com/subvisual/ruby-utils/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: subvisual-utils
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Pedro Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pedro@subvisual.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/subvisual/array_utils.rb
+- lib/subvisual/array_utils/pad.rb
+- lib/subvisual/math_utils.rb
+- lib/subvisual/math_utils/greatest_common_divisor.rb
+- lib/subvisual/math_utils/least_common_denominator.rb
+- lib/subvisual/string_utils.rb
+- lib/subvisual/string_utils/replace_at.rb
+- lib/subvisual/utils.rb
+- subvisual-utils.gemspec
+homepage: https://github.com/subvisual/ruby-utils
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/subvisual/ruby-utils
+  source_code_uri: https://github.com/subvisual/ruby-utils
+  changelog_uri: https://github.com/subvisual/ruby-utils/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Collection of reusable Ruby utilities by Subvisual
+test_files: []