tramway-core 1.17.2.1 → 1.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63c3cd63ade145dc9d56b1ed79122789322b6956273157b8d81a65ee8b9107af
-  data.tar.gz: 36e9210fe35bd7e33d218b786354b71a2ad1a316cb33252345a3ae5b49a5b6b3
+  metadata.gz: bcffbf3198b80ae53e95b4368e1759f1fb7371c5b1b45d8f9e8d946878c29ad3
+  data.tar.gz: cfa47aa8309e0546e6771f940cea2039be641cb05e564b9cd6c3bb8120b8f6b0
 SHA512:
-  metadata.gz: 6f95be747fa6d661b575968a76053a0cee7092460d1ae919aa055f4db7a18b1fa9810a1bd76d5c2af4f667b379a836c95461e7c7060ef9f1aeb16a8f5bfe9515
-  data.tar.gz: a2e82ebb362b3d275aa4bec8e16c49ad6946dd36af98fb9dc5b09251a0b54178ce8115a5e1fe2cff8b121b99f06ed4d4f4579ee9317cb4cc64f85e19e91a69ca
+  metadata.gz: 2f29524aa40533858f4589e9627363ff84ab9869ac385e88e12ae3edaf3f125bb87ad19c3a9356f4f109c30ce6f63abf19219914c1ced479af3d73a52b23f557
+  data.tar.gz: e715d84c64fa02f09fe5ac54e5136a8f0ae199ac1094a6e27f846cd82e25edd1aa2a1843500924cb80ff3c69915836c2ca9a8926977fb2178d2d83dbe3e6323e

data/README.md

@@ -203,8 +203,10 @@ Tramway::Admin.set_singleton_models Organization, project: :organization # now y
 * models - часто используемые в моделях слова
 * state_machines - локализация состояний
 
-## Contributing
-Contribution directions go here.
+## Contributors
+
+* [Pavel Kalashnikov](https://github.com/kalashnikovisme)
+* [moshinaan](https://github.com/moshinaan)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-module Tramway
-  module Core
-    class ApplicationController < ActionController::Base
-      before_action :application
-      before_action :load_extensions
+class Tramway::Core::ApplicationController < ActionController::Base
+  before_action :application
+  before_action :load_extensions
 
-      def application
-        @application = ::Tramway::Core.application_object
-      end
+  def application
+    @application = ::Tramway::Core.application_object
+  end
+
+  def load_extensions
+    ::Tramway::Extensions.load if defined? ::Tramway::Extensions
+  end
 
-      def load_extensions
-        ::Tramway::Extensions.load if defined? ::Tramway::Extensions
-      end
-    end
+  def model_class
+    params[:model].constantize
   end
 end

data/app/decorators/tramway/core/application_decorator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'tramway/error'
+require 'tramway/helpers/class_name_helpers'
 
 class Tramway::Core::ApplicationDecorator
   include ActionView::Helpers
@@ -8,6 +9,8 @@ class Tramway::Core::ApplicationDecorator
   include ::FontAwesome5::Rails::IconHelper
   include ::Tramway::Core::CopyToClipboardHelper
   include ::Tramway::Core::Associations::ObjectHelper
+  include ::Tramway::Core::Attributes::ViewHelper
+  include ::Tramway::ClassNameHelpers
 
   def initialize(object)
     @object = object
@@ -18,8 +21,10 @@ class Tramway::Core::ApplicationDecorator
   end
 
   def title
-    error = Tramway::Error.new(plugin: :core, method: :title, message: "Please, implement `title` method in a #{self.class} or #{object.class}")
-    raise error.message
+    Tramway::Error.raise_error(
+      :tramway, :core, :application_decorator, :title, :please_implement_title,
+      class_name: self.class, object_class: object.class
+    )
   end
 
   delegate :id, to: :object
@@ -65,17 +70,11 @@ class Tramway::Core::ApplicationDecorator
     end
   end
 
-
   def link
     if object.try :file
       object.file.url
     else
-      error = Tramway::Error.new(
-        plugin: :core,
-        method: :link,
-        message: "Method `link` uses `file` attribute of the decorated object. If decorated object doesn't contain `file`, you shouldn't use `link` method."
-      )
-      raise error.message
+      Tramway::Error.raise_error :tramway, :core, :application_decorator, :link, :method_link_uses_file_attribute
     end
   end
 
@@ -98,25 +97,12 @@ class Tramway::Core::ApplicationDecorator
   def attributes
     object.attributes.reduce({}) do |hash, attribute|
       if attribute[0].in? RESERVED_WORDS
-        error = Tramway::Error.new(
-          plugin: :core,
-          method: :attributes,
-          message: "Method `#{attribute[0]}` is reserved word. Please, create or delegate method in #{self.class.name} with another name."
+        Tramway::Error.raise_error(
+          :tramway, :core, :application_decorator, :attributes, :method_is_reserved_word,
+          attribute_name: attribute[0], class_name: self.class.name
         )
-        raise error.message
-      end
-      value = try(attribute[0]) ? send(attribute[0]) : object.send(attribute[0])
-      if attribute[0].to_s.in? object.class.state_machines.keys.map(&:to_s)
-        hash.merge! attribute[0] => state_machine_view(object, attribute[0])
-      elsif value.class.in? [ActiveSupport::TimeWithZone, DateTime, Time]
-        hash.merge! attribute[0] => datetime_view(attribute[1])
-      elsif value.class.superclass == ApplicationUploader
-        hash.merge! attribute[0] => image_view(object.send(attribute[0]))
-      elsif value.is_a? Enumerize::Value
-        hash.merge! attribute[0] => enumerize_view(value)
-      else
-        hash.merge! attribute[0] => value
       end
+      hash.merge! attribute[0] => build_viewable_value(object, attribute)
     end
   end
 

data/app/decorators/tramway/core/associations/class_helper.rb

@@ -16,7 +16,7 @@ module Tramway::Core::Associations::ClassHelper
     end
 
     define_method "add_#{association_name}_form" do
-      "Admin::#{object.class.to_s.pluralize}::Add#{association_name.to_s.camelize.singularize}Form".constantize.new object
+      add_association_form_class_name(object, association_name).new object
     end
   end
 
@@ -25,22 +25,16 @@ module Tramway::Core::Associations::ClassHelper
       decorate_association association_name
     end
   end
+
   def define_main_association_method(association_name, decorator)
     define_method association_name do
       association = object.class.reflect_on_association(association_name)
-      if association.nil?
-        error = Tramway::Error.new(plugin: :core, method: :decorate_association, message: "Model #{object.class} does not have association named `#{association_name}`")
-        raise error.message
-      end
-      decorator_class_name = decorator || "#{class_name(association).to_s.singularize}Decorator".constantize
-      if association.class.in? [ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasAndBelongsToManyReflection]
-        return object.send(association_name).active.map do |association_object|
-          decorator_class_name.decorate association_object
-        end
-      end
-      if association.class == ActiveRecord::Reflection::BelongsToReflection
-        return decorator_class_name.decorate object.send association_name
+      check_association object, association_name, association
+      decorator_class_name = decorator || decorator_class_name(class_name(association))
+      if association_type(association).in? %i[has_many has_and_belongs_to_many]
+        return associations_collection(object, association_name, decorator_class_name)
       end
+      return decorator_class_name.decorate object.send association_name if association_type(association) == :belongs_to
     end
   end
 end

data/app/decorators/tramway/core/associations/object_helper.rb

@@ -6,10 +6,36 @@ module Tramway::Core::Associations::ObjectHelper
       object.send(association.name).class
     else
       unless association.options[:class_name]
-        error = Tramway::Error.new(plugin: :core, method: :decorate_association, message: "Please, specify `#{association_name}` association class_name in #{object.class} model. For example: `has_many :#{association_name}, class_name: '#{association_name.to_s.singularize.camelize}'`")
-        raise error.message
+        Tramway::Error.raise_error(
+          :tramway, :core, :associations, :object_helper, :please_specify_association_name,
+          association_name: association.name, object_class: object.class,
+          association_class_name: association.name.to_s.singularize.camelize
+        )
       end
       association.options[:class_name]
     end
   end
+
+  def check_association(object, association_name, association)
+    return unless association.nil?
+
+    Tramway::Error.raise_error(
+      :tramway, :core, :associations, :class_helper, :model_does_not_have_association,
+      object_class: object.class, association_name: association_name
+    )
+  end
+
+  def association_type(association)
+    association.class.to_s.split('::').last.sub(/Reflection$/, '').underscore.to_sym
+  end
+
+  def associations_collection(object, association_name, decorator_class_name)
+    object.send(association_name).active.map do |association_object|
+      decorator_class_name.decorate association_object
+    end
+  end
+
+  def add_association_form_class_name(object, association_name)
+    "Admin::#{object.class.to_s.pluralize}::Add#{association_name.to_s.camelize.singularize}Form".constantize
+  end
 end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Tramway::Core::Attributes::ViewHelper
+  def build_viewable_value(object, attribute)
+    value = try(attribute[0]) ? send(attribute[0]) : object.send(attribute[0])
+    return state_machine_view(object, attribute[0]) if state_machine? object, attribute[0]
+
+    view_by_value object, value, attribute
+  end
+
+  def state_machine?(object, attribute_name)
+    attribute_name.to_s.in? object.class.state_machines.keys.map(&:to_s)
+  end
+
+  def view_by_value(object, value, attribute)
+    if value.class.in? [ActiveSupport::TimeWithZone, DateTime, Time]
+      datetime_view(attribute[1])
+    elsif value.class.superclass == ApplicationUploader
+      image_view(object.send(attribute[0]))
+    elsif value.is_a? Enumerize::Value
+      enumerize_view(value)
+    else
+      value
+    end
+  end
+end

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

@@ -13,37 +13,58 @@ module Tramway::Core::Concerns::AttributesDecoratorHelper
     object.send "human_#{attribute_name}_name"
   end
 
+  BASE64_REGEXP = %r{^(?:[a-zA-Z0-9+/]{4})*(?:|(?:[a-zA-Z0-9+/]{3}=)|
+                                            (?:[a-zA-Z0-9+/]{2}==)|(?:[a-zA-Z0-9+/]{1}===))$}x.freeze
+
   def image_view(original, thumb: nil, filename: nil)
-    if original.present?
-      thumb ||= original.is_a?(CarrierWave::Uploader::Base) ? original.small : nil
-      filename ||= original.is_a?(CarrierWave::Uploader::Base) ? original.path&.split('/')&.last : nil
-      src_thumb = if thumb&.is_a?(CarrierWave::Uploader::Base)
-                    thumb.url
-                  elsif thumb&.match(%r{^(?:[a-zA-Z0-9+/]{4})*(?:|(?:[a-zA-Z0-9+/]{3}=)|(?:[a-zA-Z0-9+/]{2}==)|(?:[a-zA-Z0-9+/]{1}===))$})
-                    "data:image/jpeg;base64,#{thumb}"
-                  else
-                    thumb
-                  end
-      src_original = if original.is_a?(CarrierWave::Uploader::Base)
-                       original.url
-                     elsif original.match(%r{^(?:[a-zA-Z0-9+/]{4})*(?:|(?:[a-zA-Z0-9+/]{3}=)|(?:[a-zA-Z0-9+/]{2}==)|(?:[a-zA-Z0-9+/]{1}===))$})
-                       "data:image/jpeg;base64,#{original}"
-                     else
-                       original
-                     end
-      content_tag(:div) do
-        begin
-          concat image_tag src_thumb || src_original
-        rescue NoMethodError => e
-          error = Tramway::Error.new plugin: :core, method: :image_view, message: "You should mount PhotoUploader to your model. Just add `mount_uploader \#{attribute_name}, PhotoUploader` to your model. #{e.message}"
-          raise error.message
-        end
-        concat link_to(fa_icon(:download), src_original, class: 'btn btn-success', download: filename) if filename
-      end
+    return unless original.present?
+
+    filename ||= build_filename(original)
+    content_tag(:div) do
+      build_div_content src_original(original), src_thumb(original, thumb), filename || build_filename(original)
     end
   end
 
   def enumerize_view(value)
     value.text
   end
+
+  private
+
+  def src_thumb(original, thumb)
+    thumb ||= original.is_a?(CarrierWave::Uploader::Base) ? original.small : nil
+    if thumb&.is_a?(CarrierWave::Uploader::Base)
+      thumb.url
+    elsif thumb&.match(BASE64_REGEXP)
+      "data:image/jpeg;base64,#{thumb}"
+    else
+      thumb
+    end
+  end
+
+  def src_original(original)
+    if original.is_a?(CarrierWave::Uploader::Base)
+      original.url
+    elsif original.match(BASE64_REGEXP)
+      "data:image/jpeg;base64,#{original}"
+    else
+      original
+    end
+  end
+
+  def build_filename(original)
+    original.is_a?(CarrierWave::Uploader::Base) ? original.path&.split('/')&.last : nil
+  end
+
+  def build_div_content(original, thumb, filename)
+    begin
+      concat image_tag src_thumb(original, thumb) || src_original(original)
+    rescue NoMethodError => e
+      Tramway::Error.raise_error(
+        :tramway, :core, :concerns, :attributes_decorator_helper, :you_should_mount_photo_uploader,
+        message: e.message, attribute_name: attribute_name
+      )
+    end
+    concat link_to(fa_icon(:download), src_original(original), class: 'btn btn-success', download: filename) if filename
+  end
 end

data/app/decorators/tramway/core/delegating/class_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway::Core::Delegating::ClassHelper
   def delegate_attributes(*attributes)
     attributes.each do |attr|

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

@@ -1,179 +1,130 @@
 # frozen_string_literal: true
 
-module Tramway::Core
-  class ApplicationForm < ::Reform::Form
-    def initialize(object = nil)
-      object ||= self.class.model_class.new
-      super(object).tap do
-        @@model_class = object.class
-        @@enumerized_attributes = object.class.try :enumerized_attributes
-        @@associations ||= []
-
-        self.class.full_class_name_associations.each do |association, class_name|
-          if class_name.is_a? Array
-            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?
-                raise Tramway::Error.new(plugin: :core, method: :initialize, message: 'Polymorphic association class is nil. Maybe, you should write `assocation #{association_name}` after `properties #{association_name}_id, #{association_name}_type`')
-              else
-                super association_class.find value.split('_')[-1]
-                send "#{association}_type=", association_class.to_s
-              end
-            end
-          else
-            self.class.send(:define_method, "#{association}=") do |value|
-              super class_name.find value
-            end
-          end
-        end
-
-        delegating object
+class Tramway::Core::ApplicationForm < ::Reform::Form
+  include Tramway::Core::ApplicationForms::AssociationObjectHelpers
+  include Tramway::Core::ApplicationForms::ConstantObjectActions
+  include Tramway::Core::ApplicationForms::PropertiesObjectHelper
+
+  attr_accessor :submit_message
+
+  def initialize(object = nil)
+    object ||= self.class.model_class.new
+    super(object).tap do
+      @@model_class = object.class
+      @@enumerized_attributes = object.class.try :enumerized_attributes
+      @@associations ||= []
+
+      self.class.full_class_name_associations&.each do |association, class_name|
+        define_association_method association, class_name
       end
-    end
 
-    def submit(params)
-      if params
-        if validate params
-          begin
-            save
-          rescue StandardError => e
-            error = Tramway::Error.new(plugin: :core, method: :submit, message: "Looks like you have method `#{e.name.to_s.gsub('=', '')}` in #{@@model_class}. You should rename it or rename property in #{self.class}")
-            raise error.message
-          end
-        else
-          @@associations.each do |association|
-            if errors.details[association] == [{ error: :blank }]
-              model.send("#{association}=", send(association))
-            end
-          end
-        end
-      else
-        error = Tramway::Error.new(plugin: :core, method: :submit, message: 'ApplicationForm::Params should not be nil')
-        raise error.message
-      end
+      delegating object
     end
+  end
 
-    def model_name
-      @@model_class.model_name
+  def submit(params)
+    if params
+      validate(params) ? save : collecting_associations_errors
+    else
+      Tramway::Error.raise_error(:tramway, :core, :application_form, :submit, :params_should_not_be_nil)
     end
+  end
 
-    def associations
-      @@associations
-    end
+  def model_name
+    @@model_class.model_name
+  end
 
-    def form_properties(**args)
-      @form_properties = args
-    end
+  def associations
+    @@associations
+  end
 
-    def form_properties_additional(**args)
-      @form_properties_additional = args
-    end
+  def to_model
+    self
+  end
 
-    def properties
-      return @form_properties if @form_properties
+  def persisted?
+    model.id.nil?
+  end
 
-      yaml_config_file_path = Rails.root.join('app', 'forms', "#{self.class.name.underscore}.yml")
-      if 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
-      else
-        []
-      end
-    end
+  class << self
+    include Tramway::Core::ApplicationForms::ConstantClassActions
 
-    def build_errors; end
+    delegate :defined_enums, to: :model_class
 
-    def delegating(object)
-      methods = %i[to_key errors]
-      methods.each do |method|
-        self.class.send(:define_method, method) do
-          object.send method
-        end
-      end
+    def association(property)
+      properties property
+      @@associations = ((defined?(@@associations) && @@associations) || []) + [property]
     end
 
-    def attributes
-      properties.reduce({}) do |hash, property|
-        hash.merge! property.first => model.values[property.first.to_s]
-      end
+    def associations(*properties)
+      properties.each { |property| association property }
     end
 
-    class << self
-      delegate :defined_enums, to: :model_class
-
-      def association(property)
-        properties property
-        @@associations ||= []
-        @@associations << property
-      end
-
-      def associations(*properties)
-        properties.each do |property|
-          association property
-        end
-      end
+    def full_class_name_associations
+      @@associations&.reduce({}) do |hash, association|
+        options = @@model_class.reflect_on_all_associations(:belongs_to).select do |a|
+          a.name == association.to_sym
+        end.first&.options
 
-      def full_class_name_associations
-        @@associations&.reduce({}) do |hash, association|
-          options = @@model_class.reflect_on_all_associations(:belongs_to).select do |a|
-            a.name == association.to_sym
-          end.first&.options
-
-          if options
-            if options[:polymorphic]
-              hash.merge! association => @@model_class.send("#{association}_type").values
-            else
-              class_name = options[:class_name] || association.to_s.camelize
-              hash.merge!(association => class_name.constantize)
-            end
-          end
-          hash
+        if options&.dig(:polymorphic)
+          hash.merge! association => @@model_class.send("#{association}_type").values
+        elsif options
+          hash.merge!(association => (options[:class_name] || association.to_s.camelize).constantize)
         end
+        hash
       end
+    end
 
-      def full_class_name_association(association_name)
-        full_class_name_associations[association_name]
-      end
+    def full_class_name_association(association_name)
+      full_class_name_associations[association_name]
+    end
 
-      def enumerized_attributes
-        @@enumerized_attributes
-      end
+    def reflect_on_association(*args)
+      @@model_class.reflect_on_association(*args)
+    end
 
-      def reflect_on_association(*args)
-        @@model_class.reflect_on_association(*args)
-      end
+    def enumerized_attributes
+      @@enumerized_attributes
+    end
 
-      def model_class
-        if defined?(@@model_class) && @@model_class
-          @@model_class
-        else
-          model_class_name ||= name.to_s.sub(/Form$/, '')
-          begin
-            @@model_class = model_class_name.constantize
-          rescue StandardError
-            error = Tramway::Error.new(plugin: :core, method: :model_class, message: "There is not model class name for #{name}. Should be #{model_class_name} or you can use another class to initialize form object or just initialize form with object.")
-            raise error.message
-          end
+    def model_class
+      if defined?(@@model_class) && @@model_class
+        @@model_class
+      else
+        model_class_name ||= name.to_s.sub(/Form$/, '')
+        begin
+          @@model_class = model_class_name.constantize
+        rescue StandardError
+          Tramway::Error.raise_error :tramway, :core, :application_form, :model_class, :there_is_not_model_class,
+            name: name, model_class_name: model_class_name
         end
       end
+    end
 
-      def model_class=(name)
-        @@model_class = name
-      end
+    def model_class=(name)
+      @@model_class = name
+    end
 
-      def validation_group_class
-        ActiveModel
+    def validates(attribute, **options)
+      if !defined?(@@model_class) || @@model_class.nil?
+        Tramway::Error.raise_error(:tramway, :core, :application_form, :validates, :you_need_to_set_model_class)
       end
+      @@model_class.validates attribute, **options
+    end
+  end
 
-      def validates(attribute, **options)
-        if !defined?(@@model_class) || @@model_class.nil?
-          error = Tramway::Error.new(plugin: :core, method: :validates, message: 'You need to set `model_class` name while using validations. Just write `self.model_class = YOUR_MODEL_NAME` in the class area.')
-          raise error.message
-        end
-        @@model_class.validates attribute, **options
-      end
+  private
+
+  def collecting_associations_errors
+    @@associations.each do |association|
+      model.send("#{association}=", send(association)) if errors.details[association] == [{ error: :blank }]
     end
   end
+
+  def save
+    super
+  rescue StandardError => e
+    Tramway::Error.raise_error :tramway, :core, :application_form, :submit, :looks_like_you_have_method,
+      method_name: e.name.to_s.gsub('=', ''), model_class: @@model_class, class_name: self.class
+  end
 end