run_length_encoding_rb 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79d5976a4c25210fa4e2ac722b4d25f8e8d69d28527cad8ac38965f35aa97026
+  data.tar.gz: 8b5547077da37fb7ba5870b37783b1d30ae2eb0d6fa949bb0bd1d82e38b0dd0b
+SHA512:
+  metadata.gz: 9343ec73fa5899b7af382825918bac63e2357a15f05707750a22061d85f7b3a62a54070e5bc4114c0cdc1d7d0da7c764ce525de5162405cc6f46ca02ef3eac29
+  data.tar.gz: e5f1be41e8af7f2528b542a623a134983a447a4b0ff9dadf411951c83f917458f633f2b92f6958f1e0f34a6803cc47b21be1d78539d214189b39aa4af069ace0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+### 0.2.1 / 2023-01-25
+
+* Updated docs.
+
+### 0.2.0 / 2023-01-25
+
+* Improvements:
+  * Decoding is implemented now;
+  * Code was refactored;
+  * Changed gem's name to pass RubyGems.org name filter;
+  * Now gem is available at RubyGems.org.
+
+### 0.1.0 / 2022-12-15
+
+* Initial release:
+  * Only encoding is implemented yet.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in run_length_encoding.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    run_length_encoding_rb (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+  run_length_encoding_rb!
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mate
+
+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,129 @@
+## Description
+
+A simple gem that does run-length encoding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'run_length_encoding_rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install run_length_encoding_rb
+
+## Usage
+
+### Encoding
+
+obj.encode(data [, separator]) -> array
+
+#### Arguments
+
++ _data_
+
+    Data to encode. Supported types:
+    - Array;
+    - String;
+    - Enumerator.
+
++ _separator_
+
+    A String or Regexp to split the string into single elements. Used only if _data_ is a String.
+
+#### Returns
+
++ _Array<Hash{:chunk => Object, :count => Integer}>_
+
+    Encoded data in the following format:
+    Array<Hash{:chunk => Object, :count => Integer}>, where:
+    - :chunk => Object: a repeated element;
+    - :count => Integer: how many times the element is repeated.
+
+### Encoding examples
+
+```ruby
+require 'run_length_encoding'
+
+rle = RunLengthEncoding.new
+
+# Encode an array:
+a = %w[foo foo bar foo foo foo]
+
+rle.encode(a)
+# => [{:chunk=>"foo", :count=>2}, {:chunk=>"bar", :count=>1}, {:chunk=>"foo", :count=>3}]
+
+# Encode a string with a default separator (each character is treated as a single element):
+str = 'foo'
+rle.encode(str)
+# => [{:chunk=>"f", :count=>1}, {:chunk=>"o", :count=>2}]
+
+# Encode a string with a custom separator:
+str = 'foo_foo_bar'
+rle.encode(str, '_')
+# => [{:chunk=>"foo", :count=>2}, {:chunk=>"bar", :count=>1}]
+
+# Encode an enumerator:
+str = 'foo'
+rle.encode(str.each_byte)
+# => [{:chunk=>102, :count=>1}, {:chunk=>111, :count=>2}]
+```
+
+### Decoding
+
+obj.decode(data) -> array
+
+#### Arguments
+
++ _data_
+
+    Data to decode in the following format:
+    Array<Hash{:chunk => Object, :count => Integer}>, where:
+    - :chunk => Object: a repeated element;
+    + :count => Integer: how many times the element is repeated.
+
+#### Returns
+
+Array<Object>
+
+Decoded data.
+<!-- -->
+
+### Decoding example
+
+```ruby
+require 'run_length_encoding'
+
+rle = RunLengthEncoding.new
+
+# Decode data of mixed types:
+data = [
+  { count: 3, chunk: "foo" },
+  { count: 1, chunk: "bar" },
+  { count: 2, chunk: nil },
+  { count: 4, chunk: 1 }
+]
+
+rle.decode(data)
+# => ["foo", "foo", "foo", "bar", nil, nil, 1, 1, 1, 1]
+```
+
+## Development
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/8bit-mate/run_length_encoding.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "run_length_encoding"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/run_length_encoding/constants.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Constants
+  CHUNK_KEY = :chunk
+  COUNT_KEY = :count
+end

data/lib/run_length_encoding/decoder.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "decoding_element_check"
+require_relative "constants"
+
+#
+# Decode run-length encoded data.
+#
+module Decoder
+  include Constants
+  include DecodingElementCheck
+
+  #
+  # Pass data to the decoder.
+  #
+  # @param [Array<Hash{ Symbol => Object }>] data
+  #
+  # @return [Array]
+  #
+  # @raise [ArgumentError, TypeError]
+  #   Raises if data isn't an Array [TypeError] or an empty Array [ArgumentError].
+  #
+  def decode(data)
+    ex_details = _check_dec_data(data)
+
+    raise(ex_details[:ex_type], ex_details[:ex_msg]) if ex_details
+
+    _decode(data)
+  end
+
+  private
+
+  def _check_dec_data(data)
+    case data
+    when Array
+      if data.to_a.empty?
+        {
+          ex_type: ArgumentError,
+          ex_msg: "the given data is empty (no data to decode)"
+        }
+      end
+    else
+      {
+        ex_type: TypeError,
+        ex_msg: "wrong argument type #{data.class} (expected Array)"
+      }
+    end
+  end
+
+  #
+  # Decode data.
+  #
+  # @param [Array<Hash{ Symbol => Object }>] data
+  #
+  # @return [Array]
+  #
+  # @raise [ArgumentError, TypeError]
+  #
+  def _decode(data)
+    decoded_data = []
+
+    data.each do |hash|
+      check_result = _valid_hash?(hash)
+      raise(check_result[:ex_type], check_result[:ex_msg]) unless check_result[:comply]
+
+      hash[COUNT_KEY].times { decoded_data.append(hash[CHUNK_KEY]) }
+    end
+
+    decoded_data
+  end
+end

data/lib/run_length_encoding/decoding_element_check.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "constants"
+
+#
+# Set of checks of a single element to decode.
+#
+module DecodingElementCheck
+  include Constants
+
+  private
+
+  #
+  # Check if element obj complies with the following requirements:
+  # 1. is a hash;
+  # 2. has keys:
+  #   - Constants::CHUNK_KEY (repeating element),
+  #   - Constants::COUNT_KEY (how many times element is repeating);
+  # 3. COUNT_KEY's value is an Integer;
+  # 4. COUNT_KEY's value is a positive number.
+  #
+  # @param [Object] obj
+  #   Object to check.
+  #
+  # @return [Hash{ Symbol => Object }] result
+  #   Result of checks.
+  #   If all checks are passed:
+  #     result = { comply: true }
+  #
+  #   If a check is failed, result also contains exception type and exception message:
+  #     result = { comply: false, ex_type: Exception, ex_msg: String }
+  #
+  def _valid_hash?(obj)
+    check_list = [
+      method(:_a_hash?),
+      method(:_valid_keys?),
+      method(:_count_is_integer?),
+      method(:_count_is_positive?)
+    ]
+
+    for method in check_list
+      result = method.call(obj)
+      break unless result[:comply]
+    end
+
+    result
+  end
+
+  # Check if obj is a hash.
+  def _a_hash?(obj)
+    if obj.is_a?(Hash)
+      {
+        comply: true
+      }
+    else
+      {
+        ex_type: TypeError,
+        ex_msg: "wrong argument type #{obj.class} (expected Hash)",
+        comply: false
+      }
+    end
+  end
+
+  # Check if hash has valid keys.
+  def _valid_keys?(hash)
+    if hash.key?(CHUNK_KEY) && hash.key?(COUNT_KEY)
+      {
+        comply: true
+      }
+    else
+      {
+        ex_type: ArgumentError,
+        ex_msg: "hash #{hash} has wrong keys (key is missing or has a wrong name)",
+        comply: false
+      }
+    end
+  end
+
+  # Check if count is an Integer.
+  def _count_is_integer?(hash)
+    if hash[COUNT_KEY].is_a?(Integer)
+      {
+        comply: true
+      }
+    else
+      {
+        ex_type: TypeError,
+        ex_msg: "wrong argument type #{hash[COUNT_KEY].class} (expected Integer)",
+        comply: false
+      }
+    end
+  end
+
+  # Check if count is a positive number.
+  def _count_is_positive?(hash)
+    if hash[COUNT_KEY].positive?
+      {
+        comply: true
+      }
+    else
+      {
+        ex_type: ArgumentError,
+        ex_msg: "error in #{hash}: count should be a positive Integer",
+        comply: false
+      }
+    end
+  end
+end

data/lib/run_length_encoding/encoder.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "constants"
+
+#
+# Encode data with RLE.
+#
+module Encoder
+  include Constants
+
+  #
+  # Check and then pass data to the actual encoder.
+  #
+  # @param [Array, String, Enumerator] data
+  #   Data to encode.
+  #
+  # @param [String, Regexp] separator ("")
+  #   Separator for the string arguments.
+  #
+  # @return [Array<Hash{ Symbol => Object }>]
+  #   Encoded data. Each element is a Hash with the following key-value pairs:
+  #     [Constants::CHUNK_KEY => Object]
+  #       A repeated object.
+  #
+  #     [Constants::COUNT_KEY => Integer]
+  #       How many times the object is repeated.
+  #
+  # @raise [ArgumentError, TypeError]
+  #   Raises if data isn't an Array/String/Enumerator [TypeError] or an empty Array [ArgumentError].
+  #
+  def encode(data, separator = "")
+    valid_data, ex_details = _check_enc_data(data, separator)
+
+    raise(ex_details[:ex_type], ex_details[:ex_msg]) if ex_details
+
+    _encode(valid_data)
+  end
+
+  private
+
+  #
+  # Check if data is an array, convert to an array if possible.
+  #
+  # @return [Array] data
+  #   Ready-to-be-encoded data.
+  #
+  # @return [Hash{ Symbol => Object }] ex_details
+  #   Exception type and error if data can't be encoded.
+  #
+  def _check_enc_data(data, separator)
+    ex_details = nil
+
+    case data
+    when Array
+      array = data
+    when String
+      array = data.split(separator)
+    when Enumerator
+      array = data.to_a
+    else
+      ex_details = {
+        ex_type: TypeError,
+        ex_msg: "wrong argument type #{data.class} (expected Array, String or Enumerator)"
+      }
+    end
+
+    if array.to_a.empty?
+      ex_details = {
+        ex_type: ArgumentError,
+        ex_msg: "the given data is empty (no data to encode)"
+      }
+    end
+
+    return array, ex_details
+  end
+
+  #
+  # Encode array using run-length encoding.
+  #
+  # @param [Array] data
+  #   Data to encode.
+  #
+  # @return [Array<Hash{ Symbol => Object }>]
+  #   Encoded data. Each element is a Hash with the following key-value pairs:
+  #     [Constants::CHUNK_KEY => Object]
+  #       A repeated object.
+  #
+  #     [Constants::COUNT_KEY => Integer]
+  #       How many times the object is repeated.
+  #
+  def _encode(data)
+    result = []
+
+    data.each.inject([]) do |memo, element|
+      if memo.last && element == memo.last.last
+        memo.last[0] += 1
+      else
+        memo << [1, element]
+      end
+      result = memo
+    end
+    result.map { |count, chunk| { CHUNK_KEY => chunk, COUNT_KEY => count } }
+  end
+end

data/lib/run_length_encoding/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class RunLengthEncoding
+  VERSION = "0.2.1"
+end

data/lib/run_length_encoding.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "run_length_encoding/version"
+require_relative "run_length_encoding/decoder"
+require_relative "run_length_encoding/encoder"
+
+#
+# Provides methods to encode and decode data using RLE.
+#
+class RunLengthEncoding
+  include Encoder
+  include Decoder
+
+  def initialize(*); end
+end

data/run_length_encoding.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/run_length_encoding/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "run_length_encoding_rb"
+  spec.version       = RunLengthEncoding::VERSION
+  spec.authors       = ["8bit-mate"]
+
+  spec.summary       = "Run-length encoding/decoding."
+  spec.homepage      = "https://github.com/8bit-mate/run_length_encoding.rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/8bit-mate/run_length_encoding.rb"
+  spec.metadata["changelog_uri"] = "https://github.com/8bit-mate/run_length_encoding.rb/blob/main/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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: run_length_encoding_rb
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- 8bit-mate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-24 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/run_length_encoding.rb
+- lib/run_length_encoding/constants.rb
+- lib/run_length_encoding/decoder.rb
+- lib/run_length_encoding/decoding_element_check.rb
+- lib/run_length_encoding/encoder.rb
+- lib/run_length_encoding/version.rb
+- run_length_encoding.gemspec
+homepage: https://github.com/8bit-mate/run_length_encoding.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/8bit-mate/run_length_encoding.rb
+  source_code_uri: https://github.com/8bit-mate/run_length_encoding.rb
+  changelog_uri: https://github.com/8bit-mate/run_length_encoding.rb/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Run-length encoding/decoding.
+test_files: []