yard_rideliner 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2236f2d507b77fb485f7b15cdaefd9132c80fd6c
-  data.tar.gz: 11a0728e9ad11acd8cf0118a6b83890349535b7a
+  metadata.gz: cf8a9d6cf8504de33ec5d42673065c30a89ef6ac
+  data.tar.gz: e3e4c7c4a3409f6e0963822ae0ddea9f9a51cd05
 SHA512:
-  metadata.gz: 52925126e3d63884e9ed065d6f5a104b5c97a67995ddfa18ea8faf6b2b598484b39dea00b462a2900e9377f9fe55846a8efb946d7b4356a3a3c3e0721195e037
-  data.tar.gz: 891fd383f514d4412f75d75177dbf44b0a8999d563671d5aae8f2f1d45fc486664382a31343fb49b697d0522e37117ea37fec33fc5384cb644f45a68b9874b6e
+  metadata.gz: 828d23155231553158056539e2663c33ec1ba03079caf2d60782ae406979c5463d554811bbf25d5cbc2a720432e49c7d8332dd9e47a0afb9839f26438c29cf28
+  data.tar.gz: accd3d4860e6f86bf2e22fc410f3f36d235d1ab108bac7252128168f4fec21c21caaed4667315f002aefa772c26268633a6186d26f6da092a60dcf6c9752f38b

data/.gitignore

@@ -1,6 +1,7 @@
 Gemfile.lock
 
+/.bundle/
+/vendor/bundle/
+
 *.gem
 /pkg/
-
-.rubocop-*

data/.rubocop.yml

@@ -1,47 +1,4 @@
 ---
 
-Style/Documentation:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 12
-
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/AutoResourceCleanup:
-  Enabled: true
-
-Style/CollectionMethods:
-  Enabled: true
-
-Style/Copyright:
-  Enabled: true
-  Notice: '^# Copyright \(c\) 2\d{3} .+$'
-
-Style/Encoding:
-  Enabled: true
-
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-
-Style/MultilineArrayBraceLayout:
-  Enabled: true
-
-Style/MultilineAssignmentLayout:
-  Enabled: true
-
-Style/OptionHash:
-  Enabled: true
-
-Style/Send:
-  Enabled: true
-
-Style/StringMethods:
-  Enabled: true
-
-Style/SymbolArray:
-  Enabled: true
-
-Lint/LiteralInInterpolation:
-  Enabled: true
+inherit_gem:
+  rideliner: .rubocop.yml

data/Gemfile

@@ -4,10 +4,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :development do
-  gem 'rake', require: false
-
-  # lint
-  gem 'rubocop', '>= 0.36.0', require: false
-end

data/Rakefile

@@ -1,17 +1,12 @@
 # encoding: utf-8
 # Copyright (c) 2016 Nathan Currier
 
-require 'rubygems'
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
 require 'bundler'
 
 Bundler.setup(:default, :development)
 
-require 'bundler/gem_tasks'
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.fail_on_error = false
-end
-task('rubocop:auto_correct').clear
-
-task default: :rubocop
+require 'rideliner/tasks'

data/lib/yard_rideliner/task/ghpages_deploy.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+def current_gemspec
+  root = `git rev-parse --show-toplevel`.strip
+  abort('Only git repositories are supported') unless $?
+
+  gemspecs = Dir["#{root}/*.gemspec"]
+  abort "No gemspec found in #{root}" if gemspecs.empty?
+
+  spec = gemspecs.first
+  if gemspecs.length > 1
+    $stderr.puts "Warning: only using the first gemspec found (#{spec})."
+  end
+
+  Gem::Specification.load(spec)
+end
+
+if ENV['TRAVIS'] && ENV['DOCS']
+  namespace :yard do
+    if ENV['TRAVIS_PULL_REQUEST'] == 'false'
+      require 'ghpages_deploy/rake_task'
+
+      desc 'Deploy documentation to Github Pages'
+      GithubPagesGithubPages::DeployTask.new(deploy: [:yard]) do |ghpages|
+        ghpages.remote = 'website'
+        ghpages.repo = 'https://github.com/rideliner/rideliner.github.io.git'
+        ghpages.source = '_yardoc'
+
+        tag = ENV['TRAVIS_TAG']
+        branch = ENV['TRAVIS_BRANCH']
+
+        project = PROJECT_NAME || current_gemspec.name
+        project_root = "project/#{project}"
+        doc_root = "#{project_root}/doc"
+
+        dest_and_msg =
+          lambda do |type, loc|
+            [
+              "#{doc_root}/#{type}/#{loc}",
+              "Deploying documentation for #{project}, #{type} #{loc}."
+            ]
+          end
+
+        abort 'No tag or branch specified' if tag.empty? && branch.empty?
+
+        ghpages.destination, ghpages.message =
+          if !tag.empty?
+            dest_and_msg['tag', tag]
+          elsif !branch.empty?
+            dest_and_msg['branch', branch]
+          end
+
+        ghpages.json_sitemap(
+          directory: doc_root,
+          whitelist: ['**/_index.html', '**/index_html'],
+          output: "#{project_root}/documentation.json"
+        )
+      end
+    else
+      task :deploy do
+        puts 'Documentation not generated for pull requests.'
+      end
+    end
+  end
+end

data/lib/yard_rideliner/task/yard.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+require 'rake/clean'
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files = ['lib/**/*.rb', '-', 'doc/*.md', 'LICENSE.md']
+  t.options = [
+    '--charset utf-8', '--readme README.md',
+    '--markup markdown', '--markup-provider kramdown',
+    '--output-dir _yardoc',
+    '--protected', '--private',
+    "--default-return ''",
+    '--plugin yard_rideliner'
+  ]
+end
+
+CLEAN.include '.yardoc'
+CLOBBER.include '_yardoc'

data/lib/yard_rideliner/tasks.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+require 'yard_rideliner/task/ghpages_deploy'
+require 'yard_rideliner/task/yard'

data/lib/yard_rideliner/template_path.rb

@@ -3,12 +3,6 @@
 
 require 'yard'
 
-module YARD
-  module Rideliner
-    def self.template_path
-      File.expand_path('../../template', File.dirname(__FILE__))
-    end
-  end
-end
-
-YARD::Templates::Engine.register_template_path(YARD::Rideliner.template_path)
+YARD::Templates::Engine.register_template_path(
+  File.expand_path('../../template', __dir__)
+)

data/lib/yard_rideliner/version.rb

@@ -3,6 +3,6 @@
 
 module YARD
   module Dizby
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/template/default/fulldoc/html/setup.rb

@@ -1,3 +1,9 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 def generate_version_list
   @list_title = 'Version List'

data/template/default/layout/html/setup.rb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 # Copyright (c) 2016 Nathan Currier
 
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
 def javascripts
   super + %w(js/view_on_github.js)
 end

data/yard_rideliner.gemspec

@@ -20,5 +20,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'yard', '> 0.7'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'yard'
+  spec.add_dependency 'ghpages_deploy'
+
+  spec.add_dependency 'rideliner'
 end

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: yard_rideliner
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Nathan Currier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  name: ghpages_deploy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  name: rideliner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 description: YARD plugin for Rideliner's projects
 email:
 - nathan.currier@gmail.com
@@ -36,6 +78,9 @@ files:
 - Gemfile
 - Rakefile
 - lib/yard_rideliner.rb
+- lib/yard_rideliner/task/ghpages_deploy.rb
+- lib/yard_rideliner/task/yard.rb
+- lib/yard_rideliner/tasks.rb
 - lib/yard_rideliner/template_path.rb
 - lib/yard_rideliner/version.rb
 - template/default/fulldoc/html/full_list_version.erb
@@ -64,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: YARD plugin to template Rideliner's projects