tkh_menus 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# TKH Menus
+
+
+
+## 0.0.1
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.md

@@ -0,0 +1,79 @@
+# TKH Menus
+
+This Rails engine dynamically generates menus. 
+
+Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful. It's meant primarily to be used with other tkh gems and the TKH CMS eco-system but overtime we want it to be used individually as well. The latter implementation will be accelerated if some issues and pull requests come in, denoting some interest out there.
+
+It's still embryonic but many improvements to come.
+
+
+## Pre-requisites
+
+The following things are needed:
+
+* Ruby 1.9.2 or later
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tkh_menus', '~> 0.0'
+
+Then execute:
+
+    $ bundle
+
+Import migrations and needed files
+
+		$ rake tkh_menus:install
+
+Run the migrations
+
+		$ rake db:migrate
+		
+And then of course restart your server!
+
+		$ rails s
+
+
+## Upgrading
+
+Update the gem:
+
+    $ bundle update tkh_menus
+
+Update files, migrations, etc. This is only needed with a new minor version number ( second level from left )
+
+		$ rake tkh_menus:update
+		
+Run migrations if there are new ones
+
+		$ rake db:migrate
+
+Start your server!
+
+		$ rails s
+
+
+## Usage
+
+
+The section is located at:
+
+    /menus
+
+... and it should work out of the box
+
+
+## Contributing
+
+Pull requests for new features and bug fixes are welcome.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your failing tests based on the Test Unit framework.
+4. Create your code which makes the tests pass.
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TkhMenus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/menus_controller.rb

@@ -0,0 +1,44 @@
+class MenusController < ApplicationController
+  
+  before_filter :authenticate
+  before_filter :authenticate_with_admin
+  
+  def index
+    @menus = Menu.ordered
+    switch_to_admin_layout
+  end
+
+  def new
+    @menu = Menu.new
+    switch_to_admin_layout
+  end
+
+  def edit
+    @menu = Menu.find(params[:id])
+    switch_to_admin_layout
+  end
+
+  def create
+    @menu = Menu.new(params[:menu])
+    if @menu.save
+      redirect_to menus_path, notice: t('menus.create.notice')
+    else
+      render action: "new", warning: t('menus.create.warning'), layout: 'admin'
+    end
+  end
+
+  def update
+    @menu = Menu.find(params[:id])
+    if @menu.update_attributes(params[:menu])
+      redirect_to menus_path, notice: t('menus.update.notice')
+    else
+      render action: "edit", warning: t('menus.update.warning'), layout: 'admin'
+    end
+  end
+
+  def destroy
+    @menu = Menu.find(params[:id])
+    @menu.destroy
+    redirect_to menus_url, notice: t('menus.destroy.notice')
+  end
+end

data/app/models/menu.rb

@@ -0,0 +1,47 @@
+# this is needed for now to make mass assignment security compatible with the translation of globalize3
+Globalize::ActiveRecord::Translation.class_eval do
+  attr_accessible :locale
+end
+
+class Menu < ActiveRecord::Base
+  
+  attr_accessible :name, :path, :position, :parent_id
+  
+  validates_presence_of :name, :path
+  
+  translates :name, :path
+    
+  def to_param
+    name ? "#{id}-#{name.to_url}" : id
+  end
+  
+  scope :ordered, order('position, id')
+  # tree scopes
+  scope :orphans, where('parent_id IS ?', nil)
+  scope :with_parent_id, lambda { |id| where('parent_id = ?', id) }
+  
+  def orphan?
+    parent_id == nil
+  end
+  
+  def has_children?
+    Menu.with_parent_id(id).count >= 1
+  end
+  
+  def children
+    Menu.with_parent_id(id)
+  end
+  
+  def parent
+    Menu.find(parent_id)
+  end
+  
+  def has_siblings?
+    Menu.with_parent_id(parent_id).count >= 1
+  end
+  
+  def siblings
+    Menu.with_parent_id(parent_id)
+  end
+  
+end

data/app/views/menus/_form.html.erb

@@ -0,0 +1,13 @@
+<%= simple_form_for @menu, :html => { class: 'form-horizontal' } do |f| %>
+	<%= f.error_notification %>
+	
+	<div class="form-inputs">
+		<%= f.input :name, hint: 'should be rather short as it will figure in navbar and space there is at a premium' %>
+		<%= f.input :path, hint: 'the url the menu is pointing to' %>
+		<%= f.input :parent_id, hint: 'for nested menu items' %>
+	</div>
+	
+  <div class="form-actions">
+    <%= f.button :submit, :class => 'btn btn-primary' %>
+  </div>
+<% end %>

data/app/views/menus/edit.html.erb

@@ -0,0 +1,2 @@
+<%= render 'form' %>
+<%= render 'shared/admin_sidebar' %>

data/app/views/menus/index.html.erb

@@ -0,0 +1,28 @@
+<h1>Listing Menus</h1>
+
+<table class='table table-striped'>
+	<thead>
+  <tr>
+	    <th><%= t( 'activerecord.attributes.menus.name').capitalize %></th>
+			<th><%= t( 'activerecord.attributes.menus.path').capitalize %></th>
+			<th><%= t( 'activerecord.attributes.menus.parent').capitalize %></th>
+	    <th>Actions</th>
+	  </tr>
+	</thead>
+	
+	<tbody>
+		<% @menus.each do |menu| %>
+		  <tr>
+		    <td><%= menu.name %></td>
+		    <td><%= menu.path %></td>
+				<td><%= "#{menu.parent.id} - #{menu.parent.name}" unless menu.orphan? %></td>
+		    <td><%= link_to t('edit'), edit_menu_path(menu), class: 'btn btn-mini' %>
+					<%= link_to t('delete'), menu, method: :delete, data: { confirm: t('are_you_sure') }, class: 'btn btn-mini btn-danger' %></td>
+		  </tr>
+		<% end %>
+	</tbody>
+</table>
+
+<%= link_to t('menus.create_new').capitalize, new_menu_path, class: 'btn btn-primary' %>
+
+<%= render 'shared/admin_sidebar' %>

data/app/views/menus/new.html.erb

@@ -0,0 +1,2 @@
+<%= render 'form' %>
+<%= render 'shared/admin_sidebar' %>

data/app/views/shared/_context_menu.html.erb

@@ -0,0 +1,21 @@
+<% content_for :context_menu do %>
+	<% if @page %>
+		<% if @page.has_children? %>
+			<h2><%= @page.nickname %></h2>
+			<ul>
+		  <% for page in @page.children %>
+		    <%= content_tag :li, link_to(page.nickname, page) %>
+		  <% end %>
+			</ul>
+		<% end %>
+
+		<% if !@page.orphan? && @page.has_siblings? %>
+			<h2><%= link_to @page.parent.nickname, @page.parent %></h2>
+			<ul>
+		  <% for page in @page.siblings %>
+		    <%= content_tag :li, link_to(page.nickname, page) %>
+		  <% end %>
+			</ul>
+		<% end %>
+	<% end -%>
+<% end -%>

data/app/views/shared/_menu_for_navbar.html.erb

@@ -0,0 +1,43 @@
+<% content_for :menu_for_navbar do %>
+	<% if Page.not_for_blog.published.orphans.count >= 1 %>
+		<% Page.not_for_blog.published.orphans.each do |page| %>
+			<% if page.has_children? %>
+				<li class='dropdown'>
+					<a href="#" class="dropdown-toggle" data-toggle="dropdown"><%= page.nickname.downcase %> <b class="caret"></b></a>
+					<ul class="dropdown-menu">
+						<%= content_tag :li, link_to(page.nickname.downcase, page) %>
+						<li class="divider"></li>
+						<% page.children.each do |pc| %>
+							<%= content_tag :li, link_to(pc.nickname.downcase, pc) %>
+						<% end %>
+					</ul>
+				</li>
+			<% else %>
+				<%= content_tag :li, link_to(page.nickname.downcase, page) %>
+			<% end -%>
+		<% end %>
+	<% end -%>
+	
+	<% if Page.for_blog.published.count >= 1 %>
+		<%= content_tag :li, link_to('blog', blog_path) %>
+	<% end -%>
+	
+	<% if Menu.orphans.count >= 1 %>
+		<% Menu.orphans.ordered.each do |menu| %>
+			<% if menu.has_children? %>
+				<li class='dropdown'>
+					<a href="#" class="dropdown-toggle" data-toggle="dropdown">menu.name.downcase <b class="caret"></b></a>
+					<ul class="dropdown-menu">
+						<%= content_tag :li, link_to(menu.name.downcase, menu.path) %>
+						<li class="divider"></li>
+						<% menu.children.each do |mc| %>
+							<%= content_tag :li, link_to(mc.name.downcase, mc.path) %>
+						<% end %>
+					</ul>
+				</li>
+			<% else %>
+				<%= content_tag :li, link_to(menu.name.downcase, menu.path) %>
+			<% end -%>
+		<% end %>
+	<% end -%>
+<% end %>

data/app/views/shared/_menus.html.erb

@@ -0,0 +1,2 @@
+<%= render 'shared/menu_for_navbar' %>
+<%= render 'shared/context_menu' %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
+    resources :menus
+  end
+end

data/lib/generators/tkh_menus/create_or_update_locales/create_or_update_locales_generator.rb

@@ -0,0 +1,14 @@
+module TkhMenus
+  module Generators
+    class CreateOrUpdateLocalesGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc "copying latest version of locale files"
+      def copy_locales
+        puts 'creating locale files'
+        I18n.available_locales.each do |l|
+          copy_file "#{l.to_s}.yml", "config/locales/tkh_menus.#{l.to_s}.yml"
+        end
+      end
+    end
+  end
+end

data/lib/generators/tkh_menus/create_or_update_locales/templates/de.yml

@@ -0,0 +1,26 @@
+de:
+  
+  are_you_sure: 'are you sure?'
+  delete: 'delete'
+  edit: 'edit'
+  menus: 'menus'
+  
+  
+  activerecord: 
+    attributes:
+      menus:
+        name: "name"
+        path: 'path'
+        parent: 'parent menu'
+  
+  menus:
+    create_new: 'create new menu'
+    
+    create:
+      notice: 'The menu was successfully created.'
+      warning: 'There was a problem saving the menu'
+    update:
+      notice: 'The menu was successfully updated.'
+      warning: 'There was a problem saving the menu'
+    destroy:
+      notice: 'The menu was deleted'

data/lib/generators/tkh_menus/create_or_update_locales/templates/en.yml

@@ -0,0 +1,26 @@
+en:
+  
+  are_you_sure: 'are you sure?'
+  delete: 'delete'
+  edit: 'edit'
+  menus: 'menus'
+  
+  
+  activerecord: 
+    attributes:
+      menus:
+        name: "name"
+        path: 'path'
+        parent: 'parent menu'
+  
+  menus:
+    create_new: 'create new menu'
+    
+    create:
+      notice: 'The menu was successfully created.'
+      warning: 'There was a problem saving the menu'
+    update:
+      notice: 'The menu was successfully updated.'
+      warning: 'There was a problem saving the menu'
+    destroy:
+      notice: 'The menu was deleted'

data/lib/generators/tkh_menus/create_or_update_locales/templates/es.yml

@@ -0,0 +1,26 @@
+es:
+
+  are_you_sure: 'are you sure?'
+  delete: 'delete'
+  edit: 'edit'
+  menus: 'menus'
+
+
+  activerecord: 
+    attributes:
+      menus:
+        name: "name"
+        path: 'path'
+        parent: 'parent menu'
+
+  menus:
+    create_new: 'create new menu'
+
+    create:
+      notice: 'The menu was successfully created.'
+      warning: 'There was a problem saving the menu'
+    update:
+      notice: 'The menu was successfully updated.'
+      warning: 'There was a problem saving the menu'
+    destroy:
+      notice: 'The menu was deleted'

data/lib/generators/tkh_menus/create_or_update_locales/templates/fr.yml

@@ -0,0 +1,25 @@
+fr:
+  
+  are_you_sure: 'êtes vous sûr ?'
+  delete: 'supprimer'
+  edit: 'modifier'
+  menus: 'menus'
+  
+  activerecord: 
+    attributes:
+      menus:
+        name: "nom"
+        path: 'adresse'
+        parent: 'menu parent'
+  
+  menus:
+    create_new: 'créer un nouveau menu'
+    
+    create:
+      notice: 'Le menu a été créé.'
+      warning: "Il y'a eu un probleme et le menu n'a pas été sauvegardé"
+    update:
+      notice: 'Les changements de ce menu ont été sauvegardés'
+      warning: "Il y'a eu un probleme et les changements de ce menu n'ont pas été sauvegardés"
+    destroy:
+      notice: 'Le menu a été supprimé'

data/lib/generators/tkh_menus/create_or_update_migrations/create_or_update_migrations_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/migration'
+ 
+module TkhMenus
+  module Generators
+    class CreateOrUpdateMigrationsGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "create or update page migrations"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+ 
+      def copy_migrations
+        migration_template "create_menus.rb", "db/migrate/create_menus.rb"
+      end
+ 
+    end
+  end
+end

data/lib/generators/tkh_menus/create_or_update_migrations/templates/create_menus.rb

@@ -0,0 +1,17 @@
+class CreateMenus < ActiveRecord::Migration
+  def up
+    create_table :menus do |t|
+      t.string :name
+      t.string :path
+      t.integer :parent_id
+      t.integer :position
+      t.timestamps
+    end
+    Menu.create_translation_table! :name => :string, :path => :string
+  end
+  
+  def down
+    drop_table :menus
+    Menu.drop_translation_table!
+  end
+end

data/lib/tasks/tkh_menus_tasks.rake

@@ -0,0 +1,13 @@
+namespace :tkh_menus do
+  desc "Create migrations, locale, and other files"
+  task :install do
+    system 'rails g tkh_menus:create_or_update_migrations'
+    system 'rails g tkh_menus:create_or_update_locales -f'
+  end
+  
+  desc "Update files. Skip existing migrations and blog layout. Force overwrite locales"
+  task :update do
+    system 'rails g tkh_menus:create_or_update_migrations -s'
+    system 'rails g tkh_menus:create_or_update_locales -f'
+  end
+end

data/lib/tkh_menus/version.rb

@@ -0,0 +1,3 @@
+module TkhMenus
+  VERSION = "0.0.1"
+end

data/lib/tkh_menus.rb

@@ -0,0 +1,9 @@
+require "tkh_menus/version"
+require 'simple_form'
+require 'stringex'
+require 'globalize3'
+
+module TkhMenus
+  class Engine < ::Rails::Engine
+  end
+end