ingo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a47c7bce5fadf71f66343d35a49c5c7425bfdb22
+  data.tar.gz: 34824d2cb3fc282212a4cf755b8187c847fb250e
+SHA512:
+  metadata.gz: d45f4f07f8151019ce16886d313cb6eefd7f6b97f1af93d5343bbd8376900d5c20e8bb51ec1cf2527a8f924aae8ffc8ea2c1b8053bb19a33efbfe4d6d3ef53c1
+  data.tar.gz: d9a7c90b2f79c1aab191e9fae838caddbfd34e982743d0e3b3d53b4c47b3d70f818f4c6ba7295f359c55054889a16e927aa12da6ef9f15d810aa8be42cc6f38c

data/CHANGELOG.adoc

@@ -0,0 +1,5 @@
+= Changelog
+
+== Unreleased
+
+First version with initial feature set.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Florian Wilhelm
+
+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,56 @@
+= Ingo: A static site generator built on http://asciidoctor.org/[Asciidoctor]
+
+Ingo converts AsciiDoc files in a directory and converts them using http://asciidoctor.org/[Asciidoctor].
+It is built for collecting notes in AciiDoc format and presenting them.
+
+It is recommended to add `topics` to each file.
+
+For example
+
+----
+:topics: gardening, hobby, shopping
+----
+
+defines three topics.
+Ingo will create an index file for each topic linking to all documents with that topic.
+Think of topics as "Categories" in wikipedia.
+Ingo is meant to provide an alternative to wikis for note taking for individuals and teams.
+In combination with Github/Gitlab and a CI service it can provide a similar experience for technical users.
+
+Note that the files *must* be in a `docs` subdirectory of the project directory.
+The resulting files are written to `output`.
+An example project can be found at https://gitlab.com/fwilhe/berlin.
+
+== How to build
+
+.Install dependencies
+----
+bundle install
+----
+
+.Run tests
+----
+bundle exec rake test
+----
+
+== How to run
+
+.Run program
+----
+bin/ingo path
+----
+
+== The name
+
+Yes, I was thinking about https://gohugo.io/[Hugo] and just took another male name.
+
+== Release process
+
+This is still work in progress.
+It needs automation wherever possible.
+
+* Update changelog for upcoming release
+* Remove `.unreleased` suffix from version and commit as "prepare release"
+* Create and push git tag with the version number
+* Build and publish the artifact(s)
+* Update version and append `.unreleased` and commit as "prepare for next development iteration"

data/bin/ingo

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/ingo'
+
+base_directory = ARGV[0]
+
+if base_directory.nil?
+  puts 'This is ingo. Please provide a input directory like "ingo path/to/my/notes"'
+else
+  if File.directory?(base_directory)
+    if File.directory?(base_directory + '/docs')
+      Class.new.extend(Ingo).convert_directory(base_directory)
+      Class.new.extend(Ingo).create_index_files(base_directory)
+    else
+      puts "#{base_directory}/docs is not a directory. Please consult the documentation."
+    end
+  else
+    puts "#{base_directory} is not a directory"
+  end
+end

data/lib/ingo.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+require 'asciidoctor'
+require 'fileutils'
+
+module Ingo
+
+  def asciidoc_link(reference, text)
+    "link:#{reference}[#{text}]"
+  end
+
+  def output_file_name(input_file_name)
+    File.basename(input_file_name, '.*') + '.html'
+  end
+
+  def topics(document)
+    Asciidoctor.load_file(document).attributes['topics'].split(', ')
+  end
+
+  def list_of_topics(document)
+    lines = []
+    lines << ''
+    lines << 'Topics:'
+    lines << ''
+    asciidoctor_document = Asciidoctor.load_file(document)
+    if asciidoctor_document.attributes['topics']
+      topics = asciidoctor_document.attributes['topics'].split(', ')
+      topics.each do |t|
+        lines << "#{asciidoc_link(t + '-index.html', t)} "
+      end
+    else
+      puts "#{document} has no topics"
+    end
+    lines << ''
+
+    lines
+  end
+
+  def convert_directory(base_directory)
+    Dir.glob(File.join(base_directory, 'docs/**/*.adoc')) do |document|
+      lines = File.readlines(document)
+      lines += list_of_topics(document)
+      ad_doc = Asciidoctor::Document.new(lines, header_footer: true, safe: 'unsafe')
+      html = ad_doc.convert
+      FileUtils.mkdir_p(File.join(base_directory, 'output'))
+      File.open(File.join(base_directory, 'output', output_file_name(document)), 'w+') do |file|
+        file.puts html
+      end
+    end
+  end
+
+  def create_index_files(base_directory)
+    topics = populate_topics(base_directory)
+    meta_index = <<END
+= Index
+
+END
+    meta_index = write_indexes(base_directory, meta_index, topics)
+    write_meta_index(base_directory, meta_index)
+  end
+
+  def populate_topics(base_directory)
+    topics = Hash.new
+    Dir.glob base_directory + '/docs/**/*.adoc' do |doc|
+      asciidoctor_document = Asciidoctor.load_file doc
+      if asciidoctor_document.attributes['topics']
+        this_topics = asciidoctor_document.attributes['topics'].split(", ")
+        this_topics.each do |t|
+          if topics[t].nil?
+            topics[t] = []
+          end
+          topics[t] << output_file_name(doc)
+        end
+      end
+    end
+    topics
+  end
+
+  def write_indexes(base_directory, meta_index, topics)
+    topics.each do |t, docs|
+      meta_index += "* #{asciidoc_link(t + '-index.html', t)}\n"
+      index = <<END
+== Index of #{t}
+
+END
+      docs.each do |doc|
+        index += "* #{asciidoc_link(doc, File.basename(doc, '.*'))}\n"
+      end
+      html = Asciidoctor.convert(index, header_footer: true, safe: 'unsafe')
+      File.open(base_directory + '/output/' + t + '-index.html', 'w') do |f|
+        f.write(html)
+      end
+    end
+    meta_index
+  end
+
+  def write_meta_index(base_directory, meta_index)
+    html = Asciidoctor.convert(meta_index, header_footer: true, safe: 'unsafe')
+    File.open(base_directory + '/output/index.html', 'w') do |f|
+      f.write(html)
+    end
+  end
+
+  def run(base_directory)
+    convert_directory(base_directory)
+    create_index_files(base_directory)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ingo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Florian Wilhelm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Ingo converts AsciiDoc files in a directory and converts them using Asciidoctor.
+  It is built for collecting notes in AciiDoc format and presenting them.
+email: florian-wilhelm@onlinehome.de
+executables:
+- ingo
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- bin/ingo
+- lib/ingo.rb
+homepage: https://gitlab.com/fwilhe/ingo
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: A static site generator built on Asciidoctor
+test_files: []