j1-template 2022.0.12 → 2022.0.16

data/assets/themes/j1/modules/advertising/js/google/adInitializer.js

@@ -80,13 +80,23 @@ $(document).ready(function() {
   // [INFO   ] [j1.adapter.advertising                  ] [ detected advertising provider: {{advertising_provider}}} ]
   // [INFO   ] [j1.adapter.advertising                  ] [ advertising detected as: {{advertising}} ]
   {% if advertising %}
-  var logger        = log4javascript.getLogger('j1.core.advertising.google');
-  var ads_found     = document.getElementsByClassName('adsbygoogle').length;
-  var cookie_names  = j1.getCookieNames();
-  var user_consent  = j1.readCookie(cookie_names.user_consent);
+  var logger              = log4javascript.getLogger('j1.core.advertising.google');
+  var ads_found           = document.getElementsByClassName('adsbygoogle').length;
+  var cookie_names        = j1.getCookieNames();
+  var user_consent        = j1.readCookie(cookie_names.user_consent);
+  var providerID          = '{{advertising_options.google.publisherID}}';
+  var validProviderID     = (providerID.includes('your')) ? false : true;
+  var advertisingProvider = 'Google Adsense';
 
   var dependencies_met_page_ready = setInterval (function (options) {
     if (j1.getState() === 'finished') {
+
+      if (!validProviderID) {
+        logger.warn('\n' + 'disabled provider: ' + advertisingProvider);
+        clearInterval(dependencies_met_page_ready);
+        return false;
+      }
+
       if (user_consent.personalization) {
         if (ads_found) {
           logger.info('\n' + 'initialize all ads in page: #' + ads_found);

data/exe/j1

@@ -11,17 +11,37 @@ Mercenary.program(:j1) do |p|
   p.description 'J1 Template is a gem-based Template made for Jekyll'
   p.syntax 'j1 <subcommand> [options]'
 
-  p.command(:generate) do |c|
-    c.description 'Generates a starter site scaffold in PATH'
-    c.syntax 'generate PATH'
-    c.option 'force', '--force',                '    Force a site to be created even the PATH already exists'
-    c.option 'skip-bundle', '--skip-bundle',    '    Skip bundle install'
-    c.option 'skip-patches', '--skip-patches',  '   Skip install any PATCHES buildin with J1'
-    c.option 'system', '--system',              '    Run "bundle install" for the Ruby SYSTEM gem folder'
-    c.action do |args, options|
-      J1::Commands::Generate.process(args, options)
+  # available options for all subcommands
+  #
+  # p.option 'force', '--force'
+  # p.option 'skip-bundle', '--skip-bundle'
+  # p.option 'skip-patches', '--skip-patches'
+  # p.option 'system', '--system'
+
+  # J1::External.require_if_present(J1::External.blessed_gems) do |g, ver_constraint|
+  #   cmd = g.split("-").last
+  #   p.command(cmd.to_sym) do |c|
+  #     c.syntax cmd
+  #     c.action do
+  #       J1.logger.abort_with "You must install the '#{g}' gem" \
+  #         " version #{ver_constraint} to use the 'jekyll #{cmd}' command."
+  #     end
+  #   end
+  # end
+
+  J1::Command.subclasses.each { |c| c.init_with_program(p) }
+
+  p.action do |args, _|
+    if args.empty?
+      J1.logger.error "A subcommand is required."
+      puts p
+      abort
+    else
+      subcommand = args.first
+      unless p.has_command? subcommand
+        J1.logger.abort_with "fatal: 'j1 #{args.first}' failed." \
+          " No subcommand '#{args.first}' available."
+      end
     end
   end
-
-  p.default_command(:generate)
 end

data/lib/j1/commands/generate.rb

@@ -1,36 +1,33 @@
+# frozen_string_literal: true
+
 require 'erb'
-require 'rbconfig'
-require 'fileutils'
 
 module J1
   module Commands
     class Generate < Command
       class << self
 
-        # def init_with_program(prog)
-        #   prog.command(:generate) do |c|
-        #     c.description 'Generates a starter site scaffold in PATH'
-        #     c.syntax 'generate PATH'
-        #     c.option 'force', '--force',                'Force a site to be created even the PATH already exists'
-        #     c.option 'skip-bundle', '--skip-bundle',    'Skip bundle install'
-        #     c.option 'skip-patches', '--skip-patches',  'Skip install any PATCHES buildin with J1'
-        #     c.option 'system', '--system',              'Run "bundle install" for the Ruby SYSTEM gem folder'
-        #     c.action do |args, options|
-        #       J1::Commands::Generate.process(args, options)
-        #     end
-        #   end
-        # end
-
-        def is_windows?
-          RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i
+        def init_with_program(prog)
+          prog.command(:generate) do |c|
+            c.description 'Generates a J1 project scaffold in PATH'
+            c.syntax 'generate PATH'
+            c.option 'force', '--force',                'Force a site to be created even the PATH already exists'
+            c.option 'skip-bundle', '--skip-bundle',    'Skip bundle install'
+            c.option 'skip-patches', '--skip-patches',  'Skip install any PATCHES build-in with J1'
+            c.option 'system', '--system',              'Run "bundle install" for the Ruby SYSTEM gem folder'
+            c.action do |args, options|
+              J1::Commands::Generate.process(args, options)
+            end
+          end
         end
 
         def process(args, options = {})
-          raise ArgumentError, 'You must specify a path.' if args.empty?
+          raise ArgumentError, 'GENERATE: You must specify a path.' if args.empty?
+
           new_blog_path = File.expand_path(args.join(' '), Dir.pwd)
           FileUtils.mkdir_p new_blog_path
           if preserve_source_location?(new_blog_path, options)
-            J1.logger.abort_with 'Conflict:', "#{new_blog_path} exists and is not empty."
+            J1.logger.abort_with 'GENERATE: Conflict:', "#{new_blog_path} exists and is not empty."
           end
 
           if options['blank']
@@ -61,6 +58,10 @@ module J1
 
         private
 
+        def is_windows?
+          RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i
+        end
+
         def create_site(new_blog_path)
           create_sample_files new_blog_path
 
@@ -92,33 +93,33 @@ module J1
         def after_install(path, options = {})
           unless options['skip-bundle']
             bundle_install(path, options)
-            unless options['skip-patches']
-              patch_install(options)
+            if options['skip-patches']
+              J1.logger.info "GENERATE: Install build-in patches skipped ..."
             else
-              J1.logger.info "Install build-in patches skipped ..."
+              patch_install(options)
             end
           end
-          unless options['force']
-            J1.logger.info "Generated Jekyll site installed in folder #{path}"
+          if options['force']
+            J1.logger.info "GENERATE: Generated Jekyll site force installed in folder #{path}"
           else
-            J1.logger.info "Generated Jekyll site force installed in folder #{path}"
+            J1.logger.info "GENERATE: Generated Jekyll site installed in folder #{path}"
           end
-          J1.logger.info 'Installation (bundle) of RubyGems skipped' if options['skip-bundle']
+          J1.logger.info 'GENERATE: Installation (bundle) of RubyGems skipped' if options['skip-bundle']
         end
 
         def bundle_install(path, options)
           J1::External.require_with_graceful_fail 'bundler'
-          J1.logger.info "Running bundle install in #{path} ..."
+          J1.logger.info "GENERATE: Running bundle install in #{path} ..."
           Dir.chdir(path) do
             if options['system']
-              J1.logger.info "Install bundle in Ruby gem SYSTEM folder ..."
+              J1.logger.info "GENERATE: Install bundle in Ruby gem SYSTEM folder ..."
             else
-              J1.logger.info "Install bundle in USER gem folder ~/.gem ..."
+              J1.logger.info "GENERATE: Install bundle in USER gem folder ~/.gem ..."
               process, output = J1::Utils::Exec.run('bundle', 'config', 'set', '--local', 'path', '~/.gem')
             end
             process, output = J1::Utils::Exec.run('bundle', 'install')
             output.to_s.each_line do |line|
-              J1.logger.info('Bundler:', line.strip) unless line.to_s.empty?
+              J1.logger.info('BUNDLE:', line.strip) unless line.to_s.empty?
             end
             raise SystemExit unless process.success?
           end
@@ -142,12 +143,12 @@ module J1
             system_path = result[1]
 
             if options['system']
-              J1.logger.info "Install patches in SYSTEM folder ..."
-              J1.logger.info "Install patches on path #{system_path} ..."
+              J1.logger.info "GENERATE: Install patches in SYSTEM folder ..."
+              J1.logger.info "GENERATE: Install patches on path #{system_path} ..."
               dest = system_path + '/gems/' + patch_gem_eventmachine + '/lib'
             else
-              J1.logger.info "Install patches in USER gem folder ~/.gem ..."
-              J1.logger.info "Install patches on path #{user_path} ..."
+              J1.logger.info "GENERATE: Install patches in USER gem folder ~/.gem ..."
+              J1.logger.info "GENERATE: Install patches on path #{user_path} ..."
               dest = user_path + '/gems/' + patch_gem_eventmachine + '/lib'
             end
             src = patch_eventmachine_source_path
@@ -163,7 +164,7 @@ module J1
               if Dir.exist?(dest)
                 FileUtils.cp(src, dest)
               else
-                J1.logger.info "Skipped install patches for execjs-2.7.0 ..."
+                J1.logger.info "GENERATE: Skipped install patches for execjs-2.7.0 ..."
               end
             end
 

data/lib/j1/commands/help.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module J1
+  module Commands
+    class Help < Command
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:help) do |c|
+            c.syntax "help [subcommand]"
+            c.description "Show the help message, optionally for a given subcommand"
+
+            c.action do |args, _|
+              cmd = (args.first || "").to_sym
+              if args.empty?
+                J1.logger.info prog.to_s
+              elsif prog.has_command? cmd
+                J1.logger.info prog.commands[cmd].to_s
+              else
+                invalid_command(prog, cmd)
+                abort
+              end
+            end
+          end
+        end
+
+        def invalid_command(prog, cmd)
+          J1.logger.error "Error:",
+                              "Hmm... we don't know what the '#{cmd}' command is."
+          J1.logger.info  "Valid commands:", prog.commands.keys.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/j1/commands/patch.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module J1
+  module Commands
+    class Patch < Command
+      #noinspection MissingYardParamTag
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:patch) do |c|
+            c.description 'Install patches available for J1 projects'
+            c.syntax 'patch'
+            c.option 'force', '--force',                'Force to install patches even already exists'
+            c.option 'system', '--system',              'Install patches on the Ruby SYSTEM gem folder'
+            c.action do |args, options|
+              J1::Commands::Patch.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          patch_install(options)
+          @args = args
+        end
+
+        private
+
+        def is_windows?
+          #noinspection RubyResolve
+          RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i
+        end
+
+        def patch_install(options)
+          if is_windows?
+            major, minor = RUBY_VERSION.split('.')
+            lib_version = major + '.' + minor
+            curr_path = File.expand_path(File.dirname(File.dirname(__FILE__)))
+            patch_gem_eventmachine = 'eventmachine-1.2.7-x64-mingw32'
+            patch_gem_execjs = 'execjs-2.7.0'
+            patch_eventmachine_source_path = curr_path + '/patches/rubygems' + '/' + patch_gem_eventmachine + '/lib/' + lib_version
+            patch_execjs_source_path = curr_path + '/patches/rubygems' + '/' + patch_gem_execjs + '/lib/execjs/external_runtime.rb'
+
+            process, output = J1::Utils::Exec.run('gem', 'env', 'gempath')
+            raise SystemExit unless process.success?
+
+            result = output.split(';')
+            user_path = result[0]
+            system_path = result[1]
+
+            if options['system']
+              J1.logger.info "PATCH: Install patches in SYSTEM folder ..."
+              J1.logger.info "PATCH: Install patches on path #{system_path} ..."
+              dest = system_path + '/gems/' + patch_gem_eventmachine + '/lib'
+            else
+              J1.logger.info "PATCH: Install patches in USER gem folder ~/.gem ..."
+              J1.logger.info "PATCH: Install patches on path #{user_path} ..."
+              dest = user_path + '/gems/' + patch_gem_eventmachine + '/lib'
+            end
+            src = patch_eventmachine_source_path
+            FileUtils.cp_r(src, dest)
+
+            if lib_version === '2.7'
+              if options['system']
+                dest = system_path + '/gems/' + patch_gem_execjs + '/lib/execjs'
+              else
+                dest = user_path + '/gems/' + patch_gem_execjs + '/lib/execjs'
+              end
+              src = patch_execjs_source_path
+              if Dir.exist?(dest)
+                FileUtils.cp(src, dest)
+              else
+                J1.logger.info "PATCH: Skipped install patches for execjs-2.7.0 ..."
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/j1/commands/reset.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module J1
+  module Commands
+    class Reset < Command
+      #noinspection MissingYardParamTag
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:reset) do |c|
+            c.description 'Reset a J1 project to factory state'
+            c.syntax 'reset'
+            c.action do |args, options|
+              J1::Commands::Reset.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          J1.logger.info "RESET: Reset the project to factory state ..."
+          J1.logger.info "RESET: Be patient, this will take a while ..."
+          process, output = J1::Utils::Exec.run('npm', 'run', 'reset')
+          output.to_s.each_line do |line|
+            J1.logger.info('RESET:', line.strip) unless line.to_s.empty?
+          end
+          if process.success?
+            J1.logger.info "RESET: The project reset finished successfully."
+          else
+            raise SystemExit
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/j1/commands/setup.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module J1
+  module Commands
+    class Setup < Command
+      #noinspection MissingYardParamTag
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:setup) do |c|
+            c.description 'Initialize a J1 project for first use'
+            c.syntax 'setup'
+            c.option 'force', '--force',                ' Force to install patches even already exists'
+            c.option 'system', '--system',              ' Install patches on the Ruby SYSTEM gem folder'
+            c.option 'skip-patches', '--skip-patches',  'Skip install any PATCHES build-in with J1'
+            c.action do |args, options|
+              J1::Commands::Setup.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          @args = args
+          path = File.expand_path(Dir.getwd)
+          if is_project?
+            bundle_install(path, options)
+            if options['skip-patches']
+              J1.logger.info "SETUP: Install build-in patches skipped ..."
+            else
+              patch_install(options)
+            end
+            J1.logger.info "SETUP: Initialize the project ..."
+            J1.logger.info "SETUP: Be patient, this will take a while ..."
+            process, output = J1::Utils::Exec.run('npm', 'run', 'setup')
+            output.to_s.each_line do |line|
+              J1.logger.info('SETUP:', line.strip) unless line.to_s.empty?
+            end
+            if process.success?
+              J1.logger.info "SETUP: Initializing the project finished successfully."
+              J1.logger.info "SETUP: To open your site, run: j1 site"
+            else
+              raise SystemExit
+            end
+          end
+        end
+
+        private
+
+        def is_project?
+          path = File.expand_path(File.dirname(File.dirname(__FILE__)))
+          J1.logger.info "Check consistency of the project ..."
+          return true
+        end
+
+        def is_windows?
+          #noinspection RubyResolve
+          RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i
+        end
+
+        def bundle_install(path, options)
+          J1::External.require_with_graceful_fail 'bundler'
+          J1.logger.info "Running bundle install in #{path} ..."
+          Dir.chdir(path) do
+            if options['system']
+              J1.logger.info "Install bundle in Ruby gem SYSTEM folder ..."
+            else
+              J1.logger.info "Install bundle in USER gem folder ~/.gem ..."
+              process, output = J1::Utils::Exec.run('bundle', 'config', 'set', '--local', 'path', '~/.gem')
+            end
+            process, output = J1::Utils::Exec.run('bundle', 'install')
+            output.to_s.each_line do |line|
+              J1.logger.info('Bundler:', line.strip) unless line.to_s.empty?
+            end
+            raise SystemExit unless process.success?
+          end
+        end
+
+        def patch_install(options)
+          if is_windows?
+            major, minor = RUBY_VERSION.split('.')
+            lib_version = major + '.' + minor
+            curr_path = File.expand_path(File.dirname(File.dirname(__FILE__)))
+            patch_gem_eventmachine = 'eventmachine-1.2.7-x64-mingw32'
+            patch_gem_execjs = 'execjs-2.7.0'
+            patch_eventmachine_source_path = curr_path + '/patches/rubygems' + '/' + patch_gem_eventmachine + '/lib/' + lib_version
+            patch_execjs_source_path = curr_path + '/patches/rubygems' + '/' + patch_gem_execjs + '/lib/execjs/external_runtime.rb'
+
+            process, output = J1::Utils::Exec.run('gem', 'env', 'gempath')
+            raise SystemExit unless process.success?
+
+            result = output.split(';')
+            user_path = result[0]
+            system_path = result[1]
+
+            if options['system']
+              J1.logger.info "Install patches in SYSTEM folder ..."
+              J1.logger.info "Install patches on path #{system_path} ..."
+              dest = system_path + '/gems/' + patch_gem_eventmachine + '/lib'
+            else
+              J1.logger.info "Install patches in USER gem folder ~/.gem ..."
+              J1.logger.info "Install patches on path #{user_path} ..."
+              dest = user_path + '/gems/' + patch_gem_eventmachine + '/lib'
+            end
+            src = patch_eventmachine_source_path
+            FileUtils.cp_r(src, dest)
+
+            if lib_version === '2.7'
+              if options['system']
+                dest = system_path + '/gems/' + patch_gem_execjs + '/lib/execjs'
+              else
+                dest = user_path + '/gems/' + patch_gem_execjs + '/lib/execjs'
+              end
+              src = patch_execjs_source_path
+              if Dir.exist?(dest)
+                FileUtils.cp(src, dest)
+              else
+                J1.logger.info "Skipped install patches for execjs-2.7.0 ..."
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/j1/commands/site.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module J1
+  module Commands
+    class Site < Command
+      #noinspection MissingYardParamTag
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:site) do |c|
+            c.description 'Run the website of a J1 project'
+            c.syntax 'site'
+            c.action do |args, options|
+              J1::Commands::Site.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          J1.logger.info "SITE: Starting up your site ..."
+          J1::Utils::ExecUntilTrap.run('SITE','npm', 'run', 'j1-site')
+        end
+
+      end
+    end
+  end
+end

data/lib/j1/external.rb

@@ -50,7 +50,7 @@ The full error message from Ruby is: '#{e.message}'
 
 If you run into trouble, you can find helpful resources at https://jekyllrb.com/help/!
             MSG
-            raise Jekyll::Errors::MissingDependencyException, name
+            raise J1::Errors::MissingDependencyException, name
           end
         end
       end

data/lib/j1/utils/exec_until_trap.rb

@@ -0,0 +1,28 @@
+require "open3"
+
+module J1
+  module Utils
+    module ExecUntilTrap
+      extend self
+
+      # Runs a program in a sub-shell and exits on Ctrl+C.
+      #
+      # title - Trailing line title for the output on stdout
+      # *args - a list of strings containing the program name and (followed by) arguments
+      #
+      def run(title, *args)
+        Open3.popen3(*args) do |stdin, stdout, stderr|
+          trap('INT') {
+            puts "#{title}: Received Ctrl-C to stop"
+            raise SystemExit
+          }
+          stdout.each_line do |line|
+            puts "#{title}: #{line}"
+          end
+        end
+        [stdin, stdout, stderr].each(&:close)
+      end
+
+    end
+  end
+end

data/lib/j1/utils.rb

@@ -1,11 +1,42 @@
+require "singleton"
+
 module J1
   module Utils
     extend self
     autoload :Ansi, "j1/utils/ansi"
     autoload :Exec, "j1/utils/exec"
+    autoload :ExecUntilTrap, "j1/utils/exec_until_trap"
     autoload :Platforms, "j1/utils/platforms"
     autoload :WinTZ, "j1/utils/win_tz"
 
+    class GracefulQuit
+      include Singleton
+
+      attr_accessor :breaker
+
+      def initialize
+        self.breaker = false
+      end
+
+      def self.enable
+        trap('INT') {
+          yield if block_given?
+          self.instance.breaker = true
+        }
+      end
+
+      def self.check(message = "Quitting")
+        if self.instance.breaker
+          yield if block_given?
+          puts message
+          exit
+        end
+      end
+
+    end
+
+
+
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty ascii).freeze
     SLUGIFY_RAW_REGEXP = Regexp.new('\\s+').freeze

data/lib/j1/version.rb

@@ -1,3 +1,3 @@
 module J1
-  VERSION = '2022.0.12'
+  VERSION = '2022.0.16'
 end

data/lib/starter_web/Gemfile

@@ -53,7 +53,7 @@ gem 'jekyll', '~> 4.2'
 
 # Theme Rubies, default: J1 Template (NOT used for the development system)
 #
-gem 'j1-template', '~> 2022.0.12'
+gem 'j1-template', '~> 2022.0.16'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment

data/lib/starter_web/_config.yml

@@ -53,7 +53,7 @@ environment:                            development
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2022.0.12
+version:                                2022.0.16
 
 # version
 # ------------------------------------------------------------------------------