Improve coding style in specs

Author: n-rodriguez

spec/ajax-datatables-rails/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe AjaxDatatablesRails::Base do
@@ -44,15 +46,15 @@
       context 'when data is defined as a hash' do
         let(:datatable) { ComplexDatatable.new(sample_params) }
 
-        it 'should return an array of hashes' do
+        it 'returns an array of hashes' do
           create_list(:user, 5)
           expect(datatable.data).to be_a(Array)
           expect(datatable.data.size).to eq 5
           item = datatable.data.first
           expect(item).to be_a(Hash)
         end
 
-        it 'should html escape data' do
+        it 'htmls escape data' do
           create(:user, first_name: 'Name "><img src=x onerror=alert("first_name")>', last_name: 'Name "><img src=x onerror=alert("last_name")>')
           data = datatable.send(:sanitize_data, datatable.data)
           item = data.first
@@ -64,15 +66,15 @@
       context 'when data is defined as a array' do
         let(:datatable) { ComplexDatatableArray.new(sample_params) }
 
-        it 'should return an array of arrays' do
+        it 'returns an array of arrays' do
           create_list(:user, 5)
           expect(datatable.data).to be_a(Array)
           expect(datatable.data.size).to eq 5
           item = datatable.data.first
           expect(item).to be_a(Array)
         end
 
-        it 'should html escape data' do
+        it 'htmls escape data' do
           create(:user, first_name: 'Name "><img src=x onerror=alert("first_name")>', last_name: 'Name "><img src=x onerror=alert("last_name")>')
           data = datatable.send(:sanitize_data, datatable.data)
           item = data.first
@@ -156,7 +158,7 @@ def paginate_records(records)
     describe '#as_json' do
       let(:datatable) { ComplexDatatable.new(sample_params) }
 
-      it 'should return a hash' do
+      it 'returns a hash' do
         create_list(:user, 5)
         data = datatable.as_json
         expect(data[:recordsTotal]).to eq 5
@@ -166,9 +168,9 @@ def paginate_records(records)
       end
 
       context 'with additional_data' do
-        it 'should return a hash' do
+        it 'returns a hash' do
           create_list(:user, 5)
-          expect(datatable).to receive(:additional_data){ { foo: 'bar' } }
+          expect(datatable).to receive(:additional_data) { { foo: 'bar' } }
           data = datatable.as_json
           expect(data[:recordsTotal]).to eq 5
           expect(data[:recordsFiltered]).to eq 5
@@ -184,7 +186,7 @@ def paginate_records(records)
     describe '#column_id' do
       let(:datatable) { ComplexDatatable.new(sample_params) }
 
-      it 'should return column id from view_columns hash' do
+      it 'returns column id from view_columns hash' do
         expect(datatable.column_id(:username)).to eq(0)
         expect(datatable.column_id('username')).to eq(0)
       end
@@ -194,7 +196,7 @@ def paginate_records(records)
       let(:datatable) { ComplexDatatable.new(sample_params) }
       before { datatable.params[:columns]['0'][:search][:value] = 'doe' }
 
-      it 'should return column data from params' do
+      it 'returns column data from params' do
         expect(datatable.column_data(:username)).to eq('doe')
         expect(datatable.column_data('username')).to eq('doe')
       end

spec/ajax-datatables-rails/datatable/column_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe AjaxDatatablesRails::Datatable::Column do
@@ -9,69 +11,69 @@
     let(:column) { datatable.datatable.columns.first }
 
     before do
-      datatable.params[:columns] = {'0'=>{'data'=>'username', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
+      datatable.params[:columns] = { '0' => { 'data' => 'username', 'name' => '', 'searchable' => 'true', 'orderable' => 'true', 'search' => { 'value' => 'searchvalue', 'regex' => 'false' } } }
     end
 
-    it 'should be orderable' do
+    it 'is orderable' do
       expect(column.orderable?).to eq(true)
     end
 
-    it 'should sort nulls last' do
+    it 'sorts nulls last' do
       expect(column.nulls_last?).to eq(false)
     end
 
-    it 'should be searchable' do
+    it 'is searchable' do
       expect(column.searchable?).to eq(true)
     end
 
-    it 'should be searched' do
+    it 'is searched' do
       expect(column.searched?).to eq(true)
     end
 
-    it 'should have connected to id column' do
+    it 'has connected to id column' do
       expect(column.data).to eq('username')
     end
 
     describe '#data' do
-      it 'should return the data from params' do
+      it 'returns the data from params' do
         expect(column.data).to eq 'username'
       end
     end
 
     describe '#source' do
-      it 'should return the data source from view_column' do
+      it 'returns the data source from view_column' do
         expect(column.source).to eq 'User.username'
       end
     end
 
     describe '#table' do
       context 'with ActiveRecord ORM' do
-        it 'should return the corresponding AR table' do
+        it 'returns the corresponding AR table' do
           expect(column.table).to eq User.arel_table
         end
       end
       context 'with other ORM' do
-        it 'should return the corresponding model' do
+        it 'returns the corresponding model' do
           expect(User).to receive(:respond_to?).with(:arel_table).and_return(false)
           expect(column.table).to eq User
         end
       end
     end
 
     describe '#model' do
-      it 'should return the corresponding AR model' do
+      it 'returns the corresponding AR model' do
         expect(column.model).to eq User
       end
     end
 
     describe '#field' do
-      it 'should return the corresponding field in DB' do
+      it 'returns the corresponding field in DB' do
         expect(column.field).to eq :username
       end
     end
 
     describe '#custom_field?' do
-      it 'should return false if field is bound to an AR field' do
+      it 'returns false if field is bound to an AR field' do
         expect(column.custom_field?).to be false
       end
     end
@@ -81,47 +83,47 @@
         expect(column.search).to be_a(AjaxDatatablesRails::Datatable::SimpleSearch)
       end
 
-      it 'should have search value' do
+      it 'has search value' do
         expect(column.search.value).to eq('searchvalue')
       end
 
-      it 'should not regex' do
+      it 'does not regex' do
         expect(column.search.regexp?).to eq false
       end
     end
 
     describe '#cond' do
-      it 'should be :like by default' do
+      it 'is :like by default' do
         expect(column.cond).to eq(:like)
       end
     end
 
     describe '#source' do
-      it 'should be :like by default' do
+      it 'is :like by default' do
         expect(column.source).to eq('User.username')
       end
     end
 
     describe '#search_query' do
-      it 'should buld search query' do
+      it 'bulds search query' do
         expect(column.search_query.to_sql).to include('%searchvalue%')
       end
     end
 
     describe '#sort_query' do
-      it 'should build sort query' do
+      it 'builds sort query' do
         expect(column.sort_query).to eq('users.username')
       end
     end
 
     describe '#use_regex?' do
-      it 'should be true by default' do
+      it 'is true by default' do
         expect(column.use_regex?).to be true
       end
     end
 
     describe '#delimiter' do
-      it 'should be - by default' do
+      it 'is - by default' do
         expect(column.delimiter).to eq('-')
       end
     end
@@ -131,7 +133,7 @@
     let(:datatable) { DatatableWithFormater.new(sample_params) }
     let(:column) { datatable.datatable.columns.find { |c| c.data == 'last_name' } }
 
-    it 'should be a proc' do
+    it 'is a proc' do
       expect(column.formatter).to be_a(Proc)
     end
   end
@@ -140,7 +142,7 @@
     let(:datatable) { DatatableCondProc.new(sample_params) }
     let(:column) { datatable.datatable.columns.find { |c| c.data == 'username' } }
 
-    it 'should be a proc' do
+    it 'is a proc' do
       config = column.instance_variable_get('@view_column')
       filter = config[:cond]
       expect(filter).to be_a(Proc)
@@ -205,17 +207,17 @@
 
   describe 'when empty column' do
     before do
-      datatable.params[:columns] = {'0'=>{'data'=>'', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
+      datatable.params[:columns] = { '0' => { 'data' => '', 'name' => '', 'searchable' => 'true', 'orderable' => 'true', 'search' => { 'value' => 'searchvalue', 'regex' => 'false' } } }
     end
 
     it 'raises error' do
-      expect { datatable.to_json }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchColumn).with_message("Unknown column. Check that `data` field is filled on JS side with the column name")
+      expect { datatable.to_json }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchColumn).with_message('Unknown column. Check that `data` field is filled on JS side with the column name')
     end
   end
 
   describe 'when unknown column' do
     before do
-      datatable.params[:columns] = {'0'=>{'data'=>'foo', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
+      datatable.params[:columns] = { '0' => { 'data' => 'foo', 'name' => '', 'searchable' => 'true', 'orderable' => 'true', 'search' => { 'value' => 'searchvalue', 'regex' => 'false' } } }
     end
 
     it 'raises error' do

spec/ajax-datatables-rails/datatable/datatable_spec.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe AjaxDatatablesRails::Datatable::Datatable do
 
   let(:datatable) { ComplexDatatable.new(sample_params).datatable }
   let(:datatable_json) { ComplexDatatable.new(sample_params_json).datatable }
-  let(:order_option) { {'0'=>{'column'=>'0', 'dir'=>'asc'}, '1'=>{'column'=>'1', 'dir'=>'desc'}} }
-  let(:order_option_json) { [{'column'=>'0', 'dir'=>'asc'}, {'column'=>'1', 'dir'=>'desc'}] }
+  let(:order_option) { { '0' => { 'column' => '0', 'dir' => 'asc' }, '1' => { 'column' => '1', 'dir' => 'desc' } } }
+  let(:order_option_json) { [{ 'column' => '0', 'dir' => 'asc' }, { 'column' => '1', 'dir' => 'desc' }] }
 
   shared_examples 'order methods' do
-    it 'should be orderable' do
+    it 'is orderable' do
       expect(datatable.orderable?).to eq(true)
     end
 
-    it 'should not be orderable' do
+    it 'is not orderable' do
       datatable.options[:order] = nil
       expect(datatable.orderable?).to eq(false)
     end
 
-    it 'should have 2 orderable columns' do
+    it 'has 2 orderable columns' do
       datatable.options[:order] = order_option
       expect(datatable.orders.count).to eq(2)
     end
@@ -38,7 +40,7 @@
   end
 
   shared_examples 'columns methods' do
-    it 'should have 4 columns' do
+    it 'has 4 columns' do
       expect(datatable.columns.count).to eq(6)
     end
 
@@ -60,12 +62,12 @@
   end
 
   describe 'search methods' do
-    it 'should be searchable' do
+    it 'is searchable' do
       datatable.options[:search][:value] = 'atom'
       expect(datatable.searchable?).to eq(true)
     end
 
-    it 'should not be searchable' do
+    it 'is not searchable' do
       datatable.options[:search][:value] = nil
       expect(datatable.searchable?).to eq(false)
     end

spec/ajax-datatables-rails/datatable/simple_order_spec.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe AjaxDatatablesRails::Datatable::SimpleOrder do
 
   let(:parent) { ComplexDatatable.new(sample_params) }
   let(:datatable) { parent.datatable }
-  let(:options) { ActiveSupport::HashWithIndifferentAccess.new({'column' => '1', 'dir' => 'desc'}) }
+  let(:options) { ActiveSupport::HashWithIndifferentAccess.new({ 'column' => '1', 'dir' => 'desc' }) }
   let(:simple_order) { AjaxDatatablesRails::Datatable::SimpleOrder.new(datatable, options) }
 
   describe 'option methods' do

spec/ajax-datatables-rails/datatable/simple_search_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe AjaxDatatablesRails::Datatable::SimpleSearch do
 
-  let(:options) { ActiveSupport::HashWithIndifferentAccess.new({'value' => 'search value', 'regex' => 'true'}) }
+  let(:options) { ActiveSupport::HashWithIndifferentAccess.new({ 'value' => 'search value', 'regex' => 'true' }) }
   let(:simple_search) { AjaxDatatablesRails::Datatable::SimpleSearch.new(options) }
 
   describe 'option methods' do