helmsman 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d3ab528da63035fe88a5e681ff8f5b784673dde
-  data.tar.gz: 6c13eb1db5464e344582dcbeeefd9ab81375c011
+  metadata.gz: e267300084ce4f8e33e158fa766cca8bba95aa84
+  data.tar.gz: dbb9e507ec5b46d6b66c4b129af9b420924950ff
 SHA512:
-  metadata.gz: ee820e7a0284fed73ef31ce96e792ed38c5a5db40ee00085e60ae9bd18d3223133c3b773eb8b11b323b75d6155bc276b4c9319f26e87ef90ba4302fa875e2467
-  data.tar.gz: d25e5afe9ad7373ec40f919a802ac43b85bc24cce33600de778033c23a7bfe9fa2c6c4ffcbc1ef4bf3044cc91a8c02eff3bc8d588d9d096ec082d216c0de0782
+  metadata.gz: 2a7cb10fc14086ee58a315b956ea668ca8e57a93219680dab4dc649e56cb4af09e3fabcb2c4d211f96e3963b2427f1ca80799a198ed4cb1bb2acc3aab2c2931a
+  data.tar.gz: b4321b2cb64cccc317653d2d6078bae3cfb37aedbed70388caeae852927d4716849817ae0bdc4d808dedb2d4b9661393bc1c7884cf0701cbad4381db61754869

data/README.md

@@ -32,28 +32,28 @@ The above call will produce the following html output
 
 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.
+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'
-```
+  ```ruby
+  helm :pictures, url: 'http://randompictures.com'
+  ```
 
-2. set helm values in a block.
+2. Set helm values in a block. (This works for name and url only.)
 
-```ruby
-helm :pictures do |entry|
-  entry.name = 'Some pictures'
-  entry.url  = 'http://randompictures.com'
-end
-```
+  ```ruby
+  helm :pictures do |entry|
+    entry.name = 'Some pictures'
+    entry.url  = 'http://randompictures.com'
+  end
+  ```
 
-3. build everything manually
+3. Build everything manually
 
-```ruby
-helm :pictures do |_|
-  link_to 'Some pictures', 'http://randompictures.com'
-end
-```
+  ```ruby
+  helm :pictures do |_|
+    link_to 'Some pictures', 'http://randompictures.com'
+  end
+  ```
 
 ### Translation lookup
 
@@ -65,6 +65,16 @@ e.g. `helm :edit` called from `app/views/pictures/_menu.html.*` uses the followi
 - en.pictures.menu.edit_disabled_tooltip
 - en.pictures.menu.disabled_tooltip
 
+### Translation scope
+
+To wrap a group of navigation elements into the same translation namespace use the `helm_i18n_scope` method:
+
+```ruby
+helm_i18n_scope 'bridge' do
+  helm :sensors             # will use 'bridge.sensors' for translation lookup
+end
+```
+
 ### Highlight current
 
 Helmsman will highlight the current entry by using the controller and action name.

data/lib/helmsman/helm.rb

@@ -1,6 +1,8 @@
 module Helmsman
   class Helm
-    attr_accessor :name, :url, :additional, :i18n_key, :i18n_scope
+    attr_accessor :url, :additional, :i18n_key, :i18n_scope
+    attr_writer :name
+
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::UrlHelper
 
@@ -39,7 +41,7 @@ module Helmsman
     end
 
     def name
-      I18n.translate("#{i18n_scope}#{i18n_key}").html_safe
+      @name || I18n.translate("#{i18n_scope}#{i18n_key}").html_safe
     end
 
     def disabled_title

data/lib/helmsman/version.rb

@@ -1,3 +1,3 @@
 module Helmsman
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/helmsman/view_helper.rb

@@ -35,10 +35,20 @@ module Helmsman
       end
     end
 
+    def helm_i18n_scope(scope, &block)
+      @helm_i18n_scope = scope
+      yield
+      @helm_i18n_scope = nil
+    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)
+    def helm_expand_i18n_key(key)
+      if @helm_i18n_scope
+        [@helm_i18n_scope, key].join('.')
+      else
+        scope_key_by_partial(key)
+      end
     end
 
     def helm(key, options = {}, &block)
@@ -48,7 +58,7 @@ module Helmsman
       current        = options.fetch(:current)     { highlight_helm?(highlight_opts) }
       visible        = options.fetch(:visible)     { true }
       url            = options[:url]
-      i18n_scope     = expand_i18n_key('.')
+      i18n_scope     = helm_expand_i18n_key('.')
 
       entry = Helm.new(disabled: disabled, current: current, visible: visible, i18n_key: key, i18n_scope: i18n_scope, url: url)
 

data/spec/lib/helmsman/helm_spec.rb

@@ -24,5 +24,10 @@ describe Helmsman::Helm do
     it '#default_disabled_tooltip_translation_key' do
       helm.default_disabled_tooltip_translation_key.should eq 'helmsman.disabled_tooltip'
     end
+
+    it '#name returns the setted name before the i18n fallback' do
+      helm.name = 'Foobar'
+      helm.name.should eq 'Foobar'
+    end
   end
 end

data/spec/lib/helmsman/view_helper_spec.rb

@@ -107,5 +107,29 @@ describe Helmsman::ViewHelper do
         }.to raise_error(TypeError)
       end
     end
+
+    describe '#helm_i18n_scope' do
+      it 'raises an error if called without block' do
+        expect {
+          helper.helm_i18n_scope 'foobar'
+        }.to raise_error(LocalJumpError)
+      end
+
+      it 'sets and resets the helm_i18n_scope' do
+        helper.instance_variable_get(:@helm_i18n_scope).should be_nil
+        helper.helm_i18n_scope 'foobar' do
+          helper.instance_variable_get(:@helm_i18n_scope).should eq 'foobar'
+        end
+        helper.instance_variable_get(:@helm_i18n_scope).should be_nil
+      end
+
+      it 'influences #helm_expand_i18n_key' do
+        helper.helm_expand_i18n_key('picard').should eq 'i18n_path'
+
+        helper.helm_i18n_scope 'captain' do
+          helper.helm_expand_i18n_key('picard').should eq 'captain.picard'
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsman
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Steers your navigation through the ocean of your application