documentation 0.0.1 → 1.0.0

data/lib/documentation/search_result.rb

@@ -0,0 +1,84 @@
+module Documentation
+  class SearchResult
+    
+    attr_accessor :query
+    attr_accessor :time
+    attr_accessor :raw_results
+    attr_accessor :results
+    attr_accessor :page
+    attr_accessor :per_page
+    attr_accessor :total_results
+    
+    def initialize
+      @time = nil
+      @raw_results = {}
+      @page = 1
+      @total_pages = 1
+      @per_page = nil
+    end
+    
+    #
+    # Return the pages
+    #
+    def results
+      @results ||= begin
+        results = Documentation::Page.where(:id => raw_results.keys).includes(:parent).to_a
+        results.sort_by { |p| raw_results.keys.index(p.id) }
+      end
+    end
+    
+    #
+    # Return the highlight string for a given page
+    #
+    def excerpt_for(page)
+      if @raw_results[page.id] && hl = @raw_results[page.id][:highlights]
+        ERB::Util.html_escape((hl.join("..."))).gsub('{{{', "<mark>").gsub("}}}", "</mark>").html_safe
+      else
+        page.content[0,255].gsub(/[\n\r]/, '') + "..."
+      end
+    end
+    
+    #
+    # Is the result set empty?
+    #
+    def empty?
+      self.results.empty?
+    end
+    
+    #
+    # The total number of pages in the result set
+    #
+    def total_pages
+      (total_results / per_page.to_f).ceil
+    end
+    
+    #
+    # The number of the first result on the current page
+    #
+    def start_result_number
+      ((page - 1) * per_page) + 1
+    end
+    
+    #
+    # The number of the last result on the current page
+    #
+    def end_result_number
+      start_result_number + (results.size) - 1
+    end
+    
+    #
+    # Is this the first page of the result set?
+    #
+    def first_page?
+      page == 1
+    end
+    
+    #
+    # Is this the last page of the result set?
+    #
+    def last_page?
+      page == total_pages
+    end
+    
+  end
+end

data/lib/documentation/searchers/abstract.rb

@@ -0,0 +1,47 @@
+module Documentation
+  module Searchers
+    class Abstract
+      
+      attr_reader :options
+      
+      def initialize(options = {})
+        @options = options
+        setup
+      end
+      
+      #
+      # Run whatever initial set up is needed
+      #
+      def setup
+      end
+      
+      #
+      # Search for a page from the index
+      #
+      def search(query, options = {})
+        []
+      end
+      
+      #
+      # Delete a page from the index
+      #
+      def delete(page)
+        false
+      end
+      
+      #
+      # Reset an index to have no data within it
+      #
+      def reset
+        true
+      end
+      
+      #
+      # Add or update an page in the index
+      #
+      def index(page)
+      end
+      
+    end
+  end
+end

data/lib/documentation/searchers/simple.rb

@@ -0,0 +1,40 @@
+module Documentation
+  module Searchers
+    class Simple < Documentation::Searchers::Abstract
+      
+      def search(query, options = {})
+        # Default options
+        options[:page]      ||= 1
+        options[:per_page]  ||= 15
+        
+        # Query string 
+        query_string = "content LIKE ? OR title LIKE ?", "%#{query}%", "%#{query}"
+        
+        # Get the total number of pages
+        total_results = pages = Documentation::Page.where(query_string).count
+        
+        # Get the actual pages
+        pages = Documentation::Page.where(query_string)
+        pages = pages.offset((options[:page].to_i - 1) * options[:per_page].to_i)
+        pages = pages.limit(options[:per_page].to_i)
+        
+        # Create a result object
+        result                = Documentation::SearchResult.new
+        result.page           = options[:page].to_i
+        result.per_page       = options[:per_page].to_i
+        result.total_results  = total_results
+        result.query          = query
+        result.time           = 0
+        result.results        = pages
+        
+        # Return the result
+        result
+      end
+      
+      def index(page)
+        true
+      end
+      
+    end
+  end
+end

data/lib/documentation/version.rb

@@ -1,3 +1,3 @@
 module Documentation
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/lib/documentation/view_helpers.rb

@@ -0,0 +1,113 @@
+module Documentation
+  module ViewHelpers
+    
+    #
+    # Path to edit a page in the manager UI
+    #
+    def documentation_edit_page_path(page)
+      "#{::Documentation::Engine.mounted_path}/edit/#{page.full_permalink}"
+    end
+    
+    #
+    # Path to view a page in the manager UI
+    #
+    def documentation_page_path(page)
+      "#{::Documentation::Engine.mounted_path}/#{page.try(:full_permalink)}"
+    end
+    
+    #
+    # Return a breadcrumb for the given page
+    #
+    def documentation_breadcrumb_for(page, options = {})
+      options[:root_link] = options[:root_link].nil? ? t('documentation.helpers.documentation_breadcrumb_for.default_root_link') : options[:root_link]
+      options[:class]     ||= 'breadcrumb'
+      
+      String.new.tap do |s|
+        s << "<nav class='#{options[:class]}'><ul>"
+        
+        if options[:root_link]
+          s << "<li><a href='#{documentation_doc_root}'>#{options[:root_link]}</a></li>"
+        end
+        
+        if page.is_a?(::Documentation::Page)
+          page.breadcrumb.each do |child|
+            s << "<li><a href='#{documentation_doc_root}/#{child.full_permalink}'>#{child.title}</a></li>"
+          end
+        end
+        
+        s << "</ul></nav>"
+      end.html_safe
+    end
+    
+    #
+    # Return a default navigation tree for the given page
+    #
+    def documentation_navigation_tree_for(page)
+      String.new.tap do |s|
+        s << "<ul>"
+        if page.is_a?(::Documentation::Page)
+          page.navigation.select { |p,c| documentation_authorizer.can_view_page?(p) }.each do |p, children|
+            s << "<li>"
+            s << "<a #{page == p ? "class='active'" : ''} href='#{documentation_doc_root}/#{p.full_permalink}'>#{p.title}</a>"
+            unless children.empty?
+              s << "<ul>"
+              children.select { |c| documentation_authorizer.can_view_page?(c) }.each do |p|
+                s << "<li><a #{page == p ? "class='active'" : ''} href='#{documentation_doc_root}/#{p.full_permalink}'>#{p.title}</a></li>"
+              end
+              s << "</ul>"
+            end
+            s << "</li>"            
+          end
+        else
+          ::Documentation::Page.roots.each do |page|
+            s << "<li><a href='#{documentation_doc_root}/#{page.full_permalink}'>#{page.title}</a></li>"
+          end
+        end
+        s << "</ul>"
+      end.html_safe
+    end
+    
+    #
+    # Return appropriate content for a given page
+    #
+    def documentation_content_for(page)
+      # Get the content
+      content = page.compiled_content.to_s
+      
+      # Insert navigation
+      content.gsub!("<p class=''>{{nav}}</p>") do 
+        children = page.children
+        children = children.select { |c| documentation_authorizer.can_view_page?(c) }
+        items = children.map { |c| "<li><a href='#{documentation_doc_root}/#{c.full_permalink}'>#{c.title}</a></li>" }.join
+        "<ul class='pages'>#{items}</ul>"
+      end
+      
+      # Set the document root as appropriate
+      content.gsub!("{{docRoot}}", documentation_doc_root)
+      
+      # Return HTML safe content
+      content.html_safe
+    end
+    
+    #
+    # Return the documentation document root
+    #
+    def documentation_doc_root
+      @documentation_doc_root ||= begin
+        if controller.is_a?(Documentation::ApplicationController)
+          ::Documentation::Engine.mounted_path.to_s
+        else
+          ::Documentation.config.preview_path_prefix.to_s.sub(/\/$/, '')
+        end
+      end
+    end
+    
+    #
+    # Return the documentation authorizer 
+    #
+    def documentation_authorizer
+      @documentation_authorizer ||= Documentation.config.authorizer.new(controller)
+    end
+    
+  end
+end

data/lib/tasks/documentation.rake

@@ -0,0 +1,6 @@
+namespace :documentation do
+  desc "Load a set of initial guides"
+  task :install_guides => :environment do
+    require File.expand_path('../../../db/seeds', __FILE__)
+  end
+end

metadata

@@ -1,15 +1,185 @@
 --- !ruby/object:Gem::Specification
 name: documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
-dependencies: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: dynamic_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: It does cool stuff!
 email:
 - adam@atechmedia.com
@@ -17,8 +187,54 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/images/documentation/link.svg
+- app/assets/images/documentation/logo-black.svg
+- app/assets/images/documentation/logo-white.svg
+- app/assets/images/documentation/page.svg
+- app/assets/images/documentation/pin.svg
+- app/assets/images/documentation/recommendation.svg
+- app/assets/images/documentation/search.svg
+- app/assets/images/documentation/unhappy.svg
+- app/assets/images/documentation/warning.svg
+- app/assets/javascripts/documentation/application.coffee
+- app/assets/javascripts/documentation/jquery-ui.js
+- app/assets/javascripts/documentation/jquery.autosize.js
+- app/assets/stylesheets/documentation/application.scss
+- app/assets/stylesheets/documentation/markdown.scss
+- app/assets/stylesheets/documentation/page_form.scss
+- app/assets/stylesheets/documentation/reset.scss
+- app/controllers/documentation/application_controller.rb
+- app/controllers/documentation/pages_controller.rb
+- app/helpers/documentation/application_helper.rb
+- app/models/documentation/page.rb
+- app/views/documentation/pages/_admin_buttons.html.haml
+- app/views/documentation/pages/form.html.haml
+- app/views/documentation/pages/index.html.haml
+- app/views/documentation/pages/positioning.html.haml
+- app/views/documentation/pages/search.html.haml
+- app/views/documentation/pages/show.html.haml
+- app/views/documentation/shared/access_denied.html.haml
+- app/views/documentation/shared/not_found.html.haml
+- app/views/layouts/documentation/_header.html.haml
+- app/views/layouts/documentation/_search.html.haml
+- app/views/layouts/documentation/application.html.haml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20140711185212_create_documentation_pages.rb
+- db/seeds.rb
 - lib/documentation.rb
+- lib/documentation/authorizer.rb
+- lib/documentation/config.rb
+- lib/documentation/engine.rb
+- lib/documentation/errors.rb
+- lib/documentation/generators/setup_generator.rb
+- lib/documentation/markdown_renderer.rb
+- lib/documentation/search_result.rb
+- lib/documentation/searchers/abstract.rb
+- lib/documentation/searchers/simple.rb
 - lib/documentation/version.rb
+- lib/documentation/view_helpers.rb
+- lib/tasks/documentation.rake
 homepage: http://adamcooke.io
 licenses:
 - MIT