tramway-admin 1.32.2.1 → 1.33.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07d5b960569e1726907cbb62257174c49b3bbfcd56e3343b7bed2426a17bf5a
-  data.tar.gz: 5003ac7d1adec8c28af7413a2669ad305ca3b47b0a9cc8fd9c5b350da8ae2a81
+  metadata.gz: 2a2170c93de0fe4f501e76ad2b66b3cf07e622974d1db732dccd3f0fa751ebcb
+  data.tar.gz: 432f1bf0bc5c5eedc821023e5a9156c32e9428842629ad763bef407239eb4195
 SHA512:
-  metadata.gz: 864d6c1ee5998c3d90942bf7511c06d82a6f513900682e9c4a354895b92735a828e4ac0d65304b284c237db5e6edbea4c7658469a1111be3889c5b1fa4bc4332
-  data.tar.gz: cfce672ff7fd8fb5aaa0952040de2d7513e7216fc241c5795be142cfe8dab542857fd59f63ba7ba91b1f06915b91ae764c996d309f7851906a0af827eda86ef5
+  metadata.gz: cdc0d555ddc0d23d2a526cb918234dd6380f226db163db773b2fd5ac310a698080ef0c245a178cae63aab89f567efd2245a2da67651f1d0975d9d3cab4169211
+  data.tar.gz: 621ee6dae256c59292cfbd788af17a2051ee2d43b636fee44452e31cbff25818e4dd5a0f9a08303a8026da465635e7058b4e88c9305504ea595decdecc43e09c

data/README.md

@@ -43,7 +43,7 @@ Rails.application.routes.draw do
 end
 ```
 
-#### 4. Then make `tramway-core` installation. [How-to](https://github.com/ulmic/tramway-dev/blob/develop/tramway-core/README.md#installation)
+#### 4. Then make `tramway-core` installation. [How-to](https://github.com/Purple-Magic/tramway-core/blob/develop/README.md#installation)
 
 
 #### 5. And then execute:
@@ -88,31 +88,46 @@ Tramway::Admin.navbar_structure(
   project: :your_application_name
 )
 ```
+#### 9. Create decorators and forms for all available_models.
+You can run generator that will create all necessary files
+```bash
+$ rails g tramway:admin:install
+```
+Or generate decorator and form for only one model
+```bash
+$ rails g tramway:admin:model Coworking
+```
+If you're using several user roles in your admin dashboard, then you can specify scope for the form(default scope is `admin`)
+```bash
+$ rails g tramway:admin:install --user-role=partner
+```
+
+Or you can create forms and decorators manually as it written below:
 
-#### 9. Create decorator for models
+#### 9a. Create decorator for models [manual option]
 
 *app/decorators/your_model_decorator.rb*
 ```ruby
 class YourModelDecorator < Tramway::Core::ApplicationDecorator
   decorate_associations :messages, :posts
-  
+
   class << self
     def collections
       [ :all, :scope1, :scope2 ]
     end
-    
+
     def list_attributes
       [ :begin_date, :end_date ]
     end
-    
+
     def show_attributes
       [ :begin_date, :end_date ]
     end
-    
+
     def show_associations
       [ :messages ]
     end
-    
+
     def list_filters
       {
         filter_name: {
@@ -131,7 +146,7 @@ class YourModelDecorator < Tramway::Core::ApplicationDecorator
       }
     end
   end
-  
+
   delegate_attributes :title
 end
 ```
@@ -171,15 +186,7 @@ en:
             end_date Your end date filter
 ```
 
-#### 10. Add inheritance to YourModel
-
-*app/models/your_model.rb*
-```ruby
-class YourModel < Tramway::Core::ApplicationRecord
-end
-```
-
-#### 11. Create `Admin::YourModelForm`
+#### 9b. Create `Admin::YourModelForm` [manual option]
 
 *app/forms/admin/your_model_form.rb
 ```ruby
@@ -192,13 +199,27 @@ class Admin::YourModelForm < Tramway::Core::ApplicationForm
         logo: :file,
         description: :ckeditor,
         date: :date_picker,
-        text: :text
+        text: :text,
+        birth_date: {
+          type: :default,
+          input_options: {
+            hint: 'It should be more than 18'
+          }
+        }
     end
   end
 end
 ```
 
-### 12. You can add search to your index page
+#### 10. Add inheritance to YourModel
+
+*app/models/your_model.rb*
+```ruby
+class YourModel < Tramway::Core::ApplicationRecord
+end
+```
+
+### 11. You can add search to your index page
 
 Tramway use gem [PgSearch](https://github.com/Casecommons/pg_search`) as search engine
 
@@ -218,7 +239,6 @@ class YourModel < Tramway::Core::ApplicationRecord
 #### 12. Run server `rails s`
 #### 13. Launch `localhost:3000/admin`
 
-
 ### CRUDs for models
 
 By default users with role `admin` have access to all models used as arguments in method `::Tramway::Admin.set_available_models`. If you want specify models by roles, use them as keys
@@ -372,6 +392,64 @@ window.current_locale = window.i18n_locale 'en'
 ```
 to the `app/assets/javascripts/admin/application.js.coffee` file
 
+### Decorator Helper methods
+
+#### date_view
+Returns a date in the format depending on localization
+
+*app/decorators/\*_decorator.rb*
+```ruby
+def created_at
+  date_view object.created_at
+end
+```
+#### datetime_view
+Returns a date and time in the format depending on localization
+
+*app/decorators/*_decorator.rb*
+```ruby
+def created_at
+  datetime_view object.created_at
+end
+```
+#### state_machine_view
+Returns the state of an object according to a state machine
+
+*app/decorators/*_decorator.rb*
+```ruby
+def state
+  state_machine_view object, :state
+end
+```
+#### image_view
+Returns an image in a particular format depending on the parameters of the original image file
+
+*app/decorators/\*_decorator.rb*
+```ruby
+def avatar
+  image_view object.avatar
+end
+```
+#### enumerize_view
+Returns object enumerations as text
+
+*app/decorators/\*_decorator.rb*
+```ruby
+def field_type
+  enumerize_view object.field_type
+end
+```
+
+#### file_view
+Returns file name and button to download it
+
+*app/decorators/\*_decorator.rb*
+```ruby
+def file_download
+  file_view object.file
+end
+```
+
 ## Notifications
 
 You can add notification to your admin panel to the navbar.
@@ -450,5 +528,36 @@ en:
 
 * **Model or Form is not available** - `params[:model]` or `params[:form]` is empty **OR** current user does not have access to model or form in `params[:model]` or `params[:form]`
 
+## Good features
+
+### Get actions log in admin panel
+
+Tramway uses [audited](https://github.com/collectiveidea/audited) to log actions of models. That's why all we need it's creating view for model `Audited::Audit`
+
+#### 1. Add Audited::Audit model to available models
+
+*config/initializers/tramway.rb*
+```
+Tramway::Admin.set_available_models(
+  Audited::Audit,
+  project: :your_project_name
+)
+```
+
+#### 2. Add this model to navbar
+
+```
+Tramway::Admin.set_navbar_structure(
+  Audited::Audit,
+  project: :your_project_name
+)
+```
+
+#### 3. Generate decorator for Audited::Audit
+
+```
+rails g tramway:admin:model Audited::Audit
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -16,6 +16,7 @@ module Tramway
       include ::Tramway::Admin::ActionsHelper
       include ::Tramway::Collections::Helper
       include ::Tramway::Core::CopyToClipboardHelper
+      include ::Tramway::Admin::TramwayModelHelper
 
       def object_type(object)
         object_class_name = if object.class.ancestors.include? ::Tramway::Core::ApplicationDecorator

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

@@ -99,5 +99,9 @@ module Tramway::Admin
                         }
       end
     end
+
+    def is_there_any_filters?(model_class)
+      decorator_class(model_class).list_filters&.any?
+    end
   end
 end

data/app/inputs/multiple_file_input.rb

@@ -0,0 +1,5 @@
+class MultipleFileInput < SimpleForm::Inputs::FileInput
+  def input(wrapper_options)
+    super(wrapper_options.merge! multiple: true)
+  end
+end

data/app/views/layouts/tramway/admin/shared/_navbar.html.haml

@@ -11,8 +11,8 @@
         %ul.navbar-nav
           - ::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
+            - when Class, String
+              - model = item.keys.first.is_a?(String) ? item.keys.first.constantize : item.keys.first
               - case item.values.first
               - when :singleton
                 = model_menu_item model: model, route: ::Tramway::Admin::Engine.routes.url_helpers.singleton_path(model: model)
@@ -28,10 +28,13 @@
                     - if sub_item.values.first == :singleton
                       = dropdown_model_item model: model, route: ::Tramway::Admin::Engine.routes.url_helpers.singleton_path(model: model)
                     - if sub_item.values.first == :record
-                      = 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
+                      = 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.constantize.model_name).capitalize
 
       %ul.nav.navbar-nav.ml-auto
         - if current_admin
+          %li.nav-item
+            %span.nav-link
+              = "#{current_admin.first_name} #{current_admin.last_name}"
           - if @notifications_count.present?
             - if @notifications_count > 0
               %li.nav-item.dropdown.notifications

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

@@ -24,10 +24,11 @@
               
             = 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 } }
-            - record.model.class.state_machines.keys.each do |state_method|
-              - unless state_method == :state
-                = state_events_buttons record, state_method: state_method, model_param_name: :record, controller: 'tramway/admin/records', action: :update, parameters: { redirect: current_model_records_path(page: params[:page], scope: params[:scope], filter: params[:filter], focus: focus_selector(index)), model: record.class.model_name }, button_options: { class: :smart_button }
+          - if tramway_model?(model_class)
+            %br
+            %br
+            .btn-group{ data: { toggle: :buttons } }
+              - record.model.class.state_machines.keys.each do |state_method|
+                - unless state_method == :state
+                  = state_events_buttons record, state_method: state_method, model_param_name: :record, controller: 'tramway/admin/records', action: :update, parameters: { redirect: current_model_records_path(page: params[:page], scope: params[:scope], filter: params[:filter], focus: focus_selector(index)), model: record.class.model_name }, button_options: { class: :smart_button }
 = paginate @records, theme: 'twitter-bootstrap-4'

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

@@ -1,4 +1,4 @@
-- if searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
+- if searchable_model?(model_class) || is_there_any_filters?(model_class)
   .col-md-8
     .search
       = form_tag records_path, class: 'form-inline', method: :get do |f|

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

@@ -5,7 +5,7 @@
 - tabs = get_collection
 .page-header
   .row
-    - search_render_show = searchable_model?(model_class) || decorator_class(model_class).list_filters.any?
+    - search_render_show = searchable_model?(model_class) || is_there_any_filters?(model_class)
     %div{ class: "col-md-#{search_render_show ? 4 : 12}" }
       %h1
         = current_title

data/app/views/tramway/admin/shared/show/_attribute_tr.html.haml

@@ -4,5 +4,6 @@
   %td
     = value
   %td
-    - if attribute_name.to_s != 'state' && object.model.class.state_machines.keys.include?(attribute_name.to_sym)
-      = state_events_buttons object, state_method: attribute_name, model_param_name: :record, controller: 'tramway/admin/records', action: :update, parameters: { model: object.class.model_name }, button_options: { class: :smart_button }
+    - if tramway_model?(model_class)
+      - if attribute_name.to_s != 'state' && object.model.class.state_machines.keys.include?(attribute_name.to_sym)
+        = state_events_buttons object, state_method: attribute_name, model_param_name: :record, controller: 'tramway/admin/records', action: :update, parameters: { model: object.class.model_name }, button_options: { class: :smart_button }

data/lib/tramway/admin.rb

@@ -10,6 +10,8 @@ require 'tramway/admin/notifications'
 require 'tramway/admin/welcome_page_actions'
 require 'tramway/admin/navbar'
 require 'tramway/error'
+require 'tramway/admin/generators/install_generator'
+require 'tramway/admin/tramway_model_helper'
 
 module Tramway
   Auth.layout_path = 'tramway/admin/application'

data/lib/tramway/admin/generators/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'tramway/admin/generators/model_generator'
+
+module Tramway
+  module Admin
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path('templates', __dir__)
+        class_option :user_role, type: :string, default: 'admin'
+
+        def run_decorator_generators
+          project = Tramway::Core.application.name
+          ::Tramway::Admin.available_models_for(project).map do |model|
+            generate 'tramway:admin:model', model.to_s, "--user-role=#{options[:user_role]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tramway/admin/generators/model_generator.rb

@@ -0,0 +1,109 @@
+require 'rails/generators/named_base'
+
+module Tramway
+  module Admin
+    module Generators
+      class ModelGenerator < ::Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+        class_option :user_role, type: :string, default: 'admin'
+
+        COLLECTION_ATTRIBUTE_LIMIT = 4 # limiting columns in #index table
+        ATTRIBUTE_TYPE_MAPPING = {
+          date: :date_picker,
+          datetime: :date_picker,
+          time: :date_picker,
+          text: :text,
+          string: :string,
+          uuid: :string,
+          float: :float,
+          integer: :integer,
+          boolean: :boolean,
+        }
+        DEFAULT_FIELD_TYPE = :string
+        READ_ONLY_ATTRIBUTES = %w[id uuid created_at updated_at]
+
+        def run_decorator_generator
+          template(
+            'decorator.rb.erb',
+            Rails.root.join("app/decorators/#{file_path}_decorator.rb"),
+          )
+        end
+
+        def run_forms_generator
+          template(
+            'form.rb.erb',
+            Rails.root.join("app/forms/#{user_role}/#{file_path}_form.rb"),
+          )
+        end
+
+        private
+
+        def user_role
+          options[:user_role]
+        end
+
+        def attributes
+          # TODO: this for model associations, but they probably should be handled differently
+          # klass.reflections.keys +
+
+          klass.columns.map(&:name) -
+            redundant_attributes
+        end
+
+        def form_attributes
+          attributes - READ_ONLY_ATTRIBUTES
+        end
+
+        def form_type(attribute)
+          type = column_type_for_attribute(attribute.to_s)
+
+          if type
+            ATTRIBUTE_TYPE_MAPPING.fetch(type, DEFAULT_FIELD_TYPE)
+          # else
+          #   association_type(attribute)
+          end
+        end
+
+        def redundant_attributes
+          klass.reflections.keys.flat_map do |relationship|
+            redundant_attributes_for(relationship)
+          end.compact
+        end
+
+        def redundant_attributes_for(relationship)
+          case association_type(relationship)
+          when :polymorphic
+            [relationship + '_id', relationship + '_type']
+          when :belongs_to
+            relationship + '_id'
+          end
+        end
+
+        def association_type(attribute)
+          relationship = klass.reflections[attribute.to_s]
+          if relationship.has_one?
+            :has_one
+          elsif relationship.collection?
+            :has_many
+          elsif relationship.polymorphic?
+            :polymorphic
+          else
+            :belongs_to
+          end
+        end
+
+        def column_type_for_attribute(attr)
+          column_types(attr)
+        end
+
+        def column_types(attr)
+          klass.columns.find { |column| column.name == attr }.try(:type)
+        end
+
+        def klass
+          @klass ||= Object.const_get(class_name)
+        end
+      end
+    end
+  end
+end

data/lib/tramway/admin/generators/templates/decorator.rb.erb

@@ -0,0 +1,56 @@
+class <%= class_name %>Decorator < Tramway::Core::ApplicationDecorator
+  # Associations you want to show in admin dashboard
+  # decorate_associations :messages, :posts
+
+  delegate_attributes(
+<% attributes.each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+  )
+
+  class << self
+    def collections
+      # [ :all, :scope1, :scope2 ]
+      [ :all ]
+    end
+
+    def list_attributes
+      [
+<% attributes.first(COLLECTION_ATTRIBUTE_LIMIT).each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+      ]
+    end
+
+    def show_attributes
+      [
+<% attributes.each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+      ]
+    end
+
+    def show_associations
+      # Associations you want to show in admin dashboard
+      # [ :messages ]
+    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
+end

data/lib/tramway/admin/generators/templates/form.rb.erb

@@ -0,0 +1,22 @@
+class <%= user_role.capitalize %>::<%= class_name %>Form < Tramway::Core::ApplicationForm
+  properties <%= form_attributes.map{ |a| ":#{a}" }.join(', ') %>
+
+  def initialize(object)
+    super(object).tap do
+      # Here is the mapping from model attributes to simple_form inputs.
+      # form_properties title: :string,
+      #   logo: :file,
+      #   description: :ckeditor,
+      #   games: :association,
+      #   date: :date_picker,
+      #   text: :text,
+      #   birth_date: {
+      #     type: :default,
+      #     input_options: {
+      #       hint: 'It should be more than 18'
+      #     }
+      #   }
+      form_properties <%= form_attributes.map{ |attr| "#{attr}: :#{form_type(attr)}"}.join(",\n        ") %>
+    end
+  end
+end

data/lib/tramway/admin/navbar.rb

@@ -9,7 +9,7 @@ module Tramway::Admin::Navbar
   def navbar_items_for(project, role:)
     project = project.underscore.to_sym unless project.is_a? Symbol
     @navbar_structure[project]&.map do |item|
-      if item.is_a? Class
+      if item.is_a?(Class) || item.is_a?(String)
         should_be_in_navbar_as item, project, role
       elsif item.is_a? Hash
         sub_items = item.values.first.map do |sub_item|
@@ -23,10 +23,10 @@ module Tramway::Admin::Navbar
   private
 
   def should_be_in_navbar_as(item, project, role)
-    if singleton_models_for(project, role: role).include?(item)
-      { item => :singleton }
-    elsif available_models_for(project, role: role).include?(item)
-      { item => :record }
+    if singleton_models_for(project, role: role).map(&:to_s).include?(item.to_s)
+      { item.to_s => :singleton }
+    elsif available_models_for(project, role: role).map(&:to_s).include?(item.to_s)
+      { item.to_s => :record }
     elsif item.is_a? Symbol
       :divider
     end

data/lib/tramway/admin/records_models.rb

@@ -6,8 +6,8 @@ module Tramway::Admin::RecordsModels
     @available_models[project] ||= {}
     @available_models[project][role] ||= {}
     models.each do |model|
-      if model.class == Class
-        @available_models[project][role].merge! model => %i[index show update create destroy]
+      if model.class == Class || model.class == String
+        @available_models[project][role].merge! model.to_s => %i[index show update create destroy]
       elsif model.class == Hash
         @available_models[project][role].merge! model
       end
@@ -32,7 +32,10 @@ module Tramway::Admin::RecordsModels
         end
       end.flatten.compact
     end
-    models
+    # TODO: somehow cache results?
+    models.map do |model|
+      model.class == String ? model.constantize : model
+    end
   end
 
   def available_models(role:)

data/lib/tramway/admin/singleton_models.rb

@@ -7,9 +7,9 @@ module Tramway::Admin::SingletonModels
     @singleton_models[project][role] ||= {}
     models.each do |model|
       if model.class == Class
-        @singleton_models[project][role].merge! model => %i[index show update create destroy]
+        @singleton_models[project][role].merge! model.to_s => %i[index show update create destroy]
       elsif model.class == Hash
-        @singleton_models[project][role].merge! model
+        @singleton_models[project][role].merge! model.to_s
       end
     end
     @singleton_models = @singleton_models.with_indifferent_access

data/lib/tramway/admin/tramway_model_helper.rb

@@ -0,0 +1,5 @@
+module Tramway::Admin::TramwayModelHelper
+  def tramway_model?(model_class)
+    model_class.ancestors.include? Tramway::Core::ApplicationRecord
+  end
+end

data/lib/tramway/admin/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Admin
-    VERSION = '1.32.2.1'
+    VERSION = '1.33.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-admin
 version: !ruby/object:Gem::Version
-  version: 1.32.2.1
+  version: 1.33.0.1
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tramway-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.18.3.5
+        version: 1.18.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.18.3.5
+        version: 1.18.6
 - !ruby/object:Gem::Dependency
   name: tramway-auth
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +252,7 @@ files:
 - app/helpers/tramway/admin/records_helper.rb
 - app/helpers/tramway/admin/russian_cases_helper.rb
 - app/helpers/tramway/admin/singleton_helper.rb
+- app/inputs/multiple_file_input.rb
 - app/jobs/tramway/admin/application_job.rb
 - app/mailers/tramway/admin/application_mailer.rb
 - app/models/tramway/user/user.rb
@@ -290,11 +291,16 @@ files:
 - lib/tramway/admin/additional_buttons.rb
 - lib/tramway/admin/engine.rb
 - lib/tramway/admin/forms.rb
+- lib/tramway/admin/generators/install_generator.rb
+- lib/tramway/admin/generators/model_generator.rb
+- lib/tramway/admin/generators/templates/decorator.rb.erb
+- lib/tramway/admin/generators/templates/form.rb.erb
 - lib/tramway/admin/navbar.rb
 - lib/tramway/admin/notifications.rb
 - lib/tramway/admin/record_routes_helper.rb
 - lib/tramway/admin/records_models.rb
 - lib/tramway/admin/singleton_models.rb
+- lib/tramway/admin/tramway_model_helper.rb
 - lib/tramway/admin/version.rb
 - lib/tramway/admin/welcome_page_actions.rb
 homepage: https://github.com/kalashnikovisme/tramway-dev