cmor_system_backend 0.0.6.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7086eaf92f3548322c4c691cbc5338737d9bcfbfe7a9f80f6a1c2b14eb299aae
+  data.tar.gz: 6e9a6b611604b4b4d86d0de173a4df58da7b69d7800f778c6ba723ee77a0cbe4
+SHA512:
+  metadata.gz: 1b13a38fe616f006a40c74ad8cd12f10183e59ed782034351b78229092dec0530f0b05710778bf084a3d0837120d3293993eac5f621fa4678578d4c5701a47ab
+  data.tar.gz: f7ac7aabb84a75e1f1edac96add5e5c081a42119fb4f8780557f62f95f16f41c83892a1911c9c990299f2f8902712b584169a1280e351c862840314b340c1f62

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Roberto Vasquez Angel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Cmor::System::Backend
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmor_system_backend'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cmor_system_backend
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cmor::System::Backend'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rails/dummy/tasks'

data/app/assets/config/cmor_system_backend_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/cmor/system/backend .js
+//= link_directory ../stylesheets/cmor/system/backend .css

data/app/assets/javascripts/cmor/system/backend/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree ./application

data/app/assets/javascripts/cmor_system_backend.js

@@ -0,0 +1 @@
+//= require ./cmor/system/backend/application

data/app/assets/stylesheets/cmor/system/backend/application.css

@@ -0,0 +1,4 @@
+/*
+ *= require_tree ./application
+ *= require_self
+ */

data/app/assets/stylesheets/cmor_system_backend.css

@@ -0,0 +1,3 @@
+/*
+ *= require cmor/system/backend/application
+ */

data/app/controllers/cmor/system/backend/active_storage/attachments_controller.rb

@@ -0,0 +1,27 @@
+module Cmor
+  module System
+    module Backend
+      module ActiveStorage
+        class AttachmentsController < Cmor::Core::Backend::ResourcesController::Base
+          def self.resource_class
+            ::ActiveStorage::Attachment
+          end
+
+          def self.available_rest_actions
+            super - %i(new create edit update)
+          end
+
+          private
+
+          def resource_namespace
+            :active_storage
+          end
+
+          def permitted_params
+            params.require(:attachment).permit(:name, :record_type, :record_id, :blob)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/system/backend/active_storage/blobs_controller.rb

@@ -0,0 +1,27 @@
+module Cmor
+  module System
+    module Backend
+      module ActiveStorage
+        class BlobsController < Cmor::Core::Backend::ResourcesController::Base
+          def self.resource_class
+            ::ActiveStorage::Blob
+          end
+
+          def self.available_rest_actions
+            super - %i(new create edit update)
+          end
+
+          private
+
+          def resource_namespace
+            :active_storage
+          end
+
+          def permitted_params
+            params.require(:blob).permit()
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/system/backend/delayed_backend_active_record_jobs_controller.rb

@@ -0,0 +1,21 @@
+module Cmor
+  module System
+    module Backend
+      class DelayedBackendActiveRecordJobsController < Cmor::Core::Backend::ResourcesController::Base
+        def self.resource_class
+          ::Delayed::Backend::ActiveRecord::Job
+        end
+
+        # def self.available_rest_actions
+        #   %i(index show edit update)
+        # end
+
+        private
+
+        def permitted_params
+          params.require(:delayed_backend_active_record_job).permit(:priority, :attempts, :handler, :last_error, :run_at, :locked_at, :failed_at, :locked_by, :queue)
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/system/backend/home_controller.rb

@@ -0,0 +1,8 @@
+module Cmor
+  module System
+    module Backend
+      class HomeController < Cmor::Core::Backend::HomeController::Base
+      end
+    end
+  end
+end

data/app/views/cmor/system/backend/active_storage/attachments/_index_table.html.haml

@@ -0,0 +1,7 @@
+= table.column :name
+= table.column :record
+= table.column :blob do |resource|
+  - link_to(resource.blob.filename, [:active_storage, resource.blob])
+= table.column :created_at
+= table.column :additional_actions do |resource|
+  - link_to(t('.download'), main_app.url_for(resource.blob), class: 'btn btn-primary btn-xs')

data/app/views/cmor/system/backend/active_storage/blobs/_index_table.html.haml

@@ -0,0 +1,15 @@
+= table.column :key
+= table.column :filename do |resource|
+  - resource.filename.to_s
+= table.column :content_type
+= table.column :metadata do |resource|
+  - capture_haml do
+    %ul
+      - resource.metadata.each do |key, value|
+        %li= "#{key}: #{value}"
+= table.column :byte_size do |resource|
+  - number_to_human_size(resource.byte_size)
+= table.column :checksum
+= table.column :created_at
+= table.column :additional_actions do |resource|
+  - link_to(t('.download'), main_app.url_for(resource), class: 'btn btn-primary btn-xs')

data/app/views/cmor/system/backend/delayed_backend_active_record_jobs/_index_table_actions.html.haml

@@ -0,0 +1,16 @@
+= table.column(:actions, title: false) do |resource|
+  - capture_haml do
+    .w-100.d-flex
+      .btn-group.ml-auto
+        - if available_rest_actions.include?(:show)
+          = link_to({ action: :show, id: resource.to_param }, class: 'show btn btn-xs btn-responsive btn-primary') do
+            %i.fas.fa-eye
+            %span.btn-text= t('.show')
+        - if available_rest_actions.include?(:edit)
+          = link_to({ action: :edit, id: resource.to_param }, class: 'edit btn btn-xs btn-responsive btn-secondary') do
+            %i.fas.fa-edit
+            %span.btn-text= t('.edit')
+        - if available_rest_actions.include?(:destroy)
+          = link_to(url_for({ action: :show, id: resource.to_param }), class: 'destroy btn btn-xs btn-responsive btn-danger', method: :delete, 'data-confirm': I18n.t('administrador.controller.confirmations.destroy')) do
+            %i.fas.fa-fire
+            %span.btn-text= t('.destroy')

data/app/views/cmor/system/backend/delayed_backend_active_record_jobs/_show_actions.html.haml

@@ -0,0 +1,12 @@
+= link_to({ action: :index }, class: 'btn btn-light btn-responsive') do
+  %i.fas.fa-arrow-left
+  %span.btn-text= t('administrador.resources_controller.base.show_actions.back')
+
+.ml-auto
+  - if available_rest_actions.include?(:destroy)
+    = link_to({ action: :show, id: resource.to_param }, class: 'destroy btn btn-danger btn-circle btn-lg', method: :delete, 'data-confirm': I18n.t('administrador.controller.confirmations.destroy')) do
+      %i.fas.fa-fire
+
+  - if available_rest_actions.include?(:edit)
+    = link_to({ action: :edit, id: resource.to_param }, class: 'btn btn-success btn-circle btn-lg') do
+      %i.fas.fa-edit

data/config/initializers/assets.rb

@@ -0,0 +1,2 @@
+Rails.application.config.assets.precompile += %w( cmor_system_backend.css )
+Rails.application.config.assets.precompile += %w( cmor_system_backend.js )

data/config/initializers/cmor.rb

@@ -0,0 +1,3 @@
+Cmor.configure do |config|
+  config.administrador.register_engine('Cmor::System::Backend::Engine', {})
+end

data/config/locales/de.yml

@@ -0,0 +1,48 @@
+de:
+  activerecord:
+    models:
+      active_storage/attachment:
+        one: Anhang
+        other: Anhänge
+      active_storage/blob:
+        one: BLOB
+        other: BLOBs
+      delayed/backend/active_record/job:
+        one: Hintergrundjob
+        other: Hintergrundjobs
+    attributes:
+      active_storage/attachment:
+        id: ID
+        name: Name
+        record_type: Objekt Typ
+        record_id: Objekt ID
+        record: Objekt
+        blob_id: BLOB
+        blob: BLOB
+        created_at: Erstellt am
+      active_storage/blob:
+        id: ID
+        key: Schlüssel
+        filename: Dateiname
+        content_type: Content Typ
+        metadata: Metadaten
+        byte_size: Größe
+        checksum: Checksumme
+        created_at: Erstellt am
+      delayed/backend/active_record/job:
+        id: ID
+        priority: Priorität
+        attempts: Versuche
+        handler: Handler
+        last_error: Letzter Fehler
+        run_at: Gelaufen am
+        locked_at: Gesperrt am
+        failed_at: Fehlgeschlagen am
+        locked_by: Gesperrt durch
+        queue: Warteschlange
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+  classes:
+    cmor/system/backend/engine: System
+  routes:
+    cmor-system-backend-engine: system

data/config/locales/en.yml

@@ -0,0 +1,48 @@
+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/system/backend/engine: System
+  routes:
+    cmor-system-backend-engine: system

data/config/routes.rb

@@ -0,0 +1,9 @@
+Cmor::System::Backend::Engine.routes.draw do
+  resources :delayed_backend_active_record_jobs if Cmor::System::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::System::Backend::Configuration.enable_active_storage_backend
+
+  root to: 'home#index'
+end

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

@@ -0,0 +1,27 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Cmor
+  module System
+    module Backend
+      module Configuration
+        def configure
+          yield self
+        end
+
+        mattr_accessor(:registered_controllers) { -> {[]} }
+        mattr_accessor(:registered_services) { -> {[]} }
+        mattr_accessor(:enable_active_storage_backend) { false }
+        mattr_accessor(:enable_delayed_job_backend) { false }
+        mattr_accessor(:record_factory_name) { 'user' }
+
+        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
+      end
+    end
+  end
+end

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

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

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

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

data/lib/cmor/system/backend.rb

@@ -0,0 +1,12 @@
+require "cmor/system/backend/configuration"
+require "cmor/system/backend/engine"
+
+module Cmor
+  module System
+    module Backend
+      extend Configuration
+    end
+  end
+end
+
+Cmor.configure { |c| c.register_configuration(:system_backend, Cmor::System::Backend) }

data/lib/cmor_system_backend.rb

@@ -0,0 +1,3 @@
+require "cmor_core_backend"
+
+require "cmor/system/backend"

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

@@ -0,0 +1,32 @@
+module Cmor
+  module System
+    module Backend
+      module Generators
+        class InstallGenerator < Rails::Generators::Base
+          desc 'Installs the initializer, routes and backend integration'
+
+          source_root File.expand_path('../templates', __FILE__)
+
+          attr_reader :cmor_system_backend_enable_active_storage
+          attr_reader :cmor_system_backend_enable_delayed_job
+          attr_reader :record_factory_name
+
+          def initialize(*args)
+            super
+            @cmor_system_backend_enable_active_storage = ENV.fetch('CMOR_SYSTEM_BACKEND_ENABLE_ACTIVE_STORAGE') { false }
+            @cmor_system_backend_enable_delayed_job = ENV.fetch('CMOR_SYSTEM_BACKEND_ENABLE_DELAYED_JOB') { false }
+            @record_factory_name = ENV.fetch('CMOR_SYSTEM_BACKEND_RECORD_FACTORY_NAME') { 'post' }
+          end
+
+          def generate_initializer
+            template 'initializer.rb', 'config/initializers/cmor_system_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/system/backend/install/templates/initializer.rb

@@ -0,0 +1,41 @@
+Cmor::System::Backend.configure do |config|
+  # Set the resources, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_controllers = -> {[
+  #            Cmor::System::Backend::DelayedBackendActiveRecordJobsController,
+  #            Cmor::System::Backend::ActiveStorage::BlobsController,
+  #            Cmor::System::Backend::ActiveStorage::AttachmentsController
+  #          ]}
+  # 
+  config.registered_controllers = -> {[
+    Cmor::System::Backend::DelayedBackendActiveRecordJobsController,
+    Cmor::System::Backend::ActiveStorage::BlobsController,
+    Cmor::System::Backend::ActiveStorage::AttachmentsController
+  ]}
+
+  # Set the services, that will be shown in the backend menu.
+  # 
+  # Default: config.registered_services = -> {[
+  #          ]}
+  # 
+  config.registered_services = -> {[
+  ]}
+
+  # Factory name to use for creators and updaters.
+  #
+  # default: config.record_factory_name = 'post'
+  #
+  config.record_factory_name = '<%= record_factory_name %>'
+
+  # Enable support for ActiveStorage.
+  # 
+  # default: config.enable_active_storage_backend = false
+  # 
+  config.enable_active_storage_backend = <%= cmor_system_backend_enable_active_storage %>
+
+  # Enable support for DelayedJob.
+  #
+  # default: config.enable_delayed_job_backend = false
+  #
+  config.enable_delayed_job_backend = <%= cmor_system_backend_enable_delayed_job %>
+end

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

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

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

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

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

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

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

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

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

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

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>