ncd 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Zjg2OGRkZDUwNmMxOGJhMjY0NzFhOWI2MjQ4OTE3NGExMTc3YjY4Yg==
+  data.tar.gz: !binary |-
+    NmY4MDU0ZjNlMjE0NDQ4ZmUzNTE1OWUxYjM5Y2I2MWZkNjdmOWQ1Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDhlZWUyZjhmNzFjMjY3Mjk2MTY1NzQ0ZmE3YzBmMmJhMWRkMzY3YmNmYWJm
+    MjE1ZGYzZjZjNDhjN2I4ZTk5MmM3MDJhYzVmZWI1ZWVhZjZkOGNlMzdmZTNl
+    OTUwNTcwYzYzODhiYjE3OTI0NGM2Mzk5NjY1MjBjZGI4Y2ZkZDI=
+  data.tar.gz: !binary |-
+    ZDM5MmQ0MWE1N2I5OTEyMTI4NjhjM2Y5NzZmNjBhODNmNmU3MTg3M2U4YzZm
+    OTlkZTI3NGEyNDk4NzFmZDc5NjNhZWU4MTZhNzZiY2I3YTExMTg5YjE4NGY4
+    NmUxMGJjNDdhMzVkYzMzY2E2MTNjYTM1MzZlYzQ0MTVjNDNjZmQ=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ncd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mnishida
+
+MIT License
+
+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,38 @@
+# NCD
+Ruby gem for calculating Normalized Compression Distance (NCD).
+
+It's inspired by [RubyForge code snippet](http://rubyforge.org/snippet/detail.php?type=snippet&id=3).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ncd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ncd
+
+## Usage
+```ruby
+    require 'ncd'
+
+    a = File.read('somefile.a')
+    b = File.read('somefile.b')
+    distance = NCD.distance(a, b)
+    # or 
+    distance = a.ncd(b)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/ncd.rb

@@ -0,0 +1,16 @@
+require 'zlib'
+require_relative 'ncd/version'
+
+module NCD
+  def self.distance(a, b)
+    min, max = [a, b].map{|d| Zlib::Deflate.deflate(d, Zlib::BEST_COMPRESSION).size }.minmax
+    cab = Zlib::Deflate.deflate(a+b, Zlib::BEST_COMPRESSION).size
+    (cab.to_f - min.to_f) / max.to_f
+  end
+end
+
+class String
+  def ncd(b)
+    NCD.distance(self, b)
+  end
+end

data/lib/ncd/version.rb

@@ -0,0 +1,3 @@
+module Ncd
+  VERSION = "0.0.1"
+end

data/ncd.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ncd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ncd"
+  spec.version       = Ncd::VERSION
+  spec.authors       = ["Masata Nishida"]
+  spec.email         = ["masatanish@gmail.com"]
+  spec.description   = %q{gem for calculating Normalized Compression Distance.}
+  spec.summary       = %q{gem for calculating Normalized Compression Distance.}
+  spec.homepage      = "https://github.com/masatanish/ncd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">=2.13.0"
+end

data/spec/ncd_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+def random_sting(len)
+  len.times.map{ '%c' % rand(0..255) }.join.force_encoding('ascii-8bit')
+end
+
+describe NCD do
+  let(:a) { random_sting(10000) }
+  let(:b) { random_sting(10000) }
+
+  describe '.distance' do
+    context 'when assigned values are same.' do
+      subject { NCD.distance(a, a) }
+      it { expect(subject).to be < 0.1 }
+    end
+    context 'when assign 2 random strings.' do
+      subject { NCD.distance(a, b) }
+      it { expect(subject).to be > 0.9 }
+    end
+  end
+
+  describe 'String#ncd' do
+    context 'when assigned values are same.' do
+      it { expect(a.ncd(a)).to be < 0.1 }
+    end
+    context 'when assign 2 random strings.' do
+      it { expect(a.ncd(b)).to be > 0.9 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'ncd'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ncd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masata Nishida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: gem for calculating Normalized Compression Distance.
+email:
+- masatanish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ncd.rb
+- lib/ncd/version.rb
+- ncd.gemspec
+- spec/ncd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/masatanish/ncd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- 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.0.3
+signing_key: 
+specification_version: 4
+summary: gem for calculating Normalized Compression Distance.
+test_files:
+- spec/ncd_spec.rb
+- spec/spec_helper.rb