had 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 815e72bed93c8a8b24069dc1b26423f6ea67dc89
-  data.tar.gz: 6df42d18f2cf63f08f42ddedbb1f99c0c4591191
+  metadata.gz: b5a234619e796d00f776e724aa52d8a0cc61b01c
+  data.tar.gz: 5f63a7cffb3842ef0acbdd03f2b2715bc763e541
 SHA512:
-  metadata.gz: af0ea4fecbe1ed4c767c4d82cb632ff46bfbc178a70fe65911eafc0148983a4d681e6c00d6869405001841aca109752b44399f16af5e5312db769abeb1330c8f
-  data.tar.gz: 199ca8b9e13c50d8ae62680a03eba1f06a319d601155c789425858c62652488d4c99854c6d0ff800c864bcf13bcad856638eb1e1116fa51ff0338c024679e6f9
+  metadata.gz: c2166be48e66cb2438fd2dafc5518a5bdc432c9c1dd8eca8d1a489d6048dde0a62950b8e2fcc049dc6c398802f740752b9b8ac021db7414de18e4329fb339765
+  data.tar.gz: 22d1b5aa63e2d67df4674b68965ca9d308eca8ebf7c6a686990fcaaa597e61e51fdc3c5242724087280f2c6b4a0a0797c257abd7cc3f59998e7cce8a9cd092bb

data/README.md

@@ -21,7 +21,7 @@ If necessary, add `require "had"` to your `spec/spec_helper.rb` file
 ## Usage
 
 Before start you need to setup environment.
-`export APP_ROOT=/path/to/your/application` 
+`export APP_ROOT=/path/to/your/application`
 
 By default `had` is not active (this may be configured!). To activate it, run `rspec` with
 
@@ -32,19 +32,23 @@ Documentation will be put into your application's `/doc` folder
 ### Sample controller action
 
 ```ruby
+  params do
+    required(:book).schema do
+      required(:author).filled(:str?) # This is params description
+      required(:title).filled(:str?)  # Can be empty
+    end
+  end
+
   # @description creates Category from given parameters
   # description text may be multiline
-  # @param category[title] required String Category title
-  # @param category[weight] in which order Category will be shown
+  # @param book[author] required String | You can use this params
+  # @param book[title] in which order   | if you did't using dry-validation
   # param text may also be multiline
   def call(params)
     # action code
   end
 ```
 
-Description param text is started with `@description` and may be multiline.
-Each param text is started with `@param` and first word will be param name, then optionally `required`, then optionally type (`Integer`, `String` etc), and finally param description, which may be multiline as well.
-
 ### Sample rspec test
 
 ```ruby
@@ -133,7 +137,7 @@ end
 ```
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b my_new_feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin my_new_feature`)
 5. Create new Pull Request

data/lib/had/collector.rb

@@ -305,10 +305,17 @@ module Had
     # returns params action comments
     # example TODO
     def get_action_params(controller, action)
-      comment_lines = get_action_comments(controller, action)
+      # This way using for getting params from parsing dry-validation schemes
+      params_lines = get_params_lines(controller, action)
+      comments = get_params_comments(params_lines)
+
+      return comments unless comments.empty?
 
+      # This way using for getting params form comments
+      comment_lines = get_action_comments(controller, action)
       comments_raw = []
       has_param = false
+
       comment_lines.each do |line|
         if line.match(/\s*#\s*@param/) # @param id required Integer blah blah
           has_param = true
@@ -342,6 +349,89 @@ module Had
       comments
     end
 
+    # return params comments parsed from params_lines
+    # example TODO
+    def get_params_comments(params_lines)
+      parent_params = nil
+      comments = []
+
+      params_lines.each do |line|
+        if line.match(/\s*(required|optional)\(:\w*\)\.\w*/) &&
+            !line.match(/\s*(required|optional)\(:\w*\)\.\w*\s(do)/)
+
+          name = line.split('(')[1].split(')')[0].tr(':', '')
+          required = line.match(/\s(required|optional)/).to_s.strip
+          description = line.match(/\s*#/) ? line.split('#').last.strip : '--'
+
+          type = if line.match(/\s*(required|optional)\(:\w*\)\.\w*\(:\w*\?\)/)
+            line.split('(')[2].split(')')[0].tr(':?', '')
+          else
+            'Any'
+          end
+
+          name = "#{parent_params}[#{name}]" unless parent_params.nil?
+
+          comments << {
+            name: name,
+            required: required,
+            type: type,
+            description: description
+          }
+        end
+
+        parent_params = false if line.match(/\s(end)/)
+
+        if line.match(/\s*(required|optional)\(:\w*\)\.\w*\s(do)/)
+          str = line.split('(')[1].split(')')[0].tr(':', '')
+
+          if parent_params.nil?
+            parent_params = str
+          else
+            parent_params = "#{parent_params}[#{str}]"
+          end
+        end
+      end
+
+      comments
+    rescue Exception
+      []
+    end
+
+    # returns dry-validations params lines
+    # example TODO
+    def get_params_lines(controller, action)
+      lines = File.readlines(File.join(Had.root, 'app', 'controllers', "#{controller.underscore}", "#{action.underscore}.rb"))
+      params_lines = []
+      params_begins = false
+      ends_left = 0
+
+      lines.each_with_index do |line, index|
+        if line.match(/\s*params do/)
+          params_lines << line
+          params_begins = true
+          ends_left += 1
+
+          next
+        end
+
+        if params_begins
+          params_lines << line
+
+          if line.match(/\s*do/)
+            ends_left += 1
+          elsif line.match(/\s*end/)
+            ends_left -= 1
+          end
+        end
+
+        params_begins = false if ends_left <= 0
+      end
+
+      params_lines
+    rescue Exception
+      {}
+    end
+
     def cleanup_header(key)
       key.to_s.sub(/^HTTP_/, '').underscore.split('_').map(&:capitalize).join('-')
     end

data/lib/had/version.rb

@@ -1,3 +1,3 @@
 module Had
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: had
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - nsheremet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -115,7 +115,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: Generates API documentation for integration tests written with RSpec for