looksy 0.0.1

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 documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Artin Boghosian
+
+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,35 @@
+# Looksy
+
+Looksy adds a caching layer for your ActiveRecord models
+that represent look up tables in your database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'looksy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install looksy
+
+## Usage
+
+Include Looksy::Cacheable in your ActiveRecord class.
+Provides fetch_all and fetch_by_id(id) methods as well
+as intercepts method_missing so you can use dynamic methods
+such as fetch_by_name('name') or fetch_all_by_status('active').
+You can also fetch by multiple columns such as:
+fetch_by_type_and_status('type', 'status').
+
+## Contributing
+
+1. Fork it
+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/lib/looksy.rb

@@ -0,0 +1,8 @@
+require "looksy/version"
+require "looksy/dynamic_find_match"
+require "looksy/lookup"
+require "looksy/null_cache"
+require "looksy/cacheable"
+
+module Looksy
+end

data/lib/looksy/cacheable.rb

@@ -0,0 +1,57 @@
+module Looksy
+  module Cacheable
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def cache_key
+        @@cache_key ||= [self.name.downcase, 'all'].join('/')
+      end
+
+      def cache_key=(key)
+        @@cache_key = key
+      end
+
+      def cache_options
+        @@cache_options ||= {}
+      end
+
+      def cache_options=(options = {})
+        @@cache_options = options
+      end
+
+      def fetch_all
+        lookup.all
+      end
+
+      def fetch_by_id(id)
+        lookup.find_by_id(id)
+      end
+
+      def method_missing(method, *args, &block)
+        if method.match(/^fetch/)
+          method = method.to_s.gsub(/^fetch/, 'find')
+          lookup.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      private
+
+      def lookup
+        @lookup ||= begin
+          cache = if defined?(Rails)
+            Rails.cache
+          else
+            Looksy::NullCache.new
+          end
+
+          Looksy::Lookup.new(self, cache)
+        end
+      end
+    end
+  end
+end

data/lib/looksy/dynamic_find_match.rb

@@ -0,0 +1,17 @@
+module Looksy
+  class DynamicFindMatch < Struct.new(:finder, :attributes)
+    def self.match(method)
+      finder = :find
+
+      case method.to_s
+      when /^find_(all_)?by_([_a-zA-Z]\w*)$/
+        finder = :select if $1 == 'all_'
+        attributes = $2
+      else
+        return nil
+      end
+
+      new(finder, attributes.split('_and_'))
+    end
+  end
+end

data/lib/looksy/lookup.rb

@@ -0,0 +1,59 @@
+module Looksy
+  class Lookup
+    def initialize(klass, cache)
+      @klass = klass
+      @cache = cache
+    end
+
+    def all
+      @cache.fetch(@klass.cache_key, @klass.cache_options) { @klass.all }
+    end
+
+    def find_by_id(id)
+      all.find { |record| record.id == id.to_i }
+    end
+
+    def method_missing(method, *args, &block)
+      if match = Looksy::DynamicFindMatch.match(method)
+        super unless all_attributes_exist?(match.attributes)
+
+        attributes = extract_attributes(match.attributes) do |attribute|
+          args[match.attributes.index(attribute)]
+        end
+
+        all.send(match.finder) do |record|
+          record_attributes = extract_attributes(match.attributes) do |attribute|
+            record.send(attribute)
+          end
+
+          record_attributes == attributes
+        end
+      else
+        super
+      end
+    end
+
+    private
+
+    def all_attributes_exist?(attributes)
+      (attributes - klass_attributes).empty?
+    end
+
+    def klass_attributes
+      @klass_attributes ||= @klass.new.attributes.keys
+    end
+
+    def extract_attributes(attributes, &block)
+      Hash[attributes.map { |a| [a, sanitize_attribute_value(block.call(a))] }]
+    end
+
+    def sanitize_attribute_value(value)
+      case value
+      when Symbol, String
+        value.to_s.downcase
+      else
+        value
+      end
+    end
+  end
+end

data/lib/looksy/null_cache.rb

@@ -0,0 +1,7 @@
+module Looksy
+  class NullCache
+    def fetch(key, options = {}, &block)
+      block.call
+    end
+  end
+end

data/lib/looksy/version.rb

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

data/looksy.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'looksy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "looksy"
+  gem.version       = Looksy::VERSION
+  gem.authors       = ["Artin Boghosian"]
+  gem.email         = ["artinboghosian@gmail.com"]
+  gem.description   = %q{Add a caching layer to your ActiveRecord models that represent look up tables}
+  gem.summary       = %q{Caching layer for look up tables}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/spec/lib/cacheable_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require "support/record"
+
+describe Looksy::Cacheable do
+  let(:klass) { Record }
+
+  describe '.cache_key' do
+    context 'when not set' do
+      it 'returns the default cache key' do
+        klass.cache_key.should eql('record/all')
+      end
+    end
+
+    context 'when set' do
+      it 'returns the correct cache key' do
+        klass.cache_key = 'MyKey'
+        klass.cache_key.should eql('MyKey')
+      end
+    end
+  end
+
+  describe '.cache_options' do
+    context 'when not set' do
+      it 'returns the default cache options' do
+        klass.cache_options.should eql({})
+      end
+    end
+
+    context 'when set' do
+      it 'returns the correct cache options' do
+        klass.cache_options = { expires_in: 30 }
+        klass.cache_options.should have_key(:expires_in)
+      end
+    end
+  end
+
+  describe '.fetch_all' do
+    it 'returns all of the records' do
+      klass.fetch_all.should eql(klass.all)
+    end
+  end
+
+  describe '.fetch_by_id' do
+    let(:record) { klass.last }
+
+    it 'returns the correct record' do
+      klass.fetch_by_id(record.id).should eql(record)
+    end
+  end
+
+  describe '.method_missing' do
+    context 'when method starts with fetch' do
+      it 'returns matching records' do
+        records = klass.fetch_by_type('Developer')
+        records.count.should eql(3)
+      end
+    end
+
+    context 'when method does not start with fetch' do
+      before { klass.should_receive(:method_missing) }
+
+      it 'calls method missing on the host' do
+        klass.non_existent_method
+      end
+    end
+  end
+end

data/spec/lib/dynamic_find_match_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe Looksy::DynamicFindMatch do
+  describe '.match' do
+    context 'when method matches' do
+      context 'when method has one attribute' do
+        let(:method) { :find_by_this }
+        let(:match) { Looksy::DynamicFindMatch.match(method) }
+
+        it 'returns the correct attributes' do
+          match.attributes.should eql(['this'])
+        end
+      end
+
+      context 'when method has multiple attributes' do
+        let(:method) { :find_by_this_and_that }
+        let(:match) { Looksy::DynamicFindMatch.match(method) }
+
+        it 'returns the correct attributes' do
+          match.attributes.should eql(['this', 'that'])
+        end
+      end
+
+      context 'when method finds one record' do
+        let(:method) { :find_by_this }
+        let(:match) { Looksy::DynamicFindMatch.match(method) }
+
+        it 'returns the correct finder' do
+          match.finder.should eql(:find)
+        end
+      end
+
+      context 'when method finds multiple records' do
+        let(:method) { :find_all_by_this }
+        let(:match) { Looksy::DynamicFindMatch.match(method) }
+
+        it 'returns the correct finder' do
+          match.finder.should eql(:select)
+        end
+      end
+    end
+
+    context 'when method does not match' do
+      let(:method) { :find_does_not_match }
+      let(:match) { Looksy::DynamicFindMatch.match(method) }
+
+      it 'returns nil' do
+        match.should be_nil
+      end
+    end
+  end
+end

data/spec/lib/lookup_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+require "support/record"
+
+describe Looksy::Lookup do
+  let(:klass) { Record }
+  let(:cache) { Looksy::NullCache.new }
+  let(:lookup) { Looksy::Lookup.new(klass, cache) }
+  
+  describe '#all' do
+    it 'retrieves all records' do
+      lookup.all.should eql(klass.all)
+    end
+  end
+
+  describe '#find_by_id' do
+    let(:record) { lookup.find_by_id(2) }
+
+    it 'retrieves record matching id' do
+      record.id.should eql(2)
+    end
+  end
+
+  describe '#method_missing' do
+    context 'when finding multiple records' do
+      context 'when finding by single attribute' do
+        let(:records) { lookup.find_all_by_type('Developer') }
+
+        it 'returns the matching records' do
+          records.each { |record| record.type.should eql('Developer') }
+        end
+      end
+
+      context 'when finding by multiple attributes' do
+        let(:records) { lookup.find_all_by_name_and_type('Artin', 'Developer') }
+
+        it 'returns the matching records' do
+          records.each do |record|
+            record.type.should eql('Developer')
+            record.name.should eql('Artin')
+          end
+        end
+      end
+    end
+
+    context 'when finding single record' do
+      context 'when finding by single attribute' do
+        let(:record) { lookup.find_by_name('Artin') }
+
+        it 'returns the matching receord' do
+          record.name.should eql('Artin')
+        end
+      end
+
+      context 'when finding by multiple attributes' do
+        let(:record) { lookup.find_by_name_and_type('George', 'QA') }
+
+        it 'returns the matching record' do
+          record.name.should eql('George')
+          record.type.should eql('QA')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "looksy"

data/spec/support/record.rb

@@ -0,0 +1,36 @@
+class Record < Struct.new(:id, :name, :type)
+  include Looksy::Cacheable
+
+  def self.all
+    @all ||= [
+      new(1, 'Artin', 'Developer'),
+      new(2, 'Paul', 'Developer'),
+      new(3, 'George', 'QA'),
+      new(4, 'Artin', 'Developer')
+    ]
+  end
+
+  def self.first
+    all.first
+  end
+
+  def self.second
+    all[1]
+  end
+
+  def self.third
+    all[2]
+  end
+
+  def self.last
+    all.last
+  end
+
+  def attributes
+    {
+      "id" => id,
+      "name" => name,
+      "type" => type
+    }
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: looksy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Artin Boghosian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-16 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &184782620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *184782620
+description: Add a caching layer to your ActiveRecord models that represent look up
+  tables
+email:
+- artinboghosian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/looksy.rb
+- lib/looksy/cacheable.rb
+- lib/looksy/dynamic_find_match.rb
+- lib/looksy/lookup.rb
+- lib/looksy/null_cache.rb
+- lib/looksy/version.rb
+- looksy.gemspec
+- spec/lib/cacheable_spec.rb
+- spec/lib/dynamic_find_match_spec.rb
+- spec/lib/lookup_spec.rb
+- spec/spec_helper.rb
+- spec/support/record.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Caching layer for look up tables
+test_files:
+- spec/lib/cacheable_spec.rb
+- spec/lib/dynamic_find_match_spec.rb
+- spec/lib/lookup_spec.rb
+- spec/spec_helper.rb
+- spec/support/record.rb