tramway-admin 1.30 → 1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a3193abc0ba418d70dc16809e03ed0dc6d81d7b426a7a0f14db0343cfcd3e54
-  data.tar.gz: b39d546781c693843e04dd1ed2a06ae50179e6880ee43217a4abb28330068fb0
+  metadata.gz: da3bc56fc776dfe427a596e31529b9f8c3c6f97db1db373931afb3e113c1ecdd
+  data.tar.gz: 4a8f36847d9ec84316bd18fa0633baf3c50177a9f29b4ef847a5c16bb683acfe
 SHA512:
-  metadata.gz: 9c68c4efbc9a38d060b1551e2873285238e08c3f64f87eb06652ecd49494f883b822e4683d95e1dcafa8d018ddba4885a11391833064842011bb3419d8b46c91
-  data.tar.gz: 767f2cc010f4255c29b33f24c42baf092214aba1d086d55e15c3fdd7ef0d8dd69d41e23f039301e85394a33c930ff2867550599345523a04955a8e68cc8b3c1e
+  metadata.gz: ef3fceeab511ec3eea980f77ce39de35f6447c91e191f79563751704fbd45adb2949619b04eaad84516a952c21ad415a3fbe64efdc6c1540c82bd228ddfa4ff1
+  data.tar.gz: b73d51193a4ea7d0ed2810538146bc8154f29e7640a175356b4ab1dc71ef8ce8392908f77eabcf55ae5ad2453218b384d92c9b9336366ea44c31b7cefecedf0d

data/README.md

@@ -99,12 +99,23 @@ Tramway::Admin.navbar_structure(
 
 #### 9. Create decorator for models
 
-*app/decorators/your_model_decorator.rb
+*app/decorators/your_model_decorator.rb*
 ```ruby
 class YourModelDecorator < Tramway::Core::ApplicationDecorator
   class << self
     def collections
-      [ :all ]
+      [ :all, :scope1, :scope2 ]
+    end
+    
+    def list_filters
+      {
+        filter_name: {
+          select_collection: filter_collection,
+          query: lambda do |list, value|
+            list.where some_attribute: value
+          end
+        }
+      }
     end
   end
   
@@ -112,6 +123,12 @@ class YourModelDecorator < Tramway::Core::ApplicationDecorator
 end
 ```
 
+**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
+
 #### 10. Add inheritance to YourModel
 
 *app/models/your_model.rb*
@@ -138,6 +155,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,14 @@ 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

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

@@ -33,6 +33,18 @@ module Tramway
           records = model_class.active.send(collection)
           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|
+            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?
+                records = decorator_class.list_filters[filter.to_sym][:query].call(records, begin_date, end_date) if value.present?
+              end
+            end
+          end
           hash.merge! collection => records.count
         end
       end
@@ -91,8 +103,10 @@ module Tramway
         #  :tramway, :admin, :application_controller, :form_given, :model_not_included_to_tramway_admin,
         #  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$/, '')
+        # 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]})`"
+        if params[:form].present?
+          Tramway::Admin.forms.include? params[:form].underscore.sub(%r{^admin/}, '').sub(/_form$/, '')
+        end
       end
 
       def available_scope_given?
@@ -110,6 +124,7 @@ module Tramway
       def current_admin
         user = Tramway::User::User.find_by id: session[:admin_id]
         return false unless user
+
         Tramway::User::UserDecorator.decorate user
       end
 
@@ -121,7 +136,9 @@ module Tramway
       end
 
       def authenticate_admin!
-        redirect_to '/admin/session/new' if !current_admin && !request.path.in?(['/admin/session/new', '/admin/session'])
+        if !current_admin && !request.path.in?(['/admin/session/new', '/admin/session'])
+          redirect_to '/admin/session/new'
+        end
       end
     end
   end

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

@@ -6,6 +6,18 @@ class Tramway::Admin::RecordsController < ::Tramway::Admin::ApplicationControlle
     records = model_class.active.order(id: :desc).send scope
     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|
+      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?
+          records = decorator_class.list_filters[filter.to_sym][:query].call(records, begin_date, end_date) if value.present?
+        end
+      end
+    end
     records = records.send "#{current_admin.role}_scope", current_admin.id
     @records = decorator_class.decorate records.page params[:page]
   end

data/app/helpers/tramway/admin/application_helper.rb

@@ -29,6 +29,7 @@ module Tramway
       def current_admin
         user = Tramway::User::User.find_by id: session[:admin_id]
         return false unless user
+
         Tramway::User::UserDecorator.decorate user
       end
     end

data/app/helpers/tramway/admin/records_helper.rb

@@ -47,6 +47,11 @@ module Tramway::Admin
       model_class.methods.include? :full_text_search
     end
 
+    def build_options_for_select(name, collection)
+      selected_value = params[:list_filters].present? ? params[:list_filters][name] : nil
+      options_for_select(collection, selected_value)
+    end
+
     def admin_index_path_of_model(model_class, tab, filter)
       if tab
         records_path model: model_class, filter: filter, scope: tab

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

@@ -18,9 +18,12 @@
           %td
             = record.send attribute
         %td.actions
-          = link_to fa_icon('pencil-alt'), edit_current_model_record_path(record.id), class: 'btn btn-warning btn-xs'
-          = 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'
+          .row
+               
+            = link_to fa_icon('pencil-alt'), edit_current_model_record_path(record.id), class: 'btn btn-warning btn-xs'
+              
+            = 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
           %br
           .btn-group{ data: { toggle: :buttons } }

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

@@ -1,12 +1,28 @@
-- if searchable_model?(model_class)
-  .col-md-6
+- if searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
+  .col-md-8
     .search
-      = form_tag records_path, method: :get do |f|
-        .form-group.text
-          .input-group
-            = 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]
-            .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|
+              .col-md-4
+                = label_tag t("admin.filters.#{model_class.to_s.underscore}.#{filter[0]}")
+                - case filter[1][:type]
+                - when :select
+                  = select_tag "list_filters[#{filter[0]}]", build_options_for_select(filter[0], filter[1][:select_collection]), include_blank: true, class: 'form-control'
+                - when :dates
+                  = text_field_tag "list_filters[#{filter[0]}][begin_date]", '', class: 'form-control', id: 'filter_datepicker_begin_date', value: params[:list_filters][filter[0]][:begin_date]
+                  = text_field_tag "list_filters[#{filter[0]}][end_date]", '', class: 'form-control', id: 'filter_datepicker_end_date', value: params[: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.30'
+    VERSION = '1.32'
   end
 end

metadata

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