navGATE 0.1.02

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e66426dd904e86b05d16a07ca50c75e047bd37d
+  data.tar.gz: b5e25262592f619b2a80224ab5b40afe68f76ec7
+SHA512:
+  metadata.gz: abc92a0bd85c1823e80cb7357062c1db423c4c090f1b414fbf26b97dc764573631c99751af96429a53f0c2233fec403171147720f7882b66fc03fc5a9715ae12
+  data.tar.gz: 37cbcf0c6fd5bb5fba2d1033e657fac1a537fd55c0155004eff4f75b346a0fd114e2108b31d4f188e1a9738f789d6d2b227d09b780db926336a2149e41b04873

data/Manifest

@@ -0,0 +1,11 @@
+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

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+
+Echoe.new('navGATE','0.1.02') do |p|
+  p.description = "Allows the easy creation of menus with config files"
+  p.url = "https://github.com/Thermatix/navGATE"
+  p.author = "Martin Becker"
+  p.email = "mbeckerwork@gmail.com"
+  p.ignore_pattern = []
+  p.development_dependencies =[]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|ext| load ext}

data/app/controller/application_controller.rb

@@ -0,0 +1,9 @@
+
+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

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

data/config/build_menu.yml

@@ -0,0 +1,11 @@
+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
+  controller: admin_panel

data/config/initializers/build_menu.rb

@@ -0,0 +1,26 @@
+require 'navgate'
+#building menu object from scratch
+# NAVGATE = Navgate.new do |build|
+#   build.navs = [ Navgate::Builder.new do |options|
+#           options[:selection] = %w(selection site_settings users images misc)
+#           options[:namespace] = 'admin'
+#           options[:controller] = 'admin_panel'
+#         end
+#   ]
+# end
+#
+#building menu object from database fields be sure to pass it as {Model_name: field}
+# NAVGATE = Navgate.new do |build|
+#    build.navs = [ Navgate::Builder.new do |options|
+#                   options[:selection] = {categories: :title }
+#                   options[:prefix] = 'shop_category'
+#                   options[:controller] = 'front_page'
+#                   options[:by_id] = true
+#                 end
+#   ]
+# end
+#
+#building from yaml file, look through the yaml file for an example
+# NAVGATE = Navgate.new do |build|
+#   build.navs = "#{Rails.root}/config/build_menu.yml"
+# end

data/init.rb

@@ -0,0 +1 @@
+require 'navgate'

data/lib/navgate.rb

@@ -0,0 +1,119 @@
+require 'navgate/base'
+class Navgate
+  class Builder < Base
+
+    def render_it_with(options)
+      options_to_render = ""
+      if options
+        options.each do |key,value|
+          options_to_render += ("#{key}=#{value}" + " ") unless ignoring key
+        end
+      end
+      style = styling(options)
+      @text_to_render = ""
+      if !self.by_id
+        self.selection.each do |select|
+          wrap_with options[:wrap] do
+            @text_to_render += "<a href=\"#{path_for(select)}\" #{options_to_render}>#{select}</a>#{style}"
+          end
+        end
+      else
+        self.selection.each_with_index do |select,i|
+          wrap_with options[:wrap] do
+            @text_to_render += "<a href=\"#{path_for(self.by_id[i])}\" #{options_to_render}>#{select}</a>#{style}"
+          end
+        end
+      end
+      @text_to_render
+    end
+
+    private
+      def wrap_with tag, &block
+        if tag.is_a?(Array)
+          tag_beggining = "#{tag[0]} class='#{tag[1]}'"
+          tag_end = tag[0]
+        else
+          tag_beggining = tag
+          tag_end = tag
+        end
+        if tag
+          @text_to_render += "<#{tag_beggining}>"
+            yield
+          @text_to_render += "</#{tag_end}>"
+        else
+          yield
+        end
+      end
+
+
+
+      def path_for link_to
+        if self.namespace
+          return "/#{self.namespace}/#{link_to}"
+        elsif self.prefix
+          return "/#{self.prefix}/#{link_to}"
+        else
+          return "/#{link_to}"
+        end
+      end
+
+      def styling options
+        if options
+          return "<br>" if options[:styling] == :verticle
+          return options[:styling] if options[:styling]
+        end
+        " "
+      end
+
+      def ignoring k
+         [:styling,:wrap].include?(k)
+      end
+
+  end
+
+  attr_accessor :controllers, :navs
+
+  def initialize
+    self.controllers = Rails.application.routes.routes.map do |route|
+      route.defaults[:controller]
+    end.uniq.compact
+    yield(self)
+    raise TypeError, "Expected Navgate:Builder or string" unless not_bad_type?(self.navs)
+    if self.navs.is_a?(String)
+      setup = YAML.load_file(self.navs)
+      temp = []
+      setup.each do |menu|
+        temp.push(Navgate::Builder.new do |options|
+                    options[:selection] = menu[1]['selection'].split(" ")
+                    options[:default] = menu[1]['default'] || nill
+                    options[:namespace] = menu[1]['namespace'] || nil
+                    options[:prefix] = menu[1]['prefix'] || nil
+                    options[:controller] = menu[1]['controller'] || nil
+                  end
+                )
+      end
+      self.navs = temp
+    end
+  end
+
+
+
+  def render_nav params, options
+    select_nav(params[:controller]).render_it_with(options).html_safe
+  end
+
+  def select params
+    nav = select_nav(params[:controller])
+    return params[:selection] ? params[:selection] : nav.default
+  end
+  private
+    def select_nav controller
+      self.navs.each do |nav|
+          return nav if nav.controller == controller
+      end
+    end
+
+    def not_bad_type? navs
+      navs.is_a?(String) || navs.map{ |n| n.is_a?(Navgate::Builder)}.any?
+    end
+end

data/lib/navgate/base.rb

@@ -0,0 +1,35 @@
+class Base
+  attr_accessor :selection, :default, :namespace, :controller, :prefix, :by_id
+
+  def initialize(&block)
+    options = {selection: nil,default: nil, controller: nil, namespace: nil}
+    yield(options)
+    self.selection = pull_data(options[:selection])
+    self.default = options[:default] || self.selection.first
+    self.namespace = options[:namespace]
+    self.prefix = options[:prefix]
+    self.controller = "#{namespace?}#{options[:controller]}"
+    self.by_id = pull_data({options[:selection].to_a.first.first => :id }) if options[:by_id]
+  end
+  private
+    def namespace?
+      self.namespace ? "#{self.namespace}/" : ""
+    end
+
+    def pull_data selection
+      if selection.is_a?(Array)
+        output = selection
+      elsif selection.is_a?(Hash)
+        output = []
+        selection.each do |key,value|
+          key.to_s.singularize.classify.constantize.all.each do |item|
+            output.push(item.send(value))
+          end
+        end
+      else
+        raise TypeError, " Selection was a #{selection.class}, expecting a (Array,Hash)"
+      end
+      output
+    end
+
+end

data/navGATE.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "navGATE"
+  s.version = "0.1.02"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Becker"]
+  s.date = "2013-10-14"
+  s.description = "Allows the easy creation of menus with config files"
+  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.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"
+end

data/readme.rdoc

@@ -0,0 +1,94 @@
+= 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
+
+note: this is my first gem, I am still trying to set it up, so be carefull when downloading this.
+
+==Building the menu
+
+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.
+
+===Options
+
+selection: 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.
+
+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.
+
+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.
+
+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
+
+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.
+
+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|
+            options[:selection] = %w(selection site_settings users images misc)
+            options[:default] = 'users'
+            options[:namespace] = 'admin'
+            options[:controller] = 'admin_panel'
+          end
+    ]
+  end
+
+===Building menu object from database fields
+Be sure to pass it as {model_name: :field}
+
+  NAVGATE = Navgate.new do |build|
+     build.navs = [ Navgate::Builder.new do |options|
+                    options[:selection] = {categories: :title }
+                    options[:prefix] = 'shop_category'
+                    options[:controller] = 'front_page'
+                    options[:by_id] = true
+                  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".
+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|
+    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
+    controller: admin_panel
+
+
+
+==Rendering the menu
+
+To render the menu use the provided helper "render_navigation(options)"
+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:'.
+
+===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.
+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']}) %>
+
+note: class has to be in "" due to it being a keyword in ruby.

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: navGATE
+version: !ruby/object:Gem::Version
+  version: 0.1.02
+platform: ruby
+authors:
+- Martin Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies: []
+description: Allows the easy creation of menus with config files
+email: mbeckerwork@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- lib/navgate.rb
+- lib/navgate/base.rb
+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
+homepage: https://github.com/Thermatix/navGATE
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- navGATE
+- --main
+- readme.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: navgate
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Allows the easy creation of menus with config files
+test_files: []