cat_router 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,109 @@
+= CatRouter - The most simplistic CMS in the world
+
+CatRouter is a simple router/CMS for displaying dynamic content on your site.
+Buttons with content are defined in the database (using CatRoute model). A click of a button displays it's content (yield).
+
+Copyright (c) 2011 [Kristijan Sedlak], released under the MIT license
+
+
+== Installation (Rails 3 ready)
+
+Add this line to your Gemfile (and run bundle install):
+
+  gem 'cat_router'
+
+Open config/routes.rb and add this to the end
+  
+  # define custom routes CatRouter::Routes.draw action.
+  # scope "(/:locale)" do
+  #   match 'my_slug', :to => "controller#action"
+  # end
+  
+  # CatRouter implementation 
+  CatRouter::Routes.draw
+
+Generate migration 
+
+  rails g cat_router
+  rake db:migrate
+
+Open app/controllers/application_controller.rb and add locale setter like this
+
+  class ApplicationController < ActionController::Base
+    before_filter :set_locale
+  private
+    def set_locale
+      I18n.locale = :en
+      I18n.locale = params[:locale] if params[:locale]
+    end
+  end
+
+The plugin comes with a CatRoute model and CatRouterController. You can append the default model or controller by creating a new 
+app/models/cat_route.rb file with content
+
+  class CatRoute
+  end
+
+or app/controllers/cat_router_controller.rb file with content
+
+  class CatRouterController
+  end
+
+== Examples
+
+-------
+
+You create a route by creating a CatRoute model record:
+
+  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>')
+
+Note that :locale column is set to I18n.locale value by default but you can set it manually:
+
+  myRoute = CatRoute.create(:title => 'Welcome', :html => '<b>welcome</b>', :locale => 'en')
+
+The plugin will auto generate the :slug value but you can set it manually:
+
+  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
+
+  mySubRoute = myRoute.cat_routes.create(:title => 'About', :html => 'about us html')
+
+Records that has slug == '' are root buttons
+
+  rootRoute = CatRoute.create(:title => 'Home', :html => 'home html', :slug => '')
+
+-------
+  
+You can get a list of subbuttons like this
+
+  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(I18n.locale)
+
+You get a root button like this
+
+  rootButton = CatRoute.root_routes.with_locale(I18n.locale).first
+  
+You get a button by slug like this
+
+  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).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|
+     = link_to b.title, b.url, :class => b.slug == @cat_route.slug || b.id == @cat_route.parent_id ? 'selected' : ''
+ 

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the cat_router plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the cat_router plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CatRouter'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/cat_router/routes.rb

@@ -0,0 +1,13 @@
+module CatRouter
+  module Routes
+
+    def self.draw
+      Rails.application.routes.draw do
+        match "/:locale(/*slug(.:extension))", :as => :cat_router, :to => 'cat_router#router', :constraints => { :locale => /[a-z]{2,2}/ }
+        root :to => "cat_router#router"
+      end
+
+    end
+
+  end
+end

data/lib/cat_router/version.rb

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

data/lib/cat_router.rb

@@ -0,0 +1,14 @@
+module CatRouter
+end
+
+[ File.join(File.dirname(__FILE__), 'cat_router', 'routes.rb'),
+  File.join(File.dirname(__FILE__), 'cat_router', 'version.rb'),
+  File.join(File.dirname(__FILE__), '..', 'app', 'models', 'cat_route.rb'),
+  File.join(File.dirname(__FILE__), '..', 'app', 'controllers', 'cat_router_controller.rb'),
+  File.join(Rails.root, 'app', 'models', 'cat_route.rb'),
+  File.join(Rails.root, 'app', 'controllers', 'cat_router_controller.rb')
+].each do |path|
+  if File.exists?(path)
+    require path 
+  end
+end

data/lib/generators/cat_router_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CatRouterGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+     "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/cat_router_migration.rb'
+  end
+  
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,20 @@
+class CatRouterMigration < ActiveRecord::Migration
+  def self.up
+    create_table :cat_routes do |t|
+      t.string :locale
+      t.string :title
+      t.string :slug
+      t.text :html
+      t.integer :parent_id
+      t.timestamps
+    end
+
+    add_index :cat_routes, :locale
+    add_index :cat_routes, :slug
+    add_index :cat_routes, [:locale, :slug]
+  end
+
+  def self.down
+    drop_table :cat_routes
+  end
+end

data/test/cat_router_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CatRouterTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: cat_router
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristijan Sedlak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-06 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A simple router/CMS for displaying dynamic content on your site.
+email: xpepermint@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- Rakefile
+- lib/cat_router/routes.rb
+- lib/cat_router/version.rb
+- lib/cat_router.rb
+- lib/generators/cat_router_generator.rb
+- lib/generators/templates/migration.rb
+- test/cat_router_test.rb
+- test/test_helper.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/xpepermint/cat_router
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: CatRouter - The most simplistic CMS in the world.
+test_files: []
+