octodown 0.1.0beta1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3011aaac61ee304bc3439716128d596750f8492
-  data.tar.gz: f391bb139714707d690efd512f2145d3565cf339
+  metadata.gz: 1ae27659b96dc1aed9d8e54fc5fae1eb5af80ecb
+  data.tar.gz: a312690de332fd10839cc6d554c1caeb60043ed9
 SHA512:
-  metadata.gz: 438fc034632fc7760d0bd91bc9448f34a9ca551ddf3fef6d13f44f798ea90a1c74d874a24b75eeb7a5fd837c25a432adcf078cb48f46deedda403d68945552bf
-  data.tar.gz: 114b94fffa16b686ef1fd6c2dee9f652cb40cf4d9dd60a9579d326ec1654bf17b68aaecae7c7192b13b8b64f5518d2a1151eebe5fe73e09433be2e6453316111
+  metadata.gz: 01102c2586155236c32827b65e9ec201ed96b32e90beb10ceb594a08a6a3318e2ff4cdce647f07cb3cecf61d36f5a8ab18b6762e5fd7e5df3030b9cfcc4dc85d
+  data.tar.gz: a27239bef742f5a5f4d42b63c0558f478428fe2e6992e671945cb5f181584db336c057e82970bd2a9d4961ad4dfb2304871ba5fbb61e3ced8a0bbb6f6e2695e4

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - 'octodown.gemspec'
+    - 'Rakefile'
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-literals'
+  Enabled: false

data/.travis.yml

@@ -4,8 +4,11 @@ before_install:
     - gem update --system
     - sudo apt-get install -y libicu-dev build-essential
 install: 'bundle install'
-script: 'bundle exec rspec --format documentation'
+script:
+  - 'bundle exec rspec --format documentation'
+  - 'bundle exec rubocop'
 rvm:
+  - '2.2.0'
   - '2.1.4'
   - '2.0.0'
   - '1.9.3'

data/README.md

@@ -21,8 +21,8 @@ you. Dead simple. Never get caught writing ugly markdown again.
 
 ## Installation
 
-  1. Install `icu4u` and `cmake`:
-    * Mac: `$ brew install icu4u cmake`
+  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`
@@ -32,11 +32,11 @@ you. Dead simple. Never get caught writing ugly markdown again.
 ## 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
 

data/bin/octodown

@@ -10,7 +10,12 @@ options = {}
 OptionParser.new do |opts|
   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
 

data/lib/octodown/renderer/github_markdown.rb

@@ -18,7 +18,7 @@ module Octodown
       private
 
       def context
-        { :asset_root => 'https://assets-cdn.github.com/images/icons/'}
+        { :asset_root => 'https://assets-cdn.github.com/images/icons/' }
       end
 
       def pipeline

data/lib/octodown/renderer/html.rb

@@ -21,8 +21,12 @@ module Octodown
       end
 
       def stylesheet
-        stylesheet_file = File.join Octodown.root, 'assets',
+        stylesheet_file = File.join(
+          Octodown.root,
+          'assets',
           "#{template}.css"
+        )
+
         File.read stylesheet_file
       end
 

data/lib/octodown/support/browser.rb

@@ -15,7 +15,7 @@ module Octodown
       attr_reader :cmd
 
       def determine_browser_open_cmd
-        open_in_browser_candidates.detect { |cmd| File.exists? cmd }
+        open_in_browser_candidates.detect { |cmd| File.exist? cmd }
       end
 
       def open_in_browser_candidates

data/lib/octodown/support/html_file.rb

@@ -10,9 +10,9 @@ module Octodown
       end
 
       def persistent_write(content)
-        self.write content
-        self.close
-        self.persist
+        write content
+        close
+        persist
       end
     end
   end

data/lib/octodown/version.rb

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

data/octodown.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.summary       = 'Github markdown straight from your shell.'
   spec.homepage      = 'https://github.com/ianks/octodown'
   spec.license       = 'MIT'
 
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pygments.rb',         '~> 0.6.0'
 
   spec.add_development_dependency 'rspec',   '~> 3.1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.28.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake',    '~> 10.0'
 end

data/spec/markdown_generation_spec.rb

@@ -2,11 +2,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 }
+  let(:html) do
+    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html
+  end
 
   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>'
+    expect(html).to include(
+      '<p>You are now reading markdown. How lucky you are!</p>'
+    )
   end
 
   it 'highlights the code' do

data/spec/template_rendering_spec.rb

@@ -2,15 +2,20 @@ 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 }
+  let(:html) do
+    Octodown::Renderer::GithubMarkdown.new(File.read(dummy_path)).to_html
+  end
+
   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'
+    expect(subject).to include(
+      '<p>You are now reading markdown. How lucky you are!</p>'
+    )
   end
 
   it 'sets the title' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 0.1.0beta1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -30,7 +30,7 @@ cert_chain:
   YGBeYMyEy7Q4wf7k4k5yyDUZyyaeg0DF/kNEN5llspJ9DHMP2cQqOiH+IQSNiUhR
   32sJqaZRHeJLDhZPLi5yXItTsQnPy6uob2oyypwFYTM=
   -----END CERTIFICATE-----
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
@@ -144,6 +144,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -220,15 +235,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Simple and precise markdown previewing from your terminal.
+summary: Github markdown straight from your shell.
 test_files:
 - spec/browser_spec.rb
 - spec/dummy/test.md