yield 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f793b0009f6fae3875c945302b563eae95c07b
-  data.tar.gz: 5a578c3af1ea313dc0473376513d5665fc473087
+  metadata.gz: 02a641621a62dc49014f39bce2a1e6caba8d3f03
+  data.tar.gz: 07d5e89234624f95f581e3a03b72e15a56e6a8b0
 SHA512:
-  metadata.gz: 95ec477cd689600e1280ca3b288061dafdab632a5dd8fa5d0d695a0b6f6a0cc360a00460796b6f4a090d093cf8cbc23a0d3ad36a322b6f65aafd3e1974306917
-  data.tar.gz: 5235056ce67a1aa88b38e8833f47d086c73c72f9795929e9467527d0fa8c225cf1675a951c2e9bac53346b0f912330ae17b57318ba341bb10c6246d79a3d57a3
+  metadata.gz: 2ff9bcfe989f1ed2f827b14a80f640d35a0e4457f5bf9f70d547c1359cc6785cf340d689b07d572fe5622ce2820fb8839304c1ca3dd2729345783011cb86e8b3
+  data.tar.gz: a171350d8f9ca629f6b4231ff2df32dcf300e3143eb06d428ef062234ad72b26aa81596e0eea91e4b11c03ef50f209dede6f11c8a0646ada41206718dbf57fa4

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.DS_Store
+.DS_Store
+/versions

data/README.md

@@ -32,16 +32,22 @@ $ yield
 You may also specify a path to a markdown file you'd like to render, such as:
 
 ```bash
+# Render a specific file
 $ yield UPDATES.md
 ```
 
 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.
 
-## Issues
+Yield also supports relative URLs in the same directory, so you can preview other files by navigating to them in the URL bar. For example, you can preview the CHANGELOG.md file by navigating to [localhost:4000/CHANGELOG.md](http://localhost:4000/CHANGELOG.md).
 
-### API Rate Limit Exceeded
+Finally, you can specify the port for the server to run on using the `-p` or `--port` option:
 
-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!
+```bash
+# Run the server on port 8080
+$ yield -p 8080
+```
+
+## Potential Errors
 
 ### OpenSSL Error
 

data/bin/yield

@@ -1,16 +1,31 @@
 #!/usr/bin/env ruby
 require 'rbconfig'
+require 'optparse'
 require_relative '../lib/yield'
 
+# Determine if OS is Windows, and disable echo of characters in hat notation (^C) if it is not.
 is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
-
 `stty -echoctl` unless is_windows
 
-if ARGV.length == 1
-  filename = ARGV[0]
-  Yield::Markdown.init(filename)
-else
-  Yield::Markdown.init
+port = 4000
+
+OptionParser.new do |o|
+  o.banner = "Usage: #{o.program_name} MARKDOWN_FILE.md"
+
+  o.on('-h', '--help', 'View the help menu') { puts o; Kernel.exit }
+  o.on('-p PORT', '--port PORT', 'Specify port to run Yield on') { |o| port = o }
+  o.on('-v', '--version', 'Display version number') do
+    puts 'yield version ' + Yield::VERSION
+    Kernel.exit
+  end
+
+  begin
+    o.parse!
+  rescue OptionParser::InvalidOption => o
+    puts o.message
+  end
 end
 
-Yield::Server.run!
+# Parse a specific file if given, otherwise parse README.md.
+ARGV.length == 1 ? Yield::Markdown.init(ARGV[0]) : Yield::Markdown.init
+Yield::Server.run!(port)

data/lib/yield/server.rb

@@ -2,17 +2,16 @@ module Yield
   class Server < Sinatra::Base
 
     set :server, 'webrick'
-    set :port, 4000
 
     # Override run! method from Sinatra
-    def self.run!()
+    def self.run!(port)
       settings = {}
       detect_rack_handler.run self, settings.merge(Port: port, Host: bind, Logger: WEBrick::Log.new('/dev/null'), AccessLog: []) do |server|
         $stderr.puts "=* Yield is serving your markdown at http://localhost:#{port}/"
         [:INT, :TERM].each { |sig| trap(sig) { quit!(server) } }
         server.threaded = settings.threaded if server.respond_to? :threaded=
         set :running, true
-        open_in_browser
+        open_in_browser(port)
         yield server if block_given?
       end
     rescue Errno::EADDRINUSE
@@ -31,9 +30,24 @@ module Yield
       erb :index, locals: { content: content, filename: filename }
     end
 
-    not_found { erb :'404' }
+    get '/:filename' do
+      filename = params[:filename]
+      begin
+        content = Markdown.convert_to_html(File.read(filename))
+        erb :index, locals: { content: content, filename: filename }
+      rescue Errno::EISDIR
+        raise Sinatra::NotFound
+      rescue Errno::ENOENT
+        raise Sinatra::NotFound
+      end
+    end 
+
+    not_found do 
+      filename = request.fullpath.split('/')[-1]
+      erb :'404', locals: { filename: filename }
+    end
 
-    def self.open_in_browser
+    def self.open_in_browser(port)
       Launchy.open("http://localhost:#{port}/")
     end
 

data/lib/yield/version.rb

@@ -1,3 +1,3 @@
 module Yield
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/yield/views/404.erb

@@ -7,10 +7,10 @@
   <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>
+        <span class="name"><span class="octicon octicon-book"></span> <%= filename %></span>
         <article class="markdown-body entry-content">
-          <h2>Yield could not find your file</h2>
-          <p>Try going <a href="/">here</a>!</p>
+          <h3>Oops, Yield could not find that file.</h3>
+          <p>Make sure the file exists, or try going <a href="/">here</a>.</p>
         </article>
       </div>
     </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yield
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Casey Scarborough
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Yield is a command line utility written in Ruby that allows a user to render