navtastic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f71489809ad37489fff943b48ecc3c00224a7d5d
+  data.tar.gz: 8d52c7216084c2e84d620ae1f94b7464fc4c68ad
+SHA512:
+  metadata.gz: c9a022d6a93b60adbc98dfed4d8fe26b9a9b4d35c6ac1e37a83e9a6c511cd4c021ed15e5fd4cc6871d40c585b032b13e6062c503550d11892fdccf7802d69015
+  data.tar.gz: 6b3678f6e320f10eab9f158845ec34cdb634f0b3babe35fa9c7649dfd907148a348438b6a7febb60bfef866fe185e76fe8225ff3b0b1cf0dc1b251750a9c7b85

data/.circleci/config.yml

@@ -0,0 +1,70 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/navtastic
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            echo "gem 'rspec_junit_formatter'" >> Gemfile
+            echo "gem 'rubocop-junit-formatter'" >> Gemfile
+            echo "gem 'simplecov', require: false" >> Gemfile
+
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run:
+          name: install code climate test reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+            sudo mkdir -p $CIRCLE_TEST_REPORTS/phpunit
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+
+            ./cc-test-reporter before-build
+
+            COVERAGE=true bundle exec rspec --format progress \
+                                            --format RspecJunitFormatter \
+                                            --out /tmp/test-results/rspec.xml \
+                                            --format progress
+
+            bundle exec rubocop \
+              --require $(bundle show rubocop-junit-formatter)/lib/rubocop/formatter/junit_formatter.rb \
+              --format RuboCop::Formatter::JUnitFormatter \
+              --out /tmp/test-results/rubocop.xml \
+              --format progress \
+              --parallel
+
+      - run:
+          name: upload reports to code climate
+          when: "always"
+          command: |
+            ./cc-test-reporter format-coverage -t simplecov $CIRCLE_ARTIFACTS/coverage/.resultset.json
+            ./cc-test-reporter upload-coverage
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.codeclimate.yml

@@ -0,0 +1,13 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+    exclude_paths:
+    - "spec/"
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    channel: rubocop-0-48

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+/spec/reports/
+/spec/examples.txt
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/coverage/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require: rubocop-rspec
+
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/demo/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'spec/support/matchers/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+--markup=markdown
+--no-private
+-
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [Unreleased]
+
+## 0.0.1 - 2017-08-21
+
+### Added
+
+- Defining menu's and submenus
+- Rendering a simple menu
+- Highlighting current menu item
+- Runtime parameters
+
+[Unreleased]: https://github.com/aramvisser/navtastic/compare/v0.0.1...HEAD

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Aram Visser
+
+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,143 @@
+# Navtastic
+
+[![Build Status](https://img.shields.io/circleci/project/github/aramvisser/navtastic.svg)](https://circleci.com/gh/aramvisser/navtastic)
+[![Code Coverage](https://img.shields.io/codeclimate/coverage/github/aramvisser/navtastic.svg)](https://codeclimate.com/github/aramvisser/navtastic)
+[![Inline docs](https://inch-ci.org/github/aramvisser/navtastic.svg?branch=master)](https://inch-ci.org/github/aramvisser/navtastic)
+[![MIT License](https://img.shields.io/github/license/aramvisser/navtastic.svg)](https://github.com/aramvisser/navtastic/blob/master/LICENSE)
+
+Navtastic is way to create and render complex navigation menus. It allows for runtime configurations
+of menus.
+
+- Keep menu content and rendering logic separate
+- Automatically highlight the current page
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Example](#example)
+- [Documentation](#documentation)
+  - [Submenus](#submenus)
+  - [Current item](#current-item)
+  - [Runtime parameters](#runtime-parameters)
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'navtastic'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+## Example
+
+Define a menu somwhere:
+
+```ruby
+Navtastic.define :main_menu do |menu|
+  menu.item "Home", '/'
+  menu.item "Posts", '/posts'
+  menu.item "About", '/about'
+end
+```
+
+Render it in your partials:
+
+```erb
+<%= Navtastic.render :main_menu, current_url %>
+```
+
+Using the default renderer, assuming that the current url starts with `/posts`, will result in:
+
+```html
+<ul>
+  <li>
+    <a href="/">Home</a>
+  </li>
+  <li class="current">
+    <a href="/posts">Posts</a>
+  </li>
+  <li>
+    <a href="/about">About</a>
+  </li>
+</ul>
+```
+
+## Documentation
+
+## Submenus
+
+Every item can have a submenu. They can be nested as deeply as you want (or at least until Ruby starts complaining).
+
+```ruby
+Navtastic.define :main_menu do |menu|
+  menu.item "Home", '/' do |submenu|
+    submenu.item "Posts", '/posts'
+    submenu.item "About", '/about'
+  end
+
+  menu.item "Settings" do |submenu|
+    submenu.item "General", '/settings'
+    submenu.item "Profile", '/settings/profile'
+  end
+end
+```
+
+By default, submenus will be rendered inside the `<li>` tag of the parent item.
+
+```html
+<ul>
+  <li>
+    <a href="/">Parent</a>
+    <ul>
+      <li>
+        <a href="/child">Child</a>
+      </li>
+    </ul>
+  </li>
+</ul>
+```
+
+### Current item
+
+The current active item is decided by the `current_url` parameter when rendering a menu. It is the
+item with the longest url that starts with the current_url.
+
+For example, if there is a menu containing these urls:
+
+- `/`
+- `/posts`
+- `/posts/featured`
+
+If the current_url is `/posts/featured/2017`, the `/posts/featured` item will be highlighted. If the
+current_url is `/posts/123`, then `/posts` is highlighted.
+
+The root url `/` will always match, if no other items match the current _url. If there is no item
+with `/` as url in the menu and no other urls match, nothing will be highlighted.
+
+### Runtime parameters
+
+You can pass runtime parameters when defining a menu. For example, passing the current user and
+change the menu accordingly.
+
+```ruby
+# Define the menu
+Navtastic.define :main_menu do |menu, params|
+  menu.item "Home", "/"
+
+  if params[:current_user]
+    menu.item "Profile", "/users/#{params[:current_user].id}"
+    menu.item "Logout", "/logout"
+  else
+    menu.item "Login", "/login"
+  end
+end
+
+# Render it with the current user as a parameter
+Navtastic.render :main_menu, current_url, current_user: User.current
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require './spec/demo/server'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order rand"
+end
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new
+
+desc "Run the demo server"
+task :demo do
+  DemoServer.new(9090).start
+end
+
+task default: %i[spec rubocop]

data/lib/navtastic.rb

@@ -0,0 +1,61 @@
+require 'navtastic/item'
+require 'navtastic/menu'
+require 'navtastic/renderer'
+require 'navtastic/version'
+
+# Main module containing some convenience methods
+module Navtastic
+  # @private
+  #
+  # @return [Hash<Object,Block>] all stored menus
+  @menu_store = {}
+
+  # Define a new menu to be rendered later
+  #
+  # @example Define a new menu
+  #   Navtastic.define :main do |menu, params|
+  #     menu.item "Home", "/"
+  #   end
+  #
+  # @param name the name of the menu
+  #
+  # @yield [menu, params] block to generate a new menu
+  # @yieldparam menu [Menu] the menu to be initialized
+  # @yieldparam params [Hash] runtime parameters
+  #
+  # @raise [ArgumentError] if no block was given
+  def self.define(name, &block)
+    raise ArgumentError, "no block given" unless block_given?
+
+    name = name.to_sym if name.is_a? String
+    @menu_store[name] = block
+  end
+
+  # Render a stored menu
+  #
+  # @param name the name of the defined menu
+  # @param current_url [String] the url of the current page
+  # @param params [Hash] runtime parameters
+  #
+  # @raise [KeyError] if the menu was not defined
+  #
+  # @return [Renderer] the renderer for the menu
+  def self.render(name, current_url, params = {})
+    name = name.to_sym if name.is_a? String
+    block = @menu_store[name]
+
+    raise KeyError, "menu not defined: #{name.inspect}" if block.nil?
+
+    menu = Menu.new
+    block.call(menu, params)
+    menu.current_url = current_url
+    Renderer.render(menu)
+  end
+
+  # A list of all defined menus
+  #
+  # @return [Array]
+  def self.all_menus
+    @menu_store.keys
+  end
+end

data/lib/navtastic/item.rb

@@ -0,0 +1,49 @@
+module Navtastic
+  # A single menu item
+  class Item
+    # @return [String] the name to be displayed in the menu
+    attr_reader :name
+
+    # @return [String,nil] the url to link to if item is a link, nil otherwise
+    attr_reader :url
+
+    # @return [Menu,nil] the submenu of this item, if defined
+    attr_accessor :submenu
+
+    # Create a new item
+    #
+    # This should not be used directly. Use the {Menu#item} method instead.
+    #
+    # @private
+    #
+    # @param menu [Menu] the menu this items belongs to
+    # @param name [String] the name to display when rendering
+    # @param url [String] the url to link to, if the item is a link
+    def initialize(menu, name, url = nil)
+      @menu = menu
+      @name = name
+      @url = url
+
+      @submenu = nil
+    end
+
+    # Check if this item is the current item in the menu
+    #
+    # @see file:README.md#Current_item documentation on how the current item is
+    #   selected
+    #
+    # @return [Bool] if the item is the current item
+    def current?
+      @menu.current_item == self
+    end
+
+    # @return [Bool] true if the item has a submenu, false other
+    def submenu?
+      !@submenu.nil?
+    end
+
+    def inspect
+      "#<Item \"#{name}\" [#{url}] current?:#{current?}>"
+    end
+  end
+end