ghost_writer 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 876770396865698ba8324e5b1765edfeffaab4c1
-  data.tar.gz: 7c8b0d88212c2985f6969e3a3fcf286db6135d8f
+  metadata.gz: 7aaf1da751c9da1f4bd95426076de33da3ed4bb8
+  data.tar.gz: 59d7e48cdf34b773da063196e78a6215c5dab391
 SHA512:
-  metadata.gz: 61966afe8996ef69ffbc49133455adcfae3bb63dbd1ae1ed955ef884cc0e93f912d28127554b279a9eea76be9d6ee2c7dc97e7bf419c6166fd6957ac66e09f36
-  data.tar.gz: ee9f5674274384cdcfaf14b6ef5cc4512cf83a2d572323546be75230e62f9ba2b1f951b436f6a98a48a878c9a8bcd25a31417eee080989db75cf4eb1ca6ed135
+  metadata.gz: 1473fc739dbbc1274784edb02e52948b67591be47ca3fa30fa7930555c254877968a544fe5f695594eb75c903ab7413b30cc2c7608f0fd9f1ad2b5d8e97c3a46
+  data.tar.gz: 14d93f8b53bfbb364a078f5bcfe7a86de4224fdc0e761113e227cfcd0351652ebc93d3ba66ca5ba90d9aabda70ddfaba828c9b5c11e878b9e4c47b16645fd3be

data/README.md

@@ -1,6 +1,7 @@
 # GhostWriter
 [![Build Status](https://travis-ci.org/joker1007/ghost_writer.png)](https://travis-ci.org/joker1007/ghost_writer)
 [![Gem Version](https://badge.fury.io/rb/ghost_writer.png)](http://badge.fury.io/rb/ghost_writer)
+[![Code Climate](https://codeclimate.com/github/joker1007/ghost_writer.png)](https://codeclimate.com/github/joker1007/ghost_writer)
 
 Generate API examples from params and response of controller specs
 

data/lib/ghost_writer.rb

@@ -31,11 +31,13 @@ module GhostWriter
           FileUtils.mkdir_p(output_path)
         end
         document_index = GhostWriter::DocumentIndex.new(output_path + "#{DOCUMENT_INDEX_FILENAME}", document_group, GhostWriter.output_format)
-        document_index.write_index_file
+        document_index.write_file(format: output_format)
         document_group.each do |output, docs|
           docs.sort_by!(&:location)
-          docs.shift.write_file(true)
-          docs.each(&:write_file)
+          initial = docs.shift
+          initial.header = true
+          initial.write_file(format: output_format, overwrite: true)
+          docs.each {|d| d.write_file(format: output_format) }
         end
 
         document_group.clear
@@ -68,8 +70,8 @@ module GhostWriter
       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,
+      status_code: response.status,
+      response_body: response.body,
       format: GhostWriter.output_format
     })
 

data/lib/ghost_writer/document.rb

@@ -1,79 +1,59 @@
-class GhostWriter::Document
-  attr_reader :title, :description, :location, :request_method, :path_info, :param_example, :status_example, :response_example, :output, :relative_path
+require 'ghost_writer/writer'
 
-  def initialize(output, attrs)
-    format_module = "GhostWriter::Format::#{attrs[:format].to_s.classify}"
-    extend(format_module.constantize)
+class GhostWriter::Document
+  attr_reader :basename, :relative_path, :title, :description, :location, :request_method, :path_info, :response_format, :param_example, :status_code
+  attr_accessor :header
 
-    @output           = output
-    @relative_path    = Pathname.new(output).relative_path_from(GhostWriter.output_path)
+  def initialize(basename, attrs)
+    @basename         = basename
+    @relative_path    = Pathname.new(basename).relative_path_from(GhostWriter.output_path)
     @title            = attrs[:title]
     @description      = attrs[:description]
     @location         = attrs[:location]
     @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]
-  end
-
-  def write_file(overwrite = false)
-    unless File.exist?(File.dirname(output))
-      FileUtils.mkdir_p(File.dirname(output))
-    end
-
-    mode = overwrite ? "w" : "a"
-    doc = File.open("#{output}.#{extname}", mode)
 
-    if overwrite
-      doc.write paragraph(document_header)
-    end
-
-    doc.write(document_body)
-
-    doc.close
+    param_example     = attrs[:param_example].stringify_keys
+    @response_format  = param_example.delete("format").to_s
+    @param_example    = param_example
+    @status_code      = attrs[:status_code]
+    @response_body    = attrs[:response_body]
   end
 
-  def document_header
-    <<EOP
-#{headword(title, 2)}
-
-EOP
+  def write_file(options = {})
+    writer = GhostWriter::Writer.new(self, options)
+    writer.write_file
   end
 
-  def document_body
-    <<EOP
-#{headword(description, 3)}
-
-#{headword("access path:", 4)}
-#{quote("#{request_method} #{path_info}")}
-
-#{headword("request params:", 4)}
-#{quote(param_example.inspect, :ruby)}
-
-#{headword("status code:", 4)}
-#{quote(status_example)}
-
-#{headword("response:", 4)}
-#{quote_response(response_example)}
-
-Generated by "#{description}\" at #{location}
+  def serialized_params
+    MultiJson.dump(param_example)
+  end
 
-#{separator(32)}
+  def response_body
+    arrange_json(@response_body)
+  end
 
-EOP
+  def response_format(json_convert_to_javascript = false)
+    if json_convert_to_javascript && @response_format == "json"
+      "javascript"
+    else
+      @response_format
+    end
   end
 
-  private
-  def quote_response(body)
-    if param_example[:format] && param_example[:format].to_sym == :json
-      quote(arrange_json(response_example), :javascript)
+  def content_type
+    if response_format == "json"
+      "application/json; charset=UTF-8"
     else
-      quote(response_example, param_example[:format])
+      "text/html; charset=UTF-8"
     end
   end
 
+  private
+
   def arrange_json(body)
+    return body unless response_format == "json"
+
     data = ActiveSupport::JSON.decode(body)
     if data.is_a?(Array) || data.is_a?(Hash)
       JSON.pretty_generate(data)

data/lib/ghost_writer/document_index.rb

@@ -1,34 +1,27 @@
+require 'ghost_writer/index_writer'
+require 'ghost_writer/index_writer/rack'
+
 class GhostWriter::DocumentIndex
-  attr_reader :output, :documents
+  attr_reader :basename, :document_group
+
+  def initialize(basename, document_group, format)
+    @basename = basename
+    @document_group = document_group
+  end
 
-  def initialize(output, documents, format)
-    format_module = "GhostWriter::Format::#{format.to_s.classify}"
-    extend(format_module.constantize)
+  def write_file(options = {})
+    writer = GhostWriter::IndexWriter.new(self, options)
+    writer.write_file
 
-    @output = output
-    @documents = documents
+    rack_writer = GhostWriter::IndexWriter::Rack.new(self)
+    rack_writer.write_file
   end
 
-  def write_index_file
+  def base_url
     if GhostWriter.github_base_url
       base_url = GhostWriter.github_base_url + "/"
     else
       base_url = ""
     end
-
-    document_list = documents.flat_map do |output, docs|
-      docs.map do |d|
-        list(
-          link(d.description, base_url + "#{d.relative_path}")
-        )
-      end
-    end
-
-    index_file = File.open("#{output}.#{extname}", "w")
-    index_file.write paragraph(<<EOP)
-#{headword("API Examples")}
-#{document_list.join("\n")}
-EOP
-    index_file.close
   end
 end

data/lib/ghost_writer/index_writer.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/string'
+
+class GhostWriter::IndexWriter
+  autoload "Markdown", "ghost_writer/index_writer/markdown"
+  autoload "Rst", "ghost_writer/index_writer/rst"
+
+  def initialize(document_index, options = {})
+    @document_index  = document_index
+    @format          = options.delete(:format) || :markdown
+  end
+
+  def write_file
+    format_class = lookup_format_class
+    format = format_class.new(@document_index)
+    format.write_file
+  end
+
+  private
+
+  def lookup_format_class
+    case @format
+    when Class
+      @format
+    when String, Symbol
+      "GhostWriter::IndexWriter::#{@format.to_s.classify}".constantize
+    end
+  end
+end

data/lib/ghost_writer/index_writer/base.rb

@@ -0,0 +1,27 @@
+class GhostWriter::IndexWriter
+  class Base
+    def initialize(document_index)
+      @document_index = document_index
+    end
+
+    def write_file
+      unless File.exist?(File.dirname(@document_index.basename))
+        FileUtils.mkdir_p(File.dirname(@document_index.basename))
+      end
+
+      File.open("#{@document_index.basename}.#{extname}", "w") do |f|
+        f.write template.result(@document_index.instance_eval { binding })
+      end
+    end
+
+    private
+
+    def extname
+      raise NotImplementedError
+    end
+
+    def template
+      raise NotImplementedError
+    end
+  end
+end

data/lib/ghost_writer/index_writer/markdown.rb

@@ -0,0 +1,16 @@
+require 'ghost_writer/index_writer/base'
+
+class GhostWriter::IndexWriter
+  class Markdown < Base
+    private
+
+    def extname
+      "md"
+    end
+
+    def template
+      path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", "markdown.erb")
+      ERB.new(File.read(path), nil, "%-")
+    end
+  end
+end

data/lib/ghost_writer/index_writer/rack.rb

@@ -0,0 +1,39 @@
+require 'ghost_writer/index_writer/base'
+
+class GhostWriter::IndexWriter
+  class Rack < Base
+    def write_file
+      unless File.exist?(File.dirname(@document_index.basename))
+        FileUtils.mkdir_p(File.dirname(@document_index.basename))
+      end
+
+      File.open(app_path, "w") do |f|
+        f.write template.result(@document_index.instance_eval { binding })
+      end
+
+      File.open(configru_path, "w") do |f|
+        f.write "require_relative 'mock_server'\n"
+        f.write "run MockServer.new"
+      end
+    end
+
+    private
+
+    def app_path
+      File.join(File.dirname(@document_index.basename), "mock_server.rb")
+    end
+
+    def configru_path
+      File.join(File.dirname(@document_index.basename), "config.ru")
+    end
+
+    def extname
+      "rb"
+    end
+
+    def template
+      path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", "rack.erb")
+      ERB.new(File.read(path), nil, "%-")
+    end
+  end
+end

data/lib/ghost_writer/index_writer/rst.rb

@@ -0,0 +1,16 @@
+require 'ghost_writer/index_writer/base'
+
+class GhostWriter::IndexWriter
+  class Rst < Base
+    private
+
+    def extname
+      "rst"
+    end
+
+    def template
+      path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", "rst.erb")
+      ERB.new(File.read(path), nil, "%-")
+    end
+  end
+end

data/lib/ghost_writer/index_writer/templates/markdown.erb

@@ -0,0 +1,7 @@
+## API Examples
+
+<% document_group.each do |output, docs| -%>
+<% docs.each do |d| -%>
+- [<%= d.description %>](<%= base_url + d.relative_path.to_s %>)
+<% end %>
+<% end -%>

data/lib/ghost_writer/index_writer/templates/rack.erb

@@ -0,0 +1,36 @@
+require 'rack'
+
+class MockServer
+  def call(env)
+    request = Rack::Request.new(env)
+    params = recursive_to_s(request.params)
+    case [request.request_method, request.path_info, params]
+    <% document_group.each do |output, docs| -%>
+    <% docs.each do |d| -%>
+    when [<%= d.request_method.inspect %>, <%= d.path_info.inspect %>, recursive_to_s(<%= MultiJson.load(d.serialized_params).inspect %>)]
+      [200, {"Content-Type" => <%= d.content_type.inspect %>}, [(<<BODY)]]
+<%= d.response_body %>
+BODY
+    <% end %>
+    <% end -%>
+    else
+      [404, {"Content-Type" => "text/html"}, ['No match rule']]
+    end
+  end
+
+  def recursive_to_s(params)
+    case params
+    when Hash
+      params.each do |k, v|
+        params[k] = recursive_to_s(v)
+      end
+    when Array
+      params.map do |v|
+        recursive_to_s(v)
+      end
+    else
+      params.to_s
+    end
+  end
+end
+

data/lib/ghost_writer/index_writer/templates/rst.erb

@@ -0,0 +1,8 @@
+API Examples
+*****************
+
+<% document_group.each do |output, docs| -%>
+<% docs.each do |d| -%>
+* `<%= d.description %> <<%= base_url + d.relative_path.to_s %>>`_.
+<% end %>
+<% end -%>

data/lib/ghost_writer/version.rb

@@ -1,3 +1,3 @@
 module GhostWriter
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/ghost_writer/writer.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/string'
+
+class GhostWriter::Writer
+  autoload "Markdown", "ghost_writer/writer/markdown"
+  autoload "Rst", "ghost_writer/writer/rst"
+
+  def initialize(document, options = {})
+    @document  = document
+    @format    = options.delete(:format) || :markdown
+    @options   = options
+  end
+
+  def write_file
+    format_class = lookup_format_class
+    format = format_class.new(@document, @options)
+    format.write_file
+  end
+
+  private
+
+  def lookup_format_class
+    case @format
+    when Class
+      @format
+    when String, Symbol
+      "GhostWriter::Writer::#{@format.to_s.classify}".constantize
+    end
+  end
+end

data/lib/ghost_writer/writer/base.rb

@@ -0,0 +1,31 @@
+require 'erb'
+
+class GhostWriter::Writer
+  class Base
+    def initialize(document, options = {})
+      @document  = document
+      @overwrite = options[:overwrite] || false
+    end
+
+    def write_file
+      unless File.exist?(File.dirname(@document.basename))
+        FileUtils.mkdir_p(File.dirname(@document.basename))
+      end
+
+      mode = @overwrite ? "w" : "a"
+      File.open("#{@document.basename}.#{extname}", mode) do |f|
+        f.write template.result(@document.instance_eval { binding })
+      end
+    end
+
+    private
+
+    def extname
+      raise NotImplementedError
+    end
+
+    def template
+      raise NotImplementedError
+    end
+  end
+end

data/lib/ghost_writer/writer/markdown.rb

@@ -0,0 +1,16 @@
+require 'ghost_writer/writer/base'
+
+class GhostWriter::Writer
+  class Markdown < Base
+    private
+
+    def extname
+      "md"
+    end
+
+    def template
+      path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", "markdown.erb")
+      ERB.new(File.read(path))
+    end
+  end
+end

data/lib/ghost_writer/writer/rst.rb

@@ -0,0 +1,16 @@
+require 'ghost_writer/writer/base'
+
+class GhostWriter::Writer
+  class Rst < Base
+    private
+
+    def extname
+      "rst"
+    end
+
+    def template
+      path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", "rst.erb")
+      ERB.new(File.read(path), nil, "%-")
+    end
+  end
+end

data/lib/ghost_writer/writer/templates/markdown.erb

@@ -0,0 +1,33 @@
+<% if header %>
+## <%= title %>
+<% end %>
+
+### <%= description %>
+
+#### access path:
+
+```
+<%= "#{request_method} #{path_info}" %>
+```
+
+#### request params:
+
+```json
+<%= serialized_params %>
+```
+
+#### status code:
+
+```
+<%= status_code %>
+```
+
+#### response:
+
+```<%= response_format %>
+<%= response_body %>
+```
+
+Generated by <%= description %> at <%= location %>
+
+--------------------------------

data/lib/ghost_writer/writer/templates/rst.erb

@@ -0,0 +1,41 @@
+<% if header -%>
+<%= title %>
+<%= "*" * title.length * 2 %>
+<% end -%>
+
+<%= description %>
+<%= "=" * description.length * 2 %>
+
+
+access path
+----------------
+
+::
+   <%= "#{request_method} #{path_info}" %>
+
+
+request params
+----------------------
+
+.. code-block:: javascript
+<%= serialized_params.each_line.map{|line| line.chomp.empty? ? line : "   " + line}.join %>
+
+
+status code
+----------------------
+
+::
+   <%= status_code %>
+
+
+response
+----------------------
+
+.. code-block:: <%= response_format(true) %>
+<%= response_body.each_line.map{|line| line.chomp.empty? ? line : "   " + line}.join %>
+
+
+Generated by <%= description %> at <%= location %>
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghost_writer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - joker1007
@@ -147,10 +147,21 @@ files:
 - lib/ghost_writer.rb
 - 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/index_writer.rb
+- lib/ghost_writer/index_writer/base.rb
+- lib/ghost_writer/index_writer/markdown.rb
+- lib/ghost_writer/index_writer/rack.rb
+- lib/ghost_writer/index_writer/rst.rb
+- lib/ghost_writer/index_writer/templates/markdown.erb
+- lib/ghost_writer/index_writer/templates/rack.erb
+- lib/ghost_writer/index_writer/templates/rst.erb
 - lib/ghost_writer/version.rb
+- lib/ghost_writer/writer.rb
+- lib/ghost_writer/writer/base.rb
+- lib/ghost_writer/writer/markdown.rb
+- lib/ghost_writer/writer/rst.rb
+- lib/ghost_writer/writer/templates/markdown.erb
+- lib/ghost_writer/writer/templates/rst.erb
 - output_examples/anonymous_controller/index.markdown
 - output_examples/anonymous_controller/show.markdown
 - output_examples/document_index.markdown

data/lib/ghost_writer/format/markdown.rb

@@ -1,35 +0,0 @@
-module GhostWriter
-  module Format
-    module Markdown
-      private
-
-      def extname
-        "md"
-      end
-
-      def headword(text, level = 1)
-        "#{'#'*level} #{text}"
-      end
-
-      def paragraph(text)
-        text + "\n"
-      end
-
-      def separator(length)
-        "-" * length
-      end
-
-      def quote(text, quote_format = nil)
-        "```#{quote_format}\n#{text}\n```"
-      end
-
-      def list(text, level = 1)
-        "#{"  " * (level - 1)}- #{text}"
-      end
-
-      def link(text, url)
-        "[#{text}](#{url})"
-      end
-    end
-  end
-end

data/lib/ghost_writer/format/rack.rb

@@ -1,99 +0,0 @@
-require 'multi_json'
-
-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, #{parameter_arranging(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
-
-      def parameter_arranging(params)
-        MultiJson.load(MultiJson.dump(params))
-      end
-    end
-  end
-end

data/lib/ghost_writer/format/rst.rb

@@ -1,50 +0,0 @@
-module GhostWriter
-  module Format
-    module Rst
-      private
-
-      def extname
-        "rst"
-      end
-
-      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