rails_bootstrap_easy_navbar 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format specdoc
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_bootstrap_navbar_helper.gemspec
+gemspec
+
+gem "rails"
+gem "rake"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mitchell Lane[DATACOM]
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# RailsBootstrapEasyNavbar 
+
+RailsBootstrapEasyNavbar is a Ruby on Rails gem for creating a simple navigation bar with twitter-bootstrap styling. It suits rapid prototyping as it can be setup within minutes.
+
+Make sure you have the twitter bootstrap stylesheets and javascript files installed. They can be installed in anyway. Either via gems or raw stylesheets and javascript files. For easy installation check out these gems: 'bootstrap-sass' & 'twitter-bootstrap-rails'
+
+The navigation bar may only be a maximum of two levels.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_bootstrap_easy_navbar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_bootstrap_easy_navbar
+
+## Usage
+With RailsBootstrapEasyNavbar you can create a bootstrap styled navbar with one method call containing your current page name and a JSON object. 
+
+From within a view create a navbar with:
+<pre>
+create_navbar(@current_page, @navbar_tabs)
+</pre>
+The current page variable is the title of the current tab in string format
+
+The navbar_tabs JSON object is a hash of name, path pairs. 
+
+An example of a JSON object describing 3 main tabs:
+<pre>
+{ 
+	"Login" => login_path,
+	"Tasks" => tasks_path,
+	"Project" => projects_path
+}
+</pre>
+To include subtabs simply create a key named after the main tab with a value of a hash describing each of the sub tabs. Only one level of subtabs is supported. 
+
+Here is an example of a JSON object describing 3 main tabs and 2 subtabs:
+<pre>
+{ 
+	"Login" => login_path,
+	"Tasks" => tasks_path,
+	"Project" => {
+					"Open Projects" => projects_open_path,
+			        "Closed Projects" => projects_closed_path
+			     }
+}
+</pre>
+You can create a responsive collapsible navbar with:
+<pre>
+create_collapsible_navbar(@current_page, @navbar_tabs)
+</pre>
+## Extension & Styling
+The creation methods take an optional hash for styling and exending the navbar.
+
+Add a brand to the navbar with:
+<pre>
+create_navbar(@current_page, @navbar_tabs, brand: "Website Title")
+</pre>
+Add a link for when the brand is clicked with:
+<pre>
+create_navbar(@current_page, @navbar_tabs, brand: "Website Title", brand_path: '/projects')
+</pre>
+Change the Navbar class (Check out http://twitter.github.com/bootstrap/components.html#navbar for different classes) :
+<pre>
+create_navbar(@current_page, @navbar_tabs, navbar_class: 'navbar navbar-inverse')
+</pre>
+Add raw html inside the non collapsible nav bar area:
+<pre>
+create_navbar(@current_page, @navbar_tabs, navbar_raw_html: @navbar_raw_html)
+</pre>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails_bootstrap_easy_navbar/navbar_helper.rb

@@ -0,0 +1,77 @@
+module RailsBootstrapEasyNavbar
+	module NavbarHelper
+		DEFAULT_NAVBAR_CLASS = 'navbar'
+		DEFAULT_BRAND_PATH = "/"
+
+		def create_navbar(current_tab, nav_items, options={})
+			options[:navbar_class] ||= DEFAULT_NAVBAR_CLASS
+			content_tag(:div, navbar_inner(current_tab, nav_items, options), class: options[:navbar_class])
+		end
+
+		def create_collapsible_navbar(current_tab, nav_items, options={})
+			options[:navbar_class] ||= DEFAULT_NAVBAR_CLASS
+			options[:navbar_collapsible] = true
+			content_tag(:div, navbar_inner(current_tab, nav_items, options), class: options[:navbar_class])
+		end
+
+		private
+	    # Creates the navbar wrapper optionally containing a brand on the left hand side
+	    def navbar_inner(current_tab, nav_items, options={})
+	      #create responsive collapsible layout if requested
+	      contents = [
+	      	content_tag(:a, (content_tag(:span, nil, class: "icon-bar")*3).html_safe, class: "btn btn-navbar", 'data-toggle' => "collapse", 'data-target' => '.nav-collapse'),
+	      	content_tag(:div, content_tag(:ul, tabs(current_tab, nav_items), id: "tabs", class: "nav"), id: "navbar", class: 'nav-collapse collapse')
+	      	] if options[:navbar_collapsible]
+	      # skip responsive layout and create tabs if not requested
+	      contents = [content_tag(:ul, tabs(current_tab, nav_items), id: "tabs", class: "nav")] if !options[:navbar_collapsible]
+
+	      #create brand
+	      if options[:brand]
+	      	options[:brand_path] ||= DEFAULT_BRAND_PATH
+	      	contents.insert(0, (content_tag(:a, options[:brand], href: options[:brand_path], class: "brand")))
+	      end
+
+	      #inject raw html if requested
+	      contents << options[:navbar_raw_html] if options[:navbar_raw_html]
+
+	      #create inner navbar
+	      content_tag(:div, content_tag(:div, contents.join('').html_safe, class: 'container-fluid'), class: 'navbar-inner')
+		end
+
+		    # Creates HTML for a list of clickable tabs 
+		def tabs(current_tab, nav_items)
+	    	nav_items.map do |tab_name, path|
+	          # A Hash here means the tab is made up of multiple links -> dropdown 
+		        if path.is_a? Hash
+		          	content_tag(:li, drop_down_tab(tab_name, path), class: "dropdown")
+		          # construct and add a link to the list of tabs
+		      	else
+			      	args = [:li, (link_to tab_name, path)]
+			      	args << {class: "active"} if tab_name == current_tab
+			      	content_tag(*args)
+			    end
+		    end.join(separator).html_safe
+		end
+
+		def separator
+			content_tag(:li, nil, class: "divider-vertical")
+		end
+
+		def drop_down_tab(title, items)
+			[content_tag(:a, dropdown_title(title), href: "#", class: "dropdown-toggle", 'data-toggle' => "dropdown"),
+				content_tag(:ul, drop_down_links(items), class: "dropdown-menu")
+			].join("").html_safe
+		end
+
+
+		def drop_down_links(items)
+			items.map do |tab_name, path| 
+				content_tag(:li, (link_to tab_name, path))
+			end.join("").html_safe
+		end
+
+		def dropdown_title(title)
+			dropdown_title = (title + " "+content_tag(:b, nil, class: "caret")).html_safe
+		end
+	end
+end

data/lib/rails_bootstrap_easy_navbar/railtie.rb

@@ -0,0 +1,8 @@
+require 'rails_bootstrap_easy_navbar/navbar_helper'
+module RailsBootstrapEasyNavbar
+  class Railtie < Rails::Railtie
+    initializer "rails_bootstrap_easy_navbar.navbar_helper" do
+      ActionView::Base.send :include, NavbarHelper
+    end
+  end
+end

data/lib/rails_bootstrap_easy_navbar/version.rb

@@ -0,0 +1,3 @@
+module RailsBootstrapEasyNavbar
+  VERSION = "0.0.2"
+end

data/lib/rails_bootstrap_easy_navbar.rb

@@ -0,0 +1,2 @@
+require "rails_bootstrap_easy_navbar/version"
+require 'rails_bootstrap_easy_navbar/railtie' if defined? (Rails)

data/rails_bootstrap_easy_navbar.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_bootstrap_easy_navbar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rails_bootstrap_easy_navbar"
+  gem.version       = RailsBootstrapEasyNavbar::VERSION
+  gem.authors       = ["Mitchell Lane"]
+  gem.email         = ["Mitchell.Lane52@gmail.com"]
+  gem.description   = %q{With RailsBootstrapEasyNavbar you can create a simple navigation bar with twitter-bootstrap styling from a given JSON object. The navigation bar may only be a maximum of two levels.}
+  gem.summary       = %q{With RailsBootstrapEasyNavbar you can create a simple navigation bar with twitter-bootstrap styling in only minutes.}
+  gem.homepage      = ""
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rails_bootstrap_easy_navbar
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Mitchell Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: With RailsBootstrapEasyNavbar you can create a simple navigation bar
+  with twitter-bootstrap styling from a given JSON object. The navigation bar may
+  only be a maximum of two levels.
+email:
+- Mitchell.Lane52@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_bootstrap_easy_navbar.rb
+- lib/rails_bootstrap_easy_navbar/navbar_helper.rb
+- lib/rails_bootstrap_easy_navbar/railtie.rb
+- lib/rails_bootstrap_easy_navbar/version.rb
+- rails_bootstrap_easy_navbar.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: With RailsBootstrapEasyNavbar you can create a simple navigation bar with
+  twitter-bootstrap styling in only minutes.
+test_files: []