appdoc 0.0.1

data/app/controllers/documents_controller.rb

@@ -0,0 +1,72 @@
+class DocumentsController < ApplicationController
+
+  filter_access_to :all
+
+  # GET /documents
+  def index
+    if params[:tag].blank?
+      @search = Document.search(params[:search])
+    else
+      @search = Document.tagged_with(params[:tag]).search(params[:search])
+      flash[:warn] = "No documents are tagged with \"#{params[:tag]}\"" if @search.count == 0 and params[:search].nil?
+    end
+    @documents = @search.page(params[:page]).per(20)
+
+    respond_to do |format|
+      format.html # index.html.haml
+      format.js { render :partial=>'documents' }
+    end
+  end
+
+  # GET /documents/1
+  def show
+    @document = Document.find_by_id(params[:id]) || Document.find_by_slug!(params[:id])
+  end
+
+  # GET /documents/new
+  def new
+    @document = Document.new
+  end
+
+  # GET /documents/1/edit
+  def edit
+    @document = Document.find_by_id(params[:id]) || Document.find_by_slug(params[:id])
+  end
+
+  # POST /documents
+  def create
+    @document = Document.new(params[:document])
+
+    if @document.save
+      flash[:notice] = 'Document was successfully created.'
+      redirect_to(@document)
+    else
+      render :action => 'new'
+    end
+  end
+
+  # PUT /documents/1
+  def update
+  
+    @document = Document.find_by_id(params[:id]) || Document.find_by_slug(params[:id])
+
+    if @document.update_attributes(params[:document])
+      flash[:notice] = 'Document was successfully updated.'
+      redirect_to(@document)
+    else
+      render :action => 'edit'
+    end
+    
+  end
+
+  # DELETE /documents/1
+  def destroy
+  
+    @document = Document.find_by_id(params[:id]) || Document.find_by_slug(params[:id])
+    @document.destroy
+
+    redirect_to(documents_url)
+    
+  end
+  
+end

data/app/models/document.rb

@@ -0,0 +1,32 @@
+class Document < ActiveRecord::Base
+
+  attr_accessible :name, :content, :slug, :tag_list
+  validates_presence_of :name, :content, :slug
+  validates_uniqueness_of :name, :slug
+  
+  before_validation :set_default_slug
+  
+  default_scope :order => 'name'
+  
+  scope :named, lambda {|name| select("DISTINCT documents.*").
+    joins("LEFT OUTER JOIN taggings ON (taggings.taggable_id = documents.id AND taggable_type = 'Document')").
+    joins("LEFT OUTER JOIN tags ON taggings.tag_id = tags.id").
+    where("documents.name LIKE ? OR documents.slug LIKE ? OR tags.name LIKE ?", "%#{name}%", "%#{name}%", "%#{name}%") }
+  
+  search_methods :named
+  
+  acts_as_taggable
+  
+  def to_param
+    self.slug.blank? ? self.id.to_s : self.slug
+  end
+  
+  def text_content
+    self.content.gsub(/<\/?[^>]*>/, '')
+  end
+
+  def set_default_slug
+    self.slug = self.name.parameterize if self.slug.blank?
+  end
+
+end

data/app/views/documents/_documents.html.haml

@@ -0,0 +1,18 @@
+.search.summary!=page_entries_info(@documents, :entry_name=>'document')
+
+%table
+  %tr
+    %th.name Name
+    %th.content Content
+    %th.tags Tags
+  -@documents.each do |document|
+    %tr
+      %td.name!=link_to(document.name, document_path(document))
+      %td.content
+        %p&=document.text_content[0..100]
+      %td.tags
+        %ul.tags
+          -document.tags.each do |tag|
+            %li!=link_to(tag, {:controller=>'documents', :tag=>tag.to_s})
+            
+!=paginate(@documents)

data/app/views/documents/_form.html.haml

@@ -0,0 +1,31 @@
+-content_for(:head) do
+  =javascript_include_tag('jquery-ui')
+  =javascript_include_tag('SmartTextBox')
+  =stylesheet_link_tag('jquery/smart_text_box/SmartTextBox')
+  :javascript
+    $(document).ready(function() {
+      // Tagging
+      $('#document_tag_list').smartTextBox({
+        submitChars: [#{Appdoc.delimiter.to_json}],
+        separator: ", ",
+        autocompleteValues: #{Appdoc.autocompleteValues.to_json},
+        minSearchLength: #{Appdoc.minSearchLength},
+        placeholder: #{Appdoc.placeholder.to_json}
+      });
+    });
+
+=render('shared/wysiwyg')
+
+=form_for(@document) do |f|
+  %dl
+    %dt.name=f.label :name
+    %dd.name=f.text_field :name
+    %dt.slug=f.label :slug
+    %dd.slug=f.text_field :slug
+    %dt.tags=f.label :tag_list, 'Tags'
+    %dd.tags
+      =f.text_field :tag_list, :maxlength => "15"
+      %span.help_text Lower case and separated by spaces
+    %dt.content=f.label :content
+    %dd.content=f.text_area :content
+  .buttons=f.submit 'Save'

data/app/views/documents/_index_aside.html.haml

@@ -0,0 +1,5 @@
+-content_for(:aside) do
+  -if permitted_to? :create, :documents
+    %h2 Actions
+    .box
+      %h3.add!=link_to('New document', new_document_path)

data/app/views/documents/edit.html.haml

@@ -0,0 +1,2 @@
+%h2 Editing Document
+!=render('form')

data/app/views/documents/index.html.haml

@@ -0,0 +1,12 @@
+%h2 Documentation
+
+=form_for(@search, :html=>{:class=>'search'}) do |f|
+  !=hidden_field_tag(:tag, params[:tag])
+  !=f.label(:named, 'Search')
+  !=f.text_field(:named)
+  !=f.submit('Search')
+
+.search_results
+  !=render('documents', :documents=>@documents)
+            
+!=render('index_aside')

data/app/views/documents/new.html.haml

@@ -0,0 +1,2 @@
+%h2 New Document
+!=render('form')

data/app/views/documents/show.html.haml

@@ -0,0 +1,8 @@
+%h2&=@document.name
+.content!=@document.content
+.tags
+  %h3 Tags
+  %ul.tags
+    -@document.tags.each do |tag|
+      %li!=link_to(tag, {:controller=>'documents', :tag=>tag.to_s})
+!=action_links @document

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
+    resources :documents
+  end
+end

data/lib/appdoc/engine.rb

@@ -0,0 +1,7 @@
+require 'appdoc'
+require 'rails'
+
+module Appdoc
+  class Engine < Rails::Engine
+  end
+end

data/lib/appdoc/version.rb

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

data/lib/appdoc.rb

@@ -0,0 +1,22 @@
+require "appdoc/version"
+
+module Appdoc
+  require 'appdoc/engine' if defined?(Rails)
+  require 'acts-as-taggable-on'
+  require 'declarative_authorization'
+  require 'haml'
+  require 'kaminari'
+  require 'meta_search'
+  
+  # Settings
+  mattr_accessor(:delimiter)
+  mattr_accessor(:separator)
+  mattr_accessor(:autocompleteValues)
+  mattr_accessor(:minSearchLength)
+  mattr_accessor(:placeholder)
+  
+  # for easy configuration
+  def self.config
+    yield self
+  end
+end

data/lib/generators/appdoc/appdoc_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AppdocGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(dirname)
+    sleep 1
+    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_files
+    migration_template "migration.rb", "db/migrate/appdoc_create_documents"
+    run "rails generate acts_as_taggable_on:migration"
+  end
+  
+  def create_initializer
+    template 'appdoc_config.rb', 'config/initializers/appdoc_config.rb'
+  end
+  
+  def copy_related_files
+    copy_file 'public/stylesheets/jquery/smart_text_box/SmartTextBox.css', 'public/stylesheets/jquery/smart_text_box/SmartTextBox.css'
+    copy_file 'public/stylesheets/jquery/smart_text_box/imgs/close.gif', 'public/stylesheets/jquery/smart_text_box/imgs/close.gif'
+    copy_file 'public/javascripts/SmartTextBox.js', 'public/javascripts/SmartTextBox.js'
+  end
+end

data/lib/generators/appdoc/templates/appdoc_config.rb

@@ -0,0 +1,6 @@
+Appdoc.config do |config|
+  config.delimiter = " "  #changing this line may affect the functionality of this gem.
+  config.autocompleteValues = ["dashboard", "users"]
+  config.minSearchLength = 2
+  config.placeholder = "Start typing for suggested tags"
+end

data/lib/generators/appdoc/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateDocuments < ActiveRecord::Migration
+  def self.up
+    create_table :documents do |t|
+      t.string :name
+      t.text :content
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :documents
+  end
+end