golomb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3006e47bfd7f8284ec9a97bbc04b3fb583208ad8
+  data.tar.gz: 0641044c55b5674cc32eefe4a5464e971a61b5a7
+SHA512:
+  metadata.gz: e4de6b663ad2c59416846f9d1b97cdb3747a8a43bc6bf0ed332d33725792ef91a511374f61227184bc0a543b36d9b7e092dab9d03f0c5f7b0735999bb1a24f3c
+  data.tar.gz: 3a038c14452695393fbe31ea3e7ba88ad24baf0df5b2b77201ebd2a42179c89b4978a47341aeb7804dd637073667cc09b7652a87e29d8f0626b3fe049e8e2ea9

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    golomb (0.0.1)
+      gli (= 2.13.2)
+      terminal-table (= 1.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.9.0)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    builder (3.2.2)
+    childprocess (0.5.6)
+      ffi (~> 1.0, >= 1.0.11)
+    contracts (0.12.0)
+    cucumber (2.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
+      diff-lcs (>= 1.1.3)
+      gherkin3 (~> 3.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.3.0)
+      gherkin3 (~> 3.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    gherkin3 (3.1.1)
+    gli (2.13.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    terminal-table (1.5.2)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  golomb!
+  rake
+  rdoc

data/README.md

@@ -0,0 +1,79 @@
+# Golomb coding
+
+Command-line tool that encodes and decodes content using the Golomb coding algorithm.
+
+## Installing
+
+Make sure that you have the Ruby's environment installed.
+
+#### Installing via Ruby Gems
+
+    $ gem install golomb-cli
+
+After installing you have access to the command `golomb` on your terminal.
+
+#### Manual installation
+
+Download the project and execute the command below. Make sure that you are on the project directory.
+
+    $ bundle install
+
+This command will install all dependencies. After installed you can access the binary located in `bin/golomb`. Execute the binary based on the examples below.
+
+## Usage
+
+The tool has the commands `encode` and `decode`.
+
+Use the help option to view all parameters allowed.
+
+    $ golomb --help
+
+#### Encoding
+
+The example below encodes a text file using the divisor 10 and saves the encoded data into a file named my_output. The verbose option prints the symbols table.
+
+    $ golomb --divisor 10 --output my_output encode --verbose my_file.txt
+
+You can pass a text stream to encode instead of a file.
+
+    $ golomb --divisor 10 --output my_output encode --verbose "My text goes here"
+
+Output generated by the encode command with the verbose option:
+
+    +---------+------------------+
+    |        Symbol table        |
+    +---------+------------------+
+    | Symbol  | Encode           |
+    +---------+------------------+
+    | M (77)  | 111111101101     |
+    | y (121) | 1111111111110001 |
+    |   (32)  | 1110010          |
+    | t (116) | 1111111111101100 |
+    | e (101) | 11111111110001   |
+    | x (120) | 1111111111110000 |
+    | t (116) | 1111111111101100 |
+    |   (32)  | 1110010          |
+    | g (103) | 11111111110011   |
+    | o (111) | 111111111110001  |
+    | e (101) | 11111111110001   |
+    | s (115) | 111111111110101  |
+    |   (32)  | 1110010          |
+    | h (104) | 11111111110100   |
+    | e (101) | 11111111110001   |
+    | r (114) | 111111111110100  |
+    | e (101) | 11111111110001   |
+    +---------+------------------+
+
+    INPUT HEX:
+    0x4d 0x79 0x20 0x74 0x65 0x78 0x74 0x20 0x67 0x6f 0x65 0x73 0x20 0x68 0x65 0x72 0x65
+
+    OUTPUT HEX:
+    0xfed 0xfff1 0x72 0xffec 0x3ff1 0xfff0 0xffec 0x72 0x3ff3 0x7ff1 0x3ff1 0x7ff5 0x72 0x3ff4 0x3ff1 0x7ff4 0x3ff1
+
+#### Decoding
+
+The example below decodes the previously encoded file.
+
+    $ golomb --divisor 10 decode my_output
+
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('golomb.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/golomb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+require 'gli'
+
+require 'golomb'
+require 'terminal-table'
+
+include GLI::App
+
+program_desc 'Encoder and decoder'
+
+version Golomb::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Divisor value'
+default_value '16'
+arg_name 'The divisor value for encode and decode'
+flag [:d,:divisor]
+
+desc 'Output file'
+default_value 'output'
+arg_name 'The output file name'
+flag [:o,:output]
+
+desc 'Encode a file or a text stream'
+arg_name 'File path or text stream to be encoded'
+command :encode do |c|
+
+  c.desc 'Show symbols table'
+  c.switch [:v,:verbose]
+
+
+  c.action do |global_options,options,args|
+    # executes the encoder process
+    @encoder = Golomb::Encoder.new(global_options[:d].to_i, @data)
+    @encoder.exec
+
+  end
+end
+
+desc 'Describe decode here'
+arg_name 'File or text stream to be decoded'
+command :decode do |c|
+  c.action do |global_options,options,args|
+    # executes the decoder process
+    @decoder = Golomb::Decoder.new(global_options[:d].to_i, @data)
+    @decoder.exec
+  end
+end
+
+pre do |global,command,options,args|
+  # checks if is a valid file or a text stream
+  if File.exists?(args.first)
+    @data = File.open(args.first).read
+  else
+    @data = args.first
+  end
+
+  true
+end
+
+post do |global,command,options,args|
+  case command.name
+  when :encode then
+    # if verbose flag is enable
+    if options[:v]
+      table = Terminal::Table.new :title => "Symbol table", :headings => ['Symbol', 'Encode'], :rows => @encoder.symbol_table
+      puts table
+
+      puts "\nINPUT HEX:"
+      puts @encoder.data_to_hex
+      puts "\nOUTPUT HEX:"
+      puts @encoder.result_to_hex
+    end
+
+    # generates the output file
+    output = File.new(global[:o], 'wb')
+    output.write(@encoder.result_to_hex)
+    output.close
+  when :decode then
+    # shows the decoded data
+    puts @decoder.decoded_data.join
+  end
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  p exception.message
+  p exception.backtrace
+  true
+end
+
+exit run(ARGV)

data/golomb.gemspec

@@ -0,0 +1,23 @@
+require File.join([File.dirname(__FILE__),'lib','golomb','version.rb'])
+require File.join([File.dirname(__FILE__),'lib','golomb','decoder.rb'])
+require File.join([File.dirname(__FILE__),'lib','golomb','encoder.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'golomb'
+  s.version = Golomb::VERSION
+  s.author = 'Bruno Flach Bohn / Cássio Ghilardi'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Golomb command-line tool'
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.md']
+  s.rdoc_options << '--title' << 'golomb' << '--main' << 'README.md' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'golomb'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('terminal-table','1.5.2')
+  s.add_runtime_dependency('gli','2.13.2')
+end

data/golomb.rdoc

@@ -0,0 +1,5 @@
+= golomb
+
+Generate this with
+    golomb rdoc
+After you have described your command line interface

data/lib/golomb/decoder.rb

@@ -0,0 +1,33 @@
+module Golomb
+  class Decoder
+    def initialize(divisor, data)
+      @divisor = divisor
+      @data = data
+      @decoded_data = []
+    end
+
+    attr_accessor :divisor, :data, :decoded_data
+
+    def exec
+      @data.split(" ").each do |n|
+        decode(n)
+      end
+    end
+
+    def decode(n)
+      b = Math.log2(@divisor).ceil
+      binary = n.to_i(16).to_s(2)
+      quotient_code, remainder_code = binary.sub("0", "-").split("-")
+      quotient = quotient_code.size
+      remainder = (remainder_code == 3 ? "0#{remainder_code}" : remainder_code).to_i(2)
+
+      if remainder >= (2 ** b) - @divisor
+        remainder = -(2 ** b) + @divisor + remainder
+      end
+
+      symbol = (quotient * @divisor + remainder).chr
+      @decoded_data << symbol
+    end
+  end
+end
+

data/lib/golomb/encoder.rb

@@ -0,0 +1,52 @@
+module Golomb
+  class Encoder
+
+    def initialize(divisor, data)
+      @divisor = divisor
+      @data = data
+      @encoded_data = []
+    end
+
+    attr_accessor :divisor, :data, :encoded_data
+
+    def exec
+      @data.each_byte do |byte|
+        encode(byte)
+      end
+    end
+
+    def encode(symbol)
+      quotient = (symbol / @divisor).to_i
+      remainder = symbol % @divisor
+      quotient_code = ("1" * quotient) << "0"
+
+      # checks if the divisor is power of 2 (Rice coding)
+      if @divisor.to_s(2).scan(/1/).size == 1
+        remainder_code = "0" << remainder.to_s(2)
+      else
+        b = Math.log2(@divisor).ceil
+
+        if remainder < (2 ** b) - @divisor
+          remainder_code = "0" * (b - 1 - remainder.to_s(2).size) << remainder.to_s(2)
+        else
+          remainder_code = (remainder + (2 ** b) - @divisor).to_i.to_s(2)
+        end
+      end
+
+      @encoded_data << (quotient_code << remainder_code)
+    end
+
+    def data_to_hex
+      @data.unpack('U'*@data.length).collect {|x| "0x#{x.to_s(16)}" }.join(" ")
+    end
+
+    def result_to_hex
+      @encoded_data.collect {|x| "0x%02x" % x.to_i(2) }.join(" ")
+    end
+
+    def symbol_table
+      @encoded_data.collect.with_index {|x, i| ["#{@data[i]} (#{@data[i].ord})", x]}
+    end
+
+  end
+end

data/lib/golomb/version.rb

@@ -0,0 +1,3 @@
+module Golomb
+  VERSION = '0.0.1'
+end

data/lib/golomb.rb

@@ -0,0 +1,3 @@
+require 'golomb/version.rb'
+require 'golomb/encoder.rb'
+require 'golomb/decoder.rb'

data/my_output

@@ -0,0 +1 @@
+0xfed 0xfff1 0x72 0xffec 0x3ff1 0xfff0 0xffec 0x72 0x3ff3 0x7ff1 0x3ff1 0x7ff5 0x72 0x3ff4 0x3ff1 0x7ff4 0x3ff1 0x72 0x7fee 0x7ff1 0x7ff0 0x3ff3 0x72 0xffec 0x3ff1 0xfff0 0xffec 0x72 0x3ff5 0x7ff5 0x72 0x3fed 0x72 0x3ff3 0x7ff1 0x7ff1 0x3ff0 0x72 0x7ff1 0x7ff2 0xffec 0x3ff5 0x7ff1 0x7ff0 0x72 0xffec 0x7ff1 0x72 0xffec 0x3ff1 0x7ff5 0xffec 0x72 0xffec 0x3ff4 0x3ff5 0x7ff5 0x72 0x3fef 0x7ff1 0x7fef 0x7fef 0x3fed 0x7ff0 0x3ff0 0x72 0x7fee 0x3ff5 0x7ff0 0x3ff1 0x72 0xffec 0x7ff1 0x7ff1 0x7fee

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: golomb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Flach Bohn / Cássio Ghilardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+description: 
+email: 
+executables:
+- golomb
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/golomb
+- golomb.gemspec
+- golomb.rdoc
+- lib/golomb.rb
+- lib/golomb/decoder.rb
+- lib/golomb/encoder.rb
+- lib/golomb/version.rb
+- my_output
+- test/default_test.rb
+- test/test_helper.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- golomb
+- "--main"
+- README.md
+- "-ri"
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Golomb command-line tool
+test_files: []