biovision 0.0.200518.1 → 0.1.210414.0

data/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/app/jobs/send_phone_confirmation_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Send phone confirmation code via SMS gateway
+class SendPhoneConfirmationJob < ApplicationJob
+  queue_as :default
+
+  # @param [Integer] id
+  def perform(id)
+    code = Code.find_by(id: id)
+
+    return if code.nil?
+
+    # To be implemented: use actual gateway
+    code.user.phone
+  end
+end

data/app/lib/biovision/components/base/component_parameters.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Base
+      # Getting and setting component parameters
+      module ComponentParameters
+        def use_parameters?
+          false
+        end
+
+        # Receive parameter value with default
+        #
+        # Returns value of component's parameter or default value
+        # when it's not found
+        #
+        # @param [String] key
+        # @param [String] default
+        # @return [String]
+        def receive(key, default = '')
+          @component.get(key, default)
+        end
+
+        # Receive parameter value or nil
+        #
+        # Returns value of component's parameter of nil when it's not found
+        #
+        # @param [String] key
+        # @return [String]
+        def [](key)
+          @component.get(key)
+        end
+
+        # Set parameter
+        #
+        # @param [String] key
+        # @param [String] value
+        def []=(key, value)
+          @component[key] = value unless key.blank?
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/base/component_privileges.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Base
+      # Handling component privileges
+      module ComponentPrivileges
+        # @param [String|Array] privileges
+        # @deprecated use #role? or #permit?
+        def allow?(*privileges)
+          permit?(*privileges)
+        end
+
+        # @param [String] action
+        # @param [Object] context
+        def permit?(action = 'default', context = nil)
+          return false if user.nil?
+
+          parts = []
+          model = model_from_context(context)
+          parts << model.table_name if model.respond_to?(:table_name)
+          parts << action
+          owner?(context) || role?(parts.join('.'))
+        end
+
+        # @param [ApplicationRecord|nil] entity
+        def owner?(entity)
+          return false unless entity.respond_to?(:owned_by?)
+
+          entity.owned_by?(user)
+        end
+
+        # @param [String] role_name
+        def role?(role_name)
+          return false if user.nil?
+          return true if user.super_user? || administrator?
+
+          role = Role[role_name]
+          return false if role.nil?
+
+          Array(user.data['role_cache']).include?(role.id)
+        end
+
+        # @param [Class|Object] context
+        # @return Class
+        def model_from_context(context)
+          context.is_a?(Class) ? context : context.class
+        end
+
+        def create_roles
+          slugs = %w[view edit]
+          model_roles = %w[list view create edit destroy]
+          model_roles.each { |role| slugs << "simple_images.#{role}" }
+          self.class.dependent_models.each do |model|
+            model_roles.each { |role| slugs << "#{model.table_name}.#{role}" }
+          end
+
+          slugs.each do |slug|
+            Role.create(biovision_component: component, slug: slug)
+          end
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/base/component_settings.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Base
+      # Normalizing component settings
+      module ComponentSettings
+        def settings_flags
+          []
+        end
+
+        def settings_numbers
+          []
+        end
+
+        def settings_strings
+          []
+        end
+
+        # @param [Hash] data
+        def normalize_settings(data)
+          result = {}
+          settings_flags.each { |f| result[f] = data[f].to_i == 1 }
+          settings_numbers.each { |n| result[n] = data[n].to_i }
+          settings_strings.each { |s| result[s] = data[s].to_s }
+
+          result
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/base/privilege_handler.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Base
+      # Handling user privileges in component
+      class PrivilegeHandler
+        attr_accessor :component
+
+        # @param [BaseComponent] component
+        def initialize(component)
+          @component = component
+        end
+
+        # @param [String|Symbol]
+        def privilege?(slug)
+          return false if @component.user_link.nil?
+
+          privileges = Array(@component.user_link.data['privileges'])
+          privileges.include?(slug)
+        end
+
+        def administrator!
+          return if @component.user.nil?
+
+          link = @component.user_link!
+          link.administrator = true
+          link.save
+        end
+
+        def not_administrator!
+          return if @component.user.nil? || @component.user_link.nil?
+
+          @component.user_link.update(administrator: false)
+        end
+
+        # @param [Array] new_privileges
+        def privileges=(new_privileges)
+          return if @component.user.nil?
+
+          link = @component.user_link!
+          link.data['privileges'] = Array(new_privileges).uniq
+          link.save
+        end
+
+        # @param [Hash] new_settings
+        def settings=(new_settings)
+          return if @component.user.nil?
+
+          link = @component.user_link!
+          link.data['settings'] = new_settings
+          link.save
+        end
+
+        # @param [String] slug
+        def add_privilege(slug)
+          return if @component.user.nil?
+
+          link = @component.user_link!
+          link.data['privileges'] ||= []
+          link.data['privileges'] += [slug.to_s]
+          link.data['privileges'].uniq!
+          link.save
+        end
+
+        # @param [String] slug
+        def remove_privilege(slug)
+          link = @component.user_link
+
+          return if link.nil?
+
+          link.data['privileges'] ||= []
+          link.data['privileges'] -= [slug.to_s]
+          link.save
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/base_component.rb

@@ -4,12 +4,14 @@ module Biovision
   module Components
     # Base biovision component
     class BaseComponent
-      extend ComponentSettings
+      extend Base::ComponentSettings
+      include Base::ComponentPrivileges
+      include Base::ComponentParameters
 
       attr_reader :component, :slug, :name, :user, :user_link
 
       # @param [BiovisionComponent] component
-      # @param [User] user
+      # @param [User|nil] user
       def initialize(component, user = nil)
         @component = component
         @slug = component&.slug || 'base'
@@ -29,7 +31,11 @@ module Biovision
       end
 
       def self.slug
-        to_s.demodulize.underscore.gsub('_component', '')
+        to_s.demodulize.to_s.underscore.gsub('_component', '')
+      end
+
+      def self.active?
+        BiovisionComponent[slug]&.active?
       end
 
       # Receive component-specific handler by class name for component.
@@ -48,10 +54,16 @@ module Biovision
       end
 
       # Privilege names for using in biovision_component_user.data
+      # @deprecated use roles instead
       def self.privilege_names
         []
       end
 
+      # Model list for automatic role creation
+      def self.dependent_models
+        []
+      end
+
       # @param [User] user
       def self.privileged?(user)
         return false if user.nil? || user.banned?
@@ -64,6 +76,19 @@ module Biovision
         false
       end
 
+      # @param [ApplicationRecord] entity
+      # @param [Symbol|nil] scope
+      # @param [Hash] options
+      def self.form_options(entity, scope = :admin, options = {})
+        table_name = entity.class.table_name
+        prefix = scope.nil? ? '' : "/#{scope}"
+        {
+          model: scope.nil? ? entity : [scope, entity],
+          id: "#{entity.class.to_s.underscore}-form",
+          data: { check_url: "#{prefix}/#{table_name}/check" }
+        }.merge(options)
+      end
+
       # @param [User] user
       def user=(user)
         @user = user
@@ -83,10 +108,6 @@ module Biovision
         @user_link
       end
 
-      def use_parameters?
-        false
-      end
-
       def use_settings?
         use_parameters? || @component.settings.any?
       end
@@ -97,22 +118,6 @@ module Biovision
         user.super_user? || @user_link&.administrator?
       end
 
-      # @param [String|Array] privileges
-      def allow?(*privileges)
-        return false if user.nil?
-        return true if administrator? || (component.nil? && privileges.blank?)
-        return false if @user_link.nil?
-
-        result = privileges.blank?
-        privileges.flatten.each { |slug| result |= privilege?(slug) }
-        result
-      end
-
-      # @param [String] privilege_name
-      def privilege?(privilege_name)
-        privilege_handler.privilege?(privilege_name)
-      end
-
       # @param [Hash] data
       def settings=(data)
         @component.settings.merge!(self.class.normalize_settings(data))
@@ -123,36 +128,6 @@ module Biovision
         @component.settings
       end
 
-      # Receive parameter value with default
-      #
-      # Returns value of component's parameter or default value
-      # when it's not found
-      #
-      # @param [String] key
-      # @param [String] default
-      # @return [String]
-      def receive(key, default = '')
-        @component.get(key, default)
-      end
-
-      # Receive parameter value or nil
-      #
-      # Returns value of component's parameter of nil when it's not found
-      #
-      # @param [String] key
-      # @return [String]
-      def [](key)
-        @component.get(key)
-      end
-
-      # Set parameter
-      #
-      # @param [String] key
-      # @param [String] value
-      def []=(key, value)
-        @component[key] = value unless key.blank?
-      end
-
       # @param [String] name
       # @param [Integer] quantity
       def register_metric(name, quantity = 1)
@@ -170,7 +145,29 @@ module Biovision
       end
 
       def privilege_handler
-        @privilege_handler ||= PrivilegeHandler.new(self)
+        @privilege_handler ||= Base::PrivilegeHandler.new(self)
+      end
+
+      # @param [User] user
+      # @param [String] code_type
+      # @param [Integer] quantity
+      def find_or_create_code(user, code_type, quantity = 1)
+        @component.find_or_create_code(user, code_type, quantity)
+      end
+
+      # @param [String|Symbol] key
+      # @param default_value
+      def data_value(key, default_value = '')
+        data = user.component_data(slug)
+        data.key?(key.to_s) ? data[key.to_s] : default_value
+      end
+
+      # @param [String|Symbol] key
+      # @param new_value
+      def update_data_value(key, new_value)
+        data = user.component_data(slug)
+        data[key.to_s] = new_value
+        user.new_component_data(data)
       end
     end
   end

data/app/lib/biovision/components/contact_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Contact and feedback
+    class ContactComponent < BaseComponent
+      SETTING_FEEDBACK_MAIL = 'feedback_email'
+
+      def self.settings_strings
+        [SETTING_FEEDBACK_MAIL]
+      end
+
+      def self.dependent_models
+        [ContactMethod, ContactType, FeedbackResponse, FeedbackMessage]
+      end
+
+      def use_parameters?
+        true
+      end
+    end
+  end
+end

data/app/lib/biovision/components/content_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Content
+    class ContentComponent < BaseComponent
+      def self.privilege_names
+        %w[content_manager]
+      end
+
+      def self.dependent_models
+        [DynamicBlock, NavigationGroupPage, NavigationGroup, DynamicPage]
+      end
+
+      def use_parameters?
+        true
+      end
+
+      # @param [ApplicationRecord] entity
+      # @deprecated use #permit?
+      def editable?(entity)
+        return false if entity.nil?
+
+        permit?('edit', entity)
+      end
+    end
+  end
+end