cmor_core_backend 0.0.1.pre

data/config/locales/en.yml

@@ -0,0 +1,49 @@
+en:
+  activerecord:
+    models:
+      active_storage/attachment:
+        one: Attachment
+        other: Attachments
+      active_storage/blob:
+        one: BLOB
+        other: BLOBs
+      delayed/backend/active_record/job:
+        one: Job
+        other: Jobs
+    attributes:
+      active_storage/attachment:
+        id: ID
+        name: Name
+        record_type: Record Type
+        record_id: Record ID
+        record: Record
+        blob_id: BLOB ID
+        blob: BLOB
+        created_at:  Created at
+      active_storage/blob:
+        id: ID
+        key: Key
+        filename: Filename
+        content_type: Content Type
+        metadata: Metadata
+        byte_size: Byte size
+        checksum: Checksum
+        created_at: Created at
+      delayed/backend/active_record/job:
+        id: ID
+        priority: Priority
+        attempts: Attempts
+        handler: Handler
+        last_error: Last error
+        run_at: Run at
+        locked_at: Locked at
+        failed_at: Failed at
+        locked_by: Locked by
+        queue: Queue
+        created_at: Created at
+        updated_at: Updated at
+  classes:
+    cmor/core/backend/engine: Core
+  routes:
+    cmor-core-backend-engine: core
+  or: or

data/config/routes.rb

@@ -0,0 +1,9 @@
+Cmor::Core::Backend::Engine.routes.draw do
+  resources :delayed_backend_active_record_jobs if Cmor::Core::Backend::Configuration.enable_delayed_job_backend
+  namespace :active_storage do
+    resources :blobs , only: [:index, :show, :destroy]
+    resources :attachments , only: [:index, :show, :destroy]
+  end if Cmor::Core::Backend::Configuration.enable_active_storage_backend
+
+  root to: 'home#index'
+end

data/lib/cmor/core/backend.rb

@@ -0,0 +1,13 @@
+require "cmor/core/backend/configuration"
+require "cmor/core/backend/engine"
+
+module Cmor
+  module Core
+    module Backend
+      extend Configuration
+    end
+  end
+end
+
+Cmor.configure { |c| c.register_configuration(:core_backend, Cmor::Core::Backend) }
+Cmor.configure { |c| c.register_configuration(:administrador, Administrador) }

data/lib/cmor/core/backend/configuration.rb

@@ -0,0 +1,49 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Cmor
+  module Core
+    module Backend
+      module Configuration
+        def configure
+          yield self
+        end
+
+        mattr_accessor :registered_controllers do
+          lambda do
+            [
+              # Cmor::Contact::Backend::FoosController
+            ]
+          end
+        end
+
+        mattr_accessor :registered_services do
+          lambda do
+            []
+          end
+        end
+
+        mattr_accessor(:enable_active_storage_backend) { false }
+        mattr_accessor(:enable_delayed_job_backend) { false }
+
+        def self.registered_controllers
+          rc = @@registered_controllers.call
+          rc.reject! { |c| c.name =~ /.*ActiveStorage.*/ } unless enable_active_storage_backend
+          rc.reject! { |c| c.name =~ /.*Delayed.*/ } unless enable_delayed_job_backend
+          -> { rc }
+        end
+
+        mattr_accessor(:image_variant_options) {
+          {
+            gallery: { resize: "640x480" },
+            table:   { resize: "160x120" }
+          }
+        }
+
+        def self.image_variant_options_for(identifier)
+          @@image_variant_options[identifier]
+        end
+      end
+    end
+  end
+end

data/lib/cmor/core/backend/engine.rb

@@ -0,0 +1,9 @@
+module Cmor
+  module Core
+    module Backend
+      class Engine < ::Rails::Engine
+        isolate_namespace Cmor::Core::Backend
+      end
+    end
+  end
+end

data/lib/cmor/core/backend/gemspec.rb

@@ -0,0 +1,40 @@
+module Cmor
+  module Core
+    module Backend
+      class Gemspec
+        def self.defaults(s)
+          s.version     = ::Cmor::VERSION
+          s.authors     = ["Roberto Vasquez Angel"]
+          s.email       = ["roberto@vasquez-angel.de"]
+          s.homepage    = "https://github.com/content-management-on-rails"
+          s.license     = "MIT"
+
+          s.files = Dir["{app,config,db,lib,spec}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+
+          s.add_dependency "rails", ">= 5.2.0"
+          s.add_dependency "cmor_core_backend", "= #{Cmor::VERSION}" unless s.files.include?("lib/cmor/core/backend.rb")
+
+          s.add_development_dependency "sqlite3", '~> 1.3.6'
+          s.add_development_dependency 'responders'
+          
+          s.add_development_dependency 'capybara'
+          s.add_development_dependency 'coveralls'
+          s.add_development_dependency 'factory_bot_rails'
+          s.add_development_dependency 'git_log_generator'
+          s.add_development_dependency 'guard-bundler'
+          s.add_development_dependency 'guard-rails'
+          s.add_development_dependency 'guard-rspec'
+          s.add_development_dependency 'pry-rails'
+          s.add_development_dependency 'rails-dummy'
+          s.add_development_dependency 'rails-i18n'
+          s.add_development_dependency 'rao-shoulda_matchers'
+          s.add_development_dependency 'rspec-rails'
+          s.add_development_dependency 'rubocop'
+          s.add_development_dependency 'shoulda-matchers'
+          s.add_development_dependency 'simplecov'
+          s.add_development_dependency 'simplecov-console'
+        end
+      end
+    end
+  end
+end

data/lib/cmor/core/backend/version.rb

@@ -0,0 +1,9 @@
+require 'cmor/version'
+
+module Cmor
+  module Core
+    module Backend
+      VERSION = ::Cmor::VERSION
+    end
+  end
+end

data/lib/cmor_core_backend.rb

@@ -0,0 +1,4 @@
+require "cmor"
+require "administrador"
+
+require "cmor/core/backend"

data/lib/generators/cmor/core/backend/install/install_generator.rb

@@ -0,0 +1,34 @@
+module Cmor
+  module Core
+    module Backend
+      module Generators
+        class InstallGenerator < Rails::Generators::Base
+          desc 'Installs the initializer, routes and itsf_backend integration'
+
+          source_root File.expand_path('../templates', __FILE__)
+
+          attr_reader :cmor_core_backend_enable_active_storage
+          attr_reader :cmor_core_backend_enable_delayed_job
+
+          def initialize(*args)
+            super
+            @cmor_core_backend_enable_active_storage = ENV.fetch('CMOR_CORE_BACKEND_ENABLE_ACTIVE_STORAGE') { false }
+            @cmor_core_backend_enable_delayed_job = ENV.fetch('CMOR_CORE_BACKEND_ENABLE_DELAYED_JOB') { false }
+          end
+
+          def generate_controller
+            copy_file 'backend_controller.rb', 'app/controllers/backend_controller.rb'
+          end
+
+          def generate_initializer
+            template 'initializer.rb', 'config/initializers/cmor_core_backend.rb'
+          end
+
+          def generate_routes
+            route File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/cmor/core/backend/install/templates/backend_controller.rb

@@ -0,0 +1,2 @@
+class BackendController < ApplicationController
+end

data/lib/generators/cmor/core/backend/install/templates/initializer.rb

@@ -0,0 +1,35 @@
+Cmor::Core::Backend.configure do |config|
+  # Set the resources, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_controllers = -> {[
+  #            Cmor::Core::Backend::DelayedBackendActiveRecordJobsController,
+  #            Cmor::Core::Backend::ActiveStorage::BlobsController,
+  #            Cmor::Core::Backend::ActiveStorage::AttachmentsController
+  #          ]}
+  # 
+  config.registered_controllers = -> {[
+    Cmor::Core::Backend::DelayedBackendActiveRecordJobsController,
+    Cmor::Core::Backend::ActiveStorage::BlobsController,
+    Cmor::Core::Backend::ActiveStorage::AttachmentsController
+  ]}
+
+  # Set the services, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_services = -> {[
+  #          ]}
+  # 
+  config.registered_services = -> {[
+  ]}
+
+  # Enable support for ActiveStorage.
+  # 
+  # default: config.enable_active_storage_backend = false
+  # 
+  config.enable_active_storage_backend = <%= cmor_core_backend_enable_active_storage %>
+
+  # Enable support for DelayedJob.
+  #
+  # default: config.enable_delayed_job_backend = false
+  #
+  config.enable_delayed_job_backend = <%= cmor_core_backend_enable_delayed_job %>
+end

data/lib/generators/cmor/core/backend/install/templates/routes.source

@@ -0,0 +1,4 @@
+
+  localized do
+    mount Cmor::Core::Backend::Engine, at: '/backend/cmor-core-backend-engine'
+  end

data/spec/dummy/app/controllers/backend_controller.rb

@@ -0,0 +1,2 @@
+class BackendController < ApplicationController
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ApplicationRecord
+end

data/spec/dummy/bin/delayed_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
+Delayed::Command.new(ARGV).daemonize

data/spec/dummy/config/initializers/administador.rb

@@ -0,0 +1,11 @@
+Administrador.configure do |config|
+  # Methods, that will be tried on a resource to generate a nice title
+  #
+  # Default: config.resource_label_methods = [:human, :name, :email, :to_s]
+  #
+  config.resource_label_methods = [:human, :name, :email, :to_s]
+
+  # config.register_engine 'Ecm::Blog::Backend::Engine', {}
+
+  # config.base_controller_class_name = '::ApplicationController'
+end

data/spec/dummy/config/initializers/cmor_core_backend.rb

@@ -0,0 +1,35 @@
+Cmor::Core::Backend.configure do |config|
+  # Set the resources, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_controllers = -> {[
+  #            Cmor::Core::Backend::DelayedBackendActiveRecordJobsController,
+  #            Cmor::Core::Backend::ActiveStorage::BlobsController,
+  #            Cmor::Core::Backend::ActiveStorage::AttachmentsController
+  #          ]}
+  # 
+  config.registered_controllers = -> {[
+    Cmor::Core::Backend::DelayedBackendActiveRecordJobsController,
+    Cmor::Core::Backend::ActiveStorage::BlobsController,
+    Cmor::Core::Backend::ActiveStorage::AttachmentsController
+  ]}
+
+  # Set the services, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_services = -> {[
+  #          ]}
+  # 
+  config.registered_services = -> {[
+  ]}
+
+  # Enable support for ActiveStorage.
+  # 
+  # default: config.enable_active_storage_backend = false
+  # 
+  config.enable_active_storage_backend = true
+
+  # Enable support for DelayedJob.
+  #
+  # default: config.enable_delayed_job_backend = false
+  #
+  config.enable_delayed_job_backend = true
+end

data/spec/dummy/config/initializers/content_security_policy.rb

@@ -0,0 +1,25 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.config.content_security_policy do |policy|
+#   policy.default_src :self, :https
+#   policy.font_src    :self, :https, :data
+#   policy.img_src     :self, :https, :data
+#   policy.object_src  :none
+#   policy.script_src  :self, :https
+#   policy.style_src   :self, :https
+
+#   # Specify URI for violation reports
+#   # policy.report_uri "/csp-violation-report-endpoint"
+# end
+
+# If you are using UJS then enable automatic nonce generation
+# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Report CSP violations to a specified URI
+# For further information see the following documentation:
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+# Rails.application.config.content_security_policy_report_only = true

data/spec/dummy/config/initializers/i18n.rb

@@ -0,0 +1,2 @@
+Rails.application.config.i18n.available_locales = [:en, :de]
+Rails.application.config.i18n.default_locale    = :de

data/spec/dummy/config/initializers/route_translator.rb

@@ -0,0 +1,3 @@
+RouteTranslator.config do |config|
+  config.force_locale = true
+end

data/spec/dummy/config/initializers/simple_form.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/plataformatec/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
+    b.optional :maxlength
+
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid'
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the default class to be used on forms. Can be overriden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename, :attached? ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
+end