rideliner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20191fb501aefd4fa75d1f4a54838f8f9f12f65d
+  data.tar.gz: 26d75f38e877c17cf14b96b5b6ee5206985e3e1b
+SHA512:
+  metadata.gz: e0dc45230464bf3cef0f838008b31ea443d13ca9f4f497a77badc94d5a615f8ca5384442cca95ff0740b52b02e5f4fc720922949187ef704e11f4bafc0f30538
+  data.tar.gz: b5faf1f5c09eaef8a9ad3e9326f2c2a80d556ebc2783ffdddf4981e5adad7debad5bc388f13121d259a93a75b78d0e32f266643d8caaab19da78611656700eb1

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,73 @@
+---
+
+AllCops:
+  Include:
+    - 'Gemfile'
+    - 'Rakefile'
+  Exclude:
+    - '**/*.lock'
+    - 'vendor/**/*'
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Copyright:
+  Enabled: true
+  Notice: '^# Copyright \(c\) 2\d{3} .+$'
+
+Style/Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: true
+
+Style/FirstArrayElementLineBreak:
+  Enabled: true
+
+Style/FirstHashElementLineBreak:
+  Enabled: true
+
+Style/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Style/FirstMethodParameterLineBreak:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/MultilineArrayBraceLayout:
+  Enabled: true
+
+Style/MultilineAssignmentLayout:
+  Enabled: true
+
+Style/MultilineHashBraceLayout:
+  Enabled: true
+
+Style/MultilineMethodCallBraceLayout:
+  Enabled: true
+
+Style/MultilineMethodDefinitionBraceLayout:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/Send:
+  Enabled: true
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,15 @@
+# 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/.
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'yard', require: false,
+              git: 'https://github.com/lsegal/yard.git'
+end

data/Rakefile

@@ -0,0 +1,8 @@
+# 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 'rideliner/tasks'

data/lib/rideliner/task/ghpages_deploy_yard.rb

@@ -0,0 +1,61 @@
+# 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 get_current_gemspec
+  root = `git rev-parse --show-toplevel`.strip
+  $? || abort('Only git repositories are supported')
+
+  gemspecs = Dir["#{root}/*.gemspec"]
+  abort "No gemspec found in #{root}" if gemspecs.empty?
+  if gemspecs.length > 1
+    $stderr.puts "Warning: only using the first gemspec found (#{gemspecs.first})."
+  end
+
+  Gem::Specification.load(gemspecs.first)
+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'
+      GithubPages::DeployTask.new(deploy: [:yard]) do |t|
+        t.remote = 'website'
+        t.repo = 'https://github.com/rideliner/rideliner.github.io.git'
+        t.source = '_yardoc'
+
+        tag = ENV['TRAVIS_TAG']
+        branch = ENV['TRAVIS_BRANCH']
+
+        project = PROJECT_NAME || get_current_gemspec.name
+        project_root = "project/#{project}"
+        doc_root = "#{project_root}/doc"
+
+        if !tag.empty?
+          t.destination = "#{doc_root}/tag/#{tag}"
+          t.message = "Deploying documentation for #{project}, tag #{tag}."
+        elsif !branch.empty?
+          t.destination = "#{doc_root}/branch/#{branch}"
+          t.message = "Deploying documentation for #{project}, branch #{branch}."
+        else
+          abort 'No tag or branch specified'
+        end
+
+        t.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/rideliner/task/rubocop.rb

@@ -0,0 +1,14 @@
+# 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 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.fail_on_error = false
+end
+
+task('rubocop:auto_correct').clear

data/lib/rideliner/task/test.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 'rake/testtask'
+require 'rake/clean'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = ['test/test_helper.rb']
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :test do
+  desc 'Generate a test coverage report'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    task(:test).invoke
+  end
+end
+
+CLOBBER.include 'coverage'

data/lib/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/rideliner/tasks.rb

@@ -0,0 +1,21 @@
+# 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 'rubygems'
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup(:default, :development)
+
+require 'rideliner/task/test'
+require 'rideliner/task/yard'
+require 'rideliner/task/rubocop'
+require 'rideliner/task/ghpages_deploy_yard'
+
+task default: %i(rubocop test)
+task ci: 'test:coverage'

data/lib/rideliner/version.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+# This Source Code File 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/.
+
+module Rideliner
+  VERSION = '0.1.0'.freeze
+end

data/lib/yard_rideliner.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'yard'
+
+YARD::Templates::Engine.register_template_path(
+  File.expand_path('../yard_template', File.dirname(__FILE__))
+)

data/rideliner.gemspec

@@ -0,0 +1,36 @@
+# 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 './lib/rideliner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rideliner'
+  spec.version       = Rideliner::VERSION
+  spec.authors       = ['Nathan Currier']
+  spec.email         = ['nathan.currier@gmail.com']
+  spec.license       = 'MPL-2.0'
+
+  spec.description   = "Rideliner's Ruby development"
+  spec.summary       = "Development setup and configuration for Rideliner's ruby projects"
+  spec.homepage      = 'https://github.com/rideliner/rideliner_dev_gem'
+  spec.has_rdoc      = 'yard'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  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_dependency 'rake'
+  spec.add_dependency 'rubocop'
+  spec.add_dependency 'minitest'
+  spec.add_dependency 'simplecov'
+  spec.add_dependency 'codecov'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'yard'
+  spec.add_dependency 'ghpages_deploy'
+end

data/template/default/fulldoc/html/full_list_version.erb

@@ -0,0 +1,49 @@
+<script type="text/javascript">
+if (match = parent.window.location.pathname.match(/^(.+?)(?:branch|tag)\/[^\/]+\/(.+)/)) {
+  var project_root_url = match[1];
+  var relative_url = match[2];
+
+  var jsonData = $.getJSON(project_root_url + 'sitemap.json', function(json) {
+    var branches = json.branch ? Object.keys(json.branch) : [];
+    var tags = json.tag ? Object.keys(json.tag) : [];
+    var list = $('ul.version#full_list');
+
+    var createItem = function(version, index, type) {
+      var base_url = project_root_url + type + '/' + version + '/';
+      var url = base_url;
+      url += (window.location === parent.window.location ? index : relative_url);
+
+      list.append(
+        '<li><div class="item"><span class="object_link">' +
+        '<a href="' + url + '" title="' + version + ' (' + type + ')">' +
+        version + '</a> <small>' + type + '</small></span></div></li>');
+
+      $.ajax({
+        url: url,
+        statusCode: { 404: function() {
+          item = $('ul.version#full_list li').filter(function() {
+            return $(this).find('a').attr('href') === url;
+          });
+          // mark the version as deprecated (missing the current page)
+          // redirect to the index page found in sitemap.json
+          item.addClass('deprecated');
+          item.find('a').attr('href', base_url + index);
+        }}
+      });
+    }
+
+    for (var i = 0; i < branches.length; i++) {
+      createItem(branches[i], json.branch[branches[i]], 'branch');
+    }
+
+    for (var i = 0; i < tags.length; i++) {
+      createItem(tags[i], json.tag[tags[i]], 'tag');
+    }
+
+    highlight();
+    $(fullListSearch);
+    $(linkList);
+    $(collapse);
+  });
+}
+</script>

data/template/default/fulldoc/html/js/view_on_github.js

@@ -0,0 +1,25 @@
+// encoding: utf-8
+// Copyright (c) 2016 Nathan Currier
+
+// Modified from https://github.com/docmeta/rubydoc.info
+
+function createGithubLinks() {
+  if (match = window.location.pathname.match(/([^\/]+)(?:\/doc)?\/(?:branch|tag)\/([^\/]+)\//)) {
+    var github_project = match[1];
+    var github_marker = match[2];
+
+    $(".source_code").each(function() {
+      if (match = $(this).find(".info.file").text().match(/^# File '([^']+)', line (\d+)/)) {
+        var file = match[1];
+        var line = match[2];
+
+        var url = "https://github.com/rideliner/" + github_project + "/blob/" + github_marker + "/" + file + "#L" + line;
+        var href = '<a target="_blank" href="' + url + '">View on Github</a>';
+
+        $(this).before(' <span class="showSource">[' + href + ']</span>');
+      }
+    });
+  }
+}
+
+$(createGithubLinks)

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

@@ -0,0 +1,7 @@
+
+def generate_version_list
+  @list_title = 'Version List'
+  @list_type = 'version'
+
+  asset('version_list.html', erb(:full_list))
+end

data/template/default/layout/html/footer.erb

@@ -0,0 +1,3 @@
+<div id="footer">
+    Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
+</div>

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

@@ -0,0 +1,10 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+def javascripts
+  super + %w(js/view_on_github.js)
+end
+
+def menu_lists
+  super + [{ type: 'version', title: 'Versions', search_title: 'Version List' }]
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rideliner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Currier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 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: rake
+  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: rubocop
+  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: minitest
+  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: simplecov
+  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: codecov
+  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: 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'
+description: Rideliner's Ruby development
+email:
+- nathan.currier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Rakefile
+- lib/rideliner/task/ghpages_deploy_yard.rb
+- lib/rideliner/task/rubocop.rb
+- lib/rideliner/task/test.rb
+- lib/rideliner/task/yard.rb
+- lib/rideliner/tasks.rb
+- lib/rideliner/version.rb
+- lib/yard_rideliner.rb
+- rideliner.gemspec
+- template/default/fulldoc/html/full_list_version.erb
+- template/default/fulldoc/html/js/view_on_github.js
+- template/default/fulldoc/html/setup.rb
+- template/default/layout/html/footer.erb
+- template/default/layout/html/setup.rb
+homepage: https://github.com/rideliner/rideliner_dev_gem
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Development setup and configuration for Rideliner's ruby projects
+test_files: []
+has_rdoc: yard