local_documentation 1.0.0

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

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

data/lib/documentation/view_helpers.rb

@@ -0,0 +1,159 @@
+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.blank? ? '/' : 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.sub(/\/$/, '')
+        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
+    
+    # 
+    # Return summary information for search results
+    #
+    def documentation_search_summary(result)
+      t('documentation.helpers.documentation_search_summary.text', :total_results => result.total_results, :start_result => result.start_result_number, :end_result => result.end_result_number, :query => result.query)
+    end
+    
+    #
+    # Return the search results
+    #
+    def documentation_search_results(result, options = {})
+      options[:class] ||= 'searchResults'
+      String.new.tap do |s|
+        s << "<ul class='#{options[:class]}'>"
+        result.results.each do |page|
+          s << "<li>"
+          s << "<h4><a href='#{documentation_doc_root}/#{page.full_permalink}'>#{page.title}</a></h4>"
+          unless page.parents.empty?
+            s << "<p class='in'>#{t('documentation.helpers.documentation_search_results.in')} "
+            s << page.parents.map { |c| link_to(h(c.title), "#{documentation_doc_root}/#{c.full_permalink}")}.join(" &#8658; ").html_safe
+            s << "</p>"
+          end
+          s << "<p class='excerpt'>#{result.excerpt_for(page)}</p>"
+          s << "</li>"
+        end
+        s << "</ul>"
+      end.html_safe
+    end
+    
+    #
+    # Return search pagination links
+    #
+    def documentation_search_pagination(result, options = {})
+      String.new.tap do |s|
+        unless result.first_page?
+          querystring = {:query => result.query, :page => result.page - 1}.to_query
+          s << link_to(t('documentation.helpers.documentation_search_pagination.previous'), "#{documentation_doc_root}/search?#{querystring}", :class => [options[:link_class], options[:previous_link_class]].compact.join(' '))
+        end
+
+        unless result.last_page?
+          querystring = {:query => result.query, :page => result.page + 1}.to_query
+          s << link_to(t('documentation.helpers.documentation_search_pagination.next'), "#{documentation_doc_root}/search?#{querystring}", :class => [options[:link_class], options[:next_link_class]].compact.join(' '))
+        end
+      end.html_safe
+    end
+    
+  end
+end

data/lib/tasks/documentation.rake

@@ -0,0 +1,44 @@
+namespace :documentation do
+
+  desc "Load a set of initial guides"
+  task :install_guides => :environment do
+    require File.expand_path('../../../db/seeds', __FILE__)
+  end
+
+
+  namespace :db do
+    desc 'Migrates the documentation database'
+    task :migrate => :environment do
+      p "documentation db migrate"
+      with_engine_connection do
+        ActiveRecord::Migrator.migrate("#{File.dirname(__FILE__)}/../../db/migrate", ENV['VERSION'].try(:to_i))
+      end
+      Rake::Task['documentation:db:schema:dump'].invoke
+    end
+
+    task :'schema:dump' => :environment do
+      require 'active_record/schema_dumper'
+
+      with_engine_connection do
+        File.open(Rails.root.join('db', 'documentation_schema.rb'), 'w') do |file|
+          ActiveRecord::SchemaDumper.dump ActiveRecord::Base.connection, file
+        end
+      end
+    end
+
+    task :'schema:load' => :environment do
+      with_engine_connection do
+        load Rails.root.join('db', 'documentation_schema.rb')
+      end
+    end
+  end
+end
+
+# Hack to temporarily connect AR::Base to documentation.
+def with_engine_connection
+  original = ActiveRecord::Base.remove_connection
+  ActiveRecord::Base.establish_connection "documentation".to_sym
+  yield
+ensure
+  ActiveRecord::Base.establish_connection original
+end

metadata

@@ -0,0 +1,307 @@
+--- !ruby/object:Gem::Specification
+name: local_documentation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zakaria Braksa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 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: nifty-attachments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: nifty-dialog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: Easily add markdown-based project documentation to your Rails application
+email:
+- zakaria.braksa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- 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/models/documentation/screenshot.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/screenshot.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/_footer.html.haml
+- app/views/layouts/documentation/_head.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/migrate/20140724111844_create_nifty_attachments_table.rb
+- db/migrate/20140724114255_create_documentation_screenshots.rb
+- db/seeds.rb
+- doc/developers-guide/authorization.md
+- doc/developers-guide/building-views/accessing-pages.md
+- doc/developers-guide/building-views/helpers.md
+- doc/developers-guide/building-views/overview.md
+- doc/developers-guide/customization.md
+- doc/developers-guide/overview.md
+- doc/developers-guide/search-backends.md
+- doc/markdown/overview.md
+- 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://braksa.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails Engine for easily adding markdown-based project documentation to your
+  Rails application
+test_files: []
+has_rdoc: