huffify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcd01691951ba6965369cffe9a2c8e124162f0c53fc7d81a8e230a1f529558d4
+  data.tar.gz: 6b4cf6c8b86fb7ea9e3cf37bb880a7e87c6d8854df5b8aca868fd8f6416981ca
+SHA512:
+  metadata.gz: f3f1a39bbc56b684f9a88670c671247877d6556638adf3ea407550e29924f2f687195ec7dcfd3c6add898c843a0ac75cbe1a468eb16d4cfc4be7f027bbc7193d
+  data.tar.gz: 3d065482d67930e1bf3b25b89a332d51d06d8d54107cc84fae18c2dbf5c243adff61abbb28840492b12a93df610560e2ad13a92debdf1b62173c91f5a8837994

data/.rspec

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ivan Mihun
+
+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,44 @@
+# Huffify
+Huffify is a Ruby gem that provides functionality to encode and decode text data using Huffman encoding, a lossless data compression algorithm. Huffman encoding efficiently compresses data by assigning shorter codes to more frequent symbols and longer codes to less frequent symbols.
+
+## Installation
+
+To install the gem, add this line to your application's Gemfile:
+
+```ruby
+gem 'huff'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install huffman_encoder
+```
+
+## Usage
+
+### Basic Encoding and Decoding
+
+Here's how you can use the gem to encode and decode a string using Huffman encoding:
+
+```ruby
+require 'huff'
+text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
+
+result = encode(text)
+
+decoded_text = decode(result[:encoded_text], result[:huffman_tree])
+
+decoded_text == text  # true
+
+```
+
+## 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 "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/huffify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Huffify
+  VERSION = "0.1.0"
+end

data/lib/huffify.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require 'pqueue'
+require_relative "huff/version"
+
+module Huffify
+  class HuffNode
+    attr_accessor :char, :frequency, :left, :right
+
+    def initialize(char, frequency, left = nil, right = nil)
+      @char = char
+      @frequency = frequency
+      @left = left
+      @right = right
+    end
+  end
+
+  def encode(text)
+    huffman_tree = build_huffman_tree(text)
+    codes = get_char_codes(huffman_tree)
+    { encoded_text: text.each_char.map { |char| codes[char] }.join, huffman_tree: huffman_tree }
+  end
+
+  def decode(bits, huffman_tree)
+    text = ""
+    cur_node = huffman_tree
+    bits.each_char do |bit|
+      cur_node = bit == '0' ? cur_node.left : cur_node.right
+      if cur_node.char
+        text += cur_node.char
+        cur_node = huffman_tree
+      end
+    end
+    text
+  end
+
+  private
+
+  def create_occurrences_map(text)
+    occurrences_map = Hash.new(0)
+    text.each_char { |char| occurrences_map[char] += 1 }
+    occurrences_map
+  end
+
+  def build_huffman_tree(text)
+    occurrences_map = create_occurrences_map(text)
+    pq = PQueue.new { |a, b| a.frequency < b.frequency }
+    occurrences_map.each { |char, count| pq.push(HuffNode.new(char, count)) }
+    until pq.size == 1
+      first, second = pq.pop, pq.pop
+      pq.push(HuffNode.new(nil, first.frequency + second.frequency, first, second))
+    end
+    pq.pop
+  end
+
+  def get_char_codes(node, code = '', codes = {})
+    if node.char
+      codes[node.char] = code
+    else
+      get_char_codes(node.left, code + '0', codes)
+      get_char_codes(node.right, code + '1', codes)
+    end
+    codes
+  end
+end

data/sig/huffify/huff_node.rbs

@@ -0,0 +1,12 @@
+module Huffify
+  class HuffNode
+    @char: String
+    @frequency: Integer
+
+    attr_accessor char: String | nil
+    attr_accessor frequency: Integer
+    attr_accessor left: HuffNode | nil
+    attr_accessor right: HuffNode | nil
+
+  end
+end

data/sig/huffify.rbs

@@ -0,0 +1,14 @@
+module Huffify
+  VERSION: String
+
+  def encode: (String text) -> Hash[Symbol, HuffNode | String]
+  def decode: (String bits, HuffNode tree) -> String
+
+  private
+
+  def build_huffman_tree: (String text) -> HuffNode
+
+  def create_occurrences_map: (String text) -> Hash[String, Integer]
+
+  def get_char_codes: (HuffNode node, String code, Hash[String, String]) -> Hash[String, String]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: huffify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Mihun
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Huffify is a Ruby gem that provides functionality to encode and decode
+  text data using Huffman encoding, a lossless data compression algorithm. Huffman
+  encoding efficiently compresses data by assigning shorter codes to more frequent
+  symbols and longer codes to less frequent symbols.
+email:
+- vsk76090@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/huffify.rb
+- lib/huffify/version.rb
+- sig/huffify.rbs
+- sig/huffify/huff_node.rbs
+homepage: https://github.com/ivan-22-3-5/huff
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ivan-22-3-5/huff
+  source_code_uri: https://github.com/ivan-22-3-5/huff
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby gem for lossless data compression using Huffman encoding.
+test_files: []