simple-navigation-bootstrap 0.0.4 → 1.0.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.ruby-version

data/.ruby-gemset

@@ -0,0 +1 @@
+simple-navigation-bootstrap

data/README.md

@@ -0,0 +1,69 @@
+# Simple Navigation for Bootstrap
+This gem adds a renderer for [Simple Navigation](http://github.com/andi/simple-navigation) to output markup compatible 
+with [Twitter Bootstrap](http://twitter.github.com/bootstrap/).
+
+## Getting Started
+For Rails >= 3, simply add this gem to your `Gemfile`:
+```ruby
+gem 'simple-navigation-bootstrap'
+```
+and run
+```
+bundle install
+```
+Follow the [configuration instructions](https://github.com/andi/simple-navigation/wiki/Configuration) on the Simple Navigation wiki for initial configuration.
+
+To use the Bootstrap renderer, specify it in your view:
+```ruby
+render_navigation :expand_all => true, :renderer => :bootstrap
+```
+
+## Additional Functionality
+In addition to generating Bootstrap-comptible list markup, you may specify 
+an `:icon` attribute on your navigation items, either as an array 
+or string, containing Bootstrap [icon classes](http://twitter.github.com/bootstrap/base-css.html#icons), to add an icon to the item.
+
+For items with sub-navigation, you may specify `:split => true` to enable a
+split dropdown.  Split dropdowns allow using an url on the primary navigation
+item, as well as having a dropdown containing sub-navigation.  If you plan on
+using this feature, in your `application.css` or equivalent you must require
+the `bootstrap_navbar_split_dropdowns` stylesheet after requiring Bootstrap.
+
+For example:
+```css
+/*
+*= require bootstrap_and_overrides
+*= require bootstrap_navbar_split_dropdowns
+*/
+```
+
+## Examples
+To create a navigation menu, you might do something like this:
+```ruby
+SimpleNavigation::Configuration.run do |navigation|  
+  navigation.items do |primary|
+    primary.item :music, 'Music', musics_path
+    primary.item :dvds, 'Dvds', dvds_path, :split => true do |dvds|
+      dvds.item :action, 'Action', dvds_action_path
+      dvds.item :drama, 'Drama', dvds_drama_path
+    end
+    primary.item :books, 'Books', :icon => ['icon-book', 'icon-white'] do |books|
+      books.item :fiction, 'Fiction', books_fiction_path
+      books.item :history, 'History', books_history_path
+    end
+    primary.dom_class = 'nav'
+  end
+end
+```
+
+## Caveats
+Requires Bootstrap version >= 2.1.0
+
+## Further Reading
+* [Twitter Bootstrap Documentation](http://twitter.github.com/bootstrap/)
+* [Simple Navigation Wiki](https://github.com/andi/simple-navigation/wiki/)
+
+## TODO
+So far, only nav markup and dropdowns are supported, may also implement 
+buttons and nav lists in the future. And tests, there are currently no
+tests.

data/lib/simple-navigation-bootstrap.rb

@@ -1,4 +1,5 @@
 require "simple-navigation"
 require "simple_navigation/rendering/renderer/bootstrap"
+require "simple-navigation-bootstrap/engine"
 require "simple-navigation-bootstrap/version"
 SimpleNavigation.register_renderer :bootstrap => SimpleNavigation::Renderer::Bootstrap

data/lib/simple-navigation-bootstrap/engine.rb

@@ -0,0 +1,5 @@
+module SimpleNavigationBootstrap
+  class Engine < ::Rails::Engine
+  end
+end
+

data/lib/simple-navigation-bootstrap/version.rb

@@ -1,3 +1,3 @@
 module SimpleNavigationBootstrap
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/lib/simple_navigation/rendering/renderer/bootstrap.rb

@@ -6,11 +6,21 @@ module SimpleNavigation
         SimpleNavigation.config.selected_class = 'active'
         list_content = item_container.items.inject([]) do |list, item|
           li_options = item.html_options.reject {|k, v| k == :link}
-          li_content = tag_for(item, li_options.delete(:icon))
+          icon = li_options.delete(:icon)
+          split = (include_sub_navigation?(item) and li_options.delete(:split))
+          li_content = tag_for(item, item.name, icon, split)
           if include_sub_navigation?(item)
-            item.sub_navigation.dom_class = [item.sub_navigation.dom_class, 'dropdown-menu'].flatten.compact.join(' ')
+            if split
+              lio = li_options.dup
+              lio[:class] = [li_options[:class], 'dropdown-split-left'].flatten.compact.join(' ')
+              list << content_tag(:li, li_content, lio)
+              item.html_options[:link] = nil
+              li_options[:id] = nil
+              li_content = tag_for(item)
+            end
+            item.sub_navigation.dom_class = [item.sub_navigation.dom_class, 'dropdown-menu', split ? 'pull-right' : nil].flatten.compact.join(' ')
             li_content << render_sub_navigation_for(item)
-            li_options[:class] = [li_options[:class], 'dropdown'].flatten.compact.join(' ')
+            li_options[:class] = [li_options[:class], 'dropdown', split ? 'dropdown-split-right' : nil].flatten.compact.join(' ')
           end
           list << content_tag(:li, li_content, li_options)
         end.join
@@ -24,26 +34,29 @@ module SimpleNavigation
 
       protected
 
-      def tag_for(item, icon = nil)
+      def tag_for(item, name = '', icon = nil, split = false)
         unless item.url or include_sub_navigation?(item)
           return item.name
         end
         url = item.url
         link = Array.new
         link << content_tag(:i, '', :class => [icon].flatten.compact.join(' ')) unless icon.nil?
-        link << item.name
+        link << name
         if include_sub_navigation?(item)
-          url = '#'
           item_options = item.html_options
           item_options[:link] = Hash.new if item_options[:link].nil?
           item_options[:link][:class] = Array.new if item_options[:link][:class].nil?
-          item_options[:link][:class] << 'dropdown-toggle'
-          item_options[:link][:'data-toggle'] = 'dropdown'
+          unless split
+            item_options[:link][:class] << 'dropdown-toggle'
+            item_options[:link][:'data-toggle'] = 'dropdown'
+            item_options[:link][:'data-target'] = '#'
+            link << content_tag(:b, '', :class => 'caret')
+          end
           item.html_options = item_options
-          link << content_tag(:b, '', :class => 'caret')
         end
-        link_to(link.join(" "), url, options_for(item))
+        link_to(link.join(" ").html_safe, url, options_for(item))
       end
+
     end
   end
 end

data/simple-navigation-bootstrap.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.extra_rdoc_files = ["README.rdoc"]
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rake"
   s.add_runtime_dependency "simple-navigation", ">= 3.7.0"
+  s.add_runtime_dependency "railties", ">= 3.1"
 end

data/vendor/assets/stylesheets/bootstrap_navbar_split_dropdowns.css

@@ -0,0 +1,6 @@
+.navbar .nav > li.dropdown-split-right > a {
+  padding-left: 7px;
+}
+.navbar .nav > li.dropdown-split-left > a {
+  padding-right: 0;
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-navigation-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,23 +43,41 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: simple-navigation-bootstrap is a simple-navigation renderer for twitter-bootstrap
   navigation and dropdowns.
 email:
 - github@obfusc8.org
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-gemset
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/simple-navigation-bootstrap.rb
+- lib/simple-navigation-bootstrap/engine.rb
 - lib/simple-navigation-bootstrap/version.rb
 - lib/simple_navigation/rendering/renderer/bootstrap.rb
 - simple-navigation-bootstrap.gemspec
+- vendor/assets/stylesheets/bootstrap_navbar_split_dropdowns.css
 homepage: https://github.com/pdf/simple-navigation-bootstrap
 licenses: []
 post_install_message: 
@@ -74,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3790548219355218743
+      hash: 4218250063998013409
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,10 +101,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3790548219355218743
+      hash: 4218250063998013409
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: simple-navigation-bootstrap is a simple-navigation renderer for twitter-bootstrap

data/README.rdoc

@@ -1,45 +0,0 @@
-== Simple Navigation for Bootstrap
-This gem adds a renderer for {Simple Navigation}[http://github.com/andi/simple-navigation] to output markup compatible 
-with {Twitter Bootstrap}[http://twitter.github.com/bootstrap/].
-
-== Getting Started
-For Rails >= 3, simply add this gem to your <tt>Gemfile</tt>:
- gem 'simple-navigation-bootstrap'
-and run
- bundle install
-Follow the {configuration instructions}[https://github.com/andi/simple-navigation/wiki/Configuration] on the Simple Navigation wiki for initial configuration.
-
-To use the Bootstrap renderer, specify it in your view:
- render_navigation :expand_all => true, :renderer => :bootstrap
-
-== Additional Functionality
-In addition to generating Bootstrap-comptible list markup, you may specify 
-an <tt>:icon</tt> attribute on your navigation items, either as an array 
-or string, containing Bootstrap {icon classes}[http://twitter.github.com/bootstrap/base-css.html#icons], to add an icon to the item.
-
-== Examples
-To create a navigation menu, you might do something like this:
- SimpleNavigation::Configuration.run do |navigation|  
-   navigation.items do |primary|
-     primary.item :music, 'Music', musics_path
-     primary.item :dvds, 'Dvds', dvds_path
-     primary.item :books, 'Books', :icon => ['icon-book', 'icon-white'] do |books|
-       books.item :fiction, 'Fiction', books_fiction_path
-       books.item :history, 'History', books_history_path
-     end
-     primary.dom_class = 'nav'
-   end
- end
-
-== Caveats
-Because Bootstrap only supports dropdown on-click, items with sub-navigation 
-may not contain links - any links will be overwritten with a <tt>#</tt> anchor.
-
-== Further Reading
-* {Twitter Bootstrap Documentation}[http://twitter.github.com/bootstrap/]
-* {Simple Navigation Wiki}[https://github.com/andi/simple-navigation/wiki/]
-
-== TODO
-So far, only nav markup and dropdowns are supported, may also implement 
-buttons and nav lists in the future. And tests, there are currently no
-tests.