navGATE 0.1.27 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f73da779ffc925061bcf66726faba597354dbf11
-  data.tar.gz: c65d102a4f15a497ae3ed130d689e23b00bc599c
+  metadata.gz: 5ada5671816dee12818283700eab608eda32282f
+  data.tar.gz: e28d7ab056f6631082a2548f63ada796f3cbe518
 SHA512:
-  metadata.gz: b07cf5303080aea9ba3415ac110183289afb5daa1ce2036fe75cc099144c505cb123927110a23b7b47b5cf193054d40ffe8de85f8d6e3f58cfc82b0efee4c83c
-  data.tar.gz: 581b0cad6e45eca0328a4d0f34d8abe5a81afc827334fbac6ba8d198709c7641bc3d3598b8ae41eb0a693fd7b8e48e10bab166f9b660c0a3c8b42cb427fa5164
+  metadata.gz: 1623f128d731430174efac02e16a3d248bae214bee99803b35202f90f19ab440866adaf13d8876a0c0a810a24fb286f964f409ed593d9094218cd9cdb88ffb86
+  data.tar.gz: b3ebe60acba3ac04ca4170d3f6bba54a978d6c3f54cdc9714bd5e5333a8c0ecb83ce7c4c8c67fc574776165845385c1abc23e727584a09d5e399e3b370465ba8

data/Manifest

@@ -6,7 +6,9 @@ config/initializers/build_menu.rb
 init.rb
 lib/navgate.rb
 lib/navgate/base.rb
-lib/navgate/navgatehelpers.rb
+lib/navgate/builder.rb
+lib/navgate/main.rb
+lib/navgate/modules/navgatehelpers.rb
 lib/readme.rdoc
 navGATE.gemspec
 readme.rdoc

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'echoe'
 
 
-Echoe.new('navGATE','0.1.27') do |p|
+Echoe.new('navGATE','0.1.30') do |p|
   p.summary = "Allows the easy creation of navigation with config files"
   p.description = "Can create navigation from objects using the nav builder,from database tables or from a yaml file"
   p.url = "https://github.com/Thermatix/navGATE"

data/lib/navgate.rb

@@ -1,187 +1,58 @@
+Dir[File.dirname(__FILE__) + '/navgate/modules/*.rb'].each {|file| require file }
 require 'navgate/base'
-require 'navgate/navgatehelpers'
-require 'awesome_print'
-class Navgate
-  class Builder < Base
+require 'navgate/builder'
+require 'navgate/main'
 
-    def render_it_with(options,selected)
-      options_to_render = ""
-      if self.css_class
-        if options && options[:class]
-          options[:class] = self.css_class
-        else
-          options = { class: self.css_class}
-        end
-      end
-      if options
-        options.each do |key,value|
-          options_to_render += ("#{key}='#{value}'" + " ") unless ignoring key
-        end
-      end
-      style = styling(options)
-      @text_to_render = ""
-      selected.gsub!('/',"")
-      if !self.by_id
-        self.selection.each do |select|
-          @text_to_render += select_text_for(select,selected,options[:wrap],options_to_render,style)
-        end
-      else
-        self.selection.each_with_index do |select,i|
-          @text_to_render += select_text_for(select,selected,options[:wrap],options_to_render,style,i)
-        end
-      end
-      @text_to_render
-    end
-
-    private
-      def select_text_for select, selected, wrap, options_to_render, style, id=nil
-        return_temp = ""
-        wrap_with(wrap) do
-          if select != id &&  select != selected
-            return_temp = generate_text(select,options_to_render,style,id)
-          else
-            if self.css_selected
-              if options_to_render =~ /class='.*'/
-                temp = options_to_render.gsub(/class='.*'/,"class='#{self.css_selected}'")
-                return_temp = generate_text(select,temp,style,id)
-              else
-                temp = options_to_render + "class='#{self.css_selected}'"
-                return_temp = generate_text(select,temp,style,id)
-              end#select which version to use
-            else
-              return_temp = ""
-            end #render nothing or css_selected
-          end #for select if
-        end #for wrap method
-        return_temp
-      end #for method
-      def generate_text(select,options_to_render,style,id = nil)
-        "<a href=\"#{path_for(id || select)}\" #{options_to_render}>#{select.gsub('_'," ")}</a>#{style}"
-      end
-      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.prefix
-          return "/#{self.prefix}/#{link_to.downcase}"
-        else
-          return "/#{link_to.downcase}"
-        end
-      end
-
-      def styling options
-        if options
-          return "<br>" if options[:styling] == :vertical
-          return options[:styling] if options[:styling]
-        end
-        " "
-      end
-
-      def ignoring k
-         [:styling,:wrap].include?(k)
-      end
+module NavGate
 
+  class << self
+    attr_accessor :configuration
   end
 
-  attr_accessor :controllers, :navs, :ignoring
-
-  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[:prefix] = menu[1]['prefix'] || nil
-                    options[:controller] = menu[1]['controller'] || nil
-                    options[:by_id] = menu[1]['by_id'] || nil
-                    options[:css_class] = menu[1]['css_class'] || nil
-                  end
-                )
-      end
-      self.navs = temp
-    end
-    self.ignoring ||= [""]
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    self.configuration.post_setup
   end
 
+  class Configuration
+    attr_accessor :controllers, :navs, :ignoring
 
+    def initialize
+      self.controllers = Rails.application.routes.routes.map do |route|
+        route.defaults[:controller]
+      end.uniq.compact
 
-
-
-  def select selection, controller
-    split_controller = controller.split('/').last
-    if selection
-       selection
-    else
-      if ignoring.include?(split_controller)
-        nil
-      else
-       nav_cache(split_controller).default.to_s
-       end
     end
-  end
 
-  def render_nav selection, controller, options
-    split_controller = controller.split('/').last
-    if ignoring.include?(split_controller)
-      nil
-    else
-      nav = nav_cache(split_controller).render_it_with(options,selection).html_safe
-      nav
+    def post_setup
+      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[:prefix] = menu[1]['prefix'] || nil
+                      options[:controller] = menu[1]['controller'] || nil
+                      options[:by_id] = menu[1]['by_id'] || nil
+                      options[:css_class] = menu[1]['css_class'] || nil
+                    end
+                  )
+        end
+        self.navs = temp
+      end
+      self.ignoring ||= [""]
     end
-  end
 
-  private
+    private
 
-    def nav_cache controller
-      if @selected_nav
-        if @selected_nav.controller.is_a?(Array)
-          return @selected_nav if @selected_nav.controller.include?(controller)
-        else
-          return @selected_nav unless @selected_nav.controller != controller
-        end
-        @selected_nav = nil
-        nav_cache(controller)
-      else
-        @selected_nav ||= select_nav(controller)
+      def not_bad_type? navs
+        navs.is_a?(String) || navs.map{ |n| n.is_a?(NavGate::Builder)}.any?
       end
-    end
 
-    def select_nav controller
-      nav_to_return = nil
-      self.navs.each do |nav|
-        if nav.controller.is_a?(String)
-          nav_to_return = nav if (nav.controller) == controller
-        elsif nav.controller.is_a?(Array)
-          nav_to_return = nav if nav.controller.include?(controller)
-        else
-          raise TypeError, "expecting nav.controller to be a String or an Array, got #{nav.controller.class} "
-        end
-      end
-      nav_to_return ?  (return nav_to_return) : (raise ArgumentError, "No matching controllers for #{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

@@ -1,32 +1,33 @@
-class Base
-  attr_accessor :selection, :default, :prefix, :controller,  :by_id, :css_class, :css_selected
+module NavGate
+  class Base
+    attr_accessor :selection, :default, :prefix, :controller,  :by_id, :css_class, :css_selected
 
-  def initialize(&block)
-    options = {selection: nil,default: nil, controller: nil, css_class: nil, css_selected: nil}
-    yield(options)
-    self.selection = pull_data(options[:selection])
-    self.default = options[:default] || self.selection.first
-    self.prefix = options[:prefix]
-    self.controller = options[:controller]
-    self.by_id = pull_data({options[:selection].to_a.first.first => :id }) if options[:by_id]
-    self.css_class = options[:css_class]
-    self.css_selected = options[:css_selected]
-  end
-  private
-    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))
+    def initialize(&block)
+      options = {selection: nil,default: nil, controller: nil, css_class: nil, css_selected: nil}
+      yield(options)
+      self.selection = pull_data(options[:selection])
+      self.default = options[:default] || self.selection.first
+      self.prefix = options[:prefix]
+      self.controller = options[:controller]
+      self.by_id = pull_data({options[:selection].to_a.first.first => :id }) if options[:by_id]
+      self.css_class = options[:css_class]
+      self.css_selected = options[:css_selected]
+    end
+    private
+      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
-      else
-        raise TypeError, " Selection was a #{selection.class}, expecting a (Array,Hash)"
+        output
       end
-      output
-    end
-
+  end
 end

data/lib/navgate/builder.rb

@@ -0,0 +1,96 @@
+module NavGate
+  class Builder < Base
+
+    def render_it_with(options,selected)
+      options_to_render = ""
+      if self.css_class
+        if options && options[:class]
+          options[:class] = self.css_class
+        else
+          options = { class: self.css_class}
+        end
+      end
+      if options
+        options.each do |key,value|
+          options_to_render += ("#{key}='#{value}'" + " ") unless ignoring key
+        end
+      end
+      style = styling(options)
+      @text_to_render = ""
+      selected.gsub!('/',"")
+      if !self.by_id
+        self.selection.each do |select|
+          @text_to_render += select_text_for(select,selected,options[:wrap],options_to_render,style)
+        end
+      else
+        self.selection.each_with_index do |select,i|
+          @text_to_render += select_text_for(select,selected,options[:wrap],options_to_render,style,i)
+        end
+      end
+      @text_to_render
+    end
+
+    private
+      def select_text_for select, selected, wrap, options_to_render, style, id=nil
+        return_temp = ""
+        wrap_with(wrap) do
+          if select != id &&  select != selected
+            return_temp = generate_text(select,options_to_render,style,id)
+          else
+            if self.css_selected
+              if options_to_render =~ /class='.*'/
+                temp = options_to_render.gsub(/class='.*'/,"class='#{self.css_selected}'")
+                return_temp = generate_text(select,temp,style,id)
+              else
+                temp = options_to_render + "class='#{self.css_selected}'"
+                return_temp = generate_text(select,temp,style,id)
+              end#select which version to use
+            else
+              return_temp = ""
+            end #render nothing or css_selected
+          end #for select if
+        end #for wrap method
+        return_temp
+      end #for method
+      def generate_text(select,options_to_render,style,id = nil)
+        "<a href=\"#{path_for(id || select)}\" #{options_to_render}>#{select.gsub('_'," ")}</a>#{style}"
+      end
+      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.prefix
+          return "/#{self.prefix}/#{link_to.downcase}"
+        else
+          return "/#{link_to.downcase}"
+        end
+      end
+
+      def styling options
+        if options
+          return "<br>" if options[:styling] == :vertical
+          return options[:styling] if options[:styling]
+        end
+        " "
+      end
+
+      def ignoring k
+         [:styling,:wrap].include?(k)
+      end
+
+  end
+end

data/lib/navgate/main.rb

@@ -0,0 +1,60 @@
+module NavGate
+  class Navigation
+    def self.select selection, controller
+      split_controller = controller.split('/').last
+      if selection
+         selection
+      else
+        if config.ignoring.include?(split_controller)
+          nil
+        else
+         nav_cache(split_controller).default.to_s
+         end
+      end
+    end
+
+    def self.render_nav selection, controller, options
+      split_controller = controller.split('/').last
+      if config.ignoring.include?(split_controller)
+        nil
+      else
+        nav = nav_cache(split_controller).render_it_with(options,selection).html_safe
+        nav
+      end
+    end
+
+    private
+
+      def self.config
+        NavGate.configuration
+      end
+
+      def self.nav_cache controller
+        if @selected_nav
+          if @selected_nav.controller.is_a?(Array)
+            return @selected_nav if @selected_nav.controller.include?(controller)
+          else
+            return @selected_nav unless @selected_nav.controller != controller
+          end
+          @selected_nav = nil
+          nav_cache(controller)
+        else
+          @selected_nav ||= select_nav(controller)
+        end
+      end
+
+      def self.select_nav controller
+        nav_to_return = nil
+        config.navs.each do |nav|
+          if nav.controller.is_a?(String)
+            nav_to_return = nav if (nav.controller) == controller
+          elsif nav.controller.is_a?(Array)
+            nav_to_return = nav if nav.controller.include?(controller)
+          else
+            raise TypeError, "expecting nav.controller to be a String or an Array, got #{nav.controller.class} "
+          end
+        end
+        nav_to_return ?  (return nav_to_return) : (raise ArgumentError, "No matching controllers for #{controller}")
+      end
+  end
+end

data/lib/navgate/modules/navgatehelpers.rb

@@ -0,0 +1,26 @@
+module NavGate
+  module NavGateHelpers
+    def NavGateHelpers.included(mod)
+      if Module.const_get("Rails").is_a?(Module).inspect
+        #with rails
+        def make_menu
+          @navgate = NavGate::Navigation
+          @selected ||= @navgate.select(params[:selection], params[:controller])
+        end
+        def render_navigation options = nil
+          @navgate.render_nav((params[:selection]||request.fullpath), params[:controller], options )
+        end
+      else
+        #without rails
+        def make_menu selection, controller
+          @navgate = NavGate::Navigation
+          @selected ||= @navgate.select(selection, controller)
+        end
+        def render_navigation controller, options = nil
+          @navgate.render_nav( @selected , controller, options )
+        end
+      end
+    end
+  end
+end
+

data/navGATE.gemspec

@@ -2,20 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = "navGATE"
-  s.version = "0.1.27"
+  s.version = "0.1.30"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Becker"]
-  s.date = "2013-11-01"
+  s.date = "2014-01-13"
   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", "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/navgatehelpers.rb", "lib/readme.rdoc", "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/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/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 navigation with config files"
-  s.license = 'GLP-2'
 end

data/readme.rdoc

@@ -12,7 +12,7 @@ This gem was built with Rails in mind.
 lastly the gem is up on rubygems.org
 
 ==Setup
-in the Application controller you have to <tt> include NavGateHelpers </tt> first.
+in the Application controller you have to <tt> include NavGate::NavGateHelpers </tt> first.
 
 ===For Rails
 You next have to add a before_filter and helper method to the application controller
@@ -38,7 +38,7 @@ When building the menu there are multiple options available, building the menu i
 
 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
 
 <b>selection</b>: This is used to build the menu options.
@@ -60,8 +60,8 @@ 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[:prefix] = = 'admin'
@@ -75,8 +75,8 @@ The default option doesn't have to be the first in the selection list.
 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 side_page about_page".split(" ")
@@ -86,16 +86,16 @@ Also note you can pass an array of controllers as well as just a string of one c
   end
 ===Building multiple menus
 
-  NAVGATE = Navgate.new do |build|
+  NavGate.configure do |build|
     build.navs = [
-          Navgate::Builder.new do |options|
+          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|
+          NavGate::Builder.new do |options|
             options[:selection] = %w(welcome about_us gallery news)
             options[:default] = 'news'
             options[:controller] = 'front_page'
@@ -110,9 +110,10 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: navGATE
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.1.30
 platform: ruby
 authors:
 - Martin Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies: []
 description: Can create navigation from objects using the nav builder,from database
   tables or from a yaml file
@@ -18,7 +18,9 @@ extensions: []
 extra_rdoc_files:
 - lib/navgate.rb
 - lib/navgate/base.rb
-- lib/navgate/navgatehelpers.rb
+- lib/navgate/builder.rb
+- lib/navgate/main.rb
+- lib/navgate/modules/navgatehelpers.rb
 - lib/readme.rdoc
 files:
 - LICENCE/GPL-2
@@ -29,13 +31,14 @@ files:
 - init.rb
 - lib/navgate.rb
 - lib/navgate/base.rb
-- lib/navgate/navgatehelpers.rb
+- lib/navgate/builder.rb
+- lib/navgate/main.rb
+- lib/navgate/modules/navgatehelpers.rb
 - lib/readme.rdoc
 - navGATE.gemspec
 - readme.rdoc
 homepage: https://github.com/Thermatix/navGATE
-licenses:
-- GLP-2
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:

data/lib/navgate/navgatehelpers.rb

@@ -1,24 +0,0 @@
-module NavGateHelpers
-  def NavGateHelpers.included(mod)
-    if Module.const_get("Rails").is_a?(Module).inspect
-      #with rails
-      def make_menu
-        @navgate = NAVGATE
-        @selected ||= @navgate.select(params[:selection], params[:controller])
-      end
-      def render_navigation options = nil
-        @navgate.render_nav((params[:selection]||request.fullpath), params[:controller], options )
-      end
-    else
-      #without rails
-      def make_menu selection, controller
-        @navgate = NAVGATE
-        @selected ||= @navgate.select(selection, controller)
-      end
-      def render_navigation controller, options = nil
-        @navgate.render_nav( @selected , controller, options )
-      end
-    end
-  end
-end
-