tramway-core 1.18.5 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b879028d7f87c89e93ba14221569147d80640c5d61f3cb1812d8755953f372e9
-  data.tar.gz: f0ae36c46f41aa516b7fc3b260e6c62e053f57ea6425eb93e9a69d952c3b3183
+  metadata.gz: cc709cc658e3bb686e5cf2168db2563d04374053cb83d49b6a0b987971b86271
+  data.tar.gz: 3093efbf62bad2d3e8316dd5f98c0d642c4f384529bd9168b85b6651a31f04ee
 SHA512:
-  metadata.gz: 98a707a7f0ad29077c30f04ce8d3f70d98ae10ef611fccee07861b3ed9b983e498434cf51397b251599c780635623bf8bfb8054edd26f71049a7bb8d491cebd1
-  data.tar.gz: 7fac100f8f52b257923974684b8d9b3a64758104a2f497714e047a070679260a8bfe0ad5dd8e29fae2d749a5deee4f943e1a1b00f56b5a2aac175e3deb0053f7
+  metadata.gz: c4b131aa515137b26623ff4e9b894ff7d754532b42952d8c39eb9193c1226e90e6008dd76f43e5e9af80a1ef4fe2fa062c1d9c7c43ac3c272b77776cc79a95ed
+  data.tar.gz: 4832bc73d550dd883c87f561c1227caa6e10d5ffe96a700654248eb58c5eade25ab7aed2814e585ac1c08d3ad2541f9a1251fed8727f6d8a8185e161cb4fc26a

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

@@ -9,7 +9,7 @@ module Tramway::Core::Attributes::ViewHelper
   end
 
   def state_machine?(object, attribute_name)
-    attribute_name.to_s.in? object.class.state_machines.keys.map(&:to_s)
+    attribute_name.to_s.in? object.class.state_machines_names.map(&:to_s)
   end
 
   def view_by_value(object, value, attribute)
@@ -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

@@ -10,7 +10,9 @@ module Tramway::Core::Concerns::AttributesDecoratorHelper
   end
 
   def state_machine_view(object, attribute_name)
-    object.send "human_#{attribute_name}_name"
+    object.aasm(attribute_name).human_state
+  rescue
+    object.aasm.human_state
   end
 
   BASE64_REGEXP = %r{^(?:[a-zA-Z0-9+/]{4})*(?:|(?:[a-zA-Z0-9+/]{3}=)|
@@ -40,6 +42,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/forms/tramway/core/application_forms/submit_helper.rb

@@ -18,7 +18,11 @@ module Tramway::Core::ApplicationForms::SubmitHelper
   rescue ArgumentError => e
     Tramway::Error.raise_error :tramway, :core, :application_form, :save, :argument_error, message: e.message
   rescue StandardError => e
-    Tramway::Error.raise_error :tramway, :core, :application_form, :save, :looks_like_you_have_method,
-      method_name: e.name.to_s.gsub('=', ''), model_class: @@model_class, class_name: self.class
+    if e.try :name
+      Tramway::Error.raise_error :tramway, :core, :application_form, :save, :looks_like_you_have_method,
+        method_name: e.name.to_s.gsub('=', ''), model_class: @@model_class, class_name: self.class
+    else
+      raise e
+    end
   end
 end

data/app/forms/tramway/core/extendable_forms_helpers/properties_helper.rb

@@ -4,7 +4,7 @@ module Tramway::Core::ExtendableFormsHelpers::PropertiesHelper
   def define_properties_method(simple_properties, more_properties)
     define_method 'properties' do
       hash = simple_properties.each_with_object({}) do |property, h|
-        h.merge! property[0] => property[1] unless model.class.state_machines.keys.include?(property[0])
+        h.merge! property[0] => property[1] unless model.class.state_machines_names.include?(property[0])
       end
       more_properties.reduce(hash) do |h, property|
         h.merge! property[0] => {

data/app/helpers/tramway/core/title_helper.rb

@@ -2,6 +2,7 @@
 
 module Tramway::Core::TitleHelper
   def title(page_title = default_title)
+    @application ||= Tramway::Core.application&.model_class&.first || Tramway::Core.application
     if @application.present?
       title_text = "#{page_title} | #{@application.try(:title) || @application.public_name}"
       content_for(:title) { title_text }

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

@@ -6,13 +6,14 @@ class Tramway::Core::ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
   audited
   extend ::Enumerize
+  include ::AASM
 
-  state_machine :state, initial: :active do
-    state :active
+  aasm column: :state do
+    state :active, initial: true
     state :removed
 
     event :remove do
-      transition active: :removed
+      transitions from: :active, to: :removed
     end
   end
 
@@ -20,12 +21,13 @@ 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
 
   def creator
-    audits.where(action: :create).first.user
+    creation_event = audits.where(action: :create).first
+    creation_event.user if creation_event.user_id.present?
   end
 
   # FIXME: detect inhertited locales
@@ -56,6 +58,10 @@ class Tramway::Core::ApplicationRecord < ActiveRecord::Base
     def file_extensions
       @extensions
     end
+
+    def state_machines_names
+      AASM::StateMachineStore.fetch(self).machine_names
+    end
   end
 
   # FIXME: detect inhertited locales

data/lib/tramway/core/generators.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
-module Tramway::Core::Generators
+module Tramway
+  module Core
+    module Generators
+    end
+  end
 end

data/lib/tramway/core/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Core
-    VERSION = '1.18.5'
+    VERSION = '2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway-core
 version: !ruby/object:Gem::Version
-  version: 1.18.5
+  version: '2.0'
 platform: ruby
 authors:
 - Pavel Kalashnikov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited