sinatra-documentation 0.0.1 → 0.0.2

data/README.md

@@ -1,12 +1,17 @@
-# Self
+# sinatra-documentation
 
-TODO: Write a gem description
+An extension for a Sinatra application that allows your routes to automatically return
+help documentation by specifying a route with a '.readme' extension
+(ie. '/users/show.readme') and rendering the matched '.md' file.
+
+**NOTE** This is still under development. It works, but will make API changes as it gets
+more flushed out.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'self'
+    gem 'sinatra-documentation'
 
 And then execute:
 
@@ -14,7 +19,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install self
+    $ gem install sinatra-documentation
 
 ## Usage
 

data/examples/simple_api/app.rb

@@ -1,11 +1,10 @@
 require 'sinatra'
 require 'sinatra/documentation'
 
+get '/foo/bar' do
+  "Hello World"
+end
 
-  get '/foo/bar' do
-    "Hello World"
-  end
-
-  get '/' do
-    'some shit'
-  end
+get '/' do
+  'some shit'
+end

data/lib/sinatra/documentation.rb

@@ -8,6 +8,7 @@ module Sinatra
 
     mime_type :readme, 'text/html'
     set :default_content, :html
+    set :html_triggers_documentation, true
 
     before do
       # Let through sinatra image urls in development
@@ -47,7 +48,9 @@ module Sinatra
     end
 
     get '/*' do
-      pass unless format == :readme
+      pass if format != :readme and (request.preferred_type == 'text/html' and !settings.html_triggers_documentation)
+      pass if self.class.development? && request.path_info =~ %r{/__sinatra__/.*?.png}
+      cache_control :public, :max_age => 300
       render(:markdown, :"#{request.path}")
     end
   end

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Documentation
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/sinatra-documentation.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'shotgun'
+  gem.add_development_dependency 'thin'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70283592138200 !ruby/object:Gem::Requirement
+  requirement: &70100872520840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70283592138200
+  version_requirements: *70100872520840
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70283592137420 !ruby/object:Gem::Requirement
+  requirement: &70100872519480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70283592137420
+  version_requirements: *70100872519480
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
-  requirement: &70283592144640 !ruby/object:Gem::Requirement
+  requirement: &70100872517720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70283592144640
+  version_requirements: *70100872517720
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70283592141860 !ruby/object:Gem::Requirement
+  requirement: &70100872516920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70283592141860
+  version_requirements: *70100872516920
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70283592154540 !ruby/object:Gem::Requirement
+  requirement: &70100872516340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70283592154540
+  version_requirements: *70100872516340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70283592151600 !ruby/object:Gem::Requirement
+  requirement: &70100872515440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70283592151600
+  version_requirements: *70100872515440
 - !ruby/object:Gem::Dependency
   name: shotgun
-  requirement: &70283592150720 !ruby/object:Gem::Requirement
+  requirement: &70100872530360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70283592150720
+  version_requirements: *70100872530360
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70100872529280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70100872529280
 description: Tools for creating a simple web API
 email:
 - justin.smestad@gmail.com
@@ -124,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -511765631575549300
+      hash: -1745227160013132977
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -511765631575549300
+      hash: -1745227160013132977
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17