acts_as_doc 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12a796bab9820e42c34cc94ad2029dff43521113e20a8686aed667c72a7f1c86
+  data.tar.gz: 7924b82d0461dd99417ed2757e653de560e2a884430586436d931e34f8c85c7d
+SHA512:
+  metadata.gz: cbc1030672261ae66675f1ebe0d6c7dfa6780f39adc32088a4375e3b51b07539ffbc09473b11a65f66749a8b38b692734637db6f5e3c8dfc5a403bddcb41a2f8
+  data.tar.gz: 3c615324dcbe8ef60ded241251633f40a92a86f4ce523a0eb08967f51e34b1725a86ff6074c0a5c9fecef5285a2a301ee6147f79b0dcfeb01f81d434faeab53d

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 RCC Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# acts-as-doc
+Add swagger comment to any ruby file for generating swagger response doc struct
+
+# Install
+
+Add this line to your application's Gemfile:
+
+```
+gem 'acts_as_doc', '~> 1.0'
+```
+
+# Usage
+
+```ruby
+class A
+  extend ActsAsDoc::Schema
+
+  # @prop [integer] :total Total
+end
+
+A.swagger_schema
+# => 
+{
+  'total' => {type: 'integer', description: 'Total'}  
+}
+```
+
+# Test
+
+Run Test Unit
+```
+rake test
+```
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+# # frozen_string_literal: true
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+desc "Run tests"
+task default: :test

data/acts_as_doc.gemspec

@@ -0,0 +1,13 @@
+# rubocop:disable all
+Gem::Specification.new do |s|
+  s.name        = "acts_as_doc"
+  s.version     = "1.0.1"
+  s.summary     = "Generate swagger response doc"
+  s.description = "Add swagger comment to any ruby file for generating swagger response doc struct"
+  s.authors     = ["alex.zang"]
+  s.email       = "alex.zang@rccchina.com"
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  s.homepage    = "https://github.com/rccgroup/acts-as-doc"
+  s.license     = "MIT"
+  s.required_ruby_version = '>= 2.7.0'
+end

data/lib/acts_as_doc/response_parser.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'ripper'
+
+module ActsAsDoc
+  # @success and @prop comment parser
+  class ResponseParser < Ripper::SexpBuilder
+    SUPPORT_TYPES = %w[
+      string
+      number
+      integer
+      boolean
+      array
+      object
+    ].freeze
+
+    REF_FLAG = '$'
+
+    # 处理注释
+    #
+    # @param token [String] one line of comments
+    def on_comment(token)
+      @comments ||= []
+      @comments << token[1..]
+    end
+
+    # Make props recursion
+    # @example
+    #   >> ActsAsDoc::ResponseParser.props_recursion!({}, '$a.$b.c', 'c', 'd')
+    #   # => {'a' => }
+    #
+    # @return [Hash] 处理过的hash
+    # rubocop:disable all
+    def self.props_recursion!(hash, name, type, desc)
+      arr = name.split('.')
+      name = arr.shift.sub(/^\$/, '')
+
+      hash[name] = {} unless hash.key?(name)
+
+      if arr.empty?
+        hash[name].merge!(type: type, description: desc)
+      else
+        nest_hash = hash[name]
+        nest_hash[:properties] = {} unless nest_hash.key?(:properties)
+        self.props_recursion!(nest_hash[:properties], arr.join('.'), type, desc)
+      end
+
+      hash
+    end
+
+    # @return [Hash] response schema
+    # rubocop:disable all
+    def schema
+      schema = {}
+      @comments.each do |comment|
+        comment.strip!
+        # Only need to deal with @success and @prop
+        next unless comment =~ /@(success|prop)/
+
+        arr = comment.split
+        tag, type, name = arr[..2]
+
+        if tag == '@prop'
+          desc = arr[3..] ? arr[3..].join(' ') : ''
+          matches = type.match(/\[(?<type>#{SUPPORT_TYPES.join('|')})\]/)
+          type = matches ? matches[:type] : 'string'
+
+          if name.start_with?(':')
+            name = name.sub(/^:/, '')
+            schema[name] = { type: type, description: desc }
+          end
+
+          if name.start_with?(REF_FLAG)
+            self.class.props_recursion!(schema, name, type, desc)
+          end
+        end
+      end
+      schema
+    end
+  end
+end

data/lib/acts_as_doc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative './acts_as_doc/response_parser'
+
+module ActsAsDoc
+  # Example:
+  #   class A
+  #     extend ActsAsDoc::Schema
+  #   end
+  #
+  #   >> A.swagger_schema
+  module Schema
+    # @return [Hash] Swagger schema hash
+    def swagger_schema
+      path = const_source_location(self.name).first
+      parser = ResponseParser.new(File.read(path))
+      parser.parse
+      parser.schema
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_doc
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- alex.zang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-09 00:00:00.000000000 Z
+dependencies: []
+description: Add swagger comment to any ruby file for generating swagger response
+  doc struct
+email: alex.zang@rccchina.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_doc.gemspec
+- lib/acts_as_doc.rb
+- lib/acts_as_doc/response_parser.rb
+homepage: https://github.com/rccgroup/acts-as-doc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.19
+signing_key: 
+specification_version: 4
+summary: Generate swagger response doc
+test_files: []