biovision 0.1.210414.0 → 0.12.211128.0

data/app/lib/biovision/helpers/data_helper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Helpers
+    # Helper for receiving model data in controllers
+    class DataHelper
+      attr_reader :model_class
+
+      # @param [ApplicationRecord] model_class
+      # @param [Hash] filters
+      def initialize(model_class, filters = {})
+        @model_class = model_class
+        @filters = filters
+      end
+
+      # @param [Integer] page
+      def administrative_collection(page = 1)
+        paginates = model_class.respond_to?(:page_for_administration)
+        paginates ? administrative_page(page) : administrative_list
+      end
+
+      # @param [User] user
+      # @param [Integer] page
+      def personal_collection(user, page = 1)
+        paginates = model_class.respond_to?(:page_for_owner)
+        paginates ? personal_page(user, page) : personal_list(user)
+      end
+
+      private
+
+      def administrative_list
+        if model_class.respond_to?(:filtered)
+          model_class.filtered(@filters).list_for_administration
+        else
+          model_class.list_for_administration
+        end
+      end
+
+      # @param [Integer] page
+      def administrative_page(page)
+        reflection = model_class.singleton_method(:page_for_administration)
+        if reflection.parameters.include?(%i[key filters])
+          model_class.page_for_administration(page, filters: @filters)
+        else
+          model_class.page_for_administration(page)
+        end
+      end
+
+      # @param [User] user
+      def personal_list(user)
+        if model_class.respond_to?(:filtered)
+          model_class.filtered(@filters).list_for_owner(user)
+        else
+          model_class.list_for_owner(user)
+        end
+      end
+
+      # @param [User] user
+      # @param [Integer] page
+      def personal_page(user, page)
+        reflection = model_class.singleton_method(:page_for_owner)
+        if reflection.parameters.include?(%i[key filters])
+          model_class.page_for_owner(user, page, filters: @filters)
+        else
+          model_class.page_for_owner(user, page)
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/helpers/export_helper.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Helpers
+    # Helper for exporting model data
+    class ExportHelper
+      EXPORT_DIR = "#{Rails.root}/tmp/export"
+      SPECIAL_FIELDS = %w[id agent_id ip_address_id image attachment].freeze
+
+      # @param [Class] model
+      def export_model(model)
+        puts "Exporting model #{model}..."
+        FileUtils.mkdir_p(EXPORT_DIR) unless Dir.exist?(EXPORT_DIR)
+        file_name = "#{EXPORT_DIR}/#{model.table_name}.yml"
+        File.open(file_name, 'wb') do |file|
+          @file = file
+          model.order(:id).each do |entity|
+            @entity = entity
+            export_entity
+          end
+        end
+      end
+
+      private
+
+      def export_entity
+        print "\r#{@entity.id}  "
+        @file.puts "#{@entity.id}:"
+        export_attributes
+      end
+
+      def export_attributes
+        filtered = @entity.attributes.reject { |a, v| ignored?(a) || v.nil? }
+        filtered.each do |attribute, value|
+          export_attribute(attribute, value)
+        end
+        export_track
+        export_media('image') if @entity.attributes.key?('image')
+        export_media('attachment') if @entity.attributes.key?('attachment')
+      end
+
+      # @param [String] attribute
+      # @param value
+      def export_attribute(attribute, value)
+        @file.print "  #{attribute}: "
+        if value.is_a?(Hash)
+          if value.blank?
+            @file.puts '{}'
+          else
+            @file.puts value.to_yaml.gsub(/\A---|\n\z/, '').gsub("\n", "\n    ")
+          end
+        else
+          @file.puts value.inspect
+        end
+      end
+
+      def export_track
+        return unless @entity.is_a?(HasTrack)
+
+        unless @entity.ip_address.nil?
+          @file.puts "  ip_address: #{@entity.ip_address.ip.to_s.inspect}"
+        end
+
+        return if @entity.agent.blank?
+
+        @file.puts "  agent: #{@entity.agent.name.inspect}"
+      end
+
+      def media_dir
+        "#{EXPORT_DIR}/#{@entity.class.table_name}"
+      end
+
+      def export_media(type)
+        media = @entity.send(type.to_sym)
+
+        return if media.blank?
+
+        media_name = File.basename(media.path)
+        dir_name = "#{media_dir}/#{@entity.id}"
+        FileUtils.mkdir_p(dir_name) unless Dir.exist?(dir_name)
+        FileUtils.copy(media.path, "#{dir_name}/#{media_name}")
+        @file.puts "  #{type}: #{media_name.inspect}"
+      end
+
+      # @param [String] attribute
+      def ignored?(attribute)
+        return true if SPECIAL_FIELDS.include?(attribute)
+
+        %w[count cache].each do |ending|
+          return true if attribute.end_with?("_#{ending}")
+        end
+
+        false
+      end
+    end
+  end
+end

data/app/lib/biovision/migrations/component_migration.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Migrations
+    # Mix-ins for repeated component migration parts
+    module ComponentMigration
+      # Component class
+      def component
+        @component ||= find_component
+      end
+
+      # Create component tables and roles
+      #
+      # Creates new BiovisionComponent
+      # For each dependent model, calls "create_<table_name>" method
+      # Creates roles for new component
+      def up
+        component.create
+        component.dependent_models.each do |model|
+          next if model.table_exists?
+
+          message = "create_#{model.table_name}".to_sym
+          send(message) if respond_to?(message, true)
+        end
+        handler = component[nil]
+        handler.create_roles
+        handler.seed if handler.respond_to?(:seed)
+      end
+
+      # Drops tables for each dependent model
+      # Removes BiovisionComponent
+      def down
+        component.dependent_models.reverse.each do |model|
+          drop_table model.table_name if model.table_exists?
+        end
+        BiovisionComponent[component]&.destroy
+      end
+
+      private
+
+      # Find component class by migration name
+      #
+      # Method relies on naming like Create<:CamelCaseSlug>Component
+      #
+      # Example:
+      #   - Migration class is named CreateFooBarComponent
+      #   - Component slug is "foo_bar"
+      #   - Use base component handler to get "FooBarComponent" class
+      def find_component
+        migration = name.to_s.demodulize.to_s.underscore
+        slug = migration.gsub(/\Acreate_/, '').gsub(/_component\z/, '')
+        Biovision::Components::BaseComponent.handler_class(slug)
+      end
+    end
+  end
+end

data/app/lib/biovision/stories/component_story.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Stories
+    # Base component story
+    class ComponentStory
+      attr_accessor :component_handler, :entity
+
+      # @param [Biovision::Components::BaseComponent] handler
+      # @param [ApplicationRecord|String|nil] entity
+      def initialize(handler, entity = nil)
+        self.component_handler = handler
+        return if entity.blank?
+
+        if entity.is_a?(ApplicationRecord)
+          self.entity = entity
+        else
+          self.entity_id = entity.to_s
+        end
+      end
+
+      # Get associated model class
+      #
+      # This method should be implemented in children if story name
+      # does not match model name.
+      # The result is used in #entity_id=
+      def model_class
+        model_name = to_s.demodulize.to_s.underscore.gsub('_story', '')
+        model_name.classify.safe_constantize
+      end
+
+      # @param [Hash] parameters
+      def perform(parameters)
+        @parameters = parameters
+        # implement in children and return hash
+        { result: 'Nothing was processed.' }
+      end
+
+      # Set entity identified by value
+      #
+      # This method can be implemented in child classes
+      #
+      # @param [String] value
+      def entity_id=(value)
+        return if model_class.nil?
+
+        if model_class.respond_to?(:[])
+          self.entity = model_class[value]
+        elsif model_class.respond_to?(:find_by)
+          self.entity = model_class.find_by(id: value)
+        end
+      end
+    end
+  end
+end

data/app/mailers/feedback_mailer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Mailer for sending feedback requests
+class FeedbackMailer < ApplicationMailer
+  # @param [Integer] id
+  def new_feedback_request(id)
+    @entity = FeedbackMessage.find_by(id: id)
+
+    key = Biovision::Components::ContactComponent::SETTING_FEEDBACK_MAIL
+    receiver = Biovision::Components::ContactComponent[nil].settings[key]
+
+    mail to: receiver unless @entity.nil? || receiver.blank?
+  end
+end

data/app/models/biovision_component.rb

@@ -13,16 +13,22 @@
 class BiovisionComponent < ApplicationRecord
   include FlatPriority
   include RequiredUniqueSlug
+  include Toggleable
 
   SLUG_LIMIT = 250
   SLUG_PATTERN_HTML = '^[a-zA-Z][-a-zA-Z0-9_]+[a-zA-Z0-9]$'
 
-  has_many :biovision_component_users, dependent: :delete_all
+  toggleable :active
+
   has_many :simple_images, dependent: :destroy
+  has_many :uploaded_files, dependent: :destroy
   has_many :codes, dependent: :delete_all
+  has_many :roles, dependent: :destroy
+  has_many :groups, dependent: :destroy
 
   scope :active, -> { where(active: true) }
   scope :list_for_administration, -> { ordered_by_priority }
+  scope :list_for_user, -> { active.ordered_by_priority }
 
   # Find component by slug
   #
@@ -39,6 +45,8 @@ class BiovisionComponent < ApplicationRecord
 
   # @param [String] slug
   # @param value
+  #
+  # @deprecated use parameters[slug.to_s] = value
   def []=(slug, value)
     parameters[slug.to_s] = value
     save!
@@ -62,4 +70,12 @@ class BiovisionComponent < ApplicationRecord
 
     code
   end
+
+  def text_for_link
+    I18n.t("biovision.components.#{slug}.name", default: slug)
+  end
+
+  def admin_url
+    "/admin/components/#{slug}"
+  end
 end

data/app/models/browser.rb

@@ -28,7 +28,7 @@ class Browser < ApplicationRecord
 
   scope :list_for_administration, -> { order('name asc, version asc') }
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[banned mobile name version]
   end
 end

data/app/models/code.rb

@@ -17,7 +17,7 @@ class Code < ApplicationRecord
   include HasTrack
 
   BODY_LIMIT = 50
-  QUANTITY_RANGE = (0..32_767).freeze
+  QUANTITY_RANGE = (0..32_767)
 
   belongs_to :biovision_component
   belongs_to :user, optional: true
@@ -40,11 +40,11 @@ class Code < ApplicationRecord
     list_for_administration.page(page)
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[body quantity]
   end
 
-  def self.creation_parameters(*)
+  def self.creation_parameters
     entity_parameters + %i[user_id biovision_component_id]
   end
 
@@ -80,10 +80,10 @@ class Code < ApplicationRecord
     return unless body.nil?
 
     if phone?
+      self.body = SecureRandom.random_number(1_000_000).to_s.rjust(6, '0')
+    else
       number = SecureRandom.random_number(0xffff_ffff_ffff_ffff)
       self.body = number.to_s(36).scan(/.{4}/).join('-').upcase
-    else
-      self.body = SecureRandom.random_number(1_000_000).to_s.rjust(6, '0')
     end
   end
 

data/app/models/concerns/checkable.rb

@@ -13,7 +13,8 @@ module Checkable
       if id.blank?
         entity = new(parameters)
       else
-        entity = find_by(id: id)
+        key = column_names.include?('uuid') && id.include?('-') ? :uuid : :id
+        entity = find_by(key => id)
         entity.assign_attributes(parameters)
       end
       entity

data/app/models/concerns/has_uploaded_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Model references to uploaded file
+module HasUploadedFile
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :uploaded_file, optional: true, counter_cache: :object_count
+
+    scope :included_file, -> { includes(:uploaded_file) }
+  end
+
+  def attachment_name
+    uploaded_file&.name
+  end
+
+  def attachment_size
+    uploaded_file&.file_size
+  end
+
+  def attachment_url
+    return if uploaded_file&.attachment.blank?
+
+    uploaded_file.attachment.url
+  end
+end

data/app/models/concerns/simple_tag.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Adds list of toggleable attributes to model
+#
+# @author Maxim Khan-Magomedov <maxim.km@gmail.com>
+module SimpleTag
+  extend ActiveSupport::Concern
+
+  included do
+
+    before_validation :normalize_name
+    validates_uniqueness_of :name, case_sensitive: false
+
+    scope :list_for_administration, -> { order(:name) }
+
+    def self.entity_parameters
+      %i[name]
+    end
+
+    def self.name_limit
+      100
+    end
+
+    private
+
+    def normalize_name
+      self.name = name.to_s[0..name_limit]
+    end
+  end
+end

data/app/models/concerns/toggleable.rb

@@ -14,7 +14,8 @@ module Toggleable
     def toggle_parameter(attribute)
       return unless toggleable_attributes.include? attribute.to_sym
 
-      toggle! attribute
+      assign_attributes(attribute => !attributes[attribute.to_s])
+      save!
       { attribute => self[attribute] }
     end
   end

data/app/models/concerns/tree_structure.rb

@@ -10,7 +10,10 @@ module TreeStructure
 
     before_save { children_cache.uniq! }
     after_create :cache_parents!
-    after_save { parent&.cache_children! }
+    after_destroy { parent&.cache_children! unless ENV['SKIP_CHILDREN_CACHE'] }
+    after_save { parent&.cache_children! unless ENV['SKIP_CHILDREN_CACHE'] }
+
+    scope :with_parent_id, ->(v) { where(parent_id: v) }
 
     def self.tree(collection)
       result = {}

data/app/models/contact_method.rb

@@ -41,7 +41,7 @@ class ContactMethod < ApplicationRecord
     ContactType[slug]&.contact_methods&.list_for_visitors
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[contact_type_id language_id name priority value visible]
   end
 end

data/app/models/contact_type.rb

@@ -21,7 +21,7 @@ class ContactType < ApplicationRecord
     find_by(slug: slug)
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[slug]
   end
 end

data/app/models/dynamic_block.rb

@@ -33,7 +33,7 @@ class DynamicBlock < ApplicationRecord
     visible.find_by(slug: slug)&.body.to_s
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[body slug visible]
   end
 

data/app/models/dynamic_page.rb

@@ -36,14 +36,16 @@ class DynamicPage < ApplicationRecord
   validates_length_of :slug, maximum: SLUG_LIMIT
   validates_length_of :url, maximum: URL_LIMIT
 
+  scope :visible, -> { where(visible: true) }
   scope :list_for_administration, -> { included_image.order('slug asc, language_id asc nulls first') }
+  scope :search, ->(q) { where('url ilike ? or slug ilike ?', "#{q}%", "#{q}%") unless q.blank? }
 
   # @param [String] slug
   def self.[](slug)
     find_by(slug: slug)
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[body language_id name simple_image_id slug url visible]
   end
 

data/app/models/feedback_message.rb

@@ -53,7 +53,13 @@ class FeedbackMessage < ApplicationRecord
     list_for_administration.page(page)
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[attachment comment email language_id name phone]
   end
+
+  def attachment_name
+    return if attachment.blank?
+
+    File.basename(attachment.path)
+  end
 end

data/app/models/feedback_response.rb

@@ -40,11 +40,11 @@ class FeedbackResponse < ApplicationRecord
     list_for_administration.page(page)
   end
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[body]
   end
 
-  def self.creation_parameters(*)
+  def self.creation_parameters
     entity_parameters + %i[feedback_message_id]
   end
 end

data/app/models/metric.rb

@@ -25,6 +25,10 @@ class Metric < ApplicationRecord
 
   validates_length_of :name, maximum: NAME_LIMIT
 
+  # @param [String] name
+  def self.[](name)
+    find_by(name: name)
+  end
 
   def quantity
     metric_values.sum(:quantity)

data/app/models/navigation_group.rb

@@ -23,11 +23,21 @@ class NavigationGroup < ApplicationRecord
 
   scope :list_for_administration, -> { ordered_by_name }
 
-  def self.entity_parameters(*)
+  def self.entity_parameters
     %i[name slug]
   end
 
   def text_for_link
     name
   end
+
+  # @param [DynamicPage] entity
+  def add_dynamic_page(entity)
+    navigation_group_pages.create(dynamic_page: entity)
+  end
+
+  # @param [DynamicPage] entity
+  def remove_dynamic_page(entity)
+    navigation_group_pages.where(dynamic_page: entity).destroy_all
+  end
 end

data/app/models/oembed_domain.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Domain for OEmbed receiver
+#
+# Attributes:
+#   name [String]
+#   oembed_receiver_id [OembedReceiver]
+class OembedDomain < ApplicationRecord
+  include RequiredUniqueName
+
+  NAME_LIMIT = 255
+
+  belongs_to :oembed_receiver
+
+  validates_length_of :name, maximum: NAME_LIMIT
+
+  # @param [String] name
+  def self.[](name)
+    find_by(name: name.to_s.downcase)
+  end
+
+  def receiver_slug
+    oembed_receiver&.slug
+  end
+end

data/app/models/oembed_link.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Link from oembed tag
+#
+# Attributes:
+#   code [Text], optional
+#   created_at [DateTime]
+#   updated_at [DateTime]
+#   url [String]
+class OembedLink < ApplicationRecord
+  URL_LIMIT = 255
+
+  validates_presence_of :url
+  before_save { self.url = url.to_s[0..(URL_LIMIT - 1)] }
+
+  def self.[](url)
+    find_or_initialize_by(url: url)
+  end
+end

data/app/models/oembed_receiver.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Receiver for OEmbed links
+#
+# Attributes:
+#   slug [String]
+class OembedReceiver < ApplicationRecord
+  include RequiredUniqueSlug
+
+  SLUG_PATTERN = /\A[a-z]+(_?[a-z]+){2,49}\z/
+
+  has_many :oembed_domains, dependent: :delete_all
+
+  validates_format_of :slug, with: SLUG_PATTERN
+end