lookup_table 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+-rspec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    lookup_table (0.0.1)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    sqlite3 (1.3.8)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  lookup_table!
+  rake
+  rspec
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Artem Baguinski
+
+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,36 @@
+# lookup_table
+
+Database fed lookup table.
+
+This gem allows to quickly set up a look up table with content stored in the
+database. The library supports two modes of operation: preload the whole table
+into a lookup hash or lookup (and cache) values on demand.
+
+The gem is useful for implementing data processing algorithms where some
+functions are given as table based mappings, such as implementing statistical
+models. The main purpose of the gem is making the code using such database
+backed lookup more readable.
+
+# Usage
+
+Assuming a table "deprivation" contains a mapping from zip codes to deprivation,
+a lookup table can be constructed with:
+
+Gemfile:
+
+```
+gem "lookup_table"
+```
+
+hello.rb:
+
+```
+require "lookup_table"
+
+ZipcodeToDeprivation = LookupTable.create "deprivation", :zip_code, :deprivation
+
+deprivation = ZipcodeToDeprivation[ "7777AA" ]
+
+```
+
+More features are described in the [spec](spec/lib/lookup_table_spec.rb).

data/lib/lookup_table.rb

@@ -0,0 +1,106 @@
+require "active_record"
+
+module LookupTable
+
+  attr_reader :key_columns, :value_column
+
+  def self.create *args, &block
+    Class.new(ActiveRecord::Base) do
+      extend LookupTable
+      act_as_lookup_table *args
+      class_eval &block if block_given?
+    end
+  end
+
+  class << self
+    attr_accessor :prefetch
+    alias_method :prefetch?, :prefetch
+    attr_accessor :prefetch_limit
+  end
+  LookupTable.prefetch = true
+
+  attr_writer :prefetch
+
+  def prefetch?
+    (!LookupTable.prefetch_limit or
+     (lookup_domain.count <= LookupTable.prefetch_limit)) and
+     LookupTable.prefetch? and
+     @prefetch
+  end
+
+  def act_as_lookup_table table, key, value, options = {}
+    self.table_name = table
+    @key_columns = [key].flatten
+    @value_column = value
+
+    self.default = options[:default]
+    self.prefetch = options.fetch(:prefetch, true)
+  end
+
+  def [] *keys
+    lookup_table[ keys.flatten ]
+  end
+
+  def lookup_table
+    @lookup_table ||= prefetch_if_requested( create_lookup_table )
+  end
+
+  def db_lookup keys
+    record = lookup_domain.where( quoted_where keys ).first
+    record_value record
+  end
+
+  def quoted_where key_values
+    Hash[ key_columns.zip(key_values) ]
+  end
+
+  def quoted_key_columns
+    key_columns.map{|col| connection.quote_column_name col}
+  end
+
+  def default keys
+    @default.call *keys
+  end
+
+  def default= default
+    @default = (Proc === default) ? default : proc { default }
+  end
+
+  def lookup_columns
+    key_columns + [value_column]
+  end
+
+  def quoted_lookup_columns
+    lookup_columns.map{|col| connection.quote_column_name col}
+  end
+
+  def lookup_domain
+    select quoted_lookup_columns
+  end
+
+  def record_key record
+    key_columns.map{|column| record[column]}
+  end
+
+  def record_value record
+    record.try :[], value_column
+  end
+
+  def prefetch_if_requested hash
+    if prefetch?
+      lookup_domain.inject(hash) do |hash,record|
+        hash[ record_key(record) ] = record_value(record)
+        hash
+      end
+    end
+    hash
+  end
+
+  def create_lookup_table
+    Hash.new do |lookup_table, keys|
+      lookup_table[keys] = db_lookup(keys) || default(keys)
+    end
+  end
+
+end
+

data/lib/lookup_table/version.rb

@@ -0,0 +1,4 @@
+module LookupTable
+  VERSION = '0.0.1'
+end
+

data/lookup_table.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require  'lookup_table/version'
+
+Gem::Specification.new do |s|
+  s.name = 'lookup_table'
+  s.version = LookupTable::VERSION
+  s.summary = 'database fed lookup table'
+  s.description = 'use database table as a hash table'
+  s.author = 'Artem Baguinski'
+  s.email = 'femistofel@gmail.com'
+  s.homepage = 'https://github.com/artm/lookup_table'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'activerecord'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+end
+

data/spec/lib/lookup_table_spec.rb

@@ -0,0 +1,76 @@
+describe LookupTable do
+  shared_context "with mapping table" do
+    around(:each) do |example|
+      create_mapping_table(subject, table_content)
+      example.run
+      drop_mapping_table(subject)
+    end
+  end
+  shared_context "simple content" do
+    let(:table_content) { [[1,'foo'],[2,'bar'],[42,'answer']] }
+    let(:unknown_key) { 666 }
+  end
+  shared_context "nil default" do
+    let(:default_value) { nil }
+  end
+  shared_examples "lookup table" do
+    it "looks up values for known keys" do
+      table_content.each do |record|
+        key = record[0...record.count-1]
+        value = record.last
+        expect( subject[key] ).to eq value
+      end
+    end
+    it "returns default value for unknown keys" do
+      expect( subject[ unknown_key ] ).to eq default_value
+    end
+  end
+
+  describe "simple lookup table" do
+    subject { LookupTable.create 'mapping', :key, :value }
+    include_context "with mapping table"
+    include_context "simple content"
+    include_context "nil default"
+    it_behaves_like "lookup table"
+  end
+  describe "mixed case columns" do
+    subject { LookupTable.create 'mapping', :KeyColumn, :ValueColumn }
+    include_context "with mapping table"
+    include_context "simple content"
+    include_context "nil default"
+    it_behaves_like "lookup table"
+  end
+  describe "with default value" do
+    subject { LookupTable.create 'mapping', :key, :value, default: 'default' }
+    include_context "with mapping table"
+    include_context "simple content"
+    let(:default_value) { 'default' }
+    it_behaves_like "lookup table"
+  end
+  describe "with computed default" do
+    subject { LookupTable.create 'mapping', :key, :value, default: proc{|k| k/6} }
+    include_context "with mapping table"
+    include_context "simple content"
+    let(:default_value) { 111 }
+    it_behaves_like "lookup table"
+  end
+  describe "with compound key" do
+    subject { LookupTable.create 'mapping', [:key1, :key2] , :value }
+    include_context "with mapping table"
+    include_context "nil default"
+    let(:table_content) { [[1,2,'foo'],[2,2,'bar'],[42,2,'answer']] }
+    let(:unknown_key) { [666,777] }
+    it_behaves_like "lookup table"
+  end
+  describe "simple lookup table without prefetching" do
+    subject { LookupTable.create 'mapping', :key, :value, prefetch: false }
+    include_context "with mapping table"
+    include_context "simple content"
+    include_context "nil default"
+    it "doesn't prefetch" do
+      expect( subject ).not_to receive( :prefetch )
+      subject[1]
+    end
+    it_behaves_like "lookup table"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require "active_record"
+require "lookup_table"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+def connection
+  ActiveRecord::Base.connection
+end
+
+def create_mapping_table model, table_content
+  value =  model.value_column
+  table_name = model.table_name
+  connection.create_table(table_name) do |t|
+    model.key_columns.each do |key|
+      t.integer key
+    end
+    t.string value
+  end
+  quoted_columns = model.quoted_lookup_columns
+  rows_sql = table_content.map{|row| "(#{row.map{|v| connection.quote(v)} * ','})"} * ','
+  insert_sql = "INSERT INTO #{table_name} (#{quoted_columns * ','}) VALUES #{rows_sql};"
+  connection.execute(insert_sql)
+end
+
+def drop_mapping_table model
+  connection.drop_table model.table_name
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: lookup_table
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Artem Baguinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: use database table as a hash table
+email: femistofel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/lookup_table.rb
+- lib/lookup_table/version.rb
+- lookup_table.gemspec
+- spec/lib/lookup_table_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/artm/lookup_table
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: database fed lookup table
+test_files:
+- spec/lib/lookup_table_spec.rb
+- spec/spec_helper.rb