tramway-admin 1.32.1.3 → 1.32.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff80b796cc083c3bd26c9985b3369045d3ea8f983e978dfee3880fc550a443c
-  data.tar.gz: 15f65fae673edaff024ae501e3bbbbd864536f73cda32f4c79421ea2cbbee1af
+  metadata.gz: f79d0aa9d04ed68aef471f0dc570d73e4d601270521be63081ae558a18a5f1be
+  data.tar.gz: 2d57de82ee1b753978a5ad2ac0534a0a93a67b2b41ff456606265ab12f3e5097
 SHA512:
-  metadata.gz: 2f49d2bbc8a8962a5bd8f99ba38715ee78f37c478a7b025adfabb922afaad03b41c8384f1bb3440a7cfa2a486f2d8a4c1f91b7965f49c11b73d853f2c2c03236
-  data.tar.gz: 2ba60b25129fd4ec52e9d27044fa7f94bf42abd45bd22469f173f8ef30755794bfe6e3d285cbc00428b138939b8764dd54af21d38a404152719eb0a2d284d82f
+  metadata.gz: 1c3a64f26bfcce263809d2a7b2a2d906b53966855866b90bb6500da180a09c577a59ea6a2d092d93f8a40a32b929989c5095f74884fcd5a542e87b7380d16f12
+  data.tar.gz: bfe8a88ee5c4c903f280a56bdeffdb2352e1953456f836aff20f66d11c52e15ce784e659472c201f4717ba0118458181fd1fa3573459dc5b9a00233c890a34e5

data/README.md

@@ -1,4 +1,4 @@
-# Tramway::Admin
+# ![tramway-ico](https://raw.githubusercontent.com/kalashnikovisme/kalashnikovisme/master/%D1%82%D1%80%D1%8D%D0%BC%D0%B2%D1%8D%D0%B9%D0%B1%D0%B5%D0%B7%D1%84%D0%BE%D0%BD%D0%B0-min.png) Tramway::Admin
 
 Create admin panel for your application FAST!
 
@@ -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
 
@@ -255,6 +276,35 @@ Here docs about changing roles of `Tramway::User::User` model [Readme](https://g
 
 ## Associations management
 
+### has_many
+
+We have models Game and Packs.
+
+*app/models/game.rb*
+```ruby
+class Game < Tramway::Core::ApplicationRecord
+  has_many :packs
+end
+```
+
+*app/models/pack.rb*
+```ruby
+class Pack < Tramway::Core::ApplicationRecord
+  belongs_to :game
+end
+```
+
+**You want to manage packs in the Game show admin page**
+
+#### 1. Add association to PackDecorator
+
+*app/decorators/pack_decorator.rb*
+```ruby
+class GameDecorator < Tramway::Core::ApplicationDecorator
+  decorate_association :packs, as: :game # we recommend you to add association name in Pack model. You need it if association name of Game in Pack is not `game`
+end
+```
+
 ### has_and_belongs_to_many
 
 We have models Game and Packs.
@@ -417,8 +467,9 @@ en:
         my_dropdown: Very important dropdown
 ```
 
-## Contributing
-Contribution directions go here.
+## Errors
+
+* **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]`
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -21,7 +21,7 @@ module Tramway
       protected
 
       def check_available!
-        raise 'Model or Form is not available' if !model_given? && !form_given?
+        raise 'Tramway::Admin - Model or Form is not available' if !model_given? && !form_given?
       end
 
       def check_available_scope!
@@ -47,7 +47,7 @@ module Tramway
               end
             end
           end
-          hash.merge! collection => records.count
+          hash.merge! collection => records.send("#{current_admin.role}_scope", current_admin.id).count
         end
       end
 
@@ -92,7 +92,12 @@ module Tramway
       end
 
       def admin_form_class
-        "::#{current_admin.role.camelize}::#{model_class}Form".constantize
+        class_name = "::#{current_admin.role.camelize}::#{model_class}Form"
+        if defined? class_name
+          class_name.constantize
+        else
+          raise "Tramway::Admin - you should create form for role `#{current_admin.role}` to edit #{model_class} model. It should be named #{class_name}"
+        end
       end
 
       def model_given?

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/_form.html.haml

@@ -14,3 +14,6 @@
       = hidden_field_tag :redirect, params[:redirect]
       = f.button :submit, t('helpers.links.save'), class: 'btn-success'
       = link_to t('helpers.links.back'), current_model_records_path, class: 'btn btn-secondary'
+
+-# NOTES
+-# * value_from_params helper is in tramway-core gem app/helpers/inputs_helpers.rb

data/lib/tramway/admin.rb

@@ -10,6 +10,7 @@ require 'tramway/admin/notifications'
 require 'tramway/admin/welcome_page_actions'
 require 'tramway/admin/navbar'
 require 'tramway/error'
+require 'tramway/admin/generators/install_generator'
 
 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_name}_decorator.rb"),
+          )
+        end
+
+        def run_forms_generator
+          template(
+            'form.rb.erb',
+            Rails.root.join("app/forms/#{user_role}/#{file_name}_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,52 @@
+class <%= class_name %>Decorator < Tramway::Core::ApplicationDecorator
+  # Associations you want to show in admin dashboard
+  # decorate_associations :messages, :posts
+
+  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
+
+  # delegate_attributes :title
+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,10 +6,10 @@ 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
+        @available_models[project][role].merge! model.to_s
       end
     end
     @available_models = @available_models.with_indifferent_access
@@ -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/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Admin
-    VERSION = '1.32.1.3'
+    VERSION = '1.32.2.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-admin
 version: !ruby/object:Gem::Version
-  version: 1.32.1.3
+  version: 1.32.2.4
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tramway-core
@@ -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,6 +291,10 @@ 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