ascii_binder 0.1.9 → 0.1.10

data/lib/ascii_binder/site.rb

@@ -0,0 +1,52 @@
+require 'ascii_binder/helpers'
+
+include AsciiBinder::Helpers
+
+module AsciiBinder
+  class Site
+    attr_reader :id, :name, :url
+
+    def initialize(distro_config)
+      @id   = distro_config['site']
+      @name = distro_config['site_name']
+      @url  = distro_config['site_url']
+    end
+
+    def is_valid?
+      validate
+    end
+
+    def errors
+      validate(true)
+    end
+
+    private
+
+    def validate(verbose=false)
+      errors = []
+      unless valid_id?(@id)
+        if verbose
+          errors << "Site ID '#{@id}' is not a valid ID."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@name)
+        if verbose
+          errors << "Site name '#{@name}' for site ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      unless valid_string?(@url)
+        if verbose
+          errors << "Site URL '#{@url}' for site ID '#{@id}' is not a valid string."
+        else
+          return false
+        end
+      end
+      return errors if verbose
+      return true
+    end
+  end
+end

data/lib/ascii_binder/site_info.rb

@@ -0,0 +1,22 @@
+module AsciiBinder
+  class SiteInfo
+    attr_reader :id, :name, :url, :distros, :branches
+
+    def initialize(distro)
+      @id       = distro.site.id
+      @name     = distro.site.name
+      @url      = distro.site.url
+      @distros  = {}
+      @branches = ['master']
+      add_distro(distro)
+    end
+
+    def add_distro(distro)
+      @distros[distro.id] = distro.branches
+      distro.branches.each do |branch|
+        next if @branches.include?(branch.id)
+        @branches << branch.id
+      end
+    end
+  end
+end

data/lib/ascii_binder/site_map.rb

@@ -0,0 +1,24 @@
+require 'ascii_binder/site_info'
+
+module AsciiBinder
+  class SiteMap
+    def initialize(distro_map)
+      @site_map = {}
+      distro_map.distros.each do |distro|
+        unless @site_map.has_key?(distro.site.id)
+          @site_map[distro.site.id] = AsciiBinder::SiteInfo.new(distro)
+        else
+          @site_map[distro.site.id].add_distro(distro)
+        end
+      end
+    end
+
+    def sites
+      return @site_map.values
+    end
+
+    def ids
+      return @site_map.keys
+    end
+  end
+end

data/lib/ascii_binder/topic_entity.rb

@@ -0,0 +1,255 @@
+require 'ascii_binder/helpers'
+require 'trollop'
+
+include AsciiBinder::Helpers
+
+module AsciiBinder
+  class TopicEntity
+    attr_reader :name, :dir, :file, :distro_keys, :subitems, :raw, :parent, :depth
+
+    def initialize(topic_entity,actual_distro_keys,dir_path='',parent_group=nil,depth=0)
+      @raw                = topic_entity
+      @parent             = parent_group
+      @dir_path           = dir_path
+      @name               = topic_entity['Name']
+      @dir                = topic_entity['Dir']
+      @file               = topic_entity['File']
+      @depth              = depth
+      @actual_distro_keys = actual_distro_keys
+      @distro_keys        = topic_entity.has_key?('Distros') ? parse_distros(topic_entity['Distros']) : actual_distro_keys
+      @subitems           = []
+      if topic_entity.has_key?('Topics')
+        entity_dir  = @dir.nil? ? '<nil_dir>' : @dir
+        subdir_path = dir_path == '' ? entity_dir : File.join(dir_path,entity_dir)
+        topic_entity['Topics'].each do |sub_entity|
+          @subitems << AsciiBinder::TopicEntity.new(sub_entity,actual_distro_keys,subdir_path,self,depth+1)
+        end
+      end
+    end
+
+    def repo_path
+      @repo_path ||= begin
+        this_step = '<nil_item>'
+        if is_group?
+          this_step = dir
+        elsif is_topic?
+          this_step = name.end_with?('.adoc') ? name : "#{file}.adoc"
+        end
+        @dir_path == '' ? this_step : File.join(@dir_path,this_step)
+      end
+    end
+
+    def repo_path_html
+      @repo_path_html ||= is_topic? ? File.join(File.dirname(repo_path),File.basename(repo_path,'.adoc')) + ".html" : repo_path
+    end
+
+    def source_path
+      @source_path ||= File.join(docs_root_dir,repo_path)
+    end
+
+    def preview_path(distro_key,branch_dir)
+      File.join(preview_dir,distro_key,branch_dir,repo_path_html)
+    end
+
+    def package_path(site_id,branch_dir)
+      File.join(package_dir,site_id,branch_dir,repo_path_html)
+    end
+
+    def group_filepaths
+      @group_filepaths ||= begin
+        group_filepaths = []
+        if is_topic?
+          group_filepaths << File.join(File.dirname(repo_path),File.basename(repo_path,'.adoc'))
+        else
+          subitems.each do |subitem|
+            group_filepaths.concat(subitem.group_filepaths)
+          end
+          group_filepaths.uniq!
+        end
+        group_filepaths
+      end
+    end
+
+    def nav_tree(distro_key)
+      unless distro_keys.include?(distro_key)
+        return nil
+      end
+      nav_tree = { :id => id, :name => name }
+      if is_topic?
+        nav_tree[:path] = "../" + repo_path_html
+      elsif is_group?
+        sub_nav_items = []
+        subitems.each do |subitem|
+          sub_nav = subitem.nav_tree(distro_key)
+          next if sub_nav.nil?
+          sub_nav_items << sub_nav
+        end
+
+        # Don't bother with this group if none of the sub-items is used by this distro
+        return nil if sub_nav_items.length == 0
+
+        nav_tree[:topics] = sub_nav_items
+      end
+      return nav_tree
+    end
+
+    # Is this topic entity or any of its children used in
+    # the specified distro / single page chain
+    def include?(distro_key,single_page_path)
+      # If this entity isn't for this distro, bail out
+      return false unless distro_keys.include?(distro_key)
+
+      # If we're building a single page, check if we're on the right track.
+      if single_page_path.length > 0
+        if is_group?
+          return false unless single_page_path[depth] == dir
+        elsif is_topic?
+          return false unless single_page_path[depth] == file
+        else
+          return false
+        end
+      elsif is_group?
+        # If this is a topic group that -is- okay for this distro, but
+        # none of its subitems are okay for this distro, then bail out.
+        subitems_for_distro = false
+        subitems.each do |subitem|
+          if subitem.include?(distro_key,[])
+            subitems_for_distro = true
+            break
+          end
+        end
+        return false unless subitems_for_distro
+      end
+
+      return true
+    end
+
+    def breadcrumb
+      @breadcrumb ||= hierarchy.map{ |entity| { :id => entity.id, :name => entity.name, :url => entity.repo_path_html } }
+    end
+
+    def id
+      @id ||= hierarchy.map{ |entity| camelize(entity.name) }.join('::')
+    end
+
+    def is_group?
+      @is_group ||= file.nil? and not name.nil? and not dir.nil? and subitems.length > 0
+    end
+
+    def is_topic?
+      @is_topic ||= dir.nil? and not name.nil? and not file.nil? and subitems.length == 0
+    end
+
+    def is_valid?
+      validate
+    end
+
+    def errors
+      validate(true)
+    end
+
+    private
+
+    def parse_distros(entity_distros)
+      values = entity_distros.split(',').map(&:strip)
+      # Don't bother with glob expansion if 'all' is in the list.
+      return @actual_distro_keys if values.include?('all')
+
+      # Expand globs and return the list
+      values.flat_map do |value|
+        value_regex = Regexp.new("\\A#{value.gsub("*", ".*")}\\z")
+        @actual_distro_keys.select { |k| value_regex.match(k) }
+      end.uniq
+    end
+
+    def validate(verbose=false)
+      errors = []
+
+      # Check common fields - Name and Distros
+      if not valid_string?(name)
+        if verbose
+          errors << "Topic entity with missing or invalid 'Name' value: '#{raw.inspect}'"
+        else
+          return false
+        end
+      end
+      distro_keys.each do |distro_key|
+        next if @actual_distro_keys.include?(distro_key)
+        if verbose
+          errors << "#{entity_id} 'Distros' filter includes nonexistant distro key '#{distro_key}'"
+        else
+          return false
+        end
+      end
+
+      # Check the depth. For now, max depth is '2':
+      #
+      # [<group>,<subgroup>,<topic>]
+      #
+      # But this limit will be lifted in the next major version
+      if depth > 2
+        if verbose
+          errors << "#{entity_id} exceeds the maximum nested depth."
+        else
+          return false
+        end
+      end
+
+      # For groups, test the 'Dir' value and the sub-items.
+      if is_group?
+        if not valid_string?(dir)
+          if verbose
+            errors << "#{entity_id} has invalid 'Dir' value."
+          else
+            return false
+          end
+        end
+        subitems.each do |subitem|
+          next if subitem.is_valid?
+          if verbose
+            errors = errors.concat(subitem.errors)
+          else
+            return false
+          end
+        end
+      elsif is_topic?
+        if not valid_string?(file)
+          if verbose
+            errors << "#{entity_id} has invalid 'File' value."
+          else
+            return false
+          end
+        end
+      else
+        if verbose
+          errors << "#{entity_id} is not parseable as a group or a topic: '#{raw.inspect}'"
+        else
+          return false
+        end
+      end
+      return errors if verbose
+      return true
+    end
+
+    def hierarchy
+      @hierarchy ||= begin
+        entity   = self
+        ancestry = []
+        loop do
+          ancestry << entity
+          break if entity.parent.nil?
+          entity = entity.parent
+        end
+        ancestry.reverse
+      end
+    end
+
+    def entity_id
+      if hierarchy.length == 1
+        return "Top level topic entity '#{name}'"
+      else
+        return "Topic entity at '#{breadcrumb.map{ |node| node[:name] }.join(' -> ')}'"
+      end
+    end
+  end
+end

data/lib/ascii_binder/topic_map.rb

@@ -0,0 +1,61 @@
+require 'ascii_binder/helpers'
+require 'ascii_binder/topic_entity'
+require 'trollop'
+require 'yaml'
+
+include AsciiBinder::Helpers
+
+module AsciiBinder
+  class TopicMap
+    attr_reader :list
+
+    def initialize(topic_file,distro_keys)
+      @topic_yaml = YAML.load_stream(open(File.join(docs_root_dir,topic_file)))
+      @list       = []
+      @topic_yaml.each do |topic_entity|
+        @list << AsciiBinder::TopicEntity.new(topic_entity,distro_keys)
+      end
+    end
+
+    def filepaths
+      @filepaths ||= begin
+        filepaths = []
+        @list.each do |topic_entity|
+          filepaths.concat(topic_entity.group_filepaths)
+        end
+        filepaths
+      end
+    end
+
+    def nav_tree(distro_key)
+      nav_tree = []
+      @list.each do |topic_entity|
+        entity_nav = topic_entity.nav_tree(distro_key)
+        next if entity_nav.nil?
+        nav_tree << entity_nav
+      end
+      return nav_tree
+    end
+
+    def is_valid?
+      @list.each do |topic_entity|
+        next if topic_entity.is_valid? and topic_entity.is_group?
+        return false
+      end
+      return true
+    end
+
+    def errors
+      errors = []
+      @list.each do |topic_entity|
+        if not topic_entity.is_group?
+          errors << "Top-level entries in the topic map must all be topic groups. Entity with name '#{topic_entity.name}' is not a group."
+          next
+        end
+        next if topic_entity.is_valid?
+        errors << topic_entity.errors
+      end
+      return errors
+    end
+  end
+end

data/lib/ascii_binder/version.rb

@@ -1,3 +1,3 @@
 module AsciiBinder
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/templates/_templates/page.html.erb

@@ -11,7 +11,6 @@
   <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) %>
-  <script src="<%= File.join(javascripts_path, "bootstrap-offcanvas.js") %>" type="text/javascript"></script>
 
    <!-- 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:// -->
@@ -67,6 +66,7 @@
    <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 src="<%= File.join(javascripts_path, "bootstrap-offcanvas.js") %>" type="text/javascript"></script>
    <script type="text/javascript">
     /*<![CDATA[*/
     $(document).ready(function() {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,6 +25,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+- !ruby/object:Gem::Dependency
+  name: diff_dirs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,28 +73,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.5
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -197,16 +225,16 @@ dependencies:
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +261,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Dockerfile
 - Gemfile
 - Guardfile
@@ -242,11 +271,53 @@ files:
 - ascii_binder.gemspec
 - bin/ascii_binder
 - bin/asciibinder
+- features/command_help.feature
+- features/command_version.feature
+- features/repo_build.feature
+- features/repo_clean.feature
+- features/repo_clone.feature
+- features/repo_create.feature
+- features/repo_package.feature
+- features/step_definitions/steps.rb
+- features/support/_clone_distro_map.yml
+- features/support/_invalid_distro_map.yml
+- features/support/env.rb
+- features/support/test_distro/.gitignore
+- features/support/test_distro/_distro_map.yml
+- features/support/test_distro/_images/asciibinder-logo-horizontal.png
+- features/support/test_distro/_images/asciibinder_web_logo.svg
+- features/support/test_distro/_images/book_pages_bg.jpg
+- features/support/test_distro/_images/favicon.ico
+- features/support/test_distro/_images/favicon32x32.png
+- features/support/test_distro/_javascripts/.gitkeep
+- features/support/test_distro/_stylesheets/asciibinder.css
+- features/support/test_distro/_templates/_css.html.erb
+- features/support/test_distro/_templates/_nav.html.erb
+- features/support/test_distro/_templates/page.html.erb
+- features/support/test_distro/_topic_map.yml
+- features/support/test_distro/index-main.html
+- features/support/test_distro/index-test.html
+- features/support/test_distro/main_only_topic_group/index.adoc
+- features/support/test_distro/test_only_topic_group/index.adoc
+- features/support/test_distro/welcome/index.adoc
+- features/support/test_distro/welcome/subtopics/index.adoc
+- features/support/test_distro/welcome/subtopics/main_only_topic.adoc
+- features/support/test_distro/welcome/subtopics/test_only_topic.adoc
+- features/support/test_distro/welcome/subtopics/wildcard_all.adoc
 - lib/ascii_binder.rb
+- lib/ascii_binder/distro.rb
+- lib/ascii_binder/distro_branch.rb
+- lib/ascii_binder/distro_map.rb
+- lib/ascii_binder/engine.rb
 - lib/ascii_binder/helpers.rb
+- lib/ascii_binder/site.rb
+- lib/ascii_binder/site_info.rb
+- lib/ascii_binder/site_map.rb
 - lib/ascii_binder/tasks/guards.rb
 - lib/ascii_binder/tasks/tasks.rb
 - lib/ascii_binder/template_renderer.rb
+- lib/ascii_binder/topic_entity.rb
+- lib/ascii_binder/topic_map.rb
 - lib/ascii_binder/version.rb
 - templates/.gitignore
 - templates/LICENSE.txt
@@ -286,9 +357,42 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: AsciiBinder is an AsciiDoc-based system for authoring and publishing closely
   related documentation sets from a single source.
-test_files: []
+test_files:
+- features/command_help.feature
+- features/command_version.feature
+- features/repo_build.feature
+- features/repo_clean.feature
+- features/repo_clone.feature
+- features/repo_create.feature
+- features/repo_package.feature
+- features/step_definitions/steps.rb
+- features/support/_clone_distro_map.yml
+- features/support/_invalid_distro_map.yml
+- features/support/env.rb
+- features/support/test_distro/.gitignore
+- features/support/test_distro/_distro_map.yml
+- features/support/test_distro/_images/asciibinder-logo-horizontal.png
+- features/support/test_distro/_images/asciibinder_web_logo.svg
+- features/support/test_distro/_images/book_pages_bg.jpg
+- features/support/test_distro/_images/favicon.ico
+- features/support/test_distro/_images/favicon32x32.png
+- features/support/test_distro/_javascripts/.gitkeep
+- features/support/test_distro/_stylesheets/asciibinder.css
+- features/support/test_distro/_templates/_css.html.erb
+- features/support/test_distro/_templates/_nav.html.erb
+- features/support/test_distro/_templates/page.html.erb
+- features/support/test_distro/_topic_map.yml
+- features/support/test_distro/index-main.html
+- features/support/test_distro/index-test.html
+- features/support/test_distro/main_only_topic_group/index.adoc
+- features/support/test_distro/test_only_topic_group/index.adoc
+- features/support/test_distro/welcome/index.adoc
+- features/support/test_distro/welcome/subtopics/index.adoc
+- features/support/test_distro/welcome/subtopics/main_only_topic.adoc
+- features/support/test_distro/welcome/subtopics/test_only_topic.adoc
+- features/support/test_distro/welcome/subtopics/wildcard_all.adoc