mdify 0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    mdify (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mdify!

data/README.md

@@ -0,0 +1,47 @@
+mdify
+=====
+`mdify` is a tool for previewing Markdown documents right in your browser, with a nice stylesheet.
+
+![Screenshot of mdify](http://i.imgur.com/OiRr5.png)
+
+Usage
+-----
+You can use it on your documents by running:
+
+    mdify super_secret.md
+
+It will automatically open a new browser window with the content rendered in there.
+
+Installing
+----
+The installation requires Ruby 1.8.7 or greater.
+
+    gem install mdify
+
+Emacs
+----
+You can hook `mdify` to the `compile-command` in Emacs so it's run by pressing a
+key.
+
+First, bind the compile key to whatever you want to use:
+
+    (global-set-key [f5] 'compile)
+
+Then create a new hook for the Markdown mode:
+
+    (add-hook 'markdown-mode-hook
+      (lambda ()
+        (set (make-local-variable 'compile-command) (concat "mdify " (buffer-name)))))
+
+Now you can press F5 inside any Markdown document to automatically preview it in your browser.
+
+Stylesheet
+----
+The pretty styles are provided by Twitter's [Bootstrap](http://twitter.github.com/bootstrap/)
+library. Right now there's no support for custom stylesheets but feel free to open an issue or
+create a pull request if you want to add something else.
+
+Farewell
+----
+This was written by [Federico](http://mheroin.com). Drop me a line on Twitter
+([@febuiles](http://twitter.com/febuiles)) if you're using this.

data/Rakefile

@@ -0,0 +1,126 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/mdify

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require 'mdify'
+Mdify.preview(ARGV.first)

data/lib/mdify.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'tempfile'
+require 'redcarpet'
+
+require 'mdify/renderer'
+
+module Mdify
+  VERSION = "0.1"
+
+  def self.preview(filename)
+    Renderer.new(filename).render
+  end
+end

data/lib/mdify/renderer.rb

@@ -0,0 +1,32 @@
+module Mdify
+  HTML_TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "..", "vendor", "template.html")
+
+  class Renderer
+    attr_reader :title, :content
+
+    def initialize(filename)
+      @title = filename
+      @content = File.read(filename)
+    end
+
+    def render
+      html = Redcarpet.new(@content).to_html
+      document = render_html(@title, html)
+      temp_file = create_temp_file(document)
+      exec "open #{temp_file}"
+    end
+
+    def render_html(title, html)
+      template_file = File.read(HTML_TEMPLATE_PATH)
+      document = template_file.sub(/\{\{ title \}\}/, title)
+      document.sub!(/\{\{ body \}\}/, html)
+    end
+
+    def create_temp_file(contents)
+      temp_file = Tempfile.new("mdify")
+      temp_file.write(contents)
+      temp_file.close
+      temp_file.path
+    end
+  end
+end

data/mdify.gemspec

@@ -0,0 +1,61 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'mdify'
+  s.version           = '0.1'
+  s.date              = '2011-11-28'
+  s.rubyforge_project = 'mdify'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Preview Markdown documents with your browser"
+  s.description = "mdify is a tool for previewing Markdown documents right in your browser, with a nice stylesheet."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Federico Builes"]
+  s.email    = 'federico@mheroin.com'
+  s.homepage = 'http://github.com/febuiles/mdify'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["mdify"]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency("redcarpet")
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    README.md
+    Rakefile
+    bin/mdify
+    lib/mdify.rb
+    lib/mdify/renderer.rb
+    mdify.gemspec
+    vendor/template.html
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/vendor/template.html

@@ -0,0 +1,15 @@
+<!doctype html>
+<head>
+  <meta charset="utf-8">
+  <title>{{ title }}</title>
+  <link rel="stylesheet" href="http://twitter.github.com/bootstrap/1.3.0/bootstrap.css">
+  <style>
+    body { padding: 30px; width: 960px; }
+    code { background-color: #f5f5f5; }
+    h2 { margin-bottom: 10px; }
+  </style>
+</head>
+<body>
+  {{ body }}
+</body>
+</html>

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: mdify
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Federico Builes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redcarpet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: mdify is a tool for previewing Markdown documents right in your browser, with a nice stylesheet.
+email: federico@mheroin.com
+executables: 
+- mdify
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/mdify
+- lib/mdify.rb
+- lib/mdify/renderer.rb
+- mdify.gemspec
+- vendor/template.html
+homepage: http://github.com/febuiles/mdify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mdify
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 2
+summary: Preview Markdown documents with your browser
+test_files: []
+