rails_navigation 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aae613c2e8f7248f1dafd41a9b6f18785b3ace6b
-  data.tar.gz: b6a32d1b639ec4145de44cd67c55a1af829a16a5
+  metadata.gz: f58a4745dfc48238bd43a08be6e3b12f959ca556
+  data.tar.gz: d9b27e8707cc331fcce6f61fea6e62f819f50260
 SHA512:
-  metadata.gz: f80224ce1656d606479c1d6ff61606b8148a4aad4b783981172b1825c704c74b1cb32f53153b3d8b0e13713e17d413631ad2b038323d9f619af3f7993b228e44
-  data.tar.gz: 3938909fcae239fce32fb82bc1d0f6903995544d92870c3edb0a0fe935951ec9ca25cf26e45779a483aeccfbf679d0b98fbfb67d12e755e1cebc31f827a8f9fd
+  metadata.gz: 1c104d54fd50cb0e4b11814dea82aec78b174af7a61a35c307f953eedd858b032cebd9426c292cac11e4a77d73691adfa63ab1c2c9201cad376ae598bddc7465
+  data.tar.gz: b542b987886d6c619025b4b24578fd82807eb4075a49567ba656fe862d512fae9ac83b74c7454a925c32715ad245eadb485e368e607e339bbd4bed8cf644cd19

data/README.md

@@ -1,16 +1,63 @@
 # rails_navigation
 
-Simplify matching of Rails routes. Did you ever hate the link_to_if helper? E.g.:
+Simplify matching of Rails routes. You are unhappy with the [`link_to_if`](http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to_if)
+ helper?
+
+**Then check out this gem!** You can now match controllers and actions as they are defined in your routes.rb.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_navigation'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### matches_page?
+
+Works like current_page? Example:
+
+```ruby
+matches_page?('controller#action')
+```
+
+with multiple conditions:
+
+```ruby
+matches_page?(['controller#action', 'other_controller#action'])
+```
+
+### nav_to
+
+Uses `matches_page?` and creates a link and a li element
+
+*Source code, if you want to customize it:*
+
+```ruby
+def nav_to(name, path, conditions = nil)
+ content_tag :li, link_to(name, path), class: ('active' if matches_page?(conditions))
+end
+```
 
-    <%= link_to_if(@current_user.nil?, "Login", { controller: "sessions", action: "new" }) %>
-  
-Then try this gem! You can now match controllers and actions like defined in the routes.rb.
 
 ## Examples
 
+You have a webseite full of books and want to show an edit button on the books#show page.
+```ruby
+matches_page?('books#show')
+```
+
+## It's like your routes.rb
+
 Matching controllers:
 
-    { controller: "pages", action: "new" } becomes 'pages'  
+    { controller: "pages" } becomes 'pages'  
 
 Matching controllers and actions:
 
@@ -23,28 +70,18 @@ Matching controllers, actions and params:
 Or even simpler (id is the default):
         
     { controller: "pages", action: "show", params: { id: 'homepage' } } becomes 'pages#new?homepage'  
+    
+## What it does:
 
+**rails_navigation** adds 2 helpers
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rails_navigation'
-```
-
-And then execute:
-
-    $ bundle
-
-## Usage
-
-TODO: Write usage instructions here
+* matches_page?(conditions)
+* nav_to(name, path, conditions)
 
 
 ## TODO
 
-* Match multiple conditions
+* support `not` operator
 
 ## Contributing
 

data/app/helpers/rails_navigation_helper.rb

@@ -1,5 +1,9 @@
 module RailsNavigationHelper
-  def nav_to(name, path, controller_names = nil)
-    content_tag :li, link_to(name, path), class: ('active' if RailsNavigation::Matcher.new(controller_name, action_name, params).active?(controller_names))
+  def matches_page?(conditions)
+    RailsNavigation::Matcher.match_multiple_with_or?(controller_name, action_name, params, conditions)
+  end
+
+  def nav_to(name, path, conditions = nil)
+    content_tag :li, link_to(name, path), class: ('active' if matches_page?(conditions))
   end
 end

data/lib/rails_navigation/matcher.rb

@@ -1,33 +1,31 @@
 module RailsNavigation
-  class Matcher
-    def initialize(controller_name, action_name, params)
-      @controller_name = controller_name
-      @action_name = action_name
-      @params = params
-    end
-
-    def check_controller(str)
+  module Matcher
+    def self.check_controller(controller_name, str)
       result = Array(str.match(/^([a-z_\-]+)/))[1]
-      result ? (result == @controller_name) : true
+      result ? (result == controller_name) : true
     end
 
-    def check_action(str)
+    def self.check_action(action_name, str)
       result = Array(str.match(/#([a-z_\-]+)/))[1]
-      result ? (result == @action_name) : true
+      result ? (result == action_name) : true
     end
 
-    def check_parameters(str)
+    def self.check_parameters(params, str)
       result = Array(str.match(/\?([!a-z0-9&_\-=]+)/))[1]
       if result
         key, value = result.split('=')
-        result.include?('=') ? value == @params[key.to_sym] : result == @params[:id]
+        result.include?('=') ? value == params[key.to_sym] : result == params[:id]
       else
         true
       end
     end
 
-    def active?(str)
-      check_controller(str) && check_action(str) && check_parameters(str)
+    def self.match_single?(controller_name, action_name, params, str)
+      check_controller(controller_name, str) && check_action(action_name, str) && check_parameters(params, str)
+    end
+
+    def self.match_multiple_with_or?(controller_name, action_name, params, arr)
+      [*arr].any? { |str| match_single?(controller_name, action_name, params, str) }
     end
   end
 end

data/lib/rails_navigation/version.rb

@@ -1,3 +1,3 @@
 module RailsNavigation
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/rails_navigation_spec.rb

@@ -6,8 +6,8 @@ describe RailsNavigation::Matcher do
     it 'matches a controller' do
       condition = 'pages'
       controller_name, action_name, params = 'pages', 'edit', {}
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_truthy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_truthy
     end
   end
 
@@ -15,15 +15,15 @@ describe RailsNavigation::Matcher do
     it 'matches a controller with action' do
       condition = 'pages#edit'
       controller_name, action_name, params = 'pages', 'edit', {}
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_truthy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_truthy
     end
 
     it 'does not match a controller with a wrong action' do
       condition = 'pages#show'
       controller_name, action_name, params = 'pages', 'edit', {}
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_falsey
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_falsey
     end
   end
 
@@ -31,38 +31,44 @@ describe RailsNavigation::Matcher do
     it 'matches a controller, action and param id as default' do
       condition = 'pages#edit?about'
       controller_name, action_name, params = 'pages', 'edit', { id: 'about' }
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_truthy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_truthy
     end
 
     it 'does not match a controller, action and param id as default' do
       condition = 'pages#edit?about'
       controller_name, action_name, params = 'pages', 'edit', { id: 'imprint' }
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_falsy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_falsy
     end
 
     it 'matches a controller, action and param' do
       condition = 'pages#edit?from=homepage'
       controller_name, action_name, params = 'pages', 'edit', { from: 'homepage' }
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_truthy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_truthy
     end
 
     it 'does not match a wrong controller, action and param' do
       condition = 'pages#edit?from=start'
       controller_name, action_name, params = 'pages', 'edit', { from: 'homepage' }
-      matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-      expect(matcher.active?(condition)).to be_falsy
+      result = RailsNavigation::Matcher.match_single?(controller_name, action_name, params, condition)
+      expect(result).to be_falsy
     end
   end
 
   describe 'with array of conditions' do
-    # it 'matches one of multiple conditions' do
-    #   conditions = ['pages#edit', 'recipes#show']
-    #   controller_name, action_name, params = 'pages', 'edit', { }
-    #   matcher = RailsNavigation::Matcher.new(controller_name, action_name, params)
-    #   expect(matcher.active?(conditions)).to be_truthy
-    # end
+    it 'matches one of multiple conditions' do
+      conditions = ['pages#edit', 'recipes#show']
+      controller_name, action_name, params = 'pages', 'edit', { }
+      result = RailsNavigation::Matcher.match_multiple_with_or?(controller_name, action_name, params, conditions)
+      expect(result).to be_truthy
+      controller_name, action_name, params = 'recipes', 'show', { }
+      result = RailsNavigation::Matcher.match_multiple_with_or?(controller_name, action_name, params, conditions)
+      expect(result).to be_truthy
+      controller_name, action_name, params = 'books', 'index', { }
+      result = RailsNavigation::Matcher.match_multiple_with_or?(controller_name, action_name, params, conditions)
+      expect(result).to be_falsey
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_navigation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sascha Brink