prawn-dev 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c4786b4cb0c1925fa2f5422e2a981e8dcb332ae60c955911653ddbad46b4f1f
-  data.tar.gz: 9e590a9400bc77b10280a9e7c6692bce5eb913290cdcaa1bf948d0c5d2941ad1
+  metadata.gz: 0e001fdf15ba461fb80cf6bf5c552b387d35b38bfdaf1f7b452242bbcf8aa8a3
+  data.tar.gz: 840114726af26d000ee361e1a889abbcf29a99f4cd266ffbda04d1db6ac4ff38
 SHA512:
-  metadata.gz: 726543f165e577518f63da127ffe83b72cfcb956d56cd4979fde4e2b8a1beba1f11475e1d1e69c80e496f687e4c9e2d9ae258c8c67572f2fecfedcac14cb766b
-  data.tar.gz: 26fed79a6f74bba1565131d9e556a85d7cde3fe6509d52aa3a00cd814d8871c89530bd49e26a41ace7b9163455b476b17a3545f9cfd8fac59f75bd1a8a370da6
+  metadata.gz: 28370a98a9791b0dfa6fb7985ad97f6d9d66646863a926a64348407b2f6db2b9998ad0249ca53699fe6221d7a7028d2f99942797c62a91c837d107fd0f245627
+  data.tar.gz: 60276b7b8db038441c2268fdf26cc04ef5bc14bea4b21a3178f1eaacd8d0e0d3a67aabd90d286c27e0b2fa90551abecffc6d79cba1440194a052e661ff3d647f

data/lib/prawn/dev/tasks.rb

@@ -35,12 +35,50 @@ RSpec::Core::RakeTask.new('spec') do |c|
 end
 
 require 'yard'
+YARD_OPTIONS = [
+  '--output-dir', 'doc/html',
+  '--verbose', '--debug',
+  '--load', File.expand_path('yard_markup.rb', __dir__),
+  '--markup', 'markdown',
+  '--markup-provider', 'prawn/dev/yard_markup/document',
+  '--use-cache',
+]
 
 YARD::Rake::YardocTask.new do |t|
-  t.options = ['--output-dir', 'doc/html']
+  t.options = YARD_OPTIONS + t.options
+  t.stats_options = ['--list-undoc', '--compact']
 end
 task docs: :yard
 
+require 'fileutils'
+def stash_yardopts
+  if File.exist?('.yardopts')
+    begin
+      original_opts = Shellwords.shellsplit File.read('.yardopts')
+      require('securerandom')
+      backup_file = ".yardopts-#{SecureRandom.alphanumeric(16)}.backup"
+      FileUtils.move('.yardopts', backup_file)
+      yield original_opts
+    ensure
+      FileUtils.move(backup_file, '.yardopts')
+    end
+  else
+    yield []
+  end
+end
+
+desc 'Generate YARD Documentation continuously'
+task :yard_watch do
+  yard_server = YARD::CLI::Server.new
+  stash_yardopts do |original_opts|
+    File.open('.yardopts', 'w') do |yardopts|
+      yardopts.write((YARD_OPTIONS + original_opts).shelljoin)
+      yardopts.fsync
+      yard_server.run('--reload')
+    end
+  end
+end
+
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new

data/lib/prawn/dev/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module Dev
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/prawn/dev/yard_markup/code_highlight.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'rouge'
+
+module Prawn
+  module Dev
+    module YardMarkup
+      module CodeHighlight
+        def html_syntax_highlight_ruby(source)
+          converter =
+            Kramdown::Converter::Html.__send__(
+              :new,
+              nil,
+              Prawn::Dev::YardMarkup::Document.new('').default_options,
+            )
+
+          el = Kramdown::Element.new(:codeblock, source, { lang: 'ruby' })
+          converter.convert(el, 0)
+        end
+        alias html_markup_ruby html_syntax_highlight_ruby
+
+        # Do nothing
+        def parse_codeblocks(html)
+          html
+        end
+      end
+    end
+  end
+end

data/lib/prawn/dev/yard_markup/document.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'kramdown-parser-gfm'
+require 'rouge'
+
+module Prawn
+  module Dev
+    module YardMarkup
+      class CodeFormatter < ::Rouge::Formatter
+        def initialize(opts = {})
+          @opts = opts
+          @formatter =
+            if opts[:inline_theme]
+              ::Rouge::Formatters::HTMLInline.new(opts[:inline_theme])
+            else
+              ::Rouge::Formatters::HTML.new
+            end
+        end
+
+        def stream(tokens, &block)
+          yield %(<pre><code>) unless @opts[:inline]
+          @formatter.stream(tokens, &block)
+          yield '</code></pre>' unless @opts[:inline]
+        end
+      end
+
+      class Document < Kramdown::Document
+        def initialize(source, options = {})
+          super(source, default_options.merge(options))
+        end
+
+        def default_options
+          {
+            input: 'GFM',
+            hard_wrap: false,
+            syntax_highlighter: :rouge,
+            syntax_highlighter_opts: {
+              default_lang: 'ruby',
+              block: { formatter: CodeFormatter },
+              span: { formatter: CodeFormatter, inline: true },
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/prawn/dev/yard_markup.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'yard_markup/code_highlight'
+
+module Prawn
+  module Dev
+    module YardMarkup
+      YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown].push(
+        { lib: :'prawn/dev/yard_markup/document', const: 'Prawn::Dev::YardMarkup::Document' }
+      )
+      YARD::Templates::Engine.register_template_path File.expand_path('../../../templates', __dir__)
+
+      YARD::Templates::Helpers::HtmlHelper.prepend Prawn::Dev::YardMarkup::CodeHighlight
+    end
+  end
+end

data/lib/rubocop/cop/prawn/style/trailing_comma_fix.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Prawn
+      module Style
+        module TrailingCommaFix
+          def should_have_comma?(style, node)
+            if style == :prawn_comma
+              node.loc.begin.line != node.loc.end.line # parens are on different lines
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/prawn_cops.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'prawn/style/trailing_comma_fix'
+
+RuboCop::Cop::Style::TrailingCommaInArguments.prepend(RuboCop::Cop::Prawn::Style::TrailingCommaFix)
+RuboCop::Cop::Style::TrailingCommaInArrayLiteral.prepend(RuboCop::Cop::Prawn::Style::TrailingCommaFix)
+RuboCop::Cop::Style::TrailingCommaInBlockArgs.prepend(RuboCop::Cop::Prawn::Style::TrailingCommaFix)
+RuboCop::Cop::Style::TrailingCommaInHashLiteral.prepend(RuboCop::Cop::Prawn::Style::TrailingCommaFix)
+
+%w[
+  Style/TrailingCommaInArguments
+  Style/TrailingCommaInArrayLiteral
+  Style/TrailingCommaInBlockArgs
+  Style/TrailingCommaInHashLiteral
+].each do |cop_name|
+  RuboCop::ConfigLoader.default_configuration[cop_name]['SupportedStylesForMultiline']&.append('prawn_comma')
+end