activeadmin-menu_tree 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b04ec690f0cea481508a2359ede3943c33c5353e32fd1ae07d0da5e43fc66a8a
-  data.tar.gz: b8d28caed2ce7f24facabfd707b96e710d84a20a0ec96d89350f605e73763406
+  metadata.gz: f4c16b5f354db79d26599238e1b80d2bfb978c029a9209ea61ee37aaa5627f9e
+  data.tar.gz: 37937d45abb4268ec1a4ce475ab5b1c0cd4e0e5218ab7aeff5f43966945b209b
 SHA512:
-  metadata.gz: ff9dd6bf9962dda1a7b96c3c42dbf7b369f3d74d13ee8ff660129f74e9d77ea66c43bd928a28eeb8b9ca802e240eaf1a612f903155f031f8f027e93de02ebf7d
-  data.tar.gz: 697f1a4fd51a1832c2cfce26d363ee3f328cc953580a93229b4e3226145a0fbc4767dca6e02f025b4b23fbf1139bf5b0da29edce9b213ed4aada24f6e8a9ebb8
+  metadata.gz: 6ea399628b6146c8232f6af9162960bf83afa0cdd97a49809ee114c32467d3a476fd111c24019aab5325af184d78fae58467b41bcb7c41d82602af342a2bd5d5
+  data.tar.gz: 1d5382a9f0b3957688cf218ead03e55e04fe1f9d4846969dde586ba18ae832a8a00bddd47bec1c8b57834372c0fc08b07723783cc47222c96a8b357b2e5aabb9

data/.github/workflows/main.yml

@@ -18,27 +18,27 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: 3.1
       - name: Install bundler
         run: gem install bundler
       - name: Setup
         run: bin/setup
       - name: Rubocop
         run: bundle exec rake rubocop
-  steep:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0.0
-      - name: Install bundler
-        run: gem install bundler
-      - name: Setup
-        run: bin/setup
-      - name: Steep
-        run: bundle exec steep check
+  # steep:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - name: Set up Ruby
+  #       uses: ruby/setup-ruby@v1
+  #       with:
+  #         ruby-version: 3.1
+  #     - name: Install bundler
+  #       run: gem install bundler
+  #     - name: Setup
+  #       run: bin/setup
+  #     - name: Steep
+  #       run: bundle exec steep check
   rspec:
     runs-on: ubuntu-latest
     strategy:
@@ -46,6 +46,7 @@ jobs:
         ruby:
           - 2.7
           - 3.0
+          - 3.1
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby

data/.rubocop.yml

@@ -27,6 +27,9 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
 Style/TrailingCommaInHashLiteral:
   Enabled: false
 

data/Gemfile

@@ -12,4 +12,4 @@ gem "rubocop", "~> 1.0", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 gem "rubocop-rubycw", require: false
-gem "steep"
+gem "steep", ">= 0.47.0"

data/README.md

@@ -46,12 +46,12 @@ Write the configuration in a yaml file.
 # config/activeadmin-menu_tree.yml or anywhere you like
 activeadmin:
   menu_tree:
-    - name: Dashboard
+    - id: Dashboard
     - label: Admin
       children:
-        - name: AdminUser
+        - id: AdminUser
           label: Admin Users
-        - name: Comment
+        - id: Comment
           label: Admin Comments
 ```
 
@@ -86,19 +86,22 @@ end
 
 ### Other ways to load configuration
 
-It is also possible to simply use hash instead of yaml.
+It is also possible to simply use hash instead of yaml.  
+If you want to use dynamic specification using `proc` in menu_tree (instead of in ActiveAdmin Resource), you may want to use this one.
+
 ```ruby
 ActiveAdmin::MenuTree.setup do |config|
-  config.menu_tree = [{
-    name: "Dashboard"
-  }, {
-    label: "Foo",
-    children: [{
-      name: "Bar"
-    }, {
-      name: "Baz"
-    }]
-  }]
+  config.menu_tree = [
+    { id: "Dashboard", label: proc { I18n.t("active_admin.dashboard") } },
+    {
+      label: "Foo",
+      if: proc { "Something dynamic" },
+      children: [
+        { id: "Bar" },
+        { id: "Baz" }
+      ]
+    }
+  ]
 end
 ```
 
@@ -118,36 +121,53 @@ activeadmin:
 Or you can use other configuration gems like [global gem](https://github.com/railsware/global) by converting them to hash as well.
 
 ### Full configuration example
+
 ```yaml
 activeadmin:
   menu_tree:
-    # Specify the resource name with `name`.
-    - name: Dashboard
-    - name: Product
+    # Specify the resource with `id`.
+    - id: Dashboard
+    - id: Product
     # Specify a menu label with `label`.
     - label: User Info
       # Specify child elements with `children`.
       children:
-        - name: User
-        - name: Profile
+        - id: User
+        - id: Profile
     - label: Admin
       children:
-        - name: AdminUser
+        - id: AdminUser
           label: Admin Users
         # Comment resource will be handled specially.
-        - name: Comment
+        - id: Comment
           label: Admin Comments
     - label: Others
       children:
-        - name: Foo
-        - name: Bar
+        - id: Foo
+        - id: Bar
     - label: Example Site
       # You can pass the other options available for `menu` DSL, like `url`, `html_options`.
       url: 'https://example.com'
       html_options:
         target: blank
+    # Nesting of children is also available.
+    - label: Lorem
+      children:
+        - label: ipsum
+          children:
+            - label: dolor
+              children:
+                - label: sit
+                  children:
+                    - label: amet
+                      url: 'https://wikipedia.org/wiki/Lorem_ipsum'
+                      html_options:
+                        target: blank
 ```
 
+<img width="1573" alt="screenshot" src="https://user-images.githubusercontent.com/7542105/153759374-fd516cb8-8022-4e44-aad9-c97f77afc4e7.png">
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/activeadmin/menu_tree/config.rb

@@ -14,25 +14,22 @@ module ActiveAdmin::MenuTree
       raise ActiveAdmin::MenuTree::Error, "Invalid config" unless new_value.is_a? Array
 
       @menu_tree = new_value.map(&:deep_symbolize_keys)
-      @menu_options = flatten_menu_tree
+      @menu_options = flatten_options(@menu_tree)
     end
 
-    def find_menu_option(name:)
-      menu_options.find { |item| item[:name] == name }
+    def find_menu_option(id:)
+      menu_options.find { |item| item[:id] == id }
     end
 
     private
 
-    def flatten_menu_tree
-      menu_tree.map.with_index(1) do |item, index|
-        options = format_options(item, index: index)
+    def flatten_options(items, parent: nil)
+      items.map.with_index(1) do |item, index|
+        options = format_options(item, index: index, parent: parent)
         next options unless item[:children].is_a? Array
 
-        children =
-          item[:children].map.with_index(1) do |child, child_index|
-            format_options(child, index: child_index, parent: item[:label])
-          end
-
+        next_parent = parent ? [parent, item[:label]].flatten.compact : item[:label]
+        children = flatten_options(item[:children], parent: next_parent)
         [options] + children
       end.flatten.compact
     end
@@ -40,8 +37,11 @@ module ActiveAdmin::MenuTree
     def format_options(item, index:, parent: nil)
       # TODO: validate option
       options = item.except(:children)
+      if item.key?(:name)
+        ActiveAdmin::MenuTree.warn_deprecated("Use `id` key, instead of `name`.")
+        options[:id] ||= item[:name]
+      end
       options[:priority] = index * 10
-      options[:id] ||= item[:name]
       options[:parent] = parent if parent.present?
       options
     end

data/lib/activeadmin/menu_tree/dsl.rb

@@ -4,8 +4,7 @@ module ActiveAdmin::MenuTree
   # ActiveAdmin::MenuTree::DSL class
   module DSL
     def menu_tree(**args)
-      options = menu_tree_config.find_menu_option(name: config.resource_name.name) || {}
-      options = options.except(:name)
+      options = menu_tree_config.find_menu_option(id: config.resource_name.name) || {}
       options = options.merge(args)
       menu(**options)
     end

data/lib/activeadmin/menu_tree/logging.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module MenuTree
+    # ActiveAdmin::MenuTree::Logging module
+    module Logging
+      def debug?
+        ENV["MENU_TREE_DEBUG"]
+      end
+
+      def log_debug(message)
+        warn("[ActiveAdmin::MenuTree] #{message}") if debug?
+      end
+
+      def warn_deprecated(message)
+        warn("[ActiveAdmin::MenuTree] [DEPRECATION] #{message}")
+      end
+    end
+  end
+end

data/lib/activeadmin/menu_tree/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module MenuTree
-    VERSION = "0.1.2"
+    VERSION = "0.2.2"
   end
 end

data/lib/activeadmin/menu_tree.rb

@@ -4,6 +4,7 @@ require "active_support"
 require "active_support/core_ext"
 
 require_relative "menu_tree/version"
+require_relative "menu_tree/logging"
 require_relative "menu_tree/config"
 require_relative "menu_tree/dsl"
 
@@ -13,6 +14,8 @@ module ActiveAdmin
     class Error < StandardError; end
 
     class << self
+      include ActiveAdmin::MenuTree::Logging
+
       def setup
         raise ActiveAdmin::MenuTree::Error, "No block given, require a block" unless block_given?
 
@@ -32,13 +35,13 @@ module ActiveAdmin
       private
 
       def setup_menu_options(aa_config)
-        comments_menu = config.find_menu_option(name: "Comment")
+        comments_menu = config.find_menu_option(id: "Comment")
         aa_config.comments_menu = comments_menu if comments_menu.present?
 
         menu_options = config.menu_options
-                             .reject{ |item| item[:name] == "Comment" }
-                             .map{ |item| item.except(:name) }
+                             .reject{ |item| item[:id] == "Comment" }
 
+        ActiveAdmin::MenuTree.log_debug("menu_options: #{menu_options.inspect}")
         aa_config.namespace :admin do |admin|
           admin.build_menu do |menu|
             menu_options.each do |options|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-menu_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - shuuuuuny
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -61,6 +61,7 @@ files:
 - lib/activeadmin/menu_tree.rb
 - lib/activeadmin/menu_tree/config.rb
 - lib/activeadmin/menu_tree/dsl.rb
+- lib/activeadmin/menu_tree/logging.rb
 - lib/activeadmin/menu_tree/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Allows ActiveAdmin menus to be managed in tree format.