ghost_writer 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 joker1007
+
+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,52 @@
+# GhostWriter
+
+Generate API examples from params and response of controller specs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ghost_writer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ghost_writer
+
+## Usage
+
+Write controller spec:
+```ruby
+require 'spec_helper'
+
+describe PostsController do
+  describe "GET index" do
+    it "should be success", generate_api_doc: true do # Add metadata :generate_api_doc
+      get :index
+      response.should be_success
+    end
+  end
+end
+```
+
+And set environment variable GENERATE_API_DOC at runtime
+```
+GENERATE_API_DOC=1 bundle exec rspec spec
+-> generate docs at [Rails.root]/doc/api_examples
+```
+
+If you don't set environment variable, this gem doesn't generate docs.
+
+## TODO
+- support more output formats (now markdown only)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--color --format d"
+end

data/ghost_writer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghost_writer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ghost_writer"
+  gem.version       = GhostWriter::VERSION
+  gem.authors       = ["joker1007"]
+  gem.email         = ["kakyoin.hierophant@gmail.com"]
+  gem.description   = %q{Generate API examples from params and response of controller specs}
+  gem.summary       = %q{Generate API examples from params and response of controller specs}
+  gem.homepage      = "https://github.com/joker1007/ghost_writer"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport", ">= 3.0.0"
+  gem.add_dependency "rspec-rails", "~> 2.11"
+
+  gem.add_development_dependency "rspec", "~> 2.12"
+  gem.add_development_dependency 'rake', ['>= 0']
+  gem.add_development_dependency 'rails', ['~> 3.2.9']
+end

data/lib/ghost_writer/version.rb

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

data/lib/ghost_writer.rb

@@ -0,0 +1,81 @@
+require "ghost_writer/version"
+require "active_support/concern"
+
+module GhostWriter
+  extend ActiveSupport::Concern
+
+  mattr_accessor :output_dir
+
+  def generate_api_doc
+    @@output_path = @@output_dir ? Rails.root + "doc" + @@output_dir : Rails.root + "doc" + "api_examples"
+    unless File.exist?(doc_dir)
+      FileUtils.mkdir_p(doc_dir)
+    end
+
+    doc = File.open(File.join(doc_dir, "#{doc_name}.markdown"), "w")
+
+    doc.puts headword("#{described_class} #{doc_name.titleize}", 1)
+    doc.puts headword("access path:", 2)
+    doc.puts quote("#{request.env["REQUEST_METHOD"]} #{request.env["PATH_INFO"]}")
+    doc.puts ""
+    doc.puts headword("request params:", 2)
+    doc.puts quote(controller.params.reject {|key, val| key == "controller" || key == "action"}.inspect, :ruby)
+    doc.puts ""
+    doc.puts headword("status code:", 2)
+    doc.puts quote(response.status.inspect)
+    doc.puts ""
+    doc.puts headword("response:", 2)
+    if controller.params[:format] && controller.params[:format].to_sym == :json
+      puts_json_data(doc)
+    else
+      doc.puts quote(response.body)
+    end
+    doc.puts ""
+    doc.puts "Generated by \"#{example.full_description}\" at #{example.location}"
+    doc.puts ""
+    doc.close
+  end
+
+  private
+  def doc_dir
+    @@output_path + described_class.to_s.underscore
+  end
+
+  def doc_name
+    if example.metadata[:generate_api_doc].is_a?(String) || example.metadata[:generate_api_doc].is_a?(Symbol)
+      example.metadata[:generate_api_doc].to_s
+    else
+      controller.action_name
+    end
+  end
+
+  # TODO: outputのフォーマットを選択可能に
+  def headword(text, level = 1)
+    "#{'#'*level} #{text}\n"
+  end
+
+  def paragraph(text)
+    text + "\n\n"
+  end
+
+  def quote(text, quote_format = nil)
+    "```#{quote_format}\n#{text}\n```"
+  end
+
+  def puts_json_data(doc)
+    data = ActiveSupport::JSON.decode(response.body)
+    if data.is_a?(Array) || data.is_a?(Hash)
+      doc.puts quote(JSON.pretty_generate(data), :javascript)
+    else
+      doc.puts quote(data)
+    end
+  end
+
+  included do
+    after do
+      if example.metadata[:type] == :controller && example.metadata[:generate_api_doc]
+        generate_api_doc if ENV["GENERATE_API_DOC"]
+      end
+    end
+  end
+end

data/spec/lib/ghost_writer_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+class AnonymousController
+end
+
+describe GhostWriter do
+
+  let(:group) do
+    RSpec::Core::ExampleGroup.describe do
+      include RSpec::Rails::ControllerExampleGroup
+      include GhostWriter
+
+      def described_class
+        AnonymousController
+      end
+
+      controller do
+        def index
+          collection = [
+            {
+              id: 1,
+              name: "name",
+            },
+            {
+              id: 2,
+              name: "name",
+            },
+          ]
+          render json: collection.as_json
+        end
+      end
+
+      describe "GET index" do
+        it "should be success", generate_api_doc: true do
+          begin
+            get :index
+            response.should be_success
+          rescue Exception => e
+            p e
+          end
+        end
+      end
+    end
+  end
+
+  context "Not given output_dir" do
+    before do
+      clear_output("api_examples")
+    end
+
+    after do
+      clear_output("api_examples")
+    end
+
+    context 'ENV["GENERATE_API_DOC"] is true' do
+      before do
+        ENV["GENERATE_API_DOC"] = "1"
+      end
+
+      it "generate api doc file" do
+        group.run(NullObject.new)
+        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.markdown").should be_true
+      end
+    end
+
+    context 'ENV["GENERATE_API_DOC"] is true' do
+      before do
+        ENV["GENERATE_API_DOC"] = nil
+      end
+
+      it "does not generate api doc file" do
+        group.run(NullObject.new)
+        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.markdown").should be_false
+      end
+    end
+  end
+
+  context "Given output_dir" do
+    let(:output_dir) { "api_docs" }
+
+    before do
+      GhostWriter.output_dir = output_dir
+      clear_output(output_dir)
+    end
+
+    after do
+      GhostWriter.output_dir = nil
+      clear_output(output_dir)
+    end
+
+    it "generate api doc file" do
+      ENV["GENERATE_API_DOC"] = "1"
+      group.run(NullObject.new)
+      File.exist?(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.markdown").should be_true
+    end
+  end
+
+  def clear_output(dirname)
+    if File.exist?(Rails.root + "doc" + dirname)
+      FileUtils.rm_r(Rails.root + "doc" + dirname)
+    end
+  end
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/rails_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/rails_app/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__)
+
+RailsApp::Application.load_tasks

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

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

data/spec/rails_app/app/controllers/posts_controller.rb

@@ -0,0 +1,15 @@
+class PostsController < ApplicationController
+  def index
+    collection = [
+      {
+        id: 1,
+        name: "name",
+      },
+      {
+        id: 2,
+        name: "name",
+      },
+    ]
+    render json: collection.as_json
+  end
+end