navGATE 0.1.03 → 0.1.3.1

data/navGATE.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = "navGATE"
-  s.version = "0.1.03"
+  s.version = "0.1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Becker"]
-  s.date = "2013-10-15"
-  s.description = "Allows the easy creation of menus with config files"
+  s.date = "2014-01-09"
+  s.description = "Can create navigation from objects using the nav builder,from database tables or from a yaml file"
   s.email = "mbeckerwork@gmail.com"
-  s.extra_rdoc_files = ["lib/navgate.rb", "lib/navgate/base.rb"]
-  s.files = ["Manifest", "Rakefile", "app/controller/application_controller.rb", "app/helpers/application_helper.rb", "config/build_menu.yml", "config/initializers/build_menu.rb", "init.rb", "lib/navgate.rb", "lib/navgate/base.rb", "navGATE.gemspec", "readme.rdoc"]
+  s.extra_rdoc_files = ["lib/navgate.rb", "lib/navgate/base.rb", "lib/navgate/builder.rb", "lib/navgate/main.rb", "lib/navgate/modules/navgatehelpers.rb", "lib/navgate/navgatehelpers.rb", "lib/readme.rdoc"]
+  s.files = ["LICENCE/GPL-2", "Manifest", "Rakefile", "config/build_menu.yml", "config/initializers/build_menu.rb", "init.rb", "lib/navgate.rb", "lib/navgate/base.rb", "lib/navgate/builder.rb", "lib/navgate/main.rb", "lib/navgate/modules/navgatehelpers.rb", "lib/navgate/navgatehelpers.rb", "lib/readme.rdoc", "navGATE.gemspec", "readme.rdoc"]
   s.homepage = "https://github.com/Thermatix/navGATE"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "navGATE", "--main", "readme.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "navgate"
   s.rubygems_version = "2.0.6"
-  s.summary = "Allows the easy creation of menus with config files"
+  s.summary = "Allows the easy creation of navigation with config files"
 end

data/readme.rdoc

@@ -1,99 +1,175 @@
 = navGATE
 
-This gem is provided as is, please read through the intializer file "build_menu.rb" for examples on how you can use this gem to build a nav menu.
+This gem is provided as is.
+
+This gem allows for the ease of navigation building, from preset lists, from active model databases (eg, categories), from yaml files; but it's not just
+for the ease of use it's also that you can have multiple navigation menus for differant controllers, or the same menu for differant controllers.
+However you want it, it's up to you.
 
 This gem was built with Rails in mind.
 
-note: this is my first gem, I am still trying to set it up, so be carefull when downloading this.
-Also I've included the extra files needed to get it working in there respective directories, eg, the code in 'Applicationhelper' needs to go in 'Applicationhelper'.
-I've tried to to make it easy to install but I'm still not sure how to get those things into the right files automaticly, if some one could point me in the right direction, I'd be happy to make the needed changes.
+
 lastly the gem is up on rubygems.org
+
+==Setup
+in the Application controller you have to <tt> include NavGateHelpers </tt> first.
+
+===For Rails
+You next have to add a before_filter and helper method to the application controller
+
+Just add:
+  helper_method :render_navigation
+  before_filter :make_menu
+
+To your list of filters and helper methods in the application controller, thats it, you can now use the helper method and the gem to build your navigations.
+==For non Rails
+For non rails version of NavGATE the helpers change, instead they work like so:
+
+  make_menu(selection, controller)
+
+  render_navigation(selection, controller, options = nil)
+
+You have to pass the controller (or page it matches) and the current selection,
+in rails they would pass automatically as <tt> params[:controller] </tt> and <tt> params[:selection] </tt> respectively (selection being the currently selected nav item).
+
 ==Building the menus
 
 When building the menu there are multiple options available, building the menu is done in  an initializer file in the configs directory.
 
 There are several options you can pass through, if you are building the menu with the object builder directly then two options must be present, those being 'selection' and 'controller', the rest are optional.
 
-Also note, you can pass multiple Navgate::builders as you need, just match them to there controllers and they should render properly.
+Also note, you can pass multiple <tt> NavGate::builders </tt> as you need, just match them to there controllers and they should render properly.
 ===Options
 
-selection: This is used to build the menu options.
+<b>selection</b>: This is used to build the menu options.
 There are two ways to use this, the first is to use an array of strings containing the menu options a person can select; the second is to pull from a database table, to do this pass a hash with the key being the name of the model and it's value being the field containing it's name
 
-default: This is used to give the menu a default selection for when the user has not selected anything. Pass a string containing the name of the defualt selection, if no string is passed then the first item from selection is used.
+<b>Default</b>: This is used to give the menu a default selection for when the user has not selected anything. Pass a string containing the name of the default selection, if no string is passed then the first item from selection is used.
+
+<b>prefix</b>: This is used when you have a prefix before the target in the URL, eg: if your links render out as "host.com/books" without a prefix; with a prefix of 'shelf' it will render out as "host.com/shelf/books". Namespacing is ignored within this gem, it only looks at the controller's name and nothing else when controller matching.
 
-prefix: This is used when you have a prefix before the target in the url, eg: if your links render out as "host.com/books" without a prefix; with a prefix of 'shelf' it will render out as "host.com/shelf/books". This is not for namespacing, for namespacing see the namespace option.
+<b>controller</b>: This is used to match the menu to a controller, when deciding which menu to render, it can also be an array of strings; it matches this attribute to the current controller.
 
-namespace: This is used for when you have namespacing. It works like prefix however unlike prefix it will also search for the controller within the namespace unlike prefix which doesn't.
+<b>by_id</b>: This is used when you are using a database model to build the menu and you want to link with IDs rather then the selection list. To use it simply set it to true.
 
-controller: This is used to match the menu to a controller, when deciding which menu to render, it matches this attribute to the current controller. If you have namespacing, the 'namespace' options MUST be used before the 'controller' option otherwise it won't recognise the namespace
+<b>css_class</b>: This is used when you want to hard code the CSS class selector into the menu rather then from the view.
 
-by_id: This is used when you are using a database model to build the menu and you want to link with IDs rather then the selection list. To use it simply set it to true.
+<b>css_selected</b>: the css override for the selected that's currently selected. if no override is passed then the link is simply not rendered out, as with css_class it overrides the one passed in the view, but only for the selected link
 
 examples:
 
 ===Building menu object from scratch
 The default option doesn't have to be the first in the selection list.
-  NAVGATE = Navgate.new do |build|
-    build.navs = [ Navgate::Builder.new do |options|
+  NavGate.configure do |build|
+    build.navs = [ NavGate::Builder.new do |options|
             options[:selection] = %w(selection site_settings users images misc)
             options[:default] = 'users'
-            options[:namespace] = 'admin'
+            options[:prefix] = = 'admin'
             options[:controller] = 'admin_panel'
+            options[:css_class] = 'nav button'
           end
     ]
   end
 
 ===Building menu object from database fields
-Be sure to pass it as {model_name: :field}
+Be sure to pass it as {model_name: :field}.
+Also note you can pass an array of controllers as well as just a string of one controller which in this case is done via a split command, %w() also works
 
-  NAVGATE = Navgate.new do |build|
-     build.navs = [ Navgate::Builder.new do |options|
+  NavGate.configure do |build|
+     build.navs = [ NavGate::Builder.new do |options|
                     options[:selection] = {categories: :title }
                     options[:prefix] = 'shop_category'
-                    options[:controller] = 'front_page'
+                    options[:controller] = "front_page side_page about_page".split(" ")
                     options[:by_id] = true
                   end
     ]
   end
+===Building multiple menus
 
+  NavGate.configure do |build|
+    build.navs = [
+          NavGate::Builder.new do |options|
+            options[:selection] = %w(selection site_settings users images misc)
+            options[:default] = 'users'
+            options[:prefix] = = 'admin'
+            options[:controller] = 'admin_panel'
+            options[:css_class] = 'nav button'
+          end,
+          NavGate::Builder.new do |options|
+            options[:selection] = %w(welcome about_us gallery news)
+            options[:default] = 'news'
+            options[:controller] = 'front_page'
+            options[:css_class] = 'nav button'
+          end
+    ]
+  end
 
 === Using a yml file to build the menu
-There is also a third option to build the menu, you can use a structured yml file, there is an example yaml file in the config dirrectory called "build_menu.yml".
+There is also a third option to build the menu, you can use a structured yml file, there is an example yaml file in the config directory called "build_menu.yml".
 when using this method you are unable to use a database model to create the menu.
 
 ===Building from yaml file,
 Initializing the object:
-  NAVGATE = Navgate.new do |build|
+  NavGate.configure do |build|
     build.navs = "#{Rails.root}/config/build_menu.yml"
   end
+
 The yaml file:
   nav_1:
     selection: welcome about_us gallery
     default: welcome
     prefix: main
-    namespace: front_end
     controller: front_page
   nav_2:
     selection: settings users misc
     default: settings
-    namespace: back_end
+    preix: back_end
     controller: admin_panel
 
 
+==Ignoring Controllers
+Sometimes you're going to want to ignore controllers that don't any gui. Doing that is simple, when you're building the menu just pass an Array to build like so
+  build.ignoring = ['controllers','to','ignore']
+before or after you pass through the navs.
 
 ==Rendering the menu
 
-To render the menu use the provided helper "render_navigation(options)"
+To render the menu use the provided helper <tt>render_navigation(options)</tt>;
 options is a hash that is used to build any html options you might want such as
-class, it can also take two extra options, 'styling:' and 'wrap:'.
+'class='some_css_class', it can also take two extra options, 'styling:' and 'wrap:'.
 
 ===Options
 
-Styling: This is how the navigation can be styled it can either be ':verticle' or a character that you wish to use for spacing such as '|' or ':' and so on, it can only be verticle or a spaceing character.
+Styling: This is how the navigation can be styled, it can either be ':vertical’ or a character that you wish to use for spacing such as '|' or ':' and so on, it can only be vertical or a spacing character.
+
 Wrap: This allows you to wrap each link in a html tag, wrap can itself take two differant options, either a string containing the tag's name (without "<>", only the tag name) or an Array containing the tag name and it's class.
 
 example:
-  render_navigation({"class" => "'nav button'",styling: :verticle, wrap: ['li','test']}) %>
+  render_navigation({:class => "'nav button'", styling: :vertical, wrap: ['li','test']}) %>
+
+note: There is no point in passing a class here if you have one set when you first build the menu, it will just be overridden,
+unless of course you're using multiple menus and some of them don't have css overides then they will take this option up.
+
+==Using the selection to automatically render a matching partial
+
+naveGATE is set up so you can use it to render out a partial using <tt>@selected</tt>, to do this you have to pass a route param of <tt>:selection</tt>
+in the route, then you can use <tt><%= render @selected %></tt> to automatically select either the default selection or the current selection.
+
+That said you don't have use this feature, it will still route to whatever url you set up as a normal url, but <tt>@selected</tt> won't work without <tt>:selection</tt>
+example:
+
+routes.rb
+  get "/:selection", to: "front_page#index"
+  root to: "front_page#index"
+
+front_page/index.html.erb
+  <%= render @selected %>
+
+resulting url
+  host.com/books
+  host.com/games
+
+routes to the root but the partials rendered would be respectively
+  _books.html.erb
+  _games.html.erb
 
-note: class has to be in "" due to it being a keyword in ruby.

metadata

@@ -1,32 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: navGATE
 version: !ruby/object:Gem::Version
-  version: 0.1.03
+  version: 0.1.3.1
 platform: ruby
 authors:
 - Martin Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies: []
-description: Allows the easy creation of menus with config files
+description: Can create navigation from objects using the nav builder,from database
+  tables or from a yaml file
 email: mbeckerwork@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - lib/navgate.rb
 - lib/navgate/base.rb
+- lib/navgate/builder.rb
+- lib/navgate/main.rb
+- lib/navgate/modules/navgatehelpers.rb
+- lib/navgate/navgatehelpers.rb
+- lib/readme.rdoc
 files:
+- LICENCE/GPL-2
 - Manifest
 - Rakefile
-- app/controller/application_controller.rb
-- app/helpers/application_helper.rb
 - config/build_menu.yml
 - config/initializers/build_menu.rb
 - init.rb
 - lib/navgate.rb
 - lib/navgate/base.rb
+- lib/navgate/builder.rb
+- lib/navgate/main.rb
+- lib/navgate/modules/navgatehelpers.rb
+- lib/navgate/navgatehelpers.rb
+- lib/readme.rdoc
 - navGATE.gemspec
 - readme.rdoc
 homepage: https://github.com/Thermatix/navGATE
@@ -57,5 +67,5 @@ rubyforge_project: navgate
 rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: Allows the easy creation of menus with config files
+summary: Allows the easy creation of navigation with config files
 test_files: []

data/app/controller/application_controller.rb

@@ -1,9 +0,0 @@
-
-class ApplicationController < ActionController::Base
-  before_filter :make_menu
-  def make_menu
-    @navgate = NAVGATE
-    @selected ||= @navgate.select(params)
-  end
-end
-

data/app/helpers/application_helper.rb

@@ -1,5 +0,0 @@
-module ApplicationHelper
-  def render_navigation options = nil
-    @navgate.render_nav(params, options)
-  end
-end