RubyGems - frontman-ssg - Versions diffs - 0.0.2 - Mend

frontman-ssg 0.0.2

Files changed (141) hide show

checksums.yaml +7 -0
data/.circleci/config.yml +42 -0
data/.github/CODE_OF_CONDUCT.md +9 -0
data/.github/ISSUE_TEMPLATE/bug_report.md +25 -0
data/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
data/.github/PULL_REQUEST_TEMPLATE.md +22 -0
data/.gitignore +5 -0
data/.rubocop.yml +88 -0
data/CHANGELOG.md +11 -0
data/CONTRIBUTING.md +42 -0
data/Gemfile +5 -0
data/LICENSE.md +21 -0
data/Rakefile +94 -0
data/SECURITY.md +6 -0
data/bin/frontman +6 -0
data/frontman-ssg.gemspec +48 -0
data/frontman.svg +2 -0
data/lib/frontman.rb +15 -0
data/lib/frontman/app.rb +175 -0
data/lib/frontman/bootstrapper.rb +70 -0
data/lib/frontman/builder/asset_pipeline.rb +55 -0
data/lib/frontman/builder/builder.rb +193 -0
data/lib/frontman/builder/file.rb +55 -0
data/lib/frontman/builder/mapping.rb +54 -0
data/lib/frontman/builder/statistics_collector.rb +37 -0
data/lib/frontman/cli.rb +6 -0
data/lib/frontman/commands/build.rb +76 -0
data/lib/frontman/commands/init.rb +58 -0
data/lib/frontman/commands/serve.rb +110 -0
data/lib/frontman/concerns/dispatch_events.rb +56 -0
data/lib/frontman/concerns/forward_calls_to_app.rb +28 -0
data/lib/frontman/config.rb +52 -0
data/lib/frontman/context.rb +125 -0
data/lib/frontman/custom_struct.rb +44 -0
data/lib/frontman/data_store.rb +106 -0
data/lib/frontman/data_store_file.rb +60 -0
data/lib/frontman/helpers/app_helper.rb +18 -0
data/lib/frontman/helpers/link_helper.rb +35 -0
data/lib/frontman/helpers/render_helper.rb +76 -0
data/lib/frontman/helpers/url_helper.rb +11 -0
data/lib/frontman/iterator.rb +48 -0
data/lib/frontman/process/chain.rb +43 -0
data/lib/frontman/process/processor.rb +11 -0
data/lib/frontman/renderers/erb_renderer.rb +21 -0
data/lib/frontman/renderers/haml_renderer.rb +22 -0
data/lib/frontman/renderers/markdown_renderer.rb +26 -0
data/lib/frontman/renderers/renderer.rb +26 -0
data/lib/frontman/renderers/renderer_resolver.rb +26 -0
data/lib/frontman/resource.rb +279 -0
data/lib/frontman/sitemap_tree.rb +211 -0
data/lib/frontman/toolbox/timer.rb +49 -0
data/lib/frontman/version.rb +6 -0
data/project-templates/default/.gitignore +2 -0
data/project-templates/default/Gemfile +3 -0
data/project-templates/default/config.rb +17 -0
data/project-templates/default/data/site.yml +4 -0
data/project-templates/default/helpers/site_helper.rb +7 -0
data/project-templates/default/public/code.css +77 -0
data/project-templates/default/public/frontman-logo.svg +2 -0
data/project-templates/default/public/main.css +27 -0
data/project-templates/default/public/main.js +1 -0
data/project-templates/default/source/index.html.md.erb +7 -0
data/project-templates/default/source/sitemap.xml.erb +11 -0
data/project-templates/default/views/layouts/main.erb +19 -0
data/project-templates/default/views/layouts/main.haml +15 -0
data/project-templates/default/views/partials/menu.erb +7 -0
data/project-templates/webpack/.gitignore +4 -0
data/project-templates/webpack/Gemfile +3 -0
data/project-templates/webpack/README.md +54 -0
data/project-templates/webpack/assets/css/code.css +77 -0
data/project-templates/webpack/assets/css/style.css +27 -0
data/project-templates/webpack/assets/images/.gitkeep +0 -0
data/project-templates/webpack/assets/images/frontman_logo.svg +2 -0
data/project-templates/webpack/assets/js/index.js +1 -0
data/project-templates/webpack/config.rb +24 -0
data/project-templates/webpack/data/site.yml +4 -0
data/project-templates/webpack/helpers/assets_helper.rb +24 -0
data/project-templates/webpack/helpers/site_helper.rb +7 -0
data/project-templates/webpack/package-lock.json +7603 -0
data/project-templates/webpack/package.json +34 -0
data/project-templates/webpack/source/index.html.md.erb +7 -0
data/project-templates/webpack/source/sitemap.xml.erb +11 -0
data/project-templates/webpack/views/layouts/main.erb +20 -0
data/project-templates/webpack/views/layouts/main.haml +14 -0
data/project-templates/webpack/views/partials/menu.erb +7 -0
data/project-templates/webpack/views/partials/script_with_vendors.haml +5 -0
data/project-templates/webpack/webpack/base.config.js +51 -0
data/project-templates/webpack/webpack/dev.config.js +6 -0
data/project-templates/webpack/webpack/prod.config.js +30 -0
data/readme.md +80 -0
data/sorbet/config +2 -0
data/sorbet/rbi/hidden-definitions/errors.txt +27259 -0
data/sorbet/rbi/hidden-definitions/hidden.rbi +45122 -0
data/sorbet/rbi/sorbet-typed/lib/rainbow/all/rainbow.rbi +276 -0
data/sorbet/rbi/todo.rbi +6 -0
data/spec/frontman/app_spec.rb +48 -0
data/spec/frontman/bootstrapper_spec.rb +26 -0
data/spec/frontman/builder/builder_spec.rb +79 -0
data/spec/frontman/builder/file_spec.rb +45 -0
data/spec/frontman/builder/mapping_spec.rb +8 -0
data/spec/frontman/concerns/dispatch_events_spec.rb +70 -0
data/spec/frontman/concerns/forward_calls_to_app_spec.rb +21 -0
data/spec/frontman/config_spec.rb +54 -0
data/spec/frontman/context_spec.rb +48 -0
data/spec/frontman/custom_struct_spec.rb +51 -0
data/spec/frontman/data_store_file_spec.rb +9 -0
data/spec/frontman/data_store_spec.rb +36 -0
data/spec/frontman/frontman_ssg_spec.rb +7 -0
data/spec/frontman/helpers/app_helper_spec.rb +24 -0
data/spec/frontman/helpers/link_helper_spec.rb +37 -0
data/spec/frontman/helpers/render_helper_spec.rb +55 -0
data/spec/frontman/helpers/url_helper_spec.rb +21 -0
data/spec/frontman/iterator_spec.rb +47 -0
data/spec/frontman/mocks/asset.css +3 -0
data/spec/frontman/mocks/config.rb +0 -0
data/spec/frontman/mocks/helpers/formatting_helper.rb +5 -0
data/spec/frontman/mocks/helpers/language_helper.rb +5 -0
data/spec/frontman/mocks/helpers/link_helper.rb +5 -0
data/spec/frontman/mocks/helpers/test_command.rb +5 -0
data/spec/frontman/mocks/html_file.html +8 -0
data/spec/frontman/mocks/html_file.html.md.erb +9 -0
data/spec/frontman/mocks/html_file.md.html +8 -0
data/spec/frontman/mocks/info.yml +4 -0
data/spec/frontman/mocks/layouts/raw_without_body.haml +1 -0
data/spec/frontman/mocks/nested/data.yml +4 -0
data/spec/frontman/mocks/nested/more_data.yml +4 -0
data/spec/frontman/mocks/partials/paragraph.haml +2 -0
data/spec/frontman/mocks/snippet/html_file.html +8 -0
data/spec/frontman/mocks/snippet/html_file.yml +670 -0
data/spec/frontman/mocks/test.html +8 -0
data/spec/frontman/mocks/wrap.haml +3 -0
data/spec/frontman/process/chain_spec.rb +56 -0
data/spec/frontman/renderers/erb_renderer_spec.rb +22 -0
data/spec/frontman/renderers/haml_renderer_spec.rb +12 -0
data/spec/frontman/renderers/markdown_renderer_spec.rb +12 -0
data/spec/frontman/renderers/renderer_spec.rb +16 -0
data/spec/frontman/resource_spec.rb +151 -0
data/spec/frontman/sitemap_tree_spec.rb +128 -0
data/spec/frontman/toolbox/timer_spec.rb +34 -0
data/spec/spec_setup.rb +19 -0
metadata +507 -0

data/spec/frontman/iterator_spec.rb ADDED

@@ -0,0 +1,47 @@
+# typed: false
+# frozen_string_literal: true
+require './spec/spec_setup'
+require 'parallel'
+require 'frontman/config'
+require 'frontman/iterator'
+describe Frontman::Iterator do
+  before(:each) do
+    Frontman::Config.all.keys.each do |key|
+      Frontman::Config.delete(key)
+    end
+  end
+  it 'should run in parallel by default' do
+    expect(Parallel).to receive(:map)
+    Frontman::Iterator.map []
+  end
+  it 'should not run in parallel if config says so' do
+    expect(Parallel).to_not receive(:map)
+    Frontman::Config.set :parallel, false
+    Frontman::Iterator.map []
+  end
+  context 'processor count' do
+    it 'should take the config value if not running in parallel' do
+      Frontman::Config.set :parallel, false
+      Frontman::Config.set :processor_count, 2
+      expect(Frontman::Iterator.processor_count).to eq 2
+    end
+    it 'should use Parallels method if running in parallel' do
+      expect(Frontman::Iterator.processor_count).to eq Parallel.processor_count
+    end
+    it 'should default to 1 if not running in parallel and no config is provided' do
+      Frontman::Config.set :parallel, false
+      expect(Frontman::Iterator.processor_count).to eq 1
+    end
+  end
+end

data/spec/frontman/mocks/asset.css ADDED

@@ -0,0 +1,3 @@
+body {
+    color: green;
+}

data/spec/frontman/mocks/config.rb ADDED

File without changes

data/spec/frontman/mocks/helpers/formatting_helper.rb ADDED

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+module FormattingHelper
+end

data/spec/frontman/mocks/helpers/language_helper.rb ADDED

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+module LanguageHelper
+end

data/spec/frontman/mocks/helpers/link_helper.rb ADDED

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+module LinkHelper
+end

data/spec/frontman/mocks/helpers/test_command.rb ADDED

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+module TestCommand
+end

data/spec/frontman/mocks/html_file.html ADDED

@@ -0,0 +1,8 @@
+<!DOCTYPE html> <html lang=en> <head> <title> Quick Start | Magento 1 extension | Algolia Documentation </title>
+</head> <body class=relative><main class='lg:max-w-648 min-h-full w-full'> <div class='text-grey-1000 leading-normal'> <section class=mb-48> <div class="mb-4 flex justify-between"> <div class="text-xs leading-tight"> <div class="font-sans-alt uppercase font-semibold tracking-wide"> Integrations / Extensions / <span class=text-nebula-500>Magento 1</span> </div> </div> <div class="flex items-center uppercase font-semibold tracking-wide text-grey-1000-opacity-30 text-xs leading-tight whitespace-no-wrap font-sans-alt"> <span class="block mr-4 w-16 h-16 fill-current"> <span class="block p-2"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><path d="M11,22A11,11,0,1,1,22,11,11,11,0,0,1,11,22ZM11,2a9,9,0,1,0,9,9A9,9,0,0,0,11,2Z"/><path d="M15,14a.93.93,0,0,1-.45-.11l-4-2A1,1,0,0,1,10,11V5a1,1,0,0,1,2,0v5.38l3.45,1.73a1,1,0,0,1,.44,1.34A1,1,0,0,1,15,14Z"/></svg> </span> </span> Feb. 15, 2019 </div> </div> <div class="flex justify-between"> <h1 class="md:text-4xl lg:text-5xl text-3xl leading-tall tracking-tight font-bold hyphenated"> Quick Start </h1> <div class="mt-16 ml-16"> <a class='edit-link w-24 h-24 items-center justify-center bg-grey-400-opacity-40 hover:bg-grey-400-opacity-60 rounded-full transition-fast-out hidden' href='https://github.com/algolia/doc/edit/master/source/doc/integration/magento-1/1-getting-started/1-quick-start.html.md.erb' rel=noopener target=_blank> <span class='flex items-center justify-center w-16 h-16 text-grey-700 fill-current'> <svg class=h-full xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32.58 31.77"><path d="M16.29,0a16.29,16.29,0,0,0-5.15,31.75c.82.15,1.11-.36,1.11-.79s0-1.41,0-2.77C7.7,29.18,6.74,26,6.74,26a4.36,4.36,0,0,0-1.81-2.39c-1.47-1,.12-1,.12-1a3.43,3.43,0,0,1,2.49,1.68,3.48,3.48,0,0,0,4.74,1.36,3.46,3.46,0,0,1,1-2.18c-3.62-.41-7.42-1.81-7.42-8a6.3,6.3,0,0,1,1.67-4.37,5.94,5.94,0,0,1,.16-4.31s1.37-.44,4.48,1.67a15.41,15.41,0,0,1,8.16,0c3.11-2.11,4.47-1.67,4.47-1.67A5.91,5.91,0,0,1,25,11.07a6.3,6.3,0,0,1,1.67,4.37c0,6.26-3.81,7.63-7.44,8a3.85,3.85,0,0,1,1.11,3c0,2.18,0,3.94,0,4.47s.29.94,1.12.78A16.29,16.29,0,0,0,16.29,0Z"/></svg> <span aria-hidden=true class=hidden> Edit this guide </span> </span> </a> </div> </div> </section> <div class='content mb-32'> <section> <p>To get started using Algolia in your Magento installation, just follow the steps in this video or on the page below.</p> <div class="flex transition-fast-in-out items-center" data-video=true> <div class="group embed flex-no-grow flex-no-shrink md:w-248 border-l-4 border-solid border-red-500-opacity-80 shadow-md rounded-r overflow-hidden mt-0 mb-0 transition-fast-in-out" data-video-container=DUuv9ALS5cM> <div class=embed-item data-video-frame=DUuv9ALS5cM data-video-start=0 id=DUuv9ALS5cM></div> <div class="absolute pin bg-center bg-cover pointer-events-none flex items-center justify-center" data-video-thumbnail=true style="background-image: url(https://img.youtube.com/vi/DUuv9ALS5cM/hqdefault.jpg)"> <div class="py-16 px-32 rounded-lg bg-gradient-red-400-red-500 shadow group-hover:shadow-md cursor-pointer transition-fast-out"> <div class="m-4 h-24 text-white"> <div class="h-full fill-current"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 8 10"><polygon points="0 0 0 10 8 5 0 0"/></svg> </div> </div> </div> </div> </div> <div class="ml-32 md:block hidden" data-video-description=true> <div> <div class="mb-8 text-grey-1000 font-bold text-lg"> Algolia Instant Search on your Magento Store </div> <div class=text-grey-400> By Algolia, 17 min </div> </div> </div> </div> <h2 id=installation>Installation</h2> <p>There are two possible ways to install the extension:</p> <ol> <li>Through <a href="https://github.com/colinmollenhour/modman">modman</a></li> <li>Through <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a></li> </ol> <h3 id=modman>Modman</h3> <p>With <a href="https://github.com/colinmollenhour/modman">modman</a> installed, run the following commands:</p> <div class=snippet-wrapper><div class=snippet-actions markdown=0><div class="copy-link snippet-action btn-satellite btn-satellite-white ml-8">Copy</div></div><div class=snippet-header><div class="nav nav-tabs snippet-tabs" markdown=0><span class="snippet-tab-wrapper snippet-tab-wrapper-active"><a href="#snippet_bash" data-toggle=tab class=snippet-tab>bash</a></span></div></div><div id=snippet_bash data-tab-pane class="snippet-body snippet-body-active" data-active=true data-language=bash><div class=highlight><pre class="highlight shell"><code><span class="nb">cd</span> /path/to/your/magento/directory
+modman init
+modman clone https://github.com/algolia/algoliasearch-magento.git
+</code></pre></div></div></div> <h3 id=magento-marketplace>Magento Marketplace</h3> <p>Navigate to the <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a> to get the extension and follow the instructions to install.</p> <h2 id=configuration>Configuration</h2> <p>Before Algolia can be used with Magento, an Algolia account is needed. With the account, it’s possible to configure the Magento extension to work properly.</p> <h3 id=algolia-account>Algolia account</h3> <p>An account can be created in the <a href="/users/sign_up">sign-up wizard</a>.</p> <p class="alert alert-info">Pay attention while picking a data center during the sign-up. For performance reasons, it’s best to pick the one closest to the data center of your Magento installation.</p> <h3 id=magento-settings>Magento settings</h3> <p>To configure the Magento extension, you will need the following Algolia credentials:</p> <ul> <li>Application ID</li> <li><a href="/doc/guides/security/api-keys/#search-only-api-key">Search-only API key</a></li> <li><a href="/doc/guides/security/api-keys/#admin-api-key">Admin API key</a></li> </ul> <p>These credentials can be found on the <a href="/dashboard">Algolia Dashboard</a>, on the <strong>API keys</strong> page from the menu.</p> <p>In the administration section of your Magento project, navigate to <strong>System &gt; Configuration &gt; Catalog &gt; Algolia Search</strong> and fill in the form with all the information required.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/configuration-ef05486e.png" alt="Basic information configuration"/></p> </figure> </section> <section> <h2 id=indexing>Indexing</h2> <p>With the extension configured, the data in your Magento installation should be pushed to Algolia for the first time by a process called <a href="/doc/guides/getting-started/how-algolia-works/in-depth/implementation-process/#indexing-data"><em>indexing</em></a>. This can be accomplished by navigating to <strong>System &gt; Indexing Management</strong>. On this page, a list of indices will show up for which the <strong>Reindex Data</strong> link has to be clicked:</p> <ul> <li>Algolia Search Products</li> <li>Algolia Search Categories</li> <li>Algolia Search Pages</li> <li>Algolia Search Suggestions</li> </ul> <p>When the indexing is done, the search should now be available in your Magento installation.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/indexers-a88f04f2.png" alt="Magento store indexers"/></p> </figure> </section> </div> <div class=mt-88>
+</div></div></main></body>
+</html>

data/spec/frontman/mocks/html_file.html.md.erb ADDED

@@ -0,0 +1,9 @@
+<!DOCTYPE html> <html lang=en> <head> <title> Quick Start | Magento 1 extension | Algolia Documentation </title>
+</head> <body class=relative><main class='lg:max-w-648 min-h-full w-full'> <div class='text-grey-1000 leading-normal'> <section class=mb-48> <div class="mb-4 flex justify-between"> <div class="text-xs leading-tight"> <div class="font-sans-alt uppercase font-semibold tracking-wide"> Integrations / Extensions / <span class=text-nebula-500>Magento 1</span> </div> </div> <div class="flex items-center uppercase font-semibold tracking-wide text-grey-1000-opacity-30 text-xs leading-tight whitespace-no-wrap font-sans-alt"> <span class="block mr-4 w-16 h-16 fill-current"> <span class="block p-2"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><path d="M11,22A11,11,0,1,1,22,11,11,11,0,0,1,11,22ZM11,2a9,9,0,1,0,9,9A9,9,0,0,0,11,2Z"/><path d="M15,14a.93.93,0,0,1-.45-.11l-4-2A1,1,0,0,1,10,11V5a1,1,0,0,1,2,0v5.38l3.45,1.73a1,1,0,0,1,.44,1.34A1,1,0,0,1,15,14Z"/></svg> </span> </span> Feb. 15, 2019 </div> </div> <div class="flex justify-between"> <h1 class="md:text-4xl lg:text-5xl text-3xl leading-tall tracking-tight font-bold hyphenated"> Quick Start </h1> <div class="mt-16 ml-16"> <a class='edit-link w-24 h-24 items-center justify-center bg-grey-400-opacity-40 hover:bg-grey-400-opacity-60 rounded-full transition-fast-out hidden' href='https://github.com/algolia/doc/edit/master/source/doc/integration/magento-1/1-getting-started/1-quick-start.html.md.erb' rel=noopener target=_blank> <span class='flex items-center justify-center w-16 h-16 text-grey-700 fill-current'> <svg class=h-full xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32.58 31.77"><path d="M16.29,0a16.29,16.29,0,0,0-5.15,31.75c.82.15,1.11-.36,1.11-.79s0-1.41,0-2.77C7.7,29.18,6.74,26,6.74,26a4.36,4.36,0,0,0-1.81-2.39c-1.47-1,.12-1,.12-1a3.43,3.43,0,0,1,2.49,1.68,3.48,3.48,0,0,0,4.74,1.36,3.46,3.46,0,0,1,1-2.18c-3.62-.41-7.42-1.81-7.42-8a6.3,6.3,0,0,1,1.67-4.37,5.94,5.94,0,0,1,.16-4.31s1.37-.44,4.48,1.67a15.41,15.41,0,0,1,8.16,0c3.11-2.11,4.47-1.67,4.47-1.67A5.91,5.91,0,0,1,25,11.07a6.3,6.3,0,0,1,1.67,4.37c0,6.26-3.81,7.63-7.44,8a3.85,3.85,0,0,1,1.11,3c0,2.18,0,3.94,0,4.47s.29.94,1.12.78A16.29,16.29,0,0,0,16.29,0Z"/></svg> <span aria-hidden=true class=hidden> Edit this guide </span> </span> </a> </div> </div> </section> <div class='content mb-32'> <section> <p>To get started using Algolia in your Magento installation, just follow the steps in this video or on the page below.</p> <div class="flex transition-fast-in-out items-center" data-video=true> <div class="group embed flex-no-grow flex-no-shrink md:w-248 border-l-4 border-solid border-red-500-opacity-80 shadow-md rounded-r overflow-hidden mt-0 mb-0 transition-fast-in-out" data-video-container=DUuv9ALS5cM> <div class=embed-item data-video-frame=DUuv9ALS5cM data-video-start=0 id=DUuv9ALS5cM></div> <div class="absolute pin bg-center bg-cover pointer-events-none flex items-center justify-center" data-video-thumbnail=true style="background-image: url(https://img.youtube.com/vi/DUuv9ALS5cM/hqdefault.jpg)"> <div class="py-16 px-32 rounded-lg bg-gradient-red-400-red-500 shadow group-hover:shadow-md cursor-pointer transition-fast-out"> <div class="m-4 h-24 text-white"> <div class="h-full fill-current"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 8 10"><polygon points="0 0 0 10 8 5 0 0"/></svg> </div> </div> </div> </div> </div> <div class="ml-32 md:block hidden" data-video-description=true> <div> <div class="mb-8 text-grey-1000 font-bold text-lg"> Algolia Instant Search on your Magento Store </div> <div class=text-grey-400> By Algolia, 17 min </div> </div> </div> </div> <h2 id=installation>Installation</h2> <p>There are two possible ways to install the extension:</p> <ol> <li>Through <a href="https://github.com/colinmollenhour/modman">modman</a></li> <li>Through <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a></li> </ol> <h3 id=modman>Modman</h3> <p>With <a href="https://github.com/colinmollenhour/modman">modman</a> installed, run the following commands:</p> <div class=snippet-wrapper><div class=snippet-actions markdown=0><div class="copy-link snippet-action btn-satellite btn-satellite-white ml-8">Copy</div></div><div class=snippet-header><div class="nav nav-tabs snippet-tabs" markdown=0><span class="snippet-tab-wrapper snippet-tab-wrapper-active"><a href="#snippet_bash" data-toggle=tab class=snippet-tab>bash</a></span></div></div><div id=snippet_bash data-tab-pane class="snippet-body snippet-body-active" data-active=true data-language=bash><div class=highlight><pre class="highlight shell"><code><span class="nb">cd</span> /path/to/your/magento/directory
+modman init
+modman clone https://github.com/algolia/algoliasearch-magento.git
+<%= 'testing erb' %>
+</code></pre></div></div></div> <h3 id=magento-marketplace>Magento Marketplace</h3> <p>Navigate to the <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a> to get the extension and follow the instructions to install.</p> <h2 id=configuration>Configuration</h2> <p>Before Algolia can be used with Magento, an Algolia account is needed. With the account, it’s possible to configure the Magento extension to work properly.</p> <h3 id=algolia-account>Algolia account</h3> <p>An account can be created in the <a href="/users/sign_up">sign-up wizard</a>.</p> <p class="alert alert-info">Pay attention while picking a data center during the sign-up. For performance reasons, it’s best to pick the one closest to the data center of your Magento installation.</p> <h3 id=magento-settings>Magento settings</h3> <p>To configure the Magento extension, you will need the following Algolia credentials:</p> <ul> <li>Application ID</li> <li><a href="/doc/guides/security/api-keys/#search-only-api-key">Search-only API key</a></li> <li><a href="/doc/guides/security/api-keys/#admin-api-key">Admin API key</a></li> </ul> <p>These credentials can be found on the <a href="/dashboard">Algolia Dashboard</a>, on the <strong>API keys</strong> page from the menu.</p> <p>In the administration section of your Magento project, navigate to <strong>System &gt; Configuration &gt; Catalog &gt; Algolia Search</strong> and fill in the form with all the information required.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/configuration-ef05486e.png" alt="Basic information configuration"/></p> </figure> </section> <section> <h2 id=indexing>Indexing</h2> <p>With the extension configured, the data in your Magento installation should be pushed to Algolia for the first time by a process called <a href="/doc/guides/getting-started/how-algolia-works/in-depth/implementation-process/#indexing-data"><em>indexing</em></a>. This can be accomplished by navigating to <strong>System &gt; Indexing Management</strong>. On this page, a list of indices will show up for which the <strong>Reindex Data</strong> link has to be clicked:</p> <ul> <li>Algolia Search Products</li> <li>Algolia Search Categories</li> <li>Algolia Search Pages</li> <li>Algolia Search Suggestions</li> </ul> <p>When the indexing is done, the search should now be available in your Magento installation.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/indexers-a88f04f2.png" alt="Magento store indexers"/></p> </figure> </section> </div> <div class=mt-88>
+</div></div></main></body>
+</html>

data/spec/frontman/mocks/html_file.md.html ADDED

@@ -0,0 +1,8 @@
+<!DOCTYPE html> <html lang=en> <head> <title> Quick Start | Magento 1 extension | Algolia Documentation </title>
+</head> <body class=relative><main class='lg:max-w-648 min-h-full w-full'> <div class='text-grey-1000 leading-normal'> <section class=mb-48> <div class="mb-4 flex justify-between"> <div class="text-xs leading-tight"> <div class="font-sans-alt uppercase font-semibold tracking-wide"> Integrations / Extensions / <span class=text-nebula-500>Magento 1</span> </div> </div> <div class="flex items-center uppercase font-semibold tracking-wide text-grey-1000-opacity-30 text-xs leading-tight whitespace-no-wrap font-sans-alt"> <span class="block mr-4 w-16 h-16 fill-current"> <span class="block p-2"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><path d="M11,22A11,11,0,1,1,22,11,11,11,0,0,1,11,22ZM11,2a9,9,0,1,0,9,9A9,9,0,0,0,11,2Z"/><path d="M15,14a.93.93,0,0,1-.45-.11l-4-2A1,1,0,0,1,10,11V5a1,1,0,0,1,2,0v5.38l3.45,1.73a1,1,0,0,1,.44,1.34A1,1,0,0,1,15,14Z"/></svg> </span> </span> Feb. 15, 2019 </div> </div> <div class="flex justify-between"> <h1 class="md:text-4xl lg:text-5xl text-3xl leading-tall tracking-tight font-bold hyphenated"> Quick Start </h1> <div class="mt-16 ml-16"> <a class='edit-link w-24 h-24 items-center justify-center bg-grey-400-opacity-40 hover:bg-grey-400-opacity-60 rounded-full transition-fast-out hidden' href='https://github.com/algolia/doc/edit/master/source/doc/integration/magento-1/1-getting-started/1-quick-start.html.md.erb' rel=noopener target=_blank> <span class='flex items-center justify-center w-16 h-16 text-grey-700 fill-current'> <svg class=h-full xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32.58 31.77"><path d="M16.29,0a16.29,16.29,0,0,0-5.15,31.75c.82.15,1.11-.36,1.11-.79s0-1.41,0-2.77C7.7,29.18,6.74,26,6.74,26a4.36,4.36,0,0,0-1.81-2.39c-1.47-1,.12-1,.12-1a3.43,3.43,0,0,1,2.49,1.68,3.48,3.48,0,0,0,4.74,1.36,3.46,3.46,0,0,1,1-2.18c-3.62-.41-7.42-1.81-7.42-8a6.3,6.3,0,0,1,1.67-4.37,5.94,5.94,0,0,1,.16-4.31s1.37-.44,4.48,1.67a15.41,15.41,0,0,1,8.16,0c3.11-2.11,4.47-1.67,4.47-1.67A5.91,5.91,0,0,1,25,11.07a6.3,6.3,0,0,1,1.67,4.37c0,6.26-3.81,7.63-7.44,8a3.85,3.85,0,0,1,1.11,3c0,2.18,0,3.94,0,4.47s.29.94,1.12.78A16.29,16.29,0,0,0,16.29,0Z"/></svg> <span aria-hidden=true class=hidden> Edit this guide </span> </span> </a> </div> </div> </section> <div class='content mb-32'> <section> <p>To get started using Algolia in your Magento installation, just follow the steps in this video or on the page below.</p> <div class="flex transition-fast-in-out items-center" data-video=true> <div class="group embed flex-no-grow flex-no-shrink md:w-248 border-l-4 border-solid border-red-500-opacity-80 shadow-md rounded-r overflow-hidden mt-0 mb-0 transition-fast-in-out" data-video-container=DUuv9ALS5cM> <div class=embed-item data-video-frame=DUuv9ALS5cM data-video-start=0 id=DUuv9ALS5cM></div> <div class="absolute pin bg-center bg-cover pointer-events-none flex items-center justify-center" data-video-thumbnail=true style="background-image: url(https://img.youtube.com/vi/DUuv9ALS5cM/hqdefault.jpg)"> <div class="py-16 px-32 rounded-lg bg-gradient-red-400-red-500 shadow group-hover:shadow-md cursor-pointer transition-fast-out"> <div class="m-4 h-24 text-white"> <div class="h-full fill-current"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 8 10"><polygon points="0 0 0 10 8 5 0 0"/></svg> </div> </div> </div> </div> </div> <div class="ml-32 md:block hidden" data-video-description=true> <div> <div class="mb-8 text-grey-1000 font-bold text-lg"> Algolia Instant Search on your Magento Store </div> <div class=text-grey-400> By Algolia, 17 min </div> </div> </div> </div> <h2 id=installation>Installation</h2> <p>There are two possible ways to install the extension:</p> <ol> <li>Through <a href="https://github.com/colinmollenhour/modman">modman</a></li> <li>Through <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a></li> </ol> <h3 id=modman>Modman</h3> <p>With <a href="https://github.com/colinmollenhour/modman">modman</a> installed, run the following commands:</p> <div class=snippet-wrapper><div class=snippet-actions markdown=0><div class="copy-link snippet-action btn-satellite btn-satellite-white ml-8">Copy</div></div><div class=snippet-header><div class="nav nav-tabs snippet-tabs" markdown=0><span class="snippet-tab-wrapper snippet-tab-wrapper-active"><a href="#snippet_bash" data-toggle=tab class=snippet-tab>bash</a></span></div></div><div id=snippet_bash data-tab-pane class="snippet-body snippet-body-active" data-active=true data-language=bash><div class=highlight><pre class="highlight shell"><code><span class="nb">cd</span> /path/to/your/magento/directory
+modman init
+modman clone https://github.com/algolia/algoliasearch-magento.git
+</code></pre></div></div></div> <h3 id=magento-marketplace>Magento Marketplace</h3> <p>Navigate to the <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a> to get the extension and follow the instructions to install.</p> <h2 id=configuration>Configuration</h2> <p>Before Algolia can be used with Magento, an Algolia account is needed. With the account, it’s possible to configure the Magento extension to work properly.</p> <h3 id=algolia-account>Algolia account</h3> <p>An account can be created in the <a href="/users/sign_up">sign-up wizard</a>.</p> <p class="alert alert-info">Pay attention while picking a data center during the sign-up. For performance reasons, it’s best to pick the one closest to the data center of your Magento installation.</p> <h3 id=magento-settings>Magento settings</h3> <p>To configure the Magento extension, you will need the following Algolia credentials:</p> <ul> <li>Application ID</li> <li><a href="/doc/guides/security/api-keys/#search-only-api-key">Search-only API key</a></li> <li><a href="/doc/guides/security/api-keys/#admin-api-key">Admin API key</a></li> </ul> <p>These credentials can be found on the <a href="/dashboard">Algolia Dashboard</a>, on the <strong>API keys</strong> page from the menu.</p> <p>In the administration section of your Magento project, navigate to <strong>System &gt; Configuration &gt; Catalog &gt; Algolia Search</strong> and fill in the form with all the information required.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/configuration-ef05486e.png" alt="Basic information configuration"/></p> </figure> </section> <section> <h2 id=indexing>Indexing</h2> <p>With the extension configured, the data in your Magento installation should be pushed to Algolia for the first time by a process called <a href="/doc/guides/getting-started/how-algolia-works/in-depth/implementation-process/#indexing-data"><em>indexing</em></a>. This can be accomplished by navigating to <strong>System &gt; Indexing Management</strong>. On this page, a list of indices will show up for which the <strong>Reindex Data</strong> link has to be clicked:</p> <ul> <li>Algolia Search Products</li> <li>Algolia Search Categories</li> <li>Algolia Search Pages</li> <li>Algolia Search Suggestions</li> </ul> <p>When the indexing is done, the search should now be available in your Magento installation.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/indexers-a88f04f2.png" alt="Magento store indexers"/></p> </figure> </section> </div> <div class=mt-88>
+</div></div></main></body>
+</html>

data/spec/frontman/mocks/info.yml ADDED

@@ -0,0 +1,4 @@
+name: test
+types:
+  - test1
+  - test2

data/spec/frontman/mocks/layouts/raw_without_body.haml ADDED

	@@ -0,0 +1 @@
1	+ = yield

data/spec/frontman/mocks/nested/data.yml ADDED

@@ -0,0 +1,4 @@
+name: test
+types:
+  - test1
+  - test2

data/spec/frontman/mocks/nested/more_data.yml ADDED

@@ -0,0 +1,4 @@
+name: test
+types:
+  - test1
+  - test2

data/spec/frontman/mocks/partials/paragraph.haml ADDED

	@@ -0,0 +1,2 @@
1	+ %p
2	+ = "The passed text: #{text}"

data/spec/frontman/mocks/snippet/html_file.html ADDED

@@ -0,0 +1,8 @@
+<!DOCTYPE html> <html lang=en> <head> <title> Quick Start | Magento 1 extension | Algolia Documentation </title>
+</head> <body class=relative><main class='lg:max-w-648 min-h-full w-full'> <div class='text-grey-1000 leading-normal'> <section class=mb-48> <div class="mb-4 flex justify-between"> <div class="text-xs leading-tight"> <div class="font-sans-alt uppercase font-semibold tracking-wide"> Integrations / Extensions / <span class=text-nebula-500>Magento 1</span> </div> </div> <div class="flex items-center uppercase font-semibold tracking-wide text-grey-1000-opacity-30 text-xs leading-tight whitespace-no-wrap font-sans-alt"> <span class="block mr-4 w-16 h-16 fill-current"> <span class="block p-2"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><path d="M11,22A11,11,0,1,1,22,11,11,11,0,0,1,11,22ZM11,2a9,9,0,1,0,9,9A9,9,0,0,0,11,2Z"/><path d="M15,14a.93.93,0,0,1-.45-.11l-4-2A1,1,0,0,1,10,11V5a1,1,0,0,1,2,0v5.38l3.45,1.73a1,1,0,0,1,.44,1.34A1,1,0,0,1,15,14Z"/></svg> </span> </span> Feb. 15, 2019 </div> </div> <div class="flex justify-between"> <h1 class="md:text-4xl lg:text-5xl text-3xl leading-tall tracking-tight font-bold hyphenated"> Quick Start </h1> <div class="mt-16 ml-16"> <a class='edit-link w-24 h-24 items-center justify-center bg-grey-400-opacity-40 hover:bg-grey-400-opacity-60 rounded-full transition-fast-out hidden' href='https://github.com/algolia/doc/edit/master/source/doc/integration/magento-1/1-getting-started/1-quick-start.html.md.erb' rel=noopener target=_blank> <span class='flex items-center justify-center w-16 h-16 text-grey-700 fill-current'> <svg class=h-full xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32.58 31.77"><path d="M16.29,0a16.29,16.29,0,0,0-5.15,31.75c.82.15,1.11-.36,1.11-.79s0-1.41,0-2.77C7.7,29.18,6.74,26,6.74,26a4.36,4.36,0,0,0-1.81-2.39c-1.47-1,.12-1,.12-1a3.43,3.43,0,0,1,2.49,1.68,3.48,3.48,0,0,0,4.74,1.36,3.46,3.46,0,0,1,1-2.18c-3.62-.41-7.42-1.81-7.42-8a6.3,6.3,0,0,1,1.67-4.37,5.94,5.94,0,0,1,.16-4.31s1.37-.44,4.48,1.67a15.41,15.41,0,0,1,8.16,0c3.11-2.11,4.47-1.67,4.47-1.67A5.91,5.91,0,0,1,25,11.07a6.3,6.3,0,0,1,1.67,4.37c0,6.26-3.81,7.63-7.44,8a3.85,3.85,0,0,1,1.11,3c0,2.18,0,3.94,0,4.47s.29.94,1.12.78A16.29,16.29,0,0,0,16.29,0Z"/></svg> <span aria-hidden=true class=hidden> Edit this guide </span> </span> </a> </div> </div> </section> <div class='content mb-32'> <section> <p>To get started using Algolia in your Magento installation, just follow the steps in this video or on the page below.</p> <div class="flex transition-fast-in-out items-center" data-video=true> <div class="group embed flex-no-grow flex-no-shrink md:w-248 border-l-4 border-solid border-red-500-opacity-80 shadow-md rounded-r overflow-hidden mt-0 mb-0 transition-fast-in-out" data-video-container=DUuv9ALS5cM> <div class=embed-item data-video-frame=DUuv9ALS5cM data-video-start=0 id=DUuv9ALS5cM></div> <div class="absolute pin bg-center bg-cover pointer-events-none flex items-center justify-center" data-video-thumbnail=true style="background-image: url(https://img.youtube.com/vi/DUuv9ALS5cM/hqdefault.jpg)"> <div class="py-16 px-32 rounded-lg bg-gradient-red-400-red-500 shadow group-hover:shadow-md cursor-pointer transition-fast-out"> <div class="m-4 h-24 text-white"> <div class="h-full fill-current"> <svg class="block h-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 8 10"><polygon points="0 0 0 10 8 5 0 0"/></svg> </div> </div> </div> </div> </div> <div class="ml-32 md:block hidden" data-video-description=true> <div> <div class="mb-8 text-grey-1000 font-bold text-lg"> Algolia Instant Search on your Magento Store </div> <div class=text-grey-400> By Algolia, 17 min </div> </div> </div> </div> <h2 id=installation>Installation</h2> <p>There are two possible ways to install the extension:</p> <ol> <li>Through <a href="https://github.com/colinmollenhour/modman">modman</a></li> <li>Through <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a></li> </ol> <h3 id=modman>Modman</h3> <p>With <a href="https://github.com/colinmollenhour/modman">modman</a> installed, run the following commands:</p> <div class=snippet-wrapper><div class=snippet-actions markdown=0><div class="copy-link snippet-action btn-satellite btn-satellite-white ml-8">Copy</div></div><div class=snippet-header><div class="nav nav-tabs snippet-tabs" markdown=0><span class="snippet-tab-wrapper snippet-tab-wrapper-active"><a href="#snippet_bash" data-toggle=tab class=snippet-tab>bash</a></span></div></div><div id=snippet_bash data-tab-pane class="snippet-body snippet-body-active" data-active=true data-language=bash><div class=highlight><pre class="highlight shell"><code><span class="nb">cd</span> /path/to/your/magento/directory
+modman init
+modman clone https://github.com/algolia/algoliasearch-magento.git
+</code></pre></div></div></div> <h3 id=magento-marketplace>Magento Marketplace</h3> <p>Navigate to the <a href="https://marketplace.magento.com/algolia-algoliasearch.html">Magento Marketplace</a> to get the extension and follow the instructions to install.</p> <h2 id=configuration>Configuration</h2> <p>Before Algolia can be used with Magento, an Algolia account is needed. With the account, it’s possible to configure the Magento extension to work properly.</p> <h3 id=algolia-account>Algolia account</h3> <p>An account can be created in the <a href="/users/sign_up">sign-up wizard</a>.</p> <p class="alert alert-info">Pay attention while picking a data center during the sign-up. For performance reasons, it’s best to pick the one closest to the data center of your Magento installation.</p> <h3 id=magento-settings>Magento settings</h3> <p>To configure the Magento extension, you will need the following Algolia credentials:</p> <ul> <li>Application ID</li> <li><a href="/doc/guides/security/api-keys/#search-only-api-key">Search-only API key</a></li> <li><a href="/doc/guides/security/api-keys/#admin-api-key">Admin API key</a></li> </ul> <p>These credentials can be found on the <a href="/dashboard">Algolia Dashboard</a>, on the <strong>API keys</strong> page from the menu.</p> <p>In the administration section of your Magento project, navigate to <strong>System &gt; Configuration &gt; Catalog &gt; Algolia Search</strong> and fill in the form with all the information required.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/configuration-ef05486e.png" alt="Basic information configuration"/></p> </figure> </section> <section> <h2 id=indexing>Indexing</h2> <p>With the extension configured, the data in your Magento installation should be pushed to Algolia for the first time by a process called <a href="/doc/guides/getting-started/how-algolia-works/in-depth/implementation-process/#indexing-data"><em>indexing</em></a>. This can be accomplished by navigating to <strong>System &gt; Indexing Management</strong>. On this page, a list of indices will show up for which the <strong>Reindex Data</strong> link has to be clicked:</p> <ul> <li>Algolia Search Products</li> <li>Algolia Search Categories</li> <li>Algolia Search Pages</li> <li>Algolia Search Suggestions</li> </ul> <p>When the indexing is done, the search should now be available in your Magento installation.</p> <figure> <p><img src="/doc/assets/images/integrations/magento-1/getting-started/indexers-a88f04f2.png" alt="Magento store indexers"/></p> </figure> </section> </div> <div class=mt-88>
+</div></div></main></body>
+</html>

data/spec/frontman/mocks/snippet/html_file.yml ADDED

@@ -0,0 +1,670 @@
+batch_multiple_indices:
+  android: |
+    ```java
+    List<JSONObject> array = new ArrayList<>();
+    array.add(new JSONObject()
+      .put("action", "addObject")
+      .put("indexName", "index1")
+      .put("body", new JSONObject()
+        .put("firstname", "Jimmie")
+        .put("lastname", "Barninger")
+      )
+    );
+    array.add(new JSONObject()
+      .put("action", "updateObject")
+      .put("indexName", "index1")
+      .put("body", new JSONObject()
+        .put("objectID", "myID2")
+        .put("firstname", "Max")
+        .put("lastname", "Barninger")
+      )
+    );
+    array.add(new JSONObject()
+      .put("action", "partialUpdateObject")
+      .put("indexName", "index1")
+      .put("body", new JSONObject()
+        .put("objectID", "myID3")
+        .put("lastname", "McFarway")
+      )
+    );
+    array.add(new JSONObject()
+      .put("action", "partialUpdateObjectNoCreate")
+      .put("indexName", "index1")
+      .put("body", new JSONObject()
+        .put("objectID", "myID4")
+        .put("firstname", "Warren")
+      )
+    );
+    array.add(new JSONObject()
+      .put("action", "deleteObject")
+      .put("indexName", "index2")
+      .put("body", new JSONObject()
+        .put("objectID", "myID5")
+      )
+    );
+    client.batchAsync(new JSONArray(array), null);
+    ```
+  csharp: |
+    ```csharp
+      List<BatchOperation<Contact>> operations = new List<BatchOperation<Contact>>
+      {
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.AddObject,
+            IndexName = "index1",
+            Body = new Contact { FirstName = "Jimmie", LastName = "Barninger" }
+          },
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.UpdateObject,
+            IndexName = "index1",
+            Body = new Contact { ObjectID = "myID2", FirstName = "Max", LastName = "Barninger" }
+          },
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.PartialUpdateObject,
+            IndexName = "index1",
+            Body = new Contact { ObjectID = "myID3", LastName = "McFarway" }
+          },
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.PartialUpdateObjectNoCreate,
+            IndexName = "index1",
+            Body = new Contact { ObjectID = "myID4", LastName = "Warren" }
+          },
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.DeleteObject,
+            IndexName = "index2",
+            Body = new Contact { ObjectID = "myID5" }
+          }
+      };
+    client.MultipleBatch(operations);
+    // Asynchronous
+    client.MultipleBatchAsync(operations);
+    ```
+  go: |
+    ```go
+    operations := []algoliasearch.BatchOperationIndexed{
+      {
+        IndexName: "index1",
+        BatchOperation: algoliasearch.BatchOperation{
+          Action: "addObject",
+          Body: algoliasearch.Map{
+            "firstname": "Jimmie",
+            "lastname":  "Barninger",
+          },
+        },
+      },
+      {
+        IndexName: "index1",
+        BatchOperation: algoliasearch.BatchOperation{
+          Action: "updateObject",
+          Body: algoliasearch.Map{
+            "objectID":  "myID2",
+            "firstname": "Max",
+            "lastname":  "Barninger",
+          },
+        },
+      },
+      {
+        IndexName: "index1",
+        BatchOperation: algoliasearch.BatchOperation{
+          Action: "partialUpdateObject",
+          Body: algoliasearch.Map{
+            "objectID": "myID3",
+            "lastname": "McFarway",
+          },
+        },
+      },
+      {
+        IndexName: "index1",
+        BatchOperation: algoliasearch.BatchOperation{
+          Action: "partialUpdateObjectNoCreate",
+          Body: algoliasearch.Map{
+            "objectID":  "myID4",
+            "firstname": "Warren",
+          },
+        },
+      },
+      {
+        IndexName: "index2",
+        BatchOperation: algoliasearch.BatchOperation{
+          Action: "deleteObject",
+          Body: algoliasearch.Map{
+            "objectID": "myID5",
+          },
+        },
+      },
+    }
+    res, err := client.Batch(operations)
+    ```
+  java: |
+    ```java
+    // Sync and Async version
+    client.batch(Arrays.asList(
+      new BatchAddObjectOperation<>(
+        "index1",
+        new Contact().setFirstName("Jimmie").setLastName("Barninger")
+      ),
+      new BatchUpdateObjectOperation<>(
+        "index1",
+        new Contact().setObjectID("myID2").setFirstName("Max").setLastName("Barninger")
+      ),
+      new BatchPartialUpdateObjectOperation<>(
+        "index1",
+        new Contact().setObjectID("myID3").setLastName("McFarway")
+      ),
+      new BatchPartialUpdateObjectNoCreateOperation<>(
+        "index1",
+        new Contact().setObjectID("myID4").setFirstName("Warren")
+      ),
+      new BatchDeleteObjectOperation(
+        "index2",
+        "myID5"
+      )
+    ));
+    ```
+  javascript: |
+    ```js
+    client.batch([
+      {
+        action: 'addObject',
+        indexName: 'index1',
+        body: {
+          firstname: 'Jimmie',
+          lastname: 'Barninger'
+        }
+      },
+      {
+        action: 'updateObject',
+        indexName: 'index1',
+        body: {
+          objectID: 'myID2',
+          firstname: 'Max',
+          lastname: 'Barninger'
+        }
+      },
+      {
+        action: 'partialUpdateObject',
+        indexName: 'index1',
+        body: {
+          objectID: 'myID3',
+          lastname: 'McFarway'
+        }
+      },
+      {
+        action: 'partialUpdateObjectNoCreate',
+        indexName: 'index1',
+        body: {
+          objectID: 'myID4',
+          firstname: 'Warren'
+        }
+      },
+      {
+        action: 'deleteObject',
+        indexName: 'index2',
+        body: {
+          objectID: 'myID5'
+        }
+      }
+    ], function(err, content) {
+      if (err) throw err;
+      console.log(content);
+    })
+    ```
+  php: |
+    ```php
+    $res = $client->multipleBatch(
+      [
+        [
+          'action'    => 'addObject',
+          'indexName' => 'index1',
+          'body'      => [
+            'firstname' => 'Jimmie',
+            'lastname'  => 'Barninger'
+          ]
+        ],
+        [
+          'action'    => 'updateObject',
+          'indexName' => 'index1',
+          'body'      => [
+            'objectID' => 'myID2',
+            'firstname' => 'Max',
+            'lastname'  => 'Barninger'
+          ]
+        ],
+        [
+          'action'    => 'partialUpdateObject',
+          'indexName' => 'index1',
+          'body'      => [
+            'objectID'  => 'myID3',
+            'lastname'  => 'McFarway'
+          ]
+        ],
+        [
+          'action'    => 'partialUpdateObjectNoCreate',
+          'indexName' => 'index1',
+          'body'      => [
+            'objectID'  => 'myID4',
+            'firstname' => 'Warren'
+          ]
+        ],
+        [
+          'action'    => 'deleteObject',
+          'indexName' => 'index2',
+          'body'      => [
+            'objectID'  => 'myID5'
+          ]
+        ]
+      ]
+    );
+    ```
+  python: |
+    ```python
+    res = client.multiple_batch([
+        {
+            'action': 'addObject',
+            'indexName': 'index1',
+            'body': {
+                'firstname': 'Jimmie',
+                'lastname': 'Barninger'
+            }
+        },
+        {
+            'action': 'updateObject',
+            'indexName': 'index1',
+            'body': {
+                'objectID': 'myID2',
+                'firstname': 'Max',
+                'lastname': 'Barninger'
+            }
+        },
+        {
+            'action': 'partialUpdateObject',
+            'indexName': 'index1',
+            'body': {
+                'objectID': 'myID3',
+                'lastname': 'McFarway'
+            }
+        },
+        {
+            'action': 'partialUpdateObjectNoCreate',
+            'indexName': 'index1',
+            'body': {
+                'objectID': 'myID4',
+                'firstname': 'Warren'
+            }
+        },
+        {
+            'action': 'deleteObject',
+            'indexName': 'index2',
+            'body': {
+                'objectID': 'myID5'
+            }
+        }
+    ])
+    ```
+  ruby: |
+    ```ruby
+    res = client.batch([
+      {
+        'action': 'addObject',
+        'indexName': 'index1',
+        'body': {
+          'firstname': 'Jimmie',
+          'lastname': 'Barninger'
+        }
+      },
+      {
+        'action': 'updateObject',
+        'indexName': 'index1',
+        'body': {
+          'objectID': 'myID2',
+          'firstname': 'Max',
+          'lastname': 'Barninger'
+        }
+      }
+      {
+        'action': 'partialUpdateObject',
+        'indexName': 'index1',
+        'body': {
+          'objectID': 'myID3',
+          'lastname': 'McFarway'
+        }
+      }
+      {
+        'action': 'partialUpdateObjectNoCreate',
+        'indexName': 'index1',
+        'body': {
+          'objectID': 'myID4',
+          'firstname': 'Warren'
+        }
+      }
+      {
+        'action': 'deleteObject',
+        'indexName': 'index2',
+        'body': {
+          'objectID': 'myID5'
+        }
+      }
+    ])
+    ```
+  scala: |
+    ```scala
+    client.execute {
+      batch(
+        index into "index1" `object` Contact("", "Jimmie", "Barninger"),
+        index into "index1" `object` ContactWithObjectID("myID2", "Max", "Barninger"),
+        partialUpdate from "index1" `object` ContactWithObjectID("myID3", "", "McFarway"),
+        partialUpdate from "index1" `object` ContactWithObjectID("myID4", "Warren", "") createIfNotExists false,
+        delete from "index2" objectId "myID5"
+      )
+    }
+    ```
+  swift: |
+    ```swift
+    let operations: [JSONObject] = [
+      [
+        "action": "addObject",
+        "indexName": "index1",
+        "body": [
+          "firstname": "Jimmie",
+          "lastname": "Barninger"
+        ]
+      ],
+      [
+        "action": "updateObject",
+        "indexName": "index1",
+        "body": [
+          "objectID": "myID2",
+          "firstname": "Max",
+          "lastname": "Barninger"
+        ]
+      ],
+      [
+        "action": "partialUpdateObject",
+        "indexName": "index1",
+        "body": [
+          "objectID": "myID3",
+          "lastname": "McFarway"
+        ]
+      ],
+      [
+        "action": "partialUpdateObjectNoCreate",
+        "indexName": "index1",
+        "body": [
+          "objectID": "myID4",
+          "firstname": "Warren"
+        ]
+      ],
+      [
+        "action": "deleteObject",
+        "indexName": "index2",
+        "body": [
+          "objectID": "myID5"
+        ]
+      ]
+    ]
+    client.batch(operations: operations) {
+      (content, error) in
+      // Handle response
+    }
+    ```
+batch_multiple_indices_with_extra_headers:
+  android: |
+    ```java
+    List<JSONObject> array = new ArrayList<>();
+    array.add(new JSONObject()
+      .put("action", "addObject")
+      .put("indexName", "index1")
+      .put("body", new JSONObject()
+        .put("firstname", "Jimmie")
+        .put("lastname", "Barninger")
+      )
+    );
+    array.add(new JSONObject()
+      .put("action", "addObject")
+      .put("indexName", "index2")
+      .put("body", new JSONObject()
+          .put("firstname", "Warren")
+          .put("lastname", "Speach")
+      )
+    );
+    client.batchAsync(
+      new JSONArray(array),
+      new RequestOptions().setHeader("X-Algolia-User-ID", "94.228.178.246"),
+      null
+    );
+    ```
+  csharp: |
+    ```csharp
+    RequestOptions requestOptions = new RequestOptions
+    {
+        Headers = new Dictionary<string,string>{ { "X-Algolia-User-ID", "user123" } }
+    };
+      List<BatchOperation<Contact>> operations = new List<BatchOperation<Contact>>
+      {
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.AddObject,
+            IndexName = "index1",
+            Body = new Contact { FirstName = "Jimmie", LastName = "Barninger" }
+          },
+          new BatchOperation<Contact>
+          {
+            Action = BatchActionType.AddObject,
+            IndexName = "index1",
+            Body = new Contact { FirstName = "Warren", LastName = "Speach" }
+          }
+      };
+    client.MultipleBatch(operations, requestOptions);
+    // Asynchronous
+    client.MultipleBatchAsync(operations, requestOptions);
+    ```
+  go: |
+    ```go
+    person := algoliasearch.Map{
+      "firstname": "Jimmie",
+      "lastname":  "Barninger",
+    }
+    operation := algoliasearch.BatchOperation{
+      Action: "addObject",
+      Body:   person,
+    }
+    operations := []algoliasearch.BatchOperationIndexed{
+      {IndexName: "prodIndex", BatchOperation: operation},
+      {IndexName: "devIndex", BatchOperation: operation},
+    }
+    opts := &algoliasearch.RequestOptions{
+      ExtraHeaders: map[string]string{
+        "X-Algolia-User-ID": "userID2",
+      },
+    }
+    res, err := client.BatchWithRequestOptions(operations, opts)
+    ```
+  java: |
+    ```java
+    // Sync and Async version
+    client.batch(
+      Arrays.asList(
+        new BatchAddObjectOperation<>(
+          "index1",
+          new Contact().setFirstName("Jimmie").setLastName("Barninger")
+        ),
+        new BatchAddObjectOperation<>(
+          "index2",
+          new Contact().setFirstName("Warren").setLastName("Speach")
+        )
+      ),
+      new RequestOptions().addExtraHeader("X-Algolia-User-ID", "user123")
+    );
+    ```
+  javascript: |
+    ```js
+    client.setExtraHeader('X-FORWARDED-FOR', '94.228.178.246');
+    client.batch([
+      {
+        action: 'addObject',
+        indexName: 'index1',
+        body:
+        {
+          firstname: 'Jimmie',
+          lastname: 'Barninger'
+        }
+      },
+      {
+        action: 'addObject',
+        indexName: 'index2',
+        body: {
+          firstname: 'Warren',
+          lastname: 'Speach'
+        }
+      }
+    ], function(err, content) {
+      if (err) throw err;
+      console.log(content);
+    })
+    ```
+  php: |
+    ```php
+    $operations = [
+      [
+        'action' => 'addObject',
+        'indexName' => 'index1',
+        'body' => [
+          'firstname' => 'Jimmie',
+          'lastname' => 'Barninger'
+        ]
+      ],
+      [
+        'action' => 'addObject',
+        'indexName' => 'index2',
+        'body' => [
+          'firstname' => 'Warren',
+          'lastname' => 'Speach'
+        ]
+      ]
+    ];
+    $res = $client->multipleBatch($operations, [
+      'X-FORWARDED-FOR' => '94.228.178.246'
+    ]);
+    ```
+  python: |
+    ```python
+    res = client.multiple_batch(
+        [
+            {
+                'action': 'addObject',
+                'indexName': 'index1',
+                'body': {'firstname': 'Jimmie', 'lastname': 'Barninger'}
+            },
+            {
+                'action': 'addObject',
+                'indexName': 'index2',
+                'body': {'firstname': 'Warren', 'lastname': 'Speach'}
+            }
+        ],
+        {
+            'X-FORWARDED-FOR': '94.228.178.246'
+        }
+    )
+    ```
+  ruby: |
+    ```ruby
+    operations = [
+     {
+       'action': 'addObject',
+       'indexName': 'index1',
+       'body': {'firstname': 'Jimmie', 'lastname': 'Barninger'}
+     },
+     {
+       'action': 'addObject',
+       'indexName': 'index2',
+       'body': {'firstname': 'Warren', 'lastname': 'Speach'}
+     }
+    ]
+    extra_headers = {
+      'X-FORWARDED-FOR': '94.228.178.246'
+    }
+    res = client.batch(operations, extra_headers)
+    ```
+  scala: |
+    ```scala
+    client.execute {
+      batch(
+        index into "index1" `object` Contact("Jimmie", "Barninger"),
+        index into "index2" `object` Contact("Warren", "Speach")
+      ) options RequestOptions(extraHeaders = Some(
+        Map("X-Algolia-User-ID" => "user123"))
+      )
+    }
+    ```
+  swift: |
+    ```swift
+    let operations: [JSONObject] = [
+      [
+        "action": "addObject",
+        "indexName": "index1",
+        "body": [
+          "firstname": "Jimmie",
+          "lastname": "Barninger"
+        ]
+      ],
+      [
+        "action": "addObject",
+        "indexName": "index2",
+        "body": [
+          "firstname": "Warren",
+          "lastname": "Speach"
+        ]
+      ]
+    ]
+    let requestOptions = RequestOptions()
+    requestOptions.headers["X-Algolia-User-ID"] = "user123"
+    client.batch(operations: operations, requestOptions: requestOptions) {
+      (content, error) in
+      // Handle response
+    }
+    ```