helmsman 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78f62fb01bec0e7c067b07f0fd15e8e1f526b4d6
-  data.tar.gz: 8e0d19d3f3964254e6ccb51ce904e15863837016
+  metadata.gz: 0ca11064fdfec0f066477aa210a1a911cc1d9a6e
+  data.tar.gz: 6b6bd3981fc0454aac7028905abbfcadd2b23924
 SHA512:
-  metadata.gz: 75931d6ccf84160e20579f09302af8d0a371d6cf9c4a472068bc77f87c02571a2d640fa10bd4f4f38dd75465c214cd1ce21078d8f5552847b0a7575c2a76024a
-  data.tar.gz: 0f879d0ced6f48016929028e34824bf6a4a5484ae5c9e7144eb308a8f4356d5cf71d2236910a7f5a3d6f0960dcc7a2b28ac34ec5c6e20a5009e7c073785eb2c0
+  metadata.gz: 0e613a1a3378e25f4902a1040ad32366e1090273efc12dd83fc40d87a0b33588260389e67f64939765dbdbd084c3dc109083ac982421804b4ef6b29a40148096
+  data.tar.gz: 13b4562b71d09d2fe379d204dc319b95a3b1fe6ae97e9d1bf3e093982d9ae244bc5373a2bc27861debea0043251d357ba37638175a77ea54c87bb394c93e02df

data/README.md

@@ -1,6 +1,6 @@
 # Helmsman
 
-[![Build Status](https://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) [![Code Climate](https://codeclimate.com/repos/523f6d34c7f3a34a75017842/badges/af7056196f756e73e540/gpa.png)](https://codeclimate.com/repos/523f6d34c7f3a34a75017842/feed)
+[![Build Status](https://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
 
@@ -70,13 +70,13 @@ Helmsman will highlight the current entry by using the controller and action nam
 
 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:
+You may customize the highlight options by providing a set of controller and/or action names in the `highlight` options. 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
+helm :bridge, highlight: :screens                           # on any screens controller action
+helm :bridge, highlight: [:screens, :sensors]               # on any screens and sensors controller action
+helm :bridge, highlight: { screens: :show }                 # on bridges controller show action
+helm :bridge, highlight: :screens, sensors: [: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:

data/lib/helmsman/version.rb

@@ -1,3 +1,3 @@
 module Helmsman
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/helmsman/view_helper.rb

@@ -12,6 +12,29 @@ module Helmsman
       end
     end
 
+    # Indicates if for the given conditions the helm should be highlighted.
+    # Examples:
+    #   Given we are in pictures controller and action index
+    #   highlight_helm?(:pictures)                          # true
+    #   highlight_helm?(:foobar)                            # false
+    #   highlight_helm?(pictures: :index)                   # true
+    #   highlight_helm?(pictures: [:index, :show])          # true
+    #   highlight_helm?(pictures: [:index, :show], :foobar) # true
+    def highlight_helm?(conditions)
+      Array(conditions).any? do |condition|
+        case condition
+        when Symbol, String
+          condition.to_s == controller_name
+        when Array
+          if condition.first.to_s == controller_name
+            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}"
+        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)
@@ -19,13 +42,13 @@ module Helmsman
     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}")
+      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_key       = expand_i18n_key(".#{key}")
 
       entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: i18n_key, url: url)
 

data/spec/lib/helmsman/view_helper_spec.rb

@@ -36,9 +36,9 @@ describe Helmsman::ViewHelper do
     end
 
     it 'highlights by action name as well' do
-      result = helper.helm(:pictures, actions: :show)
+      result = helper.helm(:pictures, highlight: { pictures: :show })
       result.should_not be_current
-      result = helper.helm(:pictures, actions: :index)
+      result = helper.helm(:pictures, highlight: { pictures: :index })
       result.should be_current
     end
 
@@ -80,5 +80,32 @@ describe Helmsman::ViewHelper do
         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
+      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
+      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
+      end
+
+      it 'can highlight on multiple action names' do
+        helper.highlight_helm?(pictures: [:show, :index]).should be_true
+      end
+
+      it 'raises an type error for something unknown' do
+        expect {
+          helper.highlight_helm?(3)
+        }.to raise_error(TypeError)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helmsman
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Johannes Opper