crapidocs 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08ef3d447b99f34e2c2281c50cf9e922c3ba32b4
-  data.tar.gz: bb21f2b1bb0d3c46345d1a48d5bdeb51710eaf86
+  metadata.gz: e9e7d0c00bd7671481cbe59831d7df48d8b140f8
+  data.tar.gz: 0f841c50048160d4fe3e708c47ac449e3a32f8ae
 SHA512:
-  metadata.gz: 4ad0573d67962d965da72b6e78b1b7da8cf1b738beb0240f6a1a9f131991f8f5ad57b83fa66300b1a8f399498321d9796b321d6f61db0e5cb535e2ec9fc9185d
-  data.tar.gz: 3a7a491dc465569c1dd2c74c7d806a8415643d54904de24fb2935789f8bea1b40fc85112d15095213a87b2ed9dfdf9980d90eb7e4eae2ae41cc6aa7fa4ef2f0c
+  metadata.gz: a7c904b31276f460fe9e2c375fe66968a7ed40e5e5bef1003da6f080ffdd936328fe0959408e9642405738c7aeaacddfc6e1b798ec6e59ddcb3a9ce14724115b
+  data.tar.gz: 2d3db67aa421291cdc2ae1896d594f7a23925c320a24a0ed24ba531c83a0f0cc3a844e6647ba971009ef758ce6d47869f6e6c85d81f28e644d8e27d846d8204c

data/lib/crapidocs/session.rb

@@ -1,5 +1,7 @@
 module CrapiDocs
   class Session
+    attr_reader :actions
+
     def initialize(pattern)
       @pattern = pattern
       @actions = {}
@@ -17,8 +19,7 @@ module CrapiDocs
         request: {
           method: method,
           body: env['rack.input'].string,
-          headers: env,
-          uri: uri
+          headers: clean_headers(env)
         },
         response: {
           status: status,
@@ -27,7 +28,7 @@ module CrapiDocs
         }
       }
 
-      path = cleaned_path(uri)
+      path = clean_path(uri.path)
       @actions[path] ||= {}
       @actions[path][method] ||= []
       @actions[path][method] << action
@@ -56,6 +57,13 @@ module CrapiDocs
       parse_body(res[:body])
     end
 
+    def merge(sessions)
+      sessions = [sessions] unless sessions.is_a?(Array)
+      @actions = sessions.reduce(@actions) do |a, session|
+        a.deep_merge(session.actions)
+      end
+    end
+
     private
 
     def parse_body(body)
@@ -72,9 +80,13 @@ module CrapiDocs
       params
     end
 
-    def cleaned_path(uri)
+    def clean_headers(headers)
+      headers.delete_if { |k, _v| k =~ /^(sinatra|rack)\./ }
+    end
+
+    def clean_path(path)
       last = nil
-      uri.path.split('/').reject(&:blank?).reduce('') do |cleaned, part|
+      path.split('/').reject(&:blank?).reduce('') do |cleaned, part|
         part = ":#{last.singularize}_id" if part =~ /^\d+$/
         part = ':token' if tokenish?(part)
         last = part
@@ -83,7 +95,7 @@ module CrapiDocs
     end
 
     def tokenish?(s)
-      s =~ /\d+/ && s =~ /[a-zA-Z]+/ && s.length >= 10
+      (s =~ /\d+/ && s =~ /[a-zA-Z]+/ && s.length >= 10) == true
     end
 
     def relevant?(uri)

data/lib/crapidocs.rb

@@ -16,8 +16,10 @@ module Rack
 end
 
 module CrapiDocs
-  VERSION = [0, 1, 4]
+  VERSION = [0, 2, 0]
   TEMPLATE_DIR = File.expand_path('../..', __FILE__) + '/templates'
+  PARALLEL = ENV['PARALLEL_TEST_GROUPS'] && defined?(ParallelTests)
+  SESSION_FILE_PREFIX = 'crapi-session.'
 
   class << self
     attr_reader :session
@@ -26,9 +28,10 @@ module CrapiDocs
       VERSION.join('.')
     end
 
-    def start(pattern, target = './doc/api.md')
+    def start(pattern, target = './doc/api.md', tmp = './tmp')
       @session = Session.new(pattern)
       @target = target
+      @tmp = tmp
     end
 
     def purge
@@ -40,14 +43,45 @@ module CrapiDocs
     end
 
     def done
+      handle_parallel if CrapiDocs::PARALLEL
       formatter = Formatter.new(@session)
-      write_file(formatter.to_md)
+      write_docs(formatter.to_md)
     end
 
     private
 
-    def write_file(data)
-      File.open(@target, 'w').write(data)
+    def handle_parallel
+      return write_session unless ParallelTests.first_process?
+      ParallelTests.wait_for_other_processes_to_finish
+      @session.merge(load_sessions)
+    end
+
+    def session_file
+      test_num = ENV['TEST_ENV_NUMBER'] || '1'
+      format('%s/%s%s', @tmp, SESSION_FILE_PREFIX, test_num)
+    end
+
+    def write_session
+      write_file(session_file, Marshal.dump(@session))
+    end
+
+    def load_sessions
+      glob = "#{@tmp}/#{SESSION_FILE_PREFIX}*"
+      Dir[glob].map { |f| load_session(f) }
+    end
+
+    def load_session(file)
+      data = File.open(file).read
+      File.unlink(file)
+      Marshal.load(data)
+    end
+
+    def write_docs(data)
+      write_file(@target, data)
+    end
+
+    def write_file(file, data)
+      File.open(file, 'w') { |f| f.write(data) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crapidocs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Holly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies: []
 description: Generate decent API documentation from RSpec API tests.
 email: mikejholly@gmail.com