rspec_generate_doc 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c78c2b5388bf0e0fbd7a4375d0e025c88416f5f
-  data.tar.gz: 918962276786293057bd1ce6d10d3742a30181d1
+  metadata.gz: 0c49369c2b7339e0f05b9715b4310cbe5981f542
+  data.tar.gz: a2513fc805ea6ce5cb8528bfbf0575094e7c326f
 SHA512:
-  metadata.gz: 92e709b48ba9296ebfdd12540f1d66776d183350d09f5fc68e4e5866e5ff5536cce673be513106fad83197c529a7da204f321efc2897a1ea0edf8f3b84f9f5a8
-  data.tar.gz: 7b202a2a9ac5c58feac09c0f87b57a002941c8abc11c9b4ebdaac2b260c53ce6c039be6c34325cbbef593ebd7955d1648b3ee30e2da560c25f237f848538942b
+  metadata.gz: db03b1d90c4f16d56fe690f0a9c9ca61a348a3204014e00002a7a72bd69b8515f2bc7cd160d3abfb87cd2487e087a4c4f4ac0efed7db680e31dffb923529ece3
+  data.tar.gz: 73fd24165e5a3856cd203729c68b5f07b04f30878cd9c31af33d6877f100b9a52f20d17fdde9f40c75526b21bb74423ab9393e11d3282ef3647c3154bc369e96

data/README.md

@@ -43,16 +43,17 @@ Example use
 ...
 let(:api_params) do
   {
-    id: { description: 'user id', required: true },
-    email: { description: 'user email', required: false }
+    id: { name: 'alternative id name', description: 'user id', required: true },
+    email: { description: 'user email', required: 'if not id' }
   }
 end
 ...
 ```
 *keys description:*
-id | email - parameter in result
-description - description parameter. Default parent key name
-required - is parameter required? Default false
+id | email - Parameter name.
+name - Parameter name. Default parameter key name.
+description - description parameter. Default parameter key name.
+required - is parameter required? If the value type is boolean it will be translated to default language. If the value type is string then return it value.
 
 *skip add to api description*
 
@@ -65,6 +66,14 @@ context 'this case will be skipped' do
 end
 ...
 ```
+
+*alternative name to file and menu*
+``` ruby
+require 'rails_helper'
+
+RSpec.describe UserController, type: :controller, api_name: 'alternative_name' do
+...
+```
 **result**
 
 After tests completed file *_user_controller.md* will be created in docs folder.  In format to Slate

data/config/locales/en.yml

@@ -3,5 +3,5 @@ en:
     parameter: Parameter
     required: Required
     description: Description
-    required_yes: Yes
-    required_no: No
+    required_yes: 'Yes'
+    required_no: 'No'

data/lib/rspec_generate_doc/decorators/action.rb

@@ -8,7 +8,7 @@ module RspecGenerateDoc
         @name = (data[:name] || '').split('#').join(' ')
         @response = data[:response]
         @params = to_params(data[:api_params])
-        @options = OpenStruct.new(data[:opntions] || {})
+        @options = OpenStruct.new(data[:options] || {})
       end
 
       def request_method

data/lib/rspec_generate_doc/decorators/parameter.rb

@@ -5,13 +5,14 @@ module RspecGenerateDoc
 
       def initialize(data = {})
         @name = data[:name] || data['name']
-        @required = data[:required] || data['required'] || false
+        @required = data[:required] || data['required']
         @description = data[:description] || data['description'] || name || ''
         @options = OpenStruct.new(data[:options] || data['options'] || {})
       end
 
       def required_human
-        description ? I18n.t(:required_yes, scope: :rspec_api_docs) : I18n.t(:required_no, scope: :rspec_api_docs)
+        return required unless !!required == required
+        required ? I18n.t(:required_yes, scope: :rspec_api_docs) : I18n.t(:required_no, scope: :rspec_api_docs)
       end
     end
   end

data/lib/rspec_generate_doc/generate_file.rb

@@ -19,7 +19,8 @@ module RspecGenerateDoc
 
     def create_file_by_template
       file = File.open(file_path, 'w+')
-      file.write ERB.new(File.binread(configuration.template_file), nil, '-').result(binding).to_s.force_encoding('utf-8')
+      file.write ERB.new(File.binread(configuration.template_file), nil, '-').result(binding).to_s
+                    .force_encoding('utf-8')
       file.close
     end
 
@@ -30,7 +31,7 @@ module RspecGenerateDoc
     end
 
     def parent_name
-      @parent_name ||= parent.downcase.split('::').join('_')
+      @parent_name ||= parent.split('::').join('_').underscore
     end
 
     def template_name

data/lib/rspec_generate_doc/library_hooks/doc.rb

@@ -32,7 +32,7 @@ module RspecGenerateDoc
 
         config.after(:context) do
           next if @is_incorrect_type
-          parent = try(:parent_name) || @parent_name || self.class.top_level_description
+          parent = self.class.metadata[:api_name].to_s || self.class.top_level_description
           RspecGenerateDoc::GenarateFIle.new(parent: parent, actions: @actions).create_file_by_template
         end
       end

data/lib/rspec_generate_doc/templates/slate.md.erb

@@ -7,7 +7,8 @@
 <%= action.request_method %> <%= action.request_fullpath %> HTTP/1.1
 Host: <%= action.host %>
 User-Agent: ExampleClient/1.0.0
-  ``
+```
+
 ```http
 HTTP/1.1 <%= action.status %> <%= action.status_message %>
 <% if action.content_type? -%>
@@ -15,8 +16,11 @@ Content-Type: <%= action.content_type %>
 <% end -%>
 <%= action.body %>
 ```
+
+<% if action.params.any? -%>
 <%= I18n.t(:parameter, scope: :rspec_api_docs) %> | <%= I18n.t(:required, scope: :rspec_api_docs) %> | <%= I18n.t(:description, scope: :rspec_api_docs) %>
 -------- | ------- | -------
+<% end -%>
 <% action.params.each do |parametr| -%>
 <%= parametr.name %> | <%= parametr.required_human %> | <%= parametr.description %>
 <% end -%>

data/lib/rspec_generate_doc/version.rb

@@ -1,3 +1,3 @@
 module RspecGenerateDoc
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_generate_doc
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Igor Kutyavin