active_filter 0.0.4 → 0.0.5

data/lib/active_filter/base.rb

@@ -1,62 +1,88 @@
 # coding: utf-8
-require "active_filter/field"
+require "active_filter/filter"
 
 module ActiveFilter
   class Base
-    attr_reader :fields
+    include ::Enumerable
+
+    attr_reader :filters
 
     def initialize(data, scope=nil)
       @data = data
       @scope = scope
 
-      @fields = []
-      self.class._model.columns.each do |column|
-        if self.class._field_names.include?(column.name) ||
-          self.class._field_names.include?(column.name.to_sym)
-          @fields << _create_field_from_column(column)
-        end
+      columns = self.class._model.columns
+      
+      # fields で指定した列だけをフィルタ可能にする
+      fields = self.class._fields
+      unless fields.empty?
+        columns = columns.select { |column|
+          fields.include?(column.name) ||
+            fields.include?(column.name.to_sym)
+        }
+      end
+      
+      # exclude で指定した列を除外する
+      excludes = self.class._exclude
+      unless excludes.empty?
+        columns = columns.reject { |column|
+          fields.include?(column.name) ||
+            fields.include?(column.name.to_sym)
+        }
       end
+
+      @filters = columns.map { |column|
+        _create_filter_from_column(column)
+      }
     end
 
-    private
-    def self._field_names
-      @field_names ||= []
+    def self._fields #:nodoc:
+      @fields ||= []
     end
 
-    def self._model
+    def self._model #:nodoc:
       @model
     end
 
-    def _create_field_from_column(column)
+    def self._exclude #:nodoc:
+      @excludes ||= []
+    end
+
+    def self._orders #:nodoc:
+      @orders ||= []
+    end
+
+    def _create_filter_from_column(column)
       case column.type
       when :primary_key
-        return Field.new(column.name)
+        return Filter.new(column.name)
       when :string
-        return StringField.new(column.name)
+        return StringFilter.new(column.name)
       when :text
-        return TextField.new(column.name)
+        return TextFilter.new(column.name)
       when :integer
-        return IntegerField.new(column.name)
+        return IntegerFilter.new(column.name)
       when :float
-        return FloatField.new(column.name)
+        return FloatFilter.new(column.name)
       when :decimal
-        return DecimalField.new(column.name)
+        return DecimalFilter.new(column.name)
       when :datetime
-        return DateTimeField.new(column.name)
+        return DateTimeFilter.new(column.name)
       when :timestamp
-        return Field.new(column.name)
+        return Filter.new(column.name)
       when :time
-        return TimeField.new(column.name)
+        return TimeFilter.new(column.name)
       when :date
-        return DateField.new(column.name)
+        return DateFilter.new(column.name)
       when :binary
-        return Field.new(column.name)
+        return Filter.new(column.name)
       when :boolean
-        return BooleanField.new(column.name)
+        return BooleanFilter.new(column.name)
       else
         raise ArgumentError.new("#{column.type} is not supported.")
       end
     end
+    private :_create_filter_from_column
 
     # コンストラクタで受け取ったスコープまたは
     # model.scoped を返す
@@ -67,8 +93,8 @@ module ActiveFilter
         @scope
       end
     end
+    private :_scoped
 
-    protected
     # フィルタを作成する対象のモデルを指定します。
     def self.model(klass)
       # Class クラスのインスタンスである ActiveFilter::Base オブジェクトの
@@ -82,10 +108,17 @@ module ActiveFilter
     def self.fields(*names)
       # Class クラスのインスタンスである ActiveFilter::Base オブジェクトの
       # インスタンス変数にフィールド名を格納
-      @field_names = names
+      @fields = names
+    end
+
+    def self.exclude(*names)
+      @excludes = names
+    end
+
+    def self.order(*names)
+      @orders = names
     end
 
-    public
     def model
       self.class._model
     end
@@ -102,34 +135,33 @@ module ActiveFilter
       self
     end
 
+    def _lookups_from_filter(filter)
+      lookups = { filter.name => "exact" }
+
+      lookup_types = [filter.lookup_type].flatten
+      lookup_types.each do |lookup_type|
+        lookup = "#{filter.name}__#{lookup_type}"
+        lookups[lookup] = lookup_type
+      end
+
+      lookups
+    end
+    private :_lookups_from_filter
+
     def to_scope
       scope = _scoped
       matched = false
 
-      @fields.each do |field|
-        # フィールド名でフィルタする
-        name = field.name
-        if @data.include?(name)
-          converted_value = field.convert_value(@data[name])
-          scope = field.filter(scope, converted_value, "exact")
-          matched = true
-        elsif @data.include?(name.to_sym)
-          converted_value = field.convert_value(@data[name.to_sym])
-          scope = field.filter(scope, converted_value, "exact")
-          matched = true
-        end
-
-        # lookup_type でフィルタする
-        lookup_types = [field.lookup_type].flatten
-        lookup_types.each do |lookup_type|
-          lookup = "#{name}__#{lookup_type}"
+      @filters.each do |filter|
+        lookups = _lookups_from_filter(filter)
+        lookups.each do |lookup, lookup_type|
           if @data.include?(lookup)
-            converted_value = field.convert_value(@data[lookup])
-            scope = field.filter(scope, converted_value, lookup_type)
+            converted_value = filter.convert_value(@data[lookup])
+            scope = filter.filter(scope, converted_value, lookup_type)
             matched = true
           elsif @data.include?(lookup.to_sym)
-            converted_value = field.convert_value(@data[lookup.to_sym])
-            scope = field.filter(scope, converted_value, lookup_type)
+            converted_value = filter.convert_value(@data[lookup.to_sym])
+            scope = filter.filter(scope, converted_value, lookup_type)
             matched = true
           end
         end
@@ -141,6 +173,10 @@ module ActiveFilter
         scope = scope.where("1 = 2")
       end
 
+      self.class._orders.each do |order|
+        scope = scope.order(order.to_s)
+      end
+
       scope
     end
   end

data/lib/active_filter/{field.rb → filter.rb}

@@ -2,7 +2,7 @@
 require "active_support"
 
 module ActiveFilter
-  class Field
+  class Filter
     attr_reader :name
 
     def initialize(name)
@@ -37,15 +37,15 @@ module ActiveFilter
     end
   end
 
-  class StringField < Field
+  class StringFilter < Filter
     def lookup_type
       ["exact", "contains"]
     end
   end
 
-  class TextField < StringField;end
+  class TextFilter < StringFilter;end
 
-  class IntegerField < Field
+  class IntegerFilter < Filter
     def lookup_type
       ["exact", "gt", "lt", "gte", "lte"]
     end
@@ -55,15 +55,15 @@ module ActiveFilter
     end
   end
 
-  class FloatField < IntegerField
+  class FloatFilter < IntegerFilter
     def convert_value(value)
       value.to_f
     end
   end
 
-  class DecimalField < IntegerField;end
+  class DecimalFilter < IntegerFilter;end
 
-  class DateTimeField < Field
+  class DateTimeFilter < Filter
     def lookup_type
       ["exact", "gt", "lt", "gte", "lte"]
     end
@@ -73,19 +73,19 @@ module ActiveFilter
     end
   end
 
-  class DateField < DateTimeField
+  class DateFilter < DateTimeFilter
     def convert_value(value)
       value.to_date
     end
   end
 
-  class TimeField < DateTimeField
+  class TimeFilter < DateTimeFilter
     def convert_value(value)
       value.to_time
     end
   end
 
-  class BooleanField < Field
+  class BooleanFilter < Filter
     def convert_value(value)
       compare_value = value.is_a?(String) ? value.downcase : value
       case compare_value

data/lib/active_filter/version.rb

@@ -1,3 +1,3 @@
 module ActiveFilter
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/active_filter.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 require "active_filter/version"
-require "active_filter/field"
+require "active_filter/filter"
 require "active_filter/base"
 
 module ActiveFilter

data/lib/generators/active_filter/templates/filter.rb

@@ -1,7 +1,8 @@
 class <%= class_name %>Filter < ActiveFilter::Base
   model <%= class_name %>
   <% if 0 < attributes.size %>
-  fields <%= attributes.map{|attr| ":" + attr.name}.join(", ") %>
+  fields <%= attributes.map{ |attr| ":" + attr.name }.join(", ") %>
+  #order <%= attributes.map{ |attr| "'#{attr.name} ASC'" }.join(", ") %>
   <% end %>
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_filter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,7 +100,7 @@ extra_rdoc_files: []
 files:
 - lib/active_filter/base.rb
 - lib/active_filter/engine.rb
-- lib/active_filter/field.rb
+- lib/active_filter/filter.rb
 - lib/active_filter/railtie.rb
 - lib/active_filter/version.rb
 - lib/active_filter.rb
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -52441896280290827
+      hash: 3669060738230829906
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,10 +133,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -52441896280290827
+      hash: 3669060738230829906
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A rails engine for filtering scope based on user selections.