lycopodium 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 647237749059c644529c2ddb5887e8a6d3aa61df
+  data.tar.gz: ac48dee2979e40b13b3e8b3635ab5d07825961ee
+SHA512:
+  metadata.gz: 5c063aec1bb6ade2ddebc89b540566c39472d09f0c15342c3ff091a0aa7b2fd57ddf51cf22cebbed7a946dd51e87191e88a62a494b682fe1db4dfa1b27d725be
+  data.tar.gz: 9f53c88a5b548ceef3ccd12bb82dc1d25e8efaa786b754da0020d2a34d8e1ba46f9564b032f6fb80f42fdee5419050873a1d329f63292f3526d372c63158c38a

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Open North Inc.
+
+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,103 @@
+# Lycopodium Finds Fingerprints
+
+[![Build Status](https://secure.travis-ci.org/opennorth/lycopodium.png)](http://travis-ci.org/opennorth/lycopodium)
+[![Dependency Status](https://gemnasium.com/opennorth/lycopodium.png)](https://gemnasium.com/opennorth/lycopodium)
+[![Coverage Status](https://coveralls.io/repos/opennorth/lycopodium/badge.png?branch=master)](https://coveralls.io/r/opennorth/lycopodium)
+[![Code Climate](https://codeclimate.com/github/opennorth/lycopodium.png)](https://codeclimate.com/github/opennorth/lycopodium)
+
+Test what transformations you can make to a set of values without creating collisions.
+
+> Historically, Lycopodium powder, the spores of Lycopodium and related plants, was used as a fingerprint powder. – [Wikipedia](http://en.wikipedia.org/wiki/Fingerprint_powder#Composition)
+
+## Usage
+
+```ruby
+require 'lycopodium'
+```
+
+First, write a method that transforms a value, for example:
+
+```ruby
+meth1 = ->(string) do
+  string.gsub(/\p{Space}/, '')
+end
+```
+
+Then, initialize a `Lycopodium` instance with a set of values and the transformation method:
+
+```ruby
+set = Lycopodium.new(["foo", "f o o"], meth1)
+```
+
+Lastly, test whether the method creates collisions between the members of the set:
+
+```ruby
+set.value_to_fingerprint
+```
+
+In this example, an exception will be raised, because the method creates collisions:
+
+    Lycopodium::Collision: "foo", "f o o" => "foo"
+
+With another method that, for example, uppercases a string and creates no collisions:
+
+```ruby
+meth2 = ->(string) do
+  string.upcase
+end
+```
+
+It will return the mapping from original to transformed string:
+
+    {"foo" => "FOO", "f o o" => "F O O"}
+
+We thus learn that whitespace disambiguates between members of the set, but letter case does not.
+
+To remove all members of the set that collide after transformation, run:
+
+```ruby
+set_without_collisions = set.reject_collisions
+```
+
+A `Lycopodium` instance otherwise behaves as an array.
+
+## Method definition
+
+Besides the `->` syntax above, you can define the same method as:
+
+```ruby
+meth = lambda do |string|
+  string.gsub(/\p{Space}/, '')
+end
+```
+
+Or:
+
+```ruby
+meth = proc do |string|
+  string.gsub(/\p{Space}/, '')
+end
+```
+
+Or:
+
+```ruby
+meth = Proc.new do |string|
+  string.gsub(/\p{Space}/, '')
+end
+```
+
+Or even:
+
+```ruby
+def func(string)
+  string.gsub(/\p{Space}/, '')
+end
+meth = Object.method(:func)
+```
+
+## Bugs? Questions?
+
+This project's main repository is on GitHub: [http://github.com/opennorth/lycopodium](http://github.com/opennorth/lycopodium), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
+
+Copyright (c) 2013 Open North Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/USAGE

@@ -0,0 +1 @@
+See README.md for full usage details.

data/lib/lycopodium/version.rb

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

data/lib/lycopodium.rb

@@ -0,0 +1,71 @@
+require "set"
+
+class Lycopodium < Array
+  class Error < StandardError; end
+  class Collision < Error; end
+
+  attr_accessor :function
+
+  # @param [Array] set a set of values
+  # @param [Proc] function a method that transforms a value
+  def initialize(set, function = lambda{|value| value})
+    replace(set)
+    self.function = function
+  end
+
+  # @return [Array] the members of the set without collisions
+  def reject_collisions
+    hashes, collisions = hashes_and_collisions
+
+    items = hashes.reject do |_,hash|
+      collisions.include?(hash)
+    end.map do |item,_|
+      item
+    end
+
+    self.class.new(items, function)
+  end
+
+  # @return [Hash] a mapping from the original to the transformed value
+  # @raise [Collision] if the method creates collisions between members of the set
+  def value_to_fingerprint
+    hashes, collisions = hashes_and_collisions
+
+    unless collisions.empty?
+      message = []
+      collisions.each do |collision|
+        items = hashes.select do |_,hash|
+          hash == collision
+        end.map do |item,_|
+          item
+        end
+        message << %(#{items.map(&:inspect) * ", "} => "#{collision}")
+      end
+      raise Collision, message * "\n"
+    end
+
+    hashes
+  end
+
+private
+
+  def hashes_and_collisions
+    collisions = Set.new
+
+    hashes = {}
+    counts = {}
+
+    each do |item|
+      unless hashes.key?(item)
+        hashes[item] = function.call(item)
+      end
+      if counts.key?(hashes[item])
+        collisions << hashes[item]
+      else
+        counts[hashes[item]] = 1
+      end
+    end
+
+    [hashes, collisions]
+  end
+end

data/lycopodium.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lycopodium/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "lycopodium"
+  s.version     = Lycopodium::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Open North"]
+  s.email       = ["info@opennorth.ca"]
+  s.homepage    = "http://github.com/opennorth/lycopodium"
+  s.summary     = %q{Test what transformations you can make to a set of unique strings without creating collisions}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rspec', '~> 2.10')
+  s.add_development_dependency('rake')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/lycopodium'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: lycopodium
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Open North
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !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'
+description: 
+email:
+- info@opennorth.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- USAGE
+- lib/lycopodium.rb
+- lib/lycopodium/version.rb
+- lycopodium.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/opennorth/lycopodium
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Test what transformations you can make to a set of unique strings without
+  creating collisions
+test_files:
+- spec/spec_helper.rb