tramway-core 1.17.1 → 1.17.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb727078bfed96a01a6730fbc8e529cc8ad32ff1214e6032a38ca50ba482eea
-  data.tar.gz: df33625fbd52d7072883ead0ba561c9d0b4c0e3504dc8413d945a2c7b9ebe2da
+  metadata.gz: e25693262017e7eb7b500db8ed733e26ed5c841f4e5eca94b036f422114c8f8e
+  data.tar.gz: 9cc1274352800f545610e01d2c02485c3ef2837bd2d413041818462682496e04
 SHA512:
-  metadata.gz: b49d4439ca1f4e2d5320edb0e65c9eba652a5b5f378b0ac9d42c9e5442582d07ceae9968733a28f915199ea86286b8b5560903b2176d0d39e747ad8249bb87cc
-  data.tar.gz: 75a7a039ffaa3de0c247a893daec0475d3ed9d16a39b7157df88c4ef46754b283515f7df017fff0a608f6bcbd9c77a5225a5070a3b60375500648fc4c3409929
+  metadata.gz: 796e723d4c64a741d72b2d25a769e1344d895805dda3ba55da9c6f4161252a416ade82f2439217599a60605c6d29e6292be4b165a56f0c26343eeeba6ca9ce85
+  data.tar.gz: 9991a6ecf790a5ce4ed3b0064d3cc2392336359bcf095416b91a9ee6d152e19d1487826ab9a85d7c1df4913a426375128955c602b1501ff5b273319ca49db211

data/README.md

@@ -33,7 +33,53 @@ Tramway::Core.initialize_application model_class: ::Tramway::Conference::Unity #
 Rails.application.config.assets.precompile += %w( *.jpg *.png *.js )
 ```
 # Usage
+
 ## Decorators
+### Associations
+
+Your can decorate association models. Supporting all types of association
+
+*app/decorators/your_model_decorator.rb*
+```ruby
+class YourModelDecorator < Tramway::Core::ApplicationDecorator
+  decorate_association :some_model
+  decorate_association :another_model, decorator: SpecificDecoratorForThisCase
+  decorate_association :another_one_model, as: :repeat_here_as_parameter_from_model
+  decorate_association :something_else_model, state_machines: [ :here_array_of_state_machines_you_want_to_see_in_YourModel_show_page ] # support from tramway-admin gem
+end
+```
+
+You can decorate a lot of models in one line
+
+*app/decorators/your_model_decorator.rb*
+```ruby
+class YourModelDecorator < Tramway::Core::ApplicationDecorator
+  decorate_associations :some_model, :another_model, :another_one_model, :something_else_model
+end
+```
+
+Also, you can configurate what associations you want to see in YourModel page in admin panel *support only for [tramway-admin](https://rubygems.org/gems/tramway-admin) gem*
+
+*app/decorators/your_model_decorator.rb*
+```ruby
+class YourModelDecorator < Tramway::Core::ApplicationDecorator
+  class << self
+    def show_associations
+      [ :some_model, :another_model, :another_one_model ]
+    end
+  end
+end
+```
+
+### Delegating attributes
+
+*app/decorators/your_model_decorator.rb*
+```ruby
+class YourModelDecorator < Tramway::Core::ApplicationDecorator
+  delegate_attributes :title, :something_else, :another_atttribute
+end
+```
+
 ### Helper methods
 
 #### date_view
@@ -106,6 +152,39 @@ 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
 ```
 
+## 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 model organization name:text public_name:text tagline:text address:text phone:text coordinates:point, state: text # remember! State field is required, if you use tramway-admin
+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!'
+```
+
+#### 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
 
 # Базовые классы
 
@@ -124,8 +203,10 @@ copy_to_clipboard "some_id" # some_id is HTML id of element. Content of this ele
 * 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/assets/javascripts/tramway/core/application.js

@@ -28,7 +28,7 @@ $(document).ready(function() {
     console.log('You should set `window.current_locale` before all Javascript code');
   }
 
-  if ($('.date_picker').length == 0) {
+  if ($('.date_picker').length != 0) {
     $('.date_picker').datepicker({
       format: window.current_locale.date_format,
       language: window.current_locale.locale

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,12 +21,18 @@ 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
+  delegate :human_state_name, to: :object
+
   class << self
     include ::Tramway::Core::Associations::ClassHelper
+    include ::Tramway::Core::Delegating::ClassHelper
 
     def collections
       [:all]
@@ -61,19 +70,11 @@ class Tramway::Core::ApplicationDecorator
     end
   end
 
-  delegate :id, to: :object
-  delegate :human_state_name, to: :object
-
   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
 
@@ -96,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway::Core::Associations::ClassHelper
   def decorate_association(association_name, decorator: nil, as: nil, state_machines: [])
     @@decorated_associations ||= []
@@ -14,27 +16,25 @@ 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
 
+  def decorate_associations(*association_names)
+    association_names.each do |association_name|
+      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

@@ -1,13 +1,41 @@
+# frozen_string_literal: true
+
 module Tramway::Core::Associations::ObjectHelper
   def class_name(association)
     if association.polymorphic?
-      object.send(association_name).class
+      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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Tramway::Core::Delegating::ClassHelper
+  def delegate_attributes(*attributes)
+    attributes.each do |attr|
+      delegate attr, to: :object
+    end
+  end
+end