docushin 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.redcar
+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 docushin.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Todor Grudev
+
+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,30 @@
+# Docushin
+
+Docushin creates documentation based on your rails application routes. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docushin'
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Mount engine in your application `config/routes.rb`
+
+    mount Docushin::Engine, :at => "docushin"
+
+You can specify, the name of the route you want Docushin to be mountet at, just change "docushin"
+to your desired destination. It creates a resource on `http://yousitename/docushin/routes`.
+
+## 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/app/controllers/docushin/routes_controller.rb

@@ -0,0 +1,36 @@
+class Docushin::RoutesController < ActionController::Base
+  layout 'docushin'
+  before_filter :load_route_set
+
+  def index
+  end
+
+  def show
+    @route = @routes_collection.find_by_filename_hash(params[:id])
+  end
+
+  def edit
+    @route = @routes_collection.find_by_filename_hash(params[:id])
+  end
+
+  def update
+    @route = @routes_collection.find_by_filename_hash(params[:id])
+    #create the directory if it doesnt exists
+    FileUtils.mkdir_p(@path) unless File.exists?(@path)
+
+    File.open(File.join(@path, @route.file_name) + ".md", "w+") do |file|
+      file.write "---\n"
+      file.write "description: " + params[:route][:description] + "\n"
+      file.write "---\n"
+      file.write params[:route][:content]
+      file.close
+    end
+    redirect_to routes_path
+  end
+
+  private
+  def load_route_set
+    @routes_collection = Docushin::RouteSet.new 
+    @path = File.join(Rails.root, 'doc', 'docushin')
+  end
+end

data/app/helpers/docushin/application_helper.rb

@@ -0,0 +1,10 @@
+module Docushin
+  module ApplicationHelper
+    def generate_name(verb, path)
+      return Digest::MD5.hexdigest(verb + path)
+    end
+    def file_exists?(verb, path)
+      File.exists?(File.join(Rails.root, 'doc', 'docushin', generate_name(verb, path)) + '.md')
+    end
+  end
+end

data/app/views/docushin/routes/_form.html.erb

@@ -0,0 +1,24 @@
+<h3 id="title"><%= @route.verb + " " + @route.path %></h3>
+<%= form_for(@route) do |f| %>
+  <table>
+    <tr>
+      <td>
+        <%= f.label :description %>
+      </td>
+      <td>
+        <%= f.text_field :description %>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <%= f.label :content %> 
+      </td>
+      <td>
+        <%= f.text_area(:content, :cols => 50, :rows => 20) %>
+      </td>
+    </tr>
+  </table>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/docushin/routes/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/docushin/routes/index.html.erb

@@ -0,0 +1,28 @@
+<% @routes_collection.routes.group_by{ |r| r.controller }.each do |controller, routes| %>
+<h2><%= controller.titleize %></h2>
+<table>
+  <thead>
+    <tr>
+      <th>Resource</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>       
+    <% routes.each do |route|%>     
+       <tr>
+          <td class="resource">
+            <%= link_to route.verb + " " + route.path, route_path(:id => generate_name(route.verb, route.path)) %>
+          </td>
+          <td>
+            <% if file_exists?(route.verb, route.path) %>
+              <%= route.description %>
+              <%= link_to 'Update', edit_route_path(generate_name(route.verb, route.path))%>
+            <% else %>
+              <%= link_to 'Create a description', edit_route_path(generate_name(route.verb, route.path))%>
+            <% end %>
+          </td>
+       </tr>
+    <% end %>
+  </tbody>
+</table>
+<% end %>

data/app/views/docushin/routes/show.html.erb

@@ -0,0 +1,7 @@
+<h1 id="title"><%= @route.verb + " " + @route.path %></h1>
+<h3>Route url</h3>
+<%= File.join(request.protocol, request.host, @route.path) %>
+<h3>Description</h3>
+<%= @route.description %>
+<h3>Content</h3>
+<%= @route.content %>

data/app/views/layouts/docushin.html.erb

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>Routes</title>
+  <style>
+    body { background-color: #fff; color: #333; margin: 0px; }
+
+    body, p, ol, ul, td {
+      font-family: helvetica, verdana, arial, sans-serif;
+      font-size:   13px;
+      line-height: 18px;
+    }
+    #container {
+      width: 960px;
+      margin: 0 auto;
+      padding-top: 50px;
+    }
+    #header-outer {
+      position: fixed;
+      width: 100%;
+      top: 0;
+      height: 40px;
+      z-index: 999;
+      -moz-box-shadow: 0 1px 3px rgba(0,0,0,0.25),0 -1px 0 rgba(0,0,0,0.1) inset;
+      -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25),0 -1px 0 rgba(0, 0, 0, 0.1) inset;
+      box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25),0 -1px 0 rgba(0, 0, 0, 0.1) inset;
+      background: #00A0D1 repeat-x 0 0;
+    }
+    #header {
+      width: 960px;
+      margin: 0 auto;
+    }
+    #logo {
+      float: left;
+      padding-left: 32px;
+      display: block;
+      height: 40px;
+      color: white;
+      font-size: 150%;
+      font-weight: 200;
+      line-height: 38px;
+    }
+    h1 {
+      font-size: 3em;
+      font-weight: 300;
+      line-height: 1.1;
+      margin-bottom: 0.75em;
+    }
+    table {
+      margin: 0 0 3em 0;
+      width: 100%;
+    }
+    tr:hover td, tr:hover td.active {
+      background: #F8F8F8;
+    }
+    td {
+      padding: 8px 0 8px 0;
+      vertical-align: top;
+      background: white;
+    }
+    th {
+      text-align: left;
+      border-bottom: 1px solid #EEE;
+    }
+    td.resource {
+      width: 320px;
+    }
+    pre {
+      background-color: #eee;
+      padding: 10px;
+      font-size: 11px;
+      white-space: pre-wrap;
+    }
+
+    a {
+      text-decoration: none; 
+      color: #0080A6; }
+    a:visited { color: #0080A6; }
+    a:hover {
+      text-decoration: underline;
+      color: #0080A6;
+    }
+    a.logo{
+      color: white;
+      text-decoration: none;
+    }
+  </style>
+</head>
+<body>
+  <div id="header-outer">
+    <div id="header">
+      <div id="logo"><%= link_to "Docushin", routes_path, :class => "logo" %></div>
+    </div>    
+  </div>
+  <div id="container">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Docushin::Engine.routes.draw do
+  resources :routes, :except => :destroy
+end

data/docushin.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/docushin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Todor Grudev", "Alex Ganov"]
+  gem.email         = ["tagrudev@gmail.com", "aganov@gmail.com"]
+  gem.description   = %q{Builds documentation based on your Ruby on Rails application routes.}
+  gem.summary       = %q{Useful for generating docs on your routes.}
+  gem.homepage    = "http://github.com/appsbakery/docushin"
+
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "docushin"
+  gem.require_paths = ["lib", "app", "config"]
+  gem.version       = Docushin::VERSION
+
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.0"
+end

data/lib/docushin.rb

@@ -0,0 +1,7 @@
+require "docushin/route"
+require "docushin/engine"
+require "docushin/version"
+require "docushin/route_set"
+
+module Docushin
+end

data/lib/docushin/engine.rb

@@ -0,0 +1,5 @@
+module Docushin
+  class Engine < ::Rails::Engine
+    isolate_namespace Docushin
+  end
+end

data/lib/docushin/route.rb

@@ -0,0 +1,52 @@
+require 'digest/md5'
+
+module Docushin
+  class Route
+
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    attr_accessor :name
+    attr_accessor :verb
+    attr_accessor :path
+    attr_accessor :controller
+    attr_accessor :requirements
+    attr_accessor :base
+    attr_accessor :data
+    attr_accessor :file_name
+    attr_accessor :content
+    attr_accessor :description
+    
+    def initialize(route)
+      @controller = route.defaults[:controller]
+      @base = File.join(Rails.root, 'doc', 'docushin')
+      @name = route.name
+      @verb = route.verb.source.empty? ? "MATCH" : route.verb.source.gsub(/[$^]/, '')
+      @path = route.path.spec.to_s.sub('(.:format)', '')
+      @requirements = route.requirements
+      @file_name = Digest::MD5.hexdigest(@verb.to_s + @path)
+      rtfm(@base, @file_name) if File.exists?(File.join(@base, @file_name)  + '.md')
+    end
+
+    def persisted?
+      true
+    end
+
+    alias :id :file_name
+
+    def rtfm(base, name)
+      @content = File.read(File.join(base, name) + '.md')
+
+      begin
+        if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+          @content = $'
+          @data = YAML.load($1)
+          @description = @data['description']
+        end
+      rescue => e
+        # puts "Exception reading #{name}: #{e.message}"
+      end
+      @data ||= {}
+    end
+  end
+end

data/lib/docushin/route_set.rb

@@ -0,0 +1,36 @@
+module Docushin
+  class RouteSet
+    attr_accessor :routes
+    
+    def initialize
+      @routes = []
+      Rails.application.routes.routes.each do |route|
+        next if route.app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
+        next if route.app.is_a?(Sprockets::Environment)
+        next if route.app == Docushin::Engine
+
+        if (rack_app = discover_rack_app(route.app)) && rack_app.respond_to?(:routes)
+          rack_app.routes.routes.each do |rack_route|
+            @routes << Route.new(rack_route)
+          end
+        end
+        @routes << Route.new(route)
+      end
+    end
+
+    def discover_rack_app(app)
+      class_name = app.class.name.to_s
+      if class_name == "ActionDispatch::Routing::Mapper::Constraints"
+        discover_rack_app(app.app)
+      elsif class_name !~ /^ActionDispatch::Routing/
+        app
+      end
+    end
+
+    def find_by_filename_hash(hash)
+      @routes.each do |route|
+        return route if route.file_name == "#{hash}"
+      end
+    end
+  end
+end

data/lib/docushin/version.rb

@@ -0,0 +1,3 @@
+module Docushin
+  VERSION = "0.0.1"
+end

data/spec/docushin/route_set_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Docushin::RouteSet do
+  describe 'Build route set from routes' do
+    let(:routes_collection) { Docushin::RouteSet.new }
+    it 'should have attr_accessor routes that is an array' do 
+      routes_collection.routes.class.should == Array
+    end
+  end
+end

data/spec/docushin/route_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Docushin::Route do
+  let(:route_set) { Docushin::RouteSet.new }
+  let(:route) { route_set.routes.first }
+
+  describe 'create a new Route' do
+    it 'should have name, verb, path, requirements, data, content as attr' do 
+      route.should respond_to(:name)
+      route.should respond_to(:verb)
+      route.should respond_to(:path)
+      route.should respond_to(:requirements)
+      route.should respond_to(:base)
+      route.should respond_to(:data)
+      route.should respond_to(:file_name)
+      route.should respond_to(:content)
+      route.should respond_to(:description)
+    end
+  end
+
+  describe 'inspect the new Route' do 
+    it 'should have attr defined' do 
+      route.base.should == File.join(Rails.root, 'doc', 'docushin')
+      route.file_name.should == Digest::MD5.hexdigest(route.verb.to_s + route.path) 
+      route.name.should == "foo_index"
+      route.path.should == "/foo"
+      route.requirements.should == {:action=>"index", :controller=>"foo"}
+      route.verb.should == "GET"
+    end    
+  end
+
+  describe 'read markdown file' do
+    it 'should generate data and content' do 
+      route.data.should == {"description"=>"I am so awesome"}
+      route.description.should == "I am so awesome"
+      route.content.should == "{\"id\":\"4f3a296ac8de6732fe000003\",\"first_name\":\"Todor\",\"last_name\":\"Grudev\",\"username\":null,\"bio\":null,\"gender\":\"male\",\"email\":\"tagrudev@gmail.com\"}"
+    end
+  end
+end

data/spec/docushin_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Docushin do
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "active_resource/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require
+require "docushin"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    config.autoload_paths += %W(#{Docushin::Engine.root})
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    # config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    # config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  # config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'c3e92401d481baad490a74a84260ec9dbb402bf7a19c9b82fda1dbe45d28f1fcf42b42afafcc768b7c08366c14923567901976b1011e51cbdfde863a4bf66f7a'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters :format => [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  resources :foo
+  resources :bar
+end
+

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../spec/dummy/config/environment", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'docushin'
+require 'pry'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    # Do nothing
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: docushin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Todor Grudev
+- Alex Ganov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Builds documentation based on your Ruby on Rails application routes.
+email:
+- tagrudev@gmail.com
+- aganov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/docushin/routes_controller.rb
+- app/helpers/docushin/application_helper.rb
+- app/views/docushin/routes/_form.html.erb
+- app/views/docushin/routes/edit.html.erb
+- app/views/docushin/routes/index.html.erb
+- app/views/docushin/routes/show.html.erb
+- app/views/layouts/docushin.html.erb
+- config/routes.rb
+- docushin.gemspec
+- lib/docushin.rb
+- lib/docushin/engine.rb
+- lib/docushin/route.rb
+- lib/docushin/route_set.rb
+- lib/docushin/version.rb
+- spec/docushin/route_set_spec.rb
+- spec/docushin/route_spec.rb
+- spec/docushin_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/script/rails
+- spec/spec_helper.rb
+homepage: http://github.com/appsbakery/docushin
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- app
+- config
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 363757421
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 363757421
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Useful for generating docs on your routes.
+test_files:
+- spec/docushin/route_set_spec.rb
+- spec/docushin/route_spec.rb
+- spec/docushin_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/script/rails
+- spec/spec_helper.rb