ghost_writer 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aaf1da751c9da1f4bd95426076de33da3ed4bb8
-  data.tar.gz: 59d7e48cdf34b773da063196e78a6215c5dab391
+  metadata.gz: 1dc0e5d084163ec03337241b84977a9e80c28756
+  data.tar.gz: 1e81c300e26e4b3f33333dd3e773e3c7a5b08b33
 SHA512:
-  metadata.gz: 1473fc739dbbc1274784edb02e52948b67591be47ca3fa30fa7930555c254877968a544fe5f695594eb75c903ab7413b30cc2c7608f0fd9f1ad2b5d8e97c3a46
-  data.tar.gz: 14d93f8b53bfbb364a078f5bcfe7a86de4224fdc0e761113e227cfcd0351652ebc93d3ba66ca5ba90d9aabda70ddfaba828c9b5c11e878b9e4c47b16645fd3be
+  metadata.gz: 355426a71839e8a7af4513a2b4c0e096de8bb386c6c3e8ec486b95048f4e6e48c474a22a4a5dd79fec19ba27e7748092cbb8357df99b1faa0cefcda7bf010e73
+  data.tar.gz: 44e85808ba039ede8e92e095e2cdc9123b1d886d24f64eac3fcb46c021cabb1b83ffa0fb2d5709e009b735c27ecabdb429ba26fd880aef56618cc04a5952eee1

data/.gitignore

@@ -15,3 +15,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+/api_docs
+/api_examples
+
+gemfiles/*.lock

data/.travis.yml

@@ -1,8 +1,17 @@
 language: ruby
-script: "bundle exec rake spec build"
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1
+
+gemfile:
+  - gemfiles/rspec2.gemfile
+  - gemfiles/rspec3.gemfile
+
+matrix:
+  allow_failures:
+   - rvm: 1.9.3
+
 notifications:
   email:
     on_success: never

data/README.md

@@ -3,7 +3,7 @@
 [![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
+Generate API examples from params and response of controller/request specs
 
 ## Installation
 

data/Rakefile

@@ -1,6 +1,27 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--color --format d"
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-c -f d']
+  end
+end
+
+namespace :spec do
+  %w(rspec2 rspec3).each do |gemfile|
+    desc "Run Tests by #{gemfile}.gemfile"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle install --path .bundle"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
+    end
+  end
+
+  desc "Run All Tests"
+  task :all do
+    %w(rspec2 rspec3).each do |gemfile|
+      Rake::Task["spec:#{gemfile}"].invoke
+    end
+  end
 end

data/gemfiles/rspec2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rspec-rails", "~> 2.14"
+
+gemspec path: "../"

data/gemfiles/rspec3.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rspec-rails", ">= 3.0.0.beta2", "< 3.1"
+
+gemspec path: "../"

data/ghost_writer.gemspec

@@ -19,12 +19,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "activesupport", ">= 3.0.0"
-  gem.add_dependency "rspec-rails", "~> 2.11"
+  gem.add_dependency "rspec-rails", ">= 2.12"
   gem.add_dependency "trollop"
-  gem.add_dependency "multi_json"
+  gem.add_dependency "oj"
+  gem.add_dependency "json"
 
-  gem.add_development_dependency "rspec-rails", "~> 2.12"
   gem.add_development_dependency 'rake', ['>= 0']
   gem.add_development_dependency 'rails', ['>= 3.2.9', '< 5']
+  gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'tapp'
+  gem.add_development_dependency 'pry'
 end

data/lib/ghost_writer.rb

@@ -2,6 +2,8 @@ require "ghost_writer/version"
 require "ghost_writer/document"
 require "ghost_writer/document_index"
 require "active_support/concern"
+require "oj"
+require "json"
 
 module GhostWriter
   extend ActiveSupport::Concern
@@ -27,10 +29,10 @@ module GhostWriter
 
     def generate_api_doc
       if output_flag
-        unless File.exist?(output_path)
-          FileUtils.mkdir_p(output_path)
+        unless File.exist?(output_dir)
+          FileUtils.mkdir_p(output_dir)
         end
-        document_index = GhostWriter::DocumentIndex.new(output_path + "#{DOCUMENT_INDEX_FILENAME}", document_group, GhostWriter.output_format)
+        document_index = GhostWriter::DocumentIndex.new(output_dir + "#{DOCUMENT_INDEX_FILENAME}", document_group, GhostWriter.output_format)
         document_index.write_file(format: output_format)
         document_group.each do |output, docs|
           docs.sort_by!(&:location)
@@ -49,11 +51,7 @@ module GhostWriter
     end
 
     def output_dir
-      @output_dir ? @output_dir : DEFAULT_OUTPUT_DIR
-    end
-
-    def output_path
-      Rails.root + "doc" + output_dir
+      @output_dir ? Pathname(@output_dir) : Pathname(DEFAULT_OUTPUT_DIR)
     end
 
     def output_format
@@ -61,10 +59,10 @@ module GhostWriter
     end
   end
 
-  def collect_example
-    output = File.join(doc_dir, "#{doc_name}")
+  def collect_example(example)
+    output = doc_dir + doc_name(example)
     document = GhostWriter::Document.new(output, {
-      title: "#{described_class} #{doc_name.titleize}",
+      title: "#{described_class} #{doc_name(example).titleize}",
       description: example.full_description.dup,
       location: example.location.dup,
       request_method: request.env["REQUEST_METHOD"],
@@ -81,10 +79,10 @@ module GhostWriter
 
   private
   def doc_dir
-    GhostWriter.output_path + described_class.to_s.underscore
+    GhostWriter.output_dir + described_class.to_s.underscore
   end
 
-  def doc_name
+  def doc_name(example)
     metadata = example.metadata[:generate_api_doc] || example.metadata[:ghost_writer]
     case metadata
     when String, Symbol
@@ -95,11 +93,14 @@ module GhostWriter
   end
 
   included do
-    after do
+    after do |example_or_group|
+      example = example_or_group.is_a?(RSpec::Core::Example) ?
+        example_or_group :
+        example_or_group.example
       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
+        collect_example(example) if GhostWriter.output_flag
       end
     end
   end

data/lib/ghost_writer/document.rb

@@ -6,7 +6,7 @@ class GhostWriter::Document
 
   def initialize(basename, attrs)
     @basename         = basename
-    @relative_path    = Pathname.new(basename).relative_path_from(GhostWriter.output_path)
+    @relative_path    = basename
     @title            = attrs[:title]
     @description      = attrs[:description]
     @location         = attrs[:location]
@@ -26,7 +26,10 @@ class GhostWriter::Document
   end
 
   def serialized_params
-    MultiJson.dump(param_example)
+    Oj.dump(param_example)
+  rescue NoMemoryError, StandardError
+    puts "Param serialize error: #{param_example.inspect} of #{description} at #{location}"
+    param_example.inspect
   end
 
   def response_body
@@ -54,13 +57,13 @@ class GhostWriter::Document
   def arrange_json(body)
     return body unless response_format == "json"
 
-    data = ActiveSupport::JSON.decode(body)
+    data = Oj.load(body)
     if data.is_a?(Array) || data.is_a?(Hash)
       JSON.pretty_generate(data)
     else
       data
     end
-  rescue MultiJson::DecodeError
+  rescue Oj::Error
     body
   end
 end

data/lib/ghost_writer/document_index.rb

@@ -12,9 +12,6 @@ class GhostWriter::DocumentIndex
   def write_file(options = {})
     writer = GhostWriter::IndexWriter.new(self, options)
     writer.write_file
-
-    rack_writer = GhostWriter::IndexWriter::Rack.new(self)
-    rack_writer.write_file
   end
 
   def base_url

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

@@ -7,7 +7,7 @@ class MockServer
     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 %>)]
+    when [<%= d.request_method.inspect %>, <%= d.path_info.inspect %>, recursive_to_s(<%= Oj.load(d.serialized_params).inspect %>)]
       [200, {"Content-Type" => <%= d.content_type.inspect %>}, [(<<BODY)]]
 <%= d.response_body %>
 BODY

data/lib/ghost_writer/version.rb

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

data/spec/lib/ghost_writer_spec.rb

@@ -1,12 +1,12 @@
 require "spec_helper"
 
-class AnonymousController
+class AnonymousController < ActionController::Base
 end
 
 describe GhostWriter do
 
   let(:group) do
-    RSpec::Core::ExampleGroup.describe do
+    RSpec::Core::ExampleGroup.describe AnonymousController, type: :controller do
       include RSpec::Rails::ControllerExampleGroup
       include GhostWriter
 
@@ -38,7 +38,7 @@ describe GhostWriter do
         it "first spec", generate_api_doc: true do
           begin
             get :index, param1: "value"
-            response.should be_success
+            expect(response).to be_success
           rescue Exception => e
             p e
           end
@@ -47,7 +47,7 @@ describe GhostWriter do
         it "second spec", generate_api_doc: true do
           begin
             get :index, param1: "value"
-            response.should be_success
+            expect(response).to be_success
           rescue Exception => e
             p e
           end
@@ -58,7 +58,7 @@ describe GhostWriter do
         it "returns a Resource json", generate_api_doc: true do
           begin
             get :show, id: 1, format: :json, param1: "value", params2: ["value1", "value2"]
-            response.should be_success
+            expect(response).to be_success
           rescue Exception => e
             p e
           end
@@ -81,11 +81,12 @@ 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.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/
+        path = Pathname("api_examples") + "anonymous_controller" + "index.md"
+        expect(path).to be_exist
+        doc_body = File.read(path)
+        expect(doc_body).to match(/# AnonymousController Index/)
+        expect(doc_body).to match(/first spec/)
+        expect(doc_body).to match(/second spec/)
       end
 
       context "Given github_base_url" do
@@ -94,7 +95,8 @@ 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}.md").should =~ /#{github_base_url}/
+          path = Pathname("api_examples") + "#{GhostWriter::DOCUMENT_INDEX_FILENAME}.md"
+          expect(File.read(path)).to match(/#{github_base_url}/)
         end
       end
     end
@@ -107,7 +109,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.md").should be_false
+        expect(Pathname("api_examples") + "anonymous_controller" + "index.md").not_to be_exist
       end
     end
   end
@@ -128,14 +130,15 @@ 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.md").should be_true
-      File.read(Rails.root + "doc" + output_dir + "anonymous_controller" + "index.md").should =~ /# AnonymousController Index/
+      path = Pathname(output_dir) + "anonymous_controller" + "index.md"
+      expect(path).to be_exist
+      expect(File.read(path)).to match(/# AnonymousController Index/)
     end
   end
 
   def clear_output(dirname)
-    if File.exist?(Rails.root + "doc" + dirname)
-      FileUtils.rm_r(Rails.root + "doc" + dirname)
+    if File.exist?(dirname)
+      FileUtils.rm_r(dirname)
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,11 +2,20 @@ ENV["RAILS_ENV"] = "test"
 
 $:.unshift File.dirname(__FILE__)
 
-require "rails_app/config/environment"
+require 'pry'
+
+require 'rails/all'
 
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+require "rails_app/config/environment"
 I18n.load_path << File.expand_path("../support/locale/en.yml", __FILE__)
 
-require "rspec/rails"
+require 'rspec/rails'
+require 'ghost_writer'
 
 class NullObject
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_writer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.12'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tapp
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate API examples from params and response of controller specs
 email:
 - kakyoin.hierophant@gmail.com
@@ -143,6 +171,8 @@ files:
 - README.md
 - Rakefile
 - bin/ghost_writer
+- gemfiles/rspec2.gemfile
+- gemfiles/rspec3.gemfile
 - ghost_writer.gemspec
 - lib/ghost_writer.rb
 - lib/ghost_writer/document.rb
@@ -225,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generate API examples from params and response of controller specs
@@ -270,3 +300,4 @@ test_files:
 - spec/rails_app/test/test_helper.rb
 - spec/rails_app/test/unit/.gitkeep
 - spec/spec_helper.rb
+has_rdoc: