easy_encoding 0.0.0 → 0.0.1.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98e335ebddba785c3c73c23e0fc8fb075ab1afae
-  data.tar.gz: 8c65cf12099a7e7502c31c9386c09f18234a6745
+  metadata.gz: 7170b15f4d0727a9b89ede204cb984cceaecea5c
+  data.tar.gz: 8e9d99b86ea8f8ccf637eaab3bf232b67320e1bf
 SHA512:
-  metadata.gz: b7234250a3932eccae01619b2979c10434bb935dca1e024c51af35079da71a91589c56a6b2fb0f7e1c3c2c01262825902c74f4025abe793ea756e0ac0dacfee8
-  data.tar.gz: 7e319f00877f6fe7632e7d06d3b37c76d5c9b77821248cc7c0b9f71fb9635cf5ad41b54467ca4c771a6c44a2a37149014db673d86b9c64f8e9e73de9ed5c7842
+  metadata.gz: f9679c0d4eeb6ea162d059e042963cad2bdbbaaca3eeb7c7791ff162052dfb395183dd015d636624336600442bc73412f494b14f461f36a7c015497763f03e30
+  data.tar.gz: b6b2af1867904c8a8a1ba9177e89b754516fcbafc79d782d9b69b2c1a48b5a295030f464a3d27776c87e0ee0714762cd5b56cbaa2a72a9bb3b2abb3e54e925c9

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  Include:
+    - !ruby/regexp /\.rb$/
 Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:
@@ -6,3 +9,5 @@ Style/Semicolon:
   Enabled: false
 Metrics/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Max: 15

data/README.md

@@ -20,10 +20,32 @@ And then execute:
 Or install it yourself as:
 
     $ gem install easy_encoding
+    
+## Configuration
+You can configure symbol for left and right node of tree.
+```ruby
+EasyEncoding.configure do |config|
+  config.right_node_symbol = 0
+  config.left_node_symbol = 1
+end
+```
 
 ## Usage
 
+#### Huffman coding
 
+Using with string:
+```ruby
+huffman = EasyEncoding::Huffman.new('code')
+huffman.frequencies            #=> {:e=>0.25, :d=>0.25, :o=>0.25, :c=>0.25}
+huffman.char_codes             #=> {:c=>"00", :o=>"01", :d=>"10", :e=>"11"}
+```
+Using with frequencies:
+```ruby
+huffman = EasyEncoding::Huffman.new({ x7: 0.42, x3: 0.28, x5: 0.1, x6: 0.1, x4: 0.05, x2: 0.03, x1: 0.02 })
+huffman.frequencies            #=> {:x7=>0.42, :x3=>0.28, :x6=>0.1, :x5=>0.1, :x4=>0.05, :x2=>0.03, :x1=>0.02}
+huffman.char_codes             #=> {:x7=>"1", :x3=>"01", :x5=>"0000", :x6=>"0001", :x4=>"0011", :x2=>"00100", :x1=>"00101"}
+```
 
 ## Contributing
 

data/easy_encoding.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |spec|
   spec.description   = 'Easy encoding is a tool that allows you to encode and decode data.'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.3.0'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

data/lib/easy_encoding.rb

@@ -1,4 +1,21 @@
 require 'easy_encoding/version'
+require 'easy_encoding/configuration'
+require 'easy_encoding/huffman'
 
 module EasyEncoding
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/easy_encoding/configuration.rb

@@ -0,0 +1,10 @@
+module EasyEncoding
+  class Configuration
+    attr_accessor :right_node_symbol, :left_node_symbol
+
+    def initialize
+      @right_node_symbol = 1
+      @left_node_symbol = 0
+    end
+  end
+end

data/lib/easy_encoding/huffman.rb

@@ -0,0 +1,57 @@
+require 'easy_encoding/node'
+
+module EasyEncoding
+  class Huffman
+    attr_reader :input, :char_codes, :frequencies, :root
+
+    def initialize(input)
+      case input
+      when Hash
+        raise ArgumentError, 'summ of frequencies should eq 1' if input.values.reduce(:+) > 1
+        @frequencies = input.sort_by { |_, value| value }.reverse.to_h
+      when String
+        @input = input
+        @frequencies = calculate_frequencies(input)
+      else
+        raise ArgumentError, 'you must provide a hash or a string'
+      end
+      @root = create_tree(frequencies)
+      @char_codes = generate_codes(root)
+    end
+
+    private
+
+    def generate_codes(root)
+      {}.tap { |result| root.walk { |node, code| result[node.symbol] = code unless node.merged? } }
+        .sort_by { |_, value| value.length }.to_h
+    end
+
+    def calculate_frequencies(string)
+      frequencies = Hash.new(0.0)
+      frequencies.tap { |freq| string.each_char { |char| freq[char.to_sym] += 1 } }
+                 .each { |key, value| frequencies[key] = value / string.size }
+                 .sort_by { |_, value| value }.reverse.to_h
+    end
+
+    def create_tree(frequencies)
+      nodes = [].tap { |result| frequencies.each { |sym, freq| result << Node.new(symbol: sym, frequency: freq) } }
+
+      while nodes.size > 1
+        nodes.sort!
+        nodes << merge_nodes(nodes.shift(2))
+      end
+
+      nodes.first
+    end
+
+    def merge_nodes(nodes)
+      right_node, left_node = nodes.sort
+      frequency = nodes.map(&:frequency).reduce(:+)
+
+      node = Node.new(frequency: frequency, left: left_node, right: right_node)
+      right_node.parent = left_node.parent = node
+
+      node
+    end
+  end
+end

data/lib/easy_encoding/node.rb

@@ -0,0 +1,38 @@
+require 'easy_encoding/configuration'
+
+module EasyEncoding
+  class Node
+    include Comparable
+
+    attr_reader :frequency, :symbol, :left, :right
+    attr_accessor :parent
+
+    def initialize(params)
+      @frequency = params.fetch(:frequency, 0)
+      @symbol = params.fetch(:symbol, '')
+      @left = params.fetch(:left, nil)
+      @right = params.fetch(:right, nil)
+      @parent = params.fetch(:parent, nil)
+    end
+
+    def walk(&block)
+      walk_node('', &block)
+    end
+
+    def walk_node(code, &block)
+      yield(self, code)
+      left&.walk_node(code + EasyEncoding.configuration.left_node_symbol.to_s, &block)
+      right&.walk_node(code + EasyEncoding.configuration.right_node_symbol.to_s, &block)
+    end
+
+    def <=>(other)
+      return nil unless other.is_a?(self.class)
+
+      frequency <=> other.frequency
+    end
+
+    def merged?
+      symbol == ''
+    end
+  end
+end

data/lib/easy_encoding/version.rb

@@ -1,3 +1,3 @@
 module EasyEncoding
-  VERSION = '0.0.0'.freeze
+  VERSION = '0.0.1.alpha1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_encoding
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1.alpha1
 platform: ruby
 authors:
 - Taras Shpachenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,9 @@ files:
 - Rakefile
 - easy_encoding.gemspec
 - lib/easy_encoding.rb
+- lib/easy_encoding/configuration.rb
+- lib/easy_encoding/huffman.rb
+- lib/easy_encoding/node.rb
 - lib/easy_encoding/version.rb
 homepage: https://github.com/floor114/easy_encoding
 licenses:
@@ -100,12 +103,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1