tramway-core 1.17.1.1 → 1.17.2.4

data/app/forms/tramway/core/application_forms/association_object_helpers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ApplicationForms::AssociationObjectHelpers
+  def associations
+    @@associations
+  end
+
+  def define_association_method(association, class_name)
+    if class_name.is_a? Array
+      define_polymorphic_association association, class_name
+    else
+      self.class.send(:define_method, "#{association}=") do |value|
+        super class_name.find value
+      end
+    end
+  end
+
+  def define_polymorphic_association(association, _class_name)
+    self.class.send(:define_method, "#{association}=") do |value|
+      association_class = value.split('_')[0..-2].join('_').camelize
+      association_class = association_class.constantize if association_class.is_a? String
+      if association_class.nil?
+        Tramway::Error.raise_error :tramway, :core, :application_form, :initialize, :polymorphic_class_is_nil,
+          association_name: association
+      else
+        super association_class.find value.split('_')[-1]
+        send "#{association}_type=", association_class.to_s
+      end
+    end
+  end
+end

data/app/forms/tramway/core/application_forms/constant_class_actions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ApplicationForms::ConstantClassActions
+  def validation_group_class
+    ActiveModel
+  end
+end

data/app/forms/tramway/core/application_forms/constant_object_actions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ApplicationForms::ConstantObjectActions
+  def delegating(object)
+    %i[to_key errors].each { |method| self.class.send(:define_method, method) { object.send method } }
+  end
+
+  def build_errors; end
+
+  def attributes
+    properties.reduce({}) { |hash, property| hash.merge! property.first => model.values[property.first.to_s] }
+  end
+end

data/app/forms/tramway/core/application_forms/properties_object_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ApplicationForms::PropertiesObjectHelper
+  def form_properties(**args)
+    @form_properties = args
+  end
+
+  def form_properties_additional(**args)
+    @form_properties_additional = args
+  end
+
+  def properties
+    return @form_properties if @form_properties
+
+    yaml_config_file_path = Rails.root.join('app', 'forms', "#{self.class.name.underscore}.yml")
+
+    return [] unless File.exist? yaml_config_file_path
+
+    @form_properties = YAML.load_file(yaml_config_file_path).deep_symbolize_keys
+    @form_properties.deep_merge! @form_properties_additional if @form_properties_additional
+    @form_properties
+  end
+end

data/app/forms/tramway/core/extendable_form.rb

@@ -2,80 +2,13 @@
 
 class Tramway::Core::ExtendableForm
   class << self
+    include Tramway::Core::ExtendableFormsHelpers::ClassBuilder
+
     def new(name, simple_properties: {}, **more_properties)
       if Object.const_defined? name
         name.constantize
       else
-        Object.const_set(name, Class.new(::Tramway::Core::ApplicationForm) do
-          properties(*simple_properties.keys) if simple_properties.keys.any?
-
-          define_method 'submit' do |params|
-            model.values ||= {}
-            extended_params = params.except(*simple_properties.keys).except(*jsonb_ignored_properties(more_properties))
-            params.each do |key, value|
-              method_name = "#{key}="
-              send method_name, value if respond_to?(method_name)
-            end
-            model.values = extended_params.permit!.to_h.reduce(model.values) do |hash, pair|
-              hash.merge! pair[0] => pair[1]
-            end
-            super params
-          end
-
-          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])
-            end
-            more_properties.reduce(hash) do |h, property|
-              h.merge! property[0] => {
-                extended_form_property: property[1][:object]
-              }
-            end
-          end
-
-          more_properties.each do |property|
-            define_method property[0] do
-              model.values[property[0]] if model.values
-            end
-
-            case property[1][:object].field_type
-            when 'file'
-              field = property[1][:object]
-              define_method "#{property[0]}=" do |value|
-                file_instance = property[1][:association_model].find_or_create_by "#{model.class.name.underscore}_id" => model.id, "#{field.class.name.underscore}_id" => field.id
-                file_instance.file = value
-                file_instance.save!
-              end
-            else
-              next unless property[1][:validates].present?
-
-              define_method "#{property[0]}=" do |value|
-                property[1][:validates].each do |pair|
-                  case pair[0].to_s
-                  when 'presence'
-                    validator_object = "#{pair[0].to_s.camelize}Validator".constantize.new(attributes: :not_blank)
-                    if pair[1] == 'true' && !validator_object.send(:valid?, value)
-                      model.errors.add property[0],
-                        I18n.t("activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{pair[0]}", value: value)
-                    end
-                  when 'inclusion'
-                    in_array = pair[1][:in]
-                    unless value.in? in_array
-                      model.errors.add property[0],
-                        I18n.t("activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{pair[0]}", value: value)
-                    end
-                  end
-                end
-              end
-            end
-          end
-
-          define_method :jsonb_ignored_properties do |properties|
-            properties.map do |property|
-              property[0].to_s if property[1][:object].field_type == 'file'
-            end.compact
-          end
-        end)
+        build_form_class name, simple_properties, more_properties
       end
     end
   end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::ClassBuilder
+  def build_form_class(name, simple_properties, more_properties)
+    Object.const_set(name, Class.new(::Tramway::Core::ApplicationForm) do
+      properties(*simple_properties.keys) if simple_properties.keys.any?
+
+      include Tramway::Core::ExtendableFormsHelpers::Submit::ObjectHelpers
+      include Tramway::Core::ExtendableFormsHelpers::Validators
+      extend Tramway::Core::ExtendableFormsHelpers::Submit::ClassHelpers
+      extend Tramway::Core::ExtendableFormsHelpers::PropertiesHelper
+      extend Tramway::Core::ExtendableFormsHelpers::MorePropertiesHelper
+      extend Tramway::Core::ExtendableFormsHelpers::IgnoredPropertiesHelper
+
+      define_submit_method simple_properties, more_properties
+      define_properties_method simple_properties, more_properties
+      define_ignored_properties_method
+
+      more_properties.each do |property|
+        define_property_method property[0]
+
+        case property[1][:object].field_type
+        when 'file'
+          field = property[1][:object]
+          define_file_property_assignment_method property field
+        else
+          next unless property[1][:validates].present?
+
+          define_assignment_method property
+        end
+      end
+    end)
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::IgnoredPropertiesHelper
+  def define_ignored_properties_method
+    define_method :jsonb_ignored_properties do |properties|
+      properties.map do |property|
+        property[0].to_s if property[1][:object].field_type == 'file'
+      end.compact
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::MorePropertiesHelper
+  def define_property_method(property_name)
+    define_method property_name do
+      model.values[property_name] if model.values
+    end
+  end
+
+  def define_assignment_method(property)
+    define_method "#{property[0]}=" do |value|
+      property[1][:validates].each do |pair|
+        make_validates property[0], pair, value
+      end
+    end
+  end
+
+  def define_file_property_assignment_method(property, field)
+    define_method "#{property[0]}=" do |value|
+      file_instance = property[1][:association_model].find_or_create_by(
+        "#{model.class.name.underscore}_id" => model.id, "#{field.class.name.underscore}_id" => field.id
+      )
+      file_instance.file = value
+      file_instance.save!
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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])
+      end
+      more_properties.reduce(hash) do |h, property|
+        h.merge! property[0] => {
+          extended_form_property: property[1][:object]
+        }
+      end
+    end
+  end
+end

data/app/forms/tramway/core/extendable_forms_helpers/submit/class_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::Submit::ClassHelpers
+  def define_submit_method(simple_properties, more_properties)
+    define_method 'submit' do |params|
+      model.values ||= {}
+      extended_params = extended(simple_properties, more_properties, params)
+      params.each do |key, value|
+        method_name = "#{key}="
+        send method_name, value if respond_to?(method_name)
+      end
+      model.values = extended_params.reduce(model.values) do |hash, pair|
+        hash.merge! pair[0] => pair[1]
+      end
+      super(params) && model.errors.empty?
+    end
+  end
+end

data/app/forms/tramway/core/extendable_forms_helpers/submit/object_helpers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::Submit::ObjectHelpers
+  def extended(simple_properties, more_properties, params)
+    params.except(*simple_properties.keys).except(*jsonb_ignored_properties(more_properties)).permit!.to_h
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tramway::Core::ExtendableFormsHelpers::Validators
+  def make_validates(property_name, validation, value)
+    case validation[0].to_s
+    when 'presence'
+      presence_validator property_name, validation, value
+    when 'inclusion'
+      inclusion_validator property_name, validation, value
+    end
+  end
+
+  def presence_validator(property_name, validation, value)
+    validator_object = PresenceValidator.new(attributes: :not_blank)
+    return if validation[1] == 'false'
+    return if validation[1] == 'true' && validator_object.send(:valid?, value)
+
+    model.errors.add(
+      property_name,
+      I18n.t(
+        "activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{validation[0]}",
+        value: value
+      )
+    )
+  end
+
+  def inclusion_validator(property_name, validation, value)
+    in_array = validation[1][:in]
+
+    return if value.in? in_array
+
+    model.errors.add(
+      property_name,
+      I18n.t(
+        "activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{validation[0]}",
+        value: value
+      )
+    )
+  end
+end

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

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-module Tramway
-  module Core
-    module CopyToClipboardHelper
-      def copy_to_clipboard(id)
-        button_tag class: 'btn btn-info clipboard-btn',
-                   data: { clipboard_action: 'copy', clipboard_target: "##{id}" },
-                   style: 'margin-left: 15px' do
-          fa_icon 'copy'
-        end
-      end
+module Tramway::Core::CopyToClipboardHelper
+  def copy_to_clipboard(id)
+    button_tag class: 'btn btn-info clipboard-btn',
+               data: { clipboard_action: 'copy', clipboard_target: "##{id}" },
+               style: 'margin-left: 15px' do
+      fa_icon 'copy'
     end
   end
 end

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

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
-module Tramway
-  module Core
-    module TitleHelper
-      def title(page_title = default_title)
-        if @application.present?
-          title_text = "#{page_title} | #{@application.try(:title) || @application.public_name}"
-          content_for(:title) { title_text }
-        else
-          error = Tramway::Error.new(plugin: :core, method: :title, message: 'You should set Tramway::Core::Application class using `::Tramway::Core.initialize_application model_class: #{model_class_name}` in config/initializers/tramway.rb OR maybe you don\'t have any records of application model')
-          raise error.message
-        end
-      end
+module Tramway::Core::TitleHelper
+  def title(page_title = default_title)
+    if @application.present?
+      title_text = "#{page_title} | #{@application.try(:title) || @application.public_name}"
+      content_for(:title) { title_text }
+    else
+      Tramway::Error.raise_error(:tramway, :core, :title_helper, :title, :you_should_set_tramway_core_application)
+    end
+  end
 
-      def default_title
-        t('.title')
-      end
+  def default_title
+    t('.title')
+  end
 
-      def page_title(action, model_name)
-        if I18n.locale == :ru
-          t("helpers.actions.#{action}") + ' ' + genitive(model_name)
-        else
-          t("helpers.actions.#{action}") + ' ' + model_name.model_name.human.downcase
-        end
-      end
+  def page_title(action, model_name)
+    if I18n.locale == :ru
+      t("helpers.actions.#{action}") + ' ' + genitive(model_name)
+    else
+      t("helpers.actions.#{action}") + ' ' + model_name.model_name.human.downcase
     end
   end
 end

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

@@ -2,52 +2,50 @@
 
 require 'carrierwave/orm/activerecord' if defined?(CarrierWave::Mount)
 
-module Tramway
-  module Core
-    class ApplicationRecord < ActiveRecord::Base
-      self.abstract_class = true
-      audited
-      extend ::Enumerize
-
-      state_machine :state, initial: :active do
-        state :active
-        state :removed
-
-        event :remove do
-          transition active: :remove
-        end
-      end
+class Tramway::Core::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+  audited
+  extend ::Enumerize
 
-      scope :active, -> { where state: :active }
-      scope :created_by_user, ->(user_id) { joins(:audits).where('audits.action = \'create\' AND audits.user_id = ?', user_id) }
-      scope :admin_scope, ->(_arg) { all }
+  state_machine :state, initial: :active do
+    state :active
+    state :removed
 
-      include ::PgSearch::Model
+    event :remove do
+      transition active: :remove
+    end
+  end
 
-      def creator
-        audits.where(action: :create).first.user
-      end
+  scope :active, -> { where state: :active }
+  scope :created_by_user, lambda { |user_id|
+    joins(:audits).where('audits.action = \'create\' AND audits.user_id = ?', user_id)
+  }
+  scope :admin_scope, ->(_arg) { all }
 
-      # FIXME: detect inhertited locales
-      class << self
-        def human_attribute_name(attribute_name, *_args)
-          excepted_attributes = %w[created_at updated_at state]
-          if attribute_name.to_s.in? excepted_attributes
-            I18n.t "activerecord.attributes.tramway/core/application_record.#{attribute_name}"
-          else
-            super attribute_name
-          end
-        end
-
-        def search_by(*attributes, **associations)
-          pg_search_scope :full_text_search, against: attributes, associated_against: associations
-        end
-      end
+  include ::PgSearch::Model
 
-      # FIXME: detect inhertited locales
-      def human_state_name
-        I18n.t "activerecord.state_machines.tramway/core/application_record.state.states.#{state}"
+  def creator
+    audits.where(action: :create).first.user
+  end
+
+  # FIXME: detect inhertited locales
+  class << self
+    def human_attribute_name(attribute_name, *_args)
+      excepted_attributes = %w[created_at updated_at state]
+      if attribute_name.to_s.in? excepted_attributes
+        I18n.t "activerecord.attributes.tramway/core/application_record.#{attribute_name}"
+      else
+        super attribute_name
       end
     end
+
+    def search_by(*attributes, **associations)
+      pg_search_scope :full_text_search, against: attributes, associated_against: associations
+    end
+  end
+
+  # FIXME: detect inhertited locales
+  def human_state_name
+    I18n.t "activerecord.state_machines.tramway/core/application_record.state.states.#{state}"
   end
 end