praxis-docs-search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b87c5a598e8934d2adc02815102130441fcca42
+  data.tar.gz: 883f4fef35d32169517eb3e5a1c8643681a3ed07
+SHA512:
+  metadata.gz: 5d7db10a0cf2fbc703864f59d91434c5d04f1677c1469dffe3555a3de302b65dedad7e316c7a300f72170bf4c57956484f2d9afed1802ac4c91927248801d834
+  data.tar.gz: a3c34a641de45578a9e8f1d327105bd84ea8b9ffe62f3dfd46d747b1b7860750c8373d1b528b41c8c4f0127e5a65533da8a9b026d35c47ba37e10ee9dc26d9ff

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/lib/api_browser/bower.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "lunr.js": "^0.6.0"
+  }
+}

data/lib/api_browser/praxis-docs-search.scss

@@ -0,0 +1,23 @@
+.praxis-docs-search {
+  input {
+    width: 280px;
+  }
+  .popover-content {
+    padding: 0;
+    .list-group-item {
+      width: 270px;
+      margin-right: 20px;
+      border-left: none;
+      border-right: none;
+      &:first-child {
+        border-top: none;
+      }
+      .result-type {
+        color: $text-muted;
+        position: absolute;
+        right: 12px;
+        bottom: 11px;
+      }
+    }
+  }
+}

data/lib/api_browser/search.js

@@ -0,0 +1,218 @@
+app.value('pathIndex', {});
+app.provider('praxisDocsSearch', function() {
+  function localSearchFactory(Documentation, $timeout, $q, $state, pathIndex) {
+    'ngInject';
+    console.log('Using Local Search Index');
+
+    // Create the lunr index
+    var index = lunr(function() {
+      this.ref('path');
+      this.field('titleWords', {boost: 50});
+      this.field('members', {boost: 40});
+      this.field('keywords', {boost: 20});
+      this.field('parent', {boost: 30});
+    });
+
+    // Delay building the index by loading the data asynchronously
+    var indexReadyPromise = Documentation.versions().then(function(versions) {
+      // Delay building the index for 500ms to allow the page to render
+      return $timeout(function() {
+        $q.all(versions.map(function (version) {
+          return Documentation.items(version).then(function(items) {
+            function extractMembers(thing) {
+              return _.map(_.get(thing, 'type.attributes', {}), function(v, k) {
+                var res = [k];
+                if (v.description) {
+                  res.push(v.description);
+                }
+                if (_.get(v, 'type.attributes')) {
+                  res = res.concat(extractMembers(v));
+                }
+                return res.join(' ');
+              }).join(' ');
+            }
+            function extractActionMembers(action) {
+              var headers = _.keys(_.get(action, 'headers.type.attributes', {})).join(' '),
+                  params  = extractMembers(_.get(action, 'params', {})),
+                  payload = extractMembers(_.get(action, 'payload', {})),
+                  responses = _.map(_.get(action, 'responses'), function(v, k) { return k + ' ' + v.description; }).join(' '),
+                  urls = _.map(_.get(action, 'urls'), 'path').join(' ');
+              return [headers, params, payload, responses, urls].join(' ');
+            }
+            function extractTypeMembers(type) {
+              return extractMembers({type: type});
+            }
+            _.each(items.resources, function(resource, id) {
+              var href = $state.href('root.controller', {version: version, controller: id});
+              index.add({
+                path: href,
+                titleWords: resource.display_name,
+                members: _.map(resource.actions, 'name').join(' ') + ' ' + _.get(resource.media_type, 'name') + ' ' + _.get(resource, 'traits', []).join(' '),
+                keywords: resource.description + ' ' + version,
+                parent: resource.parent ? items.resources[resource.parent].display_name : ''
+              });
+              pathIndex[href] = {
+                type: 'resource',
+                name: resource.display_name,
+                id: id,
+                version: version
+              };
+
+              _.each(resource.actions, function(action) {
+                var href = $state.href('root.action', {version: version, controller: id, action: action.name});
+                index.add({
+                  path: $state.href('root.action', {version: version, controller: id, action: action.name}),
+                  titleWords: action.name,
+                  members: extractActionMembers(action),
+                  keywords: action.description + ' ' + version,
+                  parent: resource.display_name
+                });
+
+                pathIndex[href] = {
+                  type: 'action',
+                  name: resource.display_name + ' » ' + action.name,
+                  id: action.name,
+                  version: version,
+                  resource: id
+                };
+              });
+            });
+            _.each(items.schemas, function(type) {
+              var href = $state.href('root.type', {version: version, type: type.id});
+              index.add({
+                path: href,
+                titleWords: type.display_name,
+                members: extractTypeMembers(type),
+                keywords: type.description + ' ' + version
+              });
+              pathIndex[href] = {
+                type: 'schema',
+                name: type.display_name,
+                id: type.id,
+                version: version
+              };
+            });
+
+            _.each(items.traits, function(trait, id) {
+              var href = $state.href('root.trait', {version: version, trait: id});
+              index.add({
+                path: href,
+                titleWords: id,
+                members: extractTypeMembers(trait),
+                keywords: trait.description + ' ' + version
+              });
+              pathIndex[href] = {
+                type: 'trait',
+                name: id,
+                id: id,
+                version: version
+              };
+            });
+          });
+        }));
+      }, 500);
+    });
+
+    // The actual service is a function that takes a query string and
+    // returns a promise to the search results
+    // (In this case we just resolve the promise immediately as it is not
+    // inherently an async process)
+    return function(q) {
+      return indexReadyPromise.then(function() {
+        return index.search(q);
+      });
+    };
+  }
+
+  return {
+    $get:localSearchFactory //window.Worker ? webWorkerSearchFactory : localSearchFactory
+  };
+});
+
+app.controller('DocsSearchCtrl', function($scope, $location, praxisDocsSearch, pathIndex, $timeout) {
+
+  function clearResults() {
+    $scope.results = [];
+    $scope.showResults = false;
+    $scope.colClassName = null;
+    $scope.hasResults = false;
+  }
+
+  clearResults();
+  $scope.focus = false;
+
+  $scope.search = function(q) {
+    var MIN_SEARCH_LENGTH = 2;
+    if(q.length >= MIN_SEARCH_LENGTH) {
+      praxisDocsSearch(q).then(function(hits) {
+        $scope.hasResults = hits.length > 0;
+        $scope.results = _.map(_.take(hits, 10), function(hit) {
+          var result = pathIndex[hit.ref];
+          result.path = hit.ref;
+          return result;
+        });
+      });
+    } else {
+      clearResults();
+    }
+    if(!$scope.$$phase) $scope.$apply();
+  };
+
+  $scope.submit = function() {
+    var result;
+    for(var i in $scope.results) {
+      result = $scope.results[i];
+      if(result) {
+        break;
+      }
+    }
+    if(result) {
+      $location.path(result.path);
+      $scope.hideResults();
+    }
+  };
+
+  $scope.hideResults = function() {
+    clearResults();
+    $scope.q = '';
+  };
+
+  $scope.goToResult = function(result) {
+    var str = $scope.q;
+    $scope.hideResults();
+    $timeout(function() {
+      if (window.find) {        // Firefox, Google Chrome, Safari
+        // if some content is selected, the start position of the search
+        // will be the end position of the selection
+        window.find(str, false, false, true);
+      } else {
+        if (document.selection && document.selection.createRange) { // Internet Explorer, Opera before version 10.5
+          var textRange = document.selection.createRange ();
+          if (textRange.findText) {   // Internet Explorer
+            // if some content is selected, the start position of the search
+            // will be the position after the start position of the selection
+            if (textRange.text.length > 0) {
+              textRange.collapse(true);
+              textRange.mov("character", 1);
+            }
+            if (textRange.findText(str)) {
+              textRange.select();
+            }
+          }
+        }
+      }
+    }, 200);
+  };
+
+  $scope.$watch('focus && hasResults', function(val) {
+    $scope.showResults = val;
+  });
+});
+
+app.directive('searchForm', function() {
+  return {
+    restrict: 'E',
+    controller: 'DocsSearchCtrl',
+    templateUrl: 'views/search_form.html'
+  };
+});

data/lib/api_browser/views/navbar.html

@@ -0,0 +1,10 @@
+<div class="header">
+  <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+    <div class="container">
+      <div class="navbar-header">
+        <a class="navbar-brand" href="#/">{{:: title}}</a>
+      </div>
+      <search-form class="navbar-form navbar-right"></search-form>
+    </div>
+  </div>
+</div>

data/lib/api_browser/views/search_form.html

@@ -0,0 +1,8 @@
+<form ng-controller="DocsSearchCtrl" class="praxis-docs-search" role="search" ng-class="{focus:focus}" ng-submit="submit()">
+  <div class="form-group">
+    <input type="search" class="form-control" placeholder="Search" ng-focus="focus=true"
+           ng-blur="focus=false"
+           ng-change="search(q)"
+           ng-model="q" autocomplete="off" popover-template="'views/search_results.html'" popover-is-open="showResults" popover-placement="bottom" popover-trigger="none" />
+  </div>
+</form>

data/lib/api_browser/views/search_results.html

@@ -0,0 +1,5 @@
+<div class="list-group">
+  <a ng-repeat="result in results" href="{{result.path}}" class="list-group-item" ng-click="goToResult(result)">
+    {{result.name}} <small class="result-type">{{result.type}}</small>
+  </a>
+</div>

data/lib/praxis-docs-search.rb

@@ -0,0 +1,12 @@
+module Praxis
+  class DocsSearch < ::Praxis::Plugin
+    include Singleton
+    def setup!
+      register_doc_browser_plugin File.join(File.dirname(__FILE__), 'api_browser')
+    end
+
+    def config_key
+      :docs_search
+    end
+  end
+end

data/lib/praxis-docs-search/version.rb

@@ -0,0 +1,3 @@
+module PraxisDocsSearch
+  VERSION = "0.1.0"
+end

data/praxis-docs-search.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'praxis-docs-search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "praxis-docs-search"
+  spec.version       = PraxisDocsSearch::VERSION
+  spec.authors       = ["Jakub Hampl"]
+  spec.summary       = %q{Doc Browser Search plugin for Praxis.}
+  spec.email         = ["jakub.hampl@rightscale.com"]
+
+  spec.homepage = "https://github.com/rightscale/praxis-docs-search"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">=2.1"
+
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_runtime_dependency 'praxis', [">= 0.18"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+
+end

data/readme.md

@@ -0,0 +1,36 @@
+# Praxis Docs Search
+
+This plugin for Praxis adds the capability to search the doc browser.
+
+![Demo](demo.gif)
+
+## Usage
+
+Add this to your gemfile:
+
+```ruby
+gem 'praxis-docs-search'
+```
+
+In your `config.ru` add it to the Praxis Bootloader:
+
+```ruby
+application.bootloader.use Praxis::DocsSearch
+```
+
+Finally if you would like to use the default styling, add this to your `docs/styles.scss`:
+
+```scss
+@import "praxis-docs-search.scss";
+```
+
+If you are using your own navbar, you can include the search form anywhere by using
+the `<search-form></search-form>` element in a custom template.
+
+## Authors
+
+Jakub Hampl @gampleman
+
+MIT LICENSE
+
+(c) RightScale, Inc. 2015

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: praxis-docs-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Hampl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: praxis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jakub.hampl@rightscale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- demo.gif
+- lib/api_browser/bower.json
+- lib/api_browser/praxis-docs-search.scss
+- lib/api_browser/search.js
+- lib/api_browser/views/navbar.html
+- lib/api_browser/views/search_form.html
+- lib/api_browser/views/search_results.html
+- lib/praxis-docs-search.rb
+- lib/praxis-docs-search/version.rb
+- praxis-docs-search.gemspec
+- readme.md
+homepage: https://github.com/rightscale/praxis-docs-search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: Doc Browser Search plugin for Praxis.
+test_files: []
+has_rdoc: