Refactor ruby and rake files

magento · Aug 7, 2019 · 9d800eb · 9d800eb
1 parent db915ce
commit 9d800eb
Show file tree

Hide file tree

Showing 16 changed files with 50 additions and 10 deletions.
diff --git a/Rakefile b/Rakefile
@@ -10,10 +10,9 @@ require 'html-proofer'
 require 'kramdown'
 require 'launchy'
 require 'colorator'
-require 'erb'
 
-# Require helper methods from the 'rakelib/lib' directory
-Dir.glob('rakelib/lib/**/*.rb') { |file| require_relative(file) }
+# Require helper methods from the 'lib' directory
+Dir.glob('lib/**/*.rb') { |file| require_relative(file) }
 
 desc "Same as 'rake', 'rake preview'"
 task default: %w[preview]
@@ -60,10 +59,17 @@ desc 'Pull docs from external repositories'
 task init: %w[multirepo:init]
 
 desc 'Run checks (image optimization).'
-task check: %w[check:image_optim check:mdl] 
+task check: %w[check:image_optim check:mdl]
 
-desc 'Generate data for the weekly digest.'
+desc 'Generate data for a news digest. Default period is a week since today. For other period use "since" argument: since="jul 4"'
 task :whatsnew do
+  date = ENV['since']
   print 'Generating data for the weekly digest: $ '.magenta
-  sh 'whatsup_github'
+  if date.nil? or date.empty?
+    sh 'bin/whatsup_github'
+  elsif date.is_a? String
+    sh 'bin/whatsup_github', 'since', ENV['since'].to_s
+  else
+    puts 'The "since" argument must be a string/ Example: "jul 4"'
+  end
 end
diff --git a/_checks/html-check-hook.rb b/_checks/html-check-hook.rb
@@ -6,7 +6,7 @@
 #
 require 'html-proofer'
 require 'yaml'
-require_relative '../rakelib/lib/double-slash-check.rb'
+require_relative '../lib/double_slash_check.rb'
 
 Jekyll::Hooks.register :site, :post_write do |site|
   # Do nothing unless 'site.check_links' is set

diff --git a/_plugins/collapsible-content.rb → _plugins/liquid-tags/collapsible-content.rb b/_plugins/collapsible-content.rb → _plugins/liquid-tags/collapsible-content.rb
diff --git a/_plugins/glossary-tooltip.rb → _plugins/liquid-tags/glossary-tooltip.rb b/_plugins/glossary-tooltip.rb → _plugins/liquid-tags/glossary-tooltip.rb
diff --git a/_plugins/remote_markdown.rb → _plugins/liquid-tags/remote_markdown.rb b/_plugins/remote_markdown.rb → _plugins/liquid-tags/remote_markdown.rb
diff --git a/_plugins/github-path.rb → _plugins/page-params/github-path.rb b/_plugins/github-path.rb → _plugins/page-params/github-path.rb
diff --git a/_plugins/last-modified-at.rb → _plugins/page-params/last-modified-at.rb b/_plugins/last-modified-at.rb → _plugins/page-params/last-modified-at.rb
diff --git a/_plugins/page-baseurl-generator.rb → ...ins/page-params/page-baseurl-generator.rb b/_plugins/page-baseurl-generator.rb → ...ins/page-params/page-baseurl-generator.rb
diff --git a/_plugins/page-canonical-url.rb → _plugins/page-params/page-canonical-url.rb b/_plugins/page-canonical-url.rb → _plugins/page-params/page-canonical-url.rb
diff --git a/_plugins/page-versionless.rb → _plugins/page-params/page-versionless.rb b/_plugins/page-versionless.rb → _plugins/page-params/page-versionless.rb
diff --git a/_plugins/page-versions.rb → _plugins/page-params/page-versions.rb b/_plugins/page-versions.rb → _plugins/page-params/page-versions.rb
diff --git a/bin/whatsup_github b/bin/whatsup_github
@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'whatsup_github' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("whatsup_github", "whatsup_github")
diff --git a/rakelib/lib/converter.rb → lib/converter.rb b/rakelib/lib/converter.rb → lib/converter.rb
diff --git a/rakelib/lib/doc-config.rb → lib/doc_config.rb b/rakelib/lib/doc-config.rb → lib/doc_config.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Read Docfile file and get configuration data for adding subrepositories
 class DocConfig
   attr_reader :config

diff --git a/rakelib/lib/double-slash-check.rb → lib/double_slash_check.rb b/rakelib/lib/double-slash-check.rb → lib/double_slash_check.rb
@@ -1,8 +1,11 @@
-# Custom check for html-proofer to find double forward slashes in URLs.
+# frozen_string_literal: true
+
 module LinkChecker
+  # Custom check for html-proofer to find double forward slashes in URLs.
   class DoubleSlashCheck < ::HTMLProofer::Check
     def slash?
       return false if @link.href.nil?
+
       @link.href.match %r{\w//}
     end
 
@@ -12,7 +15,7 @@ def run
         line = node.line
 
         if slash?
-          return add_issue("Remove double forward slashes from URLs", line: line)
+          return add_issue('Remove double forward slashes from URLs', line: line)
         end
       end
     end

diff --git a/rakelib/lib/link-checker.rb → lib/link_checker.rb b/rakelib/lib/link-checker.rb → lib/link_checker.rb
@@ -4,7 +4,7 @@
 module LinkChecker
   # Run html-proofer to check the generated HTML pages
   def self.check_site
-    HTMLProofer.check_directory('_site', options).run
+    HTMLProofer.check_directory('_ site', options).run
   end
 
   # Read options from the '_config.checks.yml'