octodown 0.0.1alpha1 → 0.1.0beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3011aaac61ee304bc3439716128d596750f8492
+  data.tar.gz: f391bb139714707d690efd512f2145d3565cf339
+SHA512:
+  metadata.gz: 438fc034632fc7760d0bd91bc9448f34a9ca551ddf3fef6d13f44f798ea90a1c74d874a24b75eeb7a5fd837c25a432adcf078cb48f46deedda403d68945552bf
+  data.tar.gz: 114b94fffa16b686ef1fd6c2dee9f652cb40cf4d9dd60a9579d326ec1654bf17b68aaecae7c7192b13b8b64f5518d2a1151eebe5fe73e09433be2e6453316111

data/README.md

@@ -1,5 +1,6 @@
 :octocat: octodown
 ==================
+[![GemVersion](https://badge.fury.io/rb/octodown.svg)](http://badge.fury.io/rb/octodown)
 [![Build Status](https://travis-ci.org/ianks/octodown.svg)](https://travis-ci.org/ianks/octodown)
 
 Ever wanted to easily preview what you markdown would look like *exactly* on
@@ -9,7 +10,7 @@ you. Dead simple. Never get caught writing ugly markdown again.
 ## Features:
 
   * Uses the same markdown parsers and CSS as Github for true duplication.
-    - Yes emojis *are* included :clap:
+    - Yes emojis *are* included
   * Fast. `octodown` uses native parsers to ensure performance.
   * Multiple CSS styles. Choose from either:
     - `$ octodown --style atom README.md`
@@ -26,17 +27,28 @@ you. Dead simple. Never get caught writing ugly markdown again.
   2. If you have a non-system Ruby (*highly recommended*):
     * `$ gem install octodown`
   3. Else:
-    * `$ sudo gem install octodown --no-ri --no-rdoc`
+    * `$ sudo gem install octodown`
 
 ## Usage
 
+  1. Basic:
     $ octodown README.md
+  2. Markdown preview styling
+    $ octodown --style atom README.md
+  3. *nix lovers
+    $ echo '# Hello world!' | octodown --raw > index.html
 
 ## Notes
 
   1. With no arguments given, octodown will read STDIN until EOF is reached. In
   order to work with this mode, type what you want into the input, then press
   `Ctrl-D` when finished.
+  2. octodown attempts to use default OS support for opening HTML files from
+  terminal. In Mac, this would be the `open` command; for Linux it is either
+  `xdg-open` or `x-www-browser`. If these are not set, octodown will not
+  automatically open the file in the browser. If octodown doesn't have the
+  commands neccesary to open files in a browser, please consider opening a pull
+  request to add support!
 
 ## Contributing
 

data/bin/octodown

@@ -2,58 +2,41 @@
 
 require 'octodown'
 require 'optparse'
-require 'pathname'
-require 'securerandom'
 
 include Octodown
 
 options = {}
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: octodown [options]"
+  opts.banner = 'Usage: octodown [options]'
 
-  opts.on("-s", "--style [STYLE]", [:github, :atom], "Choose style (atom, github)") do |s|
+  opts.on('-s', '--style [STYLE]', [:github, :atom], 'Choose style (atom, github)') do |s|
     options[:style] = s
   end
 
-  opts.on_tail("-h", "--help", "Show this message") do
+  opts.on('-r', '--[no-]raw', 'Print raw HTML to STDOUT') do |r|
+    options[:raw] = r
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
   end
 end.parse!
 
-def create_html_from_md(filename, template)
-  unstyled_html = Renderer::GithubMarkdown.new(filename).to_html
-  Renderer::HTML.new(unstyled_html, template).render
-end
-
-
-def open_browser_cmd
-  if RUBY_PLATFORM.include? 'darwin'
-    return '/usr/bin/open'
-  elsif RUBY_PLATFORM.include? 'linux'
-    candidates = %w(/usr/bin/xdg-open /usr/bin/x-www-browser)
-
-    candidates.each do |cmd|
-      return cmd if File.exists? cmd
-    end
-  else
-    return 'start'
-  end
-
-  false
-end
+def main(options)
+  include Octodown::Support
 
-def open_in_browser(html)
-  tmp = Pathname.new "/tmp/octodown_#{SecureRandom.hex}.html"
-  file = File.open(tmp, 'w') { |file| file.write html }
+  input_contents = ARGF.read
+  style = options[:style] || 'github'
 
-  if cmd = open_browser_cmd
-    Process.spawn(cmd, tmp.to_s, [:out, :err] => File.open('/dev/null').fileno)
+  if options[:raw]
+    puts Helpers.markdown_to_raw_html input_contents, style
   else
-    raise RuntimeError, 'No compatible shell command to open file in browser'
+    browser = Browser.new
+    html_file = Helpers.markdown_to_html input_contents, style
+    browser.open html_file
   end
 end
 
-html = create_html_from_md ARGF.read, options[:style] || 'github'
-open_in_browser html
+main(options)

data/lib/octodown/support/browser.rb

@@ -0,0 +1,33 @@
+module Octodown
+  module Support
+    class Browser
+      def initialize
+        @cmd = determine_browser_open_cmd
+      end
+
+      def open(file)
+        out_file = File.open('/dev/null').fileno
+        Process.spawn cmd, file.path, [:out, :err] => out_file
+      end
+
+      private
+
+      attr_reader :cmd
+
+      def determine_browser_open_cmd
+        open_in_browser_candidates.detect { |cmd| File.exists? cmd }
+      end
+
+      def open_in_browser_candidates
+        # TODO: More robust detection for OS
+        if RUBY_PLATFORM.include? 'darwin'
+          %w(/usr/bin/open)
+        elsif RUBY_PLATFORM.include? 'linux'
+          %w(/usr/bin/xdg-open /usr/bin/x-www-browser)
+        else
+          %w(start)
+        end
+      end
+    end
+  end
+end

data/lib/octodown/support/helpers.rb

@@ -0,0 +1,17 @@
+module Octodown
+  module Support
+    module Helpers
+      # TODO: Find a better home for this logic
+      def self.markdown_to_html(contents, template)
+        html = markdown_to_raw_html(contents, template)
+        tmp = Octodown::Support::HTMLFile.new 'octodown'
+        tmp.persistent_write html
+      end
+
+      def self.markdown_to_raw_html(contents, template)
+        unstyled_html = Octodown::Renderer::GithubMarkdown.new(contents).to_html
+        Octodown::Renderer::HTML.new(unstyled_html, template).render
+      end
+    end
+  end
+end

data/lib/octodown/support/html_file.rb

@@ -0,0 +1,19 @@
+require 'tempfile'
+require 'fileutils'
+
+module Octodown
+  module Support
+    class HTMLFile < Tempfile
+      def persist
+        ObjectSpace.undefine_finalizer self
+        self
+      end
+
+      def persistent_write(content)
+        self.write content
+        self.close
+        self.persist
+      end
+    end
+  end
+end

data/lib/octodown/template/octodown.html.erb

@@ -3,7 +3,7 @@
 <html>
   <head>
     <title><%= title %></title>
-
+    <link rel="shortcut icon" href="https://raw.githubusercontent.com/ianks/octodown/master/assets/favicon.png" type="image/png" />
     <style>
       <%= stylesheet %>
     </style>

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '0.0.1alpha1'
+  VERSION = '0.1.0beta1'
 end

data/lib/octodown.rb

@@ -1,6 +1,9 @@
-require 'octodown/version'
 require 'octodown/renderer/github_markdown'
 require 'octodown/renderer/html'
+require 'octodown/support/browser'
+require 'octodown/support/helpers'
+require 'octodown/support/html_file'
+require 'octodown/version'
 
 module Octodown
   def self.root

data/octodown.gemspec

@@ -17,15 +17,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'github-markup'
-  spec.add_dependency 'github-linguist'
-  spec.add_dependency 'html-pipeline'
-  spec.add_dependency 'sanitize'
-  spec.add_dependency 'github-markdown'
-  spec.add_dependency 'gemoji'
-  spec.add_dependency 'pygments.rb'
+  spec.add_dependency 'github-markup',       '~> 1.3.1'
+  spec.add_dependency 'github-linguist',     '~> 4.2.5'
+  spec.add_dependency 'html-pipeline',       '~> 1.11.0'
+  spec.add_dependency 'sanitize',            '~> 3.1.0'
+  spec.add_dependency 'github-markdown',     '~> 0.6.8'
+  spec.add_dependency 'gemoji',              '~> 2.1.0'
+  spec.add_dependency 'pygments.rb',         '~> 0.6.0'
 
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec',   '~> 3.1.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake',    '~> 10.0'
 end

data/spec/browser_spec.rb

@@ -0,0 +1,10 @@
+describe Octodown::Support::Browser do
+  subject { Octodown::Support::Browser.new }
+
+  describe 'open' do
+    it 'opens file in browser' do
+      expect(subject).to receive(:open).with('dummy/test.md')
+      subject.open 'dummy/test.md'
+    end
+  end
+end

metadata

@@ -1,174 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 0.0.1alpha1
-  prerelease: 5
+  version: 0.1.0beta1
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRQwEgYDVQQDDAtpLmtl
+  cnNleW1lcjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMB4XDTE0MTIxOTA3MjMxOFoXDTE1MTIxOTA3MjMxOFowQjEUMBIGA1UEAwwL
+  aS5rZXJzZXltZXIxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKVwZDJ78nh4
+  49fzhIhSG4hjXcMU2KWwEQIWXp1gESBSvj4NrcygsNvo+y+cbsxB021Fbtw4D1m/
+  Lhqxs8l0MewdaDxwIARu57e+hSX9DpwuDSJzoOBfpWpvdj9QOT0ByeGARCD3Dz4P
+  l4zsZW2HYK3/zWdWznwjh6Jlb/zQaWUgJBanMs15IODVpJ01IW2YqNxDgE1/aaiv
+  kcEE04a3XlNXvRqz0EtDgg6EJdsArVFdtoxT8IGBEvgiltiXusNWfRdAFdtU+Phg
+  Wt/zC43O+nMc8vKQIf7z8gY6ESFTLKYKZEKSAQMzK0EtN/QiTPrrUFLL9WZ4VACg
+  lLmpPiOdIGsCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFE9Q3qbzppIUo0ihetWNmRiDLUV8MCAGA1UdEQQZMBeBFWkua2Vyc2V5bWVy
+  QGdtYWlsLmNvbTAgBgNVHRIEGTAXgRVpLmtlcnNleW1lckBnbWFpbC5jb20wDQYJ
+  KoZIhvcNAQEFBQADggEBAHn26tJwdKaN5Rz8nI6weXyYhvdm9zH1RGD4/ksMPbvu
+  nX16vDqnXHM5KHeC1NgS1ESRlQ0grI5VZlNstFjQXFqbsdAP+UfsnLGpZc4x4C2O
+  gTyUm/TyRZpgGdauRjoR2arPc5M5RDp1xY2XsXKfdWyWlZt0CnKrTezSCyNriHZC
+  8lBhjW73DtD3kmT411PpnN2GMaQQ3svM03XFBQUdyw0gvrKFRv56nVCrGND+KSs3
+  YGBeYMyEy7Q4wf7k4k5yyDUZyyaeg0DF/kNEN5llspJ9DHMP2cQqOiH+IQSNiUhR
+  32sJqaZRHeJLDhZPLi5yXItTsQnPy6uob2oyypwFYTM=
+  -----END CERTIFICATE-----
 date: 2014-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: github-linguist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: github-markdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.8
 - !ruby/object:Gem::Dependency
   name: gemoji
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: 
@@ -179,22 +180,27 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - assets/atom.css
+- assets/favicon.png
 - assets/github.css
 - bin/octodown
 - lib/octodown.rb
 - lib/octodown/renderer/github_markdown.rb
 - lib/octodown/renderer/html.rb
+- lib/octodown/support/browser.rb
+- lib/octodown/support/helpers.rb
+- lib/octodown/support/html_file.rb
 - lib/octodown/template/octodown.html.erb
 - lib/octodown/version.rb
 - octodown.gemspec
+- spec/browser_spec.rb
 - spec/dummy/test.md
 - spec/markdown_generation_spec.rb
 - spec/spec_helper.rb
@@ -202,29 +208,29 @@ files:
 homepage: https://github.com/ianks/octodown
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple and precise markdown previewing from your terminal.
 test_files:
+- spec/browser_spec.rb
 - spec/dummy/test.md
 - spec/markdown_generation_spec.rb
 - spec/spec_helper.rb

metadata.gz.sig

@@ -0,0 +1 @@
+s��{����~"�BI���������J�.�$8�^T�����7�,]?��8\�kg�*��F�mw6RgkyY$����:���>Y6@&Z�x�c�����~���u=tY)���#t ��u\r�:��϶i�w���sS��´�� �"W�c���L�7��F&:�R�,