dox 0.0.3 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3017b4de18be018219c96ccc514f70cca773b8a
-  data.tar.gz: 9fd458348cb00703b8e4a0beb7ab5a962c0c50c7
+  metadata.gz: 9535d1b95849fc4c0dddff91c5ed6a35879d6505
+  data.tar.gz: c84f5af01e5de1524b533175a6141d67b995bee3
 SHA512:
-  metadata.gz: 60c5c361bcdaae16d47f468f524076f832ecf5fd86160378833e2700513d951e65fcaa11fb401af7bdbe1878e1b4b9164153b074c806e431a3cdbab298e783e4
-  data.tar.gz: b0b2c7871768c293b2ff487cc7f1e1fbc10df6b59009da3d0da5a8cf5509de97aca332ba8f78cc6f1aa621c34da8a658933717311a15a7e6d18f2c983f45000a
+  metadata.gz: a7ee68d768d9fbbf34708e1cbb901fee9dd532d09807cbd9ffa0abb60d08d80c08114014280390f8532788b68e517d29dc70ebdb6ab678057e0dbfc51566ad3d
+  data.tar.gz: 900ec7205240057d71ae6f8c1753aabe9d03d66375dbf167336b7444f2d5840969b1ed510cf25011963807c382c051976a7fb6189178ebe1335ed96370fab653

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/README.md

@@ -94,7 +94,7 @@ Descriptions folder is a fullpath of a folder that contains markdown files with
 
 ``` ruby
 Dox.configure do |config|
-  config.root_api_file = 'api.md'
+  config.header_file_path = 'api.md'
   config.desc_folder_path = Rails.root.join('spec/support/api_doc/v1/markdown_descriptions')
 end
 ```

data/dox.gemspec

@@ -29,4 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "rspec-core"
+  spec.add_runtime_dependency "rails", ">= 4.0"
 end

data/lib/dox.rb

@@ -1,23 +1,27 @@
-require "rspec/rails"
-require "dox/version"
-require "dox/config"
-require "dox/formatter"
-require "dox/dsl/attr_proxy"
-require "dox/dsl/action"
-require "dox/dsl/resource"
-require "dox/dsl/resource_group"
-require "dox/dsl/documentation"
-require "dox/dsl/syntax"
-require "dox/entities/action"
-require "dox/entities/example"
-require "dox/entities/resource"
-require "dox/entities/resource_group"
-require "dox/printers/base_printer"
-require "dox/printers/action_printer"
-require "dox/printers/document_printer"
-require "dox/printers/example_printer"
-require "dox/printers/resource_group_printer"
-require "dox/printers/resource_printer"
+require 'dox/config'
+require 'dox/dsl/attr_proxy'
+require 'dox/dsl/action'
+require 'dox/dsl/documentation'
+require 'dox/dsl/resource_group'
+require 'dox/dsl/resource'
+require 'dox/dsl/syntax'
+require 'dox/entities/action'
+require 'dox/entities/example'
+require 'dox/entities/resource_group'
+require 'dox/entities/resource'
+require 'dox/errors/file_not_found_error'
+require 'dox/errors/folder_not_found_error'
+require 'dox/errors/invalid_action_error'
+require 'dox/errors/invalid_resource_error'
+require 'dox/errors/invalid_resource_group_error'
+require 'dox/formatter'
+require 'dox/printers/base_printer'
+require 'dox/printers/action_printer'
+require 'dox/printers/document_printer'
+require 'dox/printers/example_printer'
+require 'dox/printers/resource_group_printer'
+require 'dox/printers/resource_printer'
+require 'dox/version'
 
 
 module Dox

data/lib/dox/config.rb

@@ -1,11 +1,16 @@
 module Dox
   class Config
 
-    attr_accessor :root_api_file, :desc_folder_path
+    attr_reader :header_file_path, :desc_folder_path
 
-    def initialize
-      @root_api_file = 'api.md'
-      @desc_folder_path = Rails.root.join('')
+    def header_file_path=(file_path)
+      raise(Errors::FileNotFoundError, file_path) unless File.exists?(file_path)
+      @header_file_path = file_path
+    end
+
+    def desc_folder_path=(folder_path)
+      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exists?(folder_path)
+      @desc_folder_path = folder_path
     end
 
   end

data/lib/dox/dsl/action.rb

@@ -9,26 +9,21 @@ module Dox
       attr_writer :desc
       attr_writer :params
 
-      def initialize(opts = {})
-        self.name = opts.fetch(:name, nil)
-        self.verb = opts.fetch(:verb, nil)
-        self.path = opts.fetch(:path, nil)
-        self.desc = opts.fetch(:desc, nil)
-        self.params = opts.fetch(:params, nil)
-      end
+      def initialize(name, &block)
+        self.name = name
+        instance_eval(&block) if block_given?
 
-      def param(signature)
-        params << signature
+        raise(Dox::Errors::InvalidActionError, 'Action name is required!') if @name.blank?
       end
 
       def config
-        Hash.new.tap do |config|
-          config[:action_name] = @name if @name
-          config[:action_verb] = @verb if @verb
-          config[:action_path] = @path if @path
-          config[:action_desc] = @desc if @desc
-          config[:action_params] = @params if @params
-        end
+        {
+          action_name: @name.presence,
+          action_verb: @verb.presence,
+          action_path: @path.presence,
+          action_desc: @desc.presence,
+          action_params: @params.presence
+        }
       end
     end
   end

data/lib/dox/dsl/documentation.rb

@@ -10,19 +10,16 @@ module Dox
         self.subject = opts.fetch :subject
       end
 
-      def resource(name = nil, &block)
-        self._resource = Resource.new(name: name)
-        _resource.instance_eval(&block)
+      def resource(name, &block)
+        self._resource = Resource.new(name, &block)
       end
 
-      def action(name = nil, &block)
-        self._action = Action.new(name: name)
-        _action.instance_eval(&block)
+      def action(name, &block)
+        self._action = Action.new(name, &block)
       end
 
-      def group(name = nil, &block)
-        self._group = ResourceGroup.new(name: name)
-        _group.instance_eval(&block)
+      def group(name, &block)
+        self._group = ResourceGroup.new(name: name, &block)
       end
 
       def config

data/lib/dox/dsl/resource.rb

@@ -5,24 +5,28 @@ module Dox
 
       attr_writer :name
       attr_writer :group
-      attr_writer :desc
       attr_writer :endpoint
 
-      def initialize(opts = {})
-        self.name = opts.fetch(:name, nil)
-        self.desc = opts.fetch(:desc, nil)
-        self.group = opts.fetch(:group, nil)
-        self.endpoint = opts.fetch(:endpoint, nil)
+      attr_writer :desc
+
+      def initialize(name, &block)
+        self.name = name
+
+        instance_eval(&block)
+
+        raise(Dox::Errors::InvalidResourceError, 'Resource name is required!') if @name.blank?
+        raise(Dox::Errors::InvalidResourceError, 'Resource group is required!') if @group.blank?
+        raise(Dox::Errors::InvalidResourceError, 'Resource endpoint is required!') if @endpoint.blank?
       end
 
       def config
-        {}.tap do |config|
-          config[:resource_name] = @name if @name
-          config[:resource_desc] = @desc if @desc
-          config[:resource_group_name] = @group if @group
-          config[:resource_endpoint] = @endpoint if @endpoint
-          config[:apidoc] = true
-        end
+        {
+          resource_name: @name.presence,
+          resource_desc: @desc.presence,
+          resource_group_name: @group.presence,
+          resource_endpoint: @endpoint.presence,
+          apidoc: true
+        }
       end
     end
   end

data/lib/dox/dsl/resource_group.rb

@@ -6,17 +6,19 @@ module Dox
       attr_writer :name
       attr_writer :desc
 
-      def initialize(opts = {})
-        self.name = opts.fetch(:name, nil)
-        self.desc = opts.fetch(:desc, nil)
+      def initialize(name, &block)
+        self.name = name
+        instance_eval(&block) if block_given?
+
+        raise(Dox::Errors::InvalidResourceGroupError, 'Resource group name is required!') if @name.blank?
       end
 
       def config
-        {}.tap do |config|
-          config[:resource_group_name] = @name if @name
-          config[:resource_group_desc] = @desc if @desc
-          config[:apidoc] = true
-        end
+        {
+          resource_group_name: @name.presence,
+          resource_group_desc: @desc.presence,
+          apidoc: true
+        }
       end
     end
   end

data/lib/dox/dsl/syntax.rb

@@ -3,30 +3,28 @@ module Dox
     module Syntax
       extend ActiveSupport::Concern
 
-      class_methods do
-        def document(subject, &block)
-          documentation = _subjects[subject] = Documentation.new(subject: subject)
-          documentation.instance_eval(&block)
-        end
+      def document(subject, &block)
+        documentation = _subjects[subject] = Documentation.new(subject: subject)
+        documentation.instance_eval(&block)
+      end
 
-        def const_missing(name)
-          documentation = _subjects[infer_subject(name)]
-          return super unless documentation
+      def const_missing(name)
+        documentation = _subjects[infer_subject(name)]
+        return super unless documentation
 
-          Module.new do
-            define_singleton_method :included do |base|
-              base.metadata.merge! documentation.config
-            end
+        Module.new do
+          define_singleton_method :included do |base|
+            base.metadata.merge! documentation.config
           end
         end
+      end
 
-        def infer_subject(name)
-          name.to_s.underscore.to_sym
-        end
+      def infer_subject(name)
+        name.to_s.underscore.to_sym
+      end
 
-        def _subjects
-          @_subjects ||= {}
-        end
+      def _subjects
+        @_subjects ||= {}
       end
     end
   end

data/lib/dox/entities/action.rb

@@ -1,18 +1,32 @@
 module Dox
   module Entities
     class Action
+      attr_reader :name, :desc, :verb, :path, :uri_params
+      attr_accessor :examples
 
-      attr_accessor :name, :desc, :verb, :path, :uri_params, :examples
-
-      def initialize(name, details)
+      def initialize(name, details, request)
+        @request = request
         @name = name
         @desc = details[:action_desc]
-        @verb = details[:action_verb]
-        @path = details[:action_path]
+        @verb = details[:action_verb] || request.method
+        @path = details[:action_path] || template_path
         @uri_params = details[:action_params]
         @examples = []
       end
 
+      private
+
+      attr_reader :request
+
+      def template_path
+        path_params = request.path_parameters.symbolize_keys.except(:action, :controller)
+        path = request.path.dup
+        path_params.each do |key, value|
+          # /pokemons/1 => pokemons/{id}
+          path.sub!(/\/#{value}(\/|$)/, "/{#{key}}\\1")
+        end
+        path
+      end
     end
   end
 end

data/lib/dox/entities/example.rb

@@ -19,7 +19,7 @@ module Dox
       end
 
       def request_identifier
-        fullpath
+        @desc
       end
 
       def response_status
@@ -34,15 +34,6 @@ module Dox
         response.body
       end
 
-      private
-
-      def fullpath
-        if request.query_parameters.present?
-          "#{request.path}?#{request.query_parameters.to_query}"
-        else
-          request.path
-        end
-      end
     end
   end
 end

data/lib/dox/entities/resource.rb

@@ -2,7 +2,8 @@ module Dox
   module Entities
     class Resource
 
-      attr_accessor :name, :desc, :endpoint, :actions
+      attr_reader :name, :desc, :endpoint
+      attr_accessor :actions
 
       def initialize(name, details)
         @name = name

data/lib/dox/errors/file_not_found_error.rb

@@ -0,0 +1,6 @@
+module Dox
+  module Errors
+    class FileNotFoundError < StandardError
+    end
+  end
+end

data/lib/dox/errors/folder_not_found_error.rb

@@ -0,0 +1,6 @@
+module Dox
+  module Errors
+    class FolderNotFoundError < StandardError
+    end
+  end
+end

data/lib/dox/errors/invalid_action_error.rb

@@ -0,0 +1,6 @@
+module Dox
+  module Errors
+    class InvalidActionError < StandardError
+    end
+  end
+end

data/lib/dox/errors/invalid_resource_error.rb

@@ -0,0 +1,6 @@
+module Dox
+  module Errors
+    class InvalidResourceError < StandardError
+    end
+  end
+end

data/lib/dox/errors/invalid_resource_group_error.rb

@@ -0,0 +1,6 @@
+module Dox
+  module Errors
+    class InvalidResourceGroupError < StandardError
+    end
+  end
+end

data/lib/dox/formatter.rb

@@ -49,7 +49,7 @@ module Dox
 
     def load_or_save_action_to_resource(resource)
       action_name = @current_example_data[:action_name]
-      resource.actions[action_name] ||= Entities::Action.new(action_name, @current_example_data)
+      resource.actions[action_name] ||= Entities::Action.new(action_name, @current_example_data, request)
     end
 
     def move_example_to_passed

data/lib/dox/printers/action_printer.rb

@@ -3,7 +3,7 @@ module Dox
     class ActionPrinter < BasePrinter
 
       def print(action)
-        @output.puts "### #{action.name}\n\n#{print_desc(action.desc)}\n\n"
+        @output.puts "### #{action.name} [#{action.verb} #{action.path}]\n\n#{print_desc(action.desc)}\n\n"
 
         if action.uri_params.present?
           @output.puts("+ Parameters\n#{formatted_params(action.uri_params)}")

data/lib/dox/printers/base_printer.rb

@@ -2,11 +2,8 @@ module Dox
   module Printers
     class BasePrinter
 
-      attr_reader :descriptions_folder_path
-
       def initialize(output)
         @output = output
-        @descriptions_folder_path = Dox.config.desc_folder_path
       end
 
       def print
@@ -15,17 +12,24 @@ module Dox
 
       private
 
-      def print_desc(desc)
-        return unless desc.present?
+      def descriptions_folder_path
+        Dox.config.desc_folder_path
+      end
+
+      def print_desc(desc, fullpath = false)
+        return if desc.blank?
 
         if desc.to_s =~ /.*\.md$/
-          path = descriptions_folder_path.join(desc).to_s
+          if fullpath
+            path = desc
+          else
+            path = descriptions_folder_path.join(desc).to_s
+          end
           "<!-- include(#{path}) -->"
         else
           desc
         end
       end
-
     end
   end
 end

data/lib/dox/printers/document_printer.rb

@@ -21,7 +21,7 @@ module Dox
       end
 
       def api_desc_path
-        Dox.config.root_api_file
+        Dox.config.header_file_path
       end
 
     end

data/lib/dox/printers/resource_printer.rb

@@ -3,11 +3,7 @@ module Dox
     class ResourcePrinter < BasePrinter
 
       def print(resource)
-        if resource.endpoint.present?
-          @output.puts "\n## #{resource.name} [#{resource.endpoint}]\n\n#{print_desc(resource.desc)}\n"
-        else
-          @output.puts "## #{resource.name}"
-        end
+        @output.puts "\n## #{resource.name} [#{resource.endpoint}]\n\n#{print_desc(resource.desc)}\n"
 
         resource.actions.each do |_, action|
           action_printer.print(action)

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = "0.0.3"
+  VERSION = "1.0.0.alpha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Melita Kokot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: 
 email:
 - melita.kokot@gmail.com
@@ -82,6 +124,11 @@ files:
 - lib/dox/entities/example.rb
 - lib/dox/entities/resource.rb
 - lib/dox/entities/resource_group.rb
+- lib/dox/errors/file_not_found_error.rb
+- lib/dox/errors/folder_not_found_error.rb
+- lib/dox/errors/invalid_action_error.rb
+- lib/dox/errors/invalid_resource_error.rb
+- lib/dox/errors/invalid_resource_group_error.rb
 - lib/dox/formatter.rb
 - lib/dox/printers/action_printer.rb
 - lib/dox/printers/base_printer.rb
@@ -106,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1