marksman 0.0.0 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f48ad2830561d8e10bec72c0d97ad5c9372a4973
-  data.tar.gz: f96caf8be940cdd93133ef9974dfa0c58398877b
+  metadata.gz: 057ad0bdc1acdca0c3c4683862837088232521df
+  data.tar.gz: a105f581953f1c52d9416dda50c63fca60c0b82c
 SHA512:
-  metadata.gz: e03abe1e627443dcb4374720a2cdf532cf3318dc7eab8af71989fc48295db35554b9833922c8e7abb0368b5d9cb79fb1e7e620ab0a63961925725a28c4f74b9f
-  data.tar.gz: 850c31fc8806187d3eb88f703dbb1c0f4f444038ac61b4a92d1a5037f9f9e44e55eff1bf923b711c4f2fad061cc9975b26f4c38616bf509154b7b97f9efeb04e
+  metadata.gz: 7c355dbbc9670e5fa05583a04f4b3caecae926d318a8a6a2379f4d4d09a296a95ac2afa08e9b5ec90fb53f29263236607c0ac33d23087865246471772cafa11d
+  data.tar.gz: 90d00af80c4ba2a6873250d568150c53088678a3132898be165d3ca18e88e8e7d342fc83854d5fe36b5b36a9f3723d1537db45fb789e5dd9d0da3f3c77bbdea4

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+public
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: "bundle exec rake spec"
+cache: bundler

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marksman.gemspec
+gemspec
+
+gem 'rake'
+gem 'coveralls', :require => false, group: :test

data/Guardfile

@@ -0,0 +1,7 @@
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bodo Tasche
+
+MIT License
+
+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,80 @@
+# Marksman
+
+[![Code Climate](https://codeclimate.com/github/bitboxer/marksman.png)](https://codeclimate.com/github/bitboxer/marksman)
+[![Coverage Status](https://coveralls.io/repos/bitboxer/marksman/badge.png?branch=master)](https://coveralls.io/r/bitboxer/marksman?branch=master)
+[![Gem Version](http://img.shields.io/gem/v/marksman.svg)](http://rubygems.org/gems/marksman)
+
+This is an opinionated approach to presentations. I don't want to
+think a lot about the design or how to place my text on a slide.
+
+I want to focus on the text. On what I want to say. On the important
+part of the presentation.
+
+If you think the same and love markdown, this might be for you.
+
+## Installation
+
+    gem install marksman
+
+## Usage
+
+This generates a public folder with all things needed from the
+markdown file `presentation.md`:
+
+    marksman generate presentation.md
+
+You can also run it as a watcher that regenerates the presentation each
+time the markdown file was changed
+
+    marksman watch presentation.md
+
+## File format
+
+The system uses plain markdown files with two additions:
+
+* The header can have a jekyll like yaml block
+* Slides are separated with `----------`
+* Presenter Notes within a slide are separated with `**********` from the
+  text in the slide
+
+Here is an example for that format:
+
+    ---
+    title: "How to run a company"
+    theme: "plain"
+    ---
+    Bodo Tasche    
+    @bitboxer
+    ********
+    Here I write what I want to say about me. Aka presenter notes.
+    --------
+    This is code:
+    ```
+    def hello(name)
+      puts "Hello #{name}"
+    end
+    ```
+
+## Themes
+
+Marksman supports themes. You can either set the used theme in the header of the
+presentation or override that choice by adding `-t name` as a parameter.
+
+Currently there are only two themes available:
+
+* `blank` - this renders the presentation as a simple HTML that can be used
+to print the presentation
+* `plain` - this is a basic presentation theme
+
+If you want to create a theme, just copy one of the themes to your project folder and
+reference the directory name in the header.
+
+If you have a theme you would love to share, please send a pull request.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/marksman/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require "pry"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+task :console do
+  require 'pry'
+  require 'marksman'
+  ARGV.clear
+  Pry.start
+end
+

data/bin/marksman

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+#
+require 'rubygems'
+require 'bundler/setup'
+
+require 'marksman'
+
+Marksman::CLI.start(ARGV)

data/lib/marksman.rb

@@ -0,0 +1,13 @@
+require 'marksman/equality'
+require 'marksman/cli'
+require 'marksman/converter'
+require 'marksman/writer'
+require 'marksman/parser'
+require 'marksman/presentation'
+require 'marksman/slide'
+require 'marksman/theme'
+require 'marksman/version'
+require 'marksman/watcher'
+
+module Marksman
+end

data/lib/marksman/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'marksman'
+
+module Marksman
+  class CLI < Thor
+
+    desc 'generate FILE [OUTPUT DIRECTORY]', 'generates a presentation from a markdown file'
+    long_desc <<-LONGDESC
+      `marsksman generate file.md` will parse the markdown file and 
+      create a presentation in the folder 'public'
+
+      You can optionally specify the folder where the presentation is stored
+      as a second parameter.
+
+      > $ marksman FILE.md output
+    LONGDESC
+    method_option :theme, desc: 'override the theme in the presentation', aliases: ['-t']
+    def generate(file, target = 'public')
+      Marksman::Writer.new(file, target, options[:theme]).generate
+    end
+
+    desc 'watch FILE [OUTPUT DIRECTORY]', 'same as generate, but watches the file and regenerates it on each change'
+    method_option :theme, desc: 'override the theme in the presentation', aliases: ['-t']
+    def watch(file, target = 'public')
+      Marksman::Watcher.new(file, target, options[:theme]).watch
+    end
+
+  end
+end

data/lib/marksman/converter.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'haml'
+
+module Marksman
+  class Converter
+
+    attr_accessor :presentation, :theme
+
+    def initialize(presentation)
+      @presentation = presentation
+    end
+
+    def write(directory)
+      puts 'Generating HTML...'
+      FileUtils.mkdir_p(directory)
+      Dir.glob(@presentation.theme.path.join('**/*')).each do |file|
+        if File.file? file
+          copy_file(Pathname.new(file), directory)
+        end
+      end
+    end
+
+    private
+
+    def copy_file(source, target_dir)
+      target = target_name(source, target_dir)
+      FileUtils.mkdir(target.dirname) unless File.exist? target.dirname
+      if (source.extname == '.haml')
+        convert_haml(source, target.to_s.gsub(/\.haml$/, '.html'))
+      else
+        FileUtils.copy(source, target)
+      end
+    end
+
+    def target_name(file, target_dir)
+      base_file = file.to_s[(@presentation.theme.path.to_s.length + 1)..-1]
+      target_file = Pathname.new(target_dir).join(base_file)
+    end
+
+    def convert_haml(file, output)
+      template = File.read(file)
+      haml_engine = Haml::Engine.new(template)
+      html = haml_engine.render(Object.new, {
+        presentation: @presentation
+      })
+      File.write(output, html)
+    end
+
+  end
+end

data/lib/marksman/equality.rb

@@ -0,0 +1,15 @@
+module Marksman
+  module Equality
+
+    def == (other)
+      self.class == other.class && self.attributes == other.attributes
+    end
+
+    def attributes
+      Hash[instance_variables.map do |attribute|
+        [attribute, instance_variable_get(attribute)]
+      end]
+    end
+
+  end
+end

data/lib/marksman/parser.rb

@@ -0,0 +1,55 @@
+require 'redcarpet'
+require 'ostruct'
+require 'yaml'
+
+module Marksman
+  class Parser
+
+    def parse(file)
+      metadata, markdown = load_file(file)
+      slides = split_slides(markdown).map do |slide|
+        sections = separate_presenter_notes(slide)
+        Slide.new(
+          slide: generate_html(sections.slide).strip,
+          notes: generate_html(sections.notes).strip
+        )
+      end
+
+      Presentation.new(filename: File.basename(file), metadata: metadata, slides: slides)
+    end
+
+    private
+
+    def load_file(file)
+      content = File.read(file)
+      if content.match /^(---\s*\n.*?\n?)^(?:---\s*$\n?)(.*)/m
+        [parse_yaml($1), $2]
+      else
+        [{}, content]
+      end
+    end
+
+    def parse_yaml(data)
+      yaml = YAML.load(data)
+      yaml.keys.each do |key|
+        yaml[key.to_sym] = yaml.delete key
+      end
+      yaml
+    end
+
+    def separate_presenter_notes(slide)
+      sections = slide.split(/^(?:\*{1}\s?){3,}\s*$/).each(&:strip)
+      Slide.new(slide: sections[0], notes: sections[1])
+    end
+
+    def split_slides(markdown)
+      slides = markdown.split(/^(?:[-]{1}\s?){3,}\s*$/).each(&:strip)
+    end
+
+    def generate_html(slide)
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML,{fenced_code_blocks: true})
+      markdown.render(slide || '')
+    end
+
+  end
+end

data/lib/marksman/presentation.rb

@@ -0,0 +1,26 @@
+module Marksman
+  class Presentation
+    include Equality
+    attr_accessor :filename, :metadata, :slides, :theme
+
+    def initialize(options)
+      @filename = options[:filename]
+      @slides   = options[:slides] || []
+      @metadata = defaults(filename).merge(options[:metadata] || {})
+      @theme    = Theme.new @metadata[:theme]
+    end
+
+    def title
+      @metadata[:title]
+    end
+
+    def defaults(filename)
+      {
+        filename: filename,
+        title: filename,
+        theme: 'plain'
+      }
+    end
+
+  end
+end

data/lib/marksman/slide.rb

@@ -0,0 +1,12 @@
+module Marksman
+  class Slide
+    include Equality
+    attr_accessor :slide, :notes
+
+    def initialize(options)
+      @slide = options[:slide]
+      @notes = options[:notes]
+    end
+
+  end
+end

data/lib/marksman/theme.rb

@@ -0,0 +1,21 @@
+module Marksman
+  class Theme
+    include Equality
+
+    def initialize(name)
+      @name = name
+    end
+
+    def path
+      @path ||= if File.directory?(@name)
+                  Pathname.new @name
+                else
+                  Pathname.new(File.dirname(__FILE__))
+                    .join('../../')
+                    .join('themes')
+                    .join(@name)
+                end
+    end
+
+  end
+end

data/lib/marksman/version.rb

@@ -0,0 +1,3 @@
+module Marksman
+  VERSION = '0.1'
+end

data/lib/marksman/watcher.rb

@@ -0,0 +1,47 @@
+require 'listen'
+
+module Marksman
+  class Watcher
+
+    def initialize(file, output_directory, theme_name = nil)
+      @file = Pathname.new file
+      @output_directory = output_directory
+      @theme_name = theme_name
+    end
+
+    def watch
+      update(true)
+      listen
+    end
+
+    def update(start_listener = false)
+      puts 'Updating files...'
+      presentation = Marksman::Writer.new(@file, @output_directory, @theme_name).generate
+      start_theme_listener(presentation.theme) unless @theme_listener
+    end
+
+    def listen
+      puts 'Listening to changes...'
+      @markdown_listener = Listen.to(Pathname.new(@file).dirname) do |modified, added, removed|
+        if modified.include? @file.realpath.to_s
+          update
+        end
+      end
+      @markdown_listener.start
+      sleep
+    end
+
+    def start_theme_listener(theme)
+      @theme_listener = Listen.to(theme.path) do |modified, added, removed|
+        update
+      end
+      @theme_listener.start
+    end
+
+    def stop
+      @markdown_listener.stop
+      @theme_listener.stop if @theme_listener
+    end
+
+  end
+end