mighty_grid 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f2ecaf85f78ae13f5243d1a94d4bfd92c7c3b64
-  data.tar.gz: c28ac23cd0ac630310e35d8781ca3e35d653dde2
+  metadata.gz: 6b767e8e8c424d0fd0b2aa47ef21df2228781185
+  data.tar.gz: 6d6db95c86982b32d8bb99b3f75a6e6dbacada99
 SHA512:
-  metadata.gz: 53b34a9474a8a848a07970ba31888b17974460c5192f3163a0ff5dcc7d4d937c9ab004fa8688e004176e0745afb984e54041692ae68f67f6afc8a90e09d7653d
-  data.tar.gz: 70c3fd56f39318ab809a727a04fc1e8ec1a1938d6851fffce0587c9989a17536484d714ac0e2336bf2982ec50bf15848482c3d0eaf44d0783c5aa5ad6516295c
+  metadata.gz: d95807732eb29bdcd4f6261e0ee5d0e0d52490f548455464f62806846267913a1faf70866fa668d2ad2afbaa0178576d06c6f453d9c98f0e062caf229b915408
+  data.tar.gz: 9ee5f55ba15eabbde84ef511a5f170d31f50d0af2a8f73c8ab6639f9a57a2b6cfcd5e1eabebaf08238f102f43c719284a86e5693f59f3771e51af01e6a572083

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.0.0
   - 2.1.1
 
-script: bundle exec rake spec
+script: bundle exec rake spec cucumber
 
 before_script:
   - cp spec/fake_app/config/database.yml.example spec/fake_app/config/database.yml

data/Gemfile

@@ -7,6 +7,8 @@ group :test do
   gem "generator_spec"
   gem 'capybara'
   gem 'database_cleaner'
+  gem 'cucumber-rails'
+  gem 'spreewald'
 
   gem 'coveralls', require: false
   gem "codeclimate-test-reporter", require: nil

data/Rakefile

@@ -1,28 +1,16 @@
 require "bundler/gem_tasks"
 require 'appraisal'
 require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => :appraisal
 end
 
-desc 'Default: run unit tests.'
-task :default => "spec:all"
+desc 'Test the paperclip plugin.'
+RSpec::Core::RakeTask.new(:spec)
 
-namespace :spec do
-  %w(rails_32 rails_40 rails_41).each do |gemfile|
-    desc "Run tests against #{gemfile}"
-    task gemfile do
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
-    end
-  end
-
-  desc "Run all tests"
-  task :all do
-    %w(rails_32 rails_40 rails_41).each do |gemfile|
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
-    end
-  end
-end
+desc 'Run integration test'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format progress}
+end

data/features/filtering.feature

@@ -0,0 +1,42 @@
+Feature: Filtering
+
+  Background:
+    Given I generate 100 users
+
+  Scenario: Filtering by text_field
+    Given I am on the list of users page
+    When I fill in "Name" with "user001"
+    And I press "Apply changes"
+    Then I should see "user001"
+    And the "Name" field should contain "user001"
+    And I should see "1 of 1"
+
+  Scenario: Filtering by select
+    Given I am on the list of users page
+    When I select "Admin" from "Role"
+    And I press "Apply changes"
+    Then I should see "admin001"
+    And "Admin" should be selected for "Role"
+    And I should see "1 of 1"
+
+  Scenario: Filtering by checkox
+    Given I am on the list of users page
+    When I check "Banned"
+    And I press "Apply changes"
+    Then the "Banned" checkbox should be checked
+    And I should see "user101"
+    And I should see "1 of 1"
+
+  # Scenario: Reset filter
+  #   Given I am on the list of users page
+  #   When I fill in "Name" with "user001"
+  #   And I select "Admin" from "Role"
+  #   And I check "Banned"
+  #   And I press "Apply changes"
+  #   Then the "Name" field should contain "user001"
+  #   And "Admin" should be selected for "Role"
+  #   And the "Banned" checkbox should be checked
+  #   When I press "Reset changes"
+  #   Then the "Name" field should contain ""
+  #   And nothing should be selected for "Role"
+  #   And the "Banned" checkbox should not be checked

data/features/step_definitions/steps.rb

@@ -0,0 +1,5 @@
+Given /^I generate (\d+) users$/ do |n|
+  1.upto(n.to_i) {|i| User.create! :name => "user#{'%03d' % i}" }
+  User.create! :name => "admin#{'%03d' % 1}", role: :admin
+  User.create! :name => "user#{'%03d' % (n.to_i + 1)}", is_banned: true
+end

data/features/support/database_cleaner.rb

@@ -0,0 +1,12 @@
+begin
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+
+  DatabaseCleaner.strategy = :truncation
+rescue NameError
+  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+end
+
+# Around do |scenario, block|
+#   DatabaseCleaner.cleaning(&block)
+# end

data/features/support/env.rb

@@ -0,0 +1,17 @@
+begin
+  require 'rails'
+  require 'rails/generators'
+rescue LoadError
+end
+
+require 'capybara/cucumber'
+require 'bundler/setup'
+Bundler.require
+
+if defined? Rails
+  require_relative '../../spec/fake_app/rails_app'
+end
+
+require 'spreewald/web_steps'
+require 'spreewald/table_steps'
+require 'spreewald/development_steps'

data/features/support/paths.rb

@@ -0,0 +1,27 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.feature
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /^the list of users\s?page$/
+      '/users'
+
+    else
+      begin
+        page_name =~ /^the (.*) page$/
+        path_components = $1.split(/\s+/)
+        self.send(path_components.push('path').join('_').to_sym)
+      rescue NoMethodError, ArgumentError
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+      end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/gemfiles/rails_32.gemfile

@@ -10,6 +10,8 @@ group :test do
   gem "generator_spec"
   gem "capybara"
   gem "database_cleaner"
+  gem "cucumber-rails"
+  gem "spreewald"
   gem "coveralls", :require => false
   gem "codeclimate-test-reporter", :require => nil
   gem "pg", :require => false

data/gemfiles/rails_40.gemfile

@@ -10,6 +10,8 @@ group :test do
   gem "generator_spec"
   gem "capybara"
   gem "database_cleaner"
+  gem "cucumber-rails"
+  gem "spreewald"
   gem "coveralls", :require => false
   gem "codeclimate-test-reporter", :require => nil
   gem "pg", :require => false

data/gemfiles/rails_41.gemfile

@@ -10,6 +10,8 @@ group :test do
   gem "generator_spec"
   gem "capybara"
   gem "database_cleaner"
+  gem "cucumber-rails"
+  gem "spreewald"
   gem "coveralls", :require => false
   gem "codeclimate-test-reporter", :require => nil
   gem "pg", :require => false

data/lib/mighty_grid/base.rb

@@ -41,22 +41,29 @@ module MightyGrid
                     joins(@options[:joins])
     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
-        if @filters.has_key?(filter_name.to_sym) && Array === @filters[filter_name.to_sym] || field_type == :boolean
+        
+        if @filters.has_key?(filter_name.to_sym) && @filters[filter_name.to_sym].is_a?(Array)
           @relation = @relation.where(filter_name => filter_value)
+        elsif field_type == :boolean
+          value = ['true', '1', 't'].include?(filter_value) ? true : false
+          @relation = @relation.where(filter_name => value)
         elsif [:string, :text].include?(field_type)
           @relation = @relation.where("#{klass.table_name}.#{filter_name} #{like_operator} ?", "%#{filter_value}%")
         end
       end
     end
 
+    # Get controller parameters
     def params
       @controller.params
     end
 
+    # Load grid parameters
     def load_grid_params
       @mg_params = {}
       @mg_params.merge!(@options)
@@ -65,29 +72,36 @@ module MightyGrid
       end
     end
 
+    # Get current grid parameter by name
     def get_current_grid_param(name)
       current_grid_params.has_key?(name) ? current_grid_params[name] : nil
     end
 
+    # Get filter parameters
     def filter_params
       get_current_grid_param(filter_param_name) || {}
     end
 
+    # Get filter parameter name
     def filter_param_name; 'f' end
 
+    # Get filter name by field
     def get_filter_name(filter_name)
       "#{name}[#{filter_param_name}][#{filter_name}]"
     end
 
+    # Get current grid parameters
     def current_grid_params
       params[name] || {}
     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}}
     end
 
+    # Get current order direction
     def current_order_direction
       direction = nil
       if current_grid_params.has_key?('order_direction') && ['asc', 'desc'].include?(current_grid_params['order_direction'].downcase)
@@ -96,10 +110,12 @@ module MightyGrid
       direction
     end
 
+    # Get another order direction
     def another_order_direction
       (current_grid_params.has_key?('order_direction')) ? (['asc', 'desc'] - [current_grid_params['order_direction'].to_s]).first : MightyGrid.config.order_direction
     end
 
+    # Get <tt>like</tt> or <tt>ilike</tt> operator depending on the database adapter 
     def like_operator
       if ActiveRecord::ConnectionAdapters.const_defined?(:PostgreSQLAdapter) && ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
         'ILIKE'

data/lib/mighty_grid/filter_renderer.rb

@@ -8,7 +8,16 @@ module MightyGrid
 
     def label(name, content_or_options = nil, options = nil, &block)
       filter_name = @grid.get_filter_name(name).parameterize('_')
-      label_tag(filter_name, content_or_options, options, &block)
+
+      if content_or_options.is_a?(Hash)
+        options = content_or_options
+      else
+        name ||= content_or_options
+      end
+
+      name = @grid.klass.human_attribute_name(name)
+
+      label_tag(filter_name, name, options, &block)
     end
 
     def text_field(name, options={})
@@ -16,7 +25,6 @@ module MightyGrid
     end
 
     def select(name, option_tags=nil, options={})
-
       @grid.filters[name] = option_tags
       selected = nil
       selected = options.delete(:selected) if options.has_key?(:selected)

data/lib/mighty_grid/version.rb

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

data/spec/fake_app/models/active_record.rb

@@ -1,24 +1,25 @@
 # MODELS
-class Product < ActiveRecord::Base
+class User < ActiveRecord::Base
   belongs_to :company
 end
 
 class Company < ActiveRecord::Base
-  has_many :products
+  has_many :users
 end
 
 # MIGRATIONS
 class CreateAllTables < ActiveRecord::Migration
   def self.up
-    create_table(:products) { |t| t.string :name; t.text :description; t.integer :company_id }
-    create_table(:companies) { |t| t.string :name; t.text :description }
+    create_table(:users) { |t| t.string :name; t.string :role; t.integer :company_id; t.boolean :is_banned, default: false, null: false }
+    create_table(:companies) { |t| t.string :name; }
   end
 
   def self.down
-    drop_table :products
+    drop_table :users
     drop_table :companies
   end
 end
 
+CreateAllTables.down if User.table_exists? || Company.table_exists?
 ActiveRecord::Migration.verbose = false
 CreateAllTables.up

data/spec/fake_app/rails_app.rb

@@ -3,7 +3,7 @@ require 'action_view/railtie'
 
 require 'capybara/rspec'
 
-require 'fake_app/models/config'
+require_relative 'models/config'
 
 app = Class.new(Rails::Application)
 app.config.secret_token = '7295e7f2718c940f459e5062f575cd92'
@@ -18,17 +18,17 @@ app.initialize!
 
 # ROUTES
 app.routes.draw do
-  resources :products
+  resources :users
 end
 
 # MODELS
-require 'fake_app/models/active_record'
+require_relative 'models/active_record'
 
 # CONTROLLERS
 class ApplicationController < ActionController::Base; end
-class ProductsController < ApplicationController
+class UsersController < ApplicationController
   def index
-    @products_grid = init_grid(Product)
+    @users_grid = init_grid(User)
     render 'spec/fake_app/views/index', layout: false
   end
 end

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

@@ -1,8 +1,20 @@
-<%= mighty_filter_for @products_grid do |filter| %>
+<!DOCTYPE html>
+<html>
+<head></head>
+<body>
+<%= mighty_filter_for @users_grid do |filter| %>
+  <%= filter.label :name %>
   <%= filter.text_field :name %>
+  <%= filter.label :role %>
+  <%= filter.select :role, [:user, :publisher, :moderator, :admin].map{|r| [r.capitalize, r]}, prompt: 'Select role' %>
+  <label><%= filter.check_box :is_banned, 't' %> Banned</label>
   <%= filter.submit %>
+  <%= filter.reset %>
 <% end %>
 
-<%= grid @products_grid do |g| %>
-<% g.column :name %>
-<% end %>
+<%= grid @users_grid do |g| %>
+  <% g.column :name %>
+  <% g.column :role %>
+<% end %>
+</body>
+</html>

data/spec/lib/base_spec.rb

@@ -10,14 +10,14 @@ describe MightyGrid::Base do
 
   describe '#new' do
     context 'by default' do
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:params) { should == {} }
       its(:options) { should == @default_options }
       its(:mg_params) { should == @default_options }
       its(:filters) { should == {} }
       its(:name) { should == 'grid' }
-      its(:relation) { should == Product }
-      its(:klass) { should == Product }
+      its(:relation) { should == User }
+      its(:klass) { should == User }
       its(:current_grid_params) { should == {} }
       its(:current_order_direction) { should == nil }
       its(:another_order_direction) { should == 'asc' }
@@ -28,26 +28,26 @@ describe MightyGrid::Base do
     end
 
     context 'with custom' do
-      subject { MightyGrid::Base.new(Product, @controller, page: 2, per_page: 10, name: 'grid1') }
+      subject { MightyGrid::Base.new(User, @controller, page: 2, per_page: 10, name: 'grid1') }
       its(:options) { should == @default_options.merge(page: 2, per_page: 10, name: 'grid1') }
     end
 
     context 'with custom' do
       before(:all){ @controller.params = {'grid' => {page: 5, per_page: 30, name: 'grid2'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:params) { should == @controller.params }
       its(:mg_params) { should == @default_options.merge(page: 5, per_page: 30, name: 'grid2') }
       after(:all){ @controller.params = {} }
     end
 
     context 'with bad options' do
-      it { expect{MightyGrid::Base.new(Product, @controller, bad_option: 123)}.to raise_error(ArgumentError) }
+      it { expect{MightyGrid::Base.new(User, @controller, bad_option: 123)}.to raise_error(ArgumentError) }
     end
   end
 
   describe '#get_current_grid_param' do
     before(:all){ @controller.params = {'grid'=>{per_page: 30}} }
-    subject { MightyGrid::Base.new(Product, @controller).get_current_grid_param(:per_page) }
+    subject { MightyGrid::Base.new(User, @controller).get_current_grid_param(:per_page) }
     it { should == 30 }
     after(:all){ @controller.params = {} }
   end
@@ -55,21 +55,21 @@ describe MightyGrid::Base do
   describe '#current_order_direction' do
     context 'with ASC controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'asc'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:current_order_direction) { should == 'asc' }
       after(:all){ @controller.params = {} }
     end
 
     context 'with DESC controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'desc'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:current_order_direction) { should == 'desc' }
       after(:all){ @controller.params = {} }
     end
 
     context 'with BAD controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'bad'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:current_order_direction) { should == nil }
       after(:all){ @controller.params = {} }
     end
@@ -78,21 +78,21 @@ describe MightyGrid::Base do
   describe '#another_order_direction' do
     context 'with ASC controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'asc'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:another_order_direction) { should == 'desc' }
       after(:all){ @controller.params = {} }
     end
 
     context 'with DESC controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'desc'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:another_order_direction) { should == 'asc' }
       after(:all){ @controller.params = {} }
     end
 
     context 'with BAD controller param' do
       before(:all){ @controller.params = {'grid'=>{'order_direction' => 'bad'}} }
-      subject { MightyGrid::Base.new(Product, @controller) }
+      subject { MightyGrid::Base.new(User, @controller) }
       its(:another_order_direction) { should == 'asc' }
       after(:all){ @controller.params = {} }
     end
@@ -100,7 +100,7 @@ describe MightyGrid::Base do
 
   describe '#order_params' do
     before(:all){ @controller.params = {'grid'=>{'order' => 'name', 'order_direction' => 'asc'}} }
-    subject { MightyGrid::Base.new(Product, @controller) }
+    subject { MightyGrid::Base.new(User, @controller) }
     context 'with current order attribute' do
       it { subject.order_params(:name).should == {'grid'=>{order: :name, order_direction: 'desc'}} }
     end
@@ -111,7 +111,7 @@ describe MightyGrid::Base do
   end
 
   describe '#like_operator' do
-    subject { MightyGrid::Base.new(Product, @controller) }
+    subject { MightyGrid::Base.new(User, @controller) }
     context "when DB is #{ENV['DB']}" do
       case ENV['DB']
         when 'postgresql'

data/spec/lib/column_spec.rb

@@ -52,19 +52,19 @@ describe MightyGrid::Column do
   end
 
   describe '.render' do
-    let(:product){ Product.create(name: 'product name') }
+    let(:user){ User.create(name: 'user name') }
 
     describe 'with attribute' do
       subject(:column){ MightyGrid::Column.new(:name) }
       it 'should return attribute value' do
-        column.render(product).should == product[:name]
+        column.render(user).should == user[:name]
       end
     end
 
     describe 'with block' do
-      subject(:column){ MightyGrid::Column.new { "#{product.name} 1" } }
+      subject(:column){ MightyGrid::Column.new { "#{user.name} 1" } }
       it 'should return attribute value' do
-        column.render(product).should == "#{product[:name]} 1"
+        column.render(user).should == "#{user[:name]} 1"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mighty_grid
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - jurrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,11 @@ files:
 - app/views/kaminari/mighty_grid/_paginator.html.erb
 - app/views/kaminari/mighty_grid/_prev_page.html.erb
 - config/locales/en.yml
+- features/filtering.feature
+- features/step_definitions/steps.rb
+- features/support/database_cleaner.rb
+- features/support/env.rb
+- features/support/paths.rb
 - gemfiles/rails_32.gemfile
 - gemfiles/rails_40.gemfile
 - gemfiles/rails_41.gemfile
@@ -131,7 +136,6 @@ files:
 - spec/lib/base_spec.rb
 - spec/lib/column_spec.rb
 - spec/lib/generators/install_generator_spec.rb
-- spec/requests/products_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/database_cleaner.rb
@@ -162,6 +166,11 @@ signing_key:
 specification_version: 4
 summary: Flexible grid for Rails
 test_files:
+- features/filtering.feature
+- features/step_definitions/steps.rb
+- features/support/database_cleaner.rb
+- features/support/env.rb
+- features/support/paths.rb
 - spec/config_spec.rb
 - spec/fake_app/config/database.yml.example
 - spec/fake_app/models/active_record.rb
@@ -171,7 +180,6 @@ test_files:
 - spec/lib/base_spec.rb
 - spec/lib/column_spec.rb
 - spec/lib/generators/install_generator_spec.rb
-- spec/requests/products_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/database_cleaner.rb

data/spec/requests/products_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-feature 'Product' do
-  background { 1.upto(100) {|i| Product.create! :name => "product#{'%03d' % i}" } }
-
-  subject { page }
-
-  describe 'Index Page' do
-    before { visit '/products' }
-
-    it { should have_selector 'form.mighty-grid-filter' }
-    it { should have_selector 'table.mighty-grid' }
-    it { should have_selector 'ul.pagination' }
-  end
-
-  scenario 'filtering by fields' do
-    visit '/products'
-
-    product_name = Product.first.name
-    
-    within '.mighty-grid-filter' do
-      fill_in "grid_f_name", :with => product_name
-    end
-
-    click_button "Apply changes"
-
-    expect(page).to have_content product_name
-    expect(page).to have_content '1 of 1'
-  end
-
-end