kisko-suits 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ddeff1177740ae116a13145ca29d72c4331a8e1
+  data.tar.gz: ded9ccdf907cdb1eae3698f69e3ebff92160f2ed
+SHA512:
+  metadata.gz: d89ef4eb536e4b5f3dba7d067db56e74fe50e0a96f8af0e6dcf8e7907e680b1f150754c3616c9e09496c0f4198eb7ec5527287605f5836b87f9e1cd93d0500ba
+  data.tar.gz: 831be14962e7d791fb9e6a08fb93deb00ddb55b57b749b4dcefb56f8b7481f30f53fff3b0db65cb7adef268424612e54290916296bce98e8018d05648e198dd4

data/README.md

@@ -0,0 +1,53 @@
+## Application to compile files as one
+
+This app was meant to compile a single Markdown file by including multiple files to be used by our sales team using Deckset for Mac.
+
+We create sales presentations and such using [Deckset](http://www.decksetapp.com/). There are a lot of information on those documents that we need to use again and again. Our only solution was to copy and paste those slides to the new presentation each time we started to create one.
+
+With Kisko Suits we can create re-usable slides (for example company intro, CVs, contact information) and include those to a compiled presentation. Kisko Suits will update the master Markdown file everytime an included slide is changed/added/removed.
+
+### Installation
+
+Everything you need is already installed on every Apple computer. Just run:
+
+```gem install kisko-suits```
+
+### Usage
+
+Create a config file (.suits file) for your presentation:
+
+File name 'my-presentation.md.suits' would cause kisko-suits to create a Markdown file my-presentation.md
+
+my-presentation.md.suits contains normal Markdown content and included portions (using **relative** paths). For example:
+
+```
+# Presentation #1
+
+include: introduction.md
+include: company/basic_information.md
+
+## Custom extra information
+
+All Markdown formatting **works**.
+
+include: project-details.md
+include: CVs/antti.md
+include: CVs/vesa.md
+include: contact_information.md
+```
+
+The included portions will be merged to the document and the end result will be saved as my-presentation.md when you run:
+
+```kisko-suits my-presentation.md.suits```
+
+Super simple.
+
+If you want to update the output file when any of the included portions in the config are updated, just use the -w switch:
+
+```kisko-suits -w my-presentation.md.suits```
+
+This makes it fast to work with the files and see the end result in Deckset.
+
+### CI Build Status
+
+![](https://magnum.travis-ci.com/kiskolabs/kisko-suits.svg?token=DwseF79747iq46syMYaD)

data/bin/kisko-suits

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/kisko-suits"
+
+begin
+  KiskoSuits::Application.new(ARGV).run
+rescue Errno::ENOENT => err
+  abort "kisko-suits: #{err.message}"
+rescue OptionParser::InvalidOption => err
+  abort "kisko-suits: #{err.message}\n"
+end

data/data/fail.md.suits

@@ -0,0 +1,2 @@
+include: fail.md
+include: asdas/asdas.md

data/data/folder/proot.md

@@ -0,0 +1,5 @@
+include: what.md
+
+adsadas
+
+asdasd

data/data/folder/what.md

@@ -0,0 +1 @@
+what

data/data/preso.md.suits

@@ -0,0 +1,5 @@
+include: test.md
+
+extra content
+
+include: folder/proot.md

data/data/preso.md_proper

@@ -0,0 +1,31 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+asdasd
+
+asdasd
+
+sds
+
+asds
+
+asd
+asds
+
+
+asd
+
+asd
+
+asd
+
+sas
+
+end of file
+
+extra content
+
+what
+
+adsadas
+
+asdasd

data/data/test.md

@@ -0,0 +1,23 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+asdasd
+
+asdasd
+
+sds
+
+asds
+
+asd
+asds
+
+
+asd
+
+asd
+
+asd
+
+sas
+
+end of file

data/lib/kisko-suits.rb

@@ -0,0 +1,6 @@
+require "optparse"
+require 'filewatcher'
+
+require_relative "kisko-suits/application"
+require_relative "kisko-suits/compiler"
+require_relative "kisko-suits/watcher"

data/lib/kisko-suits/application.rb

@@ -0,0 +1,37 @@
+module KiskoSuits
+  class Application
+    def initialize(argv)
+      @params, @files = parse_options(argv)
+    end
+
+    def run
+      if @files.empty? || @files.size > 1 || !@files.first.include?(".suits")
+        abort "Usage: 'kisko-suits my-presentation.md.suits'\n\nOr start watching file with: 'kisko-suits -w my-presentation.md.suits'"
+      else
+        if @params[:watch]
+          on_update = ->(filename) {
+            compiler = KiskoSuits::Compiler.new(@files.first)
+            compiler.render
+            puts "Processed files and compiled '#{compiler.output_filename}'"
+            compiler.included_filenames
+          }
+          KiskoSuits::Watcher.new(@files.first, on_update).start
+        else
+          compiler = KiskoSuits::Compiler.new(@files.first)
+          compiler.render
+          puts "Processed files and compiled '#{compiler.output_filename}'"
+        end
+      end
+    end
+
+    def parse_options(argv)
+      params = {}
+      parser = OptionParser.new
+
+      parser.on("-w") { params[:watch] = true }
+      files = parser.parse(argv)
+
+      [params, files]
+    end
+  end
+end

data/lib/kisko-suits/compiler.rb

@@ -0,0 +1,55 @@
+require "set"
+
+module KiskoSuits
+  class Compiler
+    attr_reader :path, :output_filename, :included_filenames
+
+    def initialize(path)
+      @path = path
+      @output_filename = nil
+
+      @included_filenames = Set.new
+    end
+
+    def render
+      @included_filenames.clear
+
+      abort "Suits file '#{path}' not found" unless File.exists?(path)
+
+      open_output_file do |output|
+        File.foreach(path) do |line|
+          output.write(process_line(File.dirname(path), line))
+        end
+      end
+    end
+
+    private
+
+    def process_line(root_dir, line)
+      if match = line.match(/\s*include:\s*([\w\.\/]+)/)
+        included_path = "#{root_dir}/#{match[1]}"
+        if File.exists?(included_path)
+          @included_filenames << included_path
+
+          File.foreach(included_path).map { |included_line|
+            process_line(File.dirname(included_path), included_line)
+          }.join
+        else
+          puts "Include #{included_path} can't be found"
+          ""
+        end
+      else
+        line
+      end
+    end
+
+    def open_output_file(&block)
+      @output_filename = path.gsub(".suits", "")
+
+      abort "Problem with config file (should end with .suits)" if path == @output_filename
+
+      File.delete(@output_filename) if File.exists?(@output_filename)
+      File.open(@output_filename, 'w', &block)
+    end
+  end
+end

data/lib/kisko-suits/version.rb

@@ -0,0 +1,3 @@
+module KiskoSuits
+  VERSION = "0.0.1"
+end

data/lib/kisko-suits/watcher.rb

@@ -0,0 +1,46 @@
+require "set"
+
+module KiskoSuits
+  class Watcher
+    attr_reader :initial_filename, :on_update, :watched_paths
+
+    def initialize(initial_filename, on_update)
+      @initial_filename = initial_filename
+      @on_update = on_update
+      @watched_paths = Set.new
+    end
+
+    def start
+      process_path(initial_filename)
+      add_path(initial_filename)
+      watch
+    end
+
+    private
+
+    def watch
+      watch_file(watched_paths)
+    end
+
+    def watch_file(filenames)
+      watcher = FileWatcher.new(filenames.to_a)
+      watcher.watch do |changed_filename|
+        process_path(changed_filename)
+        watcher.finalize
+        watch
+      end
+    end
+
+    def process_path(path)
+      found_paths = on_update.call(path)
+
+      found_paths.each do |new_filename|
+        add_path(new_filename)
+      end
+    end
+
+    def add_path(filename)
+      watched_paths << filename
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: kisko-suits
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antti Akonniemi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: This app was meant to compile markdown partials as one document for our
+  sales team using Deckset for Mac
+email:
+- antti@kiskolabs.com
+executables:
+- kisko-suits
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/kisko-suits
+- data/fail.md.suits
+- data/folder/proot.md
+- data/folder/what.md
+- data/preso.md.suits
+- data/preso.md_proper
+- data/test.md
+- lib/kisko-suits.rb
+- lib/kisko-suits/application.rb
+- lib/kisko-suits/compiler.rb
+- lib/kisko-suits/version.rb
+- lib/kisko-suits/watcher.rb
+homepage: http://github.com/kiskolabs/kisko-suits
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: kisko-suits
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Application to compile files as one
+test_files: []