RubyGems - ascii_binder - Versions diffs - 0.1.9 → 0.1.10 - Mend

ascii_binder 0.1.9 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

checksums.yaml +4 -4
data/.travis.yml +16 -0
data/ascii_binder.gemspec +5 -3
data/bin/asciibinder +53 -44
data/features/command_help.feature +8 -0
data/features/command_version.feature +8 -0
data/features/repo_build.feature +34 -0
data/features/repo_clean.feature +20 -0
data/features/repo_clone.feature +22 -0
data/features/repo_create.feature +13 -0
data/features/repo_package.feature +15 -0
data/features/step_definitions/steps.rb +182 -0
data/features/support/_clone_distro_map.yml +14 -0
data/features/support/_invalid_distro_map.yml +14 -0
data/features/support/env.rb +468 -0
data/features/support/test_distro/.gitignore +9 -0
data/features/support/test_distro/_distro_map.yml +29 -0
data/features/support/test_distro/_images/asciibinder-logo-horizontal.png +0 -0
data/features/support/test_distro/_images/asciibinder_web_logo.svg +125 -0
data/features/support/test_distro/_images/book_pages_bg.jpg +0 -0
data/features/support/test_distro/_images/favicon.ico +0 -0
data/features/support/test_distro/_images/favicon32x32.png +0 -0
data/features/support/test_distro/_javascripts/.gitkeep +0 -0
data/features/support/test_distro/_stylesheets/asciibinder.css +568 -0
data/features/support/test_distro/_templates/_css.html.erb +3 -0
data/features/support/test_distro/_templates/_nav.html.erb +31 -0
data/features/support/test_distro/_templates/page.html.erb +92 -0
data/features/support/test_distro/_topic_map.yml +36 -0
data/features/support/test_distro/index-main.html +10 -0
data/features/support/test_distro/index-test.html +10 -0
data/features/support/test_distro/main_only_topic_group/index.adoc +17 -0
data/features/support/test_distro/test_only_topic_group/index.adoc +17 -0
data/features/support/test_distro/welcome/index.adoc +17 -0
data/features/support/test_distro/welcome/subtopics/index.adoc +17 -0
data/features/support/test_distro/welcome/subtopics/main_only_topic.adoc +17 -0
data/features/support/test_distro/welcome/subtopics/test_only_topic.adoc +17 -0
data/features/support/test_distro/welcome/subtopics/wildcard_all.adoc +17 -0
data/lib/ascii_binder.rb +4 -2
data/lib/ascii_binder/distro.rb +111 -0
data/lib/ascii_binder/distro_branch.rb +93 -0
data/lib/ascii_binder/distro_map.rb +67 -0
data/lib/ascii_binder/engine.rb +581 -0
data/lib/ascii_binder/helpers.rb +42 -856
data/lib/ascii_binder/site.rb +52 -0
data/lib/ascii_binder/site_info.rb +22 -0
data/lib/ascii_binder/site_map.rb +24 -0
data/lib/ascii_binder/topic_entity.rb +255 -0
data/lib/ascii_binder/topic_map.rb +61 -0
data/lib/ascii_binder/version.rb +1 -1
data/templates/_templates/page.html.erb +1 -1
metadata +118 -14

data/features/support/test_distro/_templates/_css.html.erb ADDED

@@ -0,0 +1,3 @@
+<%- Dir.glob("_stylesheets/*").sort.each do |sheet| -%>
+  <link href="<%= File.join(css_path, File.basename(sheet)) %>" rel="stylesheet" />
+<%- end -%>

data/features/support/test_distro/_templates/_nav.html.erb ADDED

@@ -0,0 +1,31 @@
+<ul class="nav nav-sidebar">
+  <%- navigation.each.with_index do |topic_group, groupidx| -%>
+    <%- current_group = topic_group[:id] == group_id -%>
+    <li class="nav-header">
+      <a class="" href="#" data-toggle="collapse" data-target="#topicGroup<%= groupidx %>">
+        <span id="tgSpan<%= groupidx %>" class="fa <%= current_group ? 'fa-angle-down' : 'fa-angle-right' %>"></span><%= topic_group[:name] %>
+      </a>
+      <ul id="topicGroup<%= groupidx %>" class="collapse <%= current_group ? 'in' : '' %> list-unstyled">
+        <%- topic_group[:topics].each.with_index do |topic, topicidx| -%>
+          <%- if not topic.has_key?(:topics) -%>
+            <%- current_topic = current_group && (topic[:id] == topic_id) -%>
+            <li><a class="<%= current_topic ? ' active' : '' %>" href="<%= subtopic_shim %><%= topic[:path] %>"><%= topic[:name] %></a></li>
+          <%- else -%>
+            <%- current_subgroup = topic[:id] == subgroup_id -%>
+            <li class="nav-header">
+              <a class="" href="#" data-toggle="collapse" data-target="#topicSubGroup-<%= groupidx %>-<%= topicidx %>">
+                <span id="sgSpan-<%= groupidx %>-<%= topicidx %>" class="fa <%= current_subgroup ? 'fa-caret-down' : 'fa-caret-right' %>"></span>&nbsp;<%= topic[:name] %>
+              </a>
+              <ul id="topicSubGroup-<%= groupidx %>-<%= topicidx %>" class="nav-tertiary list-unstyled collapse<%= current_subgroup ? ' in' : '' %>">
+                <%- topic[:topics].each do |subtopic| -%>
+                  <%- current_subtopic = current_group && current_subgroup && (subtopic[:id] == topic_id) %>
+                  <li><a class="<%= current_subtopic ? ' active' : '' %>" href="<%= subtopic_shim %><%= subtopic[:path] %>"><%= subtopic[:name] %></a></li>
+                <%- end -%>
+              </ul>
+            </li>
+          <%- end -%>
+        <%- end -%>
+      </ul>
+    </li>
+  <%- end -%>
+</ul>

data/features/support/test_distro/_templates/page.html.erb ADDED

@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta content="IE=edge" http-equiv="X-UA-Compatible">
+  <meta content="width=device-width, initial-scale=1.0" name="viewport">
+  <title><%= distro %> <%= version %> | <%= [group_title, subgroup_title, topic_title].compact.join(' | ') %></title>
+  <!-- Bootstrap -->
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
+  <%= render("_templates/_css.html.erb", :css_path => css_path) %>
+   <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+   <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+   <!--[if lt IE 9]>
+     <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+     <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+   <![endif]-->
+  <link href="<%= File.join(images_path, "favicon32x32.png") %>" rel="shortcut icon" type="text/css">
+  <!--[if IE]><link rel="shortcut icon" href="<%= File.join(images_path, "favicon.ico") %>"><![endif]-->
+  <meta content="AsciiBinder" name="application-name">
+</head>
+<body>
+  <div class="navbar navbar-default" role="navigation">
+    <div class="container-fluid">
+      <div class="navbar-header">
+        <a class="navbar-brand" href="http://www.asciibinder.org/"><img alt="AsciiBinder" src="<%= File.join(images_path, "asciibinder-logo-horizontal.png") %>"></a>
+      </div>
+    </div>
+  </div>
+  <div class="container">
+    <p class="toggle-nav visible-xs pull-left">
+      <button class="btn btn-default btn-sm" type="button" data-toggle="offcanvas">Toggle nav</button>
+    </p>
+    <ol class="breadcrumb">
+      <li class="sitename">
+        <a href="<%= site_home_path %>"><%= site_name %></a>
+      </li>
+      <li class="hidden-xs active">
+        <%= breadcrumb_root %>
+      </li>
+      <li class="hidden-xs active">
+        <%= breadcrumb_group %>
+      </li>
+      <%= breadcrumb_subgroup_block %>
+      <li class="hidden-xs active">
+        <%= breadcrumb_topic %>
+      </li>
+    </ol>
+    <div class="row row-offcanvas row-offcanvas-left">
+      <div class="col-xs-8 col-sm-3 col-md-3 sidebar sidebar-offcanvas">
+        <%= render("_templates/_nav.html.erb", :navigation => navigation, :group_id => group_id, :topic_id => topic_id, :subgroup_id => subgroup_id, :subtopic_shim => subtopic_shim) %>
+      </div>
+      <div class="col-xs-12 col-sm-9 col-md-9 main">
+        <div class="page-header">
+          <h2><%= article_title %></h2>
+        </div>
+        <%= content %>
+      </div>
+    </div>
+  </div>
+   <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+   <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+   <!-- Latest compiled and minified JavaScript -->
+   <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
+   <script type="text/javascript">
+    /*<![CDATA[*/
+    $(document).ready(function() {
+      $("[id^='topicGroup']").on('show.bs.collapse', function (event) {
+        if (!($(event.target).attr('id').match(/^topicSubGroup/))) {
+          $(this).parent().find("[id^='tgSpan']").toggleClass("fa-angle-right fa-angle-down");
+        }
+      });
+      $("[id^='topicGroup']").on('hide.bs.collapse', function (event) {
+        if (!($(event.target).attr('id').match(/^topicSubGroup/))) {
+          $(this).parent().find("[id^='tgSpan']").toggleClass("fa-angle-right fa-angle-down");
+        }
+      });
+      $("[id^='topicSubGroup']").on('show.bs.collapse', function () {
+        $(this).parent().find("[id^='sgSpan']").toggleClass("fa-caret-right fa-caret-down");
+      });
+      $("[id^='topicSubGroup']").on('hide.bs.collapse', function () {
+        $(this).parent().find("[id^='sgSpan']").toggleClass("fa-caret-right fa-caret-down");
+      });
+    });
+    /*]]>*/
+  </script>
+</body>
+</html>

data/features/support/test_distro/_topic_map.yml ADDED

@@ -0,0 +1,36 @@
+---
+Name: AsciiBinder Doc Project
+Dir: welcome
+Topics:
+  - Name: Welcome
+    File: index
+  - Name: Subtopics
+    Dir: subtopics
+    Topics:
+      - Name: All Distros
+        File: index
+      - Name: MAIN_ONLY_TOPIC
+        File: main_only_topic
+        Distros: distro_main
+      - Name: TEST_ONLY_TOPIC
+        File: test_only_topic
+        Distros: distro_test
+      - Name: Wilcard All
+        File: wildcard_all
+        Distros: distro_*
+---
+Name: MAIN_ONLY_TOPIC_GROUP
+Dir: main_only_topic_group
+Distros: distro_main
+Topics:
+  - Name: MAIN_ONLY_WELCOME
+    File: index
+---
+Name: TEST_ONLY_TOPIC_GROUP
+Dir: test_only_topic_group
+Distros: distro_test
+Topics:
+  - Name: TEST_ONLY_WELCOME
+    File: index

data/features/support/test_distro/index-main.html ADDED

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>INDEX MAIN</title>
+  </head>
+  <body>
+    INDEX MAIN
+  </body>
+</html>

data/features/support/test_distro/index-test.html ADDED

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>INDEX TEST</title>
+  </head>
+  <body>
+    INDEX TEST
+  </body>
+</html>

data/features/support/test_distro/main_only_topic_group/index.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/test_only_topic_group/index.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/welcome/index.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/welcome/subtopics/index.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/welcome/subtopics/main_only_topic.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/welcome/subtopics/test_only_topic.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/features/support/test_distro/welcome/subtopics/wildcard_all.adoc ADDED

@@ -0,0 +1,17 @@
+= {product-title} {product-version} Documentation
+{product-author}
+{product-version}
+:data-uri:
+:icons:
+DIRECTIVE-TAGGED DOC
+Line 1: This should be visible in all distros
+ifdef::distro_main[]
+Line 2: This should only be visible in distro_main
+endif::[]
+ifdef::distro_test[]
+Line 3: This should only be visible in distro_test
+endif::[]

data/lib/ascii_binder.rb CHANGED

@@ -1,3 +1,5 @@
-require "ascii_binder/version"
-require "ascii_binder/template_renderer"
+require "ascii_binder/distro_map"
+require "ascii_binder/engine"
 require "ascii_binder/helpers"
+require "ascii_binder/template_renderer"
+require "ascii_binder/version"

data/lib/ascii_binder/distro.rb ADDED

@@ -0,0 +1,111 @@
+require 'ascii_binder/distro_branch'
+require 'ascii_binder/helpers'
+require 'ascii_binder/site'
+require 'trollop'
+include AsciiBinder::Helpers
+module AsciiBinder
+  class Distro
+    attr_reader :id, :name, :author, :site
+    def initialize(distro_map_filepath,distro_key,distro_config)
+      @id         = distro_key
+      @name       = distro_config['name']
+      @author     = distro_config['author']
+      @site       = AsciiBinder::Site.new(distro_config)
+      @branch_map = {}
+      distro_config['branches'].each do |branch_name,branch_config|
+        if @branch_map.has_key?(branch_name)
+          Trollop::die "Error parsing #{distro_map_filepath}: distro '#{distro_key}' lists git branch '#{branch_name}' multiple times."
+        end
+        @branch_map[branch_name] = AsciiBinder::DistroBranch.new(branch_name,branch_config,self)
+      end
+    end
+    def is_valid?
+      validate
+    end
+    def errors
+      validate(true)
+    end
+    def branch(branch_name)
+      unless @branch_map.has_key?(branch_name)
+        Trollop::die "Distro '#{@id}' does not include branch '#{branch_name}' in the distro map."
+      end
+      @branch_map[branch_name]
+    end
+    def branch_ids
+      @branch_map.keys
+    end
+    def branches
+      @branch_map.values
+    end
+    private
+    def validate(verbose=false)
+      errors = []
+      unless valid_id?(@id)
+        if verbose
+          errors << "Distro ID '#{@id}' is not a valid string"
+        else
+          return false
+        end
+      end
+      unless valid_string?(@name)
+        if verbose
+          errors << "Distro name '#{@name}' for distro '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@author)
+        if verbose
+          errors << "Distro author '#{@author}' for distro '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      # Remaining checks are sub objects. Handle the verbose case first.
+      if verbose
+        site_errors = @site.errors
+        unless site_errors.empty?
+          error_txt = "The site info has errors:\n"
+          site_errors.each do |error|
+            error_txt << "    * #{error}\n"
+          end
+          errors << error_txt
+        end
+        all_branch_errors = []
+        @branch_map.values.each do |branch|
+          branch_errors = branch.errors
+          unless branch_errors.empty?
+            all_branch_errors << "    * In branch #{branch.id}:\n"
+            branch_errors.each do |error|
+              all_branch_errors << "        * #{error}\n"
+            end
+          end
+        end
+        unless all_branch_errors.empty?
+          all_branch_errors.unshift("The branch info has errors:")
+          errors.concat(all_branch_errors)
+        end
+        return errors
+      end
+      # Still here? Run the non-verbose checks instead.
+      return false unless @site.is_valid?
+      @branch_map.values.each do |branch|
+        return false unless branch.is_valid?
+      end
+      return true
+    end
+  end
+end

data/lib/ascii_binder/distro_branch.rb ADDED

@@ -0,0 +1,93 @@
+require 'ascii_binder/helpers'
+include AsciiBinder::Helpers
+module AsciiBinder
+  class DistroBranch
+    attr_reader :id, :name, :dir, :distro, :distro_name, :distro_author
+    def initialize(branch_name,branch_config,distro)
+      @id            = branch_name
+      @name          = branch_config['name']
+      @dir           = branch_config['dir']
+      @distro        = distro
+      @distro_name   = distro.name
+      @distro_author = distro.author
+      if branch_config.has_key?('distro-overrides')
+        if branch_config['distro-overrides'].has_key?('name')
+          @distro_name = branch_config['distro-overrides']['name']
+        end
+        if branch_config['distro-overrides'].has_key?('author')
+          @distro_author = branch_config['distro-overrides']['author']
+        end
+      end
+    end
+    def branch_path
+      @branch_path ||= File.join(preview_dir,@distro.id,@dir)
+    end
+    def branch_stylesheet_dir
+      @branch_stylesheet_dir ||= File.join(branch_path,STYLESHEET_DIRNAME)
+    end
+    def branch_javascript_dir
+      @branch_javascript_dir ||= File.join(branch_path,JAVASCRIPT_DIRNAME)
+    end
+    def branch_image_dir
+      @branch_image_dir ||= File.join(branch_path,IMAGE_DIRNAME)
+    end
+    def is_valid?
+      validate
+    end
+    def errors
+      validate(true)
+    end
+    private
+    def validate(verbose=true)
+      errors = []
+      unless valid_string?(@id)
+        if verbose
+          errors << "Branch ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@name)
+        if verbose
+          errors << "Branch name '#{@name}' for branch ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@dir)
+        if verbose
+          errors << "Branch dir '#{@dir}' for branch ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@distro_name)
+        if verbose
+          errors << "Branchwise distro name '#{@distro_name}' for branch ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@distro_author)
+        if verbose
+          errors << "Branchwise distro author '#{@distro_author}' for branch ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      return errors if verbose
+      return true
+    end
+  end
+end