markdown-tools 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f3adbb9b02a6e53a558a9a653c4456d5e01fa62
+  data.tar.gz: c761e052d58d2c46429483993a509af57fe319c9
+SHA512:
+  metadata.gz: f2fc96086bb08604a9dd7796456771a3215ef62cdfe28e5b934abd34453f8b9ae8426ba7567266f2086af8af7feb3f7573af77d69da1f36dac92f79130667cb0
+  data.tar.gz: 50dc4014020252314ff4c18e3d2e45e5b766b71495f8ced19c396ab471c9675a31b3021ec9a4799758a8ab63c3e3e04002a3a590aea1ce57fcc8c2af7b8b1726

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.1 / 2014-12-06
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,10 @@
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+bin/markdown
+lib/markdown/cli/gen.rb
+lib/markdown/cli/opts.rb
+lib/markdown/cli/runner.rb
+lib/markdown/cli/version.rb
+lib/markdown/tools.rb

data/README.md

@@ -0,0 +1,53 @@
+# markdown-tools gem - markdown command line tools
+
+* home  :: [github.com/rubylibs/markdown-tools](https://github.com/rubylibs/markdown-tools)
+* bugs  :: [github.com/rubylibs/markdown-tools/issues](https://github.com/rubylibs/markdown-tools/issues)
+* gem   :: [rubygems.org/gems/markdown-tools](https://rubygems.org/gems/markdown-tools)
+* rdoc  :: [rubydoc.info/gems/markdown-tools](http://rubydoc.info/gems/markdown-tools)
+
+
+
+
+## Usage - Command Line
+
+The `markdown-tools` gem includes a little command line tool. Try `markdown -h` for details:
+
+    markdown - Lets you convert plain text documents to hypertext with your Markdown engine of choice
+      and preprocessing text filters.
+    
+    Usage: markdown [options] files_or_dirs
+        -o, --output PATH                Output Path
+        -v, --verbose                    Show debug trace
+    
+    
+    Examples:
+      markdown                   # Process all documents in working folder (that is, .)
+      markdown quickref          # Process document or folder using Markdown
+      markdown quickref.text     # Process document using Markdown
+      markdown -o site quickref  # Output documents to site folder
+    
+    Note:
+      markdown server            # Starts builtin markdown server
+                                 #   (aliases for server include serve, service, s)
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install markdown-tools
+
+
+
+## License
+
+The `markdown-tools` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Send them along to the
+[Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List](http://groups.google.com/group/webslideshow).
+Thanks!

data/Rakefile

@@ -0,0 +1,31 @@
+require 'hoe'
+require './lib/markdown/cli/version.rb'
+
+Hoe.spec 'markdown-tools' do
+
+  self.version = MarkdownCli::VERSION
+
+  self.summary = 'markdown-tools gem - markdown command line tools'
+  self.description = summary
+
+  self.urls    = ['https://github.com/rubylibs/markdown-tools']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'webslideshow@googlegroups.com'
+  
+  self.extra_deps = [
+    ['markdown'],
+    ['markdown-service'],
+  ]
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 1.9.2'
+  }
+
+end

data/bin/markdown

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/markdown
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/markdown
+#
+
+require 'markdown/tools'
+
+Markdown.main

data/lib/markdown/cli/gen.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+module Markdown
+
+class Gen
+
+  include TextUtils::Filter   # include filters such as comments_percent_style, etc. (see textutils gem)
+
+  attr_reader :logger
+  attr_reader :opts
+    
+  def initialize( logger, opts )
+    @logger = logger
+    @opts   = opts
+  end
+
+    def create_doc( fn )
+      dirname  = File.dirname(  fn )
+      basename = File.basename( fn, '.*' )
+      extname  = File.extname(  fn )
+
+      logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
+
+      if opts.output_path == '.'
+        # expand output path in current dir
+        outpath = File.expand_path( dirname ) 
+      else
+        # expand output path in user supplied dir and make sure output path exists
+        outpath = File.expand_path( opts.output_path ) 
+        FileUtils.makedirs( outpath ) unless File.directory? outpath 
+      end
+      logger.debug "outpath=#{outpath}"
+      
+      # todo: add a -c option to commandline? to let you set cwd?
+
+
+      # change working dir to sourcefile dir (that is, dirname); push working folder/dir
+      newcwd  = File.expand_path( dirname )
+      oldcwd  = File.expand_path( Dir.pwd )
+    
+      unless newcwd == oldcwd
+        logger.debug "oldcwd=>#{oldcwd}<, newcwd=>#{newcwd}<"
+        Dir.chdir( newcwd )
+      end  
+
+      inname  = "#{basename}#{extname}"
+      outname = "#{basename}.html"
+      
+      logger.debug "inname=#{inname}, outname=#{outname}"
+      
+      puts "*** #{inname} (#{dirname}) => #{outname} (#{(opts.output_path == '.') ? dirname : opts.output_path})..."
+      
+      content = File.read( inname )
+      
+      # step 1) run (optional) preprocessing text filters
+      Markdown.filters.each do |filter|
+        mn = filter.tr( '-', '_' ).to_sym  # construct method name (mn)
+        content = send( mn, content )   # call filter e.g.  include_helper_hack( content )  
+      end
+
+      # step 2) convert light-weight markup to hypertext
+      content = Markdown.new( content ).to_html
+
+
+## todo: add Markdown.lib_options inspect/dump to banner
+            
+      banner =<<EOS
+<!-- ======================================================================
+      generated by #{Markdown.banner}
+                on #{Time.now} with Markdown engine '#{Markdown.lib}'
+     ====================================================================== -->
+EOS
+      
+      out = File.new( File.join( outpath, outname ), "w+" )
+####      out << banner
+      out << content
+      out.flush
+      out.close
+
+      ## pop/restore working folder/dir
+      unless newcwd == oldcwd
+        logger.debug "oldcwd=>#{oldcwd}<, newcwd=>#{newcwd}<"
+        Dir.chdir( oldcwd )
+      end  
+            
+    end # method create_doc
+
+
+
+end # class Gen
+end # module Markdown

data/lib/markdown/cli/opts.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module Markdown
+
+class Opts
+  
+  def output_path=(value)
+    @output_path = value
+  end
+  
+  def output_path
+    @output_path || '.'
+  end
+
+end # class Opts
+end # module Markdown

data/lib/markdown/cli/runner.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+
+
+module Markdown
+
+class Runner
+
+  attr_reader :logger
+  attr_reader :opts
+
+  def initialize
+    @logger       = Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+    @opts         = Opts.new
+  end
+
+  def has_markdown_extension?( fn )
+    dirname  = File.dirname( fn )
+    basename = File.basename( fn, '.*' )
+    extname  = File.extname( fn )
+    logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
+
+    return false if extname.empty?   # no extension
+      
+    Markdown.extnames.include?( extname.downcase )
+  end
+    
+  def find_file_with_markdown_extension( fn )
+    dirname  = File.dirname( fn )
+    basename = File.basename( fn, '.*' )
+    extname  = File.extname( fn )
+    logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
+
+    Markdown.extnames.each do |e|
+      newname = File.join( dirname, "#{basename}#{e}" ) 
+      logger.debug "File.exists? #{newname}"
+      return newname if File.exists?( newname )
+    end  # each extension (e)
+      
+    nil   # not found; return nil
+  end
+
+    
+  def find_files( file_or_dir_or_pattern )
+
+    filtered_files = []
+      
+    # assume pattern if includes * or ? or {} or []
+    if file_or_dir_or_pattern =~ /[*?{}\[\]]/
+      puts "searching glob pattern '#{file_or_dir_or_pattern}'..."
+      Dir.glob( file_or_dir_or_pattern ).each do |file|
+        if File.directory?( file )  # skip (sub)directories
+          puts "  skipping folder '#{file}'..."
+          next
+        else
+          if has_markdown_extension?( file )
+            logger.debug "  adding file '#{file}'..."
+            filtered_files << file
+          else
+            puts "  skipping file   '#{file}'..."
+          end
+        end
+      end
+    elsif File.directory?(file_or_dir_or_pattern)
+      puts "searching folder '#{file_or_dir_or_pattern}'..."
+      Dir.entries( file_or_dir_or_pattern ).each do |entry|
+        next if entry == '.' || entry == '..' # silently skip current and up dirs
+          
+        if file_or_dir_or_pattern == '.'
+          file = entry
+        else  # add dir (if not working dir)
+          file = File.join( file_or_dir_or_pattern, entry )  
+        end
+           
+        if File.directory?( file )  # skip (sub)directories
+          puts "  skipping folder '#{file}'..."
+          next
+        else
+          if has_markdown_extension?( file )
+            logger.debug "  adding file '#{file}'..."
+            filtered_files << file
+          else
+            puts "  skipping file   '#{file}'..."
+          end
+        end
+      end
+    else  # assume it's a single file (check for missing extension)
+      if File.exists?( file_or_dir_or_pattern )
+        file = file_or_dir_or_pattern
+        if has_markdown_extension?( file )
+          logger.debug "  adding file '#{file}'..."
+          filtered_files << file
+        else
+          puts "  skipping file   '#{file}'..."
+        end
+      else  # check for existing file w/ missing extension
+        file = find_file_with_markdown_extension( file_or_dir_or_pattern )
+        if file.nil?
+          puts "  skipping missing file '#{file_or_dir_or_pattern}{#{Markdown.extnames.join(',')}}'..."
+        else
+          logger.debug "  adding file '#{file}'..."
+          filtered_files << file
+        end
+      end
+    end
+
+    filtered_files
+  end  # find_files
+  
+    
+    def run( args )
+      opt=OptionParser.new do |cmd|
+    
+        cmd.banner = "Usage: markdown [options] files_or_dirs"
+    
+        cmd.on( '-o', '--output PATH', "Output Path (default is #{opts.output_path})" ) { |path| opts.output_path = path }
+
+        cmd.on( '-v', '--version', "Show version" ) do
+          puts Markdown.banner
+          exit
+        end
+        
+        cmd.on( '--about', "(Debug) Show more version info" ) do
+          puts
+          puts Markdown.banner
+          puts
+
+          # dump settings
+          Markdown.dump
+          puts
+          
+          exit
+        end
+
+        cmd.on( "--verbose", "(Debug) Show debug trace" )  do
+          logger.datetime_format = "%H:%H:%S"
+          logger.level = Logger::DEBUG
+        end
+ 
+## todo: add markdown.lib options (e.g. extensions,etc)
+ 
+        cmd.on_tail( "-h", "--help", "Show this message" ) do
+           puts <<EOS
+
+markdown - Lets you convert plain text documents (#{Markdown.extnames.join(', ')}) to hypertext (.html) with your Markdown engine of choice (#{Markdown.lib}) and preprocessing text filters (#{Markdown.filters.join(', ')}).
+
+#{cmd.help}
+
+Examples:
+  markdown                   # Process all documents in working folder (that is, .)
+  markdown quickref          # Process document or folder using Markdown
+  markdown quickref.text     # Process document using Markdown
+  markdown -o site quickref  # Output documents to site folder
+
+Note:
+  markdown server            # Starts builtin markdown server
+                             #  (aliases for server include serve, service, s)
+
+
+Further information:
+  https://github.com/rubylibs/markdown-tools
+
+EOS
+           exit
+        end
+      end
+
+      opt.parse!( args )
+  
+      puts MarkdownCli.banner
+
+      # force loading of config
+      Markdown.lib
+      
+      Markdown.dump   if logger.level == Logger::DEBUG   # dump settings if verbose/debug flag on
+
+      
+      logger.debug "args.length: #{args.length}"
+      logger.debug "args: >#{args.join(',')}<"
+
+      if args.length == 1 && ['server', 'serve', 'service', 's' ].include?( args[0] )
+         # start service/server
+         # NB: server (HTTP service) not included in standard default require
+        require 'markdown/server'
+
+        Markdown::Server.run!
+      else
+
+        # if no file args given; default to working folder (that is, .)
+        args = ['.'] if args.length == 0
+
+        args.each do |arg|
+          files = find_files( arg )
+          files.each do |file|
+            Gen.new( logger, opts ).create_doc( file )
+          end
+        end
+      end
+
+      puts 'Done. Bye.'
+      
+    end   # method run 
+
+end # class Runner
+end # module Markdown

data/lib/markdown/cli/version.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module MarkdownCli
+
+  MAJOR = 1
+  MINOR = 2
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "markdown-tools/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )}"
+  end
+
+end  # module MarkdownCli
+

data/lib/markdown/tools.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'markdown'
+require 'markdown/service'    # pull in markdown HTTP JSON service addon
+
+
+# our own code
+
+require 'markdown/cli/version'   # note: let version always go first
+require 'markdown/cli/gen'
+require 'markdown/cli/opts'
+require 'markdown/cli/runner'
+
+
+module Markdown
+
+  def self.main
+    
+    # allow env variable to set RUBYOPT-style default command line options
+    #   e.g. -o site 
+    markdownopt = ENV[ 'MARKDOWNOPT' ]
+    
+    args = []
+    args += markdownopt.split if markdownopt
+    args += ARGV.dup
+    
+    Runner.new.run(args)
+  end
+
+end  # module Markdown
+
+
+Markdown.main if __FILE__ == $0

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: markdown-tools
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: markdown
+  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: markdown-service
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: markdown-tools gem - markdown command line tools
+email: webslideshow@googlegroups.com
+executables:
+- markdown
+extensions: []
+extra_rdoc_files:
+- HISTORY.md
+- Manifest.txt
+- README.md
+files:
+- HISTORY.md
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/markdown
+- lib/markdown/cli/gen.rb
+- lib/markdown/cli/opts.rb
+- lib/markdown/cli/runner.rb
+- lib/markdown/cli/version.rb
+- lib/markdown/tools.rb
+homepage: https://github.com/rubylibs/markdown-tools
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: markdown-tools gem - markdown command line tools
+test_files: []