tramway-core 1.16.2 → 1.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc76271757be0c7460400fff39e98dcf26d0b82de5fb53cbf6f1e603d581a2c
-  data.tar.gz: 0d1dbda847666e5a1eee2b1b244d9902706f475019c42c4337ac248ab24c519d
+  metadata.gz: 0c40b8698ddbb5a6d4a3bcd28c91178aea7c2b69ecbd91a3aa0c1c52935acff9
+  data.tar.gz: fa1d9920ee66893ad98b227d48806ba71e932216f927e33124ebd0c98be4d4b3
 SHA512:
-  metadata.gz: 48e33eaa840cebc55156308ec72175a92c8938d930549d768247f9d96b8584662d9eb5648192da535e485070236d5904e340933a3621f9068bde5e6ecb5bc6db
-  data.tar.gz: f2d61018cd3571c8dff6f943a6cceb2f39c1bdc8947f951d1c64a050a9d9c962f7ef1cc9bb1bc525f068f627d6228052727e8be2eb3df837ae302b5daa5c5c80
+  metadata.gz: 289701396c7578d7202d1bbf7bcfd794e360ef258c0396b82b98eacc76049a974a75e122a63e48893bb1cc8fd966e921c0fcc8a642c7dcfde2e45c8bb39b1eb7
+  data.tar.gz: f69609928571b316461d3ddf7d25fc59b5abadb0d0d788c53572d146be06f585400a8736f44d64adab5b7935eca4c3e6387086890f3e3ee2a47bb3f80c1896e6

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
 
 # Базовые классы
 

data/app/assets/javascripts/tramway/core/application.js

@@ -0,0 +1,51 @@
+//= require jquery
+//= require jquery_ujs
+//= require jquery3
+//= require popper
+//= require bootstrap
+//= require bootstrap-datepicker-1.8.0
+//= require bootstrap-datepicker-1.8.0.ru.min
+//= require font_awesome5
+//= require clipboard
+//= require_tree .
+
+window.i18n_locale = function(locale) {
+  switch (locale) {
+    case 'en':
+      return({ date_format: 'yyyy-mm-dd', locale: locale });
+      break;
+    case 'ru':
+      return({ date_format: 'dd.mm.yyyy', locale: locale });
+      break;
+    default:
+      return({ date_format: 'yyyy-mm-dd', locale: locale });
+      break;
+  }
+}
+
+$(document).ready(function() {
+  if (!(window.current_locale)) {
+    console.log('You should set `window.current_locale` before all Javascript code');
+  }
+
+  if ($('.date_picker').length != 0) {
+    $('.date_picker').datepicker({
+      format: window.current_locale.date_format,
+      language: window.current_locale.locale
+    });
+  }
+
+  $('.link').click(function() {
+    const href = $(this).data('href');
+    if (href) {
+      location.href = href;
+    } else {
+      const anchor = $(this).data('anchor');
+      if (!$(anchor).offset() == undefined) {
+        $(window).scrollTop($(anchor).offset().top);
+      }
+    };
+  });
+
+  let clipboard = new Clipboard('.clipboard-btn');
+});

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

@@ -7,6 +7,7 @@ class Tramway::Core::ApplicationDecorator
   include ActionView::Context
   include ::FontAwesome5::Rails::IconHelper
   include ::Tramway::Core::CopyToClipboardHelper
+  include ::Tramway::Core::Associations::ObjectHelper
 
   def initialize(object)
     @object = object
@@ -21,7 +22,13 @@ class Tramway::Core::ApplicationDecorator
     raise error.message
   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]
     end
@@ -49,45 +56,6 @@ class Tramway::Core::ApplicationDecorator
       end
     end
 
-    def decorate_association(association_name, decorator: nil, as: nil, state_machines: [])
-      @@decorated_associations ||= []
-      @@decorated_associations << association_name
-
-      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
-        class_name = if association.polymorphic?
-                       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
-                       end
-                       association.options[:class_name]
-                     end
-        decorator_class_name = decorator || "#{class_name.to_s.singularize}Decorator".constantize
-        if association.class == ActiveRecord::Reflection::HasManyReflection
-          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
-        end
-      end
-
-      define_method "#{association_name}_as" do
-        as
-      end
-
-      define_method "#{association_name}_state_machines" do
-        state_machines
-      end
-    end
-
     def model_class
       to_s.sub(/Decorator$/, '').constantize
     end
@@ -97,8 +65,6 @@ class Tramway::Core::ApplicationDecorator
     end
   end
 
-  delegate :id, to: :object
-  delegate :human_state_name, to: :object
 
   def link
     if object.try :file

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

@@ -0,0 +1,46 @@
+module Tramway::Core::Associations::ClassHelper
+  def decorate_association(association_name, decorator: nil, as: nil, state_machines: [])
+    @@decorated_associations ||= []
+    @@decorated_associations << association_name
+
+    define_main_association_method association_name, decorator
+
+    define_method "#{association_name}_as" do
+      as
+    end
+
+    define_method "#{association_name}_state_machines" do
+      state_machines
+    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
+    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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Tramway::Core::Associations::ObjectHelper
+  def class_name(association)
+    if association.polymorphic?
+      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
+      end
+      association.options[:class_name]
+    end
+  end
+end

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

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

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

@@ -12,11 +12,13 @@ module Tramway::Core
         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 = send("#{association}_type")
+              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.constantize.find value
+                super association_class.find value.split('_')[-1]
+                send "#{association}_type=", association_class.to_s
               end
             end
           else
@@ -34,28 +36,19 @@ module Tramway::Core
       if params
         if validate params
           begin
-            save.tap do
-              # self.class.remove_validations_from_model!
-            end
+            save
           rescue StandardError => e
-            # self.class.remove_validations_from_model!
             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
-          association_error = false
           @@associations.each do |association|
             if errors.details[association] == [{ error: :blank }]
               model.send("#{association}=", send(association))
-              association_error = true
             end
           end
-          (association_error && save).tap do
-            # self.class.remove_validations_from_model!
-          end
         end
       else
-        # self.class.remove_validations_from_model!
         error = Tramway::Error.new(plugin: :core, method: :submit, message: 'ApplicationForm::Params should not be nil')
         raise error.message
       end
@@ -65,6 +58,10 @@ module Tramway::Core
       @@model_class.model_name
     end
 
+    def associations
+      @@associations
+    end
+
     def form_properties(**args)
       @form_properties = args
     end
@@ -176,25 +173,7 @@ module Tramway::Core
           raise error.message
         end
         @@model_class.validates attribute, **options
-        #  @@validations ||= {}
-        #  @@validations.deep_merge! attribute => options
       end
-
-      # FIXME: Removes all validations in a field. We must implement own validations
-
-      # def remove_validations_from_model!
-      #  return unless defined? @@validations
-      #  @@validations&.each do |validation|
-      #    @@model_class.class_eval do
-      #      _validators.except validation[0]
-      #
-      #      binding.pry
-      #      _validate_callbacks.each do |callback|
-      #        callback.raw_filter.attributes.delete validation[0]
-      #      end
-      #    end
-      #  end
-      # end
     end
   end
 end

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

@@ -19,7 +19,7 @@ class Tramway::Core::ExtendableForm
             model.values = extended_params.permit!.to_h.reduce(model.values) do |hash, pair|
               hash.merge! pair[0] => pair[1]
             end
-            super params
+            super(params) && model.errors.empty?
           end
 
           define_method 'properties' do
@@ -51,10 +51,19 @@ class Tramway::Core::ExtendableForm
 
               define_method "#{property[0]}=" do |value|
                 property[1][:validates].each do |pair|
-                  validator_object = "#{pair[0].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)
+                  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

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

@@ -1,12 +1,14 @@
+# 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
+                   data: { clipboard_action: 'copy', clipboard_target: "##{id}" },
+                   style: 'margin-left: 15px' do
+          fa_icon 'copy'
+        end
       end
     end
   end

data/app/uploaders/photo_uploader.rb

@@ -12,7 +12,7 @@ class PhotoUploader < ApplicationUploader
       file.file.match(%r{/system/uploads/.*}).to_s
     else
       default_url = '/assets/tramway/core/mona_lisa_from_prado_square.jpg'
-      File.exists?(default_url) ? default_url : ''
+      File.exist?(default_url) ? default_url : ''
     end
   end
 

data/app/views/tramway/core/shared/input_extended_types/_checkbox.html.haml

@@ -1 +1 @@
-= f.input field.title.to_sym, as: :boolean, input_html: { class: class_name, id: "#{class_name}_#{field.title.to_sym}", name: "#{class_name}[#{field.title}]" }, checked_value: value == field.title.to_sym, required: field.required
+= f.input field.title.to_sym, as: :boolean, input_html: { class: class_name, id: "#{class_name}_#{field.title.to_sym}", name: "#{class_name}[#{field.title}]" }, checked_value: :true, unchecked_value: :false, required: field.required

data/config/locales/en/helpers.yml

@@ -13,6 +13,7 @@ en:
       search: Search
       reset: Reset
       download: Download
+      add: Add
     scope:
       found: Found
     "yes": yes

data/lib/tramway/core/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Core
-    VERSION = '1.16.2'
+    VERSION = '1.17.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tramway-core
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.2
 platform: ruby
 authors:
 - Pavel Kalashnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited
@@ -118,22 +118,22 @@ dependencies:
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -166,22 +166,22 @@ dependencies:
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: pg_search
   requirement: !ruby/object:Gem::Requirement
@@ -228,22 +228,22 @@ dependencies:
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.16.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.16.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
@@ -349,13 +349,16 @@ files:
 - app/assets/images/tramway/core/mona_lisa_from_prado_square.jpg
 - app/assets/javascripts/bootstrap-datepicker-1.8.0.js
 - app/assets/javascripts/bootstrap-datepicker-1.8.0.ru.min.js
-- app/assets/javascripts/tramway/core/application.js.coffee
+- app/assets/javascripts/tramway/core/application.js
 - app/assets/stylesheets/bootstrap-datepicker-1.8.0.css
 - app/assets/stylesheets/tramway/core/application.sass
 - app/controllers/tramway/core/application_controller.rb
 - app/decorators/tramway/core/application_decorated_collection.rb
 - 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/concerns/attributes_decorator_helper.rb
+- app/decorators/tramway/core/delegating/class_helper.rb
 - app/forms/tramway/core/application_form.rb
 - app/forms/tramway/core/extendable_form.rb
 - app/forms/tramway/core/extended_application_form.rb
@@ -424,7 +427,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Core for all Tramway Rails Engines

data/app/assets/javascripts/tramway/core/application.js.coffee

@@ -1,35 +0,0 @@
-#= require jquery
-#= require jquery_ujs
-#= require jquery3
-#= require popper
-#= require bootstrap
-#= require bootstrap-datepicker-1.8.0
-#= require bootstrap-datepicker-1.8.0.ru.min
-#= require font_awesome5
-#= require clipboard
-#= require_tree .
-
-window.i18n_locale = (locale) ->
-  switch locale
-    when 'en' then { date_format: 'yyyy-mm-dd', locale: locale }
-    when 'ru' then { date_format: 'dd.mm.yyyy', locale: locale }
-
-$(document).ready ->
-  unless window.current_locale
-    console.log 'You should set `window.current_locale` before all Javascript code'
-  unless $('.date_picker').length == 0
-    $('.date_picker').datepicker({
-      format: window.current_locale.date_format,
-      language: window.current_locale.locale
-    })
-
-  $('.link').click ->
-    href = $(this).data('href')
-    if href
-      location.href = href
-    else
-      anchor = $(this).data('anchor')
-      unless $(anchor).offset() == undefined
-        $(window).scrollTop $(anchor).offset().top
-
-  clipboard = new Clipboard '.clipboard-btn'