wice_grid_ms 3.6.0

data/release_notes/RELEASE_NOTES_3.2.pre1.rdoc

@@ -0,0 +1,81 @@
+1. Support for Prototype has been dropped. No hard feelings, Prototype, no matter what
+   others say, I liked you :)
+
+2. All assets are in the asset pipeline. All javascript is now coffeescript. No more Rails
+   2 legacy in the form of obtrusive javascript in the HTML page. The styles file is copied
+   to the application asset directory by a generate task so that is it easy to modify it to
+   the application needs. The javascript and images are loaded from the plugin. Read the
+   Installation section in README for details. Thanks to the asset pipeline taking care of
+   loading assets for us, methods +include_wice_grid_assets+, +names_of_wice_grid_stylesheets+,
+   and +names_of_wice_grid_javascripts+ have been removed
+
+3. ERB mode has been removed. It had never been used by anyone and is bad style anyway. In
+   case you have no idea what it was, here's what it was:
+
+      <% grid(@countries_grid, :erb_mode => true) do |g| %>
+        <% g.column :column_name => 'Name', :attribute_name => 'name' do |country| %>
+          <b>Name: <%= link_to(country.name, country_path(country)) %></b>
+        <% end %>
+      <% end -%>
+
+4. WiceGrid is compatible with Twitter Bootstrap out of the box.
+
+5. Paths to various images used by WiceGrid have been removed from the configuration file
+   and are now defined only in the css file. Developers are encouraged to modify
+   <tt>wice_grid.scss</tt> to use other images and to change the styles in general.
+
+6. The markup and css classes that WiceGrid generates have changed, and CSS for older versions
+   of WiceGrid might not work. Inspect the source code.
+
+7. Parameter names in the grid helper have been renamed:
+   * <tt>:table_html_attrs</tt> becomes <tt>:html</tt>
+   * <tt>:header_tr_html_attrs</tt> becomes <tt>:header_tr_html</tt>
+
+8. Parameter names in column definitions have been renamed:
+   * <tt>:column_name</tt> becomes <tt>:name</tt>
+   * <tt>:attribute_name</tt> becomes <tt>:attribute</tt>
+   * <tt>:model_class</tt> becomes <tt>:model</tt>
+   * <tt>:allow_ordering</tt>  becomes <tt>:ordering</tt>
+   * <tt>:td_html_attrs</tt>  becomes <tt>:html</tt>
+   * Negation in the parameter name does not contribute to the simplicity of an API, so
+     <tt>:no_filter</tt> in  becomes <tt>:filter</tt>. Consequently, <tt>:no_filter => true</tt>
+     becomes <tt>:filter => false</tt>
+   * <tt>:negation_in_filter</tt> becomes <tt>:negation</tt>
+
+
+9. New configuration parameter <tt>DEFAULT_TABLE_CLASSES</tt> contains CSS classes added to
+   all WiceGrid tables by default.
+
+10. In previous versions of WiceGrid in the jQuery mode DateTime filters used to automatically
+    fall back on Rails DateTime helpers due to absence of time controls in jQuery DatePicker.
+    In version 3.2 this behavior has been changed to always use jQuery DatePicker, even with
+    DateTime filters. Of course it is possible to force  Rails DateTime with
+    <tt>:helper_style => :standard</tt> in the column definition.
+
+11. The second variable injected into to <tt>before_row</tt> and <tt>after_row</tt> block,
+    and the first parameter injected into the <tt>last_row</tt> is the number of columns in
+    the current grid.
+
+12. <tt>:csv_field_separator</tt> is a new parameter for +initialize_grid+ defining the field
+    separator in CSV files. The default separator is defined by +CSV_FIELD_SEPARATOR+ in the
+    config file.
+
+13. New parameter +:confirm+ for +saved_queries_panel+ which turns on or off the JS confirm
+    dialogs when deleting saved queries.
+
+14. Instead of the old rake task creating a table for serialized queries a generator has been
+    added which adds a migration file to +db/migrations+.
+
+15. Instead of using helpers +submit_grid_javascript+ and +reset_grid_javascript+ to create
+    external Submit and Reset buttons all you have to do is add a button or any other
+    clickable HTML element with class +wg-external-submit-button+ or +wg-external-reset-button+,
+    and attribute +data-grid-name+ whose value is the name of the grid:
+
+      <button class="wg-external-submit-button" data-grid-name="grid">Submit</button>
+      <button class="wg-external-reset-button" data-grid-name="grid">Reset</button>
+
+
+    The same goes for the external CSV export button, only the CSS class is
+    +wg-external-csv-export-button+:
+
+      <button class="wg-external-csv-export-button" data-grid-name="grid">Export To CSV</button>

data/release_notes/RELEASE_NOTES_3.2.pre2.rdoc

@@ -0,0 +1,6 @@
+1. +will_paginate+ is replaced by +kaminari+.
+2. The detached filter API has changed. No more magical invocation of the +grid+ helper two times.
+   First, +define_grid+ is used in the same way as +grid+, then +grid_filter+,
+   and then <tt>render_grid(@grid)</tt> to actually output the grid table .
+3. No more polluting core Ruby classes like Hash and Array with methods. All such methods
+   are now private to the plugin.

data/release_notes/RELEASE_NOTES_3.3.0.rdoc

@@ -0,0 +1,21 @@
+the with_paginated_resultset callback receives an ActiveRelation object, not a lambda
+
+Wice::Defaults::DATEPICKER_YEAR_RANGE added to the config to define the default year range in Datepicker (https://github.com/leikind/wice_grid/issues/61)
+
+improvement of the javascript calendar control: if the FROM field is set to a value after TO, TO is set to the value of FROM. Vice versa: if the TO field is set to a value before FROM, FROM is set to the value of TO
+
+New view helpers filter_and_order_state_as_hash(grid) and filter_state_as_hash(grid)
+
+<caption> supported
+
+support for Ruby 2.0
+
+2 errors fixed in the Saved Queries UI ( https://github.com/leikind/wice_grid/issues/89 )
+
+bug fixed: extra_request_parameters not propagating to the pagination panel
+
+README: made it clear that Datepicker has to be installed separately
+
+README: made it clear that css is basis and that Twitter Bootstrap is supported
+
+

data/spec/schema.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+ActiveRecord::Schema.define(version: 20150713103513) do
+  create_table 'dummies', force: :cascade do |t|
+    t.string 'name'
+
+    t.datetime 'created_at'
+    t.datetime 'updated_at'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rspec'
+require 'coveralls'
+require 'codeclimate-test-reporter'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    Coveralls::SimpleCov::Formatter,
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+]
+SimpleCov.start
+
+begin
+  require 'support/active_record'
+  require 'action_controller'
+  require 'action_view'
+  require 'csv'
+
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+rescue LoadError
+  puts 'LoadError'
+end
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'wice_grid'
+require 'support/wice_grid_test_config'
+
+ActiveRecord::ConnectionAdapters::Column.send(:include, ::Wice::WiceGridExtentionToActiveRecordColumn)
+
+::Wice.on_action_view_load
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+load 'spec/schema.rb'
+
+class Dummy < ActiveRecord::Base
+end
+
+Dummy.create(name: 'test')

data/spec/support/wice_grid_test_config.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+
+# Default number of rows to show per page.
+Wice::Defaults::PER_PAGE = 20
+
+# Default order direction
+Wice::Defaults::ORDER_DIRECTION = 'asc'
+
+# Default name for a grid. A grid name is the basis for a lot of
+# names including parameter names, DOM IDs, etc
+# The shorter the name is the shorter the request URI will be.
+Wice::Defaults::GRID_NAME = 'grid'
+
+# If REUSE_LAST_COLUMN_FOR_FILTER_ICONS is true and the last column doesn't have any filter and column name, it will be used
+# for filter related icons (filter icon, reset icon, show/hide icon), otherwise an additional table column is added.
+Wice::Defaults::REUSE_LAST_COLUMN_FOR_FILTER_ICONS = true
+
+# The label of the first option of a custom dropdown list meaning 'All items'
+Wice::Defaults::CUSTOM_FILTER_ALL_LABEL = '--'
+
+# A list of classes for the table tag of the grid
+Wice::Defaults::DEFAULT_TABLE_CLASSES = ['table', 'table-bordered', 'table-striped']
+
+# Allow switching between a single and multiple selection modes in custom filters (dropdown boxes)
+Wice::Defaults::ALLOW_MULTIPLE_SELECTION = true
+
+# Show the upper pagination panel by default or not
+Wice::Defaults::SHOW_UPPER_PAGINATION_PANEL = false
+
+# Disabling CSV export by default
+Wice::Defaults::ENABLE_EXPORT_TO_CSV = false
+
+# Default CSV field separator
+Wice::Defaults::CSV_FIELD_SEPARATOR = ','
+
+# Default CSV encoding
+Wice::Defaults::CSV_ENCODING = nil
+
+# The strategy when to show the filter.
+# * <tt>:when_filtered</tt> - when the table is the result of filtering
+# * <tt>:always</tt>        - show the filter always
+# * <tt>:no</tt>            - never show the filter
+Wice::Defaults::SHOW_FILTER = :always
+
+# A boolean value specifying if a change in a filter triggers reloading of the grid.
+Wice::Defaults::AUTO_RELOAD = false
+
+# SQL operator used for matching strings in string filters.
+Wice::Defaults::STRING_MATCHING_OPERATOR = 'LIKE'
+# STRING_MATCHING_OPERATOR = 'ILIKE' # Use this for Postgresql case-insensitive matching.
+
+# Defining one string matching operator globally for the whole application turns is not enough
+# when you connect to two databases one of which is MySQL and the other is Postgresql.
+# If the key for an adapter is missing it will fall back to Wice::Defaults::STRING_MATCHING_OPERATOR
+Wice::Defaults::STRING_MATCHING_OPERATORS = {
+    'ActiveRecord::ConnectionAdapters::MysqlAdapter' => 'LIKE',
+    'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter' => 'ILIKE'
+}
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                              Advanced Filters                             #
+
+# Switch of the negation checkbox in all text filters
+Wice::Defaults::NEGATION_IN_STRING_FILTERS = false
+
+# Each WiceGrid filter column is defined in two classes, one used for rendering the filter, the other
+# for generating query conditions. All these columns are in lib/wice/columns/*.rb .
+# File lib/wice/columns/column_processor_index.rb lists all predefined processors.
+# In most cases a processor is chosen automatically based on the DB column type,
+# for example, integer columns
+# can have two of processors, the default one with one input field, and a processor called "range",
+# with 2 input fields. In this case it is possible to specify a processor in the column definition:
+#
+#     g.column filter_type: :range
+#
+# It is also possible to define you own processors:
+#
+#     Wice::Defaults::ADDITIONAL_COLUMN_PROCESSORS = {
+#       some_key_identifying_new_column_type:  ['AViewColumnProcessorClass', 'ConditionsGeneratorClass'],
+#       another_key_identifying_new_column_type:  ['AnotherViewColumnProcessorClass', 'AnotherConditionsGeneratorClass']
+#     }
+#
+# Column processor keys/names should not coincide with the existing keys/names (see lib/wice/columns/column_processor_index.rb)
+# the value is a 2-element array with 2 strings, the first should be a name of view processor class inherited from
+# Wice::Columns::ViewColumn, the second should be a name of conditions generator class inherited from
+# Wice::Columns::ConditionsGeneratorColumn .
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                              Showing All Records                          #
+
+# Enable or disable showing all records (non-paginated table)
+Wice::Defaults::ALLOW_SHOWING_ALL_RECORDS = true
+
+# If number of all queries is more than this value, the user will be given a warning message
+Wice::Defaults::START_SHOWING_WARNING_FROM = 100
+
+# Hide the "show all" link if the number of all records is more than...
+# Force-resets back to pagination starting from this value.
+# Set to nil to always show it
+Wice::Defaults::SHOW_ALL_ALLOWED_UP_TO = nil
+
+#
+# set to nil to skip the check
+Wice::Defaults::SWITCH_BACK_TO_PAGINATION_FROM = nil
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                               Saving Queries                              #
+
+# ActiveRecord model to store queries. Read the documentation for details
+# QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
+Wice::Defaults::QUERY_STORE_MODEL = 'WiceGridSerializedQuery'
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#            Here go settings related to the calendar helpers               #
+
+# The default style of the date and datetime helper
+# * <tt>:calendar</tt> - JS calendar
+# * <tt>:html5</tt> - HTML5 date input field
+# * <tt>:standard</tt> - standard Rails date and datetime helpers
+# * <tt>:bootstrap</tt> - Bootstrap datepicker helper
+Wice::Defaults::HELPER_STYLE = :calendar
+
+# Format of the datetime displayed.
+# If you change the format, make sure to check if +DATETIME_PARSER+ can still parse this string.
+Wice::Defaults::DATETIME_FORMAT = '%Y-%m-%d %H:%M'
+
+# Format of the date displayed.
+# If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
+Wice::Defaults::DATE_FORMAT = '%Y-%m-%d'
+
+# Format of the date displayed in jQuery's Datepicker
+# If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
+Wice::Defaults::DATE_FORMAT_JQUERY = 'yy-mm-dd'
+
+# Format of the date displayed in Bootstrap's Datepicker
+# If you change the format, make sure to check if +DATE_PARSER+ can still parse this string.
+Wice::Defaults::DATE_FORMAT_BOOTSTRAP = 'yyyy-mm-dd'
+
+# With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
+# format defined by +DATETIME_FORMAT+ and must generate a DateTime object.
+# In many cases <tt>Time.zone.parse</tt> is enough, for instance,  <tt>%Y-%m-%d</tt>. If you change the format, make sure to check this code
+# and modify it if needed.
+Wice::Defaults::DATETIME_PARSER = lambda do |datetime_string|
+  if datetime_string.blank?
+    nil
+  elsif Time.zone
+    Time.zone.parse(datetime_string)
+  else
+    Time.parse(datetime_string)
+  end
+end
+
+# The range of years to display in jQuery Datepicker.
+# It can always be changed dynamically with the following javascript:
+#  $( ".hasDatepicker" ).datepicker( "option", "yearRange", "2000:2042" );
+Wice::Defaults::DATEPICKER_YEAR_RANGE = (from = Date.current.year - 10).to_s + ':' + (from + 15).to_s
+
+# With Calendar helpers enabled the parameter sent is the string displayed. This lambda will be given a date string in the
+# format defined by +DATETIME+ and must generate a Date object.
+# In many cases <tt>Date.parse</tt> is enough, for instance,  <tt>%Y-%m-%d</tt>. If you change the format, make sure to check this code
+# and modify it if needed.
+Wice::Defaults::DATE_PARSER = lambda do |date_string|
+  if date_string.blank?
+    nil
+  else
+    begin
+      Date.parse(date_string)
+    rescue ArgumentError
+      nil
+    end
+  end
+end
+
+# The name of the page method (should correspond to Kaminari.config.page_method_name)
+Wice::Defaults::PAGE_METHOD_NAME = :page

data/spec/wice/grid_output_buffer_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+describe Wice::GridOutputBuffer do
+  FILTER_COMMON_CODE = 'here filter code'
+
+
+  let(:buffer){Wice::GridOutputBuffer.new}
+
+  it 'should to_s' do
+    expect(buffer.to_s.class).to eq(ActiveSupport::SafeBuffer)
+  end
+
+  it 'should add_filter' do
+
+    expect(buffer.add_filter('key', FILTER_COMMON_CODE)).to eq(FILTER_COMMON_CODE)
+  end
+
+  it 'should filter_for' do
+
+    buffer.add_filter('key', FILTER_COMMON_CODE)
+    expect(buffer.filter_for('key')).to eq(FILTER_COMMON_CODE)
+  end
+
+  it 'should filter_for 2 times' do
+    buffer.add_filter('key', FILTER_COMMON_CODE)
+
+    expect(buffer.filter_for('key')).to eq(FILTER_COMMON_CODE)
+    expect { buffer.filter_for('key') }.to raise_error
+  end
+
+  it 'should filter_for without filters' do
+
+    expect { buffer.filter_for('key') }.to raise_error
+  end
+
+  it 'should filter_for return empty string' do
+    buffer.return_empty_strings_for_nonexistent_filters = true
+
+    expect(buffer.filter_for('key')).to eq('')
+  end
+end

data/spec/wice/table_column_matrix_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+describe Wice::TableColumnMatrix do
+  let(:general_conditions){ 'conditions' }
+
+  let(:table){ Wice::TableColumnMatrix.new }
+
+  it 'should new' do
+    expect(table.class).to eq(Wice::TableColumnMatrix)
+  end
+
+  it 'should add_condition' do
+
+    table.add_condition('key', general_conditions)
+
+    expect(table.conditions).to include(general_conditions)
+  end
+
+  it 'should set default_model_class' do
+
+    table.default_model_class = Dummy
+
+    expect(table.class).to eq(Wice::TableColumnMatrix)
+  end
+
+  it 'should get column' do
+
+    table.default_model_class = Dummy
+
+    expect(Dummy.columns).to include(table.get_column_by_model_class_and_column_name(Dummy, :name))
+    expect(Dummy.columns).to include(table.get_column_in_default_model_class_by_column_name(:name))
+  end
+
+  it 'should get column not initialized' do
+
+    expect { table.get_column_in_default_model_class_by_column_name(:name) }.to raise_error
+  end
+end