madman 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f748ad843c81bcf4868ed28e89bdf8ed7d8250a489a7d25ad1fd972241a95bfc
-  data.tar.gz: 6e9fd6730d73a92ff64f7df7bc021c6776e5a6c1cf38d2908d0c737d59629385
+  metadata.gz: 1f05f3de9220613be599d500d333c17ee68b415a0f635fec5ce553a13f55a771
+  data.tar.gz: 753a684bdc3de29b0e74e9a0868f260d7d7e736aa7f1d554e61f30414dd48620
 SHA512:
-  metadata.gz: 2101b953c8eb179a4e943e548868fafb544d3a6aed1205590ae665b8df8dcc0e251008d4f849c442a8830d98a361c1d7eb17f1b9c0cb88cec0cc0d2da68d54d3
-  data.tar.gz: fab4a22e03dc6af9c5886983260541d1335204f3cc60f146e87ae92253a3f6fa8b399383f6307c83f99d43a52f5b7c11f650ed337737e4b9da0ebe1d2dba9f3d
+  metadata.gz: a7d40a171015a9cf52c727e16069f37d96ecea0956d4c347d89e6d66bed3719e21827b78b66ed3bf8e4c15569cd15a8b545524bb6d10ba894daaf4acafac51ab
+  data.tar.gz: 1e7c1342fa3c38c9996079d4eacb68814d5c660f82d541fd6354a31f994838026594b526306ca2f8179478d59fa192ddaa0c197be0e717890acae60d862c9131

data/README.md

@@ -1,6 +1,12 @@
 Madman
 ==================================================
 
+[![Gem Version](https://badge.fury.io/rb/madman.svg)](https://badge.fury.io/rb/madman)
+[![Build Status](https://travis-ci.com/DannyBen/madman.svg?branch=master)](https://travis-ci.com/DannyBen/madman)
+[![Maintainability](https://api.codeclimate.com/v1/badges/506449ea988f5518425d/maintainability)](https://codeclimate.com/github/DannyBen/madman/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/506449ea988f5518425d/test_coverage)](https://codeclimate.com/github/DannyBen/madman/test_coverage)
+
+
 ---
 
 The Markdown Swiss Armi Knife
@@ -10,11 +16,124 @@ The Markdown Swiss Armi Knife
 Installation
 --------------------------------------------------
 
-    $ gem install madman
+```
+$ gem install madman
+```
+
+Or with Bundler:
+
+```ruby
+gem 'madman', require: false
+```
+
+
+
+Key Features
+--------------------------------------------------
+
+- GitHub-style markdown generation.
+- Convert markdown to a single HTML file (including CSS).
+- Ad-hoc server to serve a markdown file locally for preview.
+- Markdown generation with GitHub API (optional).
+- [Planned] Table of Contents generation for a single file.
+- [Planned] Table of Contents generation for a folder of markdown files.
+- [Planned] Combine multiple markdown files to one.
 
 
 
 Usage
 --------------------------------------------------
 
-TODO
+<!-- usage -->
+```
+$ madman
+Commands:
+  render  Render markdown to HTML
+  serve   Run a webserver and serve the markdown file as HTML
+```
+
+---
+
+```
+$ madman render --help
+Render markdown to HTML
+
+Usage:
+  madman render INFILE [OUTFILE] [--rtl --github]
+  madman render (-h|--help|--version)
+
+Options:
+  --github
+    Render using the GitHub API
+    Requires setting the GITHUB_ACCESS_TOKEN environment variable
+
+  --rtl
+    Render text Right to Left
+
+  -h --help
+    Show this help
+
+Parameters:
+  INFILE
+    The input markdown file
+
+  OUTFILE
+    The output HTML file
+    If not provided, the input filename will be used with .html extension
+
+Environment Variables:
+  GITHUB_ACCESS_TOKEN
+    Your GitHub API access token
+    Generate one here: https://github.com/settings/tokens
+
+Examples:
+  madman render README.md
+  madman render README.md --github
+  madman render README.md out.html --rtl
+```
+
+---
+
+```
+$ madman serve --help
+Run a webserver and serve the markdown file as HTML
+
+Usage:
+  madman serve INFILE [--port N --bind ADDRESS --rtl --github]
+  madman serve (-h|--help|--version)
+
+Options:
+  --github
+    Render using the GitHub API
+    Requires setting the GITHUB_ACCESS_TOKEN environment variable
+
+  --rtl
+    Render text Right to Left.
+
+  -p --port N
+    Set server port [default: 3000]
+
+  -b --bind ADDRESS
+    Set server listen address [default: 0.0.0.0]
+
+  -h --help
+    Show this help
+
+Parameters:
+  INFILE
+    The input markdown file
+
+Environment Variables:
+  GITHUB_ACCESS_TOKEN
+    Your GitHub API access token
+    Generate one here: https://github.com/settings/tokens
+
+Examples:
+  madman serve README.md
+  madman serve README.md --github
+  madman serve README.md -p4000 --rtl
+```
+
+---
+
+<!-- usage -->

data/bin/madman

@@ -3,8 +3,7 @@ require 'mister_bin'
 require 'madman/version'
 
 runner = MisterBin::Runner.new 'madman', basedir: __dir__,
-  header: "Madman #{Madman::VERSION}"
-
+  version: Madman::VERSION
 
 begin
   exit runner.run ARGV

data/bin/madman-render.rb

@@ -1,25 +1,36 @@
 require 'madman'
-require 'madman/version'
-
-version Madman::VERSION
 
 help "Render markdown to HTML"
 
-usage "madman render INFILE [OUTFILE] [--rtl]"
+usage "madman render INFILE [OUTFILE] [--rtl --github]"
 usage "madman render (-h|--help|--version)"
 
-option "--rtl", "Render text Right-to-Left"
+option "--github", "Render using the GitHub API\nRequires setting the GITHUB_ACCESS_TOKEN environment variable"
+option "--rtl", "Render text Right to Left"
 
 param "INFILE", "The input markdown file"
-param "OUTFILE", "The output HTML file. If not provided, the input filename will be used with .html extension"
+param "OUTFILE", "The output HTML file\nIf not provided, the input filename will be used with .html extension"
+
+environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nGenerate one here: https://github.com/settings/tokens"
 
 example "madman render README.md"
+example "madman render README.md --github"
 example "madman render README.md out.html --rtl"
 
 action do |args|
   infile = args['INFILE']
   outfile = args['OUTFILE'] || "#{infile}.html"
-  doc = Madman::Document.from_file infile, rtl: args['--rtl']
+  renderer = args['--github'] ? :github : :default
+
+
+  opts = {
+    rtl: args['--rtl'],
+    renderer: renderer
+  }
+
+  doc = Madman::Document.from_file infile, opts
+
+  say "Rendering using the #{renderer} renderer"
   doc.render outfile
   say "Saved !txtgrn!#{outfile}"
 end

data/bin/madman-serve.rb

@@ -1,20 +1,21 @@
 require 'madman'
-require 'madman/version'
-
-version Madman::VERSION
 
 help "Run a webserver and serve the markdown file as HTML"
 
-usage "madman serve INFILE [--port N --bind ADDRESS --rtl]"
+usage "madman serve INFILE [--port N --bind ADDRESS --rtl --github]"
 usage "madman serve (-h|--help|--version)"
 
-option "   --rtl", "Render text Right-to-Left"
+option "--github", "Render using the GitHub API\nRequires setting the GITHUB_ACCESS_TOKEN environment variable"
+option "--rtl", "Render text Right to Left."
 option "-p --port N", "Set server port [default: 3000]"
 option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
 
 param "INFILE", "The input markdown file"
 
+environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nGenerate one here: https://github.com/settings/tokens"
+
 example "madman serve README.md"
+example "madman serve README.md --github"
 example "madman serve README.md -p4000 --rtl"
 
 action do |args|
@@ -25,6 +26,8 @@ action do |args|
     rtl:  args['--rtl']
   }
 
+  opts[:renderer] = :github if args['--github'] 
+
   Madman::Server.options opts
   Madman::Server.run!
 end

data/lib/madman/document.rb

@@ -1,13 +1,20 @@
 module Madman
   class Document
-    attr_reader :text, :opts
+    attr_reader :text, :options
 
-    def self.from_file(file, opts={})
+    def self.from_file(file, opts=nil)
+      opts ||= {}
       new File.read(file), opts.merge({ filename: file })
     end
 
-    def initialize(text, opts)
-      @text, @opts = text, opts
+    def initialize(text, options=nil)
+      @text = text
+      options ||= {}
+      @options = default_options.merge options
+    end
+
+    def set(new_opts)
+      @options = options.merge new_opts
     end
 
     def render(outfile)
@@ -16,20 +23,28 @@ module Madman
 
     def to_html
       html = template
-      content = CommonMarker.render_html text, :DEFAULT, [:table]
+      content = renderer.render text
       
       replacements = {
         content: content,
         inline_css: css,
         body_attributes: ''
       }
-      replacements[:body_attributes] = "dir='rtl'" if opts[:rtl]
+      replacements[:body_attributes] = "dir='rtl'" if options[:rtl]
 
       html %= replacements
     end
 
     private
 
+    def renderer
+      Renderers.available_renderers[options[:renderer]]
+    end
+
+    def default_options
+      { renderer: :default }
+    end
+
     def template
       @template ||= File.read template_file
     end

data/lib/madman/renderers/default.rb

@@ -0,0 +1,9 @@
+module Madman
+  module Renderers
+    class Default
+      def self.render(text, opts={})
+        CommonMarker.render_html text, :DEFAULT, [:table]
+      end
+    end
+  end
+end

data/lib/madman/renderers/github.rb

@@ -0,0 +1,19 @@
+module Madman
+  module Renderers
+    class GitHub
+      def self.render(text, opts={})
+        self.client.markdown text
+      end
+
+      private
+
+      def self.client
+        Octokit::Client.new access_token: access_token
+      end
+
+      def self.access_token
+        ENV['GITHUB_ACCESS_TOKEN'] or raise ArgumentError, "Please set GITHUB_ACCESS_TOKEN"
+      end
+    end
+  end
+end

data/lib/madman/renderers.rb

@@ -0,0 +1,13 @@
+require 'madman/renderers/default'
+require 'madman/renderers/github'
+
+module Madman
+  module Renderers
+    def self.available_renderers
+      {
+        default: Renderers::Default,
+        github: Renderers::GitHub,
+      }
+    end
+  end
+end

data/lib/madman/server.rb

@@ -6,10 +6,15 @@ module Madman
       @@options = opts
       set :bind, @@options[:bind]
       set :port, @@options[:port]
+      set :public_folder, File.expand_path(File.dirname(@@options[:file]))
     end
 
     def doc
-      Madman::Document.from_file @@options[:file], rtl: @@options[:rtl]
+      doc_options = {
+        rtl: @@options[:rtl],
+        renderer: (@@options[:renderer] || :default)
+      }
+      Madman::Document.from_file @@options[:file], doc_options
     end
 
     get '/' do

data/lib/madman/version.rb

@@ -1,3 +1,3 @@
 module Madman
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/madman.rb

@@ -1,5 +1,9 @@
 require 'commonmarker'
+require 'octokit'
 require 'sinatra/base'
 
 require 'madman/document'
 require 'madman/server'
+require 'madman/renderers'
+
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +249,9 @@ files:
 - bin/madman-serve.rb
 - lib/madman.rb
 - lib/madman/document.rb
+- lib/madman/renderers.rb
+- lib/madman/renderers/default.rb
+- lib/madman/renderers/github.rb
 - lib/madman/server.rb
 - lib/madman/version.rb
 - lib/templates/css.css