navi 0.0.2 → 0.0.6

data/Gemfile

@@ -5,10 +5,17 @@ gem "activesupport", ">= 3.0.0"
 gem "activerecord", ">= 3.0.0"
 gem "ordered_tree", "0.1.2"
 
-# Comment out group block first because cucumber features were complaining that
-# These gems didn't exist, even if the group included the cucumber/test
-# group! `bundle exec guard` doesn't work!
-#group :development, :test, :cucumber do
+# If you're going to do any development and run any tests, comment out the start
+# and end of the group block
+#   * group :development, :test, :cucumber do
+#   * end
+#
+# If you don't, cucumber features will complaining that
+# these gems didn't exist, even if the group below includes
+# :test and :cucumber environments!
+#
+# Just remember to uncomment them when you publish (or make a pull request).
+group :development, :test, :cucumber do
   gem "rspec", "~> 2.6.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
@@ -38,4 +45,4 @@ gem "ordered_tree", "0.1.2"
   gem 'libnotify'
   gem 'rb-inotify'
   gem 'nifty-generators'
-#end
+end

data/README.textile

@@ -1,21 +1,69 @@
 h1. navigable
 
-*navigable* puts the navigation (aka menu) in the database. That means you and/or your users can edit and control it. It was made with "WordPress' menu editor":http://dl.dropbox.com/u/16150176/until%20dec%202013/wp-menu.png in mind.
+*navi* puts the navigation (aka menu) in the database. That means you and/or your users can edit and control it. It was made with "WordPress' menu editor":http://dl.dropbox.com/u/16150176/until%20dec%202013/wp-menu.png in mind.
+
+Here are a few things to keep in mind:
+
+* navigable - this is the thing in the database, like a Page or a Category, that you've allowed to be added to the navigation (aka menu).
+* navigator - this is the record that may or may not point to the navigable item. This is a database record that represents the navigation item (menu item).
+* renderer - with all the navigables and navigators, the renderer puts it all together and creates the HTML to form the navigation.
 
 h2. Installation
 
-In your Gemfile: @gem 'navigable'@
+This has only been tested with Rails 3.0.x.
+
+In your Gemfile: @gem 'navi'@
 
 h2. Usage
 
-h2. More on renderers
+All navigation items (aka menu items) are database entries. Thus, you should create your own model for this. By default, the model name @navi@ looks for is @nav_item@, so go ahead and make it.
+
+pre. class NavItem < Navi::Navigator::Base
+  # Yup, you don't need to put anything here since most of what you want comes from Navi::Navigator::Base
+  # I'll eventually explain what you can override in the wiki.
+end
+
+Then, whatever you want to be able to become a navigation item in your navigation (menu), add @navigable@ to the class, like we do to @Page@:
+
+pre. class Page < ActiveRecord::Base
+  navigable
+end
+
+With this, Page will get the following instance methods:
+
+pre. @page.to_navigator # initialized a new NavItem instance that can be saved into the database with a .save call on it.
+@page.to_navigator! # initializes and saves the new NavItem, all in one call.
+
+You can pass any of the following arguments, in a form of a hash, into @to_navigator@:
+
+* :label
+* :title
+* :link
+* :highlights_on
+* :parent_id
+* :position
+* any other argument you want saved into the table of @nav_items@ table
+
+_For more information about each item, see the wiki._
+
+h2. Rendering it onto a page
+
+You've got your nav_items all set and you want to render it to the menu. I've created a Renderer - the SimpleNavigation renderer that fetches all the nav_items in the database and renders it on the page using "andi's simple-navigation gem":https://github.com/andi/simple-navigation. This is the default choice. To render stuff into the page, you get the @navi_render@ helper:
+
+pre. <%= navi_render NavItem.roots %>
+
+You must supply an array of top-most items to render. What do I mean? "top-most" means all the root items, for example, or a generation of items. This will render that generation and all their children in a nested @ul@. See @lib/navi/renderers/simple_navigation.rb@ for more info.
+
+You can create your own renderer too. For this, see the wiki. I could add these into the gem. Send me a pull request.
 
 h2. Contributing to navigable
+
+_To develop and run tests, see the Gemfile and read the comments right above the :development, :test, :cucumber group._
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
-* Start a feature/bugfix branch
+* Start a feature/hotfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.6

data/features/create_menu_items.feature

@@ -7,6 +7,7 @@ Feature: So that I can create a menu for my viewers to navigate my site
     Given a page "Home" exists
     And a category "Misc" exists
     And I am on the menu items page
+    And show me the page
     When I create the page "Home" menu item
     Then I should see "Home" in the list of menu items
     When I create the category "Misc" menu item

data/lib/navi/renderers/simple_navigation.rb

@@ -15,13 +15,20 @@ module Navi
       def create_dynamic_items(collection)
         nav = []
         collection.each do |nav_item|
-          nav << {
-            :key => @template.dom_id(nav_item).to_sym,
-            :name => nav_item.label,
-            :url => @template.polymorphic_path(nav_item.link),
-            :options => {:title => nav_item.title, :class => nav_item.class.name.underscore},
-            :items => create_dynamic_items(nav_item.children)
-          }
+          item = {}
+          item[:key] = @template.dom_id(nav_item).to_sym
+          item[:name] = nav_item.label
+          if nav_item.link.is_a?(String)
+            item[:url] = nav_item.link
+          else # it's a database record then!
+            puts "This is the link: #{nav_item.link.inspect}"
+            item[:url] = @template.polymorphic_path(nav_item.link)
+            #item[:url] = "/"
+          end
+          item[:options] = {:title => nav_item.title, :class => nav_item.class.name.underscore}
+          item[:items] = create_dynamic_items(nav_item.children)
+
+          nav << item
         end
         nav
       end

data/navi.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{navi}
-  s.version = "0.0.2"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ramon Tayag"]
@@ -183,34 +183,34 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<ordered_tree>, ["= 0.1.2"])
-      s.add_runtime_dependency(%q<rspec>, ["~> 2.6.0"])
-      s.add_runtime_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_runtime_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_runtime_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency(%q<simple-navigation>, ["= 3.2.0"])
-      s.add_runtime_dependency(%q<inherited_resources>, [">= 0"])
-      s.add_runtime_dependency(%q<guard-rspec>, [">= 0"])
-      s.add_runtime_dependency(%q<libnotify>, [">= 0"])
-      s.add_runtime_dependency(%q<rb-inotify>, [">= 0"])
-      s.add_runtime_dependency(%q<sqlite3>, [">= 0"])
-      s.add_runtime_dependency(%q<rake>, ["= 0.8.7"])
-      s.add_runtime_dependency(%q<apotomo>, ["= 1.1.1"])
-      s.add_runtime_dependency(%q<rails>, ["= 3.0.7"])
-      s.add_runtime_dependency(%q<haml>, [">= 0"])
-      s.add_runtime_dependency(%q<simple-navigation>, ["= 3.2.0"])
-      s.add_runtime_dependency(%q<jquery-rails>, [">= 1.0.3"])
-      s.add_runtime_dependency(%q<rspec-rails>, ["= 2.6.1"])
-      s.add_runtime_dependency(%q<cucumber-rails>, ["= 0.5.2"])
-      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
-      s.add_runtime_dependency(%q<capybara>, [">= 1.0.0.rc1"])
-      s.add_runtime_dependency(%q<database_cleaner>, [">= 0"])
-      s.add_runtime_dependency(%q<launchy>, [">= 0"])
-      s.add_runtime_dependency(%q<machinist>, [">= 0"])
-      s.add_runtime_dependency(%q<faker>, [">= 0"])
-      s.add_runtime_dependency(%q<guard-cucumber>, ["= 0.3.4"])
-      s.add_runtime_dependency(%q<libnotify>, [">= 0"])
-      s.add_runtime_dependency(%q<rb-inotify>, [">= 0"])
-      s.add_runtime_dependency(%q<nifty-generators>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<simple-navigation>, ["= 3.2.0"])
+      s.add_development_dependency(%q<inherited_resources>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<libnotify>, [">= 0"])
+      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_development_dependency(%q<apotomo>, ["= 1.1.1"])
+      s.add_development_dependency(%q<rails>, ["= 3.0.7"])
+      s.add_development_dependency(%q<haml>, [">= 0"])
+      s.add_development_dependency(%q<simple-navigation>, ["= 3.2.0"])
+      s.add_development_dependency(%q<jquery-rails>, [">= 1.0.3"])
+      s.add_development_dependency(%q<rspec-rails>, ["= 2.6.1"])
+      s.add_development_dependency(%q<cucumber-rails>, ["= 0.5.2"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 1.0.0.rc1"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<launchy>, [">= 0"])
+      s.add_development_dependency(%q<machinist>, [">= 0"])
+      s.add_development_dependency(%q<faker>, [">= 0"])
+      s.add_development_dependency(%q<guard-cucumber>, ["= 0.3.4"])
+      s.add_development_dependency(%q<libnotify>, [">= 0"])
+      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_development_dependency(%q<nifty-generators>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_dependency(%q<activerecord>, [">= 3.0.0"])

data/spec/dummy/app/controllers/menu_items_controller.rb

@@ -3,10 +3,6 @@ class MenuItemsController < InheritedResources::Base
     root << widget(:menu_editor)
   end
 
-  def index
-    @simple_navigation = []
-  end
-
   def update
     update! do |success, failure|
       success.html {redirect_to menu_items_path}

data/spec/navi/navigator_spec.rb

@@ -141,8 +141,14 @@ describe MenuItem do
 
   describe "#highlights_on," do
     describe "when the link field is not nil" do
-      it "should return the value converted to regex" do
-        MenuItem.new(:highlights_on => "holy").highlights_on.should == /holy/
+      it "should return the string value converted to regex" do
+        item = MenuItem.create(:highlights_on => "holy")
+        item.highlights_on.should == /holy/
+      end
+
+      it "should return the regexp value if set to regexp" do
+        item = MenuItem.create(:highlights_on => /holy/)
+        item.highlights_on.should == /holy/
       end
     end
 

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ Capybara.default_selector = :css
 
 # Run down then up any available migration in the dummy app
 def migrate(direction)
+  puts "Will migrate #{direction}"
   migration_directory = File.expand_path "../dummy/db/migrate", __FILE__
   migration_files = Dir["#{migration_directory}/[0-9]*_*.rb"]
   migration_files.each {|migration_file| require migration_file} # require them so we can execute them

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: navi
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Ramon Tayag
@@ -67,7 +67,7 @@ dependencies:
   version_requirements: *id003
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -83,7 +83,7 @@ dependencies:
   version_requirements: *id004
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -99,7 +99,7 @@ dependencies:
   version_requirements: *id005
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -115,7 +115,7 @@ dependencies:
   version_requirements: *id006
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -129,7 +129,7 @@ dependencies:
   version_requirements: *id007
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -145,7 +145,7 @@ dependencies:
   version_requirements: *id008
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -159,7 +159,7 @@ dependencies:
   version_requirements: *id009
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -173,7 +173,7 @@ dependencies:
   version_requirements: *id010
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -187,7 +187,7 @@ dependencies:
   version_requirements: *id011
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -201,7 +201,7 @@ dependencies:
   version_requirements: *id012
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -215,7 +215,7 @@ dependencies:
   version_requirements: *id013
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -231,7 +231,7 @@ dependencies:
   version_requirements: *id014
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -247,7 +247,7 @@ dependencies:
   version_requirements: *id015
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -263,7 +263,7 @@ dependencies:
   version_requirements: *id016
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id017 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -277,7 +277,7 @@ dependencies:
   version_requirements: *id017
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id018 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -293,7 +293,7 @@ dependencies:
   version_requirements: *id018
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id019 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -309,7 +309,7 @@ dependencies:
   version_requirements: *id019
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id020 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -325,7 +325,7 @@ dependencies:
   version_requirements: *id020
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id021 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -341,7 +341,7 @@ dependencies:
   version_requirements: *id021
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id022 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -355,7 +355,7 @@ dependencies:
   version_requirements: *id022
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id023 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -373,7 +373,7 @@ dependencies:
   version_requirements: *id023
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id024 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -387,7 +387,7 @@ dependencies:
   version_requirements: *id024
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id025 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -401,7 +401,7 @@ dependencies:
   version_requirements: *id025
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id026 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -415,7 +415,7 @@ dependencies:
   version_requirements: *id026
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id027 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -429,7 +429,7 @@ dependencies:
   version_requirements: *id027
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id028 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -445,7 +445,7 @@ dependencies:
   version_requirements: *id028
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id029 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -459,7 +459,7 @@ dependencies:
   version_requirements: *id029
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id030 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -473,7 +473,7 @@ dependencies:
   version_requirements: *id030
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   requirement: &id031 !ruby/object:Gem::Requirement 
     none: false
     requirements: