tramway-core 1.17.2.2 → 1.17.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c612a0122da3218a86e61b973beff51f378e14352fd424489130039694f82f8
-  data.tar.gz: 07d47a9b6e995469f7b500e34b21f705cc24ce1e4aede1e946ace36f5ddebb28
+  metadata.gz: e25693262017e7eb7b500db8ed733e26ed5c841f4e5eca94b036f422114c8f8e
+  data.tar.gz: 9cc1274352800f545610e01d2c02485c3ef2837bd2d413041818462682496e04
 SHA512:
-  metadata.gz: 8b275c112e32864152637a34c283677de289fc2fb5e79123fd15f149656e0d3741c1b7768e06d441004927e4fe5db0f4af2a744a55e6fdc58fe210227e1b7ce7
-  data.tar.gz: 350ace536d11005778f241370a3179f5f51f9078d8822ca4e80955aeb0ffb93edbafc64e55d9635d0cba4e4cc4ef8b3fd6f3aa205a7171542b25e6500c82d281
+  metadata.gz: 796e723d4c64a741d72b2d25a769e1344d895805dda3ba55da9c6f4161252a416ade82f2439217599a60605c6d29e6292be4b165a56f0c26343eeeba6ca9ce85
+  data.tar.gz: 9991a6ecf790a5ce4ed3b0064d3cc2392336359bcf095416b91a9ee6d152e19d1487826ab9a85d7c1df4913a426375128955c602b1501ff5b273319ca49db211

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

@@ -1,18 +1,14 @@
 # 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
-    end
+  def load_extensions
+    ::Tramway::Extensions.load if defined? ::Tramway::Extensions
   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
@@ -69,12 +74,7 @@ class Tramway::Core::ApplicationDecorator
     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
 
@@ -97,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
 
@@ -29,19 +29,12 @@ module Tramway::Core::Associations::ClassHelper
   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/forms/tramway/core/application_form.rb

@@ -54,7 +54,7 @@ class Tramway::Core::ApplicationForm < ::Reform::Form
 
         if options&.dig(:polymorphic)
           hash.merge! association => @@model_class.send("#{association}_type").values
-        elsif options.present?
+        elsif options
           hash.merge!(association => (options[:class_name] || association.to_s.camelize).constantize)
         end
         hash

data/lib/tramway/core.rb

@@ -30,6 +30,10 @@ module Tramway::Core
       end
     end
 
+    def root
+      File.dirname __dir__
+    end
+
     attr_reader :application
   end
 end

data/lib/tramway/core/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Core
-    VERSION = '1.17.2.2'
+    VERSION = '1.17.2.3'
   end
 end

data/lib/tramway/error.rb

@@ -19,10 +19,10 @@ class Tramway::Error < RuntimeError
 
   class << self
     def raise_error(*coordinates, **options)
-      @errors ||= YAML.load_file('..', '..', 'yaml', 'errors.yml').with_indifferent_access
+      @errors ||= YAML.load_file("#{Tramway::Core.root}/yaml/errors.yml").with_indifferent_access
       error = @errors.dig(*coordinates)
       options.each do |pair|
-        error.gsub!("%{#{pair[0]}}", pair[1])
+        error.gsub!("%{#{pair[0]}}", pair[1].to_s)
       end
       raise error
     end

data/lib/yaml/errors.yml

@@ -0,0 +1,35 @@
+tramway:
+  collections:
+    helper:
+      collection_list_by:
+        there_no_such_collection: "There no such collection named %{name_camelize}. Please create class with self method `list` and extended of `Tramway::Collection`. You should reload your server after creating this collection."
+  core:
+    title_helper:
+      title:
+        you_should_set_tramway_core_application: "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"
+    application_form:
+      initialize:
+        polymorphic_class_is_nil: "Polymorphic association class is nil. Maybe, you should write `assocation #{association_name}` after `properties #{association_name}_id, #{association_name}_type`"
+      validates:
+        you_need_to_set_model_class: 'You need to set `model_class` name while using validations. Just write `self.model_class = YOUR_MODEL_NAME` in the class area.'
+      submit:
+        looks_like_you_have_method: "Looks like you have method `%{method_name}` in %{model_class}. You should rename it or rename property in %{class_name}"
+        params_should_not_be_nil: "ApplicationForm::Params should not be nil"
+      model_class: 
+        there_is_not_model_class: "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."
+    concerns:
+      attribute_decorator_helper:
+        you_should_mount_photo_uploader: "You should mount PhotoUploader to your model. Just add `mount_uploader %{attribute_name}, PhotoUploader` to your model. %{message}"
+    associations:
+      object_helper:
+        please_specify_association_name: "Please, specify `%{association_name}` association class_name in %{object_class} model. For example: `has_many :%{association_name}, class_name: '%{association_class_name}'`"
+      class_helper:
+        model_does_not_have_association: "Model %{object_class} does not have association named `%{association_name}`"
+    application_decorator:
+      attributes:
+        method_is_reserved_word: "Method `%{attribute_name}` is reserved word. Please, create or delegate method in %{class_name} with another name."
+      title:
+        please_implement_title: "Please, implement `title` method in a %{class_name} or %{object_class}"
+      link:
+        method_link_uses_file_attribute: "Method `link` uses `file` attribute of the decorated object. If decorated object doesn't contain `file`, you shouldn't use `link` method."
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway-core
 version: !ruby/object:Gem::Version
-  version: 1.17.2.2
+  version: 1.17.2.3
 platform: ruby
 authors:
 - Pavel Kalashnikov
@@ -358,6 +358,7 @@ files:
 - app/decorators/tramway/core/application_decorator.rb
 - app/decorators/tramway/core/associations/class_helper.rb
 - app/decorators/tramway/core/associations/object_helper.rb
+- app/decorators/tramway/core/attributes/view_helper.rb
 - app/decorators/tramway/core/concerns/attributes_decorator_helper.rb
 - app/decorators/tramway/core/delegating/class_helper.rb
 - app/forms/tramway/core/application_form.rb
@@ -422,6 +423,7 @@ files:
 - lib/tramway/error.rb
 - lib/tramway/helpers/class_name_helpers.rb
 - lib/validators/presence_validator.rb
+- lib/yaml/errors.yml
 homepage: https://github.com/purple-magic/tramway-core
 licenses:
 - MIT