tramway-admin 1.32.1 → 1.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35624ddbaec0ee1d1fe553d65d077e6a4deb17d810faa186091f02321f0f12d
-  data.tar.gz: df7588e7dcb03f22cb106e4828eeb509bb048d7f9b4e8d553cb24a9d26368dd9
+  metadata.gz: f29f2296ff326aa4bcdeb569ba6f9c0e8f9afd9a307b53d9c79860bf1a98b9ea
+  data.tar.gz: cfb493f04f4240ff6234c2a94d927c5a5f8e8a8b458e7204d4d814bcd00b2ea1
 SHA512:
-  metadata.gz: d017beaa83e62658848a8dbd35216fdfbe120cc97ffea7961e0d199249d58f966fbbc61ab073d6fcb92332bba4b55293263890cb1f99d3fc73f1b0914c0e3020
-  data.tar.gz: c90255345820994d0a31c9e963e2057f2b4c65f9a5ae298e01969807c6e3ff1e818d972569fdd4e4ab172f28a24b7bb065f47df76329903aa8901499d3b29df4
+  metadata.gz: b8bb82d5139135bbbf8608105d3ba4bcf3a75ad53a24ac653e76f7bcbad62f683fcadf5a86d0f350fb9a6e20fe545751f8cfbd46dbfd2039a82bb778a3fb8724
+  data.tar.gz: 7515b06e5c9534eb2c6099b32287b0e6e3ea2efd232af314eccb29b59a1c55907585c29281624fbd9a275ae381542406add206af599103cfc4b0b2287f48be89

data/README.md

@@ -1,13 +1,6 @@
-# Tramway::Admin
-Short description and motivation.
+# ![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
 
-## English readme
-
-*If you need translation of this Readme, please message us kalashnikov@ulmic.ru. We'll translate for you and post to this page*
-
-## Russian readme
-
-Готовая админка для проекта. Она подготовлена для работы со всеми tramway плагинами, а также поддерживает и ваши модели тоже.
+Create admin panel for your application FAST!
 
 ## Usage
 How to use my plugin.
@@ -18,7 +11,6 @@ How to use my plugin.
 ```ruby
 gem 'tramway-admin'
 gem 'tramway-auth'
-gem 'tramway-core'
 gem 'tramway-user'
 gem 'state_machine', github: 'seuros/state_machine'
 gem 'bcrypt'
@@ -102,11 +94,25 @@ Tramway::Admin.navbar_structure(
 *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: {
@@ -126,7 +132,7 @@ class YourModelDecorator < Tramway::Core::ApplicationDecorator
     end
   end
   
-  delegate :title, to: :object
+  delegate_attributes :title
 end
 ```
 
@@ -135,16 +141,34 @@ end
 * `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
+* `list_attributes` method returns array of attributes which will be shown in index page. If empty only `name` will be shown
+* `show_attributes` method returns array of attributes which will be shown in show page. If empty all attributes of the model will be shown
+* `show_associations` method returns array of decorated associations which will be show in show page. If empty no associations will be shown
 
 Filters naming:
 
+*Select filters*
+
 ```yaml
 en:
   tramway:
     admin:
       filters:
         model_name:
-          filter_name: You Filter
+          filter_name: Your Filter
+```
+
+*Date filters*
+
+```yaml
+en:
+  tramway:
+    admin:
+      filters:
+        model_name:
+          date_filter_name:
+            begin_date: Your Begin date filter
+            end_date Your end date filter
 ```
 
 #### 10. Add inheritance to YourModel
@@ -231,6 +255,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.
@@ -393,8 +446,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/Rakefile

@@ -1,34 +1,10 @@
 # frozen_string_literal: true
 
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
+require 'rake'
+require 'rspec/core/rake_task'
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Tramway::Admin'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
 end
-
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+task default: :spec

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
 

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

@@ -5,7 +5,12 @@ class Tramway::Admin::RecordsController < ::Tramway::Admin::ApplicationControlle
     scope = params[:scope].present? ? params[:scope] : :all
     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?
+    if params[:filter].present?
+      if params[:filter].is_a? String
+        params[:filter] = JSON.parse params[:filter]
+      end
+      records = records.ransack(params[:filter]).result 
+    end
     params[:list_filters]&.each do |filter, value|
       case decorator_class.list_filters[filter.to_sym][:type]
       when :select

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/app/views/tramway/admin/records/_search.html.haml

@@ -6,7 +6,7 @@
           = 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]
+        = hidden_field_tag :filter, (params[:filter].is_a?(ActionController::Parameters) ? params[:filter].permit!.to_h.to_json : params[:filter])
         - decorator_class(model_class).list_filters.each_slice(3) do |slice|
           .row-fluid.filters
             - slice.each do |filter|

data/lib/tramway/admin.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'tramway/core'
 require 'tramway/admin/engine'
 require 'tramway/admin/singleton_models'
 require 'tramway/admin/records_models'

data/lib/tramway/admin/version.rb

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

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: tramway-admin
 version: !ruby/object:Gem::Version
-  version: 1.32.1
+  version: 1.32.2
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tramway-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.3.5
+- !ruby/object:Gem::Dependency
+  name: tramway-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: tramway-user
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3.2
 - !ruby/object:Gem::Dependency
   name: bootstrap-kaminari-views
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +196,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Engine for admin
 email:
 - kalashnikovisme@gmail.com