slate_algolia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e80c2ccf5f876da5001c305e6d272a21287e313d
+  data.tar.gz: 8e96a63ef046eef75dc8c32dbccf3e837acf892d
+SHA512:
+  metadata.gz: 87591952fd37a850f76772d4a4935210cbcef20f7a38f3015f8fd187b6ebc78ee83170cd80a9bd77d84b13ee41db0a5cf7cbbd6e7a49401652069bd01d6092f6
+  data.tar.gz: f5ef2a9aeb23290ab53e4b03cfc9cb8f1fb49b4a9bcc68ecda146c294c4863f342e1115d99043313dcdbb6b0065c78ef93559947b89327136597de2335be653e

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Slate Algolia
+
+First off, thank you for considering contributing to slate algolia :)
+
+We put these guidelines together to try and make working with this library as straight forward as possible, and hopefully help you understand how we communicate about potential changes and improvements.
+
+Improving documentation, bug triaging, building modules for various frameworks or writing tutorials are all examples of helpful contributions we really appreciate.
+
+## Guidelines
+
+* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
+* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. 
+* Please take time to read our [Community Code of Conduct](#community-code-of-conduct) which includes Reporting Guidelines.
+
+## Community Code of Conduct 
+
+The Keen IO Community is dedicated to providing a safe, inclusive, welcoming, and harassment-free space and experience for all community participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers. Our Code of Conduct exists because of that dedication, and we do not tolerate harassment in any form. See our reporting guidelines [here](https://github.com/keen/community-code-of-conduct/blob/master/incident-reporting.md). Our full Code of Conduct can be found at this [link](https://github.com/keen/community-code-of-conduct/blob/master/long-form-code-of-conduct.md). 
+
+## Your First Contribution
+
+Here are a couple of friendly tutorials with more information about contributing to OSS projects: http://makeapullrequest.com/,  http://www.firsttimersonly.com/, and [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
+
+At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:
+
+If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
+
+### Run the following commands to get this project set up locally.
+
+```ssh
+$ git clone https://github.com/keen/slate_algolia.git && cd slate_algolia
+$ bower install
+```
+
+### Submitting a Pull Request
+
+Use the template below. If certain testing steps are not relevant, specify that in the PR. If additional checks are needed, add 'em! Please run through all testing steps before asking for a review.
+
+```
+## What does this PR do?
+
+## How should this be tested?
+
+Step through the code line by line. Things to keep in mind as you review:
+ - Are there any edge cases not covered by this code?
+ - Does this code follow conventions (naming, formatting, modularization, etc) where applicable?
+
+## Related tickets?
+```
+
+## How to report a bug
+If you find a security vulnerability, do NOT open an issue. Email team@keen.io instead.
+
+If you find a bug that's not a security vulnerability please head over to the issues tab of this rep and open up an issue.
+
+We created these labels to help us organize issues: bugs, docs, enhancements, and feature-request. Please use them when creating an issue where it makes sense!
+
+## Suggesting features
+
+We welcome your feedback and requests. If you have a straight forward request please open up an issue that details the request. If you want to talk to someone on the Keen team head over to http://keen.chat or send a note to team@keen.io and we will make sure and get you in touch with the product team.
+
+# Code review process
+
+The core team looks at Pull Requests and issues on a regular basis and will typically respond within 5 business days.

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slate_algolia.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Keen IO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Slate_Algolia
+
+`slate_algolia` is a Middleman extension that allows you to easily and automatically index your [Slate docs](https://github.com/lord/slate) in [Algolia](https://www.algolia.com/)
+
+## Installation
+
+The most simple way to activate this is to add this code to your `config.rb`:
+
+```ruby
+activate :slate_algolia do |options|
+  options.application_id = 'ABCD'
+  options.api_key = '1234'
+end
+```
+
+You also need to add a line to the YAML Frontmatter of your Slate docs index. This is necessary because many companies embed Slate inside of a larger docs site.
+
+```YAML
+algolia_search: true
+```
+
+## Configuration
+
+There are some additional configurations you can enable:
+
+```ruby
+activate :slate_algolia do |options|
+  options.application_id = 'ABCD'  # Algolia Application ID
+  options.api_key        = '1234'  # Algolia API Key
+  options.dry_run        = true    # Don't send data to Algolia, but output some log information instead
+  options.parsers        = {}      # Custom tag parsers (discussed later in the docs)
+end
+```
+
+## Custom Tag Parser
+
+TODO

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict"
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'slate_algolia')

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'slate_algolia'

data/lib/slate_algolia/extension.rb

@@ -0,0 +1,79 @@
+require 'oga'
+require 'slate_algolia/parser'
+require 'slate_algolia/index'
+
+module Middleman
+    module SlateAlgolia
+        class Extension < Middleman::Extension
+            option :parsers, {}, 'Custom tag parsers'
+            option :dry_run, false, 'Send data to Algolia or not?'
+            option :application_id, '', 'Algolia Application ID'
+            option :api_key, '', 'Algolia API Key'
+
+            def initialize(app, options_hash={}, &block)
+                super
+
+                tag_parsers = set_parser_defaults(options.parsers)
+                dry_run = options.dry_run
+                application_id = options.application_id
+                api_key = options.api_key
+
+                app.after_build do |builder|
+                    sitemap.where(:algolia_search.equal => true).all.each do |slate_page|
+                        content_parser = Parser.new(slate_page, tag_parsers)
+
+                        if content_parser.sections.length > 0
+                            index = Index.new(application_id, api_key, dry_run)
+
+                            content_parser.sections.each do |section|
+                                index.queue_object(section)
+                            end
+
+                            index.flush_queue
+                            index.clean_index
+                        end
+                    end
+                end
+            end
+
+            private
+
+            def parser_defaults
+                {
+                    pre: -> (node, section, page) do 
+                        languages = node.get('class').split
+                        languages.delete('highlight')
+
+                        if languages.length
+
+                            # if the current language is in the list of language tabs
+                            if page.metadata[:page]['language_tabs'].include?(languages.first)
+                                code_type = :tabbed_code
+                            else
+                                code_type = :permanent_code
+                            end
+
+                            unless section[code_type]
+                                section[code_type] = {}
+                            end
+
+                            section[code_type][languages.first.to_sym] = node.text
+                        end
+                    end,
+
+                    blockquote: -> (node, section, page) do
+                        unless section[:annotations]
+                            section[:annotations] = []
+                        end
+
+                        section[:annotations].push(node.text)
+                    end
+                }
+            end
+
+            def set_parser_defaults(custom_parsers)
+                parser_defaults.merge(custom_parsers)
+            end
+        end
+    end
+end

data/lib/slate_algolia/index.rb

@@ -0,0 +1,51 @@
+require 'algoliasearch'
+
+module Middleman
+    module SlateAlgolia
+        class Index
+
+            def initialize(app_id, api_key, dry_run = false)
+                @publish = !dry_run
+                @published = []
+
+                Algolia.init :application_id => app_id,
+                             :api_key        => api_key
+
+                @index = Algolia::Index.new("API Docs")
+                @queue = []
+            end
+
+            def queue_object(data)
+                @queue.push(data)
+
+                if @queue.length >= 1000
+                    flush_queue()
+                end
+            end
+
+            def clean_index
+                old_content = @index.browse['hits'].reject { |hit|
+                    @published.any? { |entry| entry[:id] == hit['id'] }
+                }
+
+                if @publish
+                    @index.delete_objects(old_content.map { |hit| hit['objectID'] })
+                else
+                    puts "would have deleted #{old_content.size} items if not in dry mode"
+                end
+            end
+
+            def flush_queue
+                to_publish = @queue.reject { |obj| obj[:id].nil? }
+                if @publish
+                    @index.add_objects(to_publish)
+                else
+                    puts "would have published #{to_publish.size} items if not in dry mode"
+                end
+
+                @published.concat(to_publish)
+                @queue = []
+            end
+        end
+    end
+end

data/lib/slate_algolia/parser.rb

@@ -0,0 +1,58 @@
+require 'oga'
+
+module Middleman
+    module SlateAlgolia
+        class Parser
+
+            def initialize(middleman_page, parsers)
+                @middleman_page = middleman_page
+                @page = Oga.parse_html(middleman_page.render({}, {current_page: middleman_page }))
+                @parsers = parsers
+                get_content
+                generate_sections
+            end
+
+            def sections
+                @sections ||= []
+            end
+
+            private
+
+            def get_content
+                @content = @page.css('.content').first
+            end
+
+            def generate_sections
+                @sections = []
+                current_section = {title: 'introduction-header'}
+
+                @content.children.each do |node|
+                    next unless node.class  == Oga::XML::Element
+
+                    if node.name == 'h1' or node.name == 'h2'
+                        @sections.push(current_section) unless current_section[:title].nil? and current_section[:body].empty?
+                        current_section = {
+                            id: node.get('id'),
+                            title: node.text
+                        }
+                    else
+                        parser = @parsers[node.name.to_sym] || self.method(:default_tag_parser)
+                        parser.call(node, current_section, @middleman_page)
+                    end
+                end
+
+                @sections.push(current_section)
+            end
+
+            def default_tag_parser(node, section, page)
+                if section[:body]
+                    section[:body] += "\n"
+                else
+                    section[:body] = ""
+                end
+
+                section[:body] += node.text
+            end
+        end
+    end
+end

data/lib/slate_algolia.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+::Middleman::Extensions.register(:slate_algolia) do
+    require 'slate_algolia/extension'
+    ::Middleman::SlateAlgolia::Extension
+end

data/slate_algolia.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "slate_algolia"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joe Wegner"]
+  s.email       = ["joe@wegnerdesign.com"]
+  s.summary     = "Quickly and easily index Slate Docs in Algolia"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", ["~> 3.3", ">= 3.3.12"])
+  s.add_runtime_dependency("oga", ["~> 1.3", ">= 1.3.1"])
+  s.add_runtime_dependency("algoliasearch", ["~> 1.6", ">= 1.6.1"])
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: slate_algolia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Wegner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.12
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: algoliasearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: 
+email:
+- joe@wegnerdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman_extension.rb
+- lib/slate_algolia.rb
+- lib/slate_algolia/extension.rb
+- lib/slate_algolia/index.rb
+- lib/slate_algolia/parser.rb
+- slate_algolia.gemspec
+homepage: 
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Quickly and easily index Slate Docs in Algolia
+test_files:
+- features/support/env.rb