ld-eventsource 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e62fdcf615bb0c699746e63a929e5eb582b8680cf873659d2be9e7e018fb0a89
-  data.tar.gz: f5f2b5694a3049e4f5dc2fd5f49de948ab6a8d040151d506a5589b0da4bca0f6
+  metadata.gz: 14623ca76eeb863804646a598dec0a4f368bdd4fbf8875b7d5bb1be62c1845bd
+  data.tar.gz: 9c9d521d4e10f01f93f04431acfbbe2821434e99dd2738c09726827a84a96ed2
 SHA512:
-  metadata.gz: dd8ec3f6a4719860f1bf32bef767917a6b97753b8c9eb060c5478fa93b9115c3090313d5cfe4d00137dd1f764cb4bdfb3af000246718dd446691912f4c17ee1d
-  data.tar.gz: 23a6178d006572791caddbfb372bd9a4c68c5e9f32c272c7b3230008698744e973fcecee8d51b2bfc5471ba99f18190b95e0f074307b77dee81d1274b0416d07
+  metadata.gz: 4fccea73f41283286656e7a8ad8d10c72e0175b68a34499008d38d897d9a8828000d3f9cdb582dca682e182d1d0045240d0522fd9e28e72401410aad668a603d
+  data.tar.gz: c0756a730b152c06e7a1497703d1acdc0216a9ad8938798914fda239011d34d4c5bf521d51f3cf4f06829e6830befb550d9a47bf6d9fa19bda9ee3e2ba08972b

data/lib/ld-eventsource/client.rb

@@ -1,4 +1,5 @@
 require "ld-eventsource/impl/backoff"
+require "ld-eventsource/impl/buffered_line_reader"
 require "ld-eventsource/impl/event_parser"
 require "ld-eventsource/events"
 require "ld-eventsource/errors"
@@ -128,11 +129,12 @@ module SSE
           read: read_timeout,
           connect: connect_timeout
         })
-      @buffer = ""
+      @cxn = nil
       @lock = Mutex.new
 
       @backoff = Impl::Backoff.new(reconnect_time || DEFAULT_RECONNECT_TIME, MAX_RECONNECT_TIME,
         reconnect_reset_interval: reconnect_reset_interval)
+      @first_attempt = true
 
       @on = { event: ->(_) {}, error: ->(_) {} }
       @last_id = last_event_id
@@ -203,47 +205,14 @@ module SSE
     
     def reset_http
       @http_client.close if !@http_client.nil?
-      @cxn = nil
-      @buffer = ""
-    end
-    
-    def read_lines
-      Enumerator.new do |gen|
-        loop do
-          line = read_line
-          break if line.nil?
-          gen.yield line
-        end
-      end
-    end
-    
-    def read_line
-      loop do
-        @lock.synchronize do
-          i = @buffer.index(/[\r\n]/)
-          if !i.nil? && !(i == @buffer.length - 1 && @buffer[i] == "\r")
-            i += 1 if (@buffer[i] == "\r" && @buffer[i + 1] == "\n")
-            return @buffer.slice!(0, i + 1).force_encoding(Encoding::UTF_8)
-          end
-        end
-        return nil if !read_chunk_into_buffer
-      end
+      close_connection
     end
     
-    def read_chunk_into_buffer
-      # If @done is set, it means the Parser has signaled end of response body
-      @lock.synchronize { return false if @done }
-      begin
-        data = @cxn.readpartial
-      rescue HTTP::TimeoutError 
-        # We rethrow this as our own type so the caller doesn't have to know the httprb API
-        raise Errors::ReadTimeoutError.new(@read_timeout)
+    def close_connection
+      @lock.synchronize do
+        @cxn.connection.close if !@cxn.nil?
+        @cxn = nil
       end
-      return false if data == nil
-      @buffer << data
-      # We are piping the content through the parser so that it can handle things like chunked
-      # encoding for us. The content ends up being appended to @buffer via our callback.
-      true
     end
 
     def default_logger
@@ -255,13 +224,16 @@ module SSE
 
     def run_stream
       while !@stopped.value
-        @cxn = nil
+        close_connection
         begin
-          @cxn = connect
+          resp = connect
+          @lock.synchronize do
+            @cxn = resp
+          end
           # There's a potential race if close was called in the middle of the previous line, i.e. after we
           # connected but before @cxn was set. Checking the variable again is a bit clunky but avoids that.
           return if @stopped.value
-          read_stream(@cxn) if !@cxn.nil?
+          read_stream(resp) if !resp.nil?
         rescue => e
           # When we deliberately close the connection, it will usually trigger an exception. The exact type
           # of exception depends on the specific Ruby runtime. But @stopped will always be set in this case.
@@ -283,7 +255,8 @@ module SSE
     def connect
       loop do
         return if @stopped.value
-        interval = @backoff.next_interval
+        interval = @first_attempt ? 0 : @backoff.next_interval
+        @first_attempt = false
         if interval > 0
           @logger.info { "Will retry connection after #{'%.3f' % interval} seconds" } 
           sleep(interval)
@@ -326,7 +299,24 @@ module SSE
       # it can automatically reset itself if enough time passes between failures.
       @backoff.mark_success
 
-      event_parser = Impl::EventParser.new(read_lines)
+      chunks = Enumerator.new do |gen|
+        loop do
+          if @stopped.value
+            break
+          else
+            begin
+              data = cxn.readpartial
+            rescue HTTP::TimeoutError 
+              # For historical reasons, we rethrow this as our own type
+              raise Errors::ReadTimeoutError.new(@read_timeout)
+            end
+            break if data.nil?
+            gen.yield data
+          end
+        end
+      end
+      event_parser = Impl::EventParser.new(Impl::BufferedLineReader.lines_from(chunks))
+
       event_parser.items.each do |item|
         return if @stopped.value
         case item

data/lib/ld-eventsource/impl/buffered_line_reader.rb

@@ -0,0 +1,73 @@
+
+module SSE
+  module Impl
+    class BufferedLineReader
+      #
+      # Reads a series of data chunks from an enumerator, and returns an enumerator that
+      # parses/aggregates these into text lines. The line terminator may be CR, LF, or
+      # CRLF for each line; terminators are not included in the returned lines. When the
+      # input data runs out, the output enumerator ends and does not include any partially
+      # completed line.
+      #
+      # @param [Enumerator] chunks  an enumerator that will yield strings from a stream
+      # @return [Enumerator]  an enumerator that will yield one line at a time
+      #
+      def self.lines_from(chunks)
+        buffer = ""
+        position = 0
+        line_start = 0
+        last_char_was_cr = false
+
+        Enumerator.new do |gen|
+          chunks.each do |chunk|
+            buffer << chunk
+
+            loop do
+              # Search for a line break in any part of the buffer that we haven't yet seen.
+              i = buffer.index(/[\r\n]/, position)
+              if i.nil?
+                # There isn't a line break yet, so we'll keep accumulating data in the buffer, using
+                # position to keep track of where we left off scanning. We can also discard any previously
+                # parsed lines from the buffer at this point.
+                if line_start > 0
+                  buffer.slice!(0, line_start)
+                  line_start = 0
+                end
+                position = buffer.length
+                break
+              end
+
+              ch = buffer[i]
+              if i == 0 && ch == "\n" && last_char_was_cr
+                # This is just the dangling LF of a CRLF pair
+                last_char_was_cr = false
+                i += 1
+                position = i
+                line_start = i
+                next
+              end
+
+              line = buffer[line_start, i - line_start]
+              last_char_was_cr = false
+              i += 1
+              if ch == "\r"
+                if i == buffer.length
+                  last_char_was_cr = true # We'll break the line here, but be on watch for a dangling LF
+                elsif buffer[i] == "\n"
+                  i += 1
+                end
+              end
+              if i == buffer.length
+                buffer = ""
+                i = 0
+              end
+              position = i
+              line_start = i
+              gen.yield line
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ld-eventsource/impl/event_parser.rb

@@ -20,7 +20,8 @@ module SSE
       #
       # Constructs an instance of EventParser.
       #
-      # @param [Enumerator] lines  an enumerator that will yield one line of text at a time
+      # @param [Enumerator] lines  an enumerator that will yield one line of text at a time;
+      #   the lines should not include line terminators
       #
       def initialize(lines)
         @lines = lines
@@ -31,7 +32,6 @@ module SSE
       def items
         Enumerator.new do |gen|
           @lines.each do |line|
-            line.chomp!
             if line.empty?
               event = maybe_create_event
               reset_buffers
@@ -53,6 +53,7 @@ module SSE
         @id = nil
         @type = nil
         @data = ""
+        @have_data = false
       end
 
       def process_field(name, value)
@@ -60,8 +61,9 @@ module SSE
           when "event"
             @type = value.to_sym
           when "data"
-            @data << "\n" if !@data.empty?
+            @data << "\n" if @have_data
             @data << value
+            @have_data = true
           when "id"
             @id = value
           when "retry"
@@ -73,7 +75,7 @@ module SSE
       end
 
       def maybe_create_event
-        return nil if @data.empty?
+        return nil if !@have_data
         StreamEvent.new(@type || :message, @data, @id)
       end
     end

data/lib/ld-eventsource/version.rb

@@ -1,3 +1,3 @@
 module SSE
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,36 +107,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".ldrelease/circleci/linux/execute.sh"
-- ".ldrelease/circleci/mac/execute.sh"
-- ".ldrelease/circleci/template/build.sh"
-- ".ldrelease/circleci/template/gems-setup.sh"
-- ".ldrelease/circleci/template/prepare.sh"
-- ".ldrelease/circleci/template/publish.sh"
-- ".ldrelease/circleci/template/test.sh"
-- ".ldrelease/circleci/template/update-version.sh"
-- ".ldrelease/circleci/windows/execute.ps1"
-- ".ldrelease/config.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- ld-eventsource.gemspec
 - lib/ld-eventsource.rb
 - lib/ld-eventsource/client.rb
 - lib/ld-eventsource/errors.rb
 - lib/ld-eventsource/events.rb
 - lib/ld-eventsource/impl/backoff.rb
+- lib/ld-eventsource/impl/buffered_line_reader.rb
 - lib/ld-eventsource/impl/event_parser.rb
 - lib/ld-eventsource/version.rb
-- scripts/gendocs.sh
-- scripts/release.sh
-- spec/backoff_spec.rb
-- spec/client_spec.rb
-- spec/event_parser_spec.rb
-- spec/http_stub.rb
 homepage: https://github.com/launchdarkly/ruby-eventsource
 licenses:
 - Apache-2.0
@@ -156,12 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.29
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SSE client
-test_files:
-- spec/backoff_spec.rb
-- spec/client_spec.rb
-- spec/event_parser_spec.rb
-- spec/http_stub.rb
+test_files: []

data/.circleci/config.yml

@@ -1,39 +0,0 @@
-# This CircleCI configuration was generated by Releaser for a specific release. It is not to be used
-# for regular CI builds. Be aware that rerunning this build may cause it to repeat release actions
-# such as publishing to a package manager. However, it will not perform any Git actions other than
-# reading the repository.
-version: 2.1
-workflows:
-  test:
-    jobs:
-      - release_linux:
-          context: org-global
-jobs:
-  release_linux:
-    docker:
-      - image: cimg/ruby:2.5
-    environment:
-      LD_RELEASE_CIRCLECI_TYPE: linux
-      LD_RELEASE_BRANCH: "master"
-      LD_RELEASE_CIRCLECI_BRANCH: ""
-      LD_RELEASE_DOCS_GITHUB_PAGES: ""
-      LD_RELEASE_DOCS_TITLE: ""
-      LD_RELEASE_PROJECT: "ruby-eventsource"
-      LD_RELEASE_PROJECT_TEMPLATE: "ruby"
-      LD_RELEASE_VERSION: "2.1.0"
-    steps:
-      - checkout
-      - run:
-          name: "Releaser: prepare"
-          command: .ldrelease/circleci/mac/execute.sh prepare .ldrelease/circleci/template/prepare.sh
-      - run:
-          name: "Releaser: build"
-          command: .ldrelease/circleci/mac/execute.sh build .ldrelease/circleci/template/build.sh
-      - run:
-          name: "Releaser: test"
-          command: .ldrelease/circleci/mac/execute.sh test .ldrelease/circleci/template/test.sh
-      - run:
-          name: "Releaser: publish"
-          command: .ldrelease/circleci/mac/execute.sh publish .ldrelease/circleci/template/publish.sh
-      - store_artifacts:
-          path: artifacts

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem
-.DS_Store
-rspec
-Gemfile.lock

data/.ldrelease/circleci/linux/execute.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Performs a delegated release step in a CircleCI Linux container. This mechanism is described
-# in scripts/circleci/README.md. All of the necessary environment variables should already be
-# in the generated CircleCI configuration.
-
-mkdir -p artifacts
-
-export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
-mkdir -p ${LD_RELEASE_TEMP_DIR}
-
-STEP="$1"
-SCRIPT="$2"
-echo
-echo "[${STEP}] executing ${SCRIPT}"
-"./${SCRIPT}"

data/.ldrelease/circleci/mac/execute.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Performs a delegated release step in a CircleCI Mac container. This mechanism is described
-# in scripts/circleci/README.md. All of the necessary environment variables should already be
-# in the generated CircleCI configuration.
-
-mkdir -p artifacts
-
-export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
-mkdir -p ${LD_RELEASE_TEMP_DIR}
-
-STEP="$1"
-SCRIPT="$2"
-echo
-echo "[${STEP}] executing ${SCRIPT}"
-"./${SCRIPT}"

data/.ldrelease/circleci/template/build.sh

@@ -1,19 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Standard build.sh for Ruby-based projects that publish a gem
-
-echo "Using gem $(gem --version)"
-
-#shellcheck source=/dev/null
-source "$(dirname "$0")/gems-setup.sh"
-
-echo; echo "Installing dependencies"
-${BUNDLER_COMMAND} install
-
-# Build Ruby Gem - this assumes there is a single .gemspec file in the main project directory
-# Note that the gemspec must be able to get the project version either from $LD_RELEASE_VERSION,
-# or from somewhere in the source code that the project-specific update-version.sh has updated.
-echo "Running gem build"
-gem build ./*.gemspec || { echo "gem build failed" >&2; exit 1; }

data/.ldrelease/circleci/template/gems-setup.sh

@@ -1,16 +0,0 @@
-#!/bin/bash
-
-# helper script to set GEM_HOME, PATH, and BUNDLER_COMMAND for Ruby - must be sourced, not executed
-
-mkdir -p "${LD_RELEASE_TEMP_DIR}/gems"
-export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
-export PATH="${GEM_HOME}/bin:${PATH}"
-
-# also, determine whether we'll need to run a specific version of Bundler
-
-GEMSPEC_BUNDLER_VERSION=$(sed -n -e "s/.*['\"]bundler['\"], *['\"]\([^'\"]*\)['\"]/\1/p" ./*.gemspec | tr -d ' ')
-if [ -n "${GEMSPEC_BUNDLER_VERSION}" ]; then
-  BUNDLER_COMMAND="bundler _${GEMSPEC_BUNDLER_VERSION}_"
-else
-  BUNDLER_COMMAND="bundler"
-fi

data/.ldrelease/circleci/template/prepare.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-echo "Using gem $(gem --version)"
-
-#shellcheck source=/dev/null
-source "$(dirname "$0")/gems-setup.sh"
-
-# If the gemspec specifies a certain version of bundler, we need to make sure we install that version.
-echo "Installing bundler"
-if [ -n "${GEMSPEC_BUNDLER_VERSION:-}" ]; then
-  GEMSPEC_OPTIONS="-v ${GEMSPEC_BUNDLER_VERSION}"
-else
-  GEMSPEC_OPTIONS=""
-fi
-gem install bundler ${GEMSPEC_OPTIONS} || { echo "installing bundler failed" >&2; exit 1; }

data/.ldrelease/circleci/template/publish.sh

@@ -1,19 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Standard publish.sh for Ruby-based projects - we can assume build.sh has already been run
-
-#shellcheck source=/dev/null
-source "$(dirname "$0")/gems-setup.sh"
-
-# If we're running in CircleCI, the RubyGems credentials will be in an environment
-# variable and should be copied to the variable the gem command expects
-if [ -n "${LD_RELEASE_RUBYGEMS_API_KEY:-}" ]; then
-  export GEM_HOST_API_KEY="${LD_RELEASE_RUBYGEMS_API_KEY}"
-fi
-
-# Since all Releaser builds are clean builds, we can assume that the only .gem file here
-# is the one we just built
-echo "Running gem push"
-gem push ./*.gem || { echo "gem push failed" >&2; exit 1; }

data/.ldrelease/circleci/template/test.sh

@@ -1,10 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Standard test.sh for Ruby-based projects
-
-#shellcheck source=/dev/null
-source "$(dirname "$0")/gems-setup.sh"
-
-${BUNDLER_COMMAND} exec rspec spec

data/.ldrelease/circleci/template/update-version.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-set -ue
-
-# Standard update-version.sh for Ruby-based projects - this will work only if the version string
-# is in a source file under lib/ that has a line like his: VERSION = "2.0.0"
-
-"$(dirname "$0")/../update-version-constant.sh" lib '*.rb'

data/.ldrelease/circleci/windows/execute.ps1

@@ -1,19 +0,0 @@
-param(
-    [string]$step,
-    [string]$script
-)
-
-# Performs a delegated release step in a CircleCI Windows container using PowerShell. This
-# mechanism is described in scripts/circleci/README.md. All of the necessary environment
-# variables should already be in the generated CircleCI configuration.
-
-$ErrorActionPreference = "Stop"
-
-New-Item -Path "./artifacts" -ItemType "directory" -Force | Out-Null
-
-$env:LD_RELEASE_TEMP_DIR = "$env:TEMP\project-releaser-temp"
-New-Item -Path $env:LD_RELEASE_TEMP_DIR -ItemType "directory" -Force | Out-Null
-
-Write-Host
-Write-Host "[$step] executing $script"
-& "./$script"

data/.ldrelease/config.yml

@@ -1,22 +0,0 @@
-repo:
-  public: ruby-eventsource
-
-publications:
-  - url: https://rubygems.org/gems/ld-eventsource
-    description: RubyGems
-  - url: https://www.rubydoc.info/gems/ld-eventsource
-    description: documentation
-
-releasableBranches:
-  - name: master
-    description: 2.x - based on the http gem
-  - name: 1.x
-    description: 1.x - based on the socketry gem
-
-circleci:
-  linux:
-    image: cimg/ruby:2.5
-    context: org-global
-
-template:
-  name: ruby

data/CHANGELOG.md

@@ -1,35 +0,0 @@
-# Change log
-
-All notable changes to the LaunchDarkly SSE Client for Ruby will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
-
-## [2.0.1] - 2021-08-10
-### Changed:
-- The dependency version constraint for the `http` gem is now looser: it allows 5.x versions as well as 4.x. The breaking changes in `http` v5.0.0 do not affect `ld-eventsource`.
-- The project's build now uses v2.2.10 of `bundler` due to known vulnerabilities in other versions.
-- `Gemfile.lock` has been removed from source control. As this is a library project, the lockfile never affected application code that used this gem, but only affected the gem's own CI build. It is preferable for the CI build to refer only to the gemspec so that it resolves dependencies the same way an application using this gem would, rather than using pinned dependencies that an application would not use.
-
-## [2.0.0] - 2021-01-26
-### Added:
-- Added a `socket_factory` configuration option which can be used for socket creation by the HTTP client if provided. The value of `socket_factory` must be an object providing an `open(uri, timeout)` method and returning a connected socket.
-
-### Changed:
-- Switched to the `http` gem instead of `socketry` and a custom HTTP client.
-- Dropped support for Ruby < version 2.5
-- Dropped support for JRuby < version 9.2
-
-## [1.0.3] - 2020-03-17
-### Fixed:
-- The backoff delay logic for reconnecting after a stream failure was broken so that if a failure occurred after a stream had been active for at least `reconnect_reset_interval` (default 60 seconds), retries would use _no_ delay, potentially causing a flood of requests and a spike in CPU usage.
-
-## [1.0.2] - 2020-03-10
-### Removed:
-- Removed an unused dependency on `rake`. There are no other changes in this release.
-
-
-## [1.0.1] - 2019-07-10
-### Fixed:
-- Calling `close` on the client could cause a misleading warning message in the log, such as `Unexpected error from event source: #<IOError: stream closed in another thread>`.
-
-## [1.0.0] - 2019-01-03
-
-Initial release.

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/ld-eventsource.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ld-eventsource/version"
-
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
-  spec.name          = "ld-eventsource"
-  spec.version       = SSE::VERSION
-  spec.authors       = ["LaunchDarkly"]
-  spec.email         = ["team@launchdarkly.com"]
-  spec.summary       = "LaunchDarkly SSE client"
-  spec.description   = "LaunchDarkly SSE client for Ruby"
-  spec.homepage      = "https://github.com/launchdarkly/ruby-eventsource"
-  spec.license       = "Apache-2.0"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "2.2.10"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
-  spec.add_development_dependency "webrick", "~> 1.7"
-
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_runtime_dependency "http", ">= 4.4.1", "< 6.0.0"
-end

data/scripts/gendocs.sh

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-# Use this script to generate documentation locally in ./doc so it can be proofed before release.
-# After release, documentation will be visible at https://www.rubydoc.info/gems/ld-eventsource
-
-gem install --conservative yard
-gem install --conservative redcarpet  # provides Markdown formatting
-
-# yard doesn't seem to do recursive directories, even though Ruby's Dir.glob supposedly recurses for "**"
-PATHS="lib/*.rb lib/**/*.rb lib/**/**/*.rb"
-
-yard doc --no-private --markup markdown --markup-provider redcarpet --embed-mixins $PATHS - README.md