simpler_navigation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: affd12b2c48dcc0b8d8170a995f44a41bb1eb8dd79b0777558d748e1d79ece08
+  data.tar.gz: a2f46bd7e2a3237100c81789db92d8ae1f4d405bec317ad6b252270b36c13d2c
+SHA512:
+  metadata.gz: 4c707bfeccaf400af2517bfeb2840591ef3d1e5c91f880818f361d71ce68c51bcea7f7fef9deb9b58c8ccc3a8af10374d52b8465e98edbfb6c2b1048371f7924
+  data.tar.gz: b4459aa5521c300c7956ff0cad8fa8441e5774ae419e62beeeee292e1e0d521a4a2d13c537de0035c776961bf15eea7f8ef7a458d4e237a678d5c4b865f5f747

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simpler_navigation.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    simpler_navigation (0.1.0)
+      actionview
+      railties
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.2)
+      actionview (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    erubi (1.12.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.24.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  simpler_navigation!
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Nick Muerdter
+
+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,33 @@
+# Simpler Navigation
+
+A Rails gem to handle navigation menus and breadcrumbs.
+
+Heavily inspired by [Simple Navigation](https://github.com/codeplant/simple-navigation/tree/master), but aiming to address performance and thread safety issues with a smaller feature set.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add simpler_navigation
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install simpler_navigation
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simpler_navigation.
+
+## 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,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/simpler_navigation/configuration.rb

@@ -0,0 +1,28 @@
+module SimplerNavigation
+  class Configuration
+    attr_accessor :selected_class
+    attr_accessor :active_leaf_class
+    attr_reader :root_item
+
+    def self.run(&block)
+      SimplerNavigation.config = new(&block)
+    end
+
+    def initialize
+      @selected_class = "selected"
+      @active_leaf_class = "simple-navigation-active-leaf"
+
+      if block_given?
+        yield self
+      end
+    end
+
+    def items
+      @root_item = Item.new(key: nil, name: nil, url: nil)
+
+      if block_given?
+        yield @root_item
+      end
+    end
+  end
+end

data/lib/simpler_navigation/item.rb

@@ -0,0 +1,38 @@
+module SimplerNavigation
+  class Item
+    attr_reader :name
+    attr_reader :url
+    attr_reader :level
+    attr_reader :options
+    attr_reader :children
+
+    def initialize(key:, name:, url:, level: 0, options: {})
+      @key = key
+      @name = name
+      @url = url
+      @level = level
+      @options = options
+      @children = {}
+    end
+
+    def item(key, name, url, options = {})
+      if @children[key]
+        raise "Navigation item already exists for #{key.inspect}"
+      end
+
+      @children[key] = Item.new(key: key, name: name, url: url, level: @level + 1, options: options)
+
+      if block_given?
+        yield @children[key]
+      end
+    end
+
+    def [](key)
+      @children[key]
+    end
+
+    def fetch(key)
+      @children.fetch(key)
+    end
+  end
+end

data/lib/simpler_navigation/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+require "simpler_navigation/view_helpers"
+
+module SimplerNavigation
+  class Railtie < ::Rails::Railtie
+    initializer "simpler_navigation.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include ViewHelpers
+      end
+    end
+  end
+end

data/lib/simpler_navigation/renderers/base.rb

@@ -0,0 +1,180 @@
+require "action_view"
+
+module SimplerNavigation
+  module Renderers
+    class Base
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::OutputSafetyHelper
+
+      def initialize(context, item, options = {})
+        @selected = {}
+        @active_leaf = {}
+        @show = {}
+
+        @context = context
+        @item = item
+        @options = options
+
+        if @item.nil?
+          case @options[:level]
+          when :all
+            @item = SimplerNavigation.config.root_item
+          when Integer
+            @item = find_parent_item_for_level(SimplerNavigation.config.root_item, @options[:level])
+          when Range
+            @item = find_parent_item_for_level(SimplerNavigation.config.root_item, @options[:level].min)
+          else
+            raise Error, "Invalid navigation level: #{@options[:level]}"
+          end
+        end
+      end
+
+      protected
+
+      def find_parent_item_for_level(item, level)
+        parent_item = nil
+
+        if item.level == (level - 1)
+          parent_item = item
+        elsif item.children.any?
+          selected_child = item.children.find { |key, value| selected?(value) }&.last
+          if selected_child
+            parent_item = find_parent_item_for_level(selected_child, level)
+          end
+        end
+
+        parent_item
+      end
+
+      def link_tag(item)
+        link_to(item.name, item.url, link_tag_options(item))
+      end
+
+      def link_tag_options(item)
+        options = if item.options[:link_html]
+          item.options[:link_html].dup
+        else
+          {}
+        end
+
+        classes = []
+        if options[:class]
+          classes << options[:class]
+        end
+        if selected?(item)
+          classes << SimplerNavigation.config.selected_class
+        end
+        options[:class] = classes.compact.join(" ")
+
+        options
+      end
+
+      def wrapper_tag_options(item)
+        options = if item.options[:html]
+          item.options[:html].dup
+        else
+          {}
+        end
+
+        classes = []
+        if options[:class]
+          classes << options[:class]
+        end
+        if selected?(item)
+          classes << SimplerNavigation.config.selected_class
+        end
+        if active_leaf?(item)
+          classes << SimplerNavigation.config.active_leaf_class
+        end
+        options[:class] = classes.compact.join(" ")
+
+        options
+      end
+
+      def include_sub_navigation?(item)
+        consider_sub_navigation?(item) && selected?(item)
+      end
+
+      def url_path(url)
+        url.sub(/[#?].*/, "")
+      end
+
+      def selected?(item)
+        return @selected[item] if @selected.key?(item)
+
+        selected = false
+        case item.options[:highlights_on]
+        when Regexp
+          selected = item.options[:highlights_on].match?(SimplerNavigation.request_fullpath)
+        when Proc
+          selected = item.options[:highlights_on].call
+        else
+          if SimplerNavigation.request_fullpath
+            item_url_path = url_path(item.url).downcase
+            selected = SimplerNavigation.request_fullpath.downcase.start_with?(item_url_path)
+          end
+
+          selected ||= item.children.any? do |key, value|
+            selected?(value)
+          end
+        end
+
+        @selected[item] = selected
+      end
+
+      def active_leaf?(item)
+        return @active_leaf[item] if @active_leaf.key?(item)
+
+        active_leaf = false
+        if selected?(item)
+          active_leaf = item.children.none? do |key, value|
+            selected?(value)
+          end
+        end
+
+        @active_leaf[item] = active_leaf
+      end
+
+      def show?(item)
+        return @show[item] if @show.key?(item)
+
+        show = true
+        if !item.options[:if].nil?
+          show = case item.options[:if]
+          when false
+            false
+          when true
+            true
+          else
+            item.options[:if].call
+          end
+        elsif !item.options[:unless].nil?
+          show = case item.options[:unless]
+          when false
+            true
+          when true
+            false
+          else
+            !item.options[:unless].call
+          end
+        end
+
+        @show[item] = show
+      end
+
+      def consider_sub_navigation?(item)
+        return false unless item.children.any?
+
+        case @options[:level]
+        when :all
+          true
+        when Range
+          item.level < @options[:level].max
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/simpler_navigation/renderers/breadcrumb.rb

@@ -0,0 +1,36 @@
+require "simpler_navigation/renderers/base"
+
+module SimplerNavigation
+  module Renderers
+    class Breadcrumb < Base
+      def render
+        tags = crumb_tags(@item)
+
+        join_with = @options[:join_with] || " "
+        content_tag(:div, safe_join(tags, join_with))
+      end
+
+      private
+
+      def crumb_tags(parent_item)
+        tags = []
+
+        parent_item.children.each_value do |item|
+          next unless show?(item) && selected?(item)
+
+          tags << if @options[:static_leaf] && active_leaf?(item)
+            content_tag("span", item.name, link_tag_options(item))
+          else
+            link_tag(item)
+          end
+
+          if include_sub_navigation?(item)
+            tags += crumb_tags(item)
+          end
+        end
+
+        tags
+      end
+    end
+  end
+end

data/lib/simpler_navigation/renderers/list.rb

@@ -0,0 +1,27 @@
+require "simpler_navigation/renderers/base"
+
+module SimplerNavigation
+  module Renderers
+    class List < Base
+      def render
+        list = []
+        @item.children.each_value do |item|
+          next unless show?(item)
+
+          li_content = link_tag(item)
+          if include_sub_navigation?(item)
+            li_content << List.new(@context, item, @options).render
+          end
+
+          if @options[:render_content_partials] && item.options[:content_partial]
+            li_content << @context.render(partial: item.options[:content_partial])
+          end
+
+          list << content_tag(:li, li_content, wrapper_tag_options(item))
+        end
+
+        content_tag(:ul, safe_join(list))
+      end
+    end
+  end
+end

data/lib/simpler_navigation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimplerNavigation
+  VERSION = "0.1.0"
+end

data/lib/simpler_navigation/view_helpers.rb

@@ -0,0 +1,7 @@
+module SimplerNavigation
+  module ViewHelpers
+    def render_navigation(renderer: SimplerNavigation::Renderers::List, item: nil, **args)
+      renderer.new(self, item, **args).render
+    end
+  end
+end

data/lib/simpler_navigation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simpler_navigation/configuration"
+require "simpler_navigation/item"
+require "simpler_navigation/railtie"
+require "simpler_navigation/renderers/breadcrumb"
+require "simpler_navigation/renderers/list"
+require "simpler_navigation/version"
+
+module SimplerNavigation
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :config
+    attr_accessor :request_fullpath
+  end
+end

data/sig/simpler_navigation.rbs

@@ -0,0 +1,4 @@
+module SimplerNavigation
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/simpler_navigation.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/simpler_navigation/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simpler_navigation"
+  spec.version = SimplerNavigation::VERSION
+  spec.authors = ["Nick Muerdter"]
+  spec.email = ["12112+GUI@users.noreply.github.com"]
+
+  spec.summary = "A Rails gem to handle navigation menus and breadcrumbs."
+  spec.homepage = "https://github.com/GUI/simpler_navigation"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GUI/simpler_navigation"
+  spec.metadata["changelog_uri"] = "https://github.com/GUI/simpler_navigation/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionview"
+  spec.add_dependency "railties"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: simpler_navigation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Muerdter
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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:
+email:
+- 12112+GUI@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simpler_navigation.rb
+- lib/simpler_navigation/configuration.rb
+- lib/simpler_navigation/item.rb
+- lib/simpler_navigation/railtie.rb
+- lib/simpler_navigation/renderers/base.rb
+- lib/simpler_navigation/renderers/breadcrumb.rb
+- lib/simpler_navigation/renderers/list.rb
+- lib/simpler_navigation/version.rb
+- lib/simpler_navigation/view_helpers.rb
+- sig/simpler_navigation.rbs
+- simpler_navigation.gemspec
+homepage: https://github.com/GUI/simpler_navigation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GUI/simpler_navigation
+  source_code_uri: https://github.com/GUI/simpler_navigation
+  changelog_uri: https://github.com/GUI/simpler_navigation/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A Rails gem to handle navigation menus and breadcrumbs.
+test_files: []