super_finder 0.0.1

data/lib/super_finder/filters.rb

@@ -0,0 +1,33 @@
+# Monkey patch to enable filters even in development environment.
+module SuperFinder
+  
+  module Filters
+   
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+       
+      def enable_super_finder_filters
+        class_eval <<-EOV
+          include SuperFinder::Filters::InstanceMethods
+          before_filter :apply_superfinder_filters
+        EOV
+      end
+
+    end
+    
+    module InstanceMethods
+      
+      def apply_superfinder_filters
+        (SuperFinder::Config.instance.before_filters || []).each do |filter|
+          return false if self.send(filter.to_sym) == false
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/super_finder/generator_controller.rb

@@ -0,0 +1,94 @@
+class SuperFinder::GeneratorController < ApplicationController
+  
+  unloadable
+  
+  # enable_super_finder_filters # hack for dev env
+  
+  def index
+    render :text => "SuperFinderResources = #{self.generate.to_json}"
+  end
+  
+  protected
+  
+  def reloaded_entry_klass(klass)
+    Rails.env.development? ? eval(klass.name) : klass
+  rescue
+    klass
+  end
+  
+  def collect_entries_for(options)
+    SuperFinder::CacheManager.instance.fetch(options[:klass], get_scoper(options)) do
+      entries = (case options[:finder]
+      when Proc
+        options[:finder].call(self)
+      else
+        scoper = SuperFinder::Config.instance.scoper
+      
+        conditions = {}
+      
+        if options[:scope].nil?
+          if scoper && scoper[:column] # looking for a global scope
+            conditions = { scoper[:column] => self.send(scoper[:getter]).id }
+          end
+        end
+      
+        reloaded_entry_klass(options[:klass]).all(:conditions => conditions)
+      end)
+    
+      entries.map do |entry|
+        {
+          :value => column_value(entry, options),
+          :url => entry_url(entry, options)
+        }
+      end
+    end
+  end
+  
+  def get_scoper(options)
+    self.send(SuperFinder::Config.instance.scoper[:getter].to_sym) rescue nil
+  end
+  
+  def label_name(options)
+    case options[:label]
+    when String, Symbol then options[:label].to_s
+    when Proc then options[:label].call(self)
+    else
+      name = options[:klass].name
+      I18n.t(name.demodulize.underscore, :scope => [:activerecord, :models], :default => name.humanize)
+    end
+  end
+  
+  def column_value(entry, options)
+    case options[:column]
+    when String, Symbol then entry.attributes[options[:column].to_s]
+    when Proc then options[:column].call(entry).to_s
+    else
+      '[Superfinder] Column is missing'
+    end
+  end
+  
+  def entry_url(entry, options) 
+    url = options[:url]
+    case url
+    when Hash, nil
+      url = (SuperFinder::Config.instance.url || {}).merge(url || {})
+      resource_name = entry.class.name.pluralize.underscore
+      
+      url_for({
+        :controller => File.join(['/', url[:name_prefix], resource_name].compact),
+        :action     => url[:action].to_sym ,
+        :id         => entry.id
+      })
+    when Proc then url.call(self, entry)
+    end
+  end
+    
+  def generate
+    map = {}
+    SuperFinder::Config.instance.models.each do |options|
+      map[label_name(options)] = self.collect_entries_for(options)
+    end
+    map
+  end
+  
+end

data/lib/super_finder/helper.rb

@@ -0,0 +1,18 @@
+module SuperFinder
+  
+  module Helper
+    
+    def super_finder_tag
+      %{
+        <div id="superfinder" style="display: none">
+    			<p>#{text_field_tag 'q'}</p>
+    			<ul></ul>
+    		</div>
+
+    		<script src="#{super_finder_resources_url}" type="text/javascript"></script>
+      }
+    end
+    
+  end
+  
+end

data/lib/super_finder/initializer.rb

@@ -0,0 +1,31 @@
+module SuperFinder
+  
+  class Initializer
+   
+    unloadable
+   
+    def self.run(&block)
+      block.call(SuperFinder::Config.instance) if block_given?
+      
+      raise 'SuperFinder needs one or many models' if (SuperFinder::Config.instance.models || []).empty?
+      
+      self.apply
+    end
+    
+    protected
+    
+    def self.apply
+      # Cache Sweeper
+      SuperFinder::CacheSweeper.instance # register the observer
+      
+      # Before filters
+      unless (filters = SuperFinder::Config.instance.before_filters).empty?
+        SuperFinder::GeneratorController.class_eval do
+          before_filter SuperFinder::Config.instance.before_filters
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/super_finder/routes.rb

@@ -0,0 +1,10 @@
+module SuperFinder
+  
+  module Routes
+    
+    def self.draw(map)
+      map.super_finder_resources '/super_finder_resources.js', :controller => 'super_finder/generator', :action => 'index'
+    end
+  end
+  
+end

data/spec/assets/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  activerecord:
+    models: 
+      project: Fun project

data/spec/functional/cache_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/functional_spec_helper')
+
+describe SuperFinder::CacheSweeper do
+  
+  before(:all) do
+    add_project_and_task_records
+    
+    SuperFinder::Initializer.run do |config|
+      config.name_prefix = 'admin'
+      config.default_action = :edit
+      config.scoper = { 
+        :column => :account_id
+      }
+      config.models = [
+        { :klass => Project },
+        { :klass => Task, :scope => false }
+      ]
+    end
+  end
+  
+  it 'should refresh cache if a record is added' do
+    SuperFinder::CacheSweeper.instance.expects(:refresh_cache!).returns(true)
+  
+    Project.create :title => 'Hello world !'
+  end
+  
+  it 'should refresh cache if a record is updated' do
+    SuperFinder::CacheSweeper.instance.expects(:refresh_cache!).returns(true)
+  
+    Project.first.update_attribute :title, 'new title'
+  end
+  
+  it 'should refresh cache if a record is destroyed' do
+    SuperFinder::CacheSweeper.instance.expects(:refresh_cache!).returns(true)
+  
+    Project.first.destroy
+  end
+  
+  it 'should refresh cache based on a scope id' do
+    SuperFinder::CacheManager.instance.expects(:refresh!).with(Project, 42).returns(true)
+    
+    Project.create :title => 'Hello world !', :account_id => 42
+  end
+  
+end

data/spec/functional/controller_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/functional_spec_helper')
+
+describe SuperFinder::GeneratorController do
+  
+  before(:all) do
+    add_project_and_task_records
+    
+    SuperFinder::Initializer.run do |config|
+      config.url = {
+        :name_prefix  => 'admin',
+        :action       => :edit 
+      }
+      config.scoper = { 
+        :column => :account_id,
+        :getter => :current_account
+      }
+      config.models = [
+        { :klass => Project, :column => :title },
+        { :klass => Task, :column => :name, :label => 'My tasks', :scope => false },
+        { 
+          :klass => Person, 
+          :column => :nickname, 
+          :label => Proc.new { |c| "My people" }, 
+          :finder => Proc.new { |c| Person.all(:conditions => { :account_id => c.send(:current_account).id }) }
+        }
+      ]
+    end
+    
+    # disable caching
+    SuperFinder::CacheManager.instance.instance_eval do
+      def fetch(klass, scoper = nil, &block)
+        block.call
+      end
+    end
+    
+    @controller = SuperFinder::GeneratorController.new
+    @controller.stubs(:url_for).returns('<url>')
+  end
+  
+  it 'should return of records with an url, a label and a name for each entry' do
+    map = @controller.send(:generate)
+    
+    map.should_not be_empty
+    map.size.should == 3
+    
+    map["My people"].count.should == 1
+    map["Fun project"].count.should == 2
+    map["My tasks"].count.should == 3
+  end
+  
+  it 'should generate a json output' do
+    @controller.stubs(:url_for).returns('<url>')
+    @controller.stubs(:view_paths).returns(nil)
+    @controller.stubs(:default_template).returns(nil) 
+    @controller.response = ActionController::TestResponse.new
+        
+    output = @controller.send(:index)
+    output.should match /^SuperFinderResources = \{(.*)\}$/
+  end
+  
+end

data/spec/functional/functional_spec_helper.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :projects do |t|
+    t.column :title, :string
+    t.column :account_id, :integer
+    t.column :created_at, :datetime      
+    t.column :updated_at, :datetime
+  end
+
+  create_table :tasks do |t|
+    t.column :name, :string
+    t.column :created_at, :datetime      
+    t.column :updated_at, :datetime
+  end
+  
+  create_table :people do |t|
+    t.column :nickname, :string
+    t.column :account_id, :integer
+    t.column :created_at, :datetime      
+    t.column :updated_at, :datetime
+  end
+end
+
+class Project < ActiveRecord::Base
+end
+
+class Task < ActiveRecord::Base
+end
+
+class Person < ActiveRecord::Base
+end
+
+class Account < ActiveRecord::Base
+end
+
+ApplicationController.class_eval do
+  
+  include Spec
+  include Spec::Mocks
+  include Spec::Mocks::Methods
+  include Spec::Mocks::ExampleMethods
+  include Spec::Rails::Mocks
+  
+  protected
+  
+  def current_account
+    mock_model(Account, :id => 42) #("Account", :id => 42)    
+  end
+  
+end
+
+
+def add_project_and_task_records
+  clean_records
+  
+  Project.create :title => 'Ruby on Rails', :account_id => 42
+  Project.create :title => 'Liquid', :account_id => 42
+  Project.create :title => 'CMS', :account_id => 43
+  
+  Task.create :name => 'build engines'
+  Task.create :name => 'drink some beer'
+  Task.create :name => 'sleep'
+  
+  Person.create :nickname => 'Bart', :account_id => 42
+  Person.create :nickname => 'Homer', :account_id => 43
+end
+
+def clean_records
+  Project.destroy_all
+  Task.destroy_all
+  Person.destroy_all
+end
+
+# def teardown_db
+#   ActiveRecord::Base.connection.tables.each do |table|
+#     ActiveRecord::Base.connection.drop_table(table)
+#   end
+# end

data/spec/functional/routes_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'Routes' do
+  
+  before do
+    ActionController::Routing::Routes.draw do |map|
+      map.resources :foos do |fu|
+        fu.resources :bars
+      end
+
+      SuperFinder::Routes.draw(map)
+      
+      map.connect '/:controller/:action/:id'
+    end  
+  end
+  
+  it 'should add a custom route' do
+    params_from(:get, '/super_finder_resources.js').should == { 
+      :controller => 'super_finder/generator',
+      :action => 'index' 
+    }    
+  end
+  
+  # from rspec-rails
+  def params_from(method, path)
+    ActionController::Routing::Routes.recognize_path(path, :method => method)
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'mocha'
+
+gem 'actionpack'
+gem 'activerecord', '>= 1.15.4.7794'
+require 'action_controller'
+require 'action_controller/test_process.rb'
+require 'active_support'
+require 'action_pack'
+require 'action_view'
+require 'active_record'
+require 'active_record/observer'
+
+require 'spec'
+require 'spec/mocks'
+require 'spec/mocks/mock.rb'
+require 'spec/rails/mocks.rb'
+require 'spec/autorun'
+
+I18n.load_path << Dir[File.join(File.dirname(__FILE__), 'assets', 'locales', '*.{rb,yml}') ] 
+I18n.default_locale = :en
+
+class ApplicationController < ActionController::Base
+end
+
+require 'super_finder'
+
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+include ActionController::UrlWriter
+