rspec_generate_doc 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e3232e70074556ac288756f0e58e844096a370
-  data.tar.gz: 2bb90de0ca26f57252a63bff701cef305ea8c9ac
+  metadata.gz: 8f1b535b856bbb662c5c00d849b5eea93f7e5b24
+  data.tar.gz: b0f41dc6755e8ac3383d01174428de31f48517b1
 SHA512:
-  metadata.gz: c9a9b4625df9726ef7bc37b77dfd7d392cbf935f761a66a6dd434a329b378cd91c36d7164bf17b1c494b04044826271394dc75aebf99dc633bb27a5ac6e7a2a0
-  data.tar.gz: 8516e8c822698f98ec5244fa83074ad4b0e36f5514af0b363001f2e7d6efe908c54ef9ef2d13e08068114b2d1b6fc09c4e8d89d7600ec7963fdcf38e6b1c128e
+  metadata.gz: 00523f36f4afa791dcfd10cee715694453d7e13691be071d88e6c921b3eff5c1e8e98c34b93de709873b644be635c408095c0bf8118bcd40cd39f19034d7af8d
+  data.tar.gz: caa362b4ea165600531ebfaf3e97dbdcab6ca4a523c2c640a2914207642784a7b9a195523bb8d67c47ae2417108f814dfd11c4b84e62d5ceffb9526f6fb2e176

data/README.md

@@ -28,6 +28,11 @@ require 'rspec_generate_doc'
 RspecGenerateDoc.configure do |config|
   config.docs_dir = 'path/to/docs/dir' # default: "#{Rails.root}/docs"
   config.locale = :ru # default: I18n.default_locale
+  config.action_decorator = My::Cool::ActionDecorator # default: RspecGenerateDoc::Decorators::Action
+  config.parameter_decorator = My::Cool::ParameterDecorator # default: RspecGenerateDoc::Decorators::Parameter
+  config.template_file = '/path/to/my/template.api.erb' # default:  "#{File.dirname(__FILE__)}/templates/slate.md.erb"
+  config.file_prefix = 'prefix_to_file_name_' # default:  '_'
+  config.file_suffix = '_suffix_to_file_name' # default:  ''
 end
 ```
 
@@ -36,7 +41,7 @@ Example use
 ``` ruby
 # spec/controllers/user_controller_spec.rb
 ...
-let(:params) do
+let(:api_params) do
   {
     id: { description: 'user id', required: true },
     email: { description: 'user email', required: false }

data/lib/rspec_generate_doc/configuration.rb

@@ -1,21 +1,36 @@
-require 'fileutils'
+require 'rspec_generate_doc/decorators/action'
+require 'rspec_generate_doc/decorators/parameter'
 
 module RspecGenerateDoc
   class Configuration
+    attr_writer :docs_dir, :locale, :action_decorator, :parameter_decorator, :template_file, :file_prefix, :file_suffix
+
     def docs_dir
       @docs_dir || "#{Rails.root}/docs"
     end
 
-    def docs_dir=(dir)
-      @docs_dir = dir
-    end
-
     def locale
       @locale || I18n.default_locale
     end
 
-    def locale=(locale)
-      @locale = locale
+    def action_decorator
+      @action_decorator || RspecGenerateDoc::Decorators::Action
+    end
+
+    def parameter_decorator
+      @parameter_decorator || RspecGenerateDoc::Decorators::Parameter
+    end
+
+    def template_file
+      @template_file || "#{File.dirname(__FILE__)}/templates/slate.md.erb"
+    end
+
+    def file_prefix
+      @file_prefix || '_'
+    end
+
+    def file_suffix
+      @file_suffix || ''
     end
   end
 end

data/lib/rspec_generate_doc/decorators/action.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module RspecGenerateDoc
+  module Decorators
+    class Action
+      attr_reader :name, :response, :params, :options
+      def initialize(data = {})
+        @name = (data[:name] || '').split('#').join(' ')
+        @response = data[:response]
+        @params = to_params(data[:api_params])
+        @options = OpenStruct.new(data[:opntions] || {})
+      end
+
+      def request_method
+        @request_method ||= request.request_method
+      end
+
+      def request_fullpath
+        @request_fullpath ||= request.original_fullpath.split('?').first
+      end
+
+      def host
+        @host ||= request.host
+      end
+
+      def status
+        @status ||= response.status
+      end
+
+      def status_message
+        @status_message ||= response.status_message
+      end
+
+      def status_with_message
+        @status_with_message ||= "#{status} #{status_message}"
+      end
+
+      def content_type
+        @content_type ||= response.content_type
+      end
+
+      def content_type?
+        content_type.present?
+      end
+
+      def body
+        @body ||= json_object.nil? ? response.body.to_s : JSON.pretty_generate(json_object)
+      end
+
+      private
+
+      def to_params(api_params)
+        api_params.map do |name, value|
+          hash = value.is_a?(Hash) ? value : {}
+          hash[:name] = name unless hash[:name] || hash['name']
+          RspecGenerateDoc.configuration.parameter_decorator.new(hash)
+        end
+      end
+
+      def json_object
+        @json_object ||= JSON.parse(response.body) rescue nil
+      end
+
+      def request
+        @request ||= response.request
+      end
+    end
+  end
+end

data/lib/rspec_generate_doc/decorators/parameter.rb

@@ -0,0 +1,18 @@
+module RspecGenerateDoc
+  module Decorators
+    class Parameter
+      attr_reader :name, :required, :description, :options
+
+      def initialize(data = {})
+        @name = data[:name] || data['name']
+        @required = data[:required] || data['required'] || false
+        @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)
+      end
+    end
+  end
+end

data/lib/rspec_generate_doc/generate_file.rb

@@ -0,0 +1,52 @@
+require 'erb'
+require 'fileutils'
+
+module RspecGenerateDoc
+  class GenarateFIle
+    TEMPLATE_EXTNAME = 'erb'.freeze
+
+    attr_reader :actions, :parent
+
+    def initialize(data = {})
+      @actions = data[:actions]
+      @parent = data[:parent]
+      I18n.locale = configuration.locale
+    end
+
+    def self.source_root
+      configuration.docs_dir
+    end
+
+    def create_file_by_template
+      file = File.open(file_path, 'w+')
+      file.write ERB.new(File.binread(configuration.template_file), nil, '-').result(binding)
+      file.close
+    end
+
+    private
+
+    def file_path
+      "#{dir}/#{configuration.file_prefix}#{parent_name}#{configuration.file_suffix}.#{file_extension}"
+    end
+
+    def parent_name
+      @parent_name ||= parent.downcase.split('::').join('_')
+    end
+
+    def template_name
+      @template_name ||= configuration.template_file.split('/').last
+    end
+
+    def file_extension
+      @file_extension ||= template_name.sub(/#{TEMPLATE_EXTNAME}$/, "").split('.').last
+    end
+
+    def dir
+      @dir ||= FileUtils.mkdir_p(configuration.docs_dir).join('')
+    end
+
+    def configuration
+      @configuration ||= RspecGenerateDoc.configuration
+    end
+  end
+end

data/lib/rspec_generate_doc/library_hooks/doc.rb

@@ -1,29 +1,37 @@
 require 'rspec/rails'
-require 'rspec_generate_doc/generate'
+require 'rspec_generate_doc/generate_file'
+require 'rspec_generate_doc/decorators/action'
 
 module RspecGenerateDoc
   module LibraryHooks
     module Doc
       ::RSpec.configure do |config|
         config.before(:context) do
-          @hash = {}
+          @actions = []
+          @is_correct_type = self.class.metadata[:type] == :controller
         end
 
         config.after(:each) do
-          key = self.class.description
+          next unless @is_correct_type
+          name = self.class.description
           parent = self.class.parent
           loop do
             break if parent.nil? || parent.description == self.class.top_level_description
-            key = "#{parent.description} #{key}"
+            name = "#{parent.description} #{name}"
             parent = parent.parent
           end
 
-          skip = try(:skip_this) || @skip_this
-          @hash[key] ||= { response: response, params: (try(:params) || @params || {}) } unless skip
+          next if try(:skip_this) || @skip_this
+          api_params = try(:api_params) || @api_params || {}
+          opntions = try(:api_opntions) || @api_opntions || {}
+          @actions << RspecGenerateDoc.configuration.action_decorator
+                                      .new(name: name, response: response, api_params: api_params, options: opntions)
         end
 
         config.after(:context) do
-          RspecGenerateDoc::Genarate.new(self.class.top_level_description, @hash)
+          next unless @is_correct_type
+          parent = self.class.top_level_description
+          RspecGenerateDoc::GenarateFIle.new(parent: parent, actions: @actions).create_file_by_template
         end
       end
     end

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

@@ -0,0 +1,24 @@
+# <%= parent %>
+
+<% actions.each do |action| -%>
+#<%= action.name %>
+
+```http
+<%= 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? -%>
+Content-Type: <%= action.content_type %>
+<% end -%>
+<%= action.body %>
+```
+<%= I18n.t(:parameter, scope: :rspec_api_docs) %> | <%= I18n.t(:required, scope: :rspec_api_docs) %> | <%= I18n.t(:description, scope: :rspec_api_docs) %>
+-------- | ------- | -------
+<% action.params.each do |parametr| -%>
+<%= parametr.name %> | <%= parametr.required_human %> | <%= parametr.description %>
+<% end -%>
+
+<% end -%>

data/lib/rspec_generate_doc/version.rb

@@ -1,3 +1,3 @@
 module RspecGenerateDoc
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/rspec_generate_doc.rb

@@ -1,8 +1,6 @@
 require 'rspec/rails'
-require 'rspec_generate_doc/version'
 require 'rspec_generate_doc/configuration'
 require 'rspec_generate_doc/library_hooks/doc'
-require 'rspec_generate_doc/generate'
 
 module RspecGenerateDoc
   extend self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_generate_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Kutyavin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,8 +71,11 @@ files:
 - config/locales/ru.yml
 - lib/rspec_generate_doc.rb
 - lib/rspec_generate_doc/configuration.rb
-- lib/rspec_generate_doc/generate.rb
+- lib/rspec_generate_doc/decorators/action.rb
+- lib/rspec_generate_doc/decorators/parameter.rb
+- lib/rspec_generate_doc/generate_file.rb
 - lib/rspec_generate_doc/library_hooks/doc.rb
+- lib/rspec_generate_doc/templates/slate.md.erb
 - lib/rspec_generate_doc/version.rb
 - rspec_generate_doc.gemspec
 homepage: https://github.com/jokius/rspec_generate_doc
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Generate documentation api of rspec tests

data/lib/rspec_generate_doc/generate.rb

@@ -1,77 +0,0 @@
-require 'fileutils'
-
-module RspecGenerateDoc
-  class Genarate
-    attr_reader :parent, :methods_hash
-
-    def initialize(parent, methods_hash)
-      @parent = parent
-      @methods_hash = methods_hash
-      I18n.locale = RspecGenerateDoc.configuration.locale
-      create_file
-    end
-
-    private
-
-    def dir
-      @dir ||= FileUtils.mkdir_p(RspecGenerateDoc.configuration.docs_dir).join('')
-    end
-
-    def create_file
-      file = File.open("#{dir}/_#{parent_name}.md", 'w+')
-      file.write file_text
-      file.close
-    end
-
-    def parent_name
-      @parent_name ||= parent.downcase.split('::').join('_')
-    end
-
-    def file_text
-      file_text = "# #{parent}\r\n\r\n"
-      methods_hash.each do |key, method|
-        response = method[:response]
-        request = response.request
-        file_text += "##{key.split('#').join(' ')}\r\n\r\n"\
-                  "```http\r\n"\
-                  "#{request.request_method} #{request.original_fullpath.split('?').first} HTTP/1.1\r\n"\
-                  "Host: #{response.request.host}\r\n"\
-                  "User-Agent: ExampleClient/1.0.0\r\n"\
-                  "```\r\n\r\n"\
-                  "```http\r\n"\
-                  "HTTP/1.1 #{response.status} #{response.status_message}\r\n"
-        file_text += "Content-Type: #{response.content_type}\r\n\r\n" if response.content_type.present?
-        if response.body.present?
-          object = begin
-                     JSON.parse(response.body)
-                   rescue
-                     nil
-                   end
-          body = object.nil? ? response.body : JSON.pretty_generate(object)
-          file_text += "#{body}\r\n" if response.body.present?
-        end
-
-        file_text += "```\r\n\r\n"\
-                  "#{I18n.t(:parameter, scope: :rspec_api_docs)} | #{I18n.t(:required, scope: :rspec_api_docs)} | #{I18n.t(:description, scope: :rspec_api_docs)}\r\n"\
-                  "-------- | ------- | -------\r\n"
-        file_text += params_to_text(request, method[:params])
-        file_text += "\r\n\r\n"
-      end
-
-      file_text
-    end
-
-    def params_to_text(request, params)
-      file_text = ''
-      request.params.except(*%i(controller action format)).each do |name, _|
-        hash = params[name.to_sym] || {}
-        hash = {} unless hash.is_a? Hash
-        required = hash[:required] ? I18n.t(:required_yes, scope: :rspec_api_docs) : I18n.t(:required_no, scope: :rspec_api_docs)
-        description = hash[:description] || name
-        file_text += "#{name} | #{required} | #{description}\r\n"
-      end
-
-      file_text
-    end
-  end
-end