navi 0.0.17 → 0.1.3

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Ignore cucumber's rerun file
+rerun.txt
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+*.sw*
+
+# ignore some stuff in the included dummy app
+spec/dummy/db/*.sql
+spec/dummy/db/*.sqlite3
+spec/dummy/log

data/.rvmrc

@@ -1 +1 @@
-rvm @navi
+rvm use ruby-1.9.2-p290@navi --create

data/Gemfile

@@ -1,48 +1,3 @@
 source "http://rubygems.org"
 
-# These gems are the only ones that this gem needs
-gem "activesupport", ">= 3.0.0"
-gem "activerecord", ">= 3.0.0"
-gem "ordered_tree", ">= 0.1.6"
-
-# 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"
-  gem "rcov", ">= 0"
-  gem "simple-navigation", "3.2.0"
-  gem 'inherited_resources'
-  gem 'guard-rspec'
-  gem 'libnotify'
-  gem 'rb-inotify'
-  gem 'sqlite3'
-  # force the use of rake version, because of http://stackoverflow.com/questions/6199301/global-access-to-rake-dsl-methods-is-deprecated
-  gem 'rake', '0.8.7' 
-  gem 'apotomo', '1.1.1'
-  gem 'rails', '3.0.7'
-  gem 'haml'
-  gem 'simple-navigation', '3.2.0'
-  gem 'jquery-rails', '>= 1.0.3'
-  gem 'rspec-rails', '2.6.1'
-  gem 'cucumber-rails', '0.5.2'
-  gem 'cucumber'
-  gem 'capybara', ">= 1.0.0.rc1"
-  gem 'database_cleaner'
-  gem 'launchy'
-  gem 'machinist'
-  gem 'faker'
-  gem 'guard-cucumber', '0.3.4'
-  gem 'libnotify'
-  gem 'rb-inotify'
-  gem 'nifty-generators'
-end
+gemspec

data/Gemfile.lock

@@ -1,54 +1,63 @@
+PATH
+  remote: .
+  specs:
+    navi (0.1.0)
+      activerecord (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      ordered_tree (>= 0.1.6)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.7)
-      actionpack (= 3.0.7)
-      mail (~> 2.2.15)
-    actionpack (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-    activesupport (3.0.7)
-    apotomo (1.1.1)
-      cells (~> 3.5.6)
-      hooks (~> 0.1.3)
+    actionmailer (3.2.1)
+      actionpack (= 3.2.1)
+      mail (~> 2.4.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    apotomo (1.2.2)
+      cells (>= 3.6.7)
+      hooks (~> 0.2.0)
       onfire (~> 0.2.0)
-      rails (~> 3.0)
-    arel (2.0.10)
-    builder (2.1.2)
-    capybara (1.0.0.rc1)
+    archive-tar-minitar (0.5.2)
+    arel (3.0.0)
+    builder (3.0.0)
+    capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
-      selenium-webdriver (~> 0.2.0)
+      selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    cells (3.5.6)
-      actionpack (~> 3.0.0)
-      railties (~> 3.0.0)
-    childprocess (0.1.9)
+    cells (3.8.1)
+      actionpack (~> 3.0)
+      railties (~> 3.0)
+    childprocess (0.3.1)
       ffi (~> 1.0.6)
-    configuration (1.2.0)
-    cucumber (0.10.6)
+    columnize (0.3.6)
+    cucumber (0.10.7)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
       gherkin (~> 2.4.0)
@@ -59,16 +68,14 @@ GEM
       cucumber (>= 0.10.5)
       nokogiri (>= 1.4.4)
       rack-test (>= 0.5.7)
-    database_cleaner (0.6.7)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    faker (0.9.5)
-      i18n (~> 0.4)
-    ffi (1.0.9)
-    gherkin (2.4.0)
+    database_cleaner (0.7.1)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.1.2)
+      activesupport
+    ffi (1.0.11)
+    gherkin (2.4.21)
       json (>= 1.4.6)
-    git (1.2.5)
     guard (0.3.4)
       thor (~> 0.14.6)
     guard-cucumber (0.3.4)
@@ -76,62 +83,64 @@ GEM
       guard (~> 0.3.0)
     guard-rspec (0.3.1)
       guard (>= 0.2.2)
-    haml (3.1.2)
-    has_scope (0.5.0)
-    hooks (0.1.4)
-    i18n (0.5.0)
-    inherited_resources (1.2.2)
+    haml (3.1.4)
+    has_scope (0.5.1)
+    hike (1.2.1)
+    hooks (0.2.0)
+    i18n (0.6.0)
+    inherited_resources (1.3.0)
       has_scope (~> 0.5.0)
       responders (~> 0.6.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    jquery-rails (1.0.9)
-      railties (~> 3.0)
+    journey (1.0.1)
+    jquery-rails (2.0.0)
+      railties (>= 3.2.0.beta, < 5.0)
       thor (~> 0.14)
-    json (1.5.1)
-    json_pure (1.5.1)
-    launchy (0.4.0)
-      configuration (>= 0.0.5)
-      rake (>= 0.8.1)
-    libnotify (0.5.5)
-    machinist (1.0.6)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    json (1.6.5)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
+    libnotify (0.7.2)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.4.1)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
     nifty-generators (0.4.6)
-    nokogiri (1.4.4)
+    nokogiri (1.5.0)
     onfire (0.2.0)
-    ordered_tree (0.1.6)
-      activerecord (>= 3.0.0)
-    polyglot (0.3.1)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    ordered_tree (0.2.1)
+      activerecord (>= 3.1.1)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.7)
-      actionmailer (= 3.0.7)
-      actionpack (= 3.0.7)
-      activerecord (= 3.0.7)
-      activeresource (= 3.0.7)
-      activesupport (= 3.0.7)
+    rails (3.2.1)
+      actionmailer (= 3.2.1)
+      actionpack (= 3.2.1)
+      activerecord (= 3.2.1)
+      activeresource (= 3.2.1)
+      activesupport (= 3.2.1)
       bundler (~> 1.0)
-      railties (= 3.0.7)
-    railties (3.0.7)
-      actionpack (= 3.0.7)
-      activesupport (= 3.0.7)
+      railties (= 3.2.1)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    rb-inotify (0.8.5)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rb-inotify (0.8.8)
       ffi (>= 0.5.0)
-    rcov (0.9.9)
-    responders (0.6.4)
+    rdoc (3.12)
+      json (~> 1.4)
+    responders (0.6.5)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -145,20 +154,36 @@ GEM
       activesupport (~> 3.0)
       railties (~> 3.0)
       rspec (~> 2.6.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.2.1)
-      childprocess (>= 0.1.7)
-      ffi (>= 1.0.7)
-      json_pure
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    rubyzip (0.9.5)
+    selenium-webdriver (2.18.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
       rubyzip
     simple-navigation (3.2.0)
       activesupport (>= 2.3.2)
-    sqlite3 (1.3.3)
-    term-ansicolor (1.0.5)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    term-ansicolor (1.0.7)
     thor (0.14.6)
-    treetop (1.4.9)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.27)
+    tzinfo (0.3.31)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -166,31 +191,26 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 3.0.0)
-  activesupport (>= 3.0.0)
-  apotomo (= 1.1.1)
+  apotomo (~> 1.2.2)
   bundler (~> 1.0.0)
   capybara (>= 1.0.0.rc1)
   cucumber
   cucumber-rails (= 0.5.2)
   database_cleaner
-  faker
+  factory_girl (~> 2.1.0)
   guard-cucumber (= 0.3.4)
   guard-rspec
   haml
-  inherited_resources
-  jeweler (~> 1.5.2)
-  jquery-rails (>= 1.0.3)
+  inherited_resources (~> 1.3.0)
+  jquery-rails (~> 2.0.0)
   launchy
   libnotify
-  machinist
+  navi!
   nifty-generators
-  ordered_tree (>= 0.1.6)
-  rails (= 3.0.7)
-  rake (= 0.8.7)
+  rails (~> 3.2.0)
   rb-inotify
-  rcov
   rspec (~> 2.6.0)
-  rspec-rails (= 2.6.1)
+  rspec-rails (~> 2.6.1)
+  ruby-debug19
   simple-navigation (= 3.2.0)
   sqlite3

data/{README.textile → README.md}

@@ -1,6 +1,6 @@
-h1. navigable
+# navigable
 
-*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.
+**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][wordpress_menu_editor_image] in mind.
 
 Here are a few things to keep in mind:
 
@@ -8,33 +8,35 @@ Here are a few things to keep in mind:
 * 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
+# Installation
 
-This has only been tested with Rails 3.0.x.
+The tests run against `Rails 3.2.x` and `Ruby 1.9.2`.
 
-In your Gemfile: @gem 'navi'@
+In your Gemfile:
 
-h2. Usage
+    gem 'navi'
 
-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.
+# Usage
 
-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
+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.
 
-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@:
+    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
 
-pre. class Page < ActiveRecord::Base
-  navigable
-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`:
+
+    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.
+    @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@:
+You can pass any of the following arguments, in a form of a hash, into `to_navigator`:
 
 * :label
 * :title
@@ -42,24 +44,24 @@ You can pass any of the following arguments, in a form of a hash, into @to_navig
 * :highlights_on
 * :parent_id
 * :position
-* any other argument you want saved into the table of @nav_items@ table
+* 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
+# 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:
+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][simple_navigation]. This is the default choice. To render stuff into the page, you get the `navi_render` helper:
 
-pre. <%= navi_render NavItem.roots %>
+    <%= 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 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
+# 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
@@ -68,7 +70,9 @@ _To develop and run tests, see the Gemfile and read the comments right above the
 * 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.
 
-h2. Copyright
+# Copyright
+
+Copyright (c) 2011-2012 Ramon Tayag. See LICENSE.txt for further details.
 
-Copyright (c) 2011 Ramon Tayag. See LICENSE.txt for
-further details.
+[wordpress_menu_editor_image]: http://dl.dropbox.com/u/16150176/until%20dec%202013/wp-menu.png
+[simple_navigation]: https://github.com/andi/simple-navigation