cmor_galleries 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a2521c29e89d210dbb3aeec3024e1fbd61b465efd9764d10d72aed06118d44a
+  data.tar.gz: 228910545e1265ae45eeeac233d72c11b01ea885ceb10d6d00f8c42c8486471a
+SHA512:
+  metadata.gz: 2f2e777d1a08c41744a4a137b30ef3aa37f3cb5e95323467a88f499cca1500fc31fe044d4a9282851e25e20c5e0a49d56d6c69151eda24d2aa476ba33c223190
+  data.tar.gz: 3267d64c74a520ec46f23e2233ab888824679d39f61f6af35db711c03645cf8182a429b6e20c2886bf687afa261b7f0e399dee0bdb0b7019f27019a500a2c273

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::Galleries
+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_galleries'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cmor_galleries
+```
+
+Add migrations and migrate:
+
+```bash
+$ rake cmor_galleries:install:migrations && rake db:migrate
+```
+
+Install routes and initializer:
+
+```bash
+$ rails g cmor:galleries: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::Galleries'
+  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_galleries_manifest.js

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

data/app/assets/javascripts/cmor/galleries/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/galleries/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/galleries/application_controller.rb

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

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

@@ -0,0 +1,11 @@
+module Cmor::Galleries
+  class ApplicationResourcesController < Cmor::Galleries::Configuration.base_controller.constantize
+    include Rao::ResourcesController::RestActionsConcern
+    include Rao::ResourcesController::ResourcesConcern
+    include Rao::ResourcesController::RestResourceUrlsConcern
+    include Rao::ResourcesController::ResourceInflectionsConcern
+    include Rao::ResourcesController::LocationHistoryConcern
+
+    helper Twitter::Bootstrap::Components::Rails::V4::ComponentsHelper
+  end
+end

data/app/controllers/cmor/galleries/picture_galleries_controller.rb

@@ -0,0 +1,17 @@
+module Cmor::Galleries
+  class PictureGalleriesController < ApplicationResourcesController
+    def self.resource_class
+      Cmor::Galleries::PictureGallery
+    end
+
+    private
+
+    def load_collection_scope
+      super.published
+    end
+
+    def load_resource_scope
+      super.published
+    end
+  end
+end

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

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

data/app/models/cmor/galleries/picture_detail.rb

@@ -0,0 +1,26 @@
+module Cmor
+  module Galleries
+    class PictureDetail < ApplicationRecord
+      include ActsAsPublished::ActiveRecord
+
+      belongs_to :picture_gallery
+      belongs_to :asset, class_name: 'ActiveStorage::Attachment', dependent: :destroy
+
+      acts_as_list scope: :picture_gallery
+
+      def human
+        title || id
+      end
+
+      module DisplayCodesConcern
+        extend ActiveSupport::Concern
+
+        def display_code_for_erb
+          "<%= pictures_helper(self).render(id: #{id}) %>"
+        end
+      end
+
+      include DisplayCodesConcern
+    end
+  end
+end

data/app/models/cmor/galleries/picture_gallery.rb

@@ -0,0 +1,88 @@
+module Cmor
+  module Galleries
+    class PictureGallery < ApplicationRecord
+      include ActsAsPublished::ActiveRecord
+
+      has_many_attached :assets
+
+      acts_as_published
+
+      validates :name, presence: true, uniqueness: true
+
+      module PictureDetails
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :picture_details, -> { order(position: :asc) }, inverse_of: :picture_gallery, dependent: :destroy, autosave: true
+          before_validation :cleanup_orphaned_picture_details
+          before_validation :ensure_picture_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.picture_details.map { |pd| pd.mark_for_destruction }
+          self.assets = assets
+        end
+
+        def picture_details_count
+          picture_details.count
+        end
+
+        private
+
+        def cleanup_orphaned_picture_details
+          picture_details.each do |picture_detail|
+            picture_detail.destroy if picture_detail.asset.nil?
+          end
+        end
+
+        def ensure_picture_details
+          (assets - picture_details.all.map(&:asset)).map do |asset|
+            build_picture_detail_for_asset(asset)
+          end
+        end
+
+        def build_picture_detail_for_asset(asset)
+          picture_details.build(asset: asset, published: published)
+        end
+      end
+
+      include PictureDetails
+
+
+      def human
+        name
+      end
+
+      def assets_count
+        assets.count
+      end
+
+      module DisplayCodesConcern
+        extend ActiveSupport::Concern
+
+        def display_code_for_erb
+          "<%= galleries_helper(self).render(name: '#{name}') %>"
+        end
+      end
+
+      include DisplayCodesConcern
+    end
+  end
+end

data/app/view_helpers/cmor/galleries/galleries_helper.rb

@@ -0,0 +1,34 @@
+module Cmor
+  module Galleries
+    # Usage:
+    #
+    #     # app/controllers/application_vontroller.rb
+    #     class ApplicationController < ActionController::Base
+    #       view_helper Cmor::Galleries::GalleriesHelper, as: :galleries_helper
+    #       # ...
+    #     end
+    #
+    #     # app/views/home/index.html.haml
+    #     = galleries_helper(self).render(name: 'main', variant_options: { combine_options: { resize: "255x255^", extent: "255x255", gravity: "center"} }, show_details: true)
+    #
+    # Default options are taken from Cmor::Galleries::Configuration.galleries_helper_render_default_options.
+    # You can set this option in the initializer.
+    #
+    class GalleriesHelper < Rao::ViewHelper::Base
+      def initialize(context)
+        @context = context
+      end
+
+      def render(options = {})
+        options.reverse_merge!(Cmor::Galleries::Configuration.galleries_helper_render_default_options)
+        
+        name            = options.delete(:name)
+        variant_options = options.delete(:variant_options)
+        show_details    = options.delete(:show_details)
+        
+        resource = Cmor::Galleries::PictureGallery.where(name: name).first
+        c.render partial: 'cmor/galleries/galleries_helper/render', locals: { resource: resource, variant_options: variant_options, show_details: show_details }
+      end
+    end
+  end
+end

data/app/view_helpers/cmor/galleries/pictures_helper.rb

@@ -0,0 +1,37 @@
+module Cmor
+  module Galleries
+    # Usage:
+    #
+    #     # app/controllers/application_vontroller.rb
+    #     class ApplicationController < ActionController::Base
+    #       view_helper Cmor::Galleries::PicturesHelper, as: :pictures_helper
+    #       # ...
+    #     end
+    #
+    #     # app/views/home/index.html.haml
+    #     = pictures_helper(self).render(name: 'main', variant_options: { combine_options: { resize: "255x255^", extent: "255x255", gravity: "center"} }, show_details: true)
+    #
+    # Default options are taken from Cmor::Galleries::Configuration.pictures_helper_render_default_options.
+    # You can set this option in the initializer.
+    #
+    # You can pass the image_tag_only option to render just the <img>-tag without a bootstrap card.
+    #
+    class PicturesHelper < Rao::ViewHelper::Base
+      def initialize(context)
+        @context = context
+      end
+
+      def render(options = {})
+        options.reverse_merge!(Cmor::Galleries::Configuration.pictures_helper_render_default_options)
+        
+        id              = options.delete(:id)
+        variant_options = options.delete(:variant_options) || {}
+        show_details    = options.delete(:show_details)
+        image_tag_only  = options.delete(:image_tag_only)
+        
+        resource = Cmor::Galleries::PictureDetail.where(id: id).first
+        c.render partial: 'cmor/galleries/pictures_helper/render', locals: { resource: resource, variant_options: variant_options, show_details: show_details, image_tag_only: image_tag_only }
+      end
+    end
+  end
+end

data/app/views/cmor/galleries/galleries_helper/_render.html.haml

@@ -0,0 +1,17 @@
+- if resource.nil?
+- else
+  %div{ id: dom_id(resource), class: dom_class(resource) }
+    %notextile
+      .row
+        - resource.picture_details.published.each do |picture_detail|
+          .col-md-6.col-lg-3.d-flex.align-items-stretch.mb-4
+            = bootstrap_card(additional_css_classes: 'text-center border-0 w-100') do
+              %a{ href: main_app.url_for(picture_detail.asset), data: { gallery: dom_id(resource) } }
+                %img{ src: main_app.url_for(picture_detail.asset.variant(variant_options)) }
+              - if show_details
+                .card-body
+                  %h5.card-title
+                    = picture_detail.title
+                  %p.card-text
+                    = picture_detail.description
+

data/app/views/cmor/galleries/picture_galleries/index.html.haml

@@ -0,0 +1,16 @@
+%h1= resource_class.model_name.human(count: :other)
+
+.row
+  - @collection.each do |picture_gallery|
+    .col-4
+      - image_options = if picture_gallery.picture_details.first.try(:asset).present?
+        - { src: main_app.url_for(picture_gallery.picture_details.first.asset.variant(Cmor::Galleries::Configuration.thumbnail_variant_options)) }
+      - else
+        - {}
+      = bootstrap_card(image_options: image_options, additional_css_classes: 'text-center border-0') do
+        .card-body
+          %h5.card-title
+            = picture_gallery.name
+          %p.card-text
+            = picture_gallery.description
+          = link_to(t('.show'), picture_gallery, class: 'btn btn-primary')

data/app/views/cmor/galleries/picture_galleries/show.html.haml

@@ -0,0 +1,18 @@
+%h1= @resource.name
+
+%div{ id: dom_id(@resource), class: dom_class(@resource) }
+  .row
+    - @resource.picture_details.each do |picture_detail|
+      .col-md-6.col-lg-3.d-flex.align-items-stretch.mb-4
+        = bootstrap_card(additional_css_classes: 'text-center border-0' ) do
+          %a{ href: main_app.url_for(picture_detail.asset), data: { gallery: dom_id(@resource) } }
+            %img.img-fluid{ src: main_app.url_for(picture_detail.asset.variant(Cmor::Galleries::Configuration.thumbnail_variant_options)) }
+          .card-body
+            %h5.card-title
+              = picture_detail.title
+            %p.card-text
+              = picture_detail.description
+
+.row.mt-4
+  .col-12
+    = link_to(t('.back'), last_location, class: 'btn btn-primary')

data/app/views/cmor/galleries/pictures_helper/_render.html.haml

@@ -0,0 +1,15 @@
+- if resource.nil?
+- else
+  %notextile
+    - if image_tag_only
+      %img.img-responsive{ src: main_app.url_for(resource.asset.variant(variant_options)) }
+    - else
+      .row{ id: dom_id(resource), class: dom_class(resource) }
+        .col-md-6.col-lg-3.d-flex.align-items-stretch.mb-4
+          = bootstrap_card(image_options: { src: main_app.url_for(resource.asset.variant(variant_options)) }, additional_css_classes: 'text-center border-0 w-100' ) do
+            - if show_details
+              .card-body
+                %h5.card-title
+                  = resource.title
+                %p.card-text
+                  = resource.description

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

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

data/config/initializers/assets.rb

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

data/config/locales/de.yml

@@ -0,0 +1,48 @@
+de:
+  routes:
+    cmor_galleries_engine: bilder
+    picture_galleries: galerien
+  activerecord:
+    models:
+      cmor/galleries/picture_detail:
+        one: Bilddetail
+        other: Bilddetails
+      cmor/galleries/picture_gallery:
+        one: Bildgalerie
+        other: Bildgalerien
+    attributes:
+      cmor/galleries/picture_gallery:
+        id: ID
+        append_assets: Bilder hinzufügen
+        description: Beschreibung
+        display_code_for_erb: Anzeigecode (erb)
+        name: Name
+        overwrite_assets: Bilder ersetzen
+        picture_details_count: Bilder
+        preview: Vorschau
+        published_at: Veröffentlicht am
+        published: Veröffentlicht
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+      cmor/galleries/picture_detail:
+        id: ID
+        asset_id: Datei
+        asset: Datei
+        description: Beschreibung
+        display_code_for_erb: Anzeigecode (erb)
+        picture_gallery_id: Galerie
+        picture_gallery: Galerie
+        position: Position
+        preview: Vorschau
+        published_at: Veröffentlicht am
+        published: Veröffentlicht
+        title: Titel
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+  cmor:
+    galleries:
+      picture_galleries:
+        index:
+          show: Anzeigen
+        show:
+          back: Zurück

data/config/locales/en.yml

@@ -0,0 +1,46 @@
+en:
+  routes:
+    cmor_galleries_engine: pictures
+    picture_galleries: galleries
+  activerecord:
+    models:
+      cmor/galleries/picture_detail:
+        one: Picture detail
+        other: Picture details
+      cmor/galleries/picture_gallery:
+        one: Gallery
+        other: Galleries
+    attributes:
+      cmor/galleries/picture_gallery:
+        id: ID
+        name: Name
+        description: Description
+        display_code_for_erb: Display code (erb)
+        picture_details_count: Pictures
+        preview: Preview
+        published: Published
+        published_at: Published at
+        created_at: Created at 
+        updated_at: Updated at
+      cmor/galleries/picture_detail:
+        id: ID
+        asset_id: File
+        asset: File
+        description: Description
+        display_code_for_erb: Display code (erb)
+        picture_gallery_id: Gallery
+        picture_gallery: Gallery
+        position: Position
+        preview: Preview
+        published_at: Published at
+        published: Published
+        title: Title
+        created_at: Created at 
+        updated_at: Updated at
+  cmor:
+    galleries:
+      picture_galleries:
+        index:
+          show: Show
+        show:
+          back: Back

data/config/routes.rb

@@ -0,0 +1,9 @@
+Cmor::Galleries::Engine.routes.draw do
+  localized do
+    scope :cmor_galleries_engine do
+      resources :picture_galleries do
+        post :toggle_published, on: :member
+      end
+    end
+  end
+end

data/db/migrate/20180301153325_create_cmor_galleries_picture_galleries.rb

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

data/db/migrate/20180302082402_create_cmor_galleries_picture_details.rb

@@ -0,0 +1,14 @@
+class CreateCmorGalleriesPictureDetails < ActiveRecord::Migration[5.2]
+  def change
+    create_table :cmor_galleries_picture_details do |t|
+      t.integer :picture_gallery_id
+      t.integer :asset_id
+      t.string :title
+      t.text :description
+      t.integer :position
+      t.timestamp :published_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/cmor/galleries/configuration.rb

@@ -0,0 +1,12 @@
+module Cmor::Galleries
+  module Configuration
+    def configure
+      yield self
+    end
+
+    mattr_accessor(:base_controller) { '::FrontendController' }
+    mattr_accessor(:galleries_helper_render_default_options) { { variant_options: {}, show_details: false } }
+    mattr_accessor(:pictures_helper_render_default_options) { { image_tag_only: true } }
+    mattr_accessor(:thumbnail_variant_options) { { combine_options: { resize: "384x216^", extent: "384x216", gravity: "center"} } }
+  end
+end

data/lib/cmor/galleries/engine.rb

@@ -0,0 +1,13 @@
+module Cmor::Galleries
+  class Engine < ::Rails::Engine
+    isolate_namespace Cmor::Galleries
+
+    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?(FactoryBot)
+  end
+end

data/lib/cmor/galleries/version.rb

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

data/lib/cmor/galleries.rb

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

data/lib/cmor_galleries.rb

@@ -0,0 +1,7 @@
+require 'acts_as_list'
+require 'acts_as_published'
+require 'cmor_core'
+require 'rao-resources_controller'
+require 'rao-view_helper'
+
+require 'cmor/galleries'