nav_links 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17e44c0c934f2ca8ef5c953f752521f6b86312df
+  data.tar.gz: af182e5ef54744896589ab463b2887c922fe56bf
+SHA512:
+  metadata.gz: 7698f9298ae48e69264e2ab8d3209f73524438f2bb753418831c445a8ffa70d33db41719909536c65cc378f1fe48578cca7b5912294ec1b10b8d17f756457619
+  data.tar.gz: 0714d40a2ee19402c56285e8e64408b4b8df64d0cc5468d14fc32793cd36b201543a6434ff33be6e5c5e83d847c385728fe8ad7c07332514c0853c439366aa3c

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+(MIT License)
+
+Modifications Copyright (c) 2013 Bernhard Häussner (Sophisticates)
+Copyright 2013 Dan Tello (Viget)
+
+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,67 @@
+# Behold, the NavLinks:
+
+[![Build Status](https://travis-ci.org/bxt/wptemplates.png?branch=master)](https://travis-ci.org/bxt/wptemplates)
+
+Gem. Rails. Nav links. The nav_link_to helper works just like the standard Rails link_to helper, but adds a 'selected' class to your link (or its wrapper) if certain criteria are met. By default, if the link's destination url is the same url as the url of the current page, a default class of 'selected' is added to the link. Just replace `link_to` with `nav_link_to` in your templates. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nav_links'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The `nav_link_to` helper is used just like the good old `link_to` rails helper:
+
+    <%= nav_link_to 'My Page', my_path %>
+
+When `my_path` is the same as the current page url, this outputs:
+
+    <a class="selected" href="http://example.com/page">My Page</a>
+
+For more options and full usage details, see: http://viget.com/extend/rails-selected-nav-link-helper
+
+### Usage with blocks:
+
+Same usage as `link_to`:
+
+    <%= nav_link_to 'http://example.com/page' do %>
+      <strong>My Page</strong>
+    <% end %>
+
+### Group links with same options
+
+You can reduce duplication and wrap `nav_link_to` calls with the same options with a call to `nav_links` like this: 
+
+    <ul class="nav">
+      <% nav_links url_segment: 1, wrapper: 'li', selected_class:'active' do |n| %>
+        <%= n.nav_link_to "Projects", projects_path %>
+        <%= n.nav_link_to "People", people_path %>
+        <%= n.nav_link_to "About", about_path %>
+      <% end %>
+    </ul>
+
+## Rainy day?
+
+Here's what you can do on a rainy day:
+
+  - Write integration tests
+  - Extend docs
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+This gem is mostly based on the gem [nav_lynx](https://github.com/vigetlabs/nav_lynx) and sponsored by [Sophisticates GmbH](http://sophisticates.de/)
+

data/Rakefile

@@ -0,0 +1,3 @@
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :default => :spec

data/lib/nav_links/link_generator.rb

@@ -0,0 +1,117 @@
+module NavLinks
+  class LinkGenerator
+    include ActionView::Helpers::UrlHelper
+
+    def initialize(request, title, path, html_options = {}, options = {})
+      @request      = request
+      @title        = title
+      @path         = path
+      @html_options = html_options
+      @options      = options
+    end
+
+    def to_html
+      html = link
+
+      if @options[:wrapper]
+        html = content_tag(@options[:wrapper], html, :class => wrapper_classes)
+      end
+
+      html.html_safe
+    end
+
+    private
+
+    def current_path
+      comparable_path_for(@request.fullpath)
+    end
+
+    def link_path
+      comparable_path_for(url_for(@path))
+    end
+
+    def segment_position
+      if @options[:controller_segment]
+        @options[:controller_segment] - 1
+      elsif @options[:url_segment]
+        @options[:url_segment]
+      end
+    end
+
+    def path_controller
+      controller_for(@path)
+    end
+
+    def current_controller
+      controller_for(@request.path)
+    end
+
+    def segment_for(controller, path)
+      if @options[:controller_segment]
+        controller.split('/')[segment_position]
+      elsif @options[:url_segment]
+        path.split('/')[segment_position]
+      end
+    end
+
+    def path_segment
+      segment_for(path_controller, current_path)
+    end
+
+    def current_segment
+      segment_for(current_controller, link_path)
+    end
+
+    def paths_match?
+      current_path == link_path
+    end
+
+    def segments_match?
+      path_segment && path_segment == current_segment
+    end
+
+    def selected?
+      paths_match? || segments_match?
+    end
+
+    def selected_class
+      @options[:selected_class] || 'selected'
+    end
+
+    def link_classes
+      if @html_options[:class]
+        @html_options[:class] + " #{selected_class}"
+      elsif !@options[:wrapper]
+        selected_class
+      end
+    end
+
+    def html_options
+      selected? ? @html_options.merge(:class => link_classes) : @html_options
+    end
+
+    def link
+      link_to(@title, @path, html_options)
+    end
+
+    def wrapper_classes
+      if selected?
+        "#{selected_class} #{@options[:wrapper_class]}"
+      else
+        @options[:wrapper_class]
+      end
+    end
+
+    def controller_for(path)
+      Rails.application.routes.recognize_path(path)[:controller]
+    end
+
+    def comparable_path_for(path)
+      if @options[:ignore_params]
+        path.gsub(/\?.*/, '')
+      else
+        path
+      end
+    end
+  end
+end

data/lib/nav_links/version.rb

@@ -0,0 +1,3 @@
+module NavLinks
+  VERSION = "1.0.0"
+end

data/lib/nav_links/view_helpers.rb

@@ -0,0 +1,35 @@
+module NavLinks
+  module ViewHelpers
+    def nav_link_to(*args, &block)
+      title = block_given? ? capture(&block) : args.shift
+      path         = args[0]
+      html_options = args[1] || {}
+      options      = args[2] || {}
+
+      LinkGenerator.new(request, title, path, html_options, options).to_html
+    end
+
+    def nav_links(options = {})
+      raise ArgumentError, "Missing block" unless block_given?
+      option_wrapper = NavLinksOptions.new(self, options)
+      yield option_wrapper
+    end
+
+    class NavLinksOptions
+      def initialize(base, options = {})
+        @base = base
+        @options = options
+      end
+
+      def nav_link_to(*args, &block)
+        index = block_given? ? 2 : 3
+        args[index] = @options.merge(args[index] || {})
+
+        @base.nav_link_to(*args, &block)
+      end
+
+    end
+  end
+end
+
+ActionView::Base.send :include, NavLinks::ViewHelpers

data/lib/nav_links.rb

@@ -0,0 +1,6 @@
+require "nav_links/version"
+require "nav_links/link_generator"
+require 'nav_links/view_helpers' if defined?(Rails)
+
+module NavLinks
+end

data/nav_links.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nav_links/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nav_links"
+  spec.version       = NavLinks::VERSION
+  spec.authors       = ["Bernhard H\xC3\xA4ussner", "Dan Tello", "Patrick Reagan", "Brian Landau"]
+  spec.email         = ["bxt@die-optimisten.net", "dan.tello@viget.com", "patrick.reagan@viget.com", "brian.landau@viget.com"]
+  spec.description   = %q{Rails helper to generate navigation links with a selected class.}
+  spec.summary       = %q{Rails helper to generate navigation links with a selected class.}
+  spec.homepage      = "https://github.com/bxt/nav_links"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", ">= 3.2.13", "< 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails", '~> 2.0'
+end

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/dashboard_controller.rb

@@ -0,0 +1,3 @@
+class DashboardController < ApplicationController
+  def show; end
+end

data/spec/dummy/app/controllers/projects_controller.rb

@@ -0,0 +1,2 @@
+class ProjectsController < ApplicationController
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/dashboard/show.html.erb

@@ -0,0 +1 @@
+<%= nav_link_to 'My Title', '/projects' %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "nav_links"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,27 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end