RubyGems - octodown - Versions diffs - 0.0.1alpha1 - Mend

octodown 0.0.1alpha1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

data/.gitignore +14 -0
data/.rspec +2 -0
data/.travis.yml +11 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +47 -0
data/Rakefile +43 -0
data/assets/atom.css +396 -0
data/assets/github.css +863 -0
data/bin/octodown +59 -0
data/lib/octodown/renderer/github_markdown.rb +36 -0
data/lib/octodown/renderer/html.rb +41 -0
data/lib/octodown/template/octodown.html.erb +17 -0
data/lib/octodown/version.rb +3 -0
data/lib/octodown.rb +10 -0
data/octodown.gemspec +31 -0
data/spec/dummy/test.md +9 -0
data/spec/markdown_generation_spec.rb +15 -0
data/spec/spec_helper.rb +12 -0
data/spec/template_rendering_spec.rb +24 -0
metadata +231 -0

data/bin/octodown ADDED Viewed

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+require 'octodown'
+require 'optparse'
+require 'pathname'
+require 'securerandom'
+include Octodown
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: octodown [options]"
+  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
+    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 open_in_browser(html)
+  tmp = Pathname.new "/tmp/octodown_#{SecureRandom.hex}.html"
+  file = File.open(tmp, 'w') { |file| file.write html }
+  if cmd = open_browser_cmd
+    Process.spawn(cmd, tmp.to_s, [:out, :err] => File.open('/dev/null').fileno)
+  else
+    raise RuntimeError, 'No compatible shell command to open file in browser'
+  end
+end
+html = create_html_from_md ARGF.read, options[:style] || 'github'
+open_in_browser html

data/lib/octodown/renderer/github_markdown.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'github/markup'
+require 'pygments'
+require 'html/pipeline'
+module Octodown
+  module Renderer
+    class GithubMarkdown
+      attr_reader :content
+      def initialize(content)
+        @content = content
+      end
+      def to_html
+        pipeline.call(content)[:output].to_s
+      end
+      private
+      def context
+        { :asset_root => 'https://assets-cdn.github.com/images/icons/'}
+      end
+      def pipeline
+        ::HTML::Pipeline.new [
+          ::HTML::Pipeline::MarkdownFilter,
+          ::HTML::Pipeline::SanitizationFilter,
+          ::HTML::Pipeline::ImageMaxWidthFilter,
+          ::HTML::Pipeline::MentionFilter,
+          ::HTML::Pipeline::EmojiFilter,
+          ::HTML::Pipeline::SyntaxHighlightFilter
+        ], context.merge(:gfm => true)
+      end
+    end
+  end
+end

data/lib/octodown/renderer/html.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'erb'
+module Octodown
+  module Renderer
+    class HTML
+      attr_reader :rendered_markdown, :template
+      def initialize(rendered_markdown, template)
+        @rendered_markdown = rendered_markdown
+        @template = template
+      end
+      def render
+        template_text = File.read template_filepath
+        erb_template = ERB.new template_text
+        erb_template.result binding
+      end
+      def title
+        'Octodown Preview'
+      end
+      def stylesheet
+        stylesheet_file = File.join Octodown.root, 'assets',
+          "#{template}.css"
+        File.read stylesheet_file
+      end
+      private
+      def parent_dir
+        current_file = File.dirname __FILE__
+        File.expand_path '..', current_file
+      end
+      def template_filepath
+        File.join parent_dir, 'template', 'octodown.html.erb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <style>
+      <%= stylesheet %>
+    </style>
+  </head>
+  <body>
+    <article class="markdown-body">
+      <%= rendered_markdown %>
+    </article>
+  </body>
+</html>

data/lib/octodown/version.rb ADDED Viewed

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

data/lib/octodown.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'octodown/version'
+require 'octodown/renderer/github_markdown'
+require 'octodown/renderer/html'
+module Octodown
+  def self.root
+    spec = Gem::Specification.find_by_name 'octodown'
+    spec.gem_dir
+  end
+end

data/octodown.gemspec ADDED Viewed

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octodown/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'octodown'
+  spec.version       = Octodown::VERSION
+  spec.authors       = ['Ian Ker-Seymer']
+  spec.email         = ['i.kerseymer@gmail.com']
+  spec.summary       = %q{Simple and precise markdown previewing from your terminal.}
+  spec.homepage      = 'https://github.com/ianks/octodown'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/dummy/test.md ADDED Viewed

@@ -0,0 +1,9 @@
+# Hello world!
+You are now reading markdown. How lucky you are!
+```ruby
+def some_code()
+  puts 'Yeah, this is some code.'
+end
+```

data/spec/markdown_generation_spec.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'tempfile'
+describe Octodown::Renderer::GithubMarkdown do
+  let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
+  let(:html) { Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html }
+  it 'create HTML from markdown file' do
+    expect(html).to include '<h1>Hello world!</h1>'
+    expect(html).to include '<p>You are now reading markdown. How lucky you are!</p>'
+  end
+  it 'highlights the code' do
+    expect(html).to include 'highlight-ruby'
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require 'octodown'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/template_rendering_spec.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'tempfile'
+describe Octodown::Renderer::HTML do
+  let(:dummy_path) { File.join(File.dirname(__FILE__), 'dummy', 'test.md') }
+  let(:html) { Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html }
+  subject { Octodown::Renderer::HTML.new(html, 'github').render }
+  before { allow(Octodown).to receive(:root) { '.' } }
+  it 'includes HTML from markdown rendering phase' do
+    expect(subject).to include '<h1>Hello world!</h1>'
+    expect(subject).to include '<p>You are now reading markdown. How lucky you are!</p>'
+    expect(subject).to include 'highlight-ruby'
+  end
+  it 'sets the title' do
+    expect(subject).to include '<title>Octodown Preview</title>'
+  end
+  it 'injects Github CSS' do
+    css = File.read(File.join(Octodown.root, 'assets', 'github.css'))
+    expect(subject).to include css
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: octodown
+version: !ruby/object:Gem::Version
+  version: 0.0.1alpha1
+  prerelease: 5
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire:
+bindir: bin
+cert_chain: []
+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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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:
+email:
+- i.kerseymer@gmail.com
+executables:
+- octodown
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/atom.css
+- assets/github.css
+- bin/octodown
+- lib/octodown.rb
+- lib/octodown/renderer/github_markdown.rb
+- lib/octodown/renderer/html.rb
+- lib/octodown/template/octodown.html.erb
+- lib/octodown/version.rb
+- octodown.gemspec
+- spec/dummy/test.md
+- spec/markdown_generation_spec.rb
+- spec/spec_helper.rb
+- spec/template_rendering_spec.rb
+homepage: https://github.com/ianks/octodown
+licenses:
+- MIT
+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
+signing_key:
+specification_version: 3
+summary: Simple and precise markdown previewing from your terminal.
+test_files:
+- spec/dummy/test.md
+- spec/markdown_generation_spec.rb
+- spec/spec_helper.rb
+- spec/template_rendering_spec.rb