sinatra-documentation 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in self.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Smestad
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Self
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'self'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install self
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/simple_api/app.rb

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

data/examples/simple_api/views/foo/:id.markdown

@@ -0,0 +1,2 @@
+# GET /views/foo/:id.docs
+

data/examples/simple_api/views/foo/bar.markdown

@@ -0,0 +1,2 @@
+# Docs API
+

data/examples/simple_api/views/index.markdown

@@ -0,0 +1 @@
+# Index Page

data/lib/sinatra/documentation.rb

@@ -0,0 +1,55 @@
+require 'redcarpet'
+require 'sinatra/extension'
+require 'tilt/markdown'
+
+module Sinatra
+  module Documentation
+    extend Sinatra::Extension
+
+    mime_type :readme, 'text/html'
+    set :default_content, :html
+
+    before do
+      # Let through sinatra image urls in development
+      next if self.class.development? && request.path_info =~ %r{/__sinatra__/.*?.png}
+      unless settings.static? && settings.public_folder? && (request.get? || request.head?) && static_file?(request.path_info)
+        if request.params.has_key? 'format'
+          format params['format']
+        else
+          # Sinatra relies on a side-effect from path_info= to
+          # determine its routes. A direct string change (e.g., sub!)
+          # would bypass that -- and fail to have the effect we're looking
+          # for.
+          request.path_info = request.path_info.sub %r{\.([^\./]+)$}, ''
+          format $1 || (request.xhr? && settings.assume_xhr_is_js? ? :js : settings.default_content)
+        end
+      end
+    end
+
+    helpers do
+      def format(val=nil)
+        unless val.nil?
+          mime_type = ::Sinatra::Base.mime_type(val)
+          fail "Unknown media type #{val}\nTry registering the extension with a mime type" if mime_type.nil?
+          @_format = val.to_sym
+          response['Content-Type'] ? response['Content-Type'].sub!(/^[^;]+/, mime_type) : content_type(@_format)
+        end
+        @_format
+      end
+
+      # Patch the content_type function to remember the set type
+      # This helps cut down on time in the format helper so it
+      # doesn't have to do a reverse lookup on the header
+      def content_type(*args)
+        @_format = args.first.to_sym
+        super
+      end
+    end
+
+    get '/*' do
+      pass unless format == :readme
+      render(:markdown, :"#{request.path}")
+    end
+  end
+end
+

data/lib/sinatra/version.rb

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

data/sinatra-documentation.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Smestad"]
+  gem.email         = ["justin.smestad@gmail.com"]
+  gem.description   = %q{Tools for creating a simple web API}
+  gem.summary       = %q{Tools for creating a simple web API}
+  gem.homepage      = "https://github.com/jsmestad/sinatra-documentation"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sinatra-documentation"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Documentation::VERSION
+
+  gem.add_dependency 'redcarpet'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'sinatra-contrib'
+  gem.add_dependency 'tilt'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'shotgun'
+end

data/spec/documentation_spec.rb

@@ -0,0 +1,14 @@
+require_relative 'spec_helper'
+
+describe Sinatra::Documentation do
+  def respond_app(&block)
+    types = @provides
+    mock_app do
+      set :app_file, __FILE__
+      set :views, root + '/documentation'
+      register Sinatra::Documentation
+      respond_to(*types) if types
+      class_eval(&block)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'sinatra/contrib'
+require 'sinatra/documentation'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include Sinatra::TestHelpers
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-documentation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70283592138200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283592138200
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70283592137420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283592137420
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: &70283592144640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283592144640
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &70283592141860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283592141860
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70283592154540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283592154540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70283592151600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283592151600
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: &70283592150720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283592150720
+description: Tools for creating a simple web API
+email:
+- justin.smestad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/simple_api/app.rb
+- examples/simple_api/views/foo/:id.markdown
+- examples/simple_api/views/foo/bar.markdown
+- examples/simple_api/views/index.markdown
+- lib/sinatra/documentation.rb
+- lib/sinatra/version.rb
+- sinatra-documentation.gemspec
+- spec/documentation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jsmestad/sinatra-documentation
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -511765631575549300
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -511765631575549300
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Tools for creating a simple web API
+test_files:
+- spec/documentation_spec.rb
+- spec/spec_helper.rb