RubyGems - beyond_canvas - Versions diffs - 0.15.2.pre → 0.17.0.pre - Mend

beyond_canvas 0.15.2.pre → 0.17.0.pre

Files changed (74) hide show

data/app/views/beyond_canvas/shared/_flash.html.erb CHANGED

@@ -1,13 +1,23 @@
-<% flash.each do |key, value| %>
-  <div class="flash">
-    <div class="flash__icon flash__icon--<%= key %>">
-      <%= get_flash_icon(key) %>
+<div id="flash">
+  <% flash.each do |key, value| %>
+    <div class="flash">
+      <div class="flash__icon flash__icon--<%= key %>">
+        <%= get_flash_icon(key) %>
+      </div>
+      <div class="flash__message">
+        <%= value %>
+      </div>
+      <div class="flash__close">
+        <%= inline_svg_tag 'icons/flash_close.svg' %>
+      </div>
     </div>
-    <div class="flash__message">
-      <%= value %>
-    </div>
-    <div class="flash__close">
-      <%= inline_svg_tag 'icons/flash_close.svg' %>
-    </div>
-  </div>
-<% end %>
+  <% end %>
+</div>

data/app/views/beyond_canvas/shared/_locales.html.erb ADDED

@@ -0,0 +1,8 @@
+<% if show_locale_switch? && !is_cockpit_app? %>
+  <%= form_for :system, url: beyond_canvas.update_locale_path, method: :put do |f| %>
+      <%= f.select :locale, I18n.available_locales.collect { |l| [translate_locale(l), l] },
+                            { selected: cookies[:locale] },
+                            class: 'select--locale',
+                            onchange: 'this.form.submit()'  %>
+  <% end %>
+<% end %>

data/app/views/beyond_canvas/shared/_menu.html.erb ADDED

@@ -0,0 +1,31 @@
+<% if menu_content? %>
+  <div class="menu">
+    <div class="menu--left">
+      <%= render 'beyond_canvas/shared/logo' %>
+    </div>
+    <div class="menu--center">
+      <% BeyondCanvas.configuration.menu_items.each do |menu_item| %>
+        <% name, url, options = menu_item.name.to_s, menu_item.url.to_s, menu_item.options %>
+        <% url, external_url = respond_to?(url) ? [send(url), false] : [url, true] %>
+        <% name = defined?(I18n) && I18n.exists?(name) ? I18n.t(name) : name %>
+        <% path = Rails.application.routes.recognize_path(url) %>
+        <% options = options.merge(class: 'menu__item--active') { |_key, old_val, new_val| [new_val, old_val].join(' ') if !external_url && path[:controller] == params[:controller] } %>
+        <% options = options.merge(class: 'menu__item') { |_key, old_val, new_val| [new_val, old_val].join(' ') } %>
+        <%= link_to name, url, options %>
+      <% end %>
+    </div>
+    <div class="menu--right"></div>
+  </div>
+<% end %>

data/app/views/beyond_canvas/shared/_modal.html.erb ADDED

@@ -0,0 +1,6 @@
+<div class="modal__background" id="modal">
+  <div class="relative card card--padding">
+    <span onClick= "$.closeModal()"><%= inline_svg_tag 'icons/close.svg', class: 'modal__close' %></span>
+    <div id="modal__content"></div>
+  </div>
+</div>

data/app/views/beyond_canvas/shared/_sidebar.html.erb ADDED

@@ -0,0 +1,16 @@
+<% if is_cockpit_app? && Rails.env.development? %>
+  <div class="sidebar">
+    <div class="sidebar__header">
+      <div class="sidebar__logo"></div>
+    </div>
+    <div class="sidebar__item sidebar__item--selected"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__footer">
+      <div class="sidebar__icon"></div>
+      <div class="sidebar__icon"></div>
+      <div class="sidebar__icon"></div>
+    </div>
+  </div>
+<% end %>

data/app/views/layouts/beyond_canvas/application.html.erb ADDED

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<%= render 'beyond_canvas/shared/head' %>
+<body class="body--application"<% if is_cockpit_app? && Rails.env.development? %> style="display: flex;"<% end %>>
+  <%= render 'beyond_canvas/shared/sidebar' %>
+  <main class="main <%= params[:controller].gsub(/[\/_]/, "-") %>--<%= params[:action] %>">
+    <%= render 'beyond_canvas/shared/flash' %>
+    <%= render 'beyond_canvas/shared/locales' %>
+    <%= render 'beyond_canvas/shared/modal' %>
+    <%= render 'beyond_canvas/shared/menu' %>
+    <%= render 'beyond_canvas/shared/action_bar' %>
+    <div class="main-wrapper<% if action_bar_content? %> main-wrapper--action_bar<% end %>"<% if content_for?(:max_width)%> style="max-width: <%= yield :max_width %>"<% end %>>
+      <%= render 'beyond_canvas/shared/breadcrumbs' %>
+      <%= yield %>
+      <%= debug(params) if debug_mode? %>
+    </div>
+  </main>
+</body>
+</html>

data/app/views/layouts/beyond_canvas/public.html.erb CHANGED

@@ -4,13 +4,22 @@
 <%= render 'beyond_canvas/shared/head' %>
 <body class="body--public">
   <main class="main <%= params[:controller].gsub(/[\/_]/, "-") %>--<%= params[:action] %>">
     <%= render 'beyond_canvas/shared/flash' %>
-    <%= render 'beyond_canvas/locales/edit' %>
+    <%= render 'beyond_canvas/shared/locales' %>
     <div class="main-wrapper">
       <%= render 'beyond_canvas/shared/logo' %>
       <%= yield %>
     </div>
+    <%= debug(params) if debug_mode? %>
   </main>
 </body>
 </html>

data/config/locales/en.yml ADDED

@@ -0,0 +1,9 @@
+en:
+  beyond_canvas:
+    authentications:
+      new:
+        headline: Install %{app_name} in your shop
+        body: You are about to install %{app_name} in your shop. For continuing with this process, press the install button below.
+        actions:
+          install: Install
+      failure: Shop could not be saved

data/config/routes.rb CHANGED

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 BeyondCanvas::Engine.routes.draw do
-  put '/locale', to: 'system#update_locale', as: :update_locale
+  put 'locale', to: 'system#update_locale', as: :update_locale
+  def create_default_routes
+    get  'callback', to: 'authentications#new'
+    post 'callback', to: 'authentications#install'
+  end
+  create_default_routes unless BeyondCanvas.use_rails_app_controller
 end

data/lib/beyond_canvas.rb CHANGED

@@ -8,14 +8,30 @@ require 'jquery-rails'
 require 'bourbon'
 require 'sassc-rails'
 require 'inline_svg'
+require 'loaf'
 require 'http/accept'
 require 'premailer/rails'
 require 'beyond_api'
+require 'attr_encrypted'
 module BeyondCanvas # :nodoc:
-  autoload :AssetRegistration, 'beyond_canvas/asset_registration'
-  autoload :Configuration,     'beyond_canvas/configuration'
+  autoload :AssetRegistration,    'beyond_canvas/asset_registration'
+  autoload :Configuration,        'beyond_canvas/configuration'
+  autoload :MenuItemRegistration, 'beyond_canvas/menu_item_registration'
+  autoload :ParameterSanitizer,   'beyond_canvas/parameter_sanitizer'
+  module Models # :nodoc:
+    autoload :Shop, 'models/shop'
+    module Concerns
+      autoload :Authentication, 'models/concerns/authentication'
+      autoload :Utils,          'models/concerns/utils'
+    end
+  end
+  mattr_accessor :use_rails_app_controller
+  @@use_rails_app_controller = false
   class << self
     def configuration

data/lib/beyond_canvas/configuration.rb CHANGED

@@ -2,14 +2,22 @@
 module BeyondCanvas
   class Configuration # :nodoc:
-    attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker
+    attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker, :encryption_key, :namespace, :cockpit_app,
+                  :open_app_url, :preinstalled, :debug_mode
     include AssetRegistration
+    include MenuItemRegistration
     def initialize
-      @site_title = ::Rails.application.class.name.split('::').first.humanize
-      @site_logo = nil
+      @cockpit_app = false
+      @debug_mode = false
+      @encryption_key = nil
       @favicon = nil
+      @namespace = '/'
+      @open_app_url = nil
+      @preinstalled = false
+      @site_logo = nil
+      @site_title = ::Rails.application.class.name.split('::').first.humanize
       @skip_webpacker = false
     end

data/lib/beyond_canvas/engine.rb CHANGED

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require 'beyond_canvas/rails/routes'
 module BeyondCanvas
   class Engine < ::Rails::Engine # :nodoc:
     isolate_namespace BeyondCanvas
@@ -11,6 +13,8 @@ module BeyondCanvas
       BeyondCanvas.configuration.javascripts.each do |path|
         app.config.assets.precompile << path
       end
+      app.config.assets.precompile << 'beyond_canvas_manifest.js'
     end
     config.before_initialize do
@@ -18,6 +22,8 @@ module BeyondCanvas
         include ::BeyondCanvas::LocaleManagement
         include ::BeyondCanvas::RequestValidation
         include ::BeyondCanvas::StatusCodes
+        include ::BeyondCanvas::AuthenticationsHelper
+        include ::BeyondCanvas::DebugHelper
         ::ActionController::Base.helper BeyondCanvas::Engine.helpers
       end

data/lib/beyond_canvas/menu_item_registration.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  module MenuItemRegistration # :nodoc:
+    MenuItem = Struct.new(:name, :url, :options)
+    def register_menu_item(name, url, options = {})
+      menu_items.add MenuItem.new(name, url, options)
+    end
+    def menu_items
+      @menu_items ||= Set.new
+    end
+    def clear_menu_items!
+      menu_items.clear
+    end
+  end
+end

data/lib/beyond_canvas/parameter_sanitizer.rb ADDED

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  class ParameterSanitizer # :nodoc:
+    DEFAULT_PERMITTED_ATTRIBUTES = %i[code signature return_url api_url access_token_url]
+    def initialize(resource_name, params)
+      @params         = params
+      @resource_name  = resource_name
+      @permitted      = DEFAULT_PERMITTED_ATTRIBUTES
+    end
+    def sanitize
+      permit_keys(default_params)
+    end
+    def permit(*keys)
+      @permitted.concat(keys)
+    end
+    private
+    def default_params
+      if hashable_resource_params?
+        @params.fetch(@resource_name)
+      else
+        empty_params
+      end
+    end
+    def hashable_resource_params?
+      @params[@resource_name].respond_to?(:permit)
+    end
+    def empty_params
+      ActionController::Parameters.new({})
+    end
+    def permit_keys(parameters)
+      parameters.permit(*@permitted)
+    end
+  end
+end

data/lib/beyond_canvas/rails/routes.rb ADDED

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module ActionDispatch
+  module Routing
+    class Mapper # :nodoc:
+      def beyond_canvas_routes(options = nil)
+        mount BeyondCanvas::Engine => BeyondCanvas.configuration.namespace
+        BeyondCanvas.use_rails_app_controller = options.present? && options[:custom_controller].present?
+        set_routes if BeyondCanvas.use_rails_app_controller
+      end
+      def set_routes
+        scope BeyondCanvas.configuration.namespace do
+          get  'callback', controller: :authentications, action: :new
+          post 'callback', controller: :authentications, action: :install
+        end
+      end
+    end
+  end
+end

data/lib/beyond_canvas/version.rb CHANGED

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module BeyondCanvas
-  VERSION = '0.15.2.pre'
+  VERSION = '0.17.0.pre'
 end

data/lib/generators/beyond_canvas/controller/controller_generator.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails/generators/active_record'
+module BeyondCanvas
+  module Generators
+    class ControllerGenerator < Rails::Generators::Base # :nodoc:
+      desc 'Creates an inherited Beyond Canvas controller in the app/controllers folder'
+      argument :scope, required: true, desc: 'The scope to create the controller, e.g. shops, users'
+      source_root File.expand_path('templates', __dir__)
+      def create_controller
+        template 'controller.erb', "app/controllers/#{scope}_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/beyond_canvas/controller/templates/controller.erb ADDED

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class <%= scope.camelize %>Controller < BeyondCanvas::AuthenticationsController
+  # before_action :configure_params, only: [:install]
+  # def new
+  #   super
+  # end
+  # def install
+  #   super
+  # end
+  # private
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_params
+  #   beyond_canvas_parameter_sanitizer.permit(:attribute1, :attribute2)
+  # end
+end

data/lib/generators/beyond_canvas/custom_menu/custom_menu_generator.rb ADDED

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  module Generators
+    class CustomMenuGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path('templates', __dir__)
+      def copy_initializer
+        copy_file 'beyond_canvas_custom_menu.html.erb', 'app/views/beyond_canvas/shared/_menu.html.erb'
+      end
+    end
+  end
+end

data/lib/generators/beyond_canvas/custom_menu/templates/beyond_canvas_custom_menu.html.erb ADDED

@@ -0,0 +1,32 @@
+<div class="menu">
+  <div class="menu--left">
+    <%= render 'beyond_canvas/shared/logo' %>
+  </div>
+  <div class="menu--center">
+<%
+=begin
+    Add here your menu links. You can use `menu__item` as class name and add
+    `menu__item--selected` as secondary class for selected menu item. E.g:
+    <%= link_to 'About us', about_us_path, class: "menu__item #{ 'menu__item--selected' if params[:controller] == 'about_us' }" %>
+    <%= link_to 'Support', support_path, class: "menu__item #{ 'menu__item--selected' if params[:controller] == 'support' }" %>
+=end
+%>
+  </div>
+  <div class="menu--right">
+<%
+=begin
+    You can also add here some content that will be right-aligned, like a user
+    avatar image or a dropdown account menu.
+=end
+%>
+  </div>
+</div>