ascii_binder 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf4ffd260a5287efafd4fb3cc50fcf11d113a1a
-  data.tar.gz: 4e60310acce7c1481c773831bb8c32c3d95e29ba
+  metadata.gz: 5e46fc5bec124115e6057d804df19fe32f791d85
+  data.tar.gz: 06512c6be9db989118b8af3dfd4b49f560082c56
 SHA512:
-  metadata.gz: d9917eaeb2fb1630066889ea8d74fa55ea399ad54706da7ae1a7bbb6e00343628fd4b97bfc731e2f3aaca93e71eaa8b8bbd6a3016ca31057c715c7e2ec965087
-  data.tar.gz: de6dde4b4042a3690a7ac2dd6440ae981cb031a2391fa262257150af1159e409e368fbd20aeb47c5128d6dcf9164d980a1d561a6b9cbe833901ec79f52fd2a2d
+  metadata.gz: fb26aab0abe17ed2fedba192f2b4722d9f0330096fc5e2116e7b19f00bc6820200b4dc262fb0446cd959126a0db0e8909ce0fbe83bc93a1eba3a0f4f3ddaa074
+  data.tar.gz: 86c0a7e51ab5f08975592b0edde1c0701bde3e76a6646d5f06bafe381a4816273136e4fa0b307f4022bb0e56ac4e3b5d0157d4cfeec9a4b79cdf08080c87796c

data/bin/ascii_binder

@@ -0,0 +1 @@
+asciibinder

data/lib/ascii_binder/helpers.rb

@@ -197,7 +197,9 @@ module AsciiBinder
     def find_topic_files
       file_list = []
       Find.find(source_dir).each do |path|
-        next if path.nil? or not path =~ /.*\.adoc/ or path =~ /README/ or path =~ /\/old\//
+        # Only consider .adoc files and ignore README, and anything in
+        # directories whose names begin with 'old' or '_' (underscore)
+        next if path.nil? or not path =~ /.*\.adoc/ or path =~ /README/ or path =~ /\/old\// or path =~ /\/_/
         src_path = Pathname.new(path).sub(source_dir,'').to_s
         next if src_path.split('/').length < 3
         file_list << src_path
@@ -353,7 +355,10 @@ module AsciiBinder
       end
       # Check for right format of topic group values
       ['Name','Dir'].each do |group_key|
-        if not group[group_key].is_a?(String)
+        if [true, false].include?(group[group_key])
+          raise "One of the topic groups in #{build_config_file} is using a reserved YAML keyword for the #{group_key} setting. In order to prevent your text from being turned into a true/false value, wrap it in quotes."
+        end
+        if not group[group_key].kind_of?(String)
           raise "One of the topic groups in #{build_config_file} is not using a string for the #{group_key} setting; current value is #{group[group_key].inspect}"
         end
         if group[group_key].empty? or group[group_key].match BLANK_STRING_RE
@@ -746,6 +751,24 @@ module AsciiBinder
       single_page    = options[:single_page]
       site_name      = options[:site_name]
 
+      # Distro Map settings can be overridden on a per-branch
+      # basis. This only works for top-level (string) values
+      # of the distro config and -not- the 'site' key.
+      branchwise_distro_config = {}
+      distro_config.each do |key,value|
+        next unless distro_config[key].kind_of?(String)
+        branchwise_distro_config[key] = value
+      end
+      if branch_config.has_key?('distro-overrides')
+        branch_config['distro-overrides'].each do |key,value|
+          if key == 'site'
+            puts "WARNING: The 'site' value of the distro config cannot be overriden on a branch-by-branch basis."
+            next
+          end
+          branchwise_distro_config[key] = value
+        end
+      end
+
       src_file_path = File.join(src_group_path,"#{topic['File']}.adoc")
       tgt_file_path = File.join(tgt_group_path,"#{topic['File']}.html")
       if single_page.nil?
@@ -755,9 +778,9 @@ module AsciiBinder
       page_attrs = asciidoctor_page_attrs([
         "imagesdir=#{src_group_path}/images",
         distro,
-        "product-title=#{distro_config["name"]}",
+        "product-title=#{branchwise_distro_config["name"]}",
         "product-version=#{branch_config["name"]}",
-        "product-author=#{distro_config["author"]}"
+        "product-author=#{branchwise_distro_config["author"]}"
       ])
 
       doc = Asciidoctor.load topic_adoc, :header_footer => false, :safe => :unsafe, :attributes => page_attrs
@@ -773,9 +796,9 @@ module AsciiBinder
       end
       page_args = {
         :distro_key       => distro,
-        :distro           => distro_config["name"],
+        :distro           => branchwise_distro_config["name"],
         :site_name        => site_name,
-        :site_url         => distro_config["site_url"],
+        :site_url         => branchwise_distro_config["site_url"],
         :topic_url        => "#{branch_config['dir']}/#{topic_path}.html",
         :version          => branch_config["name"],
         :group_title      => topic_group['Name'],
@@ -835,8 +858,12 @@ module AsciiBinder
 
             # Now build a sitemap
             site_dir_path = Pathname.new(site_dir)
-            SitemapGenerator::Sitemap.default_host = site_config[:url]
-            SitemapGenerator::Sitemap.create( :compress => false, :filename => File.join(site_dir,'sitemap') ) do
+            SitemapGenerator::Sitemap.create(
+              :default_host => site_config[:url],
+              :public_path  => site_dir_path,
+              :compress     => false,
+              :filename     => File.join(site_dir,'sitemap')
+            ) do
               file_list = Find.find(site_dir).select{ |path| not path.nil? and path =~ /.*\.html$/ }.map{ |path| '/' + Pathname.new(path).relative_path_from(site_dir_path).to_s }
               file_list.each do |file|
                 add(file, :changefreq => 'daily')

data/lib/ascii_binder/version.rb

@@ -1,3 +1,3 @@
 module AsciiBinder
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -285,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: AsciiBinder is an AsciiDoc-based system for authoring and publishing closely

data/bin/ascii_binder

@@ -1,312 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'ascii_binder/helpers'
-require 'ascii_binder/version'
-require 'pathname'
-require 'trollop'
-
-include AsciiBinder::Helpers
-
-def call_generate(branch_group, distro, page)
-  if page == ''
-    page = nil
-  end
-  begin
-    generate_docs(branch_group, distro, page)
-  rescue => e
-    message = "#{e.class.name}: #{e.message} at\n    #{e.backtrace.join("\n    ")}"
-    Trollop::die "Could not generate docs:\n#{message}"
-  end
-end
-
-def repo_check(repo_dir)
-  missing_files = false
-  # These must all be present
-  ['.git','_distro_map.yml','_templates'].each do |file|
-    unless File.exist?(File.join(repo_dir, file))
-      missing_files = true
-    end
-  end
-  # Either of these must be present
-  unless File.exist?(File.join(repo_dir, '_build_cfg.yml')) or File.exist?(File.join(repo_dir, '_topic_map.yml'))
-    missing_files = true
-  end
-  if missing_files
-    Trollop::die "The specified repo directory '#{repo_dir}' does not appear to be an AsciiBinder repo."
-  end
-end
-
-SUB_COMMANDS = %w{help version build watch package clean create clone}
-Trollop::options do
-  version AsciiBinder::VERSION
-  banner <<-EOF
-Usage:
-  #$0 <command> <repo_dir>
-
-Commands:
-  build (default action)
-    Builds the HTML docs in the indicated repo dir
-  create
-    Generates a new AsciiBinder repo at the indicated dir
-  clone
-    Clones an existing AsciiBinder repo to the local filesystem
-  watch
-    Starts Guard, which automatically regenerates changed HTML
-    files on the working branch in the repo dir
-  package
-    Builds and packages the static HTML for all of the sites
-    defined in the _distro_config.yml file
-  clean
-    Remove _preview, _publish and _package dirs created by
-    other AsciiBinder operations.
-
-Options:
-EOF
-  stop_on SUB_COMMANDS
-end
-
-cmd = ARGV.shift
-repo_dir = nil
-
-if cmd.nil?
-  cmd = "build"
-elsif !SUB_COMMANDS.include?(cmd)
-  if ARGV.empty?
-    repo_dir = Pathname.new(cmd)
-    cmd = "build"
-  else
-    Trollop::die "'#{cmd}' is not a valid asciibinder subcommand. Legal values are '#{SUB_COMMANDS.join('\', \'')}'."
-  end
-end
-
-cmd_opts = case cmd
-  when "build"
-    Trollop::options do
-      banner <<-EOF
-Usage:
-  #$0 build <options> <repo_dir>
-
-Description:
-  This is the default behavior for the asciibinder utility. When run,
-  AsciiBinder reads the _distro_config.yml file out of the working
-  branch of the indicated repo directory and based on that, proceeds to
-  build the working branch version of the documentation for each distro.
-
-  If you use the --all_branches flag, AsciiBinder behaves as described
-  above, and then once the working branch version is built, AsciiBinder
-  cycles through the other branches named in the _distro_config.yml file
-  until all of the permutations have been built.
-
-  If you want to limit the scope of the build work for faster builds,
-  you have two targeted options:
-
-  --distro=<distro_key> - Only builds the specified distro and branches
-  associated with this distro.
-
-  --page=<page_path> - Only builds the specified page for all distros.
-
-  Note that the format for the "--page" option is:
-
-  <topic_group>:<topic_file>
-
-  or for subtopics:
-
-  <topic_group>/<subtopic_group>:<topic_file>
-
-  However, if you want to use the --page option extensively, then be
-  aware of the `asciibinder watch` function, which does this for you
-  automatically as you change any .adoc files in your working branch.
-
-Options:
-EOF
-      opt :all_branches, "Instead of building only the current working branch, build all branches", :default => false
-      opt :distro, "Instead of building all distros, build branches only for the specified distro.", :default => ''
-      opt :page, "Build only the specified page for all distros and only the current working branch.", :default => ''
-      conflicts :distro, :page
-    end
-  when "create"
-    Trollop::options do
-      banner <<-EOF
-Usage:
-  #$0 create <new_repo_dir>
-
-Description:
-  Creates a new, bare AsciiBinder repo in the specified directory.
-EOF
-    end
-  when "clone"
-    Trollop::options do
-      banner <<-EOF
-Usage:
-  #$0 clone <options> <git_repo_url>
-
-Description:
-  Clones an existing AsciiBinder repo to the current directory.
-  Under the default behavior, AsciiBinder will attempt to set up
-  tracking branches based on the contents of _distro_map.yml,
-  but this can be suppressed (see Options).
-
-Options:
-EOF
-      opt :branches, "Create tracking branches after cloning.", :default => true
-      opt :dir, "Specify the pathname of the local directory for cloning.", :default => ''
-    end
-  when "watch"
-    Trollop::options do
-      banner <<-EOF
-Usage:
-  #$0 watch <repo_dir>
-
-Description:
-  In watch mode, AsciiBinder starts a Guard process in the foreground.
-  This process watches the repo_dir for changes to the AsciiDoc (.adoc)
-  files. When a change occurs, AsciiBinder regenerates the specific
-  HTML output of the file that was changed, for the working branch only.
-
-  This is the equivalent of running:
-
-  $ asciibinder build --page='<topic_group>:<affected_file>'
-
-  ...except that the Guardfile automatically detects and runs this as
-  you work.
-
-  This is meant to be used in conjunction with a web browser that is
-  running a LiveReload plugin. If you are viewing the output HTML page
-  in a browser where LiveReload is active, then every time you save a
-  new version of the .adoc file, the new HTML is automatically
-  regenerated and your page view is automatically refreshed.
-EOF
-    end
-  when "package"
-    Trollop::options do
-      banner <<-EOF
-Usage:
-  #$0 package <options> <repo_dir>
-
-Description:
-  Publish mode is similar to 'build' mode, but once all of the branches' of
-  HTML are generated, 'publish' goes on to organize the branch / distro
-  combinations that are described in _distro_config.yml into their "site"
-  layouts. As a final step, the site layouts are tarred and gzipped for
-  easy placement onto a production web server.
-
-Options:
-EOF
-      opt :site, "Instead of packaging every docs site, package the specified site only.", :default => ''
-    end
-  when "help"
-    Trollop::educate
-  when "version"
-    puts AsciiBinder::VERSION
-    exit 0
-  end
-
-if (not repo_dir.nil? and not ARGV.empty?) or (repo_dir.nil? and ARGV.length > 1)
-  Trollop::die "Too many arguments provided to ascii_binder: '#{ARGV.join(' ')}'. Exiting."
-elsif repo_dir.nil?
-  if ARGV.length == 1
-    if cmd == 'clone'
-      cmd_opts[:giturl] = ARGV.shift
-      if cmd_opts[:dir] != ''
-        repo_dir = Pathname.new(cmd_opts[:dir])
-      else
-        repo_dir = Pathname.new(File.join(Pathname.pwd, cmd_opts[:giturl].split('/')[-1].split('.')[0]))
-      end
-    else
-      repo_dir = Pathname.new(ARGV.shift)
-    end
-  else
-    if cmd != 'create'
-      if cmd == 'clone'
-        Trollop::die "Provide a git URL to clone from."
-      else
-        repo_dir = Pathname.pwd
-      end
-    else
-      Trollop::die "Specify a name for the new repo directory."
-    end
-  end
-end
-
-# Validate the repo_dir path
-if cmd == 'create' or cmd == 'clone'
-  if repo_dir.exist?
-    Trollop::die "The specified new repo directory '#{repo_dir}' already exists."
-  end
-else
-  if !repo_dir.exist?
-    Trollop::die "The specified repo directory '#{repo_dir}' does not exist."
-  elsif !repo_dir.directory?
-    Trollop::die "The specified repo directory path '#{repo_dir}' is not a directory."
-  elsif !repo_dir.readable?
-    Trollop::die "The specified repo directory '#{repo_dir}' is not readable."
-  elsif !repo_dir.writable?
-    Trollop::die "The specified repo directory '#{repo_dir}' cannot be written to."
-  else
-    repo_check(repo_dir)
-  end
-end
-
-# Set the repo root
-set_source_dir(File.expand_path(repo_dir))
-
-# Cloning? Time to try it.
-if cmd == 'clone'
-  puts "Cloning #{cmd_opts[:giturl]} to #{repo_dir}"
-  system("git clone #{cmd_opts[:giturl]} #{repo_dir}")
-  Trollop::die "The git URL could not be cloned: #{err}" if $?.exitstatus != 0
-
-  # Make sure this cloned repo is legit.
-  repo_check(repo_dir)
-
-  if cmd_opts[:branches]
-    Dir.chdir(repo_dir)
-    puts "Tracking branch setup:"
-    distro_branches.each do |doc_branch|
-      next if doc_branch == 'master'
-      puts "- #{doc_branch}"
-      system("git branch #{doc_branch} origin/#{doc_branch}")
-    end
-  else
-    puts "- Skipping tracking branch setup"
-  end
-
-  # Done and done.
-  puts "Cloning complete."
-  exit
-end
-
-# Change to the repo dir. This is necessary in order for
-# AsciiDoctor to work properly.
-if cmd != 'create'
-  Dir.chdir source_dir
-end
-
-# Do the things with the stuff
-case cmd
-when "build"
-  branch_group = cmd_opts[:all_branches] ? :all : :working_only
-  build_distro = cmd_opts[:distro] || ''
-  refresh_page = cmd_opts[:page] || nil
-  call_generate(branch_group,build_distro,refresh_page)
-when "package"
-  clean_up
-  call_generate(:publish,'',nil)
-  package_site = cmd_opts[:site] || ''
-  package_docs(package_site)
-when "watch"
-  if !dir_empty?(preview_dir)
-    guardfile_path = File.join(Gem::Specification.find_by_name("ascii_binder").full_gem_path, 'Guardfile')
-    exec("guard -G #{guardfile_path}")
-  else
-    Trollop::die "Run 'asciibinder build' at least once before running 'asciibinder watch'."
-  end
-when "clean"
-  clean_up
-  puts "Cleaned up #{repo_dir}."
-when "create"
-  create_new_repo
-  puts "Created new repo in #{repo_dir}."
-end
-
-exit