five-two-nw-olivander 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 804923f3e2c0757a3477f96abbeb27d83230e0cb57be24c0943ed72ac270ca73
-  data.tar.gz: c5117164723c492667ac149891e2ef2619688074a63e8a387b2c7701a2e85b4a
+  metadata.gz: dc6de8b38d444eb9b91d348d755b9f98d49a11496cb6a1a94af7ec8f20e4623a
+  data.tar.gz: ab9f6ff9469281da90f5dfcbad98b0827046506aa869cb8ce0bee5e480521143
 SHA512:
-  metadata.gz: e8c3e1a18f2cc7d51605a5522445684e2ddbb39acb8767816983106d8d7dfce85a8e4321034d5d4605021790d5719288c361f67f359964ca53db98277863568e
-  data.tar.gz: 3c14a579d133cea6d03239af43390de369d7d023a590c17e5e29ebbc213126e8a6be8bfe82daa3d26cbce1947501d1be6a6217417693c1f5b67cfaadc3e416cf
+  metadata.gz: 8b4d04a662d71f34f11078d7a1b45a6c7b21b6179ac49b848c9e506d1236b63322c39e13b31b9b928976f0be724e5f60a8bb60a707a93bcd9fd26882e48a2ee1
+  data.tar.gz: 5cb41955375fddc24bce230f16d6c383b8e3848f967be90343f009140c7a243ec416d0cbb329ac4997a83c5c94a5e7b55c788bbc04c29a26f0509c119314db68

data/app/assets/stylesheets/adminlte.css

@@ -18,6 +18,7 @@
  *= require 'adminlte/plugins/daterangepicker/daterangepicker'
  *= require 'adminlte/plugins/summernote/summernote-bs4.min'
  *= require 'adminlte/plugins/fontawesome-free/css/all.min'
+ *= require effective_datatables
  *= require_tree .
  *= require_self
  */

data/app/components/olivander/components/menu_item_component.html.haml

@@ -0,0 +1,19 @@
+- if menu_item.visible
+  - if menu_item.href
+    %li.nav-item
+      %a.nav-link{href: menu_item.href}
+        - if menu_item.icon_class
+          %i.nav-icon{class: menu_item.icon_class}
+        %p
+          = menu_item.text
+          - if menu_item.submenu_items.size.positive?
+            %i.fas.fa-angle-left.right
+          - menu_item.badges.each do |badge|
+            %span.badge.right{ class: "badge-#{badge.badge_class}" }
+              = badge.text
+      - if menu_item.submenu_items.size.positive?
+        %ul.nav.nav-treeview
+          - menu_item.submenu_items.each do |item|
+            = render Olivander::Components::MenuItemComponent.new(item)
+  - else
+    %li.nav-header= menu_item.text.upcase

data/app/components/olivander/components/menu_item_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Olivander::Components::MenuItemComponent < ViewComponent::Base
+  attr_reader :menu_item
+
+  def initialize(menu_item)
+    super
+    @menu_item = menu_item
+  end
+end

data/app/controllers/olivander/resources/crud_chain.rb

@@ -0,0 +1,119 @@
+module Olivander
+  module Resources
+    class CrudChain
+      attr_accessor :controller
+
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def links
+        @links ||= {
+          authorize_action: nil,
+          before_load: nil, load_resource: nil, after_load: nil,
+          authorize_resource: nil,
+          before_assign: nil, assign: nil, after_assign: nil,
+          update_if: nil,
+          before_update: nil, update: nil, after_update: nil,
+          update_success: nil, update_failure: nil,
+          render_success: nil, render_failure: nil
+        }
+      end
+
+      def on(chain_link, &block)
+        raise "Invalid Link: #{chain_link}" unless links.keys.include?(chain_link)
+
+        links[chain_link] = block
+        self
+      end
+
+      def skip_load
+        clear_keys(%i[before_load load_resource after_load])
+        self
+      end
+
+      def skip_assign
+        clear_keys(%i[before_assign assign after_assign])
+        self
+      end
+
+      def skip_update
+        update_if { false }
+        self
+      end
+
+      def skip_render
+        clear_keys(%i[render_success render_failure])
+        self
+      end
+
+      def execute
+        execute_link_keys(%i[authorize_action before_load load_resource after_load authorize_resource before_assign assign after_assign])
+        success = perform_update
+        # we may not do any update - in which case we assume success
+        success = true if success.nil?
+        execute_link_key(success ? :render_success : :render_failure)
+        success
+      end
+
+      # def self.test
+      #   CrudChain.new('string')
+      #            .before_load { puts "we did a before load from within this action: #{self}" }
+      #            .before_update { puts "we are doing a before_update on a controller named: #{self.class.name}" }
+      #            .execute
+      # end
+
+      def clear_keys(keys)
+        keys.each { |k| clear_key(k) }
+      end
+
+      def clear_keys_except(keys)
+        (links.keys - keys).each { |k| clear_key(k) }
+      end
+
+      def clear_key(key)
+        links[key] = nil
+      end
+
+      private
+
+      def perform_update
+        perform_update = execute_link_key(:update_if)
+        perform_update = true if perform_update.nil?
+        return false unless perform_update
+
+        execute_link_key(:before_update) 
+        success = execute_link_key(:update)
+        execute_link_key(:after_update)
+        execute_link_key(success ? :update_success : :update_failure)
+        success
+      end
+
+      def execute_link_keys(keys)
+        keys.each do |k|
+          execute_link_key(k)
+        end
+      end
+
+      def execute_link_key(key)
+        block = links[key]
+        return if block.nil?
+
+        @controller.instance_exec(&block)
+      end
+
+      def respond_to_missing?(method_name, _include_private = false)
+        links.keys.include?(method_name.to_sym)
+      end
+
+      # syntax sugar to allow direct assignment of a chain link
+      def method_missing(m, *args, &block)
+        if respond_to_missing?(m)
+          send(:on, m, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/controllers/olivander/resources/crud_controller.rb

@@ -0,0 +1,55 @@
+module Olivander
+  module Resources
+    module CrudController
+      def index
+        execute_crud_chain(crud_action: :index)
+      end
+
+      def new
+        execute_crud_chain(crud_action: :new)
+      end
+
+      def create
+        execute_crud_chain(crud_action: :create)
+      end
+
+      def show
+        execute_crud_chain(crud_action: :show)
+      end
+
+      def edit
+        execute_crud_chain(crud_action: :edit)
+      end
+
+      def update
+        execute_crud_chain(crud_action: :update)
+      end
+
+      def destroy
+        execute_crud_chain(crud_action: :destroy)
+      end
+
+      def execute_crud_chain(crud_action: action_name, only: [], skip: [], &block)
+        chain = default_crud_chain(crud_action)
+        chain.clear_keys_except(only) if only.size.positive?
+        chain.clear_keys(skip) if skip.size.positive?
+        yield(chain) if block_given?
+        chain.execute
+      end
+
+      def default_crud_chain(crud_action = '')
+        chain = Olivander::Resources::CrudChain.new(self)
+        chain.links.keys.each do |k|
+          method_name = "crud_chain_#{crud_action}_#{k}"
+          method_name = "crud_chain_#{k}" unless respond_to?(method_name)
+          next unless respond_to?(method_name)
+
+          chain.on(k) do
+            send(method_name)
+          end
+        end
+        chain
+      end
+    end
+  end
+end

data/app/controllers/olivander/resources/default_crud_chain.rb

@@ -0,0 +1,48 @@
+module Olivander
+  module Resources
+    module DefaultCrudChain
+      def crud_chain_index_authorize_action
+        puts 'default crud chain: index_authorize_action'
+      end
+
+      def crud_chain_index_load_resource
+        puts 'default crud chain: index_load_resource'
+      end
+
+      def crud_chain_load_resource
+        puts 'default crud chain: load_resource'
+      end
+
+      def crud_chain_authorize_resource
+        raise 'Unauthorized' unless true
+        puts 'default crud chain: authorize_resource'
+      end
+
+      def crud_chain_assign
+        puts 'default crud chain: assign'
+      end
+
+      def crud_chain_update_if
+        puts 'default crud chain: update_if'
+        return true if %w[create update destroy].include?(action_name)
+        return false if %w[index new show edit].include?(action_name)
+        return false if request.method == 'GET'
+
+        true
+      end
+
+      def crud_chain_update
+        puts 'default crud chain: update'
+        true
+      end
+
+      def crud_chain_render_success
+        puts 'default crud chain: render_success'
+      end
+
+      def crud_chain_render_failure
+        puts 'default crud chain: render_failure'
+      end
+    end
+  end
+end

data/app/controllers/olivander/test_controller.rb

@@ -0,0 +1,35 @@
+module Olivander
+  class TestController < ApplicationController
+    include Olivander::Resources::CrudController
+    include Olivander::Resources::DefaultCrudChain
+
+    def index
+      execute_crud_chain(crud_action: :index) do |c|
+        c.authorize_resource { puts 'block: authorize_resource'; true }
+         .update { puts 'block: update'; true }
+         .before_assign { puts 'block: before assign' }
+         .after_assign { puts 'block: after assign' }
+      end
+    end
+
+    # def crud_chain_update
+    #   puts 'controller: update'
+    # end
+
+    # def crud_chain_index_update
+    #   puts 'controller: index_update'
+    # end
+
+    # def crud_chain_before_load
+    #   puts 'controller: before_load'
+    # end
+
+    # def crud_chain_after_update
+    #   puts 'controller: after_update'
+    # end
+
+    # def crud_chain_index_after_update
+    #   puts 'controller: index_after_update'
+    # end
+  end
+end

data/app/helpers/olivander/application_helper.rb

@@ -1,7 +1,16 @@
 module Olivander
   module ApplicationHelper
     def page_title
-      'foo'
+      return @page_title if @page_title
+
+      cf = content_for(:title)
+      return cf unless cf.blank?
+
+      controller_key = controller.class.name.underscore
+      key = "page_titles.#{controller_key}.#{action_name}"
+      return I18n.t(key) if I18n.exists?(key)
+
+      "#{controller_name}: #{action_name}".titleize
     end
 
     def user_image_path(user)

data/app/views/layouts/olivander/adminlte/_content.html.haml

@@ -2,7 +2,11 @@
   %section.content-header
     .container-fluid
       .row.mb-2
-        %h1= page_title
+        .col-sm-6
+          %h1= page_title
+        .col-sm-6
+          %ol.breadcrumb.float-sm-right
+            = content_for(:breadcrumb)
   %section.content
     .container-fluid
       = content

data/app/views/layouts/olivander/adminlte/_footer.html.haml

@@ -2,8 +2,10 @@
   %strong
     Copyright © #{Date.current.year}
     = succeed "." do
-      %a{:href => "https://adminlte.io"} AdminLTE.io
+      = link_to @context.company.name, @context.company.url
   All rights reserved.
   .float-right.d-none.d-sm-inline-block
-    %b Version
-    3.2.0
+    .text-small
+      Powered by
+      = link_to '5&2 Northwest', 'https://www.5and2northwest.com'
+      %b Olivander v#{Olivander::VERSION}

data/app/views/layouts/olivander/adminlte/_head.html.haml

@@ -8,4 +8,4 @@
   = javascript_include_tag "https://www.gstatic.com/charts/loader.js"
   = stylesheet_link_tag "adminlte", "data-turbo-track": "reload"
   = javascript_include_tag "adminlte", "data-turbo-track": "reload"
-  = javascript_importmap_tags
+  -# = javascript_importmap_tags

data/app/views/layouts/olivander/adminlte/_navbar.html.haml

@@ -5,10 +5,9 @@
     %li.nav-item
       %a.nav-link{"data-widget" => "pushmenu", :href => "#", :role => "button"}
         %i.fas.fa-bars
-    %li.nav-item.d-none.d-sm-inline-block
-      %a.nav-link{:href => "/foo"} Foo
-    %li.nav-item.d-none.d-sm-inline-block
-      %a.nav-link{:href => "/system"} System
+    - @context.visible_modules.each do |menu_item|
+      %li.nav-item.d-none.d-sm-inline-block
+        = link_to menu_item.text, menu_item.href, class: 'nav-link'
   / Right navbar links
   %ul.navbar-nav.ml-auto
     / Navbar Search

data/app/views/layouts/olivander/adminlte/_sidebar.html.haml

@@ -2,8 +2,8 @@
 %aside.main-sidebar.sidebar-dark-primary.elevation-4{ data: { controller: 'left-nav' }}
   / Brand Logo
   %a.brand-link.bg-info{:href => "/"}
-    %img.brand-image.img-circle.elevation-3{:alt => @context.logo_alt, :src => 'image_path("logo.png")', :style => "opacity: .8"}/
-    %span.brand-text.font-weight-light= @context.page_title
+    %img.brand-image.img-circle.elevation-3{:alt => @context.logo.alt, :src => @context.logo.url, :style => "opacity: .8"}/
+    %span.brand-text.font-weight-light= @context.name
   / Sidebar
   .sidebar
     / Sidebar user panel (optional)
@@ -22,3 +22,5 @@
     / Sidebar Menu
     %nav.mt-2
       %ul.nav.nav-pills.nav-sidebar.nav-compact.flex-column{"data-accordion" => "false", "data-widget" => "treeview", :role => "menu"}
+        - @context.menu_items.each do |menu_item|
+          = render Olivander::Components::MenuItemComponent.new(menu_item)

data/app/views/layouts/olivander/adminlte/main.html.haml

@@ -1,6 +1,6 @@
 !!!
 %html
-  - @context = OpenStruct.new({ page_title: 'title', logo_alt: 'logo alt' })
+  - @context ||= Olivander::ApplicationContext.default
   = render partial: 'layouts/olivander/adminlte/head'
   - sidebar_collapse = cookies['lte.pushmenu.collapsed'] == 'true' ? 'sidebar-collapse' : ''
   %body.hold-transition.sidebar-mini.layout-fixed{ class: sidebar_collapse }
@@ -15,3 +15,4 @@
       = render partial: 'layouts/olivander/adminlte/flashes'
       = render partial: 'layouts/olivander/adminlte/footer'
       = render partial: 'layouts/olivander/adminlte/control_sidebar'
+    = content_for :javascript

data/lib/five-two-nw-olivander.rb

@@ -2,4 +2,5 @@ require 'effective_resources'
 require 'effective_datatables'
 require 'haml-rails'
 require 'chartkick'
+require 'view_component'
 require 'olivander'

data/lib/olivander/application_context.rb

@@ -0,0 +1,53 @@
+module Olivander
+  class ApplicationContext
+    attr_accessor :name, :logo, :company, :menu_items
+
+    def self.default
+      ctx = ApplicationContext.new
+      ctx.company.name = 'Company Name'
+      ctx
+    end
+
+    def initialize(name: 'Application Name', logo: Logo.new, company: Company.new, menu_items: [])
+      self.name = name
+      self.logo = logo
+      self.company = company
+      self.menu_items = menu_items
+    end
+
+    def visible_modules
+      [].tap do |arr|
+        menu_items.each do |menu_item|
+          arr << visible_modules_for(menu_item)
+        end
+      end.flatten
+    end
+
+    def visible_modules_for(menu_item)
+      [].tap do |arr|
+        arr << menu_item if menu_item.module? && menu_item.visible
+        menu_item.submenu_items.each do |sub|
+          arr << visible_modules_for(sub)
+        end
+      end
+    end
+
+    class Logo
+      attr_accessor :url, :alt
+
+      def initialize(url: nil, alt: 'Logo')
+        self.url = url
+        self.alt = alt
+      end
+    end
+
+    class Company
+      attr_accessor :name, :url
+
+      def initialize(name: nil, url: nil)
+        self.url = url
+        self.name = name
+      end
+    end
+  end
+end

data/lib/olivander/menus/menu_item.rb

@@ -0,0 +1,106 @@
+module Olivander
+  module Menus
+    class MenuItem
+      attr_reader :href
+
+      def initialize(key, href = nil, icon = nil, is_module: false)
+        @key = key
+        @href = href
+        @icon = icon
+        @submenu_items_blocks = []
+        @badges_blocks = []
+        @module = is_module
+      end
+
+      def module?
+        @module
+      end
+
+      def text
+        resolved_key(@key, "menus.#{@key}.text")
+      end
+
+      def icon_class
+        @icon || resolved_key(@key, "menus.#{@key}.icon", 'menus.default_icon')
+      end
+
+      def visible
+        @visible ||= evaluate_conditions_block
+      end
+
+      def with_condition(&block)
+        @conditions_block = block
+        self
+      end
+
+      def with_submenu_items(&block)
+        @submenu_items_blocks << block
+        self
+      end
+
+      def submenu_items
+        @submenu_items ||= [].tap do |arr|
+          if visible
+            @submenu_items_blocks.each do |block|
+              Rails.logger.debug "invoking submenu item block on #{@key}"
+              block.call.each { |item| arr << item if item.visible }
+            end
+          end
+        end
+      end
+
+      def with_badges(&block)
+        @badges_blocks << block
+        self
+      end
+
+      def badges
+        @badges ||= [].tap do |arr|
+          if visible
+            @badges_blocks.each do |block|
+              Rails.logger.debug "invoking badge block on #{@key}"
+              block.call.each { |badge| arr << badge }
+            end
+          end
+        end
+      end
+
+      private
+
+      def evaluate_conditions_block
+        if @conditions_block
+          Rails.logger.debug "invoking condition on #{@key}"
+          @conditions_block.call
+        else
+          true
+        end
+      end
+
+      def resolved_key(raw, key = nil, fallback = nil)
+        return nil unless raw
+
+        if key && I18n.exists?(key)
+          I18n.t(key)
+        elsif fallback && I18n.exists?(fallback)
+          I18n.t(fallback)
+        else
+          raw.titleize
+        end
+      end
+    end
+
+    class Badge
+      attr_accessor :text, :badge_class
+  
+      def initialize(text = nil, badge_class = nil)
+        @text = text
+        @badge_class = badge_class
+      end
+  
+      def with_proc
+        yield(self)
+        self
+      end
+    end
+  end
+end

data/lib/olivander/menus.rb

@@ -0,0 +1 @@
+require 'olivander/menus/menu_item'

data/lib/olivander/version.rb

@@ -1,3 +1,3 @@
 module Olivander
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/olivander.rb

@@ -1,5 +1,7 @@
-require "olivander/version"
-require "olivander/engine"
+require 'olivander/version'
+require 'olivander/engine'
+require 'olivander/application_context'
+require 'olivander/menus'
 
 module Olivander
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: five-two-nw-olivander
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Eric Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: view_component
+  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'
 description: Description of Olivander.
 email:
 - devops@5and2northwest.com
@@ -141,7 +155,13 @@ files:
 - app/assets/stylesheets/adminlte.css
 - app/assets/stylesheets/fa-fix.scss
 - app/assets/stylesheets/olivander/application.css
+- app/components/olivander/components/menu_item_component.html.haml
+- app/components/olivander/components/menu_item_component.rb
 - app/controllers/olivander/application_controller.rb
+- app/controllers/olivander/resources/crud_chain.rb
+- app/controllers/olivander/resources/crud_controller.rb
+- app/controllers/olivander/resources/default_crud_chain.rb
+- app/controllers/olivander/test_controller.rb
 - app/datatables/test_datatable.rb
 - app/helpers/olivander/application_helper.rb
 - app/jobs/olivander/application_job.rb
@@ -159,11 +179,14 @@ files:
 - app/views/layouts/olivander/adminlte/login.html.haml
 - app/views/layouts/olivander/adminlte/main.html.haml
 - app/views/layouts/olivander/application.html.haml
-- config/initializers/effective_datatables.rb
+- config/initializers/effective_datatables.rb.old
 - config/routes.rb
 - lib/five-two-nw-olivander.rb
 - lib/olivander.rb
+- lib/olivander/application_context.rb
 - lib/olivander/engine.rb
+- lib/olivander/menus.rb
+- lib/olivander/menus/menu_item.rb
 - lib/olivander/version.rb
 - lib/tasks/olivander_tasks.rake
 homepage: https://rubygems.org/gems/olivander