nav_lynx 1.0.0 → 1.1.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+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

data/README.md

@@ -1,4 +1,6 @@
-## Behold, the nav_lynx:
+# NavLYNX
+
+[![Code Climate](https://codeclimate.com/github/vigetlabs/nav_lynx.png)](https://codeclimate.com/github/vigetlabs/nav_lynx)
 
 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.
 
@@ -23,3 +25,29 @@ Same usage as `link_to`:
 1. Add this to your Gemfile and then `bundle install`:
   <pre><code>gem 'nav_lynx'</code></pre>
 2. Use `nav_link_to` helper in your views.
+
+## Config option
+
+There is one config option `selected_class`. If you want a different class then "selected" for selected nav items globally you can use this option to change that. You can set this inside your configuration in `config/application.rb` of your Rails application like so:
+
+    module MyApplication
+      class Application < Rails::Application
+        # ...
+        
+        config.nav_lynx.selected_class = 'current'
+      end
+    end
+
+## Contributing to NavLYNX
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Viget. See MIT_LICENSE for further details.

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  require 'appraisal'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end

data/app/helpers/nav_link_helper.rb

@@ -2,22 +2,26 @@ module NavLinkHelper
 
   def nav_link_to(*args, &block)
     title = block_given? ? capture(&block) : args.shift
-    path         = args[0]
+    url_options  = args[0]
     html_options = args[1] || {}
     options      = args[2] || {}
 
-    LinkGenerator.new(request, title, path, html_options, options).to_html
+    LinkGenerator.new(request, title, url_options, controller,html_options, options).to_html
   end
 
   class LinkGenerator
     include ActionView::Helpers::UrlHelper
+    include Rails.application.routes.url_helpers
 
-    def initialize(request, title, path, html_options = {}, options = {})
+    attr_reader :controller
+
+    def initialize(request, title, url_options, controller, html_options = {}, options = {})
       @request      = request
       @title        = title
-      @path         = path
+      @url_options  = url_options
       @html_options = html_options
       @options      = options
+      @controller   = controller
     end
 
     def to_html
@@ -32,28 +36,45 @@ module NavLinkHelper
 
     private
 
+    def link
+      link_to(@title, @url_options, html_options)
+    end
+
+    def html_options
+      selected? ? @html_options.merge(:class => link_classes) : @html_options
+    end
+
+    def selected?
+      paths_match? || segments_match?
+    end
+
+    def paths_match?
+      current_path == link_path
+    end
+
     def current_path
       comparable_path_for(@request.fullpath)
     end
 
     def link_path
-      comparable_path_for(url_for(@path))
+      path = url_for(@url_options)
+      comparable_path_for(path)
     end
 
-    def segment_position
-      if @options[:controller_segment]
-        @options[:controller_segment] - 1
-      elsif @options[:url_segment]
-        @options[:url_segment]
+    def comparable_path_for(path)
+      if @options[:ignore_params]
+        path.gsub(/\?.*/, '')
+      else
+        path
       end
     end
 
-    def path_controller
-      controller_for(@path)
+    def segments_match?
+      path_segment && path_segment == current_segment
     end
 
-    def current_controller
-      controller_for(@request.path)
+    def path_segment
+      segment_for(path_controller, current_path)
     end
 
     def segment_for(controller, path)
@@ -64,28 +85,34 @@ module NavLinkHelper
       end
     end
 
-    def path_segment
-      segment_for(path_controller, current_path)
-    end
-
-    def current_segment
-      segment_for(current_controller, link_path)
+    def path_controller
+      if @url_options.is_a?(Hash) && @url_options[:controller]
+        @url_options[:controller]
+      else
+        controller_for(url_for(@url_options))
+      end
     end
 
-    def paths_match?
-      current_path == link_path
+    def segment_position
+      if @options[:controller_segment]
+        @options[:controller_segment] - 1
+      elsif @options[:url_segment]
+        @options[:url_segment]
+      end
     end
 
-    def segments_match?
-      path_segment && path_segment == current_segment
+    def controller_for(path)
+      Rails.application.routes.recognize_path(path)[:controller]
+    rescue ActionController::RoutingError
+      nil
     end
 
-    def selected?
-      paths_match? || segments_match?
+    def current_segment
+      segment_for(current_controller, link_path)
     end
 
-    def selected_class
-      @options[:selected_class] || 'selected'
+    def current_controller
+      controller_for(@request.path)
     end
 
     def link_classes
@@ -96,12 +123,8 @@ module NavLinkHelper
       end
     end
 
-    def html_options
-      selected? ? @html_options.merge(:class => link_classes) : @html_options
-    end
-
-    def link
-      link_to(@title, @path, html_options)
+    def selected_class
+      @options[:selected_class] || NavLYNX.selected_class
     end
 
     def wrapper_classes
@@ -111,18 +134,6 @@ module NavLinkHelper
         @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_lynx/engine.rb

@@ -1,7 +1,13 @@
 module NavLYNX
   class Engine < ::Rails::Engine
+    config.nav_lynx = ActiveSupport::OrderedOptions.new
+
     config.generators do |g|
       g.test_framework :rspec, :fixture => false
     end
+
+    initializer "redirector.apply_options" do |app|
+      NavLYNX.selected_class = app.config.nav_lynx.selected_class || 'selected'
+    end
   end
 end

data/lib/nav_lynx/version.rb

@@ -1,3 +1,3 @@
 module NavLYNX
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/nav_lynx.rb

@@ -1,4 +1,5 @@
-require "nav_lynx/engine"
-
 module NavLYNX
+  mattr_accessor :selected_class
 end
+
+require "nav_lynx/engine"

data/spec/dummy/config/application.rb

@@ -1,11 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
 # Pick the frameworks you want:
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "active_resource/railtie"
-require "sprockets/railtie"
+require 'rails/all'
 # require "rails/test_unit/railtie"
 
 Bundler.require(*Rails.groups)
@@ -49,12 +45,6 @@ module Dummy
     # like if you have constraints or database-specific column types
     # config.active_record.schema_format = :sql
 
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
     # Enable the asset pipeline
     config.assets.enabled = true
 

data/spec/dummy/config/boot.rb

@@ -1,10 +1,6 @@
 require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../../lib', __FILE__)

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

@@ -22,13 +22,6 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-
   # Do not compress assets
   config.assets.compress = false
 

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

@@ -29,9 +29,8 @@ Dummy::Application.configure do
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  config.eager_load = false
 end

data/spec/dummy/log/development.log

@@ -40,3 +40,142 @@ Connecting to database specified by database.yml
 Connecting to database specified by database.yml
    (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
    (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.6ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (104.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (326.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (205.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (17.4ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (9.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (14.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.8ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (2.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.3ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (11.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.9ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (1.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (7.5ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.9ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (2.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (17.1ms)  SELECT version FROM "schema_migrations"
+   (64.0ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (101.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (138.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.6ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
+Connecting to database specified by database.yml
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.6ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')