tramway-core 1.18.0.4 → 1.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc4e360083a946fd3e4d022ed65747d56f21a42adb46cda0224d6873cf8db42d
-  data.tar.gz: c1a39ccd53513c8ab09d9d2e1ff576b9c309ba7f07e7f2238b03501dfb20057b
+  metadata.gz: fcd0a4e310b681ce9df9a69b0cdb7df805937bee30e54d2b37dc77e1a059f0b3
+  data.tar.gz: 5a9ef583926f1d2b99a6a338f1b368e360c941978ec3f1f0489e8b733f76eacd
 SHA512:
-  metadata.gz: 77f182880e0b69605f74e99a660ce5d855efc2b37f3179fd38df111fd9eaae0bd7fb67adaa1b6a3ed16bf0b779508e99da07062b203f25f005d66d432741ae00
-  data.tar.gz: aec229afedc05c8353a4a499f50c91dea8510a0e8ffb5dec7756f241a61ef4f62cd1fcd0586fa80ccffa287be0c8fa76909af35592abfeadcf85ea6f0f8a7303
+  metadata.gz: cdd784f851074f4ed1bb2d5291b80bf4e064f46403e1850352c5304f74a439d2032475c16254a59b1e3ffd645ed7ee9ee6337a9cfdb641d88c888696b45c119e
+  data.tar.gz: 9ce88aa8ae79eccd838a6e52e18792fabe16cf8b6de3b1a7f37235d6f3286e58f9275092cd59deaeea48a711ce273de85a33bd817c8b300556fc85625e979679

data/README.md

@@ -34,7 +34,32 @@ Rails.application.config.assets.precompile += %w( *.jpg *.png *.js )
 ```
 # Usage
 
-## Decorators
+## Tramway::Core::ApplicationRecord
+
+### uploader
+
+Tramway use [carrierwave](https://github.com/carrierwaveuploader/carrierwave) for file uploading by default. To mount uploader you should use `uploader` method
+
+Interface: `uploader(attribute_name, uploader_name, **options)`
+
+* attribute_name - ActiveRecord attribute to mount uploader
+* uploader_name - **short** uploader name. You need to connect uploaders which are compatible with Tramway. Available uploaders:
+  * :photo - you can see it [here](https://github.com/Purple-Magic/tramway-core/blob/develop/app/uploaders/photo_uploader.rb)
+  * :file - you can see it [here](https://github.com/Purple-Magic/tramway-core/blob/develop/app/uploaders/file_uploader.rb)
+  * :ico - you can see [here](https://github.com/Purple-Magic/tramway-core/blob/develop/app/uploaders/ico_uploader.rb)
+* options - you are available to set options for uploaders exactly for this model. Available options:
+  * versions - **only for :photo**. Set needed versions for file to be cropped. If empty - 0 zero versions will be used. All versions you can see [here](https://github.com/Purple-Magic/tramway-core/blob/develop/app/uploaders/photo_uploader.rb)
+  * extensions - whitelist of file extensions. If empty will be used default whitelist from the uploaders (links above)
+
+Example:
+
+```ruby
+class User < Tramway::Core::ApplicationRecord
+  uploader :avatar, :photo, version: [ :small, :medium ], extensions: [ :jpg, :jpeg ]
+end
+```
+
+## Tramway::Core::ApplicationDecorator
 ### Associations
 
 Your can decorate association models. Supporting all types of association
@@ -157,7 +182,7 @@ copy_to_clipboard "some_id" # some_id is HTML id of element. Content of this ele
 #### 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 favicon:text # remember! State field is required, if you use tramway-admin
+rails g tramway:core:application
 rails db:migrate
 ```
 

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

@@ -15,4 +15,8 @@ class Tramway::Core::ApplicationController < ActionController::Base
   def model_class
     params[:model].constantize
   end
+
+  def authenticated_user
+    (defined?(current_user) && current_user.try(:model)) || (defined?(current_admin) && current_admin.model)
+  end
 end

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

@@ -68,6 +68,10 @@ class Tramway::Core::ApplicationDecorator
     def model_name
       model_class.try(:model_name)
     end
+
+    def filters
+      {}
+    end
   end
 
   def link

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

@@ -29,12 +29,17 @@ 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)
+      type = association_type(association)
+      return if association_has_one_without_object(object, association_name, type)
+
       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)
+      case type
+      when :has_many, :has_and_belongs_to_many
+        associations_collection(object, association_name, decorator_class_name)
+      when :belongs_to, :has_one
+        decorator_class_name.decorate(association_object(object, association_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

@@ -36,6 +36,23 @@ module Tramway::Core::Associations::ObjectHelper
   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
+    form_class = "Admin::#{object.class.to_s.pluralize}::Add#{association_name.to_s.camelize.singularize}Form"
+
+    begin
+      form_class.constantize
+    rescue StandardError
+      Tramway::Error.raise_error(
+        :tramway, :core, :associations, :object_helper, :habtm_add_class_not_defined,
+        class: form_class, association_name: association_name
+      )
+    end
+  end
+
+  def association_has_one_without_object(object, association_name, association_type)
+    association_type == :has_one && object.send(association_name).nil?
+  end
+
+  def association_object(object, association_name)
+    object.send association_name
   end
 end

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

@@ -24,7 +24,7 @@ module Tramway::Core::ExtendableFormsHelpers::ClassBuilder
           field = property[1][:object]
           define_file_property_assignment_method property, field
         else
-          #next unless property[1][:validates].present?
+          # next unless property[1][:validates].present?
 
           define_assignment_method property
         end

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

@@ -5,20 +5,14 @@ module Tramway::Core::ExtendableFormsHelpers::Submit::ClassHelpers
     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
+      every_attribute_set params
       model.values = extended_params.reduce(model.values) do |hash, pair|
         hash.merge! pair[0] => pair[1]
       end
 
       return unless model.errors.empty?
-      params.each { |key, value| send("#{key}=", value) }
-      result = save
-      result.tap do
-        collecting_associations_errors unless result
-      end
+
+      save_in_submit params
     end
   end
 end

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

@@ -4,4 +4,18 @@ 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
+
+  def every_attribute_set(params)
+    params.each do |key, value|
+      method_name = "#{key}="
+      send(method_name, value) if respond_to?(method_name)
+    end
+  end
+
+  def save_in_submit(_params)
+    result = save
+    result.tap do
+      collecting_associations_errors unless result
+    end
+  end
 end

data/app/helpers/tramway/core/inputs/associations_helper.rb

@@ -2,9 +2,10 @@
 
 module Tramway::Core::Inputs::AssociationsHelper
   def build_collection_for_association(form_object, property)
+    user = defined?(current_user) ? current_user : current_admin
     full_class_name_association = form_object.class.full_class_name_association(property)
     check_valid_association full_class_name_association
-    full_class_name_association.active.send("#{current_user.role}_scope", current_user.id).map do |obj|
+    full_class_name_association.active.send("#{user.role}_scope", user.id).map do |obj|
       decorator_class(full_class_name_association).decorate obj
     end.sort_by(&:name)
   end

data/app/helpers/tramway/core/inputs/polymorphic_associations_helper.rb

@@ -2,8 +2,9 @@
 
 module Tramway::Core::Inputs::PolymorphicAssociationsHelper
   def build_collection_for_polymorphic_association(form_object, property)
+    user = defined?(current_user) ? current_user : current_admin
     object_names = full_class_names(form_object, property).map do |class_name|
-      class_name.active.send("#{current_user.role}_scope", current_user.id).map do |obj|
+      class_name.active.send("#{user.role}_scope", user.id).map do |obj|
         decorator_class(class_name).decorate obj
       end
     end.flatten

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

@@ -12,7 +12,7 @@ class Tramway::Core::ApplicationRecord < ActiveRecord::Base
     state :removed
 
     event :remove do
-      transition active: :remove
+      transition active: :removed
     end
   end
 
@@ -46,11 +46,16 @@ class Tramway::Core::ApplicationRecord < ActiveRecord::Base
     def uploader(attribute_name, uploader_name, **options)
       mount_uploader attribute_name, "#{uploader_name.to_s.camelize}Uploader".constantize
       @versions = options[:versions] if uploader_name == :photo
+      @extensions = options[:extensions]
     end
 
     def photo_versions
       @versions
     end
+
+    def file_extensions
+      @extensions
+    end
   end
 
   # FIXME: detect inhertited locales

data/app/uploaders/file_uploader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class FileUploader < ApplicationUploader
-  def extension_white_list
-    %w[pdf doc docx xls csv xlsx jpg svg png jpeg gif]
+  def extension_whitelist
+    model.class.file_extensions || %w[pdf doc docx xls csv xlsx jpg svg png jpeg gif]
   end
 end

data/app/uploaders/ico_uploader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class IcoUploader < ApplicationUploader
+  def extension_whitelist
+    model.class.file_extensions || %w[ico]
+  end
+end

data/app/uploaders/image_defaults.rb

@@ -8,7 +8,7 @@ module ImageDefaults
       [mounted_as, version_name].compact.join('_') << '.gif'
   end
 
-  def extension_white_list
-    %w[jpg jpeg gif png]
+  def extension_whitelist
+    model.class.file_extensions || %w[jpg jpeg gif png]
   end
 end

data/lib/tramway/core/version.rb

@@ -2,6 +2,6 @@
 
 module Tramway
   module Core
-    VERSION = '1.18.0.4'
+    VERSION = '1.18.3'
   end
 end

data/lib/tramway/error.rb

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

data/lib/yaml/errors.yml

@@ -29,6 +29,7 @@ tramway:
     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}'`"
+        habtm_add_class_not_defined: "You should define class `%{class}` to be able add and remove `%{association_name}`"
       class_helper:
         model_does_not_have_association: "Model %{object_class} does not have association named `%{association_name}`"
     application_decorator:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway-core
 version: !ruby/object:Gem::Version
-  version: 1.18.0.4
+  version: 1.18.3
 platform: ruby
 authors:
 - Pavel Kalashnikov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited
@@ -361,6 +361,7 @@ files:
 - app/models/tramway/core/application_record.rb
 - app/uploaders/application_uploader.rb
 - app/uploaders/file_uploader.rb
+- app/uploaders/ico_uploader.rb
 - app/uploaders/image_defaults.rb
 - app/uploaders/photo_uploader.rb
 - app/views/tramway/core/404.haml