tramway-admin 1.29.2 → 1.31.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb8572d620231b636f36ee41b63de90c82cf6bbda55bd49d43018e13a81e9bb4
-  data.tar.gz: 38aa095dc281d92baacf40504cd56790bac6ff071dcfd238d0d6a98e4b49cd7e
+  metadata.gz: 85b6f6446c7992da10f8047f5307cde053f95c0cddbecd3fb8452b54b1e1f275
+  data.tar.gz: f1c47470978a8da9341e5cde7327f6561bdfda5f2ea8629779457ca3994f33b3
 SHA512:
-  metadata.gz: e9534f3052c14aa43b8dbf06dbbef7c61030e4fe5e8a901dfc07863caf349af8c2d8b3da153b766cc39d3a5bf98e53e5507208c224643af79f6bc48458649b53
-  data.tar.gz: 777695f2b36a4ee82e9848c25fefb79e40bfb35bbd214e97a0b3e6c0c676499ea24961f636883ed15a70fae36230d6a348cd2a854b07eb1cece6e3ba63dd9292
+  metadata.gz: 04655db55e12c76dc60edf28cf11c9e3cc73cc3256646e02363e4793522aed373300aea0c0af9391bf5a92f01391f5b72b9893426a4d7cac5eb33b9b3eb9758c
+  data.tar.gz: b529d3b27ce0c0a9288df0282ae0ca979ad6363446cef0cd6771b5e0279a3a42987126fc093dea569cb76ba84f48aea24bef5813ef1ef2ac19beefe099fac063

data/README.md

@@ -99,12 +99,12 @@ 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
   end
   
@@ -112,6 +112,8 @@ class YourModelDecorator < Tramway::Core::ApplicationDecorator
 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.
+
 #### 10. Add inheritance to YourModel
 
 *app/models/your_model.rb*
@@ -138,6 +140,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/controllers/tramway/admin/application_controller.rb

@@ -31,8 +31,13 @@ module Tramway
       def collections_counts
         @counts = decorator_class.collections.reduce({}) do |hash, collection|
           records = model_class.active.send(collection)
-          records = records.send "#{current_user.role}_scope", current_user.id
+          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)
+            end
+          end
           hash.merge! collection => records.count
         end
       end
@@ -44,8 +49,10 @@ module Tramway
       end
 
       def notifications
-        @notifications ||= Tramway::Admin.notificable_queries&.reduce({}) do |hash, notification|
-          hash.merge! notification[0] => notification[1].call(current_user)
+        if current_admin
+          @notifications ||= Tramway::Admin.notificable_queries&.reduce({}) do |hash, notification|
+            hash.merge! notification[0] => notification[1].call(current_admin)
+          end
         end
         @notifications
       end
@@ -76,7 +83,7 @@ module Tramway
       end
 
       def admin_form_class
-        "::#{current_user.role.camelize}::#{model_class}Form".constantize
+        "::#{current_admin.role.camelize}::#{model_class}Form".constantize
       end
 
       def model_given?
@@ -89,8 +96,8 @@ 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_user.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]})`"
+        Tramway::Admin.forms.include? params[:form].underscore.sub(%r{^admin/}, '').sub(/_form$/, '') if params[:form].present?
       end
 
       def available_scope_given?
@@ -105,12 +112,25 @@ module Tramway
         check_models_given? :singleton
       end
 
+      def current_admin
+        user = Tramway::User::User.find_by id: session[:admin_id]
+        return false unless user
+
+        Tramway::User::UserDecorator.decorate user
+      end
+
       private
 
       def check_models_given?(model_type)
-        models = ::Tramway::Admin.send("#{model_type}_models", role: current_user.role)
+        models = ::Tramway::Admin.send("#{model_type}_models", role: current_admin.role)
         models.any? && params[:model].in?(models.map(&:to_s))
       end
+
+      def authenticate_admin!
+        if !current_admin && !request.path.in?(['/admin/session/new', '/admin/session'])
+          redirect_to '/admin/session/new'
+        end
+      end
     end
   end
 end

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

@@ -3,8 +3,14 @@
 class Tramway::Admin::HasAndBelongsToManyRecordsController < ::Tramway::Admin::ApplicationController
   def create
     base_object = params[:model_class].constantize.find params[:object_id]
-    record_form = params[:form].constantize.new base_object
-    if record_form.submit params[params[:model_class].underscore]
+    form_class = params[:form].constantize
+    record_form = form_class.new base_object
+    sending_params = if params[params[:model_class].underscore].present?
+                       params[params[:model_class].underscore]
+                     else
+                       params[form_class.associated_as]
+                     end
+    if record_form.submit sending_params
       redirect_to params[:redirect].present? ? params[:redirect] : record_path(base_object, model: base_object.class)
     else
       redirect_to params[:redirect].present? ? params[:redirect] : record_path(base_object, model: base_object.class)

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

@@ -6,7 +6,12 @@ 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?
-    records = records.send "#{current_user.role}_scope", current_user.id
+    params[:list_filters]&.each do |filter, value|
+      if value.present?
+        records = decorator_class.list_filters[filter.to_sym][:query].call(records, value)
+      end
+    end
+    records = records.send "#{current_admin.role}_scope", current_admin.id
     @records = decorator_class.decorate records.page params[:page]
   end
 

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class Tramway::Admin::SessionsController < ::Tramway::Admin::ApplicationController
+  before_action :redirect_if_signed_in, except: :destroy
+  skip_before_action :check_available!
+  skip_before_action :collections_counts
+
+  def new
+    @session_form = ::Tramway::Auth::SessionForm.new ::Tramway::User::User.new
+  end
+
+  def create
+    @session_form = ::Tramway::Auth::SessionForm.new ::Tramway::User::User.active.find_or_initialize_by email: params[:user][:email]
+    if @session_form.validate params[:user]
+      admin_sign_in @session_form.model
+      redirect_to Tramway::Admin::Engine.routes.url_helpers.root_path
+    else
+      render :new
+    end
+  end
+
+  def destroy
+    admin_sign_out
+    redirect_to '/admin/session/new'
+  end
+
+  private
+
+  def redirect_if_signed_in
+    redirect_to Tramway::Admin::Engine.routes.url_helpers.root_path if current_admin
+  end
+
+  def admin_sign_in(user)
+    session[:admin_id] = user.id
+  end
+
+  def admin_sign_out
+    session[:admin_id] = nil
+  end
+end

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

@@ -6,7 +6,7 @@ module Tramway::Admin::ActionsHelper
       association_object,
       project: (@application_engine || @application.name),
       model_name: association_object.model.class.name,
-      role: current_user.role,
+      role: current_admin.role,
       action: :destroy
     )
   end
@@ -16,7 +16,7 @@ module Tramway::Admin::ActionsHelper
       association_object,
       project: (@application_engine || @application.name),
       model_name: association_object.model.class.name,
-      role: current_user.role,
+      role: current_admin.role,
       action: :update
     )
   end

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

@@ -4,7 +4,6 @@ module Tramway
   module Admin
     module ApplicationHelper
       include ::FontAwesome5::Rails::IconHelper
-      include AuthManagement
       include AdditionalButtonsBuilder
       include ::SmartButtons
       include CasesHelper
@@ -26,6 +25,13 @@ module Tramway
                             end
         ::Tramway::Admin.available_models_for(@application_engine || @application.name).map(&:to_s).include?(object_class_name) ? :record : :singleton
       end
+
+      def current_admin
+        user = Tramway::User::User.find_by id: session[:admin_id]
+        return false unless user
+
+        Tramway::User::UserDecorator.decorate user
+      end
     end
   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/layouts/tramway/admin/shared/_navbar.html.haml

@@ -7,9 +7,9 @@
     %button.navbar-toggler.collapsed{ aria: { controls: :navbar, expanded: "false", label: 'Toggle Navigation' }, data: { target: "#navbar", toggle: :collapse }, type: :button }
       %span.navbar-toggler-icon
     .navbar-collapse.collapse#navbar
-      - if signed_in?
+      - if current_admin
         %ul.navbar-nav
-          - ::Tramway::Admin.navbar_items_for(@application_engine || @application.name, role: current_user.role)&.each do |item|
+          - ::Tramway::Admin.navbar_items_for(@application_engine || @application.name, role: current_admin.role)&.each do |item|
             - case item.keys.first
             - when Class
               - model = item.keys.first
@@ -31,7 +31,7 @@
                       = dropdown_model_item model: model, route: ::Tramway::Admin::Engine.routes.url_helpers.records_path(model: model, scope: decorator_class(model).collections.first), pluralize: plural(model.model_name).capitalize
 
       %ul.nav.navbar-nav.ml-auto
-        - if signed_in?
+        - if current_admin
           - if @notifications_count.present?
             - if @notifications_count > 0
               %li.nav-item.dropdown.notifications
@@ -50,7 +50,9 @@
                   %span.badge.badge-light
                     = @notifications_count
           %li.nav-item
-            = link_to Tramway::Auth::Engine.routes.url_helpers.session_path, method: :delete, class: 'nav-link' do
+            -# FIXME url_helpers return with /admin for some reason
+            -#= link_to Tramway::Auth::Engine.routes.url_helpers.session_path(model: Tramway::User::User).sub('/admin', ''), method: :delete, class: 'nav-link' do
+            = link_to '/admin/sign_out', class: 'nav-link' do
               = fa_icon 'sign-out-alt'
               = t('helpers.links.sign_out')
         - else

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,15 @@
-- if searchable_model?(model_class)
+- if searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
   .col-md-6
     .search
       = form_tag records_path, method: :get do |f|
         .form-group.text
           .input-group
-            = text_field_tag :search, params[:search], class: 'text form-control'
+            - 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'

data/app/views/tramway/admin/sessions/new.html.haml

@@ -0,0 +1,9 @@
+- title
+.row
+  .col-md-6
+    = simple_form_for @session_form.model, url: '/admin/session', method: :post, html: { class: 'form-horizontal' } do |f|
+      = f.input :email, as: :string
+      = f.input :password
+      = hidden_field_tag :model, @session_form.model.class.to_s
+      = hidden_field_tag :redirect, Tramway::Admin::Engine.routes.url_helpers.root_path
+      = f.button :submit, t('helpers.links.enter'), class: 'btn btn-success'

data/config/routes.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 Tramway::Admin::Engine.routes.draw do
-  mount Tramway::Auth::Engine, at: '/auth'
   mount Tramway::Export::Engine, at: '/' if defined? Tramway::Export::Engine
 
   root to: 'welcome#index'
@@ -9,4 +8,6 @@ Tramway::Admin::Engine.routes.draw do
   resources :records
   resource :singleton, only: %i[new create show edit update]
   resources :has_and_belongs_to_many_records, only: %i[create destroy]
+  resource :session, only: %i[new create]
+  get 'sign_out', to: 'sessions#destroy'
 end

data/lib/tramway/admin/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Admin
-    VERSION = '1.29.2'
+    VERSION = '1.31.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-admin
 version: !ruby/object:Gem::Version
-  version: 1.29.2
+  version: 1.31.0.2
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap-kaminari-views
@@ -183,6 +183,7 @@ files:
 - app/controllers/tramway/admin/application_controller.rb
 - app/controllers/tramway/admin/has_and_belongs_to_many_records_controller.rb
 - app/controllers/tramway/admin/records_controller.rb
+- app/controllers/tramway/admin/sessions_controller.rb
 - app/controllers/tramway/admin/singletons_controller.rb
 - app/controllers/tramway/admin/welcome_controller.rb
 - app/controllers/tramway/export/application_controller.rb
@@ -207,6 +208,7 @@ files:
 - app/views/tramway/admin/records/index.html.haml
 - app/views/tramway/admin/records/new.html.haml
 - app/views/tramway/admin/records/show.html.haml
+- app/views/tramway/admin/sessions/new.html.haml
 - app/views/tramway/admin/shared/_show.html.haml
 - app/views/tramway/admin/shared/errors/server_error.html.haml
 - app/views/tramway/admin/shared/show/_attribute_tr.html.haml