rspec-api-blueprint-formatter 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66253fd5e90a63780a9c868ca055bace2d499990
-  data.tar.gz: 0919dbc11129eed8dac2814a3c49ef6204c1f87b
+  metadata.gz: 68a3f26247af518145dd22bcb32ca8e724445311
+  data.tar.gz: 2dcd00052e7280ab6ad3cc4de602a423affd2ab9
 SHA512:
-  metadata.gz: afdad4817e8b8129c495e0c6e1f65f4825ed7ea07017f3eedbcf173e02dc04d112fb876886bad992f57ea864e218825de629a4e0f68b2954ec9204d3fb7203cf
-  data.tar.gz: a244c31492520e6fb16a2cd7b8f58f42eae995e7712d6b03feaefedc35d06228515201317ca493870140b83812cad9998f5b1a80ed6563f4f4a54be823a4a2a5
+  metadata.gz: 4087c2a9d82868d9cfddb61489235c59c4c52c6c02b5baa33a8717d24871e93b068a66a05dfa82cc9ec98f78f5c86035aaf1a55033c4dffba2454bf48b5a7382
+  data.tar.gz: 314532515763924052e2c9caa7a6581dec9a49dd6d02a203cd202ced631ad9236b70445c842ea28fa0dbe091186f5d3443a0d1297e7e4618ff60554a351e5c65

data/lib/api_blueprint.rb

@@ -80,7 +80,7 @@ class ApiBlueprint < RSpec::Core::Formatters::BaseFormatter
     end
     output.puts "# #{resource_name}"
 
-    http_verbs = actions.keys.map {|action| action.scan(/\[([A-Z]+).+\]/).flatten[0] }
+    http_verbs = actions.keys.map {|action| action.scan(/(GET|HEAD|POST|PATCH|PUT|DELETE|OPTIONS)/).flatten[0] }
 
     unless http_verbs.length == http_verbs.uniq.length
       raise "Action HTTP verbs are not unique #{actions.keys.inspect} for resource: '#{resource_name}'"

data/lib/api_blueprint/action_formatter.rb

@@ -60,7 +60,7 @@ module ApiBlueprintFormatter
     end
 
     def action_header(param, data)
-      param_signature = "#{param}#{param_attributes_string(data)}"
+      param_signature = "#{param}#{params_example_string(data)}#{param_attributes_string(data)}"
       multiline_description = !members(param).empty?
 
       header = "+ #{param_signature}"
@@ -75,6 +75,11 @@ module ApiBlueprintFormatter
       " (#{param_attributes.join(', ')})" unless param_attributes.empty?
     end
 
+    def params_example_string(data)
+      return '' unless data[:example]
+      ": #{data[:example]}"
+    end
+
     def members(param)
       @action_metadata[:parameters][param].fetch(:members, [])
     end

data/lib/api_blueprint/example_formatter.rb

@@ -30,13 +30,17 @@ module ApiBlueprintFormatter
       "\n" \
       "        #{example_metadata[:request][:parameters]}\n" \
       "\n" \
-      "        Location: #{example_metadata[:location]}\n" \
+      "        Location: #{format_location}\n" \
       "        Source code:\n" \
       "\n" \
       "#{indent_lines(8, example_metadata[:source])}\n" \
       "\n"
     end
 
+    def format_location
+      example_metadata[:location].gsub(/:\d+/,'') # remove line numbers from location
+    end
+
     def format_response
       "+ Response #{example_metadata[:response][:status]} (#{example_metadata[:request][:format]})\n" \
       "\n" \

data/lib/api_blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprintFormatter
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/api_blueprint/action_formatter_spec.rb

@@ -75,6 +75,24 @@ RSpec.describe ApiBlueprintFormatter::ActionFormatter do
         end
       end
 
+      context 'descriptive param with: type, optionality and example value' do
+        let(:action_parameters) do
+          {
+            amount: { description: 'Id of a post', type: :number, optional: true, example: 123 }
+          }
+        end
+
+        it do
+          is_expected.to eq <<-EOF
+#{action_header}
+
++ Parameters
+    + amount: 123 (number, optional) - Id of a post
+
+          EOF
+        end
+      end
+
       context 'descriptive param with: type, optionality, default value' do
         let(:action_parameters) do
           {

data/spec/api_blueprint/example_formatter_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe ApiBlueprintFormatter::ExampleFormatter do
 
   let(:request_metadata) { { parameters: {}, format: 'application/json' } }
   let(:response_metadata) { { status: 200, body: JSON.generate({a:1, b:2, c:3}) } }
-  let(:location) { "spec/api_blueprint/example_formatter_spec.rb" }
+  let(:location) { "spec/api_blueprint/example_formatter_spec.rb:42" }
   let(:source) { "it 'returns standard APi Blueprint format' do\n  ;\nend" }
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-blueprint-formatter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Nam Chu Hoai