yard-api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53889bf365efd2b84350d070ea62220373d9dbeea679357d77f8d8037209e3e3
-  data.tar.gz: 957f57bd3f27845efe051f351c804269a82f104389cf0f6baffa1e179e14d221
+  metadata.gz: 6f9ac4cbeffaa2de7978493a2dee567b2961429daf4c44e36d88f799939b3951
+  data.tar.gz: d163d480697d3b23b479baec1087594d54f229813fd60de1b9f995146471b90f
 SHA512:
-  metadata.gz: 3d175c0645d4f7770969448d9f540ee6135e4192ed5bb196521a73a6d0b6b47158a8d7ca191c66ee1634a50ed319f590e60c8434fbe2accadc67937077365a3a
-  data.tar.gz: 6fbb88cacb7bf47ec0363e58a9f936f842188ab42d39379d3c131ca9a0b002f7480c6cf76395cab2aba8139d3289094097380e83377876ffeacd021a11e4a60e
+  metadata.gz: e5874aed23062b569f0703382f9fc50149322cf3c67a22123d68c8bcbfe1c46f42ea2760797e79551d4a89fc4d63246a8e72bbed00c002b7aee03c4ef5ca6993
+  data.tar.gz: d58e05d26f0a95c937c3deab4a985e4e7b2cc2bd5ec5153cee9385a29a1548dad1ea01d529e24c7862d86841ef8388c20bc833067345de47d7c46625567e19f8

data/lib/yard-api/options.rb

@@ -21,6 +21,7 @@ module YARD::APIPlugin
     default_attr :footer_note, ''
 
     default_attr :one_file, false
+    default_attr :include_internal, false
     default_attr :strict, false
     default_attr :verbose, ENV['VERBOSE'] || false
     default_attr :debug, ENV['DEBUG'] || false

data/lib/yard-api/verifier.rb

@@ -22,13 +22,14 @@ module YARD
       end
 
       def relevant_object?(object)
+        doc_include_internal = !!YARD::APIPlugin.options[:include_internal]
         case object.type
         when :root, :module, :constant
           false
         when :api
           true
         when :method
-          return false if object.has_tag?(:internal) || !object.has_tag?(:API)
+          return false if object.has_tag?(:internal) && !doc_include_internal || !object.has_tag?(:API)
           routes = @routes[object.object_id]
           routes ||= begin
             @routes[object.object_id] = YARD::Templates::Helpers::RouteHelper.routes_for_yard_object(object)
@@ -43,7 +44,7 @@ module YARD
 
           routes.any?
         when :class
-          return false if object.has_tag?(:internal) || !object.has_tag?(:API)
+          return false if object.has_tag?(:internal) && !doc_include_internal || !object.has_tag?(:API)
           true
         else
           object.parent.nil? && relevant_object?(object.parent)

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/spec/fulldoc_spec.rb

@@ -1,25 +1,5 @@
 require 'spec_helper'
 
-module YARD
-  module Serializers
-    # A serializer that writes data to standard output.
-    class SpecSerializer < Base
-      # Creates a serializer to print text to stdout
-      #
-      # @param [Fixnum, nil] wrap if wrap is a number, wraps text to +wrap+
-      #   columns, otherwise no wrapping is done.
-      def initialize(buffer)
-        @buffer = buffer
-      end
-
-      # Overrides serialize behaviour to write data to standard output
-      def serialize(object, data)
-        @buffer << data
-      end
-    end
-  end
-end
-
 describe YARD::Templates::Engine.template(:api, :fulldoc) do
   before do
     Registry.clear

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'json'
+require 'pry'
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this
@@ -15,7 +18,6 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-
   require File.join(File.dirname(__FILE__), '..', 'lib', 'yard-api')
 
   # rspec-expectations config goes here. You can use an alternate
@@ -123,3 +125,26 @@ RSpec.configure do |config|
     YARD.parse_string str if str
   end
 end
+
+
+module YARD
+  module Serializers
+    # A serializer that writes data to standard output.
+    class SpecSerializer < Base
+      attr_writer :basepath
+
+      # Creates a serializer to print text to stdout
+      #
+      # @param [Fixnum, nil] wrap if wrap is a number, wraps text to +wrap+
+      #   columns, otherwise no wrapping is done.
+      def initialize(buffer)
+        @buffer = buffer
+      end
+
+      # Overrides serialize behaviour to write data to standard output
+      def serialize(object, data)
+        @buffer << data
+      end
+    end
+  end
+end

data/spec/tags/internal_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe YARD::Templates::Engine.template(:api, :fulldoc) do
+  before(:each) do
+    YARD::Registry.clear
+  end
+
+  after(:each) do
+    YARD::Registry.clear
+  end
+
+  before(:each) do
+    populate <<-'eof'
+      # @API Quizzes
+      # @internal
+      class QuizzesController < ApplicationController
+      end
+    eof
+  end
+
+  let(:serializer) { YARD::Serializers::SpecSerializer.new([]) }
+  let(:verifier) { YARD::APIPlugin::Verifier.new }
+
+  it 'should hide entities marked with @internal' do
+    entities = YARD::Registry.all
+
+    YARD::Templates::Engine.render({
+      objects: entities,
+      type: :fulldoc,
+      template: :api,
+      format: :json,
+      serializer: serializer
+    })
+
+    expect(entities.size).to be > 0
+    expect(verifier.run(entities).size).to be == 0
+  end
+
+  context 'when the "include_internal" option is turned on...' do
+    before(:each) do
+      set_option(:include_internal, true)
+    end
+
+    it 'should not hide entities marked with @internal' do
+      populate <<-'eof'
+        # @API Quizzes
+        # @internal
+        class QuizzesController < ApplicationController
+        end
+      eof
+
+      entities = YARD::Registry.all
+
+      YARD::Templates::Engine.render({
+        objects: entities,
+        type: :fulldoc,
+        template: :api,
+        format: :json,
+        serializer: serializer
+      })
+
+      expect(entities.size).to be > 0
+      expect(verifier.run(entities).size).to eq(entities.size)
+    end
+  end
+end

data/templates/api/fulldoc/html/setup.rb

@@ -7,7 +7,7 @@ include YARD::Templates::Helpers::FilterHelper
 def init
   logger.info "YARD-API: starting."
 
-  options.serializer = YARD::APIPlugin::Serializer.new
+  options.serializer ||= YARD::APIPlugin::Serializer.new
   options.serializer.basepath = api_options.output
 
   options[:resources] = options.objects.

data/templates/api/fulldoc/json/setup.rb

@@ -129,15 +129,9 @@ def get_route(object)
   route = routes.first
 
   if route.present?
-    verb = if route.verb.source =~ /\^?(\w*)\$/
-      $1.upcase
-    else
-      route.verb.source
-    end
-
     {
-      path: route.path.spec.to_s.gsub("(.:format)", ""),
-      verb: verb
+      path: RouteHelper.get_route_path(route),
+      verb: RouteHelper.get_route_verb(route)
     }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -82,6 +82,7 @@ files:
 - spec/helpers/html_helper_spec.rb
 - spec/spec_helper.rb
 - spec/tags/argument_spec.rb
+- spec/tags/internal_spec.rb
 - tasks/yard_api.rake
 - templates/api/appendix/html/setup.rb
 - templates/api/appendix/json/setup.rb
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A YARD plugin for documenting APIs in Rails projects.