RubyGems - qiita_org - Versions diffs - 0.1.22 → 0.1.27 - Mend

qiita_org 0.1.22 → 0.1.27

Files changed (1633) hide show

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/fulldoc/html/js/app.js ADDED

@@ -0,0 +1,33 @@
+function generateTOC() {
+  if ($('#filecontents').length == 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+  for (i in tags) { tags[i] = '#filecontents > ' + tags[i] }
+  var lastTag = parseInt(tags[0][1]);
+  $(tags.join(', ')).each(function() {
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1]);
+    if (this.id.length == 0) {
+      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+      if ($('#' + proposedId).length > 0) proposedId += counter++;
+      this.id = proposedId;
+    }
+    if (thisTag > lastTag) {
+      for (var i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  $('#toc').append()
+  $('#toc').append(_toc);
+}

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/fulldoc/html/setup.rb ADDED

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+include T('default/fulldoc/html')
+module OverrideFileLinks
+  def resolve_links(text)
+    result = ''
+    log.enter_level(Logger::ERROR) { result = super }
+    result
+  end
+  def url_for(object, *args)
+    if CodeObjects::ExtraFileObject === object && object == options.readme
+      'index.html'
+    else
+      super
+    end
+  end
+end
+Template.extra_includes << OverrideFileLinks
+def init
+  class << options.serializer
+    define_method(:serialized_path) do |object|
+      if CodeObjects::ExtraFileObject === object
+        super(object).sub(/^file\./, '').downcase
+      else
+        super(object)
+      end
+    end
+  end if options.serializer
+  return serialize_onefile if options.onefile
+  generate_assets
+  options.delete(:objects)
+  options.files.each {|file| serialize_file(file) }
+  serialize_file(options.readme) if options.readme
+end
+def generate_assets
+  %w(js/jquery.js js/app.js css/style.css css/common.css).each do |file|
+    asset(file, file(file, true))
+  end
+end
+def serialize_file(file)
+  index = options.files.index(file)
+  outfile = file.name.downcase + '.html'
+  options.file = file
+  if file.attributes[:namespace]
+    options.object = Registry.at(file.attributes[:namespace])
+  end
+  options.object ||= Registry.root
+  if file == options.readme
+    serialize_index(options)
+  else
+    serialize_index(options) if !options.readme && index == 0
+    Templates::Engine.with_serializer(outfile, options.serializer) do
+      T('layout').run(options)
+    end
+  end
+  options.delete(:file)
+end
+def serialize_onefile
+  layout = Object.new.extend(T('layout'))
+  options.css_data = layout.stylesheets.map {|sheet| file(sheet, true) }.join("\n")
+  options.js_data = layout.javascripts.map {|script| file(script, true) }.join("")
+  Templates::Engine.with_serializer('onefile.html', options.serializer) do
+    T('onefile').run(options)
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/layout/html/layout.erb ADDED

@@ -0,0 +1,81 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <%= erb(:headers) %>
+		<script type="text/javascript">
+			$(function() {
+				$('.object_link').each(function() {
+					$(this).html($(this).find('a').html())
+				});
+			});
+			$(function() {
+				generateTOC();
+				if ($('#toc li').size() == 0) {
+					$('#sidebar h2.toc').hide();
+				}
+			})
+		</script>
+  </head>
+  <body>
+		<div id="top_nav">
+			<div id="inner_nav">
+				<% if options.readme != options.file && options.title %>
+					<span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
+					<small class="links">
+						<% links = [@prevfile ? link_file(@prevfile, '&larr;') : nil,
+						            link_file('index.html', '&uarr;'),
+									@nextfile ? link_file(@nextfile, '&rarr;') : nil].compact %>
+						<%= links.join(" ") %>
+					</small>
+				<% end %>
+			</div>
+		</div>
+		<div id="page">
+			<div id="sidebar">
+				<h2 class="toc">Table Of Contents</h2>
+				<div id="toc"></div>
+				<% if options.readme != options.file %>
+				<h2>Related Topics</h2>
+				<div id="links">
+					<ol class="top">
+						<% if options.readme %>
+							<li><%= link_file("index.html", "Documentation Overview") %></li>
+						<% end %>
+						<ol>
+							<% if @prevfile %>
+								<li>
+									<strong>Previous:</strong>
+									<%= link_file(@prevfile) %>
+								</li>
+							<% end %>
+							<% if @nextfile %>
+							<li>
+								<strong>Next:</strong>
+								<%= link_file(@nextfile) %>
+							</li>
+							<% end %>
+						</ol>
+					</ol>
+				</div>
+				<% else %>
+				<h2>List of Topics</h2>
+				<div id="links">
+					<ol class="top">
+						<li><a href="#">Documentation Overview</a></li>
+						<ol>
+							<% options.files.each do |file| %>
+							<li><%= link_file(file.filename, file.title) %></li>
+							<% end %>
+						</ol>
+					</ol>
+				</div>
+				<% end %>
+			</div>
+	    <div id="content"><%= yieldall %></div>
+		</div>
+		<div style="clear:both"></div>
+    <%= erb(:footer) %>
+  </body>
+</html>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/layout/html/setup.rb ADDED

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+include T('default/layout/html')
+def init
+  super
+  @topfile = options.readme
+  if options.files
+    if @topfile
+      @toptitle = @topfile.attributes[:title] || "Documentation Overview"
+    end
+    @page_title = @file == options.readme ? options.title : @file.title
+    index = options.files.index(@file)
+    if index
+      @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
+      @nextfile = options.files[index + 1]
+    end
+  end
+end
+def diskfile
+  options.including_object = @object
+  super
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/method/html/header.erb ADDED

@@ -0,0 +1,18 @@
+<div class="method_header">
+  <% if options.in_module %>
+    <% if object.constructor? %>
+      <em>self.</em><span class="path"><strong>new</strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
+    <% else %>
+      <em><%= object.scope == :class ? 'self.' : '' %></em><span class="path"><strong><%= object.is_attribute? ? object.name.to_s.sub(/=$/, '') : object.name %></strong></span><% if object.is_attribute? %>
+        <% rw = object.attr_info %>
+        <% if rw && rw[:read] && !rw[:write] %><span class="readonly">readonly</span>
+        <% elsif rw && !rw[:read] && rw[:write] %><span class="writeonly">writeonly</span>
+        <% end %>
+        <% else %><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %><% end %>
+    <% end %>
+  <% else %>
+    <em>def</em> <span class="path space"><%= options.including_object.relative_path(object.namespace) %><big><%= object.send(:sep) %></big><strong><%= object.name %></strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
+  <% end %>
+  <% if object.has_tag?(:since) && object.namespace.tag(:since) != object.tag(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
+</div>
+<div class="method_body"><%= yieldall %></div>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/method/html/setup.rb ADDED

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+def init
+  sections :header, [T('docstring')]
+end
+def format_args(object)
+  return if object.parameters.nil?
+  params = object.parameters
+  if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
+    params.reject! do |param|
+      param[0].to_s[0, 1] == "&" &&
+        !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
+    end
+  end
+  if params.empty?
+    ""
+  else
+    args = params.map {|n, v| v ? "<em>#{h n}</em> = #{h v}" : "<em>" + n.to_s + "</em>" }.join(", ")
+    args
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/module/html/header.erb ADDED

@@ -0,0 +1,7 @@
+<div class='module_header'>
+  <em><%= object.type %></em> <span class="path"><%= object.namespace == Registry.root ? '' : object.namespace.path + '::' %><strong><%= object.name %></strong></span>
+  <% if object.has_tag?(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
+</div>
+<div class="module_methods">
+  <%= yieldall %>
+</div>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/module/html/method_list.erb ADDED

@@ -0,0 +1,5 @@
+<div class="module_methods">
+  <% @meths.each_with_index do |meth, i| %>
+    <%= yieldall(:object => meth, :index => i, :in_module => true) %>
+  <% end %>
+</div>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/module/html/setup.rb ADDED

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+include Helpers::ModuleHelper
+def init
+  sections :header, [T('docstring')], :method_list, [T('method')]
+end
+def method_list
+  @meths = object.meths(:inherited => false, :included => false)
+  cons = @meths.find(&:constructor?)
+  @meths = @meths.reject {|meth| special_method?(meth) }
+  @meths = sort_listing(prune_method_listing(@meths, false))
+  @meths.unshift(cons) if cons
+  erb(:method_list)
+end
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
+end
+def special_method?(meth)
+  return true if meth.writer? && meth.attr_info[:read]
+  return true if meth.name(true) == 'new'
+  return true if meth.name(true) == '#method_missing'
+  return true if meth.constructor?
+  false
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/onefile/html/files.erb ADDED

@@ -0,0 +1,4 @@
+<% @files.each do |file| %>
+  <% @file = file %>
+  <%= diskfile %>
+<% end %>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/onefile/html/setup.rb ADDED

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+include T('default/onefile/html')
+def init
+  sections :layout, [:toc, :files]
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/onefile/html/toc.erb ADDED

@@ -0,0 +1,3 @@
+<h1><%= @title %></h1>
+<h2>Table of Contents</h2>
+<div id="toc" class="one-file"></div>

data/gems/ruby/2.7.0/gems/yard-0.9.25/templates/guide/tags/html/setup.rb ADDED

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+include T('default/tags/html')
+def init
+  super
+  [:since, :see, :return].each do |section|
+    sections[:index].delete(section)
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/yard.gemspec ADDED

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require File.expand_path('../lib/yard/version', __FILE__)
+Gem::Specification.new do |s|
+  s.name          = "yard"
+  s.summary       = "Documentation tool for consistent and usable documentation in Ruby."
+  s.description   = <<-eof
+    YARD is a documentation generation tool for the Ruby programming language.
+    It enables the user to generate consistent, usable documentation that can be
+    exported to a number of formats very easily, and also supports extending for
+    custom Ruby constructs such as custom class level definitions.
+  eof
+  s.version       = YARD::VERSION
+  s.date          = Time.now.strftime('%Y-%m-%d')
+  s.author        = "Loren Segal"
+  s.email         = "lsegal@soen.ca"
+  s.homepage      = "http://yardoc.org"
+  s.platform      = Gem::Platform::RUBY
+  s.files         = `git ls-files`.strip.split(/\s+/).reject {|f| f.match(%r{^spec/}) }
+  s.require_paths = ['lib']
+  s.executables   = ['yard', 'yardoc', 'yri']
+  s.license = 'MIT' if s.respond_to?(:license=)
+  s.metadata['yard.run'] = 'yri'
+end

data/gems/ruby/2.7.0/gems/yard-activesupport-concern-0.0.1/.gitignore ADDED

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

data/gems/ruby/2.7.0/gems/yard-activesupport-concern-0.0.1/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in yard-activesupport-concern.gemspec
+gemspec

data/gems/ruby/2.7.0/gems/yard-activesupport-concern-0.0.1/LICENSE ADDED

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+Copyright (c) 2015 digital cuisine
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/gems/ruby/2.7.0/gems/yard-activesupport-concern-0.0.1/README.md ADDED

@@ -0,0 +1,61 @@
+# YARD ActiveSupport::Concern Plugin
+[![Version](http://img.shields.io/gem/v/yard-activesupport-concern.svg?style=flat-square)](https://rubygems.org/gems/yard-activesupport-concern)
+[![Downloads](http://img.shields.io/gem/dt/yard-activesupport-concern.svg?style=flat-square)](https://rubygems.org/gems/yard-activesupport-concern)
+[![Open Github issues](http://img.shields.io/github/issues/digitalcuisine/yard-activesupport-concern.svg?style=flat-square)](https://github.com/digitalcuisine/yard-activesupport-concern/issues)
+This is a [YARD](https://github.com/lsegal/yard) extension that brings support for modules making use of `ActiveSupport::Concern` (very frequent in Rails projects). Here's an example of such module:
+```ruby
+module M
+  extend ActiveSupport::Concern
+  included do
+    # @!method disabled
+    # @!scope class
+    # @return [Collection<Model>] Return a scope to get all disabled records
+    scope :disabled, -> { where(disabled: true) }
+  end
+  class_methods do
+    # A quick way to get all published records
+    # @return [Collection<Model>] Return a scope to get all published records
+    def published
+      where(published: true)
+    end
+  end
+end
+```
+Because `ActiveSupport::Concern` moves method/attributes/... definitions inside `included` or `class_methods` blocks, YARD cannot document them out of the box. As a result, the docstrings in the above example won't show in the generated documentation.
+For many, one workaround has been to move all comments above the `included` or `class_methods` blocks. But this decouples the comments from the actual method definitions and hence defeats the purpose of commenting your code.
+This plugin is here to set this right and make YARD aware of those nested definitions.
+## Installation
+Add the following line to your Gemfile:
+```ruby
+gem 'yard-activesupport-concern'
+```
+Or install the gem globally:
+`gem install yard-activesupport-concern`
+You can then use the plugin using the `--plugin activesupport-concern` command-line option or by instructing YARD to always load all available plugins: `yard config load_plugins true` (see [the docs](http://www.rubydoc.info/gems/yard/YARD/Config#load_plugins-class_method))
+If you're using a `.yardopts` file, just add the `--plugin activesupport-concern` option to it.
+That's it!
+## License
+This plugin is released under the MIT license. Please refer to the [LICENSE](https://github.com/digitalcuisine/yard-activesupport-concern/blob/master/LICENSE) file.
+## Contributing
+Please refer to Github's [guide](https://guides.github.com/activities/contributing-to-open-source/#contributing) to efficiently contribute to this project!