qwerty 0.0.1.pre → 0.0.3.pre

data/README.rdoc

@@ -1,16 +1,30 @@
 = Qwerty
 
+== Install
+
 gem 'qwerty'
-rake qwerty_engine:install:migrations
-rails generate ckeditor:install
 
-todo:
-rake qwerty_engine:install
-  - create sample sitemap.rb
-  - copy across views
+For now we also need to add an additional dependancy to your Gemfile, since Gem's can not depend on git repositories only released versions
+
+gem 'simple_form', :git => 'git://github.com/plataformatec/simple_form.git'   
+gem 'kaminari',    :git => 'git://github.com/ivanyv/kaminari.git'
+
+rake qwerty_engine:install:migrations
+rake db:migrate
+rails g qwerty:install
 
 Developer Notes
 
 Vim users: To allow rails.vim to detect this is as a Rails project "touch config/environment.rb", which has already been added to .gitignore.
 
+Release Policy
+
+Create release branch from next
+Bump version in Qwerty module: http://semver.org/
+Document release as required
+Merge release branch in to master and next
+Tag master using with 'v' prefix e.g v0.0.1
+Build and push gem to Rubyforge: http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
+
+
 This project rocks and uses MIT-LICENSE.

data/app/controllers/documents_controller.rb

@@ -9,15 +9,34 @@ class DocumentsController < QwertyBaseController
   def show
     path = request.path == '/' ? '/home' : request.path
     @document = Document.public.find_by_permalink!(path)
+    prepare_view_environment
     render locate_template(@document) 
   end
 
   private
+  
+  def prepare_view_environment
+    # e.g @blog
+    instance_variable_set("@#{@document.node_name}", @document)
+    # e.g @posts
+    if @document.can_have_children?
+      @document.node.children.each do | node |
+        logger.warn("[Qwerty] Both parent and child have the same node name, so @#{@document.node_name} is overwriting @#{node.name.pluralize}, use @document instead to access the parent document") if node.name.pluralize == @document.node_name
+        instance_variable_set("@#{node.name.pluralize}", node.documents.public.order(node.get(:sort) || 'published_at desc').page(page_param(@document)).per(node.get(:per_page) || 10))
+      end
+    end
+  end
+
+  def page_param(document)
+    params[document.node_name + '_page']
+  end
 
   # TODO: move this in a class in lib, path_prefix should be setable in
   # Qwerty.options
   # Use Pathname class:
   # http://ruby-doc.org/stdlib/libdoc/pathname/rdoc/index.html
+  # Or ViewResolver
+  # http://jkfill.com/2011/03/11/implementing-a-rails-3-view-resolver/
   
   def locate_template(document)
     view_prefix = 'cms'
@@ -35,7 +54,7 @@ class DocumentsController < QwertyBaseController
       paths.uniq.each do | path |
       view_paths.each do | view_path |
         rel_path = File.join(view_prefix, path) + '.html.erb'
-        full_path = File.join(view_path, rel_path)
+        full_path = File.join(view_path.to_s, rel_path)
         if File.exists? full_path
           logger.debug "Found: #{full_path}"
           return rel_path

data/app/controllers/qwerty_admin/base_controller.rb

@@ -1,8 +1,9 @@
 class QwertyAdmin::BaseController < InheritedResources::Base
-  # Module which has a method called 'autherize', this is called from a before_filter below
-  include Qwerty.options[:admin_autherization]
 
-  before_filter :autherize
+  unless Qwerty.options[:admin_autherization].nil? 
+    include Qwerty.options[:admin_autherization]
+    before_filter :autherize
+  end
 
-  layout 'qwerty_admin'
+  layout Qwerty.options[:admin_layout] unless Qwerty.options[:admin_layout].nil?
 end

data/app/controllers/qwerty_base_controller.rb

@@ -1,6 +1,9 @@
 class QwertyBaseController < ApplicationController
-  # Module which has a method called 'autherize', this is called from a before_filter below
-  include Qwerty.options[:autherization]
 
-  before_filter :autherize
+  unless Qwerty.options[:autherization].nil? 
+    include Qwerty.options[:autherization]
+    before_filter :autherize
+  end
+
+  layout Qwerty.options[:layout] unless Qwerty.options[:layout].nil?
 end

data/app/helpers/documents_helper.rb

@@ -6,6 +6,6 @@ module DocumentsHelper
   end
 
   def document_path(document)
-    document.permalink
+    document.is_a?(Document) ? document.permalink : super(document)
   end
 end

data/app/models/document.rb

@@ -11,15 +11,16 @@ class Document < ActiveRecord::Base
 
   image_accessor :image
 
-  default_scope :order => 'position ASC'
+  # default_scope :order => 'position ASC'
   
   scope :by_node, lambda { |node| where(:node_id => node.id) }
   scope :public, where(:published => true)
 
   before_save :set_summary, :set_meta_fields
-  before_validation :set_published_at, :set_permalink
+  before_validation :set_published_at
+  before_validation :set_permalink, :on => :create
 
-  delegate :get, :to => :node
+  delegate :get, :set, :to => :node
 
   def node_name
     node.name
@@ -29,6 +30,10 @@ class Document < ActiveRecord::Base
     !image.nil?
   end
 
+  def can_have_children?
+    !node.children.empty?
+  end
+
   private
 
   def set_summary

data/app/views/cms/show.html.erb

@@ -1,3 +1,7 @@
+<div style="padding:8px; background-color:#E9EDF2; margin: 10px;">
+  <strong>Warning</strong>: This is the default document template, to generate sample templates run: <code>rails g qwerty:create_document_views</code>
+</div>
+
 <h2><%= @document.title %></h2>
 
 <% if @document.image? %>

data/app/views/kaminari/twitter/_first_page.html.erb

@@ -0,0 +1,13 @@
+<%#
+-#  Link to the "First" page
+-#  available local variables
+-#    url:           url to the first page
+-#    current_page:  a page object for the currently displayed page
+-#    num_pages:     total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%>
+<li class='prev <%= 'disabled' if current_page.first? %>'>
+<%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :remote => remote %>
+</li>
+

data/app/views/kaminari/twitter/_gap.html.erb

@@ -0,0 +1,11 @@
+<%#
+-#  Non-link tag that stands for skipped pages...
+-#  available local variables
+-#    current_page:  a page object for the currently displayed page
+-#    num_pages:     total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%>
+<li class='disabled'>
+<%= link_to(raw(t 'views.pagination.truncate'), "#") %>
+</li>

data/app/views/kaminari/twitter/_last_page.html.erb

@@ -0,0 +1,3 @@
+<li class='next <%= 'disabled' if current_page.last? %>'>
+<%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, {:remote => remote} %>
+</li>

data/app/views/kaminari/twitter/_next_page.html.erb

@@ -0,0 +1,3 @@
+<li class='next <%= 'disabled' if current_page.last? %>'>
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.next'), url, :rel => 'next', :remote => remote %>
+  </li>

data/app/views/kaminari/twitter/_page.html.erb

@@ -0,0 +1,5 @@
+<li class='<%= 'active' if page.current? %>'>
+  <%= link_to_unless(page.current?, page, url, {:remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil}) do |name| %>
+    <%= link_to(name, "#") %>
+    <% end %>
+    </li>

data/app/views/kaminari/twitter/_paginator.html.erb

@@ -0,0 +1,17 @@
+<%= paginator.render do %>
+  <div class='pagination'>
+    <ul>
+      <%= first_page_tag unless current_page.first? %>
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| %>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? %>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? %>
+          <%= gap_tag %>
+        <% end %>
+      <% end %>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? %>
+    </ul>
+  </div>
+<% end %>

data/app/views/kaminari/twitter/_prev_page.html.erb

@@ -0,0 +1,12 @@
+<%#
+-#  Link to the "Previous" page
+-#  available local variables
+-#    url:           url to the previous page
+-#    current_page:  a page object for the currently displayed page
+-#    num_pages:     total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%>
+<li class='prev <%= 'disabled' if current_page.first? %>'>
+<%= link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote %>
+</li>

data/app/views/layouts/qwerty_admin.html.erb

@@ -6,7 +6,6 @@
     <link rel="stylesheet" href="http://twitter.github.com/bootstrap/1.3.0/bootstrap.min.css">
     <%= javascript_include_tag "application" %>
     <%= javascript_include_tag 'http://twitter.github.com/bootstrap/1.3.0/bootstrap-alerts.js' %>
-    <%= javascript_include_tag "ckeditor/ckeditor.js" %>
     <%= csrf_meta_tags %>
     <style type="text/css">
       body {

data/app/views/qwerty_admin/documents/_document.html.erb

@@ -16,8 +16,10 @@
     </div>
 
     <div class="span4 offset2">
-      <%= link_to image_tag('qwerty/admin/icons/up.png'), up_qwerty_admin_document_path(document), :class => 'btn small' unless document.last? %>
-      <%= link_to image_tag('qwerty/admin/icons/down.png'), down_qwerty_admin_document_path(document), :class => 'btn small' unless document.first? %>
+      <% if document.get(:sort).try('include?', 'position') %>
+        <%= link_to image_tag('qwerty/admin/icons/up.png'), up_qwerty_admin_document_path(document), :class => "btn small#{' disabled' if document.first?}" %>
+        <%= link_to image_tag('qwerty/admin/icons/down.png'), down_qwerty_admin_document_path(document), :class => "btn small#{' disabled' if document.last?}" %>
+      <% end %>
       <%= link_to 'Edit', edit_qwerty_admin_document_path(document), :class => 'btn small' %>
       <%= link_to 'Live', document_path(document), :target => '_blank', :class => 'btn small' %>
     </div>

data/app/views/qwerty_admin/documents/_form.html.erb

@@ -6,7 +6,7 @@
 <div class='inputs'>
   <fieldset>
     <%= form.input :title if fields.include?('title') %>
-    <%= form.input :body, :as => :ckeditor , :input_html => { :cols => 5 } if fields.include?('body') %>
+    <%= form.input :body, :hint => 'HTML allowed', :input_html => { :rows => 9, :class => 'span14' } if fields.include?('body')%>
     <%= form.input :summary, :hint => 'Plain text only, automatically set if left blank', :input_html => { :rows => 5, :class => 'span14'} if fields.include?('summary') %>
     <%= form.input :url, :as => :url if fields.include?('url') %>
     <%= form.input :published if fields.include?('published') %>

data/app/views/qwerty_admin/documents/index.html.erb

@@ -1,5 +1,6 @@
 <h2>Sitemap</h2>
 
+
 <div id="documents">
   <% @documents.each do | document | %>
 
@@ -16,14 +17,13 @@
         </div>
 
         <div class="span4 offset2">
-          <%= link_to image_tag('qwerty/admin/icons/up.png'), up_qwerty_admin_document_path(document), :class => 'btn small' unless document.last? %>
-          <%= link_to image_tag('qwerty/admin/icons/down.png'), down_qwerty_admin_document_path(document), :class => 'btn small' unless document.first? %>
+          <%= link_to image_tag('qwerty/admin/icons/up.png'), up_qwerty_admin_document_path(document), :class => 'btn small' unless document.first? %>
+          <%= link_to image_tag('qwerty/admin/icons/down.png'), down_qwerty_admin_document_path(document), :class => 'btn small' unless document.last? %>
           <%= link_to 'Edit', edit_qwerty_admin_document_path(document), :class => 'btn small' %>
           <%= link_to 'Live', document_path(document), :target => '_blank', :class => 'btn small' %>
         </div>
       </div>
 
-
       <p>
       <% document.node.children.each do | node | %>
         <%= link_to "Add #{node.name.capitalize}", new_qwerty_admin_document_path(:parent_id => document.id, :node_id => node.id), :class => 'btn primary' %>

data/app/views/qwerty_admin/documents/show.html.erb

@@ -20,13 +20,17 @@
   <div class='node'>
     <h3><%= node.name.pluralize.capitalize %></h3>
 
-    <% unless @document.leaf? %>
+    <% unless node.documents.empty? %>
       <div class="documents">
-        <%= render :partial => @document.children.by_node(node) %>
+        <% documents = node.documents.order(node.get(:sort) || 'published_at desc').page(params["#{node.name}_page".to_sym]).per(10 / @document.node.children.size) %>
+        <%= render :partial => documents %>
       </div>
     <% else %>
       <p>No <%= node.name.capitalize.pluralize %> have been added yet.</p>
     <% end %>
+
+    <%= paginate documents, :route => :qwerty_admin_document_path, :param_name => "#{node.name}_page", :theme => :twitter %>
+
     <p>
     <%= link_to "Add #{node.name.capitalize}", new_qwerty_admin_document_path(:parent_id => @document.id, :node_id => node.id), :class => 'btn primary' %>
     </p>

data/app/views/qwerty_admin/nodes/_node.html.erb

@@ -1,8 +1,8 @@
 <li class='node'><%= (node.leaf? ? node.name.pluralize : node.name).capitalize %>
 <span>
   <%= link_to 'Add', new_qwerty_admin_node_path(:parent_id => node.id) %>
-  <%= link_to 'Up', up_qwerty_admin_node_path(node) %>
-  <%= link_to 'Down', down_qwerty_admin_node_path(node) %>
+  <%= link_to 'Up', up_qwerty_admin_node_path(node) unless node.last? %>
+  <%= link_to 'Down', down_qwerty_admin_node_path(node) unless node.first? %>
   <%= link_to 'Edit', edit_qwerty_admin_node_path(node) %>
   <%= link_to 'Delete', qwerty_admin_node_path(node), :method => :delete, :confirm => 'Are you sure?' %>
   <%= node.position %>

data/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
 
   root :to => 'documents#show'
 
-  namespace :qwerty_admin do
+  scope Qwerty.options[:admin_route_namespace], :module => :qwerty_admin, :as => :qwerty_admin do
     root :to => 'documents#index'
 
     resources :nodes do
@@ -22,5 +22,5 @@ Rails.application.routes.draw do
   end
 
 
-  match '*permalink' => 'documents#show'
+  match '*permalink' => 'documents#show', :as => :document
 end

data/db/migrate/20110909144300_create_documents.rb

@@ -8,7 +8,7 @@ class CreateDocuments < ActiveRecord::Migration
       t.integer :lft
       t.integer :rgt
       t.integer :depth, :default => 0
-      t.integer :position, :default => 0
+      t.integer :position, :default => 1
       t.integer :node_id
       t.timestamps
     end

data/lib/generators/qwerty/copy_views/copy_views_generator.rb

@@ -0,0 +1,10 @@
+module Qwerty
+  class CopyViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../../', __FILE__)
+    desc 'Copy views for customising'
+
+    def copy_views
+      directory 'app/views', 'app/views', :recursive => true
+    end
+  end
+end

data/lib/generators/qwerty/create_document_views/create_document_views_generator.rb

@@ -0,0 +1,18 @@
+class Qwerty::CreateDocumentViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Create a example views for a documents'
+
+    def generate_views(node = Sitemap.root)
+      node.children.each do | node |
+        generate_view(node)
+        generate_views(node) unless node.leaf?
+      end
+    end
+
+    private
+
+    def generate_view(node)
+      destination_root = Rails.root
+      template 'show.html.erb', "app/views/cms/#{node.ancestry.gsub('/root/', '').gsub('/', '.')}.html.erb", :node => node
+    end
+end

data/lib/generators/qwerty/create_document_views/templates/show.html.erb

@@ -0,0 +1,22 @@
+<% node = config[:node] 
+parent_var = '@' + (node.children.any? { |n| n.name.pluralize == node.name } ? 'document' : node.name)
+-%>
+<h2><%%= <%= parent_var %>.title %></h2>
+
+<div class='body'><%%= <%= parent_var %>.body.html_safe %></div>
+
+<% node.children.each do | node | %>
+
+  <div id="<%= node.name.pluralize %>">
+    <%% @<%= node.name.pluralize %>.each do | <%= node.name %> | %>
+      <div class='<%= node.name %>'>
+        <h3><%%= link_to <%= node.name %>.title, document_path(<%= node.name %>) %></h3>
+
+        <div><%%= <%= node.name %>.summary %></div>
+        <div><%%= <%= node.name %>.published_at %></div>
+      </div>
+    <%% end %>
+
+    <%%= paginate @<%= node.name.pluralize %>, :route => :document_path, :param_name => "#{@<%= node.name %>}_page", :theme => :twitter %>
+  </div>
+<% end %>

data/lib/generators/qwerty/install/install_generator.rb

@@ -0,0 +1,24 @@
+module Qwerty
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Install Qwerty in to your Rails application'
+
+    invoke 'qwerty:copy_views'
+
+    def copy_sitemap_config
+      template 'sitemap.rb', 'config/sitemap.rb'
+    end
+
+    def copy_initializers
+      template 'qwerty.rb', 'config/initializers/qwerty.rb'
+    end
+
+    def remove_index_html
+      remove_file 'public/index.html'
+    end
+
+    def show_readme
+      readme 'README'
+    end
+  end
+end

data/lib/generators/qwerty/install/templates/README

@@ -0,0 +1,30 @@
+===============================================================================
+                                             _         
+                                            | |        
+                      __ ___      _____ _ __| |_ _   _ 
+                     / _` \ \ /\ / / _ \ '__| __| | | |
+                    | (_| |\ V  V /  __/ |  | |_| |_| |
+                     \__, | \_/\_/ \___|_|   \__|\__, |
+                        | |                       __/ |
+                        |_|                      |___/ 
+
+
+1. Construct your sitemap
+
+config/sitemap.rb 
+
+2. Load your sitemap and some Lipsum content
+
+rake bootstrap
+
+3. Start the server
+
+rails s
+
+4. Open your browser
+
+visit localhost:3000
+
+5. Enjoy !
+
+===============================================================================

data/lib/generators/qwerty/install/templates/qwerty.rb

@@ -0,0 +1,34 @@
+Qwerty.configure do | config |
+  # config.options[:admin_title] = 'Qwerty'
+
+  # Qwerty does not include autherisation/authentication, it hooks in to your
+  # applications own choices. This way you can use authlogic, devise, cancan or 
+  # any other system.
+  #
+  # Create a module with a autherize method, the autherize method is called from
+  # a before_filter in every one of Qwerty's admin controllers.
+  #
+  # Example: 
+  # module Qwerty
+  #   module DeviseAuth
+  #     def autherize
+  #       # Delegate to Devise
+  #       authenticate_user! 
+  #       raise 'You must be an admin' unless current_user.admin?
+  #     end
+  #   end
+  # end
+  #
+  # config.options[:admin_autherization] = Qwerty::DeviseAuth
+  #
+  # Qwerty comes bundled with two Auth stratagies AllowAuth and DenyAuth.
+  # As the names suggest AllowAuth allows everything and DenyAuth allows
+  # nothing.
+  #
+  # You can also autherize a user for regular CMS pages, for example if some
+  # pages need to be private. By default anyone is allowed to view all
+  # non-admin pages.
+  #
+  # config.options[:autherization] = Qwerty::AllowAuth
+end
+

data/lib/generators/qwerty/install/templates/sitemap.rb

@@ -0,0 +1,39 @@
+Sitemap.build do | root |
+  root.undeleteable!
+
+  root.add(:home) do | home |
+    home.undeleteable!
+  end
+
+  root.add(:project) do | project |
+    project.undeleteable!
+
+    project.add(:page) do | page |
+      page.set(:per_page => 10)
+      page.set(:sort => 'updated_at desc')
+      
+      page.add(:image) do | image |
+        image.set(:per_page => 10)
+        image.set(:sort => 'position asc')
+      end
+    end
+  end
+
+  root.add(:about) do | about |
+    about.undeleteable!
+
+    about.add(:page) do | page |
+      page.set(:per_page => 10)
+      page.set(:sort => 'title asc')
+    end
+  end
+
+  root.add(:blog) do | blog |
+    blog.undeleteable!
+
+    blog.add(:post) do | post |
+      post.set(:per_page => 10)
+      post.set(:sort => 'published_at asc')
+    end
+  end
+end

data/lib/qwerty/engine.rb

@@ -1,5 +1,4 @@
 module Qwerty
   class Engine < Rails::Engine
-    config.autoload_paths += %W(#{config.root}/app/models/ckeditor)
   end
 end

data/lib/qwerty/version.rb

@@ -1,3 +1,3 @@
 module Qwerty
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.3.pre"
 end

data/lib/qwerty.rb

@@ -1,3 +1,14 @@
+# Dependencies
+require 'nested_set'
+require 'acts_as_list'
+require "inherited_resources"
+require "simple_form"
+require "jquery-rails"
+require "sanitize"
+require "dragonfly"
+require "faker"
+
+# Qwerty
 require "qwerty/engine"
 require "qwerty/allow_auth"
 require "qwerty/deny_auth"
@@ -7,13 +18,39 @@ module Qwerty
   class << self
 
     # Provides configurability to Qwerty
+    #
     # * admin_title: The title shown in the admin UI
-    # * authentication: Module which is mixed in to CMS controllers, it must have a method called 'autherize', which is called from a before_filter
+    #
+    # * admin_autherization: Module which is mixed in to Qwerty admin 
+    # controllers, it must have a method called 'autherize', which is called 
+    # from a before_filter. Set to nil to turn autherization off.
+    #
+    # * autherization: Module which is mixed in to public facing Qwerty, works
+    # in the same way as admin_authentication. Usually this will be left as nil
+    # to allow anybody access to CMS pages.
+    #
+    # Note: All Qwerty controllers inherit from ApplicationController, so your
+    # autherize method will have access to its private methods e.g current_user.
+    #
+    # * admin_layout: The layout to use for all Qwerty's admin controllers,
+    # set o nil to use Rails default layout
+    #
+    # * layout: The layout to use for Qwerty's public facing controllers, set
+    # to nil to use the Rails default layout
+    #
+    # * admin_route_namespace: The namespace for the admin controllers, you may
+    # wish to change this to '/admin' if you have other controllers in this
+    # namespace and you want consistant URL's. Note: if you change this your
+    # views will still reside in 'views/qwerty_admin'.
+    
     def options
       @options ||= {
         :admin_title => 'Qwerty CMS',
-        :autherization => Qwerty::AllowAuth,
-        :admin_autherization => Qwerty::AllowAuth
+        :autherization => nil,
+        :admin_autherization => nil,
+        :admin_layout => 'qwerty_admin',
+        :layout => nil,
+        :admin_route_namespace => '/qwerty_admin'
       }
     end
 

data/lib/tasks/qwerty_tasks.rake

@@ -1,5 +1,12 @@
-desc "Descructivly rebuild the site"
-task :bootstrap => [:environment] do
+desc "Destructively rebuild the site"
+task :bootstrap => [:load_sitemap, :load_lipsum]
+
+desc 'Load sitemap from config/sitemap.rb'
+task :load_sitemap => [:environment] do
   Sitemap.load_from_disk!
+end
+
+desc 'Load some Lispsum content for all nodes in Sitemap'
+task :load_lipsum => [:environment] do
   Qwerty::Lipsum.new.run!
 end

data/test/dummy/app/views/cms/blog.html.erb

@@ -0,0 +1,10 @@
+<h2><%= @blog.title %></h2>
+
+<% @posts.each do | post | %>
+  <h3><%= link_to post.title, document_path(post) %></h3>
+
+  <div><%= post.summary %></div>
+  <div><%= post.published_at %></div>
+<% end %>
+
+<%= paginate @posts, :route => :document_path, :param_name => "#{@blog.node_name}_page", :theme => :twitter %>