madman 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f05f3de9220613be599d500d333c17ee68b415a0f635fec5ce553a13f55a771
-  data.tar.gz: 753a684bdc3de29b0e74e9a0868f260d7d7e736aa7f1d554e61f30414dd48620
+  metadata.gz: 47049987d632e62ea57b613c96170b95031acaa20b0390fdbf55d430d02c45ec
+  data.tar.gz: 53856412c8eb24b3ee946f24b554f80fa66aad09ee93bfe0b7ff0bc30ae90bb1
 SHA512:
-  metadata.gz: a7d40a171015a9cf52c727e16069f37d96ecea0956d4c347d89e6d66bed3719e21827b78b66ed3bf8e4c15569cd15a8b545524bb6d10ba894daaf4acafac51ab
-  data.tar.gz: 1e7c1342fa3c38c9996079d4eacb68814d5c660f82d541fd6354a31f994838026594b526306ca2f8179478d59fa192ddaa0c197be0e717890acae60d862c9131
+  metadata.gz: a2df596bb8c46b703e2e708199a945d95534bf5a294ce40580b3693bb7390087a46b1fce1e6dc31cc33adca2106fc36c64210e78a9d433597006463026af88a5
+  data.tar.gz: daca0122ce6af5f38f9aeeed54c87fc818784c93a29e89da89eb6babe71ab0f6359c9686a5a9889cb5a77e295ca373fdd99903df4bb55b0a74416257d6e496a4

data/README.md

@@ -38,6 +38,7 @@ Key Features
 - [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.
+- [Considered] Web server for an entire folder (like [Madness][1])
 
 
 
@@ -98,15 +99,15 @@ Examples:
 $ madman serve --help
 Run a webserver and serve the markdown file as HTML
 
+This command will start a local server with two endpoints:
+  /         will render the markdown with the default renderer
+  /github   will render with the GitHub API
+
 Usage:
-  madman serve INFILE [--port N --bind ADDRESS --rtl --github]
+  madman serve INFILE [--port N --bind ADDRESS --rtl]
   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.
 
@@ -126,14 +127,17 @@ Parameters:
 Environment Variables:
   GITHUB_ACCESS_TOKEN
     Your GitHub API access token
+    Required only if you wish to use the '/github' endpoint
     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 -->
+<!-- usage -->
+
+
+[1]: https://github.com/DannyBen/madness

data/bin/madman-render.rb

@@ -22,16 +22,13 @@ action do |args|
   outfile = args['OUTFILE'] || "#{infile}.html"
   renderer = args['--github'] ? :github : :default
 
-
-  opts = {
-    rtl: args['--rtl'],
-    renderer: renderer
-  }
-
-  doc = Madman::Document.from_file infile, opts
-
+  doc = Madman::Document.from_file infile
+  template = Madman::Template.new :default
+  
   say "Rendering using the #{renderer} renderer"
-  doc.render outfile
+  output = template.render doc.render(renderer)
+
+  File.write outfile, output
   say "Saved !txtgrn!#{outfile}"
 end
 

data/bin/madman-serve.rb

@@ -1,21 +1,21 @@
 require 'madman'
 
-help "Run a webserver and serve the markdown file as HTML"
+summary "Run a webserver and serve the markdown file as HTML"
 
-usage "madman serve INFILE [--port N --bind ADDRESS --rtl --github]"
+help "This command will start a local server with two endpoints:\n  /         will render the markdown with the default renderer\n  /github   will render with the GitHub API"
+
+usage "madman serve INFILE [--port N --bind ADDRESS --rtl]"
 usage "madman serve (-h|--help|--version)"
 
-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"
+environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\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|
@@ -26,7 +26,11 @@ action do |args|
     rtl:  args['--rtl']
   }
 
-  opts[:renderer] = :github if args['--github'] 
+  say "Starting server at !undblu!localhost:#{opts[:port]}!txtrst!"
+  if ENV['GITHUB_ACCESS_TOKEN']
+    say "To view the GitHub API version go to !undblu!localhost:#{opts[:port]}/github!txtrst!"
+  end
+  say ''
 
   Madman::Server.options opts
   Madman::Server.run!

data/lib/madman/document.rb

@@ -1,64 +1,24 @@
 module Madman
   class Document
-    attr_reader :text, :options
+    attr_reader :text, :filename
 
-    def self.from_file(file, opts=nil)
-      opts ||= {}
-      new File.read(file), opts.merge({ filename: file })
+    def self.from_file(file)
+      new File.read(file), file
     end
 
-    def initialize(text, options=nil)
+    def initialize(text, filename=nil)
       @text = text
-      options ||= {}
-      @options = default_options.merge options
+      @filename = filename
     end
 
-    def set(new_opts)
-      @options = options.merge new_opts
-    end
-
-    def render(outfile)
-      File.write outfile, to_html
-    end
-
-    def to_html
-      html = template
-      content = renderer.render text
-      
-      replacements = {
-        content: content,
-        inline_css: css,
-        body_attributes: ''
-      }
-      replacements[:body_attributes] = "dir='rtl'" if options[:rtl]
-
-      html %= replacements
+    def render(renderer=:default)
+      renderers[renderer].render text
     end
 
     private
 
-    def renderer
-      Renderers.available_renderers[options[:renderer]]
-    end
-
-    def default_options
-      { renderer: :default }
-    end
-
-    def template
-      @template ||= File.read template_file
-    end
-
-    def css
-      @css ||= File.read css_file
-    end
-
-    def template_file
-      @template_file ||= File.expand_path('../templates/template.html', __dir__)
-    end
-
-    def css_file
-      @css_file ||= File.expand_path('../templates/css.css', __dir__)
+    def renderers
+      Renderers.available_renderers
     end
   end
 end

data/lib/madman/server.rb

@@ -9,16 +9,22 @@ module Madman
       set :public_folder, File.expand_path(File.dirname(@@options[:file]))
     end
 
+    get '/' do
+      template.render doc.render
+    end
+
+    get '/github' do
+      template.render doc.render(:github)
+    end
+
+    private
+
     def doc
-      doc_options = {
-        rtl: @@options[:rtl],
-        renderer: (@@options[:renderer] || :default)
-      }
-      Madman::Document.from_file @@options[:file], doc_options
+      Madman::Document.from_file @@options[:file]
     end
 
-    get '/' do
-      doc.to_html
+    def template
+      Madman::Template.new :default, rtl: @@options[:rtl]
     end
   end
 end

data/lib/madman/template.rb

@@ -0,0 +1,45 @@
+module Madman
+  class Template
+    attr_reader :file, :options, :content
+
+    def initialize(file, options=nil)
+      @file = file.is_a?(Symbol) ? presets[file] : file
+      @options = options || {}
+    end
+
+    def render(content)
+      @content = content
+      template % replacements
+    end
+
+    private
+
+    def replacements
+      result = {
+        content: content,
+        inline_css: css,
+        body_attributes: ''
+      }
+      result[:body_attributes] = "dir='rtl'" if options[:rtl]
+      result
+    end
+
+    def template
+      @template ||= File.read file
+    end
+
+    def css
+      @css ||= File.read css_file
+    end
+
+    def presets
+      {
+        default: File.expand_path('../templates/template.html', __dir__)
+      }
+    end
+
+    def css_file 
+      @css_file ||= File.expand_path('../templates/css.css', __dir__)
+    end
+  end
+end

data/lib/madman/version.rb

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

data/lib/madman.rb

@@ -3,7 +3,8 @@ require 'octokit'
 require 'sinatra/base'
 
 require 'madman/document'
-require 'madman/server'
 require 'madman/renderers'
+require 'madman/server'
+require 'madman/template'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/templates/template.html

@@ -23,9 +23,9 @@
       }
     </style>
 
-  <article class="markdown-body" %{body_attributes}>
-    %{content}
-  </article>
+    <article class="markdown-body" %{body_attributes}>
+      %{content}
+    </article>
 
   </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -253,6 +253,7 @@ files:
 - lib/madman/renderers/default.rb
 - lib/madman/renderers/github.rb
 - lib/madman/server.rb
+- lib/madman/template.rb
 - lib/madman/version.rb
 - lib/templates/css.css
 - lib/templates/template.html