tramway-admin 1.31 → 1.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd6a8db1b87be8858fe60fc985278bb7089df3b5ffcc464c54f92959eafb6a5
-  data.tar.gz: 1d6e819e1964d4e44f4b74698c6083374a33a87144297ea684dfee658a06b614
+  metadata.gz: e35624ddbaec0ee1d1fe553d65d077e6a4deb17d810faa186091f02321f0f12d
+  data.tar.gz: df7588e7dcb03f22cb106e4828eeb509bb048d7f9b4e8d553cb24a9d26368dd9
 SHA512:
-  metadata.gz: e8ef80f822c82bc6e4e16ea5d026ce7e41aa229d1133050f9f727083714c6e94ccf81fe699171ccc27640b343f4d8975481304c074c61c105bc06ea58f1267be
-  data.tar.gz: 1bec37b0cfb951204769eef233e32d1750ed32d28a4c6b1b629ae761736586dcc6740bc9fbbae9d0cd5d31302e1697ae4603bee40deea41eca772df029d250e0
+  metadata.gz: d017beaa83e62658848a8dbd35216fdfbe120cc97ffea7961e0d199249d58f966fbbc61ab073d6fcb92332bba4b55293263890cb1f99d3fc73f1b0914c0e3020
+  data.tar.gz: c90255345820994d0a31c9e963e2057f2b4c65f9a5ae298e01969807c6e3ff1e818d972569fdd4e4ab172f28a24b7bb065f47df76329903aa8901499d3b29df4

data/README.md

@@ -106,13 +106,46 @@ class YourModelDecorator < Tramway::Core::ApplicationDecorator
     def collections
       [ :all, :scope1, :scope2 ]
     end
+    
+    def list_filters
+      {
+        filter_name: {
+          type: :select,
+          select_collection: filter_collection,
+          query: lambda do |list, value|
+            list.where some_attribute: value
+          end
+        },
+        date_filter_name: {
+          type: :dates,
+          query: lambda do |list, begin_date, end_date|
+            list.where 'created_at > ? AND created_at < ?', begin_date, end_date
+          end
+        }
+      }
+    end
   end
   
   delegate :title, to: :object
 end
 ```
 
-**NOTE:** `collections` methods must return array of scopes of `YourModel`. Every collection will be a tab in a list of your model in admin panel.
+**NOTES:**
+* `collections` method must return array of scopes of `YourModel`. Every collection will be a tab in a list of your model in admin panel
+* `list_filters` method returns hash of filters where:
+  * select_collection - collection which will be in the select of filter. It must be compatible with [options_for_select](https://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/options_for_select) method
+  * query - some Active Record query which be used as a filter of records
+
+Filters naming:
+
+```yaml
+en:
+  tramway:
+    admin:
+      filters:
+        model_name:
+          filter_name: You Filter
+```
 
 #### 10. Add inheritance to YourModel
 
@@ -140,6 +173,24 @@ class Admin::YourModelForm < Tramway::Core::ApplicationForm
   end
 end
 ```
+
+### 12. You can add search to your index page
+
+Tramway use gem [PgSearch](https://github.com/Casecommons/pg_search`) as search engine
+
+Just add `search` method to `YourModel` like this
+
+```ruby
+search_by *attributes, **associations # `attributes` and `associations` should be the same syntax as in PgSearch
+```
+
+Example:
+
+```ruby
+class YourModel < Tramway::Core::ApplicationRecord
+  search_by :my_attribute, :another_attribute, my_association: [ :my_association_attribute, :another_my_association_attribute ]
+```
+
 #### 12. Run server `rails s`
 #### 13. Launch `localhost:3000/admin`
 

data/app/assets/stylesheets/tramway/admin/application.sass

@@ -31,3 +31,18 @@ td.actions
   height: auto
   max-height: 30em
   overflow-x: hidden
+
+.row-fluid.filters
+  width: 100%
+  display: flex
+
+  select
+    width: 100%
+
+  .submit
+    display: flex
+    flex-direction: row-reverse
+
+  .dates_filter
+    display: flex
+    flex-direction: row

data/app/controllers/tramway/admin/application_controller.rb

@@ -34,8 +34,17 @@ module Tramway
           records = records.send "#{current_admin.role}_scope", current_admin.id
           records = records.ransack(params[:filter]).result if params[:filter].present?
           params[:list_filters]&.each do |filter, value|
-            if value.present?
-              records = decorator_class.list_filters[filter.to_sym][:query].call(records, value)
+            case decorator_class.list_filters[filter.to_sym][:type]
+            when :select
+              records = decorator_class.list_filters[filter.to_sym][:query].call(records, value) if value.present?
+            when :dates
+              begin_date = params[:list_filters][filter.to_sym][:begin_date]
+              end_date = params[:list_filters][filter.to_sym][:end_date]
+              if begin_date.present? && end_date.present?
+                if value.present?
+                  records = decorator_class.list_filters[filter.to_sym][:query].call(records, begin_date, end_date)
+                end
+              end
             end
           end
           hash.merge! collection => records.count
@@ -97,7 +106,9 @@ module Tramway
         #  model: params[:model]
         # )
         # raise "Looks like model #{params[:model]} is not included to tramway-admin for `#{current_admin.role}` role. Add it in the `config/initializers/tramway.rb`. This way `Tramway::Admin.set_available_models(#{params[:model]})`"
-        Tramway::Admin.forms.include? params[:form].underscore.sub(%r{^admin/}, '').sub(/_form$/, '')
+        if params[:form].present?
+          Tramway::Admin.forms.include? params[:form].underscore.sub(%r{^admin/}, '').sub(/_form$/, '')
+        end
       end
 
       def available_scope_given?

data/app/controllers/tramway/admin/records_controller.rb

@@ -7,8 +7,17 @@ class Tramway::Admin::RecordsController < ::Tramway::Admin::ApplicationControlle
     records = records.full_text_search params[:search] if params[:search].present?
     records = records.ransack(params[:filter]).result if params[:filter].present?
     params[:list_filters]&.each do |filter, value|
-      if value.present?
-        records = decorator_class.list_filters[filter.to_sym][:query].call(records, value)
+      case decorator_class.list_filters[filter.to_sym][:type]
+      when :select
+        records = decorator_class.list_filters[filter.to_sym][:query].call(records, value) if value.present?
+      when :dates
+        begin_date = params[:list_filters][filter.to_sym][:begin_date]
+        end_date = params[:list_filters][filter.to_sym][:end_date]
+        if begin_date.present? && end_date.present?
+          if value.present?
+            records = decorator_class.list_filters[filter.to_sym][:query].call(records, begin_date, end_date)
+          end
+        end
       end
     end
     records = records.send "#{current_admin.role}_scope", current_admin.id

data/app/views/tramway/admin/records/_list.html.haml

@@ -19,9 +19,9 @@
             = record.send attribute
         %td.actions
           .row
-            &nbsp&nbsp&nbsp
+               
             = link_to fa_icon('pencil-alt'), edit_current_model_record_path(record.id), class: 'btn btn-warning btn-xs'
-            &nbsp&nbsp
+              
             = delete_button url: current_model_record_path(record.id), form_options: { class: :smart_button }, button_options: { class: 'btn btn-xs btn-danger' } do
               = fa_icon 'trash-alt'
           %br

data/app/views/tramway/admin/records/_search.html.haml

@@ -1,15 +1,35 @@
 - if searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
-  .col-md-6
+  .col-md-8
     .search
-      = form_tag records_path, method: :get do |f|
-        .form-group.text
-          .input-group
-            - if searchable_model?(model_class)
-              = text_field_tag :search, params[:search], class: 'text form-control'
-            = hidden_field_tag :model, params[:model]
-            = hidden_field_tag :scope, params[:scope]
-            = hidden_field_tag :filter, params[:filter]
-            - decorator_class(model_class).list_filters.each do |filter|
-              = select_tag "list_filters[#{filter[0]}]", build_options_for_select(filter[0], filter[1][:select_collection]), include_blank: true, class: 'form-control'
-            .input-group-append
-              = submit_tag t('helpers.actions.search'), class: 'btn btn-primary'
+      = form_tag records_path, class: 'form-inline', method: :get do |f|
+        - if searchable_model?(model_class)
+          = text_field_tag :search, params[:search], class: 'text form-control'
+        = hidden_field_tag :model, params[:model]
+        = hidden_field_tag :scope, params[:scope]
+        = hidden_field_tag :filter, params[:filter]
+        - decorator_class(model_class).list_filters.each_slice(3) do |slice|
+          .row-fluid.filters
+            - slice.each do |filter|
+              - case filter[1][:type]
+              - when :select
+                .col-md-4
+                  = label_tag t("admin.filters.#{model_class.to_s.underscore}.#{filter[0]}")
+                  = select_tag "list_filters[#{filter[0]}]", build_options_for_select(filter[0], filter[1][:select_collection]), include_blank: true, class: 'form-control'
+              - when :dates
+                .col-md-8.dates_filter
+                  .begin_date
+                    = label_tag t("admin.filters.#{model_class.to_s.underscore}.#{filter[0]}.begin_date")
+                    = text_field_tag "list_filters[#{filter[0]}][begin_date]", '', class: 'form-control', id: 'filter_datepicker_begin_date', value: params.dig(:list_filters, filter[0], :begin_date)
+                  %span
+                    \ -
+                  .end_date
+                    = label_tag t("admin.filters.#{model_class.to_s.underscore}.#{filter[0]}.end_date")
+                    = text_field_tag "list_filters[#{filter[0]}][end_date]", '', class: 'form-control', id: 'filter_datepicker_end_date', value: params.dig(:list_filters, filter[0], :end_date)
+                :javascript
+                  $(function () {
+                    $('#filter_datepicker_begin_date').datepicker();
+                    $('#filter_datepicker_end_date').datepicker();
+                  });
+        .row-fluid.filters
+          .col-md-4.offset-md-8.submit
+            = submit_tag t('helpers.actions.search'), class: 'btn btn-primary'

data/app/views/tramway/admin/records/index.html.haml

@@ -5,7 +5,8 @@
 - tabs = get_collection
 .page-header
   .row
-    .col-md-6
+    - search_render_show = searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
+    %div{ class: "col-md-#{search_render_show ? 4 : 12}" }
       %h1
         = current_title
         = link_to fa_icon(:plus), new_current_model_record_path, class: 'btn btn-primary'

data/lib/tramway/admin/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Admin
-    VERSION = '1.31'
+    VERSION = '1.32.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-admin
 version: !ruby/object:Gem::Version
-  version: '1.31'
+  version: 1.32.1
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap-kaminari-views