ghost_writer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f37053480c8f01704e4ca986b51bf9897955288
-  data.tar.gz: 0504eedceda260fdea93af08135b620f633dd13f
+  metadata.gz: ad73ab6b70235e09d11abab7a269a1a73daa594e
+  data.tar.gz: a66d4559b340bae3ed5ffb1b876711aa2790fa6b
 SHA512:
-  metadata.gz: f15b7fa91ef7f8494a2d528e3a02af5c7f531e891bd31a7847c059e1ebb564ffe0365ebb275c26c66e6fb39b9ae1796c79b0f7a4f280368570aeb5308fe0ef1c
-  data.tar.gz: 0d9ae1d442af8a0ad96ae08c55348480513d1545cfe158b7c90571c99bab361705bb95ad7aa100f9c97f335e86e4e3a101ff16aaed8b157eeec5731aebaef878
+  metadata.gz: 883153e23aadffda4dc28be4aa9242d4c94d0c676683366eb953d26430879bb2b4834d1981f72e6f9abe551df2d0c5e4e95b7cf7569a4c22b8f388fc7c5b7e78
+  data.tar.gz: c69d18ddb176d9e9dad7c9b2e46866a4b22fb4deb09588f9d0f95f0c529bf41ec7f3f98a2177544f44a1b9259a84aadf0b38f018ca24a83b4f7315504d79e9db

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 script: "bundle exec rake spec build"
 rvm:
   - 1.9.3
+  - 2.0.0
 notifications:
   email:
     on_success: never

data/README.md

@@ -20,7 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-Write controller spec:
+Write controller spec or request spec, and...
+
+```sh
+bundle exec ghost_writer spec/controllers # execute specs and generate docs at [Rails.root]/doc/api_examples
+```
+
+### Command options
+
+- --output, -o Set output directory
+- --format, -f Set output document format (markdown or rst)
+- --clear , -c Clear output directory before running specs
+
+
+## Spec helper configuration
 
 **Caution: Using ghost_writer command and Defining after fook manually at the same time, after hook is executed twice, because of it document_index is cleared.**
 ```ruby
@@ -50,21 +63,20 @@ describe PostsController do
 end
 ```
 
-And set environment variable GENERATE\_API\_DOC at runtime
-```
-bundle exec ghost_writer spec/controllers
--> generate docs at [Rails.root]/doc/api_examples
-```
+If `GhostWriter.output_dir` is set, generate docs at `[Rails.root]/doc/[output_dir]`
+
+If `GhostWriter.github_base_url` is set, link index is based on the url, like output\_examples
 
-If you don't set environment variable, this gem doesn't generate docs.
+And set environment variable `GENERATE_API_DOC` or `GhostWriter.output_flag` true at runtime.
+If you don't set, this gem doesn't generate docs.
+
+`ghost_writer` command set `GhostWriter.output_flag` true automatically.
 
 ## Output Example
 Please look at [output_examples](https://github.com/joker1007/ghost_writer/tree/master/output_examples)
 
-## Config
-If output_dir is set, generate docs at `[Rails.root]/doc/[output_dir]`
-
-If github\_base\_url is set, link index is based on the url, like output\_examples
+## License
+MIT
 
 ## Contributing
 

data/lib/ghost_writer/document.rb

@@ -1,5 +1,5 @@
 class GhostWriter::Document
-  attr_reader :title, :description, :location, :url_example, :param_example, :status_example, :response_example, :output, :relative_path
+  attr_reader :title, :description, :location, :request_method, :path_info, :param_example, :status_example, :response_example, :output, :relative_path
 
   def initialize(output, attrs)
     format_module = "GhostWriter::Format::#{attrs[:format].to_s.classify}"
@@ -10,7 +10,8 @@ class GhostWriter::Document
     @title            = attrs[:title]
     @description      = attrs[:description]
     @location         = attrs[:location]
-    @url_example      = attrs[:url_example]
+    @request_method   = attrs[:request_method]
+    @path_info        = attrs[:path_info]
     @param_example    = attrs[:param_example]
     @status_example   = attrs[:status_example]
     @response_example = attrs[:response_example]
@@ -22,7 +23,7 @@ class GhostWriter::Document
     end
 
     mode = overwrite ? "w" : "a"
-    doc = File.open(output, mode)
+    doc = File.open("#{output}.#{extname}", mode)
 
     if overwrite
       doc.write paragraph(document_header)
@@ -35,27 +36,25 @@ class GhostWriter::Document
 
   def document_header
     <<EOP
-#{headword(title, 1)}
-
-#{separator(32)}
+#{headword(title, 2)}
 
 EOP
   end
 
   def document_body
     <<EOP
-#{headword(description, 2)}
+#{headword(description, 3)}
 
-#{headword("access path:", 3)}
-#{quote(url_example)}
+#{headword("access path:", 4)}
+#{quote("#{request_method} #{path_info}")}
 
-#{headword("request params:", 3)}
+#{headword("request params:", 4)}
 #{quote(param_example.inspect, :ruby)}
 
-#{headword("status code:", 3)}
+#{headword("status code:", 4)}
 #{quote(status_example)}
 
-#{headword("response:", 3)}
+#{headword("response:", 4)}
 #{quote_response(response_example)}
 
 Generated by "#{description}\" at #{location}

data/lib/ghost_writer/document_index.rb

@@ -9,7 +9,7 @@ class GhostWriter::DocumentIndex
     @documents = documents
   end
 
-  def write_file
+  def write_index_file
     if GhostWriter.github_base_url
       base_url = GhostWriter.github_base_url + "/"
     else
@@ -24,7 +24,7 @@ class GhostWriter::DocumentIndex
       end
     end
 
-    index_file = File.open(output, "w")
+    index_file = File.open("#{output}.#{extname}", "w")
     index_file.write paragraph(<<EOP)
 #{headword("API Examples")}
 #{document_list.join("\n")}

data/lib/ghost_writer/format/markdown.rb

@@ -2,6 +2,11 @@ module GhostWriter
   module Format
     module Markdown
       private
+
+      def extname
+        "md"
+      end
+
       def headword(text, level = 1)
         "#{'#'*level} #{text}"
       end

data/lib/ghost_writer/format/rack.rb

@@ -0,0 +1,93 @@
+module GhostWriter
+  module Format
+    module Rack
+      def write_index_file
+        rack = <<RUBY
+require 'rack'
+
+class DummyApp
+  def call(env)
+    request = Rack::Request.new(env)
+    case [request.request_method, request.path_info]
+
+RUBY
+        documents.each do |output, docs|
+          docs.each do |d|
+            rack += <<RUBY
+    when [#{d.request_method.inspect}, #{d.path_info.inspect}]
+      if fuzzy_match(request.params, #{d.param_example.reject {|k, _| k == "format"}.inspect})
+        [200, {"Content-Type" => #{d.content_type.inspect}}, [(<<BODY)]]
+#{d.response_example}
+BODY
+      else
+        [404, {"Content-Type" => "text/html"}, ['No match rule']]
+      end
+RUBY
+          end
+        end
+        rack += <<RUBY
+    else
+      [404, {"Content-Type" => "text/html"}, ['No match rule']]
+    end
+  end
+
+  def fuzzy_match(params, other)
+    params.all? do |k, v|
+      case v
+      when Hash
+        return false unless other[k].instance_of?(Hash)
+        fuzzy_match(v, other[k])
+      when Array
+        return false unless other[k].instance_of?(Array)
+        fuzzy_match_array(v, other[k])
+      else
+        v.to_s == other[k].to_s
+      end
+    end
+  end
+
+  def fuzzy_match_array(array, other)
+    array.each_with_index.all? do |v, i|
+      case v
+      when Hash
+        fuzzy_match(v, other[i])
+      when Array
+        fuzzy_match_array(v, other[i])
+      else
+        v.to_s == other[i].to_s
+      end
+    end
+  end
+end
+RUBY
+        File.open("#{output}.#{extname}", "w") do |f|
+          f.write rack
+        end
+
+        configru = File.join(File.dirname(output), "config.ru")
+
+        File.open(configru, "w") do |f|
+          f.write "require_relative '#{File.basename(output)}'\n"
+          f.write "run DummyApp.new"
+        end
+      end
+
+      def write_file(overwrite = false)
+      end
+
+      def content_type
+        if param_example["format"] == "json"
+          "application/json; charset=UTF-8"
+        else
+          "text/html; charset=UTF-8"
+        end
+      end
+
+      private
+
+      def extname
+        "rb"
+      end
+    end
+  end
+end

data/lib/ghost_writer/format/rst.rb

@@ -2,6 +2,11 @@ module GhostWriter
   module Format
     module Rst
       private
+
+      def extname
+        "rst"
+      end
+
       def headword(text, level = 1)
         char = case level
                when 1

data/lib/ghost_writer/version.rb

@@ -1,3 +1,3 @@
 module GhostWriter
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/ghost_writer.rb

@@ -9,6 +9,7 @@ module GhostWriter
   module Format
     autoload "Markdown", "ghost_writer/format/markdown"
     autoload "Rst", "ghost_writer/format/rst"
+    autoload "Rack", "ghost_writer/format/rack"
   end
 
   DEFAULT_OUTPUT_DIR = "api_examples".freeze
@@ -29,10 +30,10 @@ module GhostWriter
         unless File.exist?(output_path)
           FileUtils.mkdir_p(output_path)
         end
-        document_index = GhostWriter::DocumentIndex.new(output_path + "#{DOCUMENT_INDEX_FILENAME}.#{output_format}", document_group, GhostWriter.output_format)
-        document_index.write_file
+        document_index = GhostWriter::DocumentIndex.new(output_path + "#{DOCUMENT_INDEX_FILENAME}", document_group, GhostWriter.output_format)
+        document_index.write_index_file
         document_group.each do |output, docs|
-          docs.sort_by!(&:description)
+          docs.sort_by!(&:location)
           docs.shift.write_file(true)
           docs.each(&:write_file)
         end
@@ -59,12 +60,13 @@ module GhostWriter
   end
 
   def collect_example
-    output = File.join(doc_dir, "#{doc_name}.#{GhostWriter.output_format}")
+    output = File.join(doc_dir, "#{doc_name}")
     document = GhostWriter::Document.new(output, {
       title: "#{described_class} #{doc_name.titleize}",
       description: example.full_description.dup,
       location: example.location.dup,
-      url_example: "#{request.env["REQUEST_METHOD"]} #{request.env["PATH_INFO"]}",
+      request_method: request.env["REQUEST_METHOD"],
+      path_info: request.env["PATH_INFO"],
       param_example: controller.params.reject {|key, val| key == "controller" || key == "action"},
       status_example: response.status.inspect,
       response_example: response.body,
@@ -81,7 +83,9 @@ module GhostWriter
   end
 
   def doc_name
-    if example.metadata[:generate_api_doc].is_a?(String) || example.metadata[:generate_api_doc].is_a?(Symbol)
+    metadata = example.metadata[:generate_api_doc] || example.metadata[:ghost_writer]
+    case metadata
+    when String, Symbol
       example.metadata[:generate_api_doc].to_s
     else
       controller.action_name
@@ -90,7 +94,9 @@ module GhostWriter
 
   included do
     after do
-      if (example.metadata[:type] == :controller || example.metadata[:type] == :request) && example.metadata[:generate_api_doc]
+      target_type = example.metadata[:type] == :controller || example.metadata[:type] == :request
+      target_metadata = example.metadata[:generate_api_doc] || example.metadata[:ghost_writer]
+      if target_type && target_metadata
         collect_example if GhostWriter.output_flag
       end
     end

data/spec/lib/ghost_writer_spec.rb

@@ -81,8 +81,8 @@ describe GhostWriter do
       it "generate api doc file" do
         group.run(NullObject.new)
         GhostWriter.generate_api_doc
-        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.markdown").should be_true
-        doc_body = File.read(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.markdown")
+        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.md").should be_true
+        doc_body = File.read(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.md")
         doc_body.should =~ /# AnonymousController Index/
         doc_body.should =~ /first spec/
         doc_body.should =~ /second spec/
@@ -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}.#{GhostWriter.output_format}").should =~ /#{github_base_url}/
+          File.read(Rails.root + "doc" + "api_examples" + "#{GhostWriter::DOCUMENT_INDEX_FILENAME}.md").should =~ /#{github_base_url}/
         end
       end
     end
@@ -107,7 +107,7 @@ describe GhostWriter do
       it "does not generate api doc file" do
         group.run(NullObject.new)
         GhostWriter.generate_api_doc
-        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.markdown").should be_false
+        File.exist?(Rails.root + "doc" + "api_examples" + "anonymous_controller" + "index.md").should be_false
       end
     end
   end
@@ -128,8 +128,8 @@ describe GhostWriter do
       ENV["GENERATE_API_DOC"] = "1"
       group.run(NullObject.new)
       GhostWriter.generate_api_doc
-      File.exist?(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.markdown").should be_true
-      File.read(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.markdown").should =~ /# AnonymousController Index/
+      File.exist?(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.md").should be_true
+      File.read(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.md").should =~ /# AnonymousController Index/
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_writer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -134,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/rack.rb
 - lib/ghost_writer/format/rst.rb
 - lib/ghost_writer/version.rb
 - output_examples/anonymous_controller/index.markdown
@@ -244,4 +245,3 @@ test_files:
 - spec/rails_app/test/test_helper.rb
 - spec/rails_app/test/unit/.gitkeep
 - spec/spec_helper.rb
-has_rdoc: