tramway-core 1.18.5.2 → 1.18.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bca828825ed63cfecc857febadda0ba9cc44b43b851009982de2dec760c3ab
-  data.tar.gz: 1c4cb7d7dd804f538b3c0acb4e3c54d2dd42799583fc89c76467ee17c7f68d9a
+  metadata.gz: 6099966ec764bed33f2ff047144f9bde9057da2740626df9dd7070658ea54b8a
+  data.tar.gz: 95215f84be2eed817f5a6d4741aadb8d68d9a66de216be52c994e0eabca50cf7
 SHA512:
-  metadata.gz: bf9ed7162852e76ff1bb5f67a144719da05ba2643a604bb753a3d361863f4ea573e553e9f1ae27f5b7c8be9846940552a26c1e3035d556f345b592f2afc2b346
-  data.tar.gz: b7533a50cd1e1803c05af20ba9433b72bf551b31faf1da0f6eed59300b821f73472af8f3862915f9cce48601412f3d8e2da6c4245eb8e41bcecd33f8a704a65c
+  metadata.gz: 8259a4092c24557aeb828575a7966634ae8a707beac890737fdf5630735e534193c3820a0c14a27dec54d0daf1b2a210266f881ce12631364782fa8298e233dc
+  data.tar.gz: b41e199f893ec054da4d5d1e9716d841acea37e155d6019792b9eb4009c651ad84b33231eaccc8643975ec800e7eca6276744cc32a31c628b11c27a0b5de2dd9

data/README.md

@@ -1,4 +1,4 @@
-# Tramway::Core ![Ruby](https://github.com/Purple-Magic/tramway-core/workflows/Tests/badge.svg) ![Ruby](https://github.com/Purple-Magic/tramway-core/workflows/Rubocop/badge.svg) [![Gem Version](https://badge.fury.io/rb/tramway-core.svg)](https://badge.fury.io/rb/tramway-core)
+# ![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::Core ![Ruby](https://github.com/Purple-Magic/tramway-core/workflows/Tests/badge.svg) ![Ruby](https://github.com/Purple-Magic/tramway-core/workflows/Rubocop/badge.svg) [![Gem Version](https://badge.fury.io/rb/tramway-core.svg)](https://badge.fury.io/rb/tramway-core)
 
 *If you need translation of this Readme, please message us kalashnikov@ulmic.ru. We'll translate for you and post to this page*
 
@@ -22,7 +22,7 @@ rails g tramway:core:install
 *config/initializers/tramway.rb*
 ```ruby
 # Initialize application with name
-Tramway::Core.initialize_application name: "Your application's name"
+Tramway::Core.initialize_application name: :your_application_name
 
 # Initialize application name with model_class. Model class must be a singlethon
 Tramway::Core.initialize_application model_class: ::Tramway::Conference::Unity # example was taken from tramway-conference gem
@@ -32,6 +32,64 @@ Tramway::Core.initialize_application model_class: ::Tramway::Conference::Unity #
 ```ruby
 Rails.application.config.assets.precompile += %w( *.jpg *.png *.js )
 ```
+
+#### Every Tramway application need initialized @application object (or if you create Tramway plugin, it should be @application_engine object).
+
+You don't need to initialize this object yourself, just configurate application with Tramway. You have **2** options of this:
+
+## Option 1. If you want to change @application object just in the code base.
+
+```shell
+rails g tramway:core:install
+```
+
+*config/initializers/tramway.rb*
+
+```ruby
+Tramway::Core.initialize_application name: :your_application_name
+```
+
+## Option 2. If you want to change @application object from admin panel. How to create model that will be an Application Model for the Tramway
+
+#### 1. Generate model that you to use. We create Organization, for example
+
+```shell
+rails g tramway:core:application
+rails db:migrate
+```
+
+#### 2. Add model_class to Initializer
+
+```ruby
+Tramway::Core.initialize_application model_class: Organization
+```
+
+#### 3. Create 1 instance of Organization model
+
+```ruby
+rails c
+Organization.create! public_name: 'Tramway', name: :organization, tagline: 'Tramway is not buggy, LOL!', main_image: 'https://raw.githubusercontent.com/ulmic/tramway-dev/develop/logo.png'
+```
+
+#### 4. Add model to singleton to the `tramway-admin` admin panel to be able to change its data
+
+```ruby
+Tramway::Admin.set_singleton_models Organization, project: :organization # now you should use organization.name here
+```
+
+#### 5. Then continue configuration of your model in admin panel with tramway-admin gem [instruction, starting from point 8](https://github.com/ulmic/tramway-dev/tree/develop/tramway-admin#8-configurate-navbar)
+
+#### 6. Now you are able to change your application main info in admin panel
+
+## How-to
+
+### add favicon to your application
+
+*config/initializers/tramway.rb*
+```ruby
+::Tramway::Core.initialize_application attribute1: value, another_attribute: another_value, favicon: `/icon.ico` # icon should be in public folder
+```
+
 # Usage
 
 ## Tramway::Core::ApplicationRecord
@@ -177,54 +235,6 @@ Something like this:
 copy_to_clipboard "some_id" # some_id is HTML id of element. Content of this element will be copied to the clipboard after pressing the button
 ```
 
-# Every Tramway application need initialized @application object (or if you create Tramway plugin, it should be @application_engine object).
-
-You don't need to initialize this object yourself, just configurate application with Tramway. You have **2** options of this:
-
-## Option 1. If you want to change @application object just in the code base.
-
-```shell
-rails g tramway:core:application
-```
-
-*config/initializers/tramway.rb*
-
-```ruby
-Tramway::Core.initialize_application name: :your_application_name
-```
-
-## Option 2. If you want to change @application object from admin panel. How to create model that will be an Application Model for the Tramway
-
-#### 1. Generate model that you to use. We create Organization, for example
-
-```shell
-rails g tramway:core:application
-rails db:migrate
-```
-
-#### 2. Add model_class to Initializer
-
-```ruby
-Tramway::Core.initialize_application model_class: Organization
-```
-
-#### 3. Create 1 instance of Organization model
-
-```ruby
-rails c
-Organization.create! public_name: 'Tramway', name: :organization, tagline: 'Tramway is not buggy, LOL!', main_image: 'https://raw.githubusercontent.com/ulmic/tramway-dev/develop/logo.png'
-```
-
-#### 4. Add model to singleton to the `tramway-admin` admin panel to be able to change its data
-
-```ruby
-Tramway::Admin.set_singleton_models Organization, project: :organization # now you should use organization.name here
-```
-
-#### 5. Then continue configuration of your model in admin panel with tramway-admin gem [instruction, starting from point 8](https://github.com/ulmic/tramway-dev/tree/develop/tramway-admin#8-configurate-navbar)
-
-#### 6. Now you are able to change your application main info in admin panel
-
 ## In Russian
 
 # Базовые классы
@@ -251,7 +261,13 @@ Tramway::Admin.set_singleton_models Organization, project: :organization # now y
 * [Pavel Kalashnikov](https://github.com/kalashnikovisme)
 * [moshinaan](https://github.com/moshinaan)
 
-### Workflow
+### Run tests
+
+```shell
+make test
+```
+
+### Deployment workflow
 
 #### If you don't have access to push gem to rubygems then
 

data/app/decorators/tramway/core/attributes/view_helper.rb

@@ -21,6 +21,8 @@ module Tramway::Core::Attributes::ViewHelper
       file_view(object.send(attribute[0]))
     elsif value.is_a? Enumerize::Value
       enumerize_view(value)
+    elsif value.is_a? Hash
+      yaml_view(value)
     else
       value
     end

data/app/decorators/tramway/core/concerns/attributes_decorator_helper.rb

@@ -40,6 +40,10 @@ module Tramway::Core::Concerns::AttributesDecoratorHelper
     value.text
   end
 
+  def yaml_view(value)
+    content_tag(:pre) { value.to_yaml }
+  end
+
   private
 
   def src_thumb(original, thumb)

data/app/models/tramway/core/application_record.rb

@@ -20,7 +20,7 @@ class Tramway::Core::ApplicationRecord < ActiveRecord::Base
   scope :created_by_user, lambda { |user_id|
     joins(:audits).where('audits.action = \'create\' AND audits.user_id = ?', user_id)
   }
-  scope :admin_scope, ->(_arg) { all }
+  scope :admin_scope, -> (_arg) { all }
 
   include ::PgSearch::Model
 

data/lib/tramway/core/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Core
-    VERSION = '1.18.5.2'
+    VERSION = '1.18.6'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway-core
 version: !ruby/object:Gem::Version
-  version: 1.18.5.2
+  version: 1.18.6
 platform: ruby
 authors:
 - Pavel Kalashnikov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited