zettel_outline 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e6d4d09a164ac3febd013bbaa07c3ab5be5897e
+  data.tar.gz: 8c4de1018c06c70ce3f8ff340d85d903a963df9a
+SHA512:
+  metadata.gz: 1165635cfcbea62fe5741bfc0ad9c49f1aefab371652bdeb66ad038a9b0b32a1cab420102cfec7fe478b9a1b27c1e18469752c1be3a9566b3af79676c1f19b02
+  data.tar.gz: d93af4f2a5b2d061402047fea8ddeb0e09a136f8e992aa5fd8b45b33638ce28878dd7503e7b23ef8d44e85f041faf7e1a1fdc705e5815cb01d226c54098ee71f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at christian.tietze@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    zettel_outline (0.1.1)
+      colorize (~> 0.7)
+      slop (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.7.7)
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (4.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zettel_outline!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian Tietze
+
+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.md

@@ -0,0 +1,85 @@
+# ZettelOutline Rendering
+
+Assemble a first draft from your [Zettelkasten](http://zettelkasten.de) notes and an outline file. **Markdown** aware, allowing you to write arbitrarily nested lists as outlines.
+
+
+## Installation
+
+Install the ruby gem yourself from the command line:
+
+    $ gem install zettel_outline
+
+## Usage of the program
+
+From the command line, run `zettel_outline` with the required parameters as the help indicates:
+
+    $ zettel_outline
+    usage: zettel_outline -f <OUTLINE FILE> -a <ARCHIVE PATH> -o <DRAFT FILE>
+
+    Required options:
+        -f, --file     an outline file
+        -a, --archive  path to your Zettel notes
+        -o, --output   file to write results to
+
+    Also available:
+        -h, --help     prints this help
+        -v, --verbose  verbose output
+        --version 
+
+For example:
+    
+    $ zettel_outline -f outline.txt -a /path/to/notes/ -o draft.txt
+
+This will read the `outline.txt` from the current directory. It will resolve every Zettel reference using the Zettel note archive (`/path/to/notes/`) and concatenate the notes's contents into `draft.txt`.
+
+A sample outline can look like this:
+
+    * 201407030825 Why baking is so important for life. I really love baking
+    * 201601231448 Banana cake. The very best cake ever
+        * 201601222058 Nutritional value of bananas
+        * 201601222035 Nutritional value of eggs
+
+The nested list of Zettel references will be split into:
+
+1. The Zettel ID, used to find the note in your archive; e.g. "201407030825"
+2. The note title, used for the draft's output; e.g. "Why baking is so important for life"
+3. The comment, which is everything after the first period in the line; e.g. "I really love baking"
+
+Zettel note contents will be separated using Markdown-enabled HTML comments, which are surrounded with `<!--` and `-->`. So the resulting `draft.txt` will look similar to this:
+
+    <!-- §201407030825 Why baking is so important for life -->
+    <!-- I really love baking -->
+    
+    Baking is one of the oldest and definitely one of the 
+    most delicious ways to prepare food. 
+    
+    ...
+
+
+## Usage of the library
+
+The higher-level interface of the gem is very simple. Wrapping every parameter into a `compile` function can look like this:
+
+```ruby
+def compile(outline_path, notes_path, draft_path)
+  content = File.read(outline_path)
+  result = ZettelOutline::compile(content, notes_path)
+  File.open(draft_path, "w") do |f|
+    f.write(ZettelOutline::render(result))
+  end
+end
+```
+
+* `ZettelOutline::compile` takes the outline as a string and the path to resolve note references.
+* `ZettelOutline::render` is just a wrapper to concatenate the result and return a simple string.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/DivineDominion/zettel-outline-rendering>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zettel_outline/zettel_outline"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zettel_outline"
+
+PATH = File.expand_path("~/Archiv/")
+
+testoutline = <<EOF
+* 201509250830 Wie man mit Ausnahmen bei guten Habits umgeht. the comment
+* 201510101029 Bilderquellen im Internet. another comment
+    * 201509281235 Serial Queues 
+* 201509011226 Freie Funktionen über
+EOF
+
+zettel = ZettelOutline::compile(testoutline, PATH)
+puts ZettelOutline::render(zettel)
+

data/exe/zettel_outline

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require "zettel_outline"
+require "slop"
+require "colorize"
+
+opts = Slop.parse(ARGV, suppress_errors: true) do |o|
+  o.banner = "usage: #$PROGRAM_NAME -f <OUTLINE FILE> -a <ARCHIVE PATH> -o <DRAFT FILE>"
+  
+  o.separator ""
+  o.separator "Required options:"
+  o.string '-f', '--file', 'an outline file'
+  o.string '-a', '--archive', 'path to your Zettel notes'
+  o.string '-o', '--output', 'file to write results to'
+  
+  o.separator ""
+  o.separator "Also available:"
+  o.null '-h', '--help', 'prints this help'
+  o.bool '-v', '--verbose', 'verbose output', default: false, :argument => :optional
+  o.on "--version", :argument => :optional do
+    puts "zettel_outline #{ZettelOutline::VERSION} (#{ZettelOutline::DATE})"
+    exit
+  end
+end
+
+if ARGV.include?('-h') || ARGV.include?('--help') 
+  puts opts 
+  exit
+end
+
+class Command
+  attr_accessor :file, :archive, :output, :verbose
+  
+  def initialize(opts)
+    abort("--file required") if opts[:file].nil?
+    abort("--archive required") if opts[:archive].nil?
+    abort("--output required") if opts[:output].nil?
+    
+    opts.to_hash.each do |k, v| send("#{k}=", v) end
+  end
+
+  def check_permissions!
+    abort("Could not open file '#{@file}'.".red) unless File.readable?(@file)  
+    abort("Could not write to file '#{@output}'.") if File.directory?(@output)
+    abort("Zettel archive does not exist at '#{@archive}'.".red) unless File.directory?(@archive)
+  end
+  
+  def execute
+    check_permissions!
+    
+    in_path = File.expand_path(@file)
+    log("Reading in outline from #{in_path} ...")
+    content = File.read(@file)
+    
+    log("Compiling draft from Zettel ...")
+    result = ZettelOutline::compile(content, @archive)
+    
+    out_path = File.expand_path(@output)
+    log("Writing to #{out_path} ...")
+    File.open(out_path, "w") do |f|
+      f.write(ZettelOutline::render(result))
+    end
+  end
+  
+  def log(msg)
+     puts msg.green if @verbose
+  end
+end
+
+Command.new(opts).execute

data/lib/zettel_outline.rb

@@ -0,0 +1,27 @@
+require "zettel_outline/version"
+require 'zettel_outline/outline'
+require 'zettel_outline/outline_item'
+require 'zettel_outline/archive'
+require 'zettel_outline/zettel_info'
+require 'zettel_outline/zettel_renderer'
+require 'zettel_outline/zettel'
+
+module ZettelOutline
+
+  class << self
+    
+    def compile(outline_content, folder)
+      outline = Outline.new(outline_content)
+      all_items = outline.map_files { |f| ZettelInfo.new(f) }
+        .map { |info| OutlineItem.new(info) }
+      renderer = ZettelRenderer.new()
+      archive = Archive.new(folder)
+  
+      all_items.map { |z| z.render(renderer, archive) }
+    end
+    
+    def render(outline)
+      outline.join("")
+    end
+  end
+end

data/lib/zettel_outline/archive.rb

@@ -0,0 +1,30 @@
+require 'zettel_outline/zettel'
+
+module ZettelOutline
+  
+  class Finder
+    def file_path(folder, id)
+      Dir.glob(File.join(folder, "#{id}*")).first
+    end
+  end
+  
+  class Archive
+    def initialize(folder)
+      @folder = folder
+    end
+  
+    def zettel(id, finder = Finder.new)
+      create_zettel(path(id, finder))
+    end
+    
+    def create_zettel(path)
+      return NullZettel.new if path.nil?
+      
+      Zettel.new(path)
+    end  
+
+    def path(id, finder = Finder.new)
+      finder.file_path(@folder, id)
+    end
+  end
+end

data/lib/zettel_outline/outline.rb

@@ -0,0 +1,27 @@
+require "zettel_outline/outline_parser"
+
+module ZettelOutline
+  class Outline
+    attr_reader :content
+    attr_reader :files
+  
+    def initialize(content)
+      @content = content || ""
+    end
+  
+    def files(parser = OutlineParser.new)
+      return [] if @content.empty?
+      
+      @files = parser.parse(content) if @files.nil?
+      @files
+    end
+  
+    def map_files(parser = OutlineParser.new, &block)
+      if block_given?
+        files(parser).map { |f| yield f }
+      else 
+        to_enum(:map_files, parser)
+      end
+    end
+  end
+end

data/lib/zettel_outline/outline_item.rb

@@ -0,0 +1,19 @@
+module ZettelOutline
+  class OutlineItem
+  
+    def initialize(zettel_info)
+      @zettel_info = zettel_info
+    end
+  
+    def render(renderer, archive)
+      renderer.render(zettel(archive), @zettel_info)
+    end
+  
+    private 
+  
+    def zettel(archive)
+      id = @zettel_info.id
+      archive.zettel(id)
+    end
+  end
+end

data/lib/zettel_outline/outline_parser.rb

@@ -0,0 +1,18 @@
+module ZettelOutline
+  class OutlineParser
+    def parse(content)
+      content.each_line
+        .map    { |l| l.strip }
+        .select { |l| !l.empty? }
+        .map    { |l| cleanup(l) }
+    end
+    
+    private
+
+    def cleanup(line)
+      raise "empty line" if line.nil? || line.empty?
+  
+      line[/^[\* ]*(.+)$/, 1]
+    end
+  end
+end

data/lib/zettel_outline/version.rb

@@ -0,0 +1,4 @@
+module ZettelOutline
+  VERSION = "0.1.1"
+  DATE = "2016-01-23"
+end

data/lib/zettel_outline/zettel.rb

@@ -0,0 +1,28 @@
+module ZettelOutline
+  class Zettel
+    def initialize(path)
+      raise "file path needed" if path.nil?
+      raise "file expected at path" unless File.file?(path)
+      
+      @path = path
+    end
+  
+    def render
+      remove_header(file_contents).join("")
+    end
+  
+    def file_contents
+      File.readlines(@path)
+    end
+    
+    def remove_header(text)
+      text
+    end
+  end
+  
+  class NullZettel
+    def render
+      ""
+    end
+  end
+end

data/lib/zettel_outline/zettel_info.rb

@@ -0,0 +1,33 @@
+module ZettelOutline
+    class ZettelInfo
+
+    def initialize(line)
+      @line = line
+    end
+  
+    def id
+      @line[/[0-9]+/]
+    end
+  
+    def title
+      @line[/[0-9]+ ([\d\w_\- ]+?)(?:\..*)?$/, 1]
+    end
+  
+    def comment
+      @line[/[0-9]+ [\d\w_\- ]+\.[ ]*(.*)$/, 1]
+    end
+  
+    def info
+      { id: id, title: title, comment: comment }
+    end
+  
+    def render
+      "".tap do |output|
+        output << "\n"
+        output << %Q{<!-- §#{id} #{title}-->\n}
+        output << %Q{<!-- #{comment}-->\n} unless comment.nil?
+        output << "\n"
+      end
+    end
+  end
+end

data/lib/zettel_outline/zettel_renderer.rb

@@ -0,0 +1,12 @@
+module ZettelOutline
+  class ZettelRenderer
+  
+    def render(contents, separator)
+      "".tap do |output|
+        output << separator.render
+        output << contents.render
+        output << "\n\n"
+      end
+    end
+  end
+end

data/zettel_outline.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zettel_outline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zettel_outline"
+  spec.version       = ZettelOutline::VERSION
+  spec.authors       = ["Christian Tietze"]
+  spec.email         = ["christian.tietze@gmail.com"]
+
+  spec.summary       = %q{Converts a plain text/Markdown outline of Zettel note references into a document.}
+  spec.description   = %q{Using outlines to plan writing projects is great, but assembling a first draft is still tiresome work. Adhere to this gem's outline convention and assemble first drafts in no time.}
+  spec.homepage      = "http://zettelkasten.de/"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "slop", "~> 4.2"
+  spec.add_runtime_dependency "colorize", "~> 0.7"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: zettel_outline
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christian Tietze
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Using outlines to plan writing projects is great, but assembling a first
+  draft is still tiresome work. Adhere to this gem's outline convention and assemble
+  first drafts in no time.
+email:
+- christian.tietze@gmail.com
+executables:
+- zettel_outline
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- exe/zettel_outline
+- lib/zettel_outline.rb
+- lib/zettel_outline/archive.rb
+- lib/zettel_outline/outline.rb
+- lib/zettel_outline/outline_item.rb
+- lib/zettel_outline/outline_parser.rb
+- lib/zettel_outline/version.rb
+- lib/zettel_outline/zettel.rb
+- lib/zettel_outline/zettel_info.rb
+- lib/zettel_outline/zettel_renderer.rb
+- zettel_outline.gemspec
+homepage: http://zettelkasten.de/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Converts a plain text/Markdown outline of Zettel note references into a document.
+test_files: []