cmor_files 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70cd107d2c4ac0eaed207ec61a5916d139aaa98c4ea80b5d7574005df010d719
+  data.tar.gz: 4bf97f90e9f6383c520ffc791c8657634e2e425a02a9d76ef1007cb8b3ea3e1b
+SHA512:
+  metadata.gz: 5df2312bdfa0ba43c4617d6e3a84c5b927f6a22003f7ecd686b758402fa575af0d9075881490d92724689a5e5ee6158f6e2242c76b8e7e10f831359a198ff892
+  data.tar.gz: 9c915b00bd25a3c006b46e32b8b19400108fb15948dc48f0795306f1ad4f40988702dea607aeafb701f3df4d7daaa0f7887795c455feeb877463569e690ebc35

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 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,44 @@
+# Cmor::Files
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Prerequisites
+
+Make sure you have installed and configured active storage.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmor_files'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cmor_files
+```
+
+Add migrations and migrate:
+
+```bash
+$ rake cmor_files:install:migrations && rake db:migrate
+```
+
+Install routes and initializer:
+
+```bash
+$ rails g cmor:files:install
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://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::Files'
+  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_files_manifest.js

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

data/app/assets/javascripts/cmor/files/application.js

@@ -0,0 +1,14 @@
+// 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 activestorage
+//= require_tree ./application

data/app/assets/stylesheets/cmor/files/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 ./application
+ *= require_self
+ */

data/app/controllers/cmor/files/application_controller.rb

@@ -0,0 +1,5 @@
+module Cmor::Files
+  class ApplicationController < Cmor::Files::Configuration.base_controller.constantize
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/cmor/files/application_resources_controller.rb

@@ -0,0 +1,18 @@
+module Cmor::Files
+  class ApplicationResourcesController < Cmor::Blog::Configuration.base_controller.constantize
+    include Rao::ResourcesController::RestActionsConcern
+    include Rao::ResourcesController::ResourcesConcern
+    include Rao::ResourcesController::RestResourceUrlsConcern
+    include Rao::ResourcesController::ResourceInflectionsConcern
+    include Rao::ResourcesController::LocationHistoryConcern
+    include Rao::Query::Controller::QueryConcern
+
+    helper Twitter::Bootstrap::Components::Rails::V4::ComponentsHelper
+
+    private
+
+    def load_collection_scope
+      with_conditions_from_query(resource_class)
+    end
+  end
+end

data/app/controllers/cmor/files/folders_controller.rb

@@ -0,0 +1,19 @@
+module Cmor::Files
+  class FoldersController < ApplicationResourcesController
+    helper Rao::Component::ApplicationHelper
+
+    def self.resource_class
+      Cmor::Files::Folder
+    end
+
+    private
+
+    def load_collection_scope
+      super.published
+    end
+
+    def load_resource_scope
+      super.published
+    end
+  end
+end

data/app/helpers/cmor/files/application_helper.rb

@@ -0,0 +1,4 @@
+module Cmor::Files
+  module ApplicationHelper
+  end
+end

data/app/jobs/cmor/files/application_job.rb

@@ -0,0 +1,4 @@
+module Cmor::Files
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/cmor/files/application_mailer.rb

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

data/app/models/cmor/files/application_record.rb

@@ -0,0 +1,5 @@
+module Cmor::Files
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/cmor/files/file_detail.rb

@@ -0,0 +1,6 @@
+module Cmor::Files
+  class FileDetail < ApplicationRecord
+    belongs_to :folder
+    belongs_to :asset, class_name: 'ActiveStorage::Attachment', dependent: :destroy
+  end
+end

data/app/models/cmor/files/folder.rb

@@ -0,0 +1,71 @@
+module Cmor::Files
+  class Folder < ApplicationRecord
+    include ActsAsPublished::ActiveRecord
+
+    has_many_attached :assets
+
+    acts_as_published
+
+    validates :name, presence: true, uniqueness: true
+
+    def human
+      "#{self.class.model_name.human}: #{I18n.l(created_at)}"
+    end
+
+    def assets_count
+      assets.count
+    end
+
+    module FileDetailsConcern
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :file_details, inverse_of: :folder, dependent: :destroy, autosave: true
+        before_validation :cleanup_orphaned_file_details
+        before_validation :ensure_file_details
+      end
+
+      def append_assets
+        assets
+      end
+
+       def append_assets=(assets)
+          if Rails.version < '6.0.0'
+            self.assets = assets
+          else
+            self.assets.attach(assets)
+          end
+        end
+
+      def overwrite_assets
+        assets
+      end
+
+      def overwrite_assets=(assets)
+        return if assets.nil? || assets.empty?
+        self.file_details.map { |fd| fd.mark_for_destruction }
+        self.assets = assets
+      end
+
+      private
+
+      def cleanup_orphaned_file_details
+        file_details.each do |file_detail|
+          file_detail.destroy if file_detail.asset.nil?
+        end
+      end
+
+      def ensure_file_details
+        (assets - file_details.all.map(&:asset)).map do |asset|
+          build_file_detail_for_asset(asset)
+        end
+      end
+
+      def build_file_detail_for_asset(asset)
+        file_details.build(asset: asset)
+      end
+    end
+
+    include FileDetailsConcern
+  end
+end

data/app/views/cmor/files/folders/index.haml

@@ -0,0 +1,9 @@
+%h1= resource_class.model_name.human(count: :other)
+
+.row
+  .col-12
+    = collection_table(collection: @collection, resource_class: resource_class) do |t|
+      = t.column :name
+      = t.column :assets_count
+      = t.column :actions do |resource|
+        - link_to(t('.show'), [resource], class: 'btn btn-primary')

data/app/views/cmor/files/folders/show.haml

@@ -0,0 +1,17 @@
+%h1= @resource.name
+
+.row
+  .col-12
+    = collection_table(collection: @resource.assets, resource_class: ActiveStorage::Attachment, header: false) do |table|
+      = table.column :filename do |resource|
+        - resource.blob.filename
+      = table.column :blob_byte_size do |resource|
+        - number_to_human_size(resource.blob.byte_size)
+      = table.column :actions do |resource|
+        - capture_haml do
+          = link_to(t('.download'), main_app.url_for(resource), class: 'btn btn-primary')
+
+
+.row.mt-4
+  .col-12
+    = link_to(t('.back'), last_location, class: 'btn btn-primary')

data/app/views/layouts/cmor/files/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Cmor files</title>
+  <%= stylesheet_link_tag    "cmor/files/application", media: "all" %>
+  <%= javascript_include_tag "cmor/files/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/assets.rb

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

data/config/initializers/i18n.rb

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

data/config/locales/de.yml

@@ -0,0 +1,44 @@
+de:
+  routes:
+    cmor_files_engine: dateien
+    folders: ordner
+  activerecord:
+    models:
+      cmor/files/file_detail:
+        one: Dateidetail
+        other: Dateidetails
+      cmor/files/folder:
+        one: Ordner
+        other: Ordner
+    attributes:
+      cmor/files/file_detail:
+        id: ID
+        blob_byte_size: Dateigröße
+        blob_checksum: Checksumme
+        blob_filename: Dateiname
+        folder: Ordner
+        folder_id: Ordner
+        asset: Datei
+        asset_id: Datei
+        title: Titel
+        description: Beschreibung
+        position: Position
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+      cmor/files/folder:
+        id: ID
+        name: Name
+        description: Beschreibung
+        assets: Dateien
+        assets_count: Dateien
+        published_at: Veröffentlicht am
+        published: Veröffentlicht
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+  cmor:
+    files:
+      folders:
+        index:
+          show: Anzeigen
+        show:
+          back: Zurück

data/config/locales/en.yml

@@ -0,0 +1,44 @@
+en:
+  routes:
+    cmor_files_engine: files
+    folders: folders
+  activerecord:
+    models:
+      cmor/files/file_detail:
+        one: File detail
+        other: File details
+      cmor/files/folder:
+        one: Folder
+        other: Folders
+    attributes:
+      cmor/files/file_detail:
+        id: ID
+        blob_byte_size: Filesize
+        blob_checksum: Checksum
+        blob_filename: Filename
+        folder: Folder
+        folder_id: Folder
+        asset: Asset
+        asset_id: Asset
+        title: Title
+        description: Description
+        position: Position
+        created_at: Created at
+        updated_at: Updated at
+      cmor/files/folder:
+        id: ID
+        name: Name
+        description: Description
+        assets: Files
+        assets_count: Files
+        published_at: Published at
+        published: Published
+        created_at: Created at
+        updated_at: Updated at
+  cmor:
+    files:
+      folders:
+        index:
+          show: Show
+        show:
+          back: Back

data/config/routes.rb

@@ -0,0 +1,7 @@
+Cmor::Files::Engine.routes.draw do
+  localized do
+    scope :cmor_files_engine do
+      resources :folders
+    end
+  end
+end

data/db/migrate/20180301094240_create_cmor_files_folders.rb

@@ -0,0 +1,11 @@
+class CreateCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    create_table :cmor_files_folders do |t|
+      t.string :name
+      t.timestamp :published_at
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180302082402_create_cmor_files_file_details.rb

@@ -0,0 +1,13 @@
+class CreateCmorFilesFileDetails < ActiveRecord::Migration[5.2]
+  def change
+    create_table :cmor_files_file_details do |t|
+      t.integer :folder_id
+      t.integer :asset_id
+      t.string :title
+      t.text :description
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+end

data/lib/cmor/files/configuration.rb

@@ -0,0 +1,9 @@
+module Cmor::Files
+  module Configuration
+    def configure
+      yield self
+    end
+
+    mattr_accessor(:base_controller) { '::FrontendController' }
+  end
+end

data/lib/cmor/files/engine.rb

@@ -0,0 +1,13 @@
+module Cmor::Files
+  class Engine < ::Rails::Engine
+    isolate_namespace Cmor::Files
+
+    config.generators do |g|
+      g.test_framework      :rspec
+      g.fixture_replacement :factory_bot, dir: 'spec/factories' 
+    end
+
+    # config.factory_bot.definition_file_paths =
+    #   self.root.join(*%w(spec factories)) if defined?(FactoryBotRails)
+  end
+end

data/lib/cmor/files/version.rb

@@ -0,0 +1,7 @@
+require 'cmor/version'
+
+module Cmor
+  module Files
+    VERSION = ::Cmor::VERSION
+  end
+end

data/lib/cmor/files.rb

@@ -0,0 +1,10 @@
+require 'cmor/files/configuration'
+require "cmor/files/engine"
+
+module Cmor
+  module Files
+    extend Configuration
+  end
+end
+
+Cmor.configure { |c| c.register_configuration(:files, Cmor::Files) }

data/lib/cmor_files.rb

@@ -0,0 +1,6 @@
+require 'cmor_core'
+require 'acts_as_published'
+require 'rao-resources_controller'
+require 'rao-component'
+
+require "cmor/files"

data/lib/generators/cmor/files/install/install_generator.rb

@@ -0,0 +1,24 @@
+module Cmor::Files
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Generates the initializer'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      attr_reader :base_controller_class_name
+
+      def initialize(*args)
+        super
+        @base_controller_class_name = ENV.fetch('BASE_CONTROLLER_CLASS_NAME') { '::ApplicationController' }
+      end
+
+      def generate_initializer
+        template 'initializer.rb', 'config/initializers/cmor_files.rb'
+      end
+
+      def generate_routes
+        route File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+      end
+    end
+  end
+end

data/lib/generators/cmor/files/install/templates/initializer.rb

@@ -0,0 +1,7 @@
+Cmor::Files.configure do |config|
+  # Set the base controller for the page controller
+  #
+  # Default: config.base_controller = '<%= base_controller_class_name %>'
+  #
+  config.base_controller = '<%= base_controller_class_name %>'
+end

data/lib/generators/cmor/files/install/templates/routes.source

@@ -0,0 +1,3 @@
+
+
+  mount Cmor::Files::Engine, at: '/'

data/lib/tasks/cmor_files_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cmor/files do
+#   # Task goes here
+# end

data/spec/config/locales/de.yml

@@ -0,0 +1,3 @@
+RSpec.describe  do
+
+end

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

@@ -0,0 +1,7 @@
+Cmor::Files.configure do |config|
+  # Set the base controller for the page controller
+  #
+  # Default: config.base_controller = '::ApplicationController'
+  #
+  config.base_controller = '::ApplicationController'
+end

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/db/migrate/20190325174535_create_active_storage_tables.active_storage.rb

@@ -0,0 +1,27 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+end

data/spec/dummy/db/migrate/20190325174557_create_cmor_files_folders.cmor_files.rb

@@ -0,0 +1,12 @@
+# This migration comes from cmor_files (originally 20180301094240)
+class CreateCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    create_table :cmor_files_folders do |t|
+      t.string :name
+      t.timestamp :published_at
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20190325174558_create_cmor_files_file_details.cmor_files.rb

@@ -0,0 +1,14 @@
+# This migration comes from cmor_files (originally 20180302082402)
+class CreateCmorFilesFileDetails < ActiveRecord::Migration[5.2]
+  def change
+    create_table :cmor_files_file_details do |t|
+      t.integer :folder_id
+      t.integer :asset_id
+      t.string :title
+      t.text :description
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+end