yield 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e110a49fbc1543025a325b8f2f6d1de9c32ffd03
-  data.tar.gz: 878002a6f69b610556af6ddda461c37479653259
+  metadata.gz: ea16de90187bdc71533059a24947b51da99ed5f2
+  data.tar.gz: 19c46b8d1505910dd6da4fd3fec830da754ebbb6
 SHA512:
-  metadata.gz: c9406ff6ede1349d5d987b533a805079fd431f4a8bdcde3d46b204a9342c9e77c58f9488d6c79d5e98673ffa3dd8b1a42cedafab58ed0b091bf2c719a664e9f9
-  data.tar.gz: 84da1a0cde5f1245c394c626ec59c9e7ab65c3cc127579f5277df6700ea867d0f5e65220c19b4e1d6c8bbf1d111762bd0293a3376ba7cde364ef6aa6ceca0200
+  metadata.gz: b4fb3356e9d9b3a0a19da44650b58de061fe308406feb161d37fa4accc3ff94272bb4a5abb8ad04ca2afd256c97b2ce61816fcf2704919d0c042fe30687b5f5e
+  data.tar.gz: 22a9dc0dabb3ceab5faff97f0a23e15f5f2240d375ecef0d9936861966cb3a695fa0a5b9088b60b2602fc9632d9b9ee82c3e61acf6d62eeda4eade69b086cacb

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in yield.gemspec
 gemspec
+
+gem "sinatra", "1.4.3"
+gem "octokit", "1.25.0"
+gem "thin", "1.5.1"
+gem "launchy", "2.3.0"

data/README.md

@@ -1,13 +1,12 @@
 # Yield
 
-Yield is a command line utility that generates a preview of README.md and markdown files using GitHub Flavored Markdown
-in your browser.
+Yield is a command line utility that generates a preview of README.md and markdown files using GitHub Flavored Markdown in your browser. It parses your markdown files using [GitHub's Markdown API](http://developer.github.com/v3/markdown/), so you can preview it exactly how it will look on GitHub.
 
 ## Installation
 
 ### Dependencies
 
-* Ruby
+* [Ruby v2.0.0](http://www.ruby-lang.org/en/)
 * [sinatra](http://sinatrarb.com)
 * [thin](http://code.macournoyer.com/thin/)
 * [octokit](http://octokit.github.io)
@@ -24,7 +23,7 @@ From the root of your project, or any folder containing a README.md file, run th
 
 ```bash
 $ yield
--> yield is now serving your markdown at localhost:4567 using Thin...
+=* Yield is serving your markdown at http://localhost:4000/
 ```
 
 You may also specify a path to a markdown file you'd like to render, such as:
@@ -33,7 +32,15 @@ You may also specify a path to a markdown file you'd like to render, such as:
 $ yield UPDATES.md
 ```
 
-Then navigate to [localhost:4567](http://localhost:4567) in your browser to view the preview of the file.
+Then navigate to [localhost:4000](http://localhost:4000) in your browser to view the preview of the file.
+
+You can stop the server by pressing Control+C.
+
+### Errors
+
+#### API Rate Limit Exceeded
+
+GitHub's API only allows only 60 unauthenticated requests per hour from a single IP address. If you are hitting this limit, then you must really like yield!
 
 ## Contributing
 

data/bin/yield

@@ -2,11 +2,13 @@
 
 require_relative '../lib/yield'
 
+`stty -echoctl`
+
 if ARGV.length == 1
   filename = ARGV[0]
-  Yield::Markdown.render(filename)
+  Yield::Markdown.init(filename)
 else
-  Yield::Markdown.render
+  Yield::Markdown.init
 end
 
 Yield::Markdown.run!

data/lib/yield.rb

@@ -1,6 +1,8 @@
 require "sinatra"
 require "octokit"
 require "thin"
+require "launchy"
+
 require_relative "yield/version"
 
 

data/lib/yield/markdown.rb

@@ -2,52 +2,57 @@ module Yield
   class Markdown < Sinatra::Base
 
     set :server, %w[thin]
+    set :port, 4000
     @@content = nil
     @@filename = nil
 
+    def self.init(filename = 'README.md')
+      @@filename = filename.to_s
+      original_stdout = $stdout
+      $stdout = fake = StringIO.new
+      unless File.exist?(@@filename)
+        abort "Filename '#{@@filename}' doesn't exist."
+      end
+    end
+
     # Override run! method from Sinatra
     def self.run!(options = {})
       set options
       handler         = detect_rack_handler
       handler_name    = handler.name.gsub(/.*::/, '')
       server_settings = settings.respond_to?(:server_settings) ? settings.server_settings : {}
-
       handler.run self, server_settings.merge(:Port => port, :Host => bind) do |server|
         unless handler_name =~ /cgi/i
-          $stderr.puts "-> yield is now serving your markdown " +
-          "at localhost:#{port} using #{handler_name}..."
+          $stderr.puts "=* Yield is serving your markdown at http://localhost:#{port}/"
         end
         [:INT, :TERM].each { |sig| trap(sig) { quit!(server, handler_name) } }
         server.threaded = settings.threaded if server.respond_to? :threaded=
         set :running, true
+        open_in_browser
         yield server if block_given?
       end
     rescue Errno::EADDRINUSE
-      $stderr.puts "-> Port #{port} is already being used!"
+      $stderr.puts "=* Port #{port} is already being used!"
     end
 
     # Override quit! method from Sinatra
     def self.quit!(server, handler_name)
       # Use Thin's hard #stop! if available, otherwise just #stop.
       server.respond_to?(:stop!) ? server.stop! : server.stop
-      $stderr.puts "\n-> Stopping yield..." unless handler_name =~/cgi/i
+      $stderr.puts "=* Stopping yield..." unless handler_name =~/cgi/i
     end
 
-    def self.render(filename = 'README.md')
-      original_stdout = $stdout
-      $stdout = fake = StringIO.new
+    get '/' do
+      @@content = Octokit.markdown(File.read(@@filename), mode: 'gfm')
+      erb :index, locals: { content: @@content, filename: @@filename }
+    end
 
-      @@filename = filename
-      begin
-        @@content = Octokit.markdown(File.read(@@filename), mode: 'gfm')
-      rescue Exception => e
-        puts "Filename '#{@@filename}' doesn't exist."
-        exit
-      end
+    not_found do
+      erb :'404', locals: { filename: params[:filename] }
     end
 
-    get '/' do
-      erb :index, locals: { content: @@content, filename: @@filename }
+    def self.open_in_browser
+      Launchy.open("http://localhost:#{port}/")
     end
     
   end

data/lib/yield/version.rb

@@ -1,3 +1,3 @@
 module Yield
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/yield/views/404.erb

@@ -0,0 +1,18 @@
+<html>
+  <head>
+    <link rel="stylesheet" href="https://github.global.ssl.fastly.net/assets/github-c6ca95663cba6496fe7a5bdd98671b82cd956df3.css" />
+    <link rel="stylesheet" href="https://github.global.ssl.fastly.net/assets/github2-71386ba60dc4794e755db985b31f4dfc74dcd99d.css" />
+    <style>.page {margin:30px auto;width:784px;}</style>
+  </head>
+  <body>
+    <div class="page">
+      <div id="readme" class="clearfix announce instapaper_body md">
+        <span class="name"><span class="octicon octicon-book"></span> OOPS.md</span>
+        <article class="markdown-body entry-content">
+          <h2>Yield could not find your file</h2>
+          <p>Try going <a href="/">here</a>!</p>
+        </article>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/yield/views/index.erb

@@ -2,7 +2,7 @@
   <head>
     <link rel="stylesheet" href="https://github.global.ssl.fastly.net/assets/github-c6ca95663cba6496fe7a5bdd98671b82cd956df3.css" />
     <link rel="stylesheet" href="https://github.global.ssl.fastly.net/assets/github2-71386ba60dc4794e755db985b31f4dfc74dcd99d.css" />
-    <style>.page {margin:30px auto;width:920px;}</style>
+    <style>.page {margin:30px auto;width:784px;}</style>
   </head>
   <body>
     <div class="page">

data/yield.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{A utility for previewing markdown files in GitHub Flavored Markdown.}
   spec.summary       = %q{Yield is a command line utility written in Ruby that allows a user to render
     markdown files for previewing in a browser. It renders the markdown files using GitHub flavored 
-    markdown at http://localhost:4567 using Sinatra.}
+    markdown at http://localhost:4000/ using Sinatra and Thin.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 
-  spec.add_dependency "sinatra"
-  spec.add_dependency "octokit"
-  spec.add_dependency "thin"
+  spec.add_dependency "sinatra", "1.4.3"
+  spec.add_dependency "octokit", "1.25.0"
+  spec.add_dependency "thin", "1.5.1"
+  spec.add_dependency "launchy", "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yield
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Casey Scarborough
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,44 +42,58 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 description: A utility for previewing markdown files in GitHub Flavored Markdown.
 email:
 - caseyscarborough@gmail.com
@@ -97,6 +111,7 @@ files:
 - lib/yield.rb
 - lib/yield/markdown.rb
 - lib/yield/version.rb
+- lib/yield/views/404.erb
 - lib/yield/views/index.erb
 - yield.gemspec
 homepage: ''
@@ -119,10 +134,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Yield is a command line utility written in Ruby that allows a user to render
   markdown files for previewing in a browser. It renders the markdown files using
-  GitHub flavored  markdown at http://localhost:4567 using Sinatra.
+  GitHub flavored  markdown at http://localhost:4000/ using Sinatra and Thin.
 test_files: []