octodown 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce562e8fb22b507adb9254a3a477e580e8476aa
-  data.tar.gz: 8bad0909539c3c0ec5976b899e3d8591db901b7c
+  metadata.gz: dad582795e7cd14b58107e3c533ecfc71503f4d2
+  data.tar.gz: 71b248c82c33cb1d4ed0991531f79dec0fb58da2
 SHA512:
-  metadata.gz: 52a608f823bea53fd6bfc09ba7cc4c5f5c40954d7977e798a6635c040e68e252c55c6013f1034b0e9e0ee574c7b0b24e694312f5c34ee0edd6d80702916e972a
-  data.tar.gz: 5e4d3e21b4127e3ac90ea4edbbc85231b771953c57ff1844f3490e218a92447c12bbc27d4ed4b24d17ccbf8e81e3adbcde6ad0b0276293218d77843fe6df90f9
+  metadata.gz: bf4eb1f65e95f3b94a6b76814f854ba2cda0ad59aed4ebff05232689009e5cad6cf10aa1b4704274b1fa7c62bde43a439c992a0804a4d6d23ce3751f8e57eda9
+  data.tar.gz: 4c986a05888c0d05b48de4dcc726f1e3ff2fbaea6ca32447170d5cc197d8f45357431892081b6d65e1d4d6f7b958940ad89c69888df2f84e4941a2f315ecaaa8

data/.travis.yml

@@ -5,8 +5,7 @@ before_install:
     - sudo apt-get install -y libicu-dev build-essential
 install: 'bundle install'
 script:
-  - 'bundle exec rspec --format documentation'
-  - 'bundle exec rubocop'
+  - bundle exec rake
 rvm:
   - '2.2.0'
   - '2.1.4'

data/README.md

@@ -1,50 +1,75 @@
 :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
+
+Ever wanted to easily preview what you markdown would look like _exactly_ on
 Github? Ever wanted to do that from inside of a Terminal? Well this Gem is for
 you. Dead simple. Never get caught writing ugly markdown again.
 
+Octodown uses the same parsers and CSS and Github uses for their markdown
+rendering. Github markdown styling looks beautiful, so it is Octodown's
+primary goal to reproduce it as faithfully as possible.
+
 ![Octodown GIF](assets/octodown.gif?raw=true)
 
+-------------------------------------------------------------------------------
+
 ## Features:
 
-  * Uses the same markdown parsers and CSS as Github for true duplication.
-    - Yes emojis *are* included.
-  * Fast. `octodown` uses native parsers to ensure performance.
-  * Multiple CSS styles. Choose from either.
-    - `$ octodown --style atom README.md`
-    - The `github.com` markdown (default)
-    - The `Atom` text editor markdown
-  * Properly parses `STDIN`.
-    - `$ cat README.md | octodown`
+  - Uses the same markdown parsers and CSS as Github for true duplication.
+    - Yes emojis _are_ included. :smiling_imp:
+
+  - Fast. `octodown` uses native parsers to ensure performance.
+  - Multiple CSS styles.
+    - `octodown --style atom README.md`
+    - The `--github` markdown (default)
+    - The `--atom` text editor markdown
+
+  - Properly parses `STDIN`.
+    - `cat README.md | octodown`
 
 ## Installation
 
   1. Install `icu4c` and `cmake`:
-    * Mac: `$ brew install icu4c cmake`
-    * Apt: `$ sudo apt-get install -y libicu-dev cmake`
-  2. If you have a non-system Ruby (*highly recommended*):
-    * `$ gem install octodown`
-  3. Else:
-    * `$ sudo gem install octodown`
+    - Mac: `brew install icu4c cmake`
+    - Apt: `sudo apt-get install -y libicu-dev cmake`
+
+  2. Install octodown:
+    - If you have a non-system Ruby (_highly recommended_):  `gem install
+      octodown`
+    - Else: `sudo gem install octodown`
+
+  4. Install in VIM (_optional_):
+    - Use [Dispatch](https://github.com/tpope/vim-dispatch) and add this to
+      your .vimrc:
+
+      ```viml
+      " Use octodown as default build command for Markdown files
+      autocmd FileType markdown let b:dispatch = 'octodown %'
+      ```
+    - Caveat: make sure you follow the directions on the Dispatch README.md and
+      make sure that the correct version of Ruby (the one which as Octodown
+      install as a Gem), is used.
 
 ## Usage
 
   1. Basic:
-    * `$ octodown README.md`
+    - `octodown README.md`
+
   2. Markdown preview styling:
-    * `$ octodown --style atom README.md`
+    - `octodown --style atom README.md`
+
   3. *nix lovers:
-    * `$ echo '# Hello world!' | octodown --raw > index.html`
+    - `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.
+    - 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
@@ -54,8 +79,9 @@ you. Dead simple. Never get caught writing ugly markdown again.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/octodown/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+  1. Fork it ( https://github.com/ianks/octodown/fork )
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Run the test suite (`bundle exec rake`)
+  5. Push to the branch (`git push origin my-new-feature`)
+  6. Create a new Pull Request

data/Rakefile

@@ -2,6 +2,16 @@ require 'bundler/gem_tasks'
 require 'open-uri'
 require 'fileutils'
 require 'tempfile'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new :spec do |task|
+  task.rspec_opts = '--format documentation'
+end
+
+task :default => [:spec, :rubocop]
 
 task :styles do
   begin

data/bin/octodown

@@ -20,6 +20,10 @@ OptionParser.new do |opts|
     options[:raw] = r
   end
 
+  opts.on('-g', '--[no-]gfm', 'Use for non-README files (comments, etc)') do |g|
+    options[:gfm] = g
+  end
+
   opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
@@ -30,13 +34,12 @@ def main(options)
   include Octodown::Support
 
   content = ARGF.read
-  style = options[:style] || 'github'
   path = File.dirname(File.expand_path(ARGF.path))
 
   if options[:raw]
-    puts Helpers.markdown_to_raw_html content, style, path
+    puts Helpers.markdown_to_raw_html content, options, path
   else
-    html_file = Helpers.markdown_to_html content, style, path
+    html_file = Helpers.markdown_to_html content, options, path
     Browser.new.open html_file
   end
 end

data/lib/octodown/renderer/github_markdown.rb

@@ -5,11 +5,12 @@ require 'html/pipeline'
 module Octodown
   module Renderer
     class GithubMarkdown
-      attr_reader :content, :document_root
+      attr_reader :content, :document_root, :gfm
 
-      def initialize(content, document_root)
+      def initialize(content, document_root, options = {})
         @content = content
         @document_root = document_root
+        @gfm = options[:gfm] || false
       end
 
       def to_html
@@ -34,7 +35,7 @@ module Octodown
           ::HTML::Pipeline::MentionFilter,
           ::HTML::Pipeline::EmojiFilter,
           ::HTML::Pipeline::SyntaxHighlightFilter
-        ], context.merge(:gfm => true)
+        ], context.merge(:gfm => gfm)
       end
     end
   end

data/lib/octodown/renderer/html.rb

@@ -3,11 +3,11 @@ require 'erb'
 module Octodown
   module Renderer
     class HTML
-      attr_reader :rendered_markdown, :template
+      attr_reader :rendered_markdown, :style
 
-      def initialize(rendered_markdown, template)
+      def initialize(rendered_markdown, options)
         @rendered_markdown = rendered_markdown
-        @template = template
+        @style = options[:style] || 'github'
       end
 
       def render
@@ -24,7 +24,7 @@ module Octodown
         stylesheet_file = File.join(
           Octodown.root,
           'assets',
-          "#{template}.css"
+          "#{style}.css"
         )
 
         File.read stylesheet_file

data/lib/octodown/support/helpers.rb

@@ -4,15 +4,15 @@ module Octodown
       include Octodown::Renderer
 
       # TODO: Find a better home for this logic
-      def self.markdown_to_html(content, template, path)
-        html = markdown_to_raw_html(content, template, path)
+      def self.markdown_to_html(content, options, path)
+        html = markdown_to_raw_html(content, options, path)
         tmp = Octodown::Support::HTMLFile.new 'octodown'
         tmp.persistent_write html
       end
 
-      def self.markdown_to_raw_html(content, template, path)
-        unstyled_html = GithubMarkdown.new(content, path).to_html
-        HTML.new(unstyled_html, template).render
+      def self.markdown_to_raw_html(content, options, path)
+        rendered_markdown = GithubMarkdown.new(content, path, options).to_html
+        HTML.new(rendered_markdown, options).render
       end
     end
   end

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/dummy/test.md

@@ -1,4 +1,7 @@
-# Hello world!
+Hello world!
+============
+![some-img](https://foo.com/bar.img)
+![some-img](https://foo.com/bar.img)
 
 You are now reading markdown. How lucky you are!
 

data/spec/markdown_generation_spec.rb

@@ -2,8 +2,9 @@ require 'tempfile'
 
 describe Octodown::Renderer::GithubMarkdown do
   let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
+  let(:content) { File.read dummy_path }
   let(:html) do
-    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path), 'tmp').to_html
+    Octodown::Renderer::GithubMarkdown.new(content, 'tmp').to_html
   end
 
   it 'create HTML from markdown file' do
@@ -16,4 +17,22 @@ describe Octodown::Renderer::GithubMarkdown do
   it 'highlights the code' do
     expect(html).to include 'highlight-ruby'
   end
+
+  describe 'when :gfm option is set' do
+    context 'true' do
+      it 'renders hard-wraps' do
+        options = { :gfm => true }
+        doc = Octodown::Renderer::GithubMarkdown.new(content, 'tmp', options)
+        expect(doc.to_html).to include '<br>'
+      end
+    end
+
+    context 'false' do
+      it 'does not render hard-wraps' do
+        options = { :gfm => false }
+        doc = Octodown::Renderer::GithubMarkdown.new(content, 'tmp', options)
+        expect(doc.to_html).to_not include '<br>'
+      end
+    end
+  end
 end

data/spec/template_rendering_spec.rb

@@ -2,11 +2,12 @@ require 'tempfile'
 
 describe Octodown::Renderer::HTML do
   let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
+  let(:options) { { style: 'github' } }
   let(:html) do
     Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path), 'tmp').to_html
   end
 
-  subject { Octodown::Renderer::HTML.new(html, 'github').render }
+  subject { Octodown::Renderer::HTML.new(html, options).render }
 
   before { allow(Octodown).to receive(:root) { '.' } }
 

data.tar.gz.sig

@@ -1,3 +1 @@
-l9!/:!�N����.���m��B&�$&��а���ǝxR�D(Y`�ٛ�!�@���M�|P
-z'�c�A;k���{����0z�J���\�M(�k�|�yNv�D�T��JYk3O
-�|�>.@��OWF,ײ��lDZ���s��_&=9E�&���VH�T�aA˿SV�9��܅)��	`�S��[�F}�T�HXl�t���F��cUOa
+,����t�n��+՞��OS<��U����u�dVQ�@{��)`�|7�E��x!�w����"�N�}�3i�9�r�uh��uҺU�_zt�� ���e�S����V:U&�
@����SIRHLw#Ƴ:��2�y��5%���
����f������Dzk�q��8���\G�Ewm(�G�;�7�m�)8����3��eG�#��)��d˛#�B��$��r�<��䁇>�
K���%�-D)�U5(����]G

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -30,7 +30,7 @@ cert_chain:
   YGBeYMyEy7Q4wf7k4k5yyDUZyyaeg0DF/kNEN5llspJ9DHMP2cQqOiH+IQSNiUhR
   32sJqaZRHeJLDhZPLi5yXItTsQnPy6uob2oyypwFYTM=
   -----END CERTIFICATE-----
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup