ar_finder_form 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+/coverage
+/pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Takeshi AKIMA
+
+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.rdoc

@@ -0,0 +1,117 @@
+= ArFinderForm
+== ArFinderFormとは？
+
+検索条件フォームを少ない記述で組み立てるためのDSLを提供するライブラリです。
+
+== サンプル
+
+以下のようなデータベースがあった場合、
+ ActiveRecord::Schema.define(:version => 0) do
+   create_table :products, :force => true do |t|
+     t.string :category_cd
+     t.string :code
+     t.string :name
+     t.float :price
+     t.integer :stock
+     t.time :released_at
+     t.timestamp
+   end
+
+   create_table :orders, :force => true do |t|
+     t.integer :user_id
+     t.integer :product_id
+     t.integer :amount
+     t.float :price
+     t.date :delivery_estimate
+     t.time :delivered_at
+     t.time :deleted_at 
+     t.timestamp
+   end
+
+   create_table :users, :force => true do |t|
+     t.string :login
+     t.string :name
+     t.timestamp
+   end
+ end
+
+
+例えば、Userのfindに渡すオプションを組み立てるクラスを以下のように組み立てることができます。
+
+ class UserFinderForm1
+   include ArFinderForm
+
+   def initialize(attrs = {})
+     attrs.each{|key, value|send("#{key}=", value)}
+   end
+
+   with_model(User) do
+     # users.nameの条件。文字列なのでデフォルトでLIKEが使われます
+     column(:name, :attr => :user_name)
+     
+     # 関連するordersに関する条件を加えるため、ordersをinner joinで結合します。
+     inner_join(:has_many => :orders) do
+                          
+       # orders.product_idの条件。:operatorで:INを指定できます。
+       # :attrで指定している:product_idsがUserFinderForm1にattr_accessorで宣言されます。
+       column(:product_id, :attr => :product_ids, :operator => :IN)
+
+       # ordersに関連するusersに関する条件を加えるため、usersをinner joinで結合します。
+       # このようにjoinのネストも可能です。
+       inner_join(:belongs_to => :product) do
+       
+         # products.nameの条件。同じnameというカラムについてですが、conditionsには
+         # products.nameが出力され、UserFinderForm1の属性としては:product_nameが
+         # 宣言されます        
+         column(:name, :attr => :product_name)
+         
+         # products.priceの条件。関連に使われていないinteger,float,date,time,datetimeは
+         # :match => :exactなどが指定されない限りデフォルトでは範囲の条件となり、
+         # 属性としては :price_min, :price_maxが宣言されます 
+         column(:price)
+       end
+     end
+   end
+ end
+ 
+実際にfindに使うコードは
+ form = UserFinderForm1.new(:user_name => "akimatter", :product_name => "ABC")
+ users = User.find(:all, form.to_find_options)
+ users = form.find(:all)
+という感じになります。
+
+動的にオプションを設定することも可能です。
+ users = User.find(:all, form.to_find_options(:include => [xxxx]))
+ users = form.find(:all, :include => [xxxx]) 
+
+またwill_paginate用に以下のようなことも可能です。
+ form = UserFinderForm1.new(:user_name => "akimatter", :product_name => "ABC")
+ users = User.paginate(form.to_paginate_options(:page => params[:page])
+ users = form.paginate(:page => params[:page])
+
+詳しくはspecを御覧下さい。
+
+== セットアップ
+=== Railsのプラグインとして
+ ruby script/plugin install git://github.com/akm/ar_finder_form.git
+
+=== Railsでgemとして
+まずgemcutterの設定をしていなかったら、
+ gem install gemcutter
+ gem tumble
+を実行した後、
+ gem install ar_finder_form
+
+で、config/initializersに以下のファイルを作成すればオッケーです。
+
+config/initializers/ar_finder_form.rb
+
+ require 'ar_finder_form'
+
+
+== 備考
+フォームのクラスにはactive_formなどを継承することを想定しています。
+selectable_attr(およびselectable_attr_rails)もあわせて使うと便利かも。
+ 
+
+Copyright (c) 2008 Takeshi AKIMA, released under the MIT license

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+gem 'rspec', '>= 1.1.4'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+ 
+desc 'Default: run unit tests.'
+task :default => :spec
+ 
+task :pre_commit => [:spec, 'coverage:verify']
+ 
+desc 'Run all specs under spec/**/*_spec.rb'
+Spec::Rake::SpecTask.new(:spec => 'coverage:clean') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov_dir = 'coverage'
+  t.rcov = true
+  # t.rcov_opts = ["--include-file", "lib\/*\.rb", "--exclude", "spec\/"]
+  t.rcov_opts = ["--exclude", "spec\/"]
+end
+ 
+desc 'Generate documentation for the ar_finder_form plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FinderForm'
+  rdoc.options << '--line-numbers' << '--inline-source' << '-c UTF-8'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+ 
+namespace :coverage do
+  desc "Delete aggregate coverage data."
+  task(:clean) { rm_f "coverage" }
+ 
+  desc "verify coverage threshold via RCov"
+  RCov::VerifyTask.new(:verify => :spec) do |t|
+    t.threshold = 100.0 # Make sure you have rcov 0.7 or higher!
+    t.index_html = 'coverage/index.html'
+  end
+end
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "ar_finder_form"
+    s.summary  = "ar_finder_form provides a DSL to define form for options to find/paginate"
+    s.description  = "ar_finder_form provides a DSL to define form for options to find/paginate"
+    s.email    = "akima@gmail.com"
+    s.homepage = "http://github.com/akm/ar_finder_form/"
+    s.authors  = ["Takeshi Akima"]
+    s.add_dependency("activerecord")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

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

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/ar_finder_form.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+module ArFinderForm
+
+  autoload :Config, 'ar_finder_form/config'
+  autoload :ClientClassMethods, 'ar_finder_form/client_class_methods'
+  autoload :ClientInstanceMethods, 'ar_finder_form/client_instance_methods'
+  autoload :Table, 'ar_finder_form/table'
+  autoload :JoinedTable, 'ar_finder_form/joined_table'
+  autoload :Column, 'ar_finder_form/column'
+  autoload :Attr, 'ar_finder_form/attr'
+  autoload :Builder, 'ar_finder_form/builder'
+  autoload :Context, 'ar_finder_form/context'
+
+  def self.included(mod)
+    mod.extend(ClientClassMethods)
+    mod.module_eval do
+      include ClientInstanceMethods
+    end
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+end

data/lib/ar_finder_form/attr.rb

@@ -0,0 +1,11 @@
+require 'ar_finder_form'
+module ArFinderForm
+  module Attr
+    autoload :Base, 'ar_finder_form/attr/base'
+    autoload :Static, 'ar_finder_form/attr/static'
+    autoload :Simple, 'ar_finder_form/attr/simple'
+    autoload :Like, 'ar_finder_form/attr/like'
+    autoload :RangeAttrs, 'ar_finder_form/attr/range_attrs'
+
+  end
+end

data/lib/ar_finder_form/attr/base.rb

@@ -0,0 +1,49 @@
+require 'ar_finder_form/attr'
+module ArFinderForm
+  module Attr
+    class Base
+      attr_reader :column, :name, :options
+      attr_reader :nil_available, :array_separator
+      def initialize(column, name, options)
+        @column, @name = column, name
+        @nil_available = options.delete(:nil_available)
+        @options = options
+        @attr_filter = options[:attr_filter] || method(:column_type_cast)
+        @array_separator = options.delete(:array_separator) || /[\s\,]/
+      end
+
+      def table; column.table; end
+      def nil_available?; !!@nil_available; end
+
+      def column_name(context)
+        context.single_table? ? column.name : "#{table.name}.#{column.name}"
+      end
+
+      def client_class_eval(script, &block)
+        klass = column.table.root_table.client_class
+        klass.module_eval(&block) if block
+        klass.module_eval(script) if script
+      end
+
+      def match?(context)
+        nil_available? ? true : !!context.form.send(name)
+      end
+
+      def form_value(context)
+        result = context.form.send(name)
+        @attr_filter ? @attr_filter.call(result) : result
+      end
+
+      def form_value_array(context)
+        values = context.form.send(name)
+        values = values.to_s.split(array_separator) unless values.is_a?(Array)
+        @attr_filter ? values.map{|v| @attr_filter.call(v)} : values
+      end
+
+      def column_type_cast(value)
+        column.model_column.type_cast(value)
+      end
+
+    end
+  end
+end

data/lib/ar_finder_form/attr/like.rb

@@ -0,0 +1,30 @@
+require 'ar_finder_form/attr'
+module ArFinderForm
+  module Attr
+    class Like < Base
+
+      MATCHERS = {
+        :forward => '%s%%',
+        :backward => '%%%s',
+        :partial => '%%%s%%'
+      }
+
+      attr_reader :operator
+      def initialize(column, name, options)
+        super(column, name, options)
+        @mathcer = MATCHERS[options[:match]] || MATCHERS[:partial]
+      end
+
+      def setup
+        client_class_eval("attr_accessor :#{name}")
+      end
+
+      def build(context)
+        return unless match?(context)
+        context.add_condition(
+          "#{column_name(context)} LIKE ?",
+          @mathcer % form_value(context).to_s)
+      end
+    end
+  end
+end

data/lib/ar_finder_form/attr/range_attrs.rb

@@ -0,0 +1,29 @@
+require 'ar_finder_form/attr'
+module ArFinderForm
+  module Attr
+    class RangeAttrs < Base
+
+      attr_accessor :min, :max
+      def initialize(column, name, options)
+        super(column, name, options)
+        range = options[:range] || {}
+        min_def = {:operator => '>='}.update(range[:min] || options[:min] || {})
+        max_def = {:operator => '<='}.update(range[:max] || options[:max] || {})
+        @min = Simple.new(column, min_def[:attr] || "#{name}_min", min_def)
+        @max = Simple.new(column, max_def[:attr] || "#{name}_max", max_def)
+      end
+
+      def setup
+        @min.setup
+        @max.setup
+      end
+
+      def build(context)
+        sub_context = context.new_sub_context(:connector => 'AND')
+        @min.build(sub_context)
+        @max.build(sub_context)
+        context.merge(sub_context)
+      end
+    end
+  end
+end

data/lib/ar_finder_form/attr/simple.rb

@@ -0,0 +1,29 @@
+require 'ar_finder_form/attr'
+module ArFinderForm
+  module Attr
+    class Simple < Base
+      attr_reader :operator
+      def initialize(column, name, options)
+        super(column, name, options)
+        @operator = options.delete(:operator).to_s.downcase.to_sym
+      end
+
+      def setup
+        client_class_eval("attr_accessor :#{name}")
+      end
+
+      def build(context)
+        return unless match?(context)
+        case operator
+        when :in then
+          context.add_condition("#{column_name(context)} IN (?)",
+            form_value_array(context))
+        else
+          context.add_condition(
+            "#{column_name(context)} #{operator} ?",
+            form_value(context))
+        end
+      end
+    end
+  end
+end

data/lib/ar_finder_form/attr/static.rb

@@ -0,0 +1,24 @@
+require 'ar_finder_form/attr'
+module ArFinderForm
+  module Attr
+    class Static < Base
+
+      attr_reader :values
+      def initialize(column, name, values, options)
+        super(column, name, options)
+        @values = values || {}
+      end
+
+      def setup
+        # do nothing
+      end
+
+      def build(context)
+        context.add_condition(
+          values.map{|v| "#{column_name(context)} #{v}"}.
+          join(' %s ' % options[:connector]))
+      end
+
+    end
+  end
+end

data/lib/ar_finder_form/builder.rb

@@ -0,0 +1,22 @@
+require 'ar_finder_form'
+
+module ArFinderForm
+  class Builder < Table
+    attr_reader :client_class, :model_class
+    attr_reader :columns
+    def initialize(client_class, model_class)
+      super(model_class)
+      @client_class = client_class
+    end
+
+    def root_table
+      self
+    end
+
+    def build(context)
+      context.single_table = joined_tables.empty?
+      super(context)
+    end
+
+  end
+end

data/lib/ar_finder_form/client_class_methods.rb

@@ -0,0 +1,23 @@
+require 'ar_finder_form'
+module ArFinderForm
+  module ClientClassMethods
+    attr_reader :builder
+    def with_model(model_class, &block)
+      @builder = Builder.new(self, model_class)
+      @builder.instance_eval(&block)
+      @builder.build_methods
+      @builder
+    end
+
+    def find_options(value = nil)
+      @find_options = value if value
+      @find_options ||= {}
+    end
+
+    def paginate_options(value = nil)
+      @find_options = value if value
+      @find_options ||= {}
+    end
+
+  end
+end