mighty_grid 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b767e8e8c424d0fd0b2aa47ef21df2228781185
-  data.tar.gz: 6d6db95c86982b32d8bb99b3f75a6e6dbacada99
+  metadata.gz: db143f79e6b1f6002945861e8da4884867dda3b8
+  data.tar.gz: c2164ac042c84c00515e03dd41dcb5ddddd3c2f3
 SHA512:
-  metadata.gz: d95807732eb29bdcd4f6261e0ee5d0e0d52490f548455464f62806846267913a1faf70866fa668d2ad2afbaa0178576d06c6f453d9c98f0e062caf229b915408
-  data.tar.gz: 9ee5f55ba15eabbde84ef511a5f170d31f50d0af2a8f73c8ab6639f9a57a2b6cfcd5e1eabebaf08238f102f43c719284a86e5693f59f3771e51af01e6a572083
+  metadata.gz: 8a36b57f6971bb4e3437555f56cccfe0dde9349d5cf5ef809ebcb29dd6db09899ab85e23b78d1fc4ecc7c5aa21bb20f3e2540318de0b78b52db2eb9b8c00ee18
+  data.tar.gz: 753d836d4737f542a101362b177c6d0762e260a9851b868ecc04bc830c22594e70d3df890428ffe1c8683b65ee2f3d83eb02ba33ab64a67cbc9b8bb364e14430

data/README.md

@@ -21,6 +21,7 @@ Or install it yourself as:
 ### Controller
 
 You can define class or relation in <tt>init_grid</tt> method.
+
 ```
 def index
   @products_grid = init_grid(Product)
@@ -42,6 +43,7 @@ end
 ### General configuration options
 
 You can configure the following default values by overriding these values using <tt>MightyGrid.configure</tt> method.
+
 ```
 per_page          # 15 by default
 order_direction   # 'asc' by default

data/lib/mighty_grid/base.rb

@@ -11,11 +11,13 @@ module MightyGrid
       @filters = {}
 
       @options = {
-        :page     => 1,
-        :per_page => MightyGrid.config.per_page,
-        :name     => MightyGrid.config.grid_name,
-        :include  => nil,
-        :joins    => nil,
+        :page       => 1,
+        :per_page   => MightyGrid.config.per_page,
+        :name       => MightyGrid.config.grid_name,
+        :include    => nil,
+        :joins      => nil,
+        :conditions => nil,
+        :group      => nil
       }
 
       opts.assert_valid_keys(@options.keys)
@@ -23,37 +25,54 @@ module MightyGrid
 
       @name = @options[:name].to_s
 
-      load_grid_params
-
       @relation = klass_or_relation
 
       @klass = klass_or_relation.is_a?(ActiveRecord::Relation) ? klass_or_relation.klass : klass_or_relation
 
+      load_grid_params
     end
 
     def read
       apply_filters
-      @relation = @relation.order(@mg_params[:order] => current_order_direction.to_sym) if @mg_params[:order].present? && current_order_direction.present?
+      @relation = @relation.order("#{@mg_params[:order]} #{current_order_direction.to_sym}") if @mg_params[:order].present? && current_order_direction.present?
       @relation = @relation.
                     page(@mg_params[:page]).
                     per(@mg_params[:per_page]).
                     includes(@options[:include]).
-                    joins(@options[:joins])
+                    joins(@options[:joins]).
+                    where(@options[:conditions]).
+                    group(@options[:group])
     end
 
     # Apply filters
     def apply_filters
       filter_params.each do |filter_name, filter_value|
-        next if filter_value.blank? || !klass.column_names.include?(filter_name)
-        field_type = klass.columns_hash[filter_name].type
+        name, table_name = filter_name.split('.').reverse
+
+        if table_name && Object.const_defined?(table_name.classify)
+          model = table_name.classify.constantize
+        else
+          model = klass
+        end
+
+        next if filter_value.blank? || !model.column_names.include?(name)
+        
+        if model && model.superclass == ActiveRecord::Base
+          filter_type = model.columns_hash[name].type
+        else
+          next
+        end
+
+        field_type ||= model.columns_hash[name].type
+        table_name = model.table_name
         
         if @filters.has_key?(filter_name.to_sym) && @filters[filter_name.to_sym].is_a?(Array)
-          @relation = @relation.where(filter_name => filter_value)
+          @relation = @relation.where(table_name => { filter_name => filter_value })
         elsif field_type == :boolean
           value = ['true', '1', 't'].include?(filter_value) ? true : false
-          @relation = @relation.where(filter_name => value)
+          @relation = @relation.where(table_name => {filter_name => value})
         elsif [:string, :text].include?(field_type)
-          @relation = @relation.where("#{klass.table_name}.#{filter_name} #{like_operator} ?", "%#{filter_value}%")
+          @relation = @relation.where("#{table_name}.#{name} #{like_operator} ?", "%#{filter_value}%")
         end
       end
     end
@@ -69,6 +88,9 @@ module MightyGrid
       @mg_params.merge!(@options)
       if current_grid_params
         @mg_params.merge!(current_grid_params.symbolize_keys)
+        if @mg_params[:order].present? && !@mg_params[:order].to_s.include?('.')
+          @mg_params[:order] = "#{klass.table_name}.#{@mg_params[:order]}" 
+        end
       end
     end
 
@@ -86,8 +108,9 @@ module MightyGrid
     def filter_param_name; 'f' end
 
     # Get filter name by field
-    def get_filter_name(filter_name)
-      "#{name}[#{filter_param_name}][#{filter_name}]"
+    def get_filter_name(field, model = nil)
+      field_name = model.present? ? "#{model.table_name}.#{field}" : field
+      "#{name}[#{filter_param_name}][#{field_name}]"
     end
 
     # Get current grid parameters
@@ -96,9 +119,10 @@ module MightyGrid
     end
 
     # Get order parameters
-    def order_params(attribute)
-      direction = attribute.to_s == @mg_params[:order] ? another_order_direction : 'asc'
-      {@name => {order: attribute, order_direction: direction}}
+    def order_params(attribute, model = nil)
+      order = model.present? ? "#{model.table_name}.#{attribute}" : attribute.to_s
+      direction = order == current_grid_params['order'] ? another_order_direction : 'asc'
+      {@name => {order: order, order_direction: direction}}
     end
 
     # Get current order direction

data/lib/mighty_grid/column.rb

@@ -1,7 +1,7 @@
 module MightyGrid
   class Column
 
-    attr_reader :attribute, :attrs, :th_attrs, :options, :title
+    attr_reader :attribute, :attrs, :th_attrs, :options, :title, :model
     attr_accessor :render_value
 
     def initialize(attr_or_options=nil, options=nil, &block)
@@ -15,6 +15,10 @@ module MightyGrid
         @attribute = attr_or_options
         @render_value = @attribute
       end
+
+      @model = @options[:model]
+      raise MightyGridArgumentError.new("Model of field for filtering should have type ActiveRecord") if @model && @model.superclass != ActiveRecord::Base
+      
       @attrs = @options[:html] if @options.has_key?(:html)
       @th_attrs = @options[:th_html] if @options.has_key?(:th_html)
       @title = @options.has_key?(:title) && @options[:title] || ''
@@ -23,7 +27,8 @@ module MightyGrid
     def render(record)
       case @render_value
         when String, Symbol
-          return record[@render_value]
+          rec = @model ? record.send(@model.to_s.underscore) : record
+          return rec[@render_value]
         when Proc
           value = @render_value.call(record)
           return ERB::Util.h(value).to_s.html_safe

data/lib/mighty_grid/filter_renderer.rb

@@ -6,46 +6,53 @@ module MightyGrid
       @grid = grid
     end
 
+    # Get <tt>label</tt> HTML tag
     def label(name, content_or_options = nil, options = nil, &block)
-      filter_name = @grid.get_filter_name(name).parameterize('_')
+      options = content_or_options if content_or_options.is_a?(Hash)
+      human_name = (content_or_options.is_a?(Hash) || content_or_options.nil?) ? @grid.klass.human_attribute_name(name) : content_or_options
 
-      if content_or_options.is_a?(Hash)
-        options = content_or_options
-      else
-        name ||= content_or_options
-      end
-
-      name = @grid.klass.human_attribute_name(name)
+      f_options = filter_options(name, options, false)
 
-      label_tag(filter_name, name, options, &block)
+      label_tag(get_filter_id(f_options), human_name, options, &block)
     end
 
+    # Get <tt>input</tt> HTML tag
     def text_field(name, options={})
-      text_field_tag(@grid.get_filter_name(name), get_filter_param(name), options)
+      f_options = filter_options(name, options)
+      text_field_tag(@grid.get_filter_name(name, f_options[:model]), get_filter_param(name, f_options[:model]), options)
     end
 
+    # Get <tt>select</tt> HTML tag
     def select(name, option_tags=nil, options={})
       @grid.filters[name] = option_tags
       selected = nil
       selected = options.delete(:selected) if options.has_key?(:selected)
-      selected = get_filter_param(name) if get_filter_param(name)
+      
+      f_options = filter_options(name, options)
+
+      selected = get_filter_param(name, f_options[:model]) if get_filter_param(name, f_options[:model])
       opts = options_for_select(option_tags, selected)
 
-      select_tag(@grid.get_filter_name(name), opts, options)
+      select_tag(@grid.get_filter_name(name, f_options[:model]), opts, options)
     end
 
+    # Get <tt>checkbox</tt>
     def check_box(name, value = '1', checked = false, options = {})
       checked = true if get_filter_param(name)
+
+      f_options = filter_options(name, options)
       
-      check_box_tag(@grid.get_filter_name(name), value, checked, options)
+      check_box_tag(@grid.get_filter_name(name, f_options[:model]), value, checked, options)
     end
 
+    # Get button for Apply filter changes
     def submit(content = nil, options = {})
       content = I18n.t("mighty_grid.filters.submit", default: 'Apply changes') if content.blank?
       options.merge!(type: :submit)
       content_tag(:button, content, options)
     end
 
+    # Get button for Reset filter changes
     def reset(content = nil, options = {})
       content = I18n.t("mighty_grid.filters.reset", default: 'Reset changes') if content.blank?
       options.merge!(type: :reset)
@@ -54,8 +61,24 @@ module MightyGrid
 
     private
 
-      def get_filter_param(name)
-        @grid.filter_params.has_key?(name) ? @grid.get_current_grid_param(@grid.filter_param_name)[name] : nil
+      def get_filter_param(name, model = nil)
+        filter_name = model ? "#{model.table_name}.#{name}" : name
+        @grid.filter_params.has_key?(filter_name) ? @grid.filter_params[filter_name] : nil
+      end
+
+      def get_filter_id(name: nil, model: nil)
+        @grid.get_filter_name(name, model).parameterize('_')
+      end
+
+      def filter_options(name, options, with_id = true)
+        opts = {name: name}
+        if options.is_a?(Hash) && options.has_key?(:model)
+          model = options.delete(:model)
+          raise MightyGridArgumentError.new("Model of field for filtering should have type ActiveRecord") if model.present? && model.superclass != ActiveRecord::Base
+          opts.merge!(model: model)
+          options.merge!(id: get_filter_id(opts)) if with_id
+        end
+        opts
       end
   end
 end

data/lib/mighty_grid/helpers/mighty_grid_view_helpers.rb

@@ -58,7 +58,7 @@ module MightyGrid
           rendering.columns.map { |column|
             content_tag :th, column.th_attrs do
               if column.options[:ordering] && column.attribute.present?
-                link_to(column.title, "?#{MightyGrid::MgHash.rec_merge(grid.params, grid.order_params(column.attribute)).except('controller', 'action').to_query}").html_safe
+                link_to(column.title, "?#{MightyGrid::MgHash.rec_merge(grid.params, grid.order_params(column.attribute, column.model)).except('controller', 'action').to_query}").html_safe
               else
                 column.title.html_safe
               end

data/lib/mighty_grid/version.rb

@@ -1,3 +1,3 @@
 module MightyGrid
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/spec/fake_app/views/index.html.erb

@@ -15,6 +15,7 @@
 <%= grid @users_grid do |g| %>
   <% g.column :name %>
   <% g.column :role %>
+  <% g.column :is_banned %>
 <% end %>
 </body>
 </html>

data/spec/lib/base_spec.rb

@@ -5,7 +5,15 @@ describe MightyGrid::Base do
   before(:all) do
     @controller = ActionView::TestCase::TestController.new
 
-    @default_options = {page: 1, per_page: 15, name: 'grid', :include => nil, joins: nil}
+    @default_options = {
+      page: 1,
+      per_page: 15,
+      name: 'grid',
+      :include => nil,
+      joins: nil,
+      conditions: nil,
+      group: nil
+    }
   end
 
   describe '#new' do
@@ -102,10 +110,10 @@ describe MightyGrid::Base do
     before(:all){ @controller.params = {'grid'=>{'order' => 'name', 'order_direction' => 'asc'}} }
     subject { MightyGrid::Base.new(User, @controller) }
     context 'with current order attribute' do
-      it { subject.order_params(:name).should == {'grid'=>{order: :name, order_direction: 'desc'}} }
+      it { subject.order_params(:name).should == {'grid'=>{order: 'name', order_direction: 'desc'}} }
     end
     context 'with other order attribute' do
-      it { subject.order_params(:description).should == {'grid'=>{order: :description, order_direction: 'asc'}} }
+      it { subject.order_params(:description).should == {'grid'=>{order: 'description', order_direction: 'asc'}} }
     end
     after(:all){ @controller.params = {} }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mighty_grid
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - jurrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler