cmor_files 0.0.44.pre → 0.0.45.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80e5b0f66d42596ab3cbeb65a2234620c2eb9687a393a8643a87c6c7dfbdbbef
-  data.tar.gz: f2d6d035c17968608701c28042bd3f4b7e7cf1b519a0b55619d736841b50b854
+  metadata.gz: b08c90107f4559820ba2de578b1dc456dbb1c0042918320783b67ba09fff0150
+  data.tar.gz: adf30c1245020a09e6b7b2522270e50c4885a6b92394dab9731c5edf9ca6facf
 SHA512:
-  metadata.gz: 9d90e43c2f7b2dd77e9bbd1626099eb08093f054cb73f2402af03d3c56f7a5b61848e6c47c94b34334f3bd750658e24634dd10e1cf8eaf245920ce135b1dd6f2
-  data.tar.gz: 44f21849068752cc5d98c7f86299c95a5219ad930393119a103a244dab3ef8c25b563f271c3d6a59566fb1f89d3cb5e63e93ae1ccd99a812301be0781197476f
+  metadata.gz: 49d230e14bb39f86c71a78682d80bd02d8d00ded2dfe79c71a6d20aa8830f70477214dea559ebf2765250ec570b0ab1dcd18fa6b23f2072bfbb7db00892b1955
+  data.tar.gz: 664eb643669118ecb906216ef0819cf071e5607bcadf6ad1685674d6133931e70aab5379747385fa9d1462e740b42b3ee3f20586e119b2d8ba22234f121ee5c8

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

@@ -0,0 +1,21 @@
+module Cmor::Files
+  class FileDetailsController < ApplicationResourcesController
+    include Rao::ResourcesController::FriendlyIdConcern
+
+    helper Rao::Component::ApplicationHelper
+
+    def self.resource_class
+      Cmor::Files::FileDetail
+    end
+
+    private
+
+    def load_collection_scope
+      super.published
+    end
+
+    def load_resource_scope
+      super.published
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 module Cmor::Files
   class FoldersController < ApplicationResourcesController
+    include Rao::ResourcesController::FriendlyIdConcern
+
     helper Rao::Component::ApplicationHelper
 
     def self.resource_class

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

@@ -2,5 +2,19 @@ module Cmor::Files
   class FileDetail < ApplicationRecord
     belongs_to :folder
     belongs_to :asset, class_name: 'ActiveStorage::Attachment', dependent: :destroy
+
+    # acts as published
+    include ActsAsPublished::ActiveRecord
+    acts_as_published
+
+    # acts as list
+    acts_as_list scope: :folder
+    default_scope { order(folder_id: :desc, position: :asc) }
+
+    # slugs
+    extend FriendlyId
+    friendly_id :title, use: :slugged
+
+    validates :identifier, uniqueness: { scope: [ :folder_id ] }, allow_blank: true, allow_nil: true
   end
 end

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

@@ -1,71 +1,85 @@
-module Cmor::Files
-  class Folder < ApplicationRecord
-    include ActsAsPublished::ActiveRecord
+module Cmor
+  module Files
+    class Folder < ApplicationRecord
+      include Cmor::Core::Model::LocalizationConcern
 
-    has_many_attached :assets
+      has_many_attached :assets
 
-    acts_as_published
+      # acts as published
+      include ActsAsPublished::ActiveRecord
+      acts_as_published
 
-    validates :name, presence: true, uniqueness: true
+      # acts as list
+      acts_as_list
+      default_scope { order(position: :asc) }
 
-    def human
-      "#{self.class.model_name.human}: #{I18n.l(created_at)}"
-    end
+      # slugs
+      extend FriendlyId
+      friendly_id :name, use: :slugged
 
-    def assets_count
-      assets.count
-    end
 
-    module FileDetailsConcern
-      extend ActiveSupport::Concern
+      validates :name, presence: true, uniqueness: { scope: [ :locale ] }
+      validates :identifier, uniqueness: { scope: [ :locale ] }, allow_nil: true, allow_blank: true
 
-      included do
-        has_many :file_details, inverse_of: :folder, dependent: :destroy, autosave: true
-        before_validation :cleanup_orphaned_file_details
-        before_validation :ensure_file_details
+      def human
+        "#{self.class.model_name.human}: #{self.name}"
       end
 
-      def append_assets
-        assets
+      def assets_count
+        assets.count
       end
 
-       def append_assets=(assets)
-          if Rails.version < '6.0.0'
-            self.assets = assets
-          else
-            self.assets.attach(assets)
+      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
-      end
+        def overwrite_assets=(assets)
+          return if assets.nil? || assets.empty?
+          self.file_details.map { |fd| fd.mark_for_destruction }
+          self.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
 
-      private
+        def cleanup_orphaned_file_details
+          file_details.each do |file_detail|
+            file_detail.destroy if file_detail.asset.nil?
+          end
+        end
 
-      def cleanup_orphaned_file_details
-        file_details.each do |file_detail|
-          file_detail.destroy if file_detail.asset.nil?
+        def ensure_file_details
+          (assets - file_details.all.map(&:asset)).map do |asset|
+            build_file_detail_for_asset(asset)
+          end
         end
-      end
 
-      def ensure_file_details
-        (assets - file_details.all.map(&:asset)).map do |asset|
-          build_file_detail_for_asset(asset)
+        def build_file_detail_for_asset(asset)
+          file_details.build(asset: asset)
         end
       end
 
-      def build_file_detail_for_asset(asset)
-        file_details.build(asset: asset)
-      end
+      include FileDetailsConcern
     end
-
-    include FileDetailsConcern
   end
 end

data/app/view_helpers/cmor/files/application_view_helper.rb

@@ -0,0 +1,22 @@
+module Cmor
+  module Files
+    # Example:
+    #
+    #     # app/controllers/application_controller.rb
+    #     class ApplicationController < ActionController::Base
+    #       view_helper Cmor::Files::ApplicationViewHelper, as: :files_helper
+    #     end
+    #
+    class ApplicationViewHelper < Rao::ViewHelper::Base
+      # Example:
+      #
+      #     # app/views/layouts/application.html.haml
+      #     = files_helper(self).render_download(name: 'Quick reference manual')
+      #
+      def render_file(identifier:)
+        resource = Cmor::Files::FileDetail.where(identifier: identifier).first
+        render resource: resource
+      end
+    end
+  end
+end

data/app/views/cmor/files/application_view_helper/_render_file.html.haml

@@ -0,0 +1,8 @@
+.cmor-files-file_detail
+  %h4.title= resource.title
+
+  %p.description= resource.description
+
+  .resource-actions
+    = link_to(main_app.url_for(resource.asset), class: 'btn btn-primary') do
+      = "#{t('.download')} (#{resource.asset.content_type.split('/').last}, #{number_to_human_size(resource.asset.blob.byte_size)})"

data/app/views/cmor/files/file_details/index.html.haml

@@ -0,0 +1,12 @@
+%h1= resource_class.model_name.human(count: :other)
+
+.row
+  .col-12
+    = collection_table(collection: @collection, resource_class: resource_class) do |table|
+      = table.column :filename do |resource|
+        - resource.asset.blob.filename
+      = table.column :blob_byte_size do |resource|
+        - number_to_human_size(resource.asset.blob.byte_size)
+      = table.column :actions do |resource|
+        - capture_haml do
+          = link_to(t('.download'), main_app.url_for(resource.asset), class: 'btn btn-primary')

data/app/views/cmor/files/file_details/show.html.haml

@@ -0,0 +1,17 @@
+%h1= @resource.title
+
+.row
+  .col-12
+    = resource_table(resource: @resource, resource_class: Cmor::Files::FileDetail, header: false) do |table|
+      = table.row :filename do |resource|
+        - resource.asset.blob.filename
+      = table.row :blob_byte_size do |resource|
+        - number_to_human_size(resource.asset.blob.byte_size)
+      = table.row :actions do |resource|
+        - capture_haml do
+          = link_to(t('.download'), main_app.url_for(resource.asset), class: 'btn btn-primary')
+
+
+.row.mt-4
+  .col-12
+    = link_to(t('.back'), last_location, class: 'btn btn-primary')

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

@@ -2,14 +2,14 @@
 
 .row
   .col-12
-    = collection_table(collection: @resource.assets, resource_class: ActiveStorage::Attachment, header: false) do |table|
+    = collection_table(collection: @resource.file_details, resource_class: Cmor::Files::FileDetail, header: false) do |table|
       = table.column :filename do |resource|
-        - resource.blob.filename
+        - resource.asset.blob.filename
       = table.column :blob_byte_size do |resource|
-        - number_to_human_size(resource.blob.byte_size)
+        - number_to_human_size(resource.asset.blob.byte_size)
       = table.column :actions do |resource|
         - capture_haml do
-          = link_to(t('.download'), main_app.url_for(resource), class: 'btn btn-primary')
+          = link_to(t('.download'), main_app.url_for(resource.asset), class: 'btn btn-primary')
 
 
 .row.mt-4

data/config/locales/de.yml

@@ -3,6 +3,7 @@ de:
     cmor/files/engine: Dateien
   routes:
     cmor_files_engine: dateien
+    file_details: dateien
     folders: ordner
   activerecord:
     models:
@@ -15,30 +16,44 @@ de:
     attributes:
       cmor/files/file_detail:
         id: ID
+        asset: Datei
+        asset_id: Datei
         blob_byte_size: Dateigröße
         blob_checksum: Checksumme
         blob_filename: Dateiname
+        description: Beschreibung
         folder: Ordner
         folder_id: Ordner
-        asset: Datei
-        asset_id: Datei
-        title: Titel
-        description: Beschreibung
+        identifier: Bezeichner
         position: Position
+        published: Veröffentlicht
+        published_at: Veröffentlicht am
+        slug: Freundliche ID
+        title: Titel
         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
+        description: Beschreibung
+        identifier: Bezeichner
+        locale: Sprache
+        name: Name
+        position: Position
         published: Veröffentlicht
+        published_at: Veröffentlicht am
+        slug: Freundliche ID
         created_at: Erstellt am
         updated_at: Aktualisiert am
   cmor:
     files:
+      application_view_helper:
+        render_file:
+          download: Herunterladen
+      file_details:
+        show:
+          back: Zurück
       folders:
         index:
           show: Anzeigen

data/config/locales/en.yml

@@ -3,6 +3,7 @@ en:
     cmor/files/engine: Files
   routes:
     cmor_files_engine: files
+    file_details: files
     folders: folders
   activerecord:
     models:
@@ -15,30 +16,44 @@ en:
     attributes:
       cmor/files/file_detail:
         id: ID
+        asset: Asset
+        asset_id: Asset
         blob_byte_size: Filesize
         blob_checksum: Checksum
         blob_filename: Filename
+        description: Description
         folder: Folder
         folder_id: Folder
-        asset: Asset
-        asset_id: Asset
-        title: Title
-        description: Description
+        identifier: Identifier
         position: Position
+        published: Published
+        published_at: Published at
+        slug: Friendly ID
+        title: Title
         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
+        description: Description
+        identifier: Identifier
+        locale: Locale
+        name: Name
+        position: Position
         published: Published
+        published_at: Published at
+        slug: Friendly ID
         created_at: Created at
         updated_at: Updated at
   cmor:
     files:
+      application_view_helper:
+        render_file:
+          download: Download
+      file_details:
+        show:
+          back: Back
       folders:
         index:
           show: Show

data/config/routes.rb

@@ -1,7 +1,8 @@
 Cmor::Files::Engine.routes.draw do
   localized do
     scope :cmor_files_engine do
-      resources :folders
+      resources :folders, only: [ :index, :show ]
+      resources :file_details, only: [ :index, :show ]
 
       root to: 'folders#index'
     end

data/db/migrate/20200216141542_add_identifier_to_cmor_files_folders.rb

@@ -0,0 +1,5 @@
+class AddIdentifierToCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_folders, :identifier, :string
+  end
+end

data/db/migrate/20200216141614_add_slug_to_cmor_files_folders.rb

@@ -0,0 +1,5 @@
+class AddSlugToCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_folders, :slug, :string
+  end
+end

data/db/migrate/20200216141650_add_position_to_cmor_files_folders.rb

@@ -0,0 +1,5 @@
+class AddPositionToCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_folders, :position, :integer
+  end
+end

data/db/migrate/20200216142054_add_locale_to_cmor_files_folders.rb

@@ -0,0 +1,5 @@
+class AddLocaleToCmorFilesFolders < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_folders, :locale, :string
+  end
+end

data/db/migrate/20200216164748_add_identifier_to_cmor_files_file_details.rb

@@ -0,0 +1,5 @@
+class AddIdentifierToCmorFilesFileDetails < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_file_details, :identifier, :string
+  end
+end

data/db/migrate/20200217133512_add_slug_to_cmor_files_file_details.rb

@@ -0,0 +1,5 @@
+class AddSlugToCmorFilesFileDetails < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_file_details, :slug, :string
+  end
+end

data/db/migrate/20200217141730_add_published_at_to_cmor_files_file_details.rb

@@ -0,0 +1,5 @@
+class AddPublishedAtToCmorFilesFileDetails < ActiveRecord::Migration[5.2]
+  def change
+    add_column :cmor_files_file_details, :published_at, :timestamp
+  end
+end

data/db/migrate/20200301154948_set_all_cmor_files_publishable_to_published.rb

@@ -0,0 +1,21 @@
+class SetAllCmorFilesPublishableToPublished < ActiveRecord::Migration[5.2]
+  def self.up
+    ActiveRecord::Base.transaction do
+      [
+        Cmor::Files::FileDetail
+      ].each do |klass|
+        klass.update_all(published_at: Time.zone.now)
+      end
+    end
+  end
+
+  def down.up
+    ActiveRecord::Base.transaction do
+      [
+        Cmor::Files::FileDetail
+      ].each do |klass|
+        klass.update_all(published_at: nil)
+      end
+    end
+  end
+end

data/lib/cmor_files.rb

@@ -1,6 +1,9 @@
 require 'cmor_core_frontend'
 require 'acts_as_published'
+require 'acts_as_list'
+require 'friendly_id'
 require 'rao-resources_controller'
 require 'rao-component'
 
+require 'cmor/core/model/localization_concern'
 require "cmor/files"

data/spec/factories/cmor_files_folders.rb

@@ -1,5 +1,6 @@
 FactoryBot.define do
   factory :cmor_files_folder, class: 'Cmor::Files::Folder' do
     sequence(:name) { |i| "Folder ##{i}" }
+    sequence(:identifier) { |i| "folder-#{i}" }
   end
 end

data/spec/models/cmor/files/folder_spec.rb

@@ -7,6 +7,6 @@ module Cmor::Files
     it { expect(subject).to respond_to(:assets_count) }
     
     it { expect(subject).to validate_presence_of(:name) }
-    it { expect(subject).to validate_uniqueness_of(:name) }
+    it { expect(subject).to validate_uniqueness_of(:name).scoped_to([:locale]) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmor_files
 version: !ruby/object:Gem::Version
-  version: 0.0.44.pre
+  version: 0.0.45.pre
 platform: ruby
 authors:
 - Roberto Vasquez Angel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: cmor_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.44.pre
+        version: 0.0.45.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.44.pre
+        version: 0.0.45.pre
 - !ruby/object:Gem::Dependency
   name: cmor_core_frontend
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.44.pre
+        version: 0.0.45.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.44.pre
+        version: 0.0.45.pre
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -318,6 +318,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: acts_as_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: friendly_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rao-resources_controller
   requirement: !ruby/object:Gem::Requirement
@@ -363,6 +391,7 @@ files:
 - app/assets/stylesheets/cmor/files/application/keep.css
 - app/controllers/cmor/files/application_controller.rb~
 - app/controllers/cmor/files/application_resources_controller.rb
+- app/controllers/cmor/files/file_details_controller.rb
 - app/controllers/cmor/files/folders_controller.rb
 - app/helpers/cmor/files/application_helper.rb
 - app/jobs/cmor/files/application_job.rb
@@ -370,16 +399,27 @@ files:
 - app/models/cmor/files/application_record.rb
 - app/models/cmor/files/file_detail.rb
 - app/models/cmor/files/folder.rb
+- app/view_helpers/cmor/files/application_view_helper.rb
+- app/views/cmor/files/application_view_helper/_render_file.html.haml
+- app/views/cmor/files/file_details/index.html.haml
+- app/views/cmor/files/file_details/show.html.haml
 - app/views/cmor/files/folders/index.html.haml
 - app/views/cmor/files/folders/show.html.haml
 - app/views/layouts/cmor/files/application.html.erb
 - config/initializers/assets.rb
-- config/initializers/i18n.rb
 - config/locales/de.yml
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20180301094240_create_cmor_files_folders.rb
 - db/migrate/20180302082402_create_cmor_files_file_details.rb
+- db/migrate/20200216141542_add_identifier_to_cmor_files_folders.rb
+- db/migrate/20200216141614_add_slug_to_cmor_files_folders.rb
+- db/migrate/20200216141650_add_position_to_cmor_files_folders.rb
+- db/migrate/20200216142054_add_locale_to_cmor_files_folders.rb
+- db/migrate/20200216164748_add_identifier_to_cmor_files_file_details.rb
+- db/migrate/20200217133512_add_slug_to_cmor_files_file_details.rb
+- db/migrate/20200217141730_add_published_at_to_cmor_files_file_details.rb
+- db/migrate/20200301154948_set_all_cmor_files_publishable_to_published.rb
 - lib/cmor/files.rb
 - lib/cmor/files/configuration.rb
 - lib/cmor/files/engine.rb

data/config/initializers/i18n.rb

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