ghost_writer 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 967ed54744c35d63d0a06e6665ae69ab314f6f34
+  data.tar.gz: 20c5650513d18bc21298317222409fd8986b7ad8
+SHA512:
+  metadata.gz: 642ed40681a6b8a79aac3988029b8a96e347a4ab2d98809ef3bdbddd7af285114852a069aca3f2a21ffb871d21da1d2c4fd43bce2ccbdd4d91e3f10e33a47a30
+  data.tar.gz: e59c1e45a4bf4ce60770970c9c26d52f7a8d9bf30b111ed7385b8f22442cb52d30843f585c23506f361db6e747adc58e6247e134a34df50158c8a24cb232f046

data/README.md

@@ -28,6 +28,7 @@ Write controller spec:
 RSpec.configure do |config|
   # The difference with previous version. already no need including Module and Defining after hook
   GhostWriter.output_dir = "api_docs" # Optional (default is "api_examples")
+  GhostWriter.output_format = :rst # Optional (default is :markdown)
   GhostWriter.github_base_url = "https://github.com/joker1007/ghost_writer/tree/master/output_examples" # Optional
 end
 
@@ -49,7 +50,7 @@ describe PostsController do
 end
 ```
 
-And set environment variable GENERATE_API_DOC at runtime
+And set environment variable GENERATE\_API\_DOC at runtime
 ```
 bundle exec ghost_writer spec/controllers
 -> generate docs at [Rails.root]/doc/api_examples

data/bin/ghost_writer

@@ -18,6 +18,7 @@ where [options] are:
 EOS
 
   opt :output, "Output directory", :type => String
+  opt :format, "Output doc format (default: markdown, availables: markdown, rst)", :type => String
   opt :clear, "[Caution] Clear Output directory before running specs", :default => false
 end
 
@@ -29,6 +30,7 @@ end
 RSpec.configure do |c|
   c.include GhostWriter
   GhostWriter.output_dir = opts[:output]
+  GhostWriter.output_format = opts[:format].to_sym if opts[:format]
   c.after(:suite) do
     GhostWriter.generate_api_doc
   end

data/ghost_writer.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rspec-rails", "~> 2.11"
   gem.add_dependency "trollop"
 
-  gem.add_development_dependency "rspec", "~> 2.12"
+  gem.add_development_dependency "rspec-rails", "~> 2.12"
   gem.add_development_dependency 'rake', ['>= 0']
-  gem.add_development_dependency 'rails', ['~> 3.2.9']
+  gem.add_development_dependency 'rails', ['>= 3.2.9', '< 5']
   gem.add_development_dependency 'tapp'
 end

data/lib/ghost_writer.rb

@@ -8,13 +8,15 @@ module GhostWriter
 
   module Format
     autoload "Markdown", "ghost_writer/format/markdown"
+    autoload "Rst", "ghost_writer/format/rst"
   end
 
-  DEFAULT_OUTPUT_DIR = "api_examples"
-  DOCUMENT_INDEX_FILENAME = "document_index.markdown"
+  DEFAULT_OUTPUT_DIR = "api_examples".freeze
+  DEFAULT_FORMAT = :markdown
+  DOCUMENT_INDEX_FILENAME = "document_index".freeze
 
   class << self
-    attr_writer :output_dir, :output_flag
+    attr_writer :output_dir, :output_flag, :output_format
     attr_accessor :github_base_url
 
     def document_group
@@ -27,7 +29,7 @@ module GhostWriter
         unless File.exist?(output_path)
           FileUtils.mkdir_p(output_path)
         end
-        document_index = GhostWriter::DocumentIndex.new(output_path + DOCUMENT_INDEX_FILENAME, document_group)
+        document_index = GhostWriter::DocumentIndex.new(output_path + "#{DOCUMENT_INDEX_FILENAME}.#{output_format}", document_group, GhostWriter.output_format)
         document_index.write_file
         document_group.each do |output, docs|
           docs.sort_by!(&:description)
@@ -50,10 +52,14 @@ module GhostWriter
     def output_path
       Rails.root + "doc" + output_dir
     end
+
+    def output_format
+      @output_format || DEFAULT_FORMAT
+    end
   end
 
   def collect_example
-    output = File.join(doc_dir, "#{doc_name}.markdown")
+    output = File.join(doc_dir, "#{doc_name}.#{GhostWriter.output_format}")
     document = GhostWriter::Document.new(output, {
       title: "#{described_class} #{doc_name.titleize}",
       description: example.full_description.dup,
@@ -62,7 +68,9 @@ module GhostWriter
       param_example: controller.params.reject {|key, val| key == "controller" || key == "action"},
       status_example: response.status.inspect,
       response_example: response.body,
+      format: GhostWriter.output_format
     })
+
     GhostWriter.document_group[output] ||= []
     GhostWriter.document_group[output] << document
   end
@@ -82,7 +90,7 @@ module GhostWriter
 
   included do
     after do
-      if example.metadata[:type] == :controller && example.metadata[:generate_api_doc]
+      if (example.metadata[:type] == :controller || example.metadata[:type] == :request) && example.metadata[:generate_api_doc]
         collect_example if GhostWriter.output_flag
       end
     end

data/lib/ghost_writer/document.rb

@@ -2,7 +2,9 @@ class GhostWriter::Document
   attr_reader :title, :description, :location, :url_example, :param_example, :status_example, :response_example, :output, :relative_path
 
   def initialize(output, attrs)
-    extend(GhostWriter::Format::Markdown)
+    format_module = "GhostWriter::Format::#{attrs[:format].to_s.classify}"
+    extend(format_module.constantize)
+
     @output           = output
     @relative_path    = Pathname.new(output).relative_path_from(GhostWriter.output_path)
     @title            = attrs[:title]
@@ -23,46 +25,44 @@ class GhostWriter::Document
     doc = File.open(output, mode)
 
     if overwrite
-      doc.write paragraph(<<EOP)
+      doc.write paragraph(document_header)
+    end
+
+    doc.write(document_body)
+
+    doc.close
+  end
+
+  def document_header
+    <<EOP
 #{headword(title, 1)}
 
---------------------------------
+#{separator(32)}
 
 EOP
-    end
+  end
 
-    doc.write paragraph(<<EOP)
+  def document_body
+    <<EOP
 #{headword(description, 2)}
-EOP
 
-    doc.write paragraph(<<EOP)
 #{headword("access path:", 3)}
 #{quote(url_example)}
-EOP
 
-    doc.write paragraph(<<EOP)
 #{headword("request params:", 3)}
 #{quote(param_example.inspect, :ruby)}
-EOP
 
-    doc.write paragraph(<<EOP)
 #{headword("status code:", 3)}
 #{quote(status_example)}
-EOP
 
-    doc.write paragraph(<<EOP)
 #{headword("response:", 3)}
 #{quote_response(response_example)}
-EOP
 
-    doc.write paragraph(<<EOP)
 Generated by "#{description}\" at #{location}
 
---------------------------------
+#{separator(32)}
 
 EOP
-
-    doc.close
   end
 
   private

data/lib/ghost_writer/document_index.rb

@@ -1,8 +1,10 @@
 class GhostWriter::DocumentIndex
   attr_reader :output, :documents
 
-  def initialize(output, documents)
-    extend(GhostWriter::Format::Markdown)
+  def initialize(output, documents, format)
+    format_module = "GhostWriter::Format::#{format.to_s.classify}"
+    extend(format_module.constantize)
+
     @output = output
     @documents = documents
   end

data/lib/ghost_writer/format/markdown.rb

@@ -2,7 +2,6 @@ module GhostWriter
   module Format
     module Markdown
       private
-      # TODO: outputのフォーマットを選択可能に
       def headword(text, level = 1)
         "#{'#'*level} #{text}"
       end
@@ -11,6 +10,10 @@ module GhostWriter
         text + "\n"
       end
 
+      def separator(length)
+        "-" * length
+      end
+
       def quote(text, quote_format = nil)
         "```#{quote_format}\n#{text}\n```"
       end

data/lib/ghost_writer/format/rst.rb

@@ -0,0 +1,45 @@
+module GhostWriter
+  module Format
+    module Rst
+      private
+      def headword(text, level = 1)
+        char = case level
+               when 1
+                 "*"
+               when 2
+                 "="
+               when 3
+                 "-"
+               when 4
+                 "^"
+               end
+        text + "\n" + char * text.length * 2
+      end
+
+      def paragraph(text)
+        text + "\n"
+      end
+
+      def separator(length)
+        ""
+      end
+
+      def quote(text, quote_format = nil)
+        if quote_format
+          marker = ".. code-block:: #{quote_format}" + "\n"
+        else
+          marker = "::" + "\n"
+        end
+        marker + "#{text.each_line.map{|line| line.chomp.empty? ? line : "   " + line}.join}"
+      end
+
+      def list(text, level = 1)
+        "#{"  " * (level - 1)}* #{text}"
+      end
+
+      def link(text, url)
+        "`#{text} #{url}`_"
+      end
+    end
+  end
+end

data/lib/ghost_writer/version.rb

@@ -1,3 +1,3 @@
 module GhostWriter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/ghost_writer_spec.rb

@@ -94,7 +94,7 @@ describe GhostWriter do
           GhostWriter.github_base_url = github_base_url
           group.run(NullObject.new)
           GhostWriter.generate_api_doc
-          File.read(Rails.root + "doc" + "api_examples" + GhostWriter::DOCUMENT_INDEX_FILENAME).should =~ /#{github_base_url}/
+          File.read(Rails.root + "doc" + "api_examples" + "#{GhostWriter::DOCUMENT_INDEX_FILENAME}.#{GhostWriter.output_format}").should =~ /#{github_base_url}/
         end
       end
     end

data/spec/rails_app/config/environments/development.rb

@@ -6,9 +6,6 @@ RailsApp::Application.configure do
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # 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
@@ -34,4 +31,6 @@ RailsApp::Application.configure do
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  config.eager_load = false
 end

data/spec/rails_app/config/environments/production.rb

@@ -64,4 +64,6 @@ RailsApp::Application.configure do
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  config.eager_load = true
 end

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

@@ -11,9 +11,6 @@ RailsApp::Application.configure do
   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
@@ -34,4 +31,6 @@ RailsApp::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  config.eager_load = false
 end

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

@@ -4,4 +4,4 @@
 # 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.
-RailsApp::Application.config.secret_token = '98e50fa60d0ddcf9c64b8b87e0dfd8c247885c4cbcaeecf37d24fc4b5fb2cd36c9744a5165653efc77d5ced8cb4a6c7157d3752721b0acc2e7b69b7f2b915b9a'
+RailsApp::Application.config.secret_key_base = '98e50fa60d0ddcf9c64b8b87e0dfd8c247885c4cbcaeecf37d24fc4b5fb2cd36c9744a5165653efc77d5ced8cb4a6c7157d3752721b0acc2e7b69b7f2b915b9a'

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: ghost_writer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,49 +69,49 @@ dependencies:
 - !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: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.9
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.9
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: tapp
   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'
 description: Generate API examples from params and response of controller specs
@@ -143,6 +134,7 @@ files:
 - lib/ghost_writer/document.rb
 - lib/ghost_writer/document_index.rb
 - lib/ghost_writer/format/markdown.rb
+- lib/ghost_writer/format/rst.rb
 - lib/ghost_writer/version.rb
 - output_examples/anonymous_controller/index.markdown
 - output_examples/anonymous_controller/show.markdown
@@ -189,33 +181,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/joker1007/ghost_writer
 licenses: []
+metadata: {}
 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: 885870710401004349
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 885870710401004349
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generate API examples from params and response of controller specs
 test_files:
 - spec/lib/ghost_writer_spec.rb
@@ -258,3 +243,4 @@ test_files:
 - spec/rails_app/test/test_helper.rb
 - spec/rails_app/test/unit/.gitkeep
 - spec/spec_helper.rb
+has_rdoc: