lookup_by 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c32a15a02ac5c67549366075fac6d76db2122564
-  data.tar.gz: 07aa69751c19f10a96b573eb08d562e7290aee47
+  metadata.gz: 89c6960058f0ae2cbe8cb5654c37b331b0b25bd1
+  data.tar.gz: d13f7ed9c8e34d40b51e8c68983d19d9b5645cbc
 SHA512:
-  metadata.gz: 14f87c363d0c346dafb9f37a1b015a721786c0ba4223ddfa1bb656adfe0dbf1d9764ea3724ac3330b336719382c5f014ae393b97f0c6eeeff3a936844d825af5
-  data.tar.gz: c1cca0a1500aedf3a1f10ffaceca6dbe5d1fd870b86c9a0b23858f5c075aeaf6901c84f0fd73559a31c60a5cc64149c2f1925af69ab57935fa56d623f8550662
+  metadata.gz: f09941d8870cde958762337e6f75d42bf88c44d37d06fe63f7fc91f60e4c79fc8b4c4cb183de0403dc02f0a43587e06f75f65ff43d0b3eea8297f9ef023839b1
+  data.tar.gz: 4e7c909cd63d81350726fc80066e211d92cdf8c5c447a78ae8830f6dcd5cbc7f2706c758d52a430ecf3cc0475e51ed674dba2ae030701dd12eedf83730698da2

data/.travis.yml

@@ -7,4 +7,4 @@ rvm:
 services:
   - postgresql
 before_script:
-  - sh -c "cd spec/dummy && RAILS_ENV=test bundle exec rake db:migrate:reset"
+  - sh -c "cd spec/dummy && RAILS_ENV=test bundle exec rake db:migrate:reset db:seed"

data/Gemfile

@@ -10,6 +10,7 @@ group :development, :test do
   gem "rake"
   gem "simplecov", require: false
   gem "rspec-rails", "~> 2.11.0"
+  gem 'database_cleaner'
 
   gem "pg", platform: :ruby
   gem "activerecord-jdbcpostgresql-adapter", platform: :jruby

data/Rakefile

@@ -11,4 +11,3 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-

data/lib/lookup_by.rb

@@ -4,6 +4,9 @@ require "lookup_by/railtie" if defined? Rails
 module LookupBy
   class Error < StandardError; end
 
+  UUID_REGEX    = /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\Z/
+  UUID_REGEX_V4 = /\A\h{8}-\h{4}-4\h{3}-[89aAbB]\h{3}-\h{12}\Z/
+
   autoload :Association, "lookup_by/association"
   autoload :Cache,       "lookup_by/cache"
   autoload :Lookup,      "lookup_by/lookup"

data/lib/lookup_by/association.rb

@@ -14,7 +14,12 @@ module LookupBy
   module Association
     module MacroMethods
       def lookup_for field, options = {}
-        return unless table_exists?
+        begin
+          return unless table_exists?
+        rescue => error
+          Rails.logger.error "lookup_by caught #{error.class.name} when connecting - skipping initialization (#{error.inspect})"
+          return
+        end
 
         options.symbolize_keys!
         options.assert_valid_keys(:class_name, :foreign_key, :symbolize, :strict, :scope)
@@ -84,9 +89,9 @@ module LookupBy
 
           def #{field}=(arg)
             value = case arg
-            when "", nil
+            when nil
               nil
-            when String, Integer
+            when String, Integer, IPAddr
               #{class_name}[arg].try(:id)
             when Symbol
               #{%Q(raise ArgumentError, "#{foreign_key}=(Symbol): use `lookup_for :column, symbolize: true` to allow symbols") unless options[:symbolize]}
@@ -95,7 +100,7 @@ module LookupBy
               raise ArgumentError, "self.#{foreign_key}=(#{class_name}): must be saved" unless arg.id
               arg.id
             else
-              raise TypeError, "#{foreign_key}=(arg): arg must be a String, Symbol, Integer, nil, or #{class_name}"
+              raise TypeError, "#{foreign_key}=(arg): arg must be a String, Symbol, Integer, IPAddr, nil, or #{class_name}"
             end
 
             #{%Q(raise LookupBy::Error, "\#{arg.inspect} is not in the <#{class_name}> lookup cache" if arg.present? && value.nil?) if strict}

data/lib/lookup_by/cache.rb

@@ -4,18 +4,20 @@ module LookupBy
     attr_accessor :testing
 
     def initialize(klass, options = {})
-      @klass       = klass
-      @primary_key = klass.primary_key
-      @field       = options[:field].to_sym
-      @cache       = {}
-      @order       = options[:order] || @field
-      @read        = options[:find]
-      @write       = options[:find_or_create]
-      @normalize   = options[:normalize]
-      @testing     = false
-      @enabled     = true
-
-      @stats       = { db: Hash.new(0), cache: Hash.new(0) }
+      @klass            = klass
+      @primary_key      = klass.primary_key
+      @primary_key_type = klass.columns_hash[@primary_key].type
+      @field            = options[:field].to_sym
+      @cache            = {}
+      @order            = options[:order] || @field
+      @read             = options[:find_or_create] || options[:find]
+      @write            = options[:find_or_create]
+      @allow_blank      = options[:allow_blank] || false
+      @normalize        = options[:normalize]
+      @testing          = false
+      @enabled          = true
+
+      @stats            = { db: Hash.new(0), cache: Hash.new(0) }
 
       raise ArgumentError, %Q(unknown attribute "#{@field}" for <#{klass}>) unless klass.column_names.include?(@field.to_s)
 
@@ -62,7 +64,7 @@ module LookupBy
     def fetch(value)
       increment :cache, :get
 
-      value = normalize(value)  if @normalize && !value.is_a?(Integer)
+      value = normalize(value)  if @normalize && !primary_key?(value)
 
       found = cache_read(value) if cache?
       found ||= db_read(value)  if @read
@@ -83,6 +85,10 @@ module LookupBy
       @read
     end
 
+    def allow_blank?
+      @allow_blank
+    end
+
     def enabled?
       @enabled
     end
@@ -103,12 +109,21 @@ module LookupBy
 
   private
 
+    def primary_key?(value)
+      case @primary_key_type
+      when :integer
+        value.is_a? Integer
+      when :uuid
+        value =~ UUID_REGEX
+      end
+    end
+
     def normalize(value)
       @klass.new(@field => value).send(@field)
     end
 
     def cache_read(value)
-      if value.is_a? Integer
+      if primary_key?(value)
         found = @cache[value]
       else
         found = @cache.values.detect { |o| o.send(@field) == value }
@@ -138,7 +153,7 @@ module LookupBy
     end
 
     def column_for(value)
-      value.is_a?(Integer) ? @primary_key : @field
+      primary_key?(value) ? @primary_key : @field
     end
 
     def cache?

data/lib/lookup_by/lookup.rb

@@ -18,8 +18,15 @@ module LookupBy
       end
 
       def lookup_by(field, options = {})
+        begin
+          connection
+        rescue => error
+          Rails.logger.error "lookup_by caught #{error.class.name} when connecting - skipping initialization (#{error.inspect})"
+          return
+        end
+
         options.symbolize_keys!
-        options.assert_valid_keys :order, :cache, :normalize, :find, :find_or_create, :raise
+        options.assert_valid_keys :allow_blank, :order, :cache, :normalize, :find, :find_or_create, :raise
 
         raise "#{self} already called lookup_by" if is_a? Lookup::ClassMethods
         raise "#{self} responds_to :[], needed for lookup_by"     if respond_to? :[]
@@ -51,7 +58,9 @@ module LookupBy
     end
 
     module ClassMethods
+      # TODO: Rails 4 needs to return a proxy object here
       def all(*args)
+        return super if Rails::VERSION::MAJOR > 3
         return super if @lookup.read_through?
         return super if args.any?
 
@@ -76,10 +85,12 @@ module LookupBy
         when 0 then raise ArgumentError, "#{name}[*args]: at least one argument is required"
         when 1
           case arg = args.first
-          when nil, "" then nil
+          when nil     then nil
+          when ""      then @lookup.allow_blank? ? @lookup.fetch(arg) : nil
           when String  then @lookup.fetch(arg)
-          when Symbol  then @lookup.fetch(arg.to_s)
           when Integer then @lookup.fetch(arg)
+          when Symbol  then @lookup.fetch(arg.to_s)
+          when IPAddr  then @lookup.fetch(arg.to_s)
           when self    then arg
           else raise TypeError, "#{name}[arg]: arg must be at least one String, Symbol, Integer, nil, or #{name}"
           end
@@ -91,7 +102,7 @@ module LookupBy
     module InstanceMethods
       def ===(arg)
         case arg
-        when Symbol, String, Integer, nil
+        when Symbol, String, Integer, IPAddr, nil
           return self == self.class[arg]
         when Array
           return arg.any? { |i| self === i }
@@ -102,22 +113,40 @@ module LookupBy
     end
 
     module SchemaMethods
-      def create_lookup_table(table_name, options = {})
-        lookup_column = options[:lookup_column] || table_name.to_s.singularize
-        primary_key   = options[:primary_key]   || table_name.to_s.singularize + "_id"
+      def create_lookup_table(name, options = {})
+        options.symbolize_keys!
+
+        schema = options[:schema].to_s
 
-        create_table table_name, primary_key: primary_key do |t|
-          t.text lookup_column, null: false
+        if schema.present?
+          table = name.to_s
+        else
+          schema, table = name.to_s.split('.')
+          schema, table = nil, schema unless table
+        end
+
+        name = schema.blank? ? table : "#{schema}.#{table}"
+
+        lookup_column = options[:lookup_column] || table.singularize
+        lookup_type   = options[:lookup_type]   || :text
+
+        table_options = options.slice(:primary_key, :id)
+        table_options[:primary_key] ||= table.singularize + '_id'
+
+        create_table name, table_options do |t|
+          t.send lookup_type, lookup_column, null: false
 
           yield t if block_given?
         end
 
-        add_index table_name, lookup_column, unique: true
+        add_index name, lookup_column, unique: true, name: "#{table}__u_#{lookup_column}"
       end
 
-      def create_lookup_tables(*table_names)
-        table_names.each do |table_name|
-          create_lookup_table table_name
+      def create_lookup_tables(*names)
+        options = names.last.is_a?(Hash) ? names.pop : {}
+
+        names.each do |name|
+          create_lookup_table name, options
         end
       end
     end

data/lib/lookup_by/version.rb

@@ -1,3 +1,3 @@
 module LookupBy
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/spec/dummy/Rakefile

@@ -12,3 +12,11 @@ RSpec::Core::RakeTask.new(:spec) do |config|
 end
 
 task :default => :spec
+
+namespace :db do
+  namespace :test do
+    task :load_structure => :environment do
+      Rake::Task["db:seed"].invoke
+    end
+  end
+end

data/spec/dummy/app/models/account.rb

@@ -1,5 +1,3 @@
 class Account < ActiveRecord::Base
-  attr_accessible :account
-
   lookup_by :account, cache: true, find: true
 end

data/spec/dummy/app/models/city.rb

@@ -1,5 +1,3 @@
 class City < ActiveRecord::Base
-  attr_accessible :city
-
   lookup_by :city
 end

data/spec/dummy/app/models/email_address.rb

@@ -1,5 +1,3 @@
 class EmailAddress < ActiveRecord::Base
-  attr_accessible :email_address
-
   lookup_by :email_address, find_or_create: true
 end

data/spec/dummy/app/models/ip_address.rb

@@ -1,5 +1,3 @@
 class IpAddress < ActiveRecord::Base
-  attr_accessible :ip_address
-
   lookup_by :ip_address, cache: 2, find_or_create: true
 end

data/spec/dummy/app/models/path.rb

@@ -0,0 +1,5 @@
+class Path < ActiveRecord::Base
+  self.table_name = 'traffic.paths'
+
+  lookup_by :path, cache: 40, find_or_create: true
+end

data/spec/dummy/app/models/postal_code.rb

@@ -1,5 +1,3 @@
 class PostalCode < ActiveRecord::Base
-  attr_accessible :postal_code
-
   lookup_by :postal_code, cache: 2
 end

data/spec/dummy/app/models/state.rb

@@ -1,5 +1,3 @@
 class State < ActiveRecord::Base
-  attr_accessible :state
-
   lookup_by :state, cache: true
 end

data/spec/dummy/app/models/status.rb

@@ -1,6 +1,4 @@
 class Status < ActiveRecord::Base
-  attr_accessible :status
-
   lookup_by :status, normalize: true
 
   def status=(arg)

data/spec/dummy/app/models/street.rb

@@ -1,5 +1,3 @@
 class Street < ActiveRecord::Base
-  attr_accessible :street
-
   lookup_by :street, find_or_create: true
 end

data/spec/dummy/app/models/user_agent.rb

@@ -0,0 +1,3 @@
+class UserAgent < ActiveRecord::Base
+  lookup_by :user_agent, cache: 2, find_or_create: true
+end

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -1,20 +1,28 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_record/railtie"
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
 
-Bundler.require
 require "lookup_by"
 
 module Dummy
   class Application < Rails::Application
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    config.active_record.schema_format = :sql
   end
 end
 

data/spec/dummy/config/boot.rb

@@ -1,10 +1,6 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -1,5 +1,5 @@
-# Load the rails application
+# Load the Rails application.
 require File.expand_path('../application', __FILE__)
 
-# Initialize the rails application
+# Initialize the Rails application.
 Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -1,15 +1,29 @@
 Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
 
-  # Print deprecation notices to the Rails logger
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
 end