cmor_core_frontend 0.0.37.pre → 0.0.38.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6092260ee1a69d59aa1fc59d3e418f7a8ca118ac53b08fe00d8b356900b555
-  data.tar.gz: 763ae39e1002dce86e057abd2bc931ac0560efe42b85012b44f87a4d0ebe3a04
+  metadata.gz: e3805a6c65e725937dbec4ec08d133603516a8298b2077d3d1e75f643116a2b6
+  data.tar.gz: 0d84db04304467a201a478e56441c423d134a6486a2b988363668a1020f4a4d9
 SHA512:
-  metadata.gz: cb8d11827fc04306129cf6ea9d2671635775c0c73fd6d37fc37abff4dd930ea46e2ab531337d21d3e5f7355e558c8967958ef4bd5549fda2587ff382795d398c
-  data.tar.gz: 839f0196dad83922fd02ad4afe06f2119cf8a36cea4b215b59fd5d295f364b37bd25ab7982077c54784cf193067253fa40728c581536dcbcfa11acd1a96fa8b1
+  metadata.gz: 178343f3524a17dd9fa2fbc5b352cd8e71627fea0af9d6c8e772f515dde24969c7b36f61f66e4aff44eecb7136a35526e995f5eb1d0fba0de422a4466608d2e0
+  data.tar.gz: 1b27542f4a7b006a8af4572eee75680fc2f8eeaf38b18eeb26991cde5e67970eb5b8930bd6a37ea7b01a32559dd73d7a10d5151b6e14e1d0a8240218aaa56a4e

data/app/breadcrumbs/cmor/core/frontend/breadcrumb/path/base.rb

@@ -0,0 +1,46 @@
+module Cmor
+  module Core
+    module Frontend
+      module Breadcrumb
+        module Path
+          # You can specify custom breadcrumbs at controller/action level.
+          #
+          # Example:
+          #
+          # Assume you have a PostsController with an index action and you want
+          # to change its breadcrumb. You will have to create a class that
+          # inherits from Cmor::Core::Frontend::Breadcrumb::Path::Base. This
+          # class has to have a breadcrumbs methods that returns an array of
+          # Cmor::Core::Frontend::Breadcrumb::Base.
+          #
+          #     # app/breadcrumbs/posts_controller/index_breadcrumb_path.rb
+          #     class PostsController::IndexBreadcrumbPath < Cmor::Core::Frontend::Breadcrumb::Path::Base
+          #       def breadcrumbs
+          #         [
+          #           Cmor::Core::Frontend::Breadcrumb::Base.new(title: 'Foo', url: '/foo' ),
+          #           Cmor::Core::Frontend::Breadcrumb::Base.new(title: 'Bar', url: '/bar' )
+          #         ]
+          #       end
+          #     end
+          #
+          class Base
+            extend ActiveModel::Model
+            include I18nConcern
+
+            attr_accessor :context
+
+            def initialize(attrs)
+              attrs.each do |k, v|
+                self.send("#{k}=", v)
+              end
+            end
+
+            def breadcrumbs
+              raise "Child class reponsibility"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/concerns/cmor/core/frontend/breadcrumb/i18n_concern.rb

@@ -0,0 +1,32 @@
+module Cmor
+  module Core
+    module Frontend
+      module Breadcrumb
+        module I18nConcern
+          extend ActiveSupport::Concern
+
+          def t(identifier, options = {})
+            if identifier.start_with?('.')
+              prefix = self.class.name.underscore
+
+              # Check if we are in a proc by matching the caller string
+              caller_method = if caller[0] =~ /.*<.*>/
+                                # If yes omit the last call (that has to be instance_exec) and
+                                # fetch the previous one that should be the method that is really
+                                # calling us.
+                                caller[2].split(' ').last.gsub("'", '').gsub("`", '')
+                              else
+                                # Otherwise take the first caller
+                                caller[0].split(' ').last.gsub("'", '').gsub("`", '')
+                              end
+
+              I18n.t("#{prefix}.#{caller_method}.#{identifier}", options)
+            else
+              I18n.t(identifier, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/view_helpers/cmor/core/frontend/breadcrumbs_view_helper.rb

@@ -10,6 +10,7 @@ module Cmor
       #     end
       #
       class BreadcrumbsViewHelper < Rao::ViewHelper::Base
+        include Cmor::Core::Frontend::Breadcrumb::I18nConcern
         # Usage:
         #
         #     # app/views/layouts/application.html.erb
@@ -32,6 +33,13 @@ module Cmor
             # Add breadcrumb to home page
             b.push(instance_exec(&Cmor::Core::Frontend::Configuration.first_breadcrumb))
 
+            # Are custom breadcrumbs defined?
+            if custom_breadcrumbs.any?
+              b.push << custom_breadcrumbs
+              exclude = []
+              next
+            end
+
             # Are we showing a cms page?
             if c.controller.class.name == 'Cmor::Cms::PageController' && c.action_name == 'respond' && c.params[:page] != 'home'
               # Add breadcrumb for this page
@@ -75,6 +83,7 @@ module Cmor
             end
           end
 
+          breadcrumbs.flatten!
           breadcrumbs.last.url = nil
 
           if exclude.any?
@@ -92,6 +101,34 @@ module Cmor
 
         private
 
+        def custom_breadcrumbs
+          klass = custom_breadcrumb_path_class
+          if klass.present?
+            klass.new(context: c).breadcrumbs
+          else
+            []
+          end
+        end
+
+        def custom_breadcrumb_path_class
+          klass_name = "#{c.controller.class.name}::#{c.action_name.camelize}BreadcrumbPath"
+          # Are we eager loading?
+          if Rails.application.config.eager_load
+            # If so we can ask const_defined?
+            if klass_name.split("::")[0...-1].join("::").constantize.const_defined?(klass_name.split("::").last)
+              klass_name.constantize
+            end
+          else
+            # Else we have to try to constantize the klass name to see if it lazy loads.
+            begin
+              klass_name.constantize
+            rescue NameError => e
+              Rails.logger.debug "No custom breadcrumb path class found. Define #{klass_name} to customize breadcrumbs. Continuing with default breadcrumbs."
+              nil
+            end
+          end
+        end
+
         def breadcrumb_for_current_engine
           return if current_engine.nil?
           breadcrumb_for_engine(current_engine)
@@ -110,27 +147,6 @@ module Cmor
           end
         end
 
-        def t(identifier, options = {})
-          if identifier.start_with?('.')
-            prefix = self.class.name.underscore
-
-            # Check if we are in a proc by matching the caller string
-            caller_method = if caller[0] =~ /\(required\)>/
-              # If yes omit the last call (that has to be instance_exec) and
-              # fetch the previous one that should be the method that is really
-              # calling us.
-              caller[2].split(' ').last.gsub("'", '').gsub("`", '')
-            else
-              # Otherwise take the first caller
-              caller[0].split(' ').last.gsub("'", '').gsub("`", '')
-            end
-
-            I18n.t("#{prefix}.#{caller_method}.#{identifier}", options)
-          else
-            I18n.t(identifier, options)
-          end
-        end
-
         private
 
         def label_for(resource)

data/lib/cmor/core/frontend.rb

@@ -1,5 +1,6 @@
 require 'cmor/core/frontend/configuration'
 require 'cmor/core/frontend/engine'
+require 'cmor/core/frontend/version'
 
 module Cmor
   module Core

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/frontend_controller.rb

@@ -0,0 +1,2 @@
+class FrontendController < 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/user.rb

@@ -0,0 +1,2 @@
+class User < 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>

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

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,30 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "cmor_core_frontend"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end
+