hid 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjQ5MGI4NzQ4YzJlMmEwMTgxZDdlYjljMTU1ODNkNDk1ZGNmNmQ5MA==
+  data.tar.gz: !binary |-
+    YzZlNTQ1OTk4ZGYwMjBjMzI3Y2UyZWIwMzc3ODRmMWQwOWYyNmJjOA==
+SHA512:
+  metadata.gz: !binary |-
+    NGVmMmRhZmNmYzQ5MGM4MWZiOTAyOGVmOTVjNGQwOTZkNmM5N2QzZjdhOTRk
+    MzM1ZjYzZWUwODRlNjAxN2QwZjdjOTNmMTgwZTEyMDhiYmUyMjg0MTZhZjg0
+    YzlmNTIyNmQwMjNkYzk3MWIwMzUxZjcxZGE0NDY1NWRlNTFhZTU=
+  data.tar.gz: !binary |-
+    OTdjYjIwNGZjYzVjZWExYTNhM2VlMGI5YTI5NDk0MjA1NDJjYjBmNDYzN2E2
+    NTVkY2QxMmU2NjlkODNhMjkwNWU1YzgxOTliMGZhZjA0Mzc2MTA1NmNlMzIx
+    ZWE0ZTJjNDM0OTZhYWE3NmQ4YWE2MmExNDlkY2ZkY2VjNWQxNDY=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Cavileer
+
+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,68 @@
+# HID
+
+[![Code Climate](https://codeclimate.com/github/bcavileer/hid/badges/gpa.svg)](https://codeclimate.com/github/bcavileer/hid)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hid
+
+## Usage
+
+Configure (optional):
+
+    HID.configure do |config|
+        config.identifier = SomeIdentifier
+        config.recorder = SomeRecorder
+    end
+
+Examples: (these were executed **in order** in a REPL)
+    
+    HID.identify 'foo'
+    => nil
+    
+    HID.map 'bar', 'baz'
+    => nil
+    
+    HID.identify 'bar'
+    => "baz"
+    
+    HID.recorded
+    => {nil=>["foo"]}
+    
+    HID.map 'persistance', 'persistence', 'typos'
+    => nil
+    
+    HID.identify 'persistance', 'typos'
+    => "persistence"
+    
+    HID.identify 'persistance'
+    => nil
+    
+    HID.recorded
+    => {nil=>["foo", "persistance"]}
+    
+    HID.identify 'fizz', 'buzz'
+    => nil
+    
+    HID.recorded
+    => {nil=>["foo", "persistance"], "fizz" => ["buzz"]}
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hid/fork )
+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 a new Pull Request

data/Rakefile

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

data/hid.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hid'
+  spec.version       = HID::VERSION
+  spec.authors       = ['Benjamin Cavileer']
+  spec.email         = ['bcavileer@holmanauto.com']
+  spec.summary       = %q{Identity Mapping}
+  spec.description   = %q{Maps string to other strings?}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+end

data/lib/hid.rb

@@ -0,0 +1,38 @@
+require 'hid/version'
+require 'hid/configuration'
+
+module HID
+  class << self
+    attr_accessor :configuration
+
+    def identify(unknown, type=nil)
+      identity = find unknown, type
+      return identity if identity
+      record unknown, type
+    end
+
+    def map(unknown, identity, type=nil)
+      configuration.identifier.map unknown, identity, type
+    end
+
+    def recorded(type=nil)
+      configuration.recorder.recorded type
+    end
+
+    def configure
+      yield configuration
+    end
+
+    private
+
+    def find(unknown, type)
+      configuration.identifier.find unknown, type
+    end
+
+    def record(unknown, type)
+      configuration.recorder.record unknown, type
+    end
+  end
+
+  self.configuration ||= Configuration.new
+end

data/lib/hid/configuration.rb

@@ -0,0 +1,25 @@
+module HID
+  class Configuration
+    attr_accessor :identifier, :recorder
+
+    def initialize(persistence=:memory)
+      case persistence
+        when :memory
+          require 'hid/persistence/memory/identifier'
+          require 'hid/persistence/memory/recorder'
+          @identifier = HID::Persistence::Memory::Identifier
+          @recorder = HID::Persistence::Memory::Recorder
+          @identifier.store = Hash.new
+          @recorder.store = Hash.new
+        when :active_record
+          raise 'activerecord gem is required to use ActiveRecord persistence' unless defined?(::ActiveRecord)
+          require 'hid/persistence/active_record/identifier'
+          require 'hid/persistence/active_record/recorder'
+          @identifier = HID::Persistence::ActiveRecord::Identifier
+          @recorder = HID::Persistence::ActiveRecord::Recorder
+        else
+          raise "unknown internal persistence type #{persistence}"
+      end
+    end
+  end
+end

data/lib/hid/persistence/active_record/identifier.rb

@@ -0,0 +1,24 @@
+module HID
+  module Persistence
+    module ActiveRecord
+      class Identifier
+        class Identities < ::ActiveRecord::Base; end
+        @identities_class = Identities
+
+        class << self
+          attr_accessor :identities_class
+
+          def find(input, type)
+            identity = identities_class.where(input: input, id_type: type).first
+            identity && identity.identity
+          end
+
+          def map(input, identity, type)
+            identities_class.create input: input, identity: identity, id_type: type
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hid/persistence/active_record/recorder.rb

@@ -0,0 +1,41 @@
+module HID
+  module Persistence
+    module ActiveRecord
+      class Recorder
+        class Records < ::ActiveRecord::Base; end
+        @records_class = Records
+
+        class << self
+          attr_accessor :records_class
+
+          def record(input, type)
+            records_class.create input: input, id_type: type
+            nil
+          end
+
+          def recorded(type)
+            return typed_records(type) if type
+            untyped_records
+          end
+
+          private
+
+          def typed_records(type)
+            records_class.where(id_type: type).pluck(:input)
+          end
+
+          def untyped_records
+            record_groups = records_class.all.group_by(&:id_type)
+            hash = Hash.new
+
+            record_groups.each do |type, records|
+              hash[type] = records.map(&:input) if records
+            end
+
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hid/persistence/memory/identifier.rb

@@ -0,0 +1,21 @@
+module HID
+  module Persistence
+    module Memory
+      class Identifier
+        class << self
+          attr_accessor :store
+
+          def find(input, type)
+            (type_hash = store[type]) && type_hash[input]
+          end
+
+          def map(input, identity, type)
+            type_hash = store[type] ||= Hash.new
+            type_hash[input] = identity
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hid/persistence/memory/recorder.rb

@@ -0,0 +1,23 @@
+module HID
+  module Persistence
+    module Memory
+      class Recorder
+        class << self
+          attr_accessor :store
+
+          def record(input, type)
+            type_array = store[type] ||= []
+            return if type_array.include? input
+            type_array << input
+            nil
+          end
+
+          def recorded(type)
+            return store unless type
+            store[type] || []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hid/version.rb

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

data/spec/active_record_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'support/active_record'
+
+ACTIVE_RECORD_CONFIG =
+
+describe 'ActiveRecord HID' do
+  before(:each) do
+    HID.configuration = HID::Configuration.new :active_record
+    DatabaseCleaner.start
+  end
+
+  after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  include_examples 'identifier'
+  include_examples 'recorder'
+end

data/spec/examples/identifier.rb

@@ -0,0 +1,73 @@
+RSpec.shared_examples 'identifier' do
+  describe 'identified Inputs' do
+    context 'without Type argument' do
+      context 'nothing mapped' do
+        it 'returns nil' do
+          expect(
+              HID.identify 'input'
+          ).to be_nil
+        end
+      end
+
+      context 'other mapped' do
+        it 'returns nil' do
+          HID.map 'input2', 'identity'
+
+          expect(
+              HID.identify 'input'
+          ).to be_nil
+        end
+      end
+
+      context 'Input mapped with Type' do
+        it 'returns nil' do
+          HID.map 'input', 'identity', 'type'
+
+          expect(
+              HID.identify 'input'
+          ).to be_nil
+        end
+      end
+
+      context 'Input mapped without Type' do
+        it 'returns Identity' do
+          HID.map 'input', 'identity'
+
+          expect(
+              HID.identify 'input'
+          ).to eq 'identity'
+        end
+      end
+    end
+
+    context 'with Type argument' do
+      context 'nothing mapped' do
+        it 'returns nil' do
+          expect(
+              HID.identify 'input', 'type'
+          ).to be_nil
+        end
+      end
+
+      context 'other mapped Type' do
+        it 'returns nil' do
+          HID.map 'input', 'identity', 'type'
+
+          expect(
+              HID.identify 'input', 'type2'
+          ).to be_nil
+        end
+      end
+
+      context 'Input mapped' do
+        it 'returns Identity' do
+          HID.map 'input', 'identity', 'type'
+
+          expect(
+              HID.identify 'input', 'type'
+          ).to eq 'identity'
+        end
+      end
+    end
+  end
+end

data/spec/examples/recorder.rb

@@ -0,0 +1,85 @@
+RSpec.shared_examples 'recorder' do
+  describe 'not identified Inputs' do
+    context 'without Type argument' do
+      context 'nothing recorded' do
+        it 'returns an empty Hash' do
+          expect(
+              HID.recorded
+          ).to eq({})
+        end
+      end
+
+      context 'no Types' do
+        it 'returns a Hash with key nil and value Array with item Input' do
+          HID.identify 'input'
+
+          expect(
+              HID.recorded
+          ).to eq nil => ['input']
+        end
+      end
+
+      context 'with Types' do
+        it 'returns a Hash with key Type and value Array with item Input' do
+          HID.identify 'input', 'type'
+
+          expect(
+              HID.recorded
+          ).to eq 'type' => ['input']
+        end
+      end
+
+      context 'with and without Types' do
+        it 'returns full Hash' do
+          HID.identify 'input'
+          HID.identify 'input2', 'type'
+
+          expect(
+              HID.recorded
+          ).to eq nil => ['input'], 'type' => ['input2']
+        end
+      end
+    end
+
+    context 'with Type argument' do
+      context 'nothing recorded' do
+        it 'returns an empty Array' do
+          expect(
+              HID.recorded 'type'
+          ).to eq []
+        end
+      end
+
+      context 'no Types' do
+        it 'returns an empty Array' do
+          HID.identify 'input'
+
+          expect(
+              HID.recorded 'type'
+          ).to eq []
+        end
+      end
+
+      context 'with Types' do
+        it 'returns Array with Input' do
+          HID.identify 'input', 'type'
+
+          expect(
+              HID.recorded 'type'
+          ).to eq ['input']
+        end
+      end
+
+      context 'with multiple Types' do
+        it 'returns Array with Input' do
+          HID.identify 'input', 'type'
+          HID.identify 'input2', 'type2'
+
+          expect(
+              HID.recorded 'type'
+          ).to eq ['input']
+        end
+      end
+    end
+  end
+end

data/spec/memory_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'In-Memory HID' do
+  # create new in-memory stores before each test
+  before(:each) do
+    HID.configuration = HID::Configuration.new :memory
+  end
+
+  include_examples 'identifier'
+  include_examples 'recorder'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hid'
+require 'examples/identifier'
+require 'examples/recorder'

data/spec/support/active_record.rb

@@ -0,0 +1,16 @@
+require 'sqlite3'
+require 'active_record'
+require 'database_cleaner'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Migration.create_table :identities do |t|
+  t.string :input, null: false
+  t.string :identity, null: false
+  t.string :id_type
+end
+
+ActiveRecord::Migration.create_table :records do |t|
+  t.string :input, null: false
+  t.string :id_type
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: hid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Cavileer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: sqlite3
+  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: database_cleaner
+  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: Maps string to other strings?
+email:
+- bcavileer@holmanauto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hid.gemspec
+- lib/hid.rb
+- lib/hid/configuration.rb
+- lib/hid/persistence/active_record/identifier.rb
+- lib/hid/persistence/active_record/recorder.rb
+- lib/hid/persistence/memory/identifier.rb
+- lib/hid/persistence/memory/recorder.rb
+- lib/hid/version.rb
+- spec/active_record_spec.rb
+- spec/examples/identifier.rb
+- spec/examples/recorder.rb
+- spec/memory_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Identity Mapping
+test_files:
+- spec/active_record_spec.rb
+- spec/examples/identifier.rb
+- spec/examples/recorder.rb
+- spec/memory_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb