smart_navigation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 322510ff431e621ac05e9a7114fc15ad656bd6be
+  data.tar.gz: 4257511a0085900ef8be0f89bb0a7bb105da50b3
+SHA512:
+  metadata.gz: 6fa49d788f5b38b65c19688393888c3b19a991e6eec39048d2bfda5d0382e3c25407cde74aad5b2ba0f7ee5c0d07df37e7de801e17da59711ecbce5f9933e199
+  data.tar.gz: 68a2d5cdf34287d02cbd335c832d42a5fd05ab09a7d18f5be4386b80f79c518ba0347fba8f80588f4910f4f9e3015280563f3c4245d34a2a136d6bacdd861467

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@hardpixel.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_navigation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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,43 @@
+# SmartNavigation
+
+View helpers for navigation menus. Build navigation menus from hash configs.
+
+[![Gem Version](https://badge.fury.io/rb/smart_navigation.svg)](https://badge.fury.io/rb/smart_navigation)
+[![Build Status](https://travis-ci.org/hardpixel/smart-navigation.svg?branch=master)](https://travis-ci.org/hardpixel/smart-navigation)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c484472c3989ff4a7c33/maintainability)](https://codeclimate.com/github/hardpixel/smart-navigation/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_navigation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/smart-navigation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveContent project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hardpixel/smart-navigation/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/lib/smart_navigation/helper.rb

@@ -0,0 +1,11 @@
+module SmartNavigation
+  module Helper
+    # Render navigation builder
+    def smart_navigation_for(items, options={})
+      SmartNavigation::Renderer.new(self, items, options).render
+    end
+
+    # Alias helper method
+    alias :navigation_for :smart_navigation_for
+  end
+end

data/lib/smart_navigation/renderer.rb

@@ -0,0 +1,108 @@
+module SmartNavigation
+  class Renderer
+    # Initialize builder
+    def initialize(view_context, items, options={})
+      @context              = view_context
+      @items                = sort_items items
+      @menu_class           = options.fetch :menu_class,           'menu'
+      @sep_class            = options.fetch :separator_class,      'separator'
+      @group_class          = options.fetch :group_class,          'menu-group'
+      @submenu_class        = options.fetch :submenu_class,        'submenu'
+      @active_class         = options.fetch :active_class,         'active'
+      @active_submenu_class = options.fetch :active_submenu_class, 'open'
+      @submenu_icons        = options.fetch :submenu_icons,        false
+    end
+
+    # Sort items by order
+    def sort_items(items)
+      items.sort_by { |_k, v| v[:order] }.to_h
+    end
+
+    # Get menu item url
+    def item_url(item)
+      params = { controller: item[:controller], action: item[:action] }
+      params[:action] ? url_for(params) : "##{item[:id]}"
+    end
+
+    # Check if current page
+    def current_page?(item)
+      url = item_url(item)
+      @context.current_page?(url)
+    end
+
+    # Check if current group
+    def current_group?(item)
+      current = item[:children].any? { |_k, v| current_page?(v) }
+      current = item[:children].any? { |_k, v| current_group?(v) } if current.blank?
+      current
+    end
+
+    # Create menu separator
+    def separator_tag(item)
+      content_tag :li, item[:label], class: @sep_class
+    end
+
+    # Create item link
+    def item_link_tag(item, icons=false)
+      arrow = content_tag :span, icon('angle-left pull-right'), class: 'pull-right-container'
+      label = content_tag :span, item[:label]
+      label = icon("#{item[:icon]}") + label if icons.present?
+      label = label + arrow if item[:children].present?
+
+      link_to label.html_safe, item_url(item)
+    end
+
+    # Create submenu item
+    def submenu_item_tag(item, active=false)
+      items  = sort_items item[:children]
+      items  = items.map { |_k, v| item_tag(v, @submenu_icons) }.join
+      active = @active_submenu_class if active.present?
+
+      content_tag(:ul, items.html_safe, class: "#{active} #{@submenu_class}")
+    end
+
+    # Create group menu item
+    def group_item_tag(item, icons=false)
+      active  = @active_class if current_group?(item)
+      link    = item_link_tag item, icons
+      submenu = submenu_item_tag item, active
+      content = link + submenu
+
+      content_tag :li, content.html_safe, class: "#{active} #{@group_class}"
+    end
+
+    # Create single menu item
+    def single_item_tag(item, icons=false)
+      active = @active_class if current_page?(item)
+      link   = item_link_tag(item, icons)
+
+      content_tag :li, link.html_safe, class: "#{active}"
+    end
+
+    # Create menu list item
+    def item_tag(item, icons=false)
+      if item[:separator].present?
+        separator_tag(item)
+      elsif item[:children].present?
+        group_item_tag(item, icons)
+      else
+        single_item_tag(item, icons)
+      end
+    end
+
+    # Create menu list
+    def menu_tag(items)
+      content_tag :ul, items.html_safe, class: @menu_class
+    end
+
+    # Render menu
+    def render
+      menu_tag @items.map { |k, v| item_tag(v, true) }.join
+    end
+
+    # Get app helpers if method is missing
+    def method_missing(method, *args, &block)
+      @context.respond_to?(method) ? @context.send(method, *args, &block) : super
+    end
+  end
+end

data/lib/smart_navigation/version.rb

@@ -0,0 +1,3 @@
+module SmartNavigation
+  VERSION = '0.1.0'
+end

data/lib/smart_navigation.rb

@@ -0,0 +1,15 @@
+require 'active_support'
+require 'smart_navigation/version'
+
+module SmartNavigation
+  extend ActiveSupport::Autoload
+
+  # Autoload modules
+  autoload :Renderer
+  autoload :Helper
+end
+
+# Include action view helpers
+if defined? ActionView::Base
+  ActionView::Base.send :include, SmartNavigation::Helper
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: smart_navigation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: View helpers for navigation menus. Build navigation menus from hash configs.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_navigation.rb
+- lib/smart_navigation/helper.rb
+- lib/smart_navigation/renderer.rb
+- lib/smart_navigation/version.rb
+homepage: https://github.com/hardpixel/smart-navigation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: View helpers for navigation menus
+test_files: []