helmsman 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd0afaa2f3e70cd6119aaad852ccaa0fc8f196f
-  data.tar.gz: 694f7a96e46ac89ded713cedb864c046e1b44358
+  metadata.gz: a6b701adb066d32088971a3e5daa6e1ea70a61cc
+  data.tar.gz: 079e0a5d62c8205a7f60cdbbb15573acf7bc5224
 SHA512:
-  metadata.gz: 7ea788e7d2f08d2d73cc6d21c7b3bd9d458df3e095148ef8f59e035e9813112c1aa5f4d53f4cb2ad908aad0fcc25c02ea9a49bc54498d24e4647147b2849aa50
-  data.tar.gz: b799ba1db4cc5dad3ad1acd6e8d4e30c31495b9f3aa1b923eab7e03dae48faf24e324f0b2a033efd2f809a4e93e9ecf52e409d3f500696271c0fd26c0c1d7189
+  metadata.gz: 2b8142ba64141f62d0a0163f7b063d92b27e90353cf4942393a1d46ad720c11610ff004ddf7cec7192347805bacfedaa99be945352a1c98676c4a7ea185e8e62
+  data.tar.gz: 6b3532ef9ceac4bf2a9d43cd5d863dbb15196ae800b2dd9ddb3a449fa77e186e00a469c55bca013234aa9656de27685a26c32b4b10879170c1cc1438b28ee051

data/README.md

@@ -63,6 +63,7 @@ e.g. `helm :edit` called from `app/views/pictures/_menu.html.*` uses the followi
 
 - en.pictures.menu.edit
 - en.pictures.menu.edit_disabled_tooltip
+- en.pictures.menu.disabled_tooltip
 
 ### Highlight current
 
@@ -73,10 +74,10 @@ Per default the first parameter will be treated as the controller name: `helm :p
 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, 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
+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] }] # all screens controller actions and sensors controller #show and #index
 ```
 
 Anyway you are not forced to use that mechanism, you can also set `current` by hand:
@@ -87,16 +88,16 @@ 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.
+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 (´.pictures_disabled_tooltip´).
 
 ```ruby
-admin_sidebar_entry :pictures, url: pictures_url, disabled: user_signed_in?
+helm :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?
+helm :pictures, url: pictures_url, visible: user_signed_in?
 ```
 
 ### Additional content and nesting
@@ -114,7 +115,7 @@ You can always use the current helm during that yield, so finding out whether it
 
 
 ```ruby
-admin_sidebar_entry :pictures, disabled: true, current: false do |entry|
+helm :pictures, disabled: true, current: false do |entry|
   puts entry.enabled?   # false
   puts entry.disabled?  # true
   puts entry.visible?   # true

data/lib/helmsman/helm.rb

@@ -1,15 +1,16 @@
 module Helmsman
   class Helm
-    attr_accessor :name, :url, :additional, :i18n_key
+    attr_accessor :name, :url, :additional, :i18n_key, :i18n_scope
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::UrlHelper
 
     def initialize(options = {})
-      @disabled = options.fetch(:disabled) { false }
-      @visible  = options.fetch(:visible)  { true }
-      @current  = options.fetch(:current)  { false }
-      @i18n_key = options.fetch(:i18n_key) { 'helmsman.helm.fallback' }
-      @url      = options[:url]
+      @disabled   = options.fetch(:disabled)   { false }
+      @visible    = options.fetch(:visible)    { true }
+      @current    = options.fetch(:current)    { false }
+      @i18n_scope = options.fetch(:i18n_scope)
+      @i18n_key   = options.fetch(:i18n_key)
+      @url        = options[:url]
     end
 
     def to_s
@@ -38,11 +39,23 @@ module Helmsman
     end
 
     def name
-      I18n.translate(i18n_key).html_safe
+      I18n.translate("#{i18n_scope}#{i18n_key}").html_safe
     end
 
     def disabled_title
-      I18n.translate("#{i18n_key}_disabled_tooltip").html_safe
+      I18n.translate(disabled_tooltip_translation_key, default: default_disabled_tooltip_translation_key).html_safe
+    end
+
+    def name_translation_key
+      "#{i18n_scope}#{i18n_key}"
+    end
+
+    def disabled_tooltip_translation_key
+      "#{i18n_scope}#{i18n_key}_disabled_tooltip"
+    end
+
+    def default_disabled_tooltip_translation_key
+      "#{i18n_scope}disabled_tooltip"
     end
 
     def disabled?

data/lib/helmsman/version.rb

@@ -1,3 +1,3 @@
 module Helmsman
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/helmsman/view_helper.rb

@@ -48,9 +48,9 @@ module Helmsman
       current        = options.fetch(:current)     { highlight_helm?(highlight_opts) }
       visible        = options.fetch(:visible)     { true }
       url            = options[:url]
-      i18n_key       = expand_i18n_key(".#{key}")
+      i18n_scope     = expand_i18n_key('.')
 
-      entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: i18n_key, url: url)
+      entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: key, i18n_scope: i18n_scope, url: url)
 
       entry.additional = capture(entry, &block) if block_given?
       entry

data/spec/lib/helmsman/helm_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Helmsman::Helm do
-  let(:helm) { Helmsman::Helm.new }
+  let(:helm) { Helmsman::Helm.new(i18n_scope: 'helmsman.', i18n_key: 'foo') }
 
   it 'is always html_safe' do
     helm.should be_html_safe
@@ -13,5 +13,16 @@ describe Helmsman::Helm do
       helm.disabled_title.should be_html_safe
     end
 
+    it '#name_translation_key returns the right thing' do
+      helm.name_translation_key.should eq 'helmsman.foo'
+    end
+
+    it '#disabled_tooltip_translation_key' do
+      helm.disabled_tooltip_translation_key.should eq 'helmsman.foo_disabled_tooltip'
+    end
+
+    it '#default_disabled_tooltip_translation_key' do
+      helm.default_disabled_tooltip_translation_key.should eq 'helmsman.disabled_tooltip'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsman
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack