rack-test-poc 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46a3bb92ca40f94800c03a6a051131225680c1a6
-  data.tar.gz: b1d1e08780a95399be8d8d13acc9b9be79315b14
+  metadata.gz: cce9633d21092ba28d822d448effd6ffe1e0ba18
+  data.tar.gz: c5985ca6394c44769bb4ef9a39c624d0f308719f
 SHA512:
-  metadata.gz: af9deb1af48aa3204949d790b705f20e25bed5527f9041f21c46421f6e2c64b96de8bb2f6c5392c9e9cd84d01782446b7aae0d4808aa022a3393c14583713e20
-  data.tar.gz: 2bf4efcd8e3bba1416bdafc8336f34b881f554f5ccf75e929cf57e5d2f37d7b9dbc235064b708f4570a2dd3fed6c6811ef6c54e2db5795aab17e46898eb7a1ef
+  metadata.gz: b9a612216dfdd57272d5e0345670b221b9dd04c01b215629406c65ae88f7455b39921e42b83f0f93069faa831516e55cbca371f162fdb3e4dd4f9ba1ba450039
+  data.tar.gz: 6ba7a28169ef568020bb87b2b787d619de06723349b3a891458528393282ba535bcfdbe6cb9a878ed6f4e8d1aad85e20ebb6b8e503fa6b44168b8bcd8d9cfa0f

data/README.md

@@ -28,6 +28,10 @@ All you need to do is to require 'rack/test/poc' in your test_helper
 when you working with rack-test module,
 and you good to go!
 
+If you can, you should always describe with :is_for object methods, the response content,
+so it can be easy to analyze out from the poc file, or even can be used in documentation generating!
+With that you can make Google Api docs level documentations!
+
 ### example
 
 ```ruby
@@ -57,6 +61,11 @@ describe 'AppTest' do
 
     #> bla bla bla some code here
     last_response.body #> '{"msg":"Hello Rack!"}'
+    
+    #> you should describe a response so it can be easy to understand from the poc!
+    resp = JSON.parse(last_response.body)
+    resp['msg'].desc 'Hy'
+    resp['data']['key'].desc 'bye'
 
   end
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/lib/rack/test/poc.rb

@@ -1,18 +1,95 @@
+require 'minitest/unit'
+
 module RackTestPoc
 
-  def self.root
-    if defined?(Rails) && Rails.respond_to?(:root) && !!Rails.root
-      Rails.root.to_s
-    elsif !!ENV['BUNDLE_GEMFILE']
-      ENV['BUNDLE_GEMFILE'].split(File::Separator)[0..-2].join(File::Separator)
-    else
-      Dir.pwd
+  module ObjectExt
+
+    def is_for(description_text)
+      return unless RackTestPoc.last_poc
+
+      old_body = RackTestPoc.last_poc['response']['body']['object']
+      RackTestPoc.last_poc['response']['body']['description'] ||= ->{
+
+        begin
+          JSON.parse(old_body.to_json) #> hard clone
+        rescue
+          old_body.dup rescue old_body
+        end
+
+      }.call
+
+      desc_body = RackTestPoc.last_poc['response']['body']['description']
+      RackTestPoc.description_helper(desc_body,self,description_text)
+
+      nil
+
     end
+
   end
 
-  def self.dump_obj
-    @dump_obj ||= Hash.new
-  end;self.dump_obj #> eager load for multiThread
+  ::Object.__send__ :include, ObjectExt
+
+  class << self
+
+    def desc_comp_search(container,object,description_text)
+      case container
+
+        when Array
+          if container.index(object)
+            container[container.index(object)]= description_text
+          else
+            container.each do |element|
+              desc_comp_search(element,object,description_text)
+            end
+          end
+
+        when Hash
+          if container.key(object)
+            container[container.key(object)]= description_text
+          else
+            container.each { |k,v| desc_comp_search(v,object,description_text) }
+          end
+
+      end
+    end
+
+    def description_helper(container,object,description_text)
+      case container
+
+        when Array,Hash
+          desc_comp_search(container,object,description_text)
+
+        else
+          RackTestPoc.last_poc['response']['body']['description']=description_text
+
+      end
+
+    end
+
+    def root
+      if defined?(Rails) && Rails.respond_to?(:root) && !!Rails.root
+        Rails.root.to_s
+      elsif !!ENV['BUNDLE_GEMFILE']
+        ENV['BUNDLE_GEMFILE'].split(File::Separator)[0..-2].join(File::Separator)
+      else
+        Dir.pwd
+      end
+    end
+
+    def dump_object
+      @dump_object ||= Hash.new
+    end
+
+    def last_poc=(last_poc)
+      @last_poc=last_poc
+    end
+
+    def last_poc
+      @last_poc
+    end
+
+  end
+  self.dump_object #> eager load for multiThread
 
   module EXT
 
@@ -26,9 +103,9 @@ module RackTestPoc
           dump_dir = File.join RackTestPoc.root,'test','poc'
           FileUtils.mkdir_p(dump_dir) unless File.exist?(dump_dir)
 
-          unless RackTestPoc.dump_obj.empty?
+          unless RackTestPoc.dump_object.empty?
             File.write File.join(dump_dir,Time.now.to_i.to_s.concat('.yaml')),
-                       RackTestPoc.dump_obj.to_yaml
+                       RackTestPoc.dump_object.to_yaml
 
           end
 
@@ -44,8 +121,8 @@ module RackTestPoc
 
       request_method_str = env['REQUEST_METHOD'].to_s.upcase
 
-      RackTestPoc.dump_obj[uri] ||= {}
-      RackTestPoc.dump_obj[uri][request_method_str] ||= {}
+      RackTestPoc.dump_object[uri] ||= {}
+      RackTestPoc.dump_object[uri][request_method_str] ||= {}
 
       begin
 
@@ -71,8 +148,8 @@ module RackTestPoc
 
       end
 
-      RackTestPoc.dump_obj[uri][request_method_str]['response'] ||= {}
-      RackTestPoc.dump_obj[uri][request_method_str]['request']  ||= {}
+      RackTestPoc.dump_object[uri][request_method_str]['response'] ||= {}
+      RackTestPoc.dump_object[uri][request_method_str]['request']  ||= {}
 
       raw_query = env.find{|k,v|
         %W[ QUERY_STRING rack.request.form_vars ].any?{|tag| k == tag && !v.nil? && v != '' }
@@ -89,24 +166,28 @@ module RackTestPoc
 
                    end
 
-      RackTestPoc.dump_obj[uri][request_method_str]['request']['query'] ||= {}
-      RackTestPoc.dump_obj[uri][request_method_str]['request']['query']['raw'] = raw_query
-      RackTestPoc.dump_obj[uri][request_method_str]['request']['query']['object'] = query_hash
-      RackTestPoc.dump_obj[uri][request_method_str]['request']['headers'] = @headers
+      RackTestPoc.dump_object[uri][request_method_str]['request']['query'] ||= {}
+      RackTestPoc.dump_object[uri][request_method_str]['request']['query']['raw'] = raw_query
+      RackTestPoc.dump_object[uri][request_method_str]['request']['query']['object'] = query_hash
+      RackTestPoc.dump_object[uri][request_method_str]['request']['headers'] = @headers
 
-      RackTestPoc.dump_obj[uri][request_method_str]['response']['body']     = body
-      RackTestPoc.dump_obj[uri][request_method_str]['response']['raw_body'] = last_response.body
+      RackTestPoc.dump_object[uri][request_method_str]['response']['body']= {}
 
-      RackTestPoc.dump_obj[uri][request_method_str]['response']['headers']= env.reduce({}){
-          |m,o| m.merge!(o[0]=>o[1]) if o[0].to_s.downcase =~ /^http_/ ; m
-      }
-      
-      RackTestPoc.dump_obj[uri][request_method_str]['response']['status']= last_response.status
-      RackTestPoc.dump_obj[uri][request_method_str]['response']['format']= format
+      RackTestPoc.dump_object[uri][request_method_str]['response']['body']['object'] = body
+      RackTestPoc.dump_object[uri][request_method_str]['response']['body']['raw'] = last_response.body
 
-      if env['CONTENT_TYPE']
-        RackTestPoc.dump_obj[uri][request_method_str]['response']['content_type']= env['CONTENT_TYPE']
-      end
+      # RackTestPoc.dump_object[uri][request_method_str]['response']['headers']= env.reduce({}){
+      #     |m,o| m.merge!(o[0]=>o[1]) if o[0].to_s.downcase =~ /^http_/ ; m
+      # }
+
+      RackTestPoc.dump_object[uri][request_method_str]['response']['status']= last_response.status
+      RackTestPoc.dump_object[uri][request_method_str]['response']['format']= format
+
+      # if env['CONTENT_TYPE']
+      #   RackTestPoc.dump_object[uri][request_method_str]['response']['content_type']= env['CONTENT_TYPE']
+      # end
+
+      RackTestPoc.last_poc = RackTestPoc.dump_object[uri][request_method_str]
 
       return last_response
 

data/test/{dummy.rb → test_description.rb}

@@ -3,7 +3,8 @@ require 'rack'
 
 class APP
   def self.call(env)
-    [200, {"Content-Type" => "application/json"}, '{"msg":"Hello Rack!"}']
+    [200, {"Content-Type" => "application/json"}, '{"msg":"Hello Rack!","data":{"key":"value"}}']
+    # [200, {"Content-Type" => "text/html"}, 'true']
   end
 end
 
@@ -27,6 +28,13 @@ describe 'AppTest' do
 
     last_response.body #> '{"msg":"Hello Rack!"}'
 
+    resp = JSON.parse(last_response.body)
+    resp['msg'].is_for 'Hy'
+    resp['data']['key'].is_for 'bye'
+
+    # last_response.body.desc 'boolean response'
+
+
   end
 
 

data/test/test_poc_generation.rb

@@ -7,7 +7,7 @@ describe 'POCTest' do
 
   specify 'it should be made able to made a poc at exiting from the process' do
 
-    $stdout.puts `bundle exec ruby #{File.join __dir__,'dummy.rb'}`
+    $stdout.puts `bundle exec ruby #{File.join __dir__,'test_description.rb'}`
 
     begin
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-test-poc
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,7 +72,7 @@ files:
 - lib/rack-test-poc.rb
 - lib/rack/test/poc.rb
 - rack-test-poc.gemspec
-- test/dummy.rb
+- test/test_description.rb
 - test/test_poc_generation.rb
 homepage: https://github.com/adamluzsi/rack-test-poc
 licenses: []
@@ -98,6 +98,6 @@ signing_key:
 specification_version: 4
 summary: rack/test based poc file generator
 test_files:
-- test/dummy.rb
+- test/test_description.rb
 - test/test_poc_generation.rb
 has_rdoc: