helmsman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17ffb3e2f06409546207afd53827fa0cb5e58dc8
+  data.tar.gz: 70366137bfc394958f7cdfefa7c2ab6ee2af2fec
+SHA512:
+  metadata.gz: 659c202d87b8e499766eb522c8aa48c2ba9b34ea6cad192c10b620904cf3a25be422c3113574fd4e1ac7626d71f8265616ccd2726390753fbe9e81f8bcdb7f2f
+  data.tar.gz: 15fa8c66a2d2d7a99cf1ffa86c42338f5b9019dcaae91886bae62e8a70ba9ff76ec0abcc8efb5775872e3cc9f5807906ea67dbde2e5910f4ccc81b7b35fe0597

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+helmsman

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+script: "bundle exec rspec"
+
+notifications:
+  disabled: false
+  recipients:
+    - xijo@gmx.de

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,140 @@
+# Helmsman
+
+[![Build Status](https://secure.travis-ci.org/xijo/helmsman.png?branch=master)](https://travis-ci.org/xijo/helmsman) [![Gem Version](https://badge.fury.io/rb/helmsman.png)](http://badge.fury.io/rb/helmsman)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'helmsman'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Helmsman adds the `helm` helper to your rails application views. Here is how you use it:
+
+```ruby
+helm :pictures, url: 'http://defiant.ncc/pictures'
+```
+
+The above call will produce the following html output
+
+```html
+<li>
+  <a href='http://defiant.ncc/pictures'>Pictures</a>
+</li>
+```
+
+### Building the link
+
+There are multiple ways to build the link:
+
+1. provide the url parameter. The link will then be build by using the translation and that url.
+
+```ruby
+helm :pictures, url: 'http://randompictures.com'
+```
+
+2. set helm values in a block.
+
+```ruby
+helm :pictures do |entry|
+  entry.name = 'Some pictures'
+  entry.url  = 'http://randompictures.com'
+end
+```
+
+3. build everything manually
+
+```ruby
+helm :pictures do |_|
+  link_to 'Some pictures', 'http://randompictures.com'
+end
+```
+
+### Translation lookup
+
+The first parameter will be used to lookup the translations.
+
+e.g. `helm :edit` called from `app/views/pictures/_menu.html.*` uses the following translations
+
+- en.pictures.menu.edit
+- en.pictures.menu.edit_disabled
+
+### Highlight current
+
+Helmsman will highlight the current entry by using the controller and action name.
+
+Per default the first parameter will be treated as the controller name: `helm :pictures, url: pictures_url` highlights on every controller action of the pictures_controller.
+
+You may customize the highlight options by providing a set of controller and/or action names. Here are some examples:
+
+```ruby
+helm :bridge, controllers: :screens                           # on any screens controller action
+helm :bridge, controllers: [:screens, :sensors]               # on any screens and sensors controller action
+helm :bridge, actions: :show                                  # on bridges controller show action
+helm :bridge, controllers: :screens, actions: [:show, :index] # only on screens controller #show and #index
+```
+
+Anyway you are not forced to use that mechanism, you can also set `current` by hand:
+
+```ruby
+helm :bridge, current: true
+```
+
+### Disabling and visibility
+
+To set a helm disabled you may use the `disabled` option. It will then add a tooltip to that entry to explain why it was disabled.
+
+```ruby
+admin_sidebar_entry :pictures, url: pictures_url, disabled: user_signed_in?
+```
+
+If you want it to not be visible at all set the `visible` option to false.
+
+```ruby
+admin_sidebar_entry :pictures, url: pictures_url, visible: user_signed_in?
+```
+
+### Additional content and nesting
+
+As mentioned above you may additional content and nest helms into each other by using its yield feature. Here is a SLIM example:
+
+```slim
+- helm :pictures, url: 'http://allpictures.com' do
+  ul
+    = helm :architecture
+    = helm :nature
+```
+
+You can always use the current helm during that yield, so finding out whether it is disabled, current or anything is trivial:
+
+
+```ruby
+admin_sidebar_entry :pictures, disabled: true, current: false do |entry|
+  puts entry.enabled?   # false
+  puts entry.disabled?  # true
+  puts entry.visible?   # true
+  puts entry.current?   # false
+end
+```
+
+## Compatibility
+
+Helmsman is working for rails 3 & 4 and for any ruby >= 1.9.3
+
+## 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
+
+## TODO
+
+1. configure helper name
+2. configure current/disabled class

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/helmsman.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'helmsman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "helmsman"
+  spec.version       = Helmsman::VERSION
+  spec.authors       = ["Johannes Opper"]
+  spec.email         = ["johannes.opper@gmail.com"]
+  spec.description   = %q{Steers your navigation through the ocean of your application}
+  spec.summary       = %q{Steers your navigation through the ocean of your application}
+  spec.homepage      = "http://github.com/xijo/helmsman"
+  spec.license       = "WTFPL"
+
+  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_dependency 'actionpack'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/helmsman/helm.rb

@@ -0,0 +1,64 @@
+module Helmsman
+  class Helm
+    attr_accessor :name, :url, :additional, :i18n_key
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+
+    def initialize(options = {})
+      @disabled = options.fetch(:disabled)
+      @visible  = options.fetch(:visible)
+      @current  = options.fetch(:current)
+      @i18n_key = options.fetch(:i18n_key)
+      @url      = options[:url]
+    end
+
+    def to_s
+      visible? ? content_tag(:li, li_content, li_options) : ''.html_safe
+    end
+
+    def html_safe?
+      true
+    end
+
+    def to_str
+      to_s
+    end
+
+    def li_content
+      link = link_to_if(enabled?, name, url) if url
+      disabled? ? link : "#{link}#{additional}".html_safe
+    end
+
+    def li_options
+      if enabled?
+        { class: ('current-menu-item' if current?) }
+      else
+        { rel: 'tooltip', title: disabled_title, class: 'disabled-menu-item', data: { placement: 'bottom' } }
+      end
+    end
+
+    def name
+      I18n.translate(i18n_key)
+    end
+
+    def disabled_title
+      I18n.translate("#{i18n_key}_disabled")
+    end
+
+    def disabled?
+      @disabled
+    end
+
+    def visible?
+      @visible
+    end
+
+    def enabled?
+      !@disabled
+    end
+
+    def current?
+      @current
+    end
+  end
+end

data/lib/helmsman/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module Helmsman
+  class Railtie < ::Rails::Railtie
+    initializer 'helmsman.view_helper' do
+      ActionView::Base.send :include, Helmsman::ViewHelper
+    end
+  end
+end

data/lib/helmsman/version.rb

@@ -0,0 +1,3 @@
+module Helmsman
+  VERSION = "0.0.1"
+end

data/lib/helmsman/view_helper.rb

@@ -0,0 +1,36 @@
+module Helmsman
+  module ViewHelper
+    # Returns true if one of the given controllers match the actual one.
+    # If actions are set they are taken into account.
+    def current_state_by_controller(*given_controller_names, actions: [])
+      if given_controller_names.any? { |name| name == controller_name.to_sym }
+        if actions.present?
+          Array(actions).include?(action_name.to_sym)
+        else
+          true
+        end
+      end
+    end
+
+    # Private part of actionpack/lib/action_view/helpers/translation_helper.rb
+    # Wrapped for clarification what that does.
+    def expand_i18n_key(key)
+      scope_key_by_partial(key)
+    end
+
+    def helm(key, options = {}, &block)
+      actions     = options.fetch(:actions)     { [] }
+      controllers = options.fetch(:controllers) { [key] }
+      disabled    = options.fetch(:disabled)    { false }
+      current     = options.fetch(:current)     { current_state_by_controller(*controllers, actions: actions) }
+      visible     = options.fetch(:visible)     { true }
+      url         = options[:url]
+      i18n_key    = expand_i18n_key(".#{key}")
+
+      entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: i18n_key, url: url)
+
+      entry.additional = capture(entry, &block) if block_given?
+      entry
+    end
+  end
+end

data/lib/helmsman.rb

@@ -0,0 +1,11 @@
+require 'i18n'
+require 'active_support'
+require 'action_view'
+
+require 'helmsman/version'
+require 'helmsman/helm'
+require 'helmsman/view_helper'
+require 'helmsman/railtie' if defined?(Rails)
+
+module Helmsman
+end

data/spec/lib/helmsman/view_helper_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+class FakeHelper
+  include Helmsman::ViewHelper
+  include ActionView::Context
+  include ActionView::Helpers::CaptureHelper
+  include ActionView::Helpers::TranslationHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::UrlHelper
+
+  def controller_name
+    'pictures'
+  end
+
+  def action_name
+    'index'
+  end
+
+  def scope_key_by_partial(_)
+    'i18n_path'
+  end
+end
+
+describe Helmsman::ViewHelper do
+  let(:helper) { FakeHelper.new }
+
+  describe '#helm' do
+    it 'highlights per class name on a given controller name' do
+      result = helper.helm(:pictures)
+      result.should be_current
+    end
+
+    it 'is possible to override the current state' do
+      result = helper.helm(:not_pictures, current: true)
+      result.should be_current
+    end
+
+    it 'highlights by action name as well' do
+      result = helper.helm(:pictures, actions: :show)
+      result.should_not be_current
+      result = helper.helm(:pictures, actions: :index)
+      result.should be_current
+    end
+
+    it 'passing disabled option disables the link' do
+      result = helper.helm(:pictures, disabled: true)
+      result.to_s.should_not include '<a href'
+      result.to_s.should include 'disabled-menu-item'
+    end
+
+    it 'adds block results to the result' do
+      result = helper.helm(:pictures) { |entry| 'jambalaia' }
+      result.to_s.should include 'jambalaia'
+    end
+
+    it 'generates a link if it got a url' do
+      result = helper.helm(:pictures, url: 'hellofoo.com')
+      result.to_s.should include '<a href="hellofoo.com">'
+    end
+
+    it 'generates html_safe output' do
+      result = helper.helm(:pictures)
+      result.to_s.should be_html_safe
+    end
+
+    it 'setting visible to false will output nothing' do
+      result = helper.helm(:pictures, url: 'http://defiant.ncc/pictures', visible: false)
+      result.to_s.should eq ''
+    end
+
+    describe 'yield the entry' do
+      it 'knows if its the current' do
+        helper.helm(:foo, current: true) { |e| e.should be_current }
+      end
+
+      it 'knows if it is disabled' do
+        helper.helm(:foo, disabled: true) do |entry|
+          entry.should be_disabled
+          entry.should_not be_enabled
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+
+SimpleCov.adapters.define 'gem' do
+  add_filter '/spec/'
+  add_group 'Libraries', '/lib/'
+end
+SimpleCov.start 'gem'
+
+require 'helmsman'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: helmsman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Johannes Opper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: simplecov
+  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: Steers your navigation through the ocean of your application
+email:
+- johannes.opper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- helmsman.gemspec
+- lib/helmsman.rb
+- lib/helmsman/helm.rb
+- lib/helmsman/railtie.rb
+- lib/helmsman/version.rb
+- lib/helmsman/view_helper.rb
+- spec/lib/helmsman/view_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/xijo/helmsman
+licenses:
+- WTFPL
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Steers your navigation through the ocean of your application
+test_files:
+- spec/lib/helmsman/view_helper_spec.rb
+- spec/spec_helper.rb