cat_router 0.1.7 → 0.1.8

data/README.rdoc

@@ -8,6 +8,8 @@ Copyright (c) 2011 [Kristijan Sedlak], released under the MIT license
 
 == Installation (Rails 3 ready)
 
+NOTE: If you are upgrading please recreate the database table!
+
 Add this line to your Gemfile (and run bundle install):
 
   gem 'cat_router'
@@ -45,35 +47,38 @@ app/models/cat_route.rb file with content
 
 -------
 
-You create a route by creating a CatRoute model record:
+First you create a root button. By default :locale is set to value of I18n.locale and :domain is not set 
+(which means the route is defined for all domains).
 
-  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>')
+  rootRoute = CatRoute.create(:slug => ':root', :title => 'Home', :html => 'This is my home content.')
+  rootRoute = CatRoute.create(:slug => ':root', :title => 'Home', :html => 'This is my home content.', :locale => 'en')
+  rootRoute = CatRoute.create(:slug => ':root', :title => 'Home', :html => 'This is my home content.', :locale => 'en', :domain => 'mydomain.com')
 
-Note that :locale column is set to I18n.locale value by default but you can set it manually:
+You can then create a route for the main menu.
 
-  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>', :locale => 'en')
+  myRoute = CatRoute.create(:title => 'About us', :html => '<b>This is the about page.</b>')
 
-The plugin will auto generate the :slug value but you can set it manually:
+The plugin will automatically generate the :slug value but you can set it manually.
 
-  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>', :slug => 'home/first_page', :domain => 'mydomain.com')
+  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>', :slug => 'home/first_page')
 
-If you would like to create a subroute (a sub button of myRoute) you would do it like this
+You can also create a subroute (a sub button of myRoute).
 
   mySubRoute = myRoute.cat_routes.create(:title => 'About', :html => 'about us html')
 
-Records that has slug == '' are root buttons
+You can also create a button that redirects to some external website.
 
-  rootRoute = CatRoute.create(:title => 'Home', :html => 'home html', :slug => '')
+  myRoute = CatRoute.create(:slug => ':redirect_to', :html => 'http://lotterade.com', :title => 'Home')
 
 -------
   
-You can get a list of subbuttons like this
+You can get a list of subbuttons
 
   mySubRoutes = CatRoute.find(13).cat_routes
 
 To get the list of main buttons for your main menu, you will use
 
-  mainButtons = CatRoute.base_routes.with_locale('en').with_domain('mydomain.com')
+  mainButtons = CatRoute.base_routes.with_locale('en').with_or_no_domain('mydomain.com')
 
 You get a root button like this
 
@@ -85,17 +90,23 @@ You get a button by slug like this
 
 -------
 
+You can reorder the default order of buttons by setting the order column
+
+  button = CatRoute.with_slug('about/our_business').first
+  
+-------
+
 The @cat_route variable is also available (defined inside CatRoutesController) which holds the current route record.
 
 Using HAML you will define a main-menu like this
 
   .mainmenu
-   - CatRoute.base_routes.with_locale(I18n.locale).with_domain(request.host).each do |b|
+   - CatRoute.base_routes.with_locale(I18n.locale).with_or_no_domain(request.host).ordered.each do |b|
      = link_to b.title, b.url, :class => b.slug == @cat_route.slug || b.id == @cat_route.parent_id ? 'selected' : ''
 
 and a sub-menu like this
 
   .submenu
-   - @cat_route.cat_routes_or_neighbours.each do |b|
+   - @cat_route.cat_routes_or_neighbours.ordered.each do |b|
      = link_to b.title, b.url, :class => b.slug == @cat_route.slug || b.id == @cat_route.parent_id ? 'selected' : ''
  

data/app/models/cat_route.rb

@@ -4,9 +4,11 @@ class CatRoute < ActiveRecord::Base
   
   scope :with_locale, lambda{|locale| where('locale=?', locale) }
   scope :with_domain, lambda{|domain| where('domain=?', domain) }
-  scope :base_routes, where('parent_id IS NULL')
-  scope :root_routes, where('slug=""')
+  scope :with_or_no_domain, lambda{|domain| where('domain=? OR domain=""', domain) }
+  scope :base_routes, where('parent_id=0')
+  scope :root_routes, where('slug=":root"')
   scope :with_slug, lambda{|slug| where('slug=?', slug) }
+  scope :ordered, order('`order`')
   
   before_validation :set_locale
   before_validation :set_slug
@@ -16,7 +18,10 @@ class CatRoute < ActiveRecord::Base
   validates :locale, 
             :presence => true
   validates :slug, 
-            :uniqueness => { :scope => [:domain, :locale] }
+            :uniqueness => { :scope => [:locale] }
+  validates :parent_id,
+            :presence => true,
+            :numericality => true
   
   def url
     if self.slug == ':redirect_to'
@@ -43,9 +48,9 @@ class CatRoute < ActiveRecord::Base
   end
   
   def set_slug
-    if self.slug.nil?
+    if self.slug.blank?
       self.slug = ''
-      if self.parent_id.present?
+      if self.parent_id > 0
         parent_route = CatRoute.find(self.parent_id)
         self.slug = CatRoute.slug_string(parent_route.title)+'/' if parent_route.present?
       end
@@ -54,7 +59,7 @@ class CatRoute < ActiveRecord::Base
   end
 
   def self.slug_string(string)
-    string.downcase.gsub(' ', '_')
+    string.downcase.gsub(' ', '_').gsub(',', '_').gsub('.', '_').gsub('-', '_')
   end
   
 end

data/lib/cat_router/instance_methods.rb

@@ -1,12 +1,12 @@
 module CatRouter::InstanceMethods
   
   def set_locale
-    I18n.locale = :sl
+    I18n.locale = :en
     I18n.locale = params[:locale] if params[:locale]
   end
   
   def load_cat_route
-    @cat_route = CatRoute.with_slug(params[:slug] ? params[:slug] : '').with_domain(request.host).first
+    @cat_route = CatRoute.with_slug(params[:slug] ? params[:slug] : ':root').with_or_no_domain(request.host).first
   end
   
   def handle_cat_routes

data/lib/cat_router/version.rb

@@ -2,7 +2,7 @@ module CatRouter
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY  = 7
+    TINY  = 8
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/generators/templates/migration.rb

@@ -1,20 +1,23 @@
 class CatRouterMigration < ActiveRecord::Migration
   def self.up
     create_table :cat_routes do |t|
-      t.string :locale
-      t.string :domain
-      t.string :title
-      t.string :slug
-      t.text :html
-      t.integer :parent_id
+      t.string :locale, :null => false, :default => 'en'
+      t.string :domain, :null => false, :default => ''
+      t.string :title, :null => false, :default => ''
+      t.string :slug, :null => false, :default => ''
+      t.text :html, :null => false, :default => ''
+      t.integer :parent_id, :null => false, :default => 0
+      t.integer :order, :null => false, :default => 1
       t.timestamps
     end
 
     add_index :cat_routes, :domain
     add_index :cat_routes, :locale
     add_index :cat_routes, :slug
+    add_index :cat_routes, :order
     add_index :cat_routes, [:domain, :locale]
     add_index :cat_routes, [:domain, :locale, :slug]
+    add_index :cat_routes, [:domain, :locale, :slug, :order]
   end
 
   def self.down

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cat_router
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Kristijan Sedlak