awestruct-ibeams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6efd8c9c2adb0cbc709e972e9ac6c1cc4f6802d4
+  data.tar.gz: c342e9ca8b1e008fe8bb905beebc9c45cb12e5e5
+SHA512:
+  metadata.gz: 99d3cdb7d7171d39810e701263f59e87fbe98e3a59203eb0b72a87d0485f3c8dda451795b9444cc57fa0ff1a746738b21ce477d648ca8e4c423182c9750f5c3c
+  data.tar.gz: 706e50e140035860e98d2cb2bde1cd4fa73d0e116a5088bbdb444265981e216c4fcefb642441542eba0f8b4ed7f2c8240611b2e727015d7436e43d6fe34741d9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-*
+*.sw*

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in awestruct-ibeams.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 10.0'
+  gem 'pry'
+  gem 'rspec'
+  gem 'rspec-its'
+end

data/LICENSE.adoc

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

data/README.adoc

@@ -0,0 +1,30 @@
+= Awestruct I-Beams
+
+The `awestruct-ibeams` gem adds more structural support with a variety of
+different extensions to the link:http://awestruct.org[Awestruct] static site
+generator.
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source, ruby]
+----
+gem 'awestruct-ibeams'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install awestruct-ibeams
+
+== Usage
+
+== Contributing
+
+Bug reports and pull requests are welcome
+link:https://github.com/jenkins-infra/awestruct-ibeams[on GitHub].

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+
+task :default => [:spec, :build]

data/awestruct-ibeams.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awestruct/ibeams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "awestruct-ibeams"
+  spec.version       = Awestruct::Ibeams::VERSION
+  spec.authors       = ["R. Tyler Croy"]
+  spec.email         = ["tyler@monkeypox.org"]
+
+  spec.summary       = "Collection of helpful Awestruct extensions and helpers"
+  spec.description   = "Collection of helpful Awestruct extensions and helpers"
+  spec.homepage      = 'https://github.com/jenkins-infra/awestruct-ibeams'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'awestruct', '~> 0.5.6'
+end

data/lib/awestruct/ibeams/asciidoc_sections.rb

@@ -0,0 +1,99 @@
+require 'asciidoctor'
+require 'awestruct/ibeams/errors'
+
+module Awestruct
+  module IBeams
+    module AsciidocSections
+      # sections_from() will take the given
+      #
+      # @param [String] relative or absolute path to a directory containing
+      #   asciidoc files (`.ad`, `.adoc`)
+      # @return [Array] Array of arrays containing: [section_title, filepath,
+      #   link_to_section, subsections]
+      # @raise [Errors::InvalidPath] thrown when the provided +directory+ is
+      #   not a valid path to an existing directory
+      def sections_from(directory)
+        if directory.nil?
+          raise Errors::InvalidPath.new("The provided `directory` was nil")
+        end
+        unless File.directory?(directory)
+          raise Errors::InvalidPath.new("The provided `#{directory}` is not a valid directory")
+        end
+
+        # Generate a +Hash+ of all the pages in the site keyed by their path
+        # for easy discovery
+        pages_by_path = site.pages.map { |p| [p.source_path, p] }.to_h
+        sections = []
+
+        Dir.glob(File.join(directory, "*.{ad,adoc}")).sort.each do |adoc|
+          # Since all our documents are going to have front-matter so they render
+          # properly, we need to look first at the Awestruct::Page and then
+          # re-render to grab the sections from the asciidoc
+          page = pages_by_path[adoc]
+          url = page.url
+
+          document = Asciidoctor.load(page.raw_content)
+
+          document.sections.each do |section|
+            sections << [
+              section.title,
+              adoc,
+              url,
+              find_subsections_from(section, document)
+            ]
+          end
+        end
+
+        return sections
+      end
+
+
+      # This method will recurse through all the subsections of the given
+      # +section+ to discover the full tree of subsections and compute a nested
+      # array containing them.
+      #
+      # @param [Asciidoctor::Section] section to discover subsections from
+      # @param [Asciidoctor::Document] Document objection the section anchor
+      #   belongs to, this is necessary to ensure the document's settinsg are
+      #   used to provide the appropriate anchors
+      # @return [Array] of subsection arrays
+      def find_subsections_from(section, in_document)
+        found = []
+
+        section.sections.each do |subsection|
+          title = subsection.title
+          found << [
+            title,
+            in_document.file,
+            section_anchor(title, in_document),
+            find_subsections_from(subsection, in_document),
+          ]
+        end
+
+        return found
+      end
+
+
+      # Compute an appropriate section anchor for the given title within the
+      # given +Asciidoctor::Document+. This is effectively the same logic that
+      # Asciidoctor itself inside the +Asciidoctor::Section#generate_id+ method
+      # but extracted to be callable in an idempotent fashion
+      #
+      # @param [String] title of the section provided
+      # @param [Asciidoctor::Document] Document objection the section anchor
+      #   belongs to, this is necessary to ensure the document's settinsg are
+      #   used to provide the appropriate anchor
+      # @return [String] Computed section anchor
+      def section_anchor(title, in_document)
+        prefix = in_document.attributes['idprefix'] || ''
+        separator = in_document.attributes['idseparator'] || '-'
+        title = title.downcase.gsub(Asciidoctor::InvalidSectionIdCharsRx, separator)
+
+        return [
+          prefix,
+          title.tr_s(separator, separator).chomp(separator),
+        ].join('')
+      end
+    end
+  end
+end

data/lib/awestruct/ibeams/debuggable_partial.rb

@@ -0,0 +1,21 @@
+require 'awestruct/extensions/partial'
+
+module Awestruct
+  module IBeams
+    # Debuggbale partial is just like a regular partial in awestruct except
+    # there are HTML comments which make it clearer which files are being
+    # included where in the rendered output
+    module DebuggablePartial
+      include Awestruct::Extensions::Partial
+      alias_method :original_partial, :partial
+
+      def partial(path, params={})
+        return [
+          "<!-- starting partial #{path} -->",
+          original_partial(path, params),
+          "<!-- ending partial #{path} -->",
+        ].join("\n")
+      end
+    end
+  end
+end

data/lib/awestruct/ibeams/errors.rb

@@ -0,0 +1,8 @@
+
+module Awestruct
+  module IBeams
+    module Errors
+      class InvalidPath < Exception; end;
+    end
+  end
+end

data/lib/awestruct/ibeams/version.rb

@@ -0,0 +1,5 @@
+module Awestruct
+  module Ibeams
+    VERSION = "0.1.0"
+  end
+end

data/lib/awestruct/ibeams.rb

@@ -0,0 +1,7 @@
+require "awestruct/ibeams/version"
+
+module Awestruct
+  module Ibeams
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: awestruct-ibeams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awestruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+description: Collection of helpful Awestruct extensions and helpers
+email:
+- tyler@monkeypox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.adoc
+- README.adoc
+- Rakefile
+- awestruct-ibeams.gemspec
+- lib/awestruct/ibeams.rb
+- lib/awestruct/ibeams/asciidoc_sections.rb
+- lib/awestruct/ibeams/debuggable_partial.rb
+- lib/awestruct/ibeams/errors.rb
+- lib/awestruct/ibeams/version.rb
+homepage: https://github.com/jenkins-infra/awestruct-ibeams
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Collection of helpful Awestruct extensions and helpers
+test_files: []