helmsman 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c4b143c57977a78c91d041062e78e1630382b07
-  data.tar.gz: cd64f69c0b678199ca4aa8cbf68d1582a4ebd98b
+  metadata.gz: 22ea9eb486378b8fdd42100f7a4a0394846eb9c1
+  data.tar.gz: 95755650dd2099182189afdd695932049f3b2ef9
 SHA512:
-  metadata.gz: 762a534747d8cb1e80f412ead8ca1a5d85a5e9fca44a1690aa1019d1cb125d09cf70e8bec9c4d2d28fb9887b59f0cd63f9fe2cefd485058e7ecdda229f39a08f
-  data.tar.gz: bdf16c685f4510105d6c24cabde76514941db4dfb6ea850b6dcb5af29bba28864cd00b4e649d96b7b5c9d941106526e172bd7f704839dc14ac0b2ece2cc9877d
+  metadata.gz: dc2261720f3961c2b79c19de1de6d7f2d22df3e6d8f5a929937bd26929223aff0d3e796c7a3e0eb8069c3cf4846545c14a897f75dac781f7112c0c3dc60442c9
+  data.tar.gz: 9b9ae038b5bfbc3489fcdba587f5b66c7363828a0b5f897c7e09c83b0aea144538e88b32958e3562b50330ba87e6c70130760497aa30c943049e990b851bac7e

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
-  - 2.0.0
-
-script: "bundle exec rspec"
+  - 2.0
+  - 2.1
+  - 2.2
 
 notifications:
   disabled: false

data/Rakefile

@@ -1 +1,17 @@
 require "bundler/gem_tasks"
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'helmsman'
+  ARGV.clear
+  IRB.start
+end
+
+begin
+    require 'rspec/core/rake_task'
+      RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/helmsman.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'actionpack'
+  spec.add_dependency 'rails'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/helmsman/helm.rb

@@ -7,9 +7,10 @@ module Helmsman
     include ActionView::Helpers::UrlHelper
 
     def initialize(options = {})
-      @disabled   = options.fetch(:disabled)   { false }
-      @visible    = options.fetch(:visible)    { true }
-      @current    = options.fetch(:current)    { false }
+      @disabled   = options.fetch(:disabled) { false }
+      @visible    = options.fetch(:visible)  { true }
+      @current    = options.fetch(:current)  { false }
+      @li_class   = options[:li_class] || []
       @i18n_scope = options.fetch(:i18n_scope)
       @i18n_key   = options.fetch(:i18n_key)
       @url        = options[:url]
@@ -32,11 +33,36 @@ module Helmsman
       disabled? ? link : "#{link}#{additional}".html_safe
     end
 
+    def configure_li_class
+      if @li_class.respond_to?(:to_ary)
+        @li_class.to_ary
+      else
+        @li_class.to_s.split(/\s+/)
+      end.tap do |li_class|
+        yield li_class
+      end.select(&:present?).uniq.sort * ' '
+    end
+
     def li_options
       if enabled?
-        { class: (Helmsman.current_css_class if current?) }
+        li_class = configure_li_class do |li_class|
+          if current?
+            li_class << Helmsman.current_css_class
+          end
+        end
+        {
+          class: li_class
+        }
       else
-        { rel: 'tooltip', title: disabled_title, class: Helmsman.disabled_css_class, data: { placement: 'bottom' } }
+        li_class = configure_li_class do |li_class|
+          li_class << Helmsman.disabled_css_class
+        end
+        {
+          rel:   'tooltip',
+          title: disabled_title,
+          class: li_class,
+          data:  { placement: 'bottom' }
+        }
       end
     end
 

data/lib/helmsman/version.rb

@@ -1,3 +1,3 @@
 module Helmsman
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/helmsman/view_helper.rb

@@ -30,7 +30,9 @@ module Helmsman
             Array(condition.last).any? { |given| given.to_s == action_name }
           end
         else
-          raise TypeError, "invalid format for highlight options, expected Symbol, Array or Hash got #{conditions.class.name}"
+          raise TypeError,
+            "invalid format for highlight options, "\
+            "expected Symbol, Array or Hash got #{conditions.class.name}"
         end
       end
     end
@@ -52,15 +54,25 @@ module Helmsman
     end
 
     def helm(key, options = {}, &block)
-      actions        = options.fetch(:actions)     { [] }
-      highlight_opts = options.fetch(:highlight)   { key }
-      disabled       = options.fetch(:disabled)    { false }
-      current        = options.fetch(:current)     { highlight_helm?(highlight_opts) }
-      visible        = options.fetch(:visible)     { true }
+      actions        = options.fetch(:actions)   { [] }
+      highlight_opts = options.fetch(:highlight) { key }
+      disabled       = options.fetch(:disabled)  { false }
+      current        = options.fetch(:current)   {
+        highlight_helm?(highlight_opts)
+      }
+      visible        = options.fetch(:visible)   { true }
       url            = options[:url]
       i18n_scope     = helm_expand_i18n_key('.')
 
-      entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: key, i18n_scope: i18n_scope, url: url)
+      entry = Helm.new(
+        disabled:  disabled,
+        current:    current,
+        visible:    visible,
+        i18n_key:   key,
+        i18n_scope: i18n_scope,
+        url:        url,
+        li_class:   options[:li_class]
+      )
 
       entry.additional = capture(entry, &block) if block_given?
       entry

data/spec/lib/helmsman/helm_spec.rb

@@ -4,30 +4,67 @@ describe Helmsman::Helm do
   let(:helm) { Helmsman::Helm.new(i18n_scope: 'helmsman.', i18n_key: 'foo') }
 
   it 'is always html_safe' do
-    helm.should be_html_safe
+    expect(helm).to be_html_safe
   end
 
   context 'translations' do
     it 'treats translations as html safe' do
-      helm.name.should be_html_safe
-      helm.disabled_title.should be_html_safe
+      expect(helm.name).to be_html_safe
+      expect(helm.disabled_title).to be_html_safe
     end
 
     it '#name_translation_key returns the right thing' do
-      helm.name_translation_key.should eq 'helmsman.foo'
+      expect(helm.name_translation_key).to eq 'helmsman.foo'
     end
 
     it '#disabled_tooltip_translation_key' do
-      helm.disabled_tooltip_translation_key.should eq 'helmsman.foo_disabled_tooltip'
+      expect(helm.disabled_tooltip_translation_key).to\
+        eq 'helmsman.foo_disabled_tooltip'
     end
 
     it '#default_disabled_tooltip_translation_key' do
-      helm.default_disabled_tooltip_translation_key.should eq 'helmsman.disabled_tooltip'
+      expect(helm.default_disabled_tooltip_translation_key).to\
+        eq 'helmsman.disabled_tooltip'
     end
 
     it '#name returns the setted name before the i18n fallback' do
       helm.name = 'Foobar'
-      helm.name.should eq 'Foobar'
+      expect(helm.name).to eq 'Foobar'
+    end
+  end
+
+  context '#li_options' do
+    it 'contains li_class if enabled' do
+      helm = Helmsman::Helm.new(
+        i18n_scope: 'helmsman.',
+        i18n_key:   'key',
+        li_class:   'foo bar'
+      )
+      expect(helm.li_options[:class]).to respond_to :to_str
+      expect(helm.li_options[:class]).to include 'foo'
+      expect(helm.li_options[:class]).to include 'bar'
+    end
+
+    it 'contains li_class if disabled' do
+      helm = Helmsman::Helm.new(
+        i18n_scope: 'helmsman.',
+        i18n_key: 'key',
+        li_class: 'bar foo',
+        disabled: true
+      )
+      expect(helm.li_options[:class]).to respond_to :to_str
+      expect(helm.li_options[:class]).to include 'foo'
+      expect(helm.li_options[:class]).to include 'bar'
+    end
+
+    it 'contains li_class if passed as an array' do
+      helm = Helmsman::Helm.new(
+        i18n_scope: 'helmsman.',
+        i18n_key: 'key',
+        li_class: %w[foo bar] << ' ' << nil
+      )
+      expect(helm.li_options[:class]).to respond_to :to_str
+      expect(helm.li_options[:class]).to eq 'bar foo'
     end
   end
 end

data/spec/lib/helmsman/view_helper_spec.rb

@@ -27,78 +27,82 @@ describe Helmsman::ViewHelper do
   describe '#helm' do
     it 'highlights per class name on a given controller name' do
       result = helper.helm(:pictures)
-      result.should be_current
+      expect(result).to be_current
     end
 
     it 'is possible to override the current state' do
       result = helper.helm(:not_pictures, current: true)
-      result.should be_current
+      expect(result).to be_current
     end
 
     it 'highlights by action name as well' do
       result = helper.helm(:pictures, highlight: { pictures: :show })
-      result.should_not be_current
+      expect(result).not_to be_current
       result = helper.helm(:pictures, highlight: { pictures: :index })
-      result.should be_current
+      expect(result).to 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'
+      expect(result.to_s).not_to include '<a href'
+      expect(result.to_s).to include 'disabled'
     end
 
     it 'adds block results to the result' do
       result = helper.helm(:pictures) { |entry| 'jambalaia' }
-      result.to_s.should include 'jambalaia'
+      expect(result.to_s).to 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">'
+      expect(result.to_s).to include '<a href="hellofoo.com">'
     end
 
     it 'generates html_safe output' do
       result = helper.helm(:pictures)
-      result.to_s.should be_html_safe
+      expect(result.to_s).to 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 ''
+      result = helper.helm(
+        :pictures,
+        url:     'http://defiant.ncc/pictures',
+        visible: false
+      )
+      expect(result.to_s).to eq ''
     end
 
     describe 'yield the entry' do
       it 'knows if its the current' do
-        helper.helm(:foo, current: true) { |e| e.should be_current }
+        helper.helm(:foo, current: true) { |e| expect(e).to 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
+          expect(entry).to be_disabled
+          expect(entry).not_to be_enabled
         end
       end
     end
 
     describe '#highlight_helm?' do
       it 'highlights for a given controller' do
-        helper.highlight_helm?(:pictures).should be_true
-        helper.highlight_helm?(:romulans).should be_false
+        expect(helper.highlight_helm?(:pictures)).to be_truthy
+        expect(helper.highlight_helm?(:romulans)).to be_falsey
       end
 
       it 'accepts multiple controllers as highlight options' do
-        helper.highlight_helm?([:pictures, :romulans]).should be_true
-        helper.highlight_helm?([:borg, :romulans]).should be_false
+        expect(helper.highlight_helm?([:pictures, :romulans])).to be_truthy
+        expect(helper.highlight_helm?([:borg, :romulans])).to be_falsey
       end
 
       it 'takes a flat conditions hash and treats it correctly' do
-        helper.highlight_helm?(pictures: :index).should be_true
-        helper.highlight_helm?(romulans: :attack).should be_false
+        expect(helper.highlight_helm?(pictures: :index)).to be_truthy
+        expect(helper.highlight_helm?(romulans: :attack)).to be_falsey
       end
 
       it 'can highlight on multiple action names' do
-        helper.highlight_helm?(pictures: [:show, :index]).should be_true
+        expect(helper.highlight_helm?(pictures: [:show, :index])).to be_truthy
       end
 
       it 'raises an type error for something unknown' do
@@ -116,24 +120,28 @@ describe Helmsman::ViewHelper do
       end
 
       it 'sets and resets the helm_i18n_scope' do
-        helper.instance_variable_get(:@helm_i18n_scope).should be_nil
+        expect(helper.instance_variable_get(:@helm_i18n_scope)).to be_nil
         helper.helm_i18n_scope 'foobar' do
-          helper.instance_variable_get(:@helm_i18n_scope).should eq 'foobar'
+          scope = helper.instance_variable_get(:@helm_i18n_scope)
+          expect(scope).to eq 'foobar'
         end
-        helper.instance_variable_get(:@helm_i18n_scope).should be_nil
+        scope = helper.instance_variable_get(:@helm_i18n_scope)
+        expect(scope).to be_nil
       end
 
       it 'influences #helm_expand_i18n_key' do
-        helper.helm_expand_i18n_key('picard').should eq 'i18n_path'
+        expect(helper.helm_expand_i18n_key('picard')).to eq 'i18n_path'
 
         helper.helm_i18n_scope 'captain' do
-          helper.helm_expand_i18n_key('.picard').should eq 'captain.picard'
+          key = helper.helm_expand_i18n_key('.picard')
+          expect(key).to eq 'captain.picard'
         end
       end
 
       it 'is used by #helm in the end' do
         helper.helm_i18n_scope 'captain' do
-          helper.helm(:picard, url: 'hello-jean-luc.com').to_s.should include 'captain.picard'
+          helm = helper.helm(:picard, url: 'hello-jean-luc.com').to_s
+          expect(helm).to include 'captain.picard'
         end
       end
     end

data/spec/lib/helmsman_spec.rb

@@ -5,12 +5,12 @@ describe Helmsman do
     after { Helmsman.current_css_class = 'active' }
 
     it 'defaults to active' do
-      Helmsman.current_css_class.should eq 'active'
+      expect(Helmsman.current_css_class).to eq 'active'
     end
 
     it 'is settable and gettable' do
       Helmsman.current_css_class = 'foo'
-      Helmsman.current_css_class.should eq 'foo'
+      expect(Helmsman.current_css_class).to eq 'foo'
     end
   end
 
@@ -18,12 +18,12 @@ describe Helmsman do
     after { Helmsman.disabled_css_class = 'disabled' }
 
     it 'defaults to disabled' do
-      Helmsman.disabled_css_class.should eq 'disabled'
+      expect(Helmsman.disabled_css_class).to eq 'disabled'
     end
 
     it 'is settable and gettable' do
       Helmsman.disabled_css_class = 'foo'
-      Helmsman.disabled_css_class.should eq 'foo'
+      expect(Helmsman.disabled_css_class).to eq 'foo'
     end
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: helmsman
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: rails
   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
@@ -87,10 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -115,17 +113,17 @@ 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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Steers your navigation through the ocean of your application

data/.ruby-gemset

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

data/.ruby-version

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