had 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db267458f5bae36246d3f0a3b3b479d94884460
-  data.tar.gz: 72b0dd4604f3b8bd240cdf96e459d5ef99047c1c
+  metadata.gz: 42ede04649baa5183ebe5f3de682f6b5b9456182
+  data.tar.gz: 49b469fdae7230489412c82f019ecd3b973705d6
 SHA512:
-  metadata.gz: cdbcd9ff09cc012638b003ffc176dd17d19808b1daff08048837d1919ed3d5350f818d7eba34f4e50b819366da9d10294530441c50d43b11aff1750b0c044935
-  data.tar.gz: 3951a608143dffd695a2447514d7baf47f676911009e3806e692526699b0f0a4a8887400a83d7450976efcdac3dcb605f556ced6fe00323bee88f8bf1b8e6983
+  metadata.gz: 58792ce4aa9616fe5316a492da9da5468d1c4fb2a651fdb5e084673427fc600d635a7eb21686e4c858d0a668590b16eab731d3ccc33089f5ec61dc6700412fb6
+  data.tar.gz: a8ded0d4a2adb62bab1a2a5ef047c42839732bd96450110e20726bfb9a05b710868e0aede00623b92a0001157c39bc3799aeecf12385aa4d926820f197b8b757

data/README.md

@@ -20,7 +20,10 @@ If necessary, add `require "had"` to your `spec/spec_helper.rb` file
 
 ## Usage
 
-by default `had` is not active (this may be configured!). To activate it, run `rspec` with
+Before start you need to setup environment.
+`export APP_ROOT=/path/to/your/application` 
+
+By default `had` is not active (this may be configured!). To activate it, run `rspec` with
 
 `HAD_RUN=1 bundle exec rspec --order=defined`
 
@@ -34,9 +37,6 @@ Documentation will be put into your application's `/doc` folder
   # @param category[title] required String Category title
   # @param category[weight] in which order Category will be shown
   # param text may also be multiline
-  # @method GET
-  # @path /example/path
-  # @host example.com
   def call(params)
     # action code
   end

data/lib/had/collector.rb

@@ -77,8 +77,9 @@ module Had
       if request.params.env && (request_params = request.params)
         action = request.class.name.split('::').last
         controller = request.class.name.split('::')[-2]
-        description, additional_info = get_action_description(controller, action)
+        description = get_action_description(controller, action)
         # description = request.class.to_s
+        routes_params = get_routes_params(controller, action)
         params = get_action_params(controller, action)
         query_parameters = request_params.to_h.reject { |p| %w[controller action format].include? p }
         backend_parameters = request_params.to_h.reject { |p| !%w[controller action format].include? p }
@@ -98,11 +99,11 @@ module Had
         description: description,
         params: params,
         request: {
-          host: additional_info['host'],
-          url: additional_info['host'] + additional_info['path'],
-          path: additional_info['path'],
-          symbolized_path: additional_info['host'] + additional_info['path'],
-          method: additional_info['method'],
+          host: Had.host,
+          url: Had.host + routes_params['path'],
+          path: routes_params['path'],
+          symbolized_path: Had.host + routes_params['path'],
+          method: routes_params['method'],
           query_parameters: query_parameters,
           backend_parameters: backend_parameters,
           body: request.instance_variable_get("@_body"),
@@ -261,6 +262,23 @@ module Had
       ['not found']
     end
 
+    # returns routes information
+    # example TODO
+    def get_routes_params(controller, action)
+      lines = File.readlines(File.join(Had.root, 'config', 'routes.rb'))
+      data = {}
+
+      lines.each do |line|
+        if line.match(/\s*#{controller.downcase}##{action.downcase}/)
+          array = line.split(' ')
+          data['method'] = array[0].upcase
+          data['path'] = array[1].split("'")[1]
+        end
+      end
+
+      data
+    end
+
     # returns description action comments
     # example TODO
     def get_action_description(controller, action)
@@ -278,16 +296,10 @@ module Had
               break
             end
           end
-        elsif line.match(/\s*# @method/)
-          info['method'] = line.split(' ').last
-        elsif line.match(/\s*# @path/)
-          info['path'] = line.split(' ').last
-        elsif line.match(/\s*# @host/)
-          info['host'] = line.split(' ').last
         end
       end
 
-      [description.join(' '), info]
+      description.join(' ')
     end
 
     # returns params action comments

data/lib/had/configuration.rb

@@ -20,12 +20,22 @@ module Had
     configuration.root
   end
 
+  def host
+    configuration.host
+  end
+
   class Configuration
     DEFAULT_FORMATTERS = %w(html json)
 
     def initialize
       Had.logger.level = Logger::INFO
 
+      if ENV['APP_HOST'].nil?
+        @host = "example.com"
+      else
+        @host = ENV['APP_HOST']
+      end
+
       if ENV['APP_ROOT'].nil?
         raise 'APP_ROOT is not defined'
       else
@@ -47,6 +57,6 @@ module Had
     attr_accessor :output_path
     attr_accessor :title
     attr_accessor :formatters
-    attr_reader :root
+    attr_reader :root, :host
   end
 end

data/lib/had/version.rb

@@ -1,3 +1,3 @@
 module Had
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/had.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'had/version'
 require 'had/utils'
 require 'had/configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: had
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - nsheremet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay