rails_navigation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aae613c2e8f7248f1dafd41a9b6f18785b3ace6b
+  data.tar.gz: b6a32d1b639ec4145de44cd67c55a1af829a16a5
+SHA512:
+  metadata.gz: f80224ce1656d606479c1d6ff61606b8148a4aad4b783981172b1825c704c74b1cb32f53153b3d8b0e13713e17d413631ad2b038323d9f619af3f7993b228e44
+  data.tar.gz: 3938909fcae239fce32fb82bc1d0f6903995544d92870c3edb0a0fe935951ec9ca25cf26e45779a483aeccfbf679d0b98fbfb67d12e755e1cebc31f827a8f9fd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sascha Brink
+
+MIT License
+
+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,55 @@
+# rails_navigation
+
+Simplify matching of Rails routes. Did you ever hate the link_to_if helper? E.g.:
+
+    <%= 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
+
+Matching controllers:
+
+    { controller: "pages", action: "new" } becomes 'pages'  
+
+Matching controllers and actions:
+
+    { controller: "pages", action: "new" } becomes 'pages#new'  
+
+Matching controllers, actions and params:
+
+    { controller: "pages", action: "show", params: { id: 'homepage' } } becomes 'pages#new?id=homepage'
+        
+Or even simpler (id is the default):
+        
+    { controller: "pages", action: "show", params: { id: 'homepage' } } becomes 'pages#new?homepage'  
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_navigation'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## TODO
+
+* Match multiple conditions
+
+## Contributing
+
+1. Fork it ( https://github.com/sbrink/rails_navigation/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec

data/app/helpers/rails_navigation_helper.rb

@@ -0,0 +1,5 @@
+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))
+  end
+end

data/lib/rails_navigation.rb

@@ -0,0 +1,4 @@
+require 'rails_navigation/railtie' if defined?(Rails)
+require 'rails_navigation/version'
+require 'rails_navigation/matcher'
+

data/lib/rails_navigation/matcher.rb

@@ -0,0 +1,33 @@
+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)
+      result = Array(str.match(/^([a-z_\-]+)/))[1]
+      result ? (result == @controller_name) : true
+    end
+
+    def check_action(str)
+      result = Array(str.match(/#([a-z_\-]+)/))[1]
+      result ? (result == @action_name) : true
+    end
+
+    def check_parameters(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]
+      else
+        true
+      end
+    end
+
+    def active?(str)
+      check_controller(str) && check_action(str) && check_parameters(str)
+    end
+  end
+end

data/lib/rails_navigation/railtie.rb

@@ -0,0 +1,4 @@
+module RailsNavigation
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_navigation/version.rb

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

data/rails_navigation.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_navigation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_navigation'
+  spec.version       = RailsNavigation::VERSION
+  spec.authors       = ['Sascha Brink', 'Martin Schurig']
+  spec.email         = ['sascha.brink@gmail.com', 'martin@schurig.pw']
+  spec.summary       = %q{Simplified navigation helper for Rails.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/sbrink/rails_navigation'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+end

data/spec/rails_navigation_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe RailsNavigation::Matcher do
+
+  describe 'with a controller' 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
+    end
+  end
+
+  describe 'with a controller and action' 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
+    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
+    end
+  end
+
+  describe 'with controller, action and a single parameter' 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
+    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
+    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
+    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
+    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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'rails_navigation'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: rails_navigation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sascha Brink
+- Martin Schurig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simplified navigation helper for Rails.
+email:
+- sascha.brink@gmail.com
+- martin@schurig.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/rails_navigation_helper.rb
+- lib/rails_navigation.rb
+- lib/rails_navigation/matcher.rb
+- lib/rails_navigation/railtie.rb
+- lib/rails_navigation/version.rb
+- rails_navigation.gemspec
+- spec/rails_navigation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sbrink/rails_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.2.2
+signing_key: 
+specification_version: 4
+summary: Simplified navigation helper for Rails.
+test_files:
+- spec/rails_navigation_spec.rb
+- spec/spec_helper.rb