ar_lookups 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd850a54a805b4137aa6719a8fbc85aba98c8421
+  data.tar.gz: 590ef6a50e3fea20afa2eaf0ef767f90fd89b17c
+SHA512:
+  metadata.gz: 079f96de9b4f4858bf7342391d549e87748ffe6252b7342c5b18bfa076a820ea0f2d6d4055389880c2fa3eccd0ca49931381b50d6e16493a890cc1dce23dc173
+  data.tar.gz: 161e657dabaf63874c03ea106cf3a251e3676d5b19cfe548263e8cc41f6f22208469dbab3d23b4a1e166179230c0489a66d190d9446e80d65ebe80518840fac6

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar_lookups.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec -d .' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stan Bondi
+
+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,29 @@
+# ArLookups
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar_lookups'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar_lookups
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ar_lookups/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ar_lookups.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ar_lookups/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_lookups"
+  spec.version       = ArLookups::VERSION
+  spec.authors       = ["Stan Bondi"]
+  spec.email         = ["stan@fixate.it"]
+  spec.summary       = %q{Lookup tables using activerecord and array fields}  
+  spec.homepage      = "https://github.com/fixate/ar_ar_lookups"
+  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_dependency 'rails', '~> 4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+end

data/lib/ar_lookups.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+
+require 'ar_lookups/version'
+require 'ar_lookups/lookup_table_definition'
+require 'ar_lookups/base_ext'
+require 'ar_lookups/railtie' if defined?(Rails)

data/lib/ar_lookups/base_ext.rb

@@ -0,0 +1,47 @@
+module ArLookups
+  module BaseExt
+    def ar_lookups
+      @ar_lookups ||= superclass.respond_to?(:ar_lookups) ? superclass.ar_lookups.dup : {}
+    end
+
+    def lookup(column, *args)
+      options = args.extract_options!
+      lookup_model = args.first
+
+      options.reverse_merge!(key_column: :key, name_column: :name)
+
+      # Directly override accessors and super to the module below
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{column}; super; end
+        def #{column}=(value); super; end
+      RUBY
+
+      ar_lookups[column] = lookup_model || implicit_lookup_class(column)
+
+      # Mixin this Module so that we can use super in these functions
+      mod = Module.new
+      include mod
+      mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{column}
+          keys = read_attribute(:#{column})
+          return {} if keys.blank?
+          Hash[self.class.ar_lookups[:#{column}].where('#{options[:key_column]} IN (?)', keys).pluck(:#{options[:key_column]}, :#{options[:name_column]})]
+        end
+
+        def #{column}_ids
+          read_attribute(:#{column})
+        end
+
+        def #{column}=(val)
+          write_attribute(:#{column}, val)
+        end
+      RUBY
+    end
+
+    private
+
+    def implicit_lookup_class(column)
+      column.to_s.camelize.singularize.constantize
+    end
+  end
+end

data/lib/ar_lookups/lookup_table_definition.rb

@@ -0,0 +1,7 @@
+module ArLookups
+  module LookupTableDefinition
+    def lookup(column, options = {})
+      send(:integer, column, options.merge(array: true, default: []))
+    end
+  end
+end

data/lib/ar_lookups/railtie.rb

@@ -0,0 +1,19 @@
+require "rails"
+
+module ArLookups
+  class Railtie < Rails::Railtie # :nodoc:
+    config.eager_load_namespaces << ArLookups
+
+    initializer "ar_lookups.initialize" do |app|
+      ActiveSupport.on_load(:active_record) do
+        # Extend migration table definition
+        ActiveRecord::ConnectionAdapters::TableDefinition.send :include,
+          ArLookups::LookupTableDefinition
+
+        # Extend AR base
+        ActiveRecord::Base.send :extend,
+          ArLookups::BaseExt
+      end
+    end
+  end
+end

data/lib/ar_lookups/version.rb

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

data/spec/base_ext_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+class FooBar; end
+
+describe ArLookups::BaseExt do
+  let(:lookup_relation) { mock_model('Dummy', pluck: []) }
+  let(:lookup) do
+    mock_model('Lookup', where: lookup_relation)
+  end
+
+  let(:client_class) do
+    @class = Class.new
+    @class.class_eval do
+      def write_attribute(column, val)
+        unless respond_to?(column)
+          class_eval <<-RUBY, __FILE__, __LINE__+1
+            attr_accessor :#{column}
+          RUBY
+        end
+
+        instance_variable_set("@#{column}".to_sym, val)
+      end
+
+      def read_attribute(column)
+        instance_variable_get("@#{column}".to_sym)
+      end
+    end
+
+    @class.send(:extend, ArLookups::BaseExt)
+    @class.lookup :foo, lookup
+    @class
+  end
+
+  subject { client_class.new }
+
+  it 'fetches values with keys' do
+    expect(lookup).to receive(:where).with('key IN (?)', [1])
+    expect(lookup_relation).to receive(:pluck).with(:key, :name)
+
+    subject.foo = [1]
+    subject.foo
+  end
+
+  it 'fetches values with different key name' do
+    client_class.lookup :bar, lookup, key_column: :id, name_column: :place
+    expect(lookup).to receive(:where).with('id IN (?)', [1])
+    expect(lookup_relation).to receive(:pluck).with(:id, :place)
+
+    subject.bar = [1]
+    subject.bar
+  end
+
+  it 'returns ids from lookup' do
+    subject.foo = [1,2]
+    expect(subject.foo_ids).to eq([1,2])
+  end
+
+  it 'returns an empty hash if ar_lookups empty' do
+    expect(subject.foo).to eq({})
+  end
+
+  it 'returns a hash' do
+    subject.foo = [1,2]
+    expect(subject.foo).to be_kind_of(Hash)
+  end
+
+  it 'implicitly gets the model name from the column' do
+    client_class.class_eval do
+      lookup :foo_bars
+    end
+
+    expect(client_class.ar_lookups[:foo_bars]).to be(FooBar)
+  end
+end

data/spec/lookup_table_definition_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ArLookups::LookupTableDefinition do
+  subject do
+    class TableDefinition; include ArLookups::LookupTableDefinition; end.new
+  end
+
+  it 'creates an integer array column with default' do
+    expect(subject).to receive(:integer).with(:foo, {array: true, default: []})
+    subject.lookup :foo
+  end
+
+  it 'merges additional options in preserving array:true' do
+    expect(subject).to receive(:integer).with(:foo, {test: 'foobar', array: true, default: []})
+    subject.lookup :foo, test: 'foobar'
+  end
+
+  it 'uses default if given' do
+    expect(subject).to receive(:integer).with(:foo, {default: [1, 2], array: true, default: []})
+    subject.lookup :foo, default: [1, 2]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rails/all'
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/rails/mocks'
+require 'rspec/autorun'
+
+require 'ar_lookups'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ar_lookups
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stan Bondi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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-rails
+  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:
+- stan@fixate.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_lookups.gemspec
+- lib/ar_lookups.rb
+- lib/ar_lookups/base_ext.rb
+- lib/ar_lookups/lookup_table_definition.rb
+- lib/ar_lookups/railtie.rb
+- lib/ar_lookups/version.rb
+- spec/base_ext_spec.rb
+- spec/lookup_table_definition_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fixate/ar_ar_lookups
+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.0
+signing_key: 
+specification_version: 4
+summary: Lookup tables using activerecord and array fields
+test_files:
+- spec/base_ext_spec.rb
+- spec/lookup_table_definition_spec.rb
+- spec/spec_helper.rb