ar_finder_form 0.1.0

data/lib/ar_finder_form/client_instance_methods.rb

@@ -0,0 +1,38 @@
+require 'ar_finder_form'
+module ArFinderForm
+  module ClientInstanceMethods
+    def find_options(value = nil)
+      @find_options = value if value
+      @find_options ||= self.class.find_options.dup
+      @find_options
+    end
+
+    def paginate_options(value = nil)
+      @find_options = value if value
+      @find_options ||= self.class.paginate_options.dup
+      @find_options
+    end
+
+    def to_find_options(options = {})
+      context = Context.build(self, options)
+      context.to_find_options
+    end
+
+    def to_paginate_options(options = {})
+      context = Context.build(self, options)
+      context.to_paginate_options
+    end
+
+    def find(*args)
+      options = to_find_options(args.extract_options!)
+      args << options
+      self.class.builder.model_class.find(*args)
+    end
+
+    def paginate(*args)
+      options = to_paginate_options(args.extract_options!)
+      args << options
+      self.class.builder.model_class.paginate(*args)
+    end
+  end
+end

data/lib/ar_finder_form/column.rb

@@ -0,0 +1,89 @@
+require 'ar_finder_form'
+module ArFinderForm
+  class Column
+    attr_reader :table, :name, :options
+    attr_reader :form_attr
+    def initialize(table, name, *args)
+      @table, @name = table, name
+      @options = args.extract_options!
+      @static_values = args.empty? ? nil : args
+    end
+
+    def setup
+      send("setup_#{setup_type}")
+    end
+
+    def build(context)
+      @form_attr.build(context)
+    end
+
+    def static?
+      !!@static_values
+    end
+
+    def foreign_key?
+      name = self.name.to_s
+      table.model_class.reflections.
+        any?{|key, ref| ref.primary_key_name == name}
+    end
+
+    def model_column
+      result = table.model_column_for(name)
+      unless result.is_a?(ActiveRecord::ConnectionAdapters::Column)
+        raise "Unsupported column object for #{table.name}.#{name}: #{result.inspect}"
+      end
+      result
+    end
+
+    def type
+      @options[:type] || model_column.type
+    end
+
+    private
+    def setup_type
+      return 'match_static' if static?
+      return 'match_range' if options[:range]
+      return "match_#{options[:match]}" if options[:match]
+      case type
+      when :string, :text then
+        'match_partial'
+      when :integer then
+        foreign_key? ? 'match_exactly' : 'match_range'
+      when :float, :datetime, :date, :time then
+        'match_range'
+      else
+        'match_exactly'
+      end
+    end
+
+    def setup_match_static
+      new_attr(Attr::Static, {:connector => 'AND'}, @static_values)
+    end
+
+    def setup_match_exactly
+      new_attr(Attr::Simple, :operator => '=')
+    end
+
+    def setup_match_range
+      new_attr(Attr::RangeAttrs, options.delete(:range))
+    end
+
+    Attr::Like::MATCHERS.keys.each do |matcher|
+      class_eval(<<-EOS)
+        def setup_match_#{matcher}
+          new_attr(Attr::Like, :match => :#{matcher.to_s})
+        end
+      EOS
+    end
+
+    def new_attr(klass, default_options, *args)
+      options = (default_options || {}).update(self.options)
+      args << options
+      @form_attr = klass.new(self, options[:attr] || name, *args)
+      @form_attr.setup
+      @form_attr
+    end
+
+
+  end
+end

data/lib/ar_finder_form/config.rb

@@ -0,0 +1,6 @@
+require 'ar_finder_form'
+module ArFinderForm
+  class Config
+
+  end
+end

data/lib/ar_finder_form/context.rb

@@ -0,0 +1,117 @@
+require 'ar_finder_form'
+module ArFinderForm
+  class Context
+    FIND_OPTIONS_KEYS = [:order, :group, :limit, :offset, :include, 
+      :select, :from, :readonly, :lock
+    ]
+    PAGINATE_OPTIONS_KEYS = [:per_page, :page, :total_entries, :count, :finder]
+
+    attr_reader :form, :options, :joins
+    attr_reader :where, :params
+    attr_accessor :single_table
+    
+    def initialize(form, options = {})
+      @form, @options = form, options
+      @where, @params = [], []
+      @joins = []
+      @connector = options.delete(:connector) || 'AND'
+      FIND_OPTIONS_KEYS.each do |attr_name|
+        if value = @options[attr_name]
+          @find_options ||= {}
+          @find_options[attr_name] = value
+        end
+      end
+      PAGINATE_OPTIONS_KEYS.each do |attr_name|
+        if value = @options[attr_name]
+          @paginate_options ||= {}
+          @paginate_options[attr_name] = value
+        end
+      end
+    end
+
+    def add_condition(where, *params)
+      @where << where
+      @params.concat(params)
+    end
+
+    def to_find_options(options = nil)
+      conditions = @where.join(" %s " % @connector)
+      unless @params.empty?
+        conditions = [conditions].concat(@params)
+      end
+      result = {}
+      if find_options
+        FIND_OPTIONS_KEYS.each do |attr_name|
+          value = find_options[attr_name]
+          result[attr_name] = value unless value.blank?
+        end
+      end
+      result[:joins] = joins.join(' ') unless joins.empty?
+      result[:conditions] = conditions unless conditions.empty?
+      options ? result.update(options) : result
+    end
+
+    def to_paginate_options(options = nil)
+      result = to_find_options(options)
+      if paginate_options
+        PAGINATE_OPTIONS_KEYS.each do |attr_name|
+          value = paginate_options[attr_name]
+          result[attr_name] = value unless value.blank?
+        end
+      end
+      result
+    end
+
+    def single_table?
+      @single_table
+    end
+
+    def new_sub_context(options = {})
+      result = Context.new(form, options)
+      result.single_table = self.single_table
+      result
+    end
+
+    def empty?
+      to_find_options[:conditions].nil? && joins.empty?
+    end
+
+    def merge(sub_context)
+      conditions = sub_context.to_find_options[:conditions]
+      if conditions
+        if conditions.is_a?(Array)
+          add_condition(conditions.shift, *conditions)
+        else
+          add_condition(conditions)
+        end
+      end
+      yield if block_given?
+      unless sub_context.joins.empty?
+        joins.concat(sub_context.joins)
+      end
+    end
+
+    def build(builder)
+      form.send(:before_build, self) if form.respond_to?(:before_build)
+      builder.build(self)
+      form.send(:after_build, self) if form.respond_to?(:after_build)
+    end
+
+    def find_options; @find_options ||= {}; end
+    def paginate_options; @paginate_options ||= {}; end
+
+    class << self
+      def build(form, options)
+        builder = form.class.builder
+        options = 
+          (form.find_options || {}).dup.
+          update(form.find_options || {}).
+          update(options || {})
+        context = Context.new(form, options)
+        context.build(builder)
+        context
+      end
+    end
+
+  end
+end

data/lib/ar_finder_form/joined_table.rb

@@ -0,0 +1,46 @@
+require 'ar_finder_form'
+
+module ArFinderForm
+  class JoinedTable < Table
+    attr_reader :reflection, :join_type, :parent_table
+    def initialize(parent_table, join_type, reflection, *args)
+      super(reflection.klass, *args)
+      @parent_table = parent_table
+      @join_type = join_type
+      @reflection = reflection
+      @table_name = reflection.klass.table_name
+      @name = "cond_" << @table_name
+    end
+
+    def table_name; @table_name; end
+    def name; @name; end
+
+    def root_table
+      parent_table.root_table
+    end
+
+    def build(context)
+      sub_context = context.new_sub_context(:connector => 'AND')
+      super(sub_context)
+      unless sub_context.empty?
+        context.merge(sub_context) do
+          context.joins << build_join
+        end
+      end
+    end
+
+    def build_join
+      join_on =
+        case reflection.macro
+        when :belongs_to then
+          "#{name}.id = #{parent_table.name}.#{reflection.primary_key_name}"
+        else
+          "#{name}.#{reflection.primary_key_name} = #{parent_table.name}.id"
+        end
+      "%s JOIN %s %s ON %s" % [
+        join_type.to_s.gsub(/\_/, ' ').upcase, reflection.klass.table_name, name, join_on
+      ]
+    end
+
+  end
+end

data/lib/ar_finder_form/table.rb

@@ -0,0 +1,84 @@
+require 'ar_finder_form'
+
+class NameAccessableArray < Array
+  attr_accessor :item_name
+  def initialize(item_name, *args, &block)
+    super(*args, &block)
+    @item_name = item_name
+  end
+
+  def [](index_or_name)
+    if index_or_name.is_a?(Integer)
+      super.[](index_or_name)
+    else
+      detect{|item| name_for(item) == index_or_name}
+    end
+  end
+
+  def name_for(item)
+    item.send(item_name)
+  end
+end
+
+module ArFinderForm
+  class Table
+    attr_reader :model_class, :columns, :joined_tables
+    def initialize(model_class, *args)
+      @model_class = model_class
+      @columns = NameAccessableArray.new(:name)
+      @joined_tables = []
+    end
+
+    def table_name; @model_class.table_name; end
+    def name; table_name; end
+
+    def column(column_name, *args)
+      @columns << Column.new(self, column_name, *args)
+    end
+
+    def model_column_for(name)
+      name = name.to_s
+      @model_columns ||= @model_class.columns
+      @model_columns.detect{|col| col.name.to_s == name}
+    end
+
+    def build_methods
+      columns.each{|column| column.setup}
+      joined_tables.each do |joined_table|
+        joined_table.build_methods
+      end
+    end
+
+    def build(context)
+      columns.each{|column| column.build(context)}
+      joined_tables.each do |joined_table|
+        joined_table.build(context)
+      end
+    end
+
+    def join(join_type, options, &block)
+      join_as = options.delete(:as)
+      join_on = options.delete(:on)
+      ref_name = [:belongs_to, :has_one, :has_many].map{|k| options[k]}.compact.first
+      raise ArgumentError, "#{join_type}_join requires :belongs_to, :has_one or :has_many" unless ref_name
+      ref = @model_class.reflections[ref_name]
+      raise ArgumentError, "no reflection for #{ref_name.inspect}" unless ref
+      result = JoinedTable.new(self, join_type, ref)
+      @joined_tables << result
+      result.instance_eval(&block)
+      result
+    end
+
+    JOIN_TYPES = (%w(inner cross natual) +
+      %w(left right full).map{|t| [t, "#{t}_outer"]}.flatten).map(&:to_sym)
+
+    JOIN_TYPES.each do |join_type|
+      class_eval(<<-"EOS")
+        def #{join_type.to_s}_join(options, &block)
+          join(:#{join_type.to_s}, options, &block)
+        end
+      EOS
+    end
+
+  end
+end

data/spec/.gitignore

@@ -0,0 +1 @@
+/*.sqlite3

data/spec/database.yml

@@ -0,0 +1,23 @@
+sqlite3:
+  adapter: sqlite3
+  database: finder_form_plugin_test.sqlite3
+  timeout: 5000
+
+mysql:
+  adapter: mysql
+  database: finder_form_test
+  encoding: utf8
+  username: root
+  password:
+  socket: /opt/local/var/run/mysql5/mysqld.sock
+  # connect_timeout: 5000
+  read_timeout: 3000
+  write_timeout: 5000
+
+postgresql:
+  adapter: postgresql
+  database: finder_form_test
+  encoding: unicode
+  host: localhost
+  username: postgres
+  password: 

data/spec/order_finder_form1_spec.rb

@@ -0,0 +1,250 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+class OrderFinderForm1
+  include ArFinderForm
+
+  def initialize(attrs = {})
+    attrs.each{|key, value|send("#{key}=", value)}
+  end
+
+  with_model(Order) do
+    # 静的なパラメータ
+    column(:deleted_at, "IS NOT NULL")
+
+    # belongs_to単数一致
+    column(:user_id, :attr => :user_id)
+    # belongs_toに使われているintegerはデフォルトでは一致と判断されます。
+
+    # belongs_to複数一致
+    column(:product_id, :attr => :product_ids, :operator => :IN)
+    # :operatorが指定されているので、単数の一致ではなく複数のどれかへの一致になります
+
+    # 範囲integer
+    column(:amount)
+    # belongs_toに使われていないintegerはデフォルトでは範囲と判断されます。
+    # = column(:amount, :range => {:min => {:attr => :amount_min, :oprator => '>='}, :max => {:attr => :amount_max, :oprator => '<='}})
+
+    # 範囲float
+    column(:price)
+    # dateはデフォルトでは範囲と判断されます。
+    # => column_range(:price)
+    # column_rangeにはデフォルトで :minに'>='と:maxに'<='が指定されます。
+    # = column(:price, :range => {:min => {:attr => :price_min, :oprator => '>='}, :max => {:attr => :price_max, :oprator => '<='}})
+
+    # 範囲date
+    column(:delivery_estimate)
+    # dateはデフォルトでは範囲と判断されます。
+    # => column_range(:delivery_estimate)
+    # column_rangeにはデフォルトで :minに'>='と:maxに'<='が指定されます。
+    # => column_range(:delivery_estimate, :min => '>=', :max => '<=')
+
+    # 範囲time
+    column(:delivered_at)
+    # timeはデフォルトでは範囲と判断されます。
+    # => column_range(:delivered_at)
+    # column_rangeにはデフォルトで :minに'>='と:maxに'<='が指定されます。
+    # => column_range(:delivered_at, :min => '>=', :max => '<=')
+
+  end
+end
+
+
+describe OrderFinderForm1 do
+
+  after do
+    Order.find(:all, @form.to_find_options)
+  end
+
+  it "no attribute" do
+    @form = OrderFinderForm1.new
+    @form.to_find_options.should == {
+      :conditions => "deleted_at IS NOT NULL"
+    }
+  end
+
+  describe "belongs_to" do
+    it "with integer" do
+      @form = OrderFinderForm1.new(:user_id => 3)
+      @form.to_find_options.should == {
+        :conditions => ["deleted_at IS NOT NULL AND user_id = ?", 3]}
+    end
+
+    it "with string" do
+      @form = OrderFinderForm1.new(:user_id => '3')
+      @form.to_find_options.should == {
+        :conditions => ["deleted_at IS NOT NULL AND user_id = ?", 3]}
+    end
+  end
+
+
+  describe "belongs_to IN" do
+    it "with integer array" do
+      @form = OrderFinderForm1.new(:product_ids => [1,2,3,4])
+      @form.to_find_options.should == {
+        :conditions => ["deleted_at IS NOT NULL AND product_id IN (?)", [1,2,3,4]]}
+    end
+
+    it "with String array" do
+      @form = OrderFinderForm1.new(:product_ids => %w(3 4 6 8))
+      @form.to_find_options.should == {
+        :conditions => ["deleted_at IS NOT NULL AND product_id IN (?)", [3, 4, 6, 8]]}
+    end
+
+    it "with comma separated string" do
+      @form = OrderFinderForm1.new(:product_ids => '1,2,3,4')
+      @form.to_find_options.should == {
+        :conditions => ["deleted_at IS NOT NULL AND product_id IN (?)", [1,2,3,4]]}
+    end
+
+  end
+
+  describe "integer range" do
+    describe "as integer" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:amount_min => 3)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount >= ?", 3]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:amount_max => 10)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount <= ?", 10]}
+      end
+
+      it "with min and max" do
+        @form = OrderFinderForm1.new(:amount_min => 4, :amount_max => 9)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount >= ? AND amount <= ?", 4, 9]}
+      end
+    end
+
+    describe "as string" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:amount_min => '3')
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount >= ?", 3]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:amount_max => '10')
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount <= ?", 10]}
+      end
+
+      it "with min and max" do
+        @form = OrderFinderForm1.new(:amount_min => '4', :amount_max => '9')
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND amount >= ? AND amount <= ?", 4, 9]}
+      end
+    end
+  end
+
+  describe "float range" do
+    describe "as float" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:price_min => 3.9)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price >= ?", 3.9]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:price_max => 10.2)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price <= ?", 10.2]}
+      end
+
+      it "with comma separated string" do
+        @form = OrderFinderForm1.new(:price_min => 4.1, :price_max => 9.9)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price >= ? AND price <= ?", 4.1, 9.9]}
+      end
+    end
+
+    describe "as String" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:price_min => '3.1')
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price >= ?", 3.1]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:price_max => '10.1')
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price <= ?", 10.1]}
+      end
+
+      it "with comma separated string" do
+        @form = OrderFinderForm1.new(:price_min => 4.0, :price_max => 9.5)
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND price >= ? AND price <= ?", 4.0, 9.5]}
+      end
+    end
+  end
+
+
+
+  describe "date range" do
+    describe "as Date" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => Date.parse("2009/11/15"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ?", Date.parse("2009/11/15")]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:delivery_estimate_max => Date.parse("2009/11/15"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate <= ?", Date.parse("2009/11/15")]}
+      end
+
+      it "with comma separated string" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => Date.parse("2009/11/1"), :delivery_estimate_max => Date.parse("2009/11/15"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ? AND delivery_estimate <= ?", Date.parse("2009/11/1"), Date.parse("2009/11/15")]}
+      end
+    end
+
+    describe "as DateTime" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => DateTime.parse("2009/11/15 12:34:56"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ?", DateTime.parse("2009/11/15 12:34:56")]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:delivery_estimate_max => DateTime.parse("2009/11/15 01:02:03"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate <= ?", DateTime.parse("2009/11/15 01:02:03")]}
+      end
+
+      it "with comma separated string" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => DateTime.parse("2009/11/1 01:02:03"), :delivery_estimate_max => DateTime.parse("2009/11/15 11:32:33"))
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ? AND delivery_estimate <= ?", DateTime.parse("2009/11/1 01:02:03"), DateTime.parse("2009/11/15 11:32:33")]}
+      end
+    end
+
+    describe "as String" do
+      it "with min" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => "2009-11-1")
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ?", Date.parse("2009/11/1")]}
+      end
+
+      it "with max" do
+        @form = OrderFinderForm1.new(:delivery_estimate_max => "H21.11.15")
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate <= ?", Date.parse("2009/11/15")]}
+      end
+
+      it "with comma separated string" do
+        @form = OrderFinderForm1.new(:delivery_estimate_min => "2009/11/1", :delivery_estimate_max => "2009/11/15")
+        @form.to_find_options.should == {
+          :conditions => ["deleted_at IS NOT NULL AND delivery_estimate >= ? AND delivery_estimate <= ?", Date.parse("2009/11/1"), Date.parse("2009/11/15")]}
+      end
+    end
+  end
+
+end