thredded_create_app 0.1.28 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db282a04338266835a3d22a51412fe231eb8199464d001ba7d1169ce3ef6ee74
-  data.tar.gz: d2a4a3a9d2004b6501ac35db551f77838612b95e090e6acb2e5b334d275f0640
+  metadata.gz: f0232d103e459c18069f055aba4bb87d2d776148151a2519ceeae3450c0ddfd5
+  data.tar.gz: 970727679e31aad434d3e5dbe0e0aa1e4b75c668649bd7a60af63d71f3a8af68
 SHA512:
-  metadata.gz: ed068b67a37c9133825d4f5ad0a7a6828f86cca729180fb6af257997e95b014f99f4b766f0aac7c76b6cb6e23288e045c9de7b334ab10abc05dd9083a23d05c4
-  data.tar.gz: 8cce0de75ec5f90b5d0f8cf0ab129531339c12df819af7d94dd2366c2f302f3520d4a4446dda88674643739bf471ba10fb322642e658c6b78c8b422de7baadf3
+  metadata.gz: 334b7ec1e5e6edf199f5dc1bb92f7162d7cdce08adf74d390ecf50d4230a4497351e52581fb31ef373be286aaf8c837beff60803ebd21474d7ea65d796535596
+  data.tar.gz: 83547babdc8755375d7f5ad6e6e86b29249301f83c745125feb71a6ce692b77bf271a8901d08b7c21c7d3dae4f2487f6d68737f4ee766ce57dc8125f48f797dc

data/lib/thredded_create_app/cli.rb

@@ -15,6 +15,7 @@ module ThreddedCreateApp
       verbose: false,
       install_gem_bundler_rails: true,
       start_server: true,
+      webpack_js: true,
       simple_form: true,
       database: :postgresql,
       rails_version: nil
@@ -74,7 +75,8 @@ module ThreddedCreateApp
       end
     end
 
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize,Metrics/BlockLength,Metrics/MethodLength
+
     def optparse
       argv = @argv.dup
       argv << '--help' if argv.empty?
@@ -96,6 +98,9 @@ module ThreddedCreateApp
           options[:rails_version] = value
         end
 
+        flags.bool :webpack_js,
+                   '--[no-]webpack-js',
+                   'Use webpack for JavaScript'
         flags.bool :simple_form, '--[no-]simple-form', 'Use simple_form'
 
         op.separator "\nOther options:"
@@ -128,7 +133,7 @@ module ThreddedCreateApp
       options.update(app_path: argv[0])
       options
     end
-    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize,Metrics/BlockLength,Metrics/MethodLength
 
     class Flags
       def initialize(op, options)

data/lib/thredded_create_app/tasks/add_thredded.rb

@@ -3,7 +3,7 @@
 require 'thredded_create_app/tasks/base'
 module ThreddedCreateApp
   module Tasks
-    class AddThredded < Base
+    class AddThredded < Base # rubocop:disable Metrics/ClassLength
       def summary
         'Add and setup Thredded with a User model'
       end
@@ -68,8 +68,17 @@ module ThreddedCreateApp
       end
 
       def add_thredded_javascripts
-        copy 'add_thredded/myapp_thredded.js',
-             "app/assets/javascripts/#{app_name}_thredded.js"
+        if webpack_js?
+          run 'bundle exec rails webpacker:install:erb'
+          copy 'add_thredded/thredded_imports.js.erb',
+               'app/javascript/thredded_imports.js.erb'
+          append_to_file 'app/javascript/packs/application.js', <<~JS
+            require('thredded_imports.js');
+          JS
+        else
+          copy 'add_thredded/myapp_thredded.js',
+               "app/assets/javascripts/#{app_name}_thredded.js"
+        end
       end
 
       def add_admin_column_to_users

data/lib/thredded_create_app/tasks/add_thredded/thredded_imports.js.erb

@@ -0,0 +1,8 @@
+// To add additional timeago locales, uncomment the lines below:
+/*
+<% timeago_root = File.join(Gem.loaded_specs['timeago_js'].full_gem_path, 'assets', 'javascripts') %>
+import "<%= File.join(timeago_root, 'timeago.js') %>";
+<%= %w[de es fr it pl pt_BR ru].map { |locale| %(import "#{File.join(timeago_root, "timeago/locales/#{locale}.js")}";) } * "\n" %>
+*/
+
+<%= Thredded::WebpackAssets.javascripts %>

data/lib/thredded_create_app/tasks/base.rb

@@ -8,13 +8,14 @@ require 'thredded_create_app/command_error'
 module ThreddedCreateApp
   module Tasks
     # @abstract
-    class Base
+    class Base # rubocop:disable Metrics/ClassLength
       include ThreddedCreateApp::Logging
 
       attr_reader :app_name, :app_hostname, :app_path, :gems
 
-      def initialize(
-        app_path:, verbose: false, database:, simple_form: true, **_args
+      def initialize( # rubocop:disable Metrics/ParameterLists
+        app_path:, verbose: false, database:, webpack_js: true,
+        simple_form: true, **_args
       )
         @app_path = app_path
         @app_name = File.basename(File.expand_path(app_path))
@@ -23,6 +24,11 @@ module ThreddedCreateApp
         @database_adapter_name = database.to_s
         @gems = []
         @simple_form = simple_form
+        @webpack_js = webpack_js
+      end
+
+      def webpack_js?
+        @webpack_js
       end
 
       def devise_form_fields_begin_pattern

data/lib/thredded_create_app/tasks/create_rails_app.rb

@@ -20,7 +20,7 @@ module ThreddedCreateApp
           " #{rails_database} and rspec"
       end
 
-      def before_bundle
+      def before_bundle # rubocop:disable Metrics/AbcSize
         if @install_gem_bundler_rails
           run 'gem update --system --no-document --quiet' unless @user_install
           install_gem 'bundler'
@@ -31,7 +31,8 @@ module ThreddedCreateApp
         run "rails _#{@rails_version}_ new . --skip-bundle" \
            " --database=#{rails_database} " \
            " --skip-test#{verbose? ? ' --verbose' : ' --quiet'}" \
-           ' --skip-javascript'
+           "#{' --skip-javascript' unless webpack_js?}"
+        run 'rm', 'Gemfile.lock' if File.exist?('Gemfile.lock')
         replace 'Gemfile', /gem 'sass-rails'.*$/, "gem 'sassc-rails'"
         add_gem 'rspec-rails', version: '>= 4.0.0.beta3', groups: %i[test]
         add_gem 'capybara', groups: %i[test]

data/lib/thredded_create_app/tasks/setup_app_skeleton.rb

@@ -20,9 +20,11 @@ module ThreddedCreateApp
       end
 
       def before_bundle
-        add_gem 'babel-transpiler'
-        add_gem 'uglifier'
-        add_gem 'turbolinks'
+        unless webpack_js?
+          add_gem 'babel-transpiler'
+          add_gem 'uglifier'
+          add_gem 'turbolinks'
+        end
         add_gem 'rails-timeago'
       end
 
@@ -30,9 +32,13 @@ module ThreddedCreateApp
         add_config_vars
         add_i18n
         add_seeds
-        configure_assets
+        configure_sprockets
         add_favicon_and_touch_icons
-        add_javascripts
+        if webpack_js?
+          add_javascripts_webpack
+        else
+          add_javascripts_sprockets
+        end
         add_styles
         add_user_page
         add_home_page
@@ -61,12 +67,25 @@ module ThreddedCreateApp
                          ERB
       end
 
-      def configure_assets
-        copy 'setup_app_skeleton/manifest.js',
-             'app/assets/config/manifest.js'
+      def add_javascripts_webpack
+        append_to_file 'app/javascript/packs/application.js', <<~JS
+          require('monkey-patch-turbolinks.js');
+          require('app');
+        JS
+        copy 'setup_app_skeleton/javascript_webpack/monkey-patch-turbolinks.js',
+             'app/javascript/monkey-patch-turbolinks.js'
+        %w[app index theme time_ago].each do |file|
+          copy "setup_app_skeleton/javascript_webpack/app/#{file}.js",
+               "app/javascript/app/#{file}.js"
+        end
+        git_commit 'Add app JavaScript'
+      end
 
+      def configure_sprockets
+        replace 'app/assets/config/manifest.js',
+                "//= link_directory ../stylesheets .css\n",
+                ''
         append_to_file 'config/initializers/assets.rb', <<~RUBY
-
           # Work around https://github.com/rails/sprockets/issues/581
           Rails.application.config.assets.configure do |env|
             env.export_concurrent = false
@@ -74,7 +93,7 @@ module ThreddedCreateApp
         RUBY
       end
 
-      def add_javascripts
+      def add_javascripts_sprockets
         inject_into_file 'config/environments/production.rb',
                          after: "  # config.assets.css_compressor = :sass\n",
                          content: <<-RUBY
@@ -158,18 +177,32 @@ module ThreddedCreateApp
                 indent(4, <<~ERB)
                   <%= stylesheet_link_tag current_theme, media: 'all', 'data-turbolinks-track': 'reload' %>
                 ERB
-        inject_into_file 'app/views/layouts/application.html.erb',
-                         before: %r{\s*</head>},
-                         content: <<-'ERB'
+        if webpack_js?
+          replace 'app/views/layouts/application.html.erb',
+                  <<-'ERB',
+    <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+                  ERB
+                  <<-'ERB'
+    <%= javascript_pack_tag 'application',
+                            async: true,
+                            defer: true,
+                            'data-turbolinks-track': 'reload' %>
+                  ERB
+        else
+          inject_into_file 'app/views/layouts/application.html.erb',
+                           before: %r{\s*</head>},
+                           content: <<-'ERB'
     <%= javascript_include_tag 'application',
                                 async: !Rails.application.config.assets.debug,
                                 defer: true,
                                 'data-turbolinks-track': 'reload' %>
-                         ERB
+                           ERB
+        end
 
         inject_into_file 'app/views/layouts/application.html.erb',
                          before: %r{\s*</head>},
                          content: <<-'ERB'
+
     <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
                          ERB
 

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/app.js

@@ -0,0 +1,55 @@
+let DOMContentLoadedFired = false;
+
+const isTurbolinks = 'Turbolinks' in window && window.Turbolinks.supported;
+const isTurbolinks5 = isTurbolinks && 'clearCache' in window.Turbolinks;
+
+let onPageLoadFiredOnce = false;
+const pageLoadCallbacks = [];
+const triggerOnPageLoad = () => {
+  pageLoadCallbacks.forEach(function(callback) {
+    callback();
+  });
+  onPageLoadFiredOnce = true;
+};
+
+// Fires the callback on DOMContentLoaded or a Turbolinks page load.
+// If called from an async script on the first page load, and the DOMContentLoad event
+// has already fired, will execute the callback immediately.
+export function onPageLoad(callback) {
+  pageLoadCallbacks.push(callback);
+  // With async script loading, a callback may be added after the DOMContentLoaded event has already triggered.
+  // This means we will receive neither a DOMContentLoaded event, nor a turbolinks:load event on Turbolinks 5.
+  if (!onPageLoadFiredOnce && DOMContentLoadedFired) {
+    callback();
+  }
+}
+
+export function isAppPage() {
+  return !!document.getElementById('app-page-container');
+}
+
+if (isTurbolinks5) {
+  // In Turbolinks 5.0.1, turbolinks:load may have already fired (before DOMContentLoaded).
+  // If so, add our own DOMContentLoaded listener:
+  // See: https://github.com/turbolinks/turbolinks/commit/69d353ea73d10ee6b25c2866fc5706879ba403e3
+  if (window.Turbolinks.controller.lastRenderedLocation) {
+    document.addEventListener('DOMContentLoaded', () => {
+      triggerOnPageLoad();
+    });
+  }
+  document.addEventListener('turbolinks:load', () => {
+    triggerOnPageLoad();
+  });
+} else {
+  // Turbolinks Classic (with or without jQuery.Turbolinks), or no Turbolinks:
+  if (!DOMContentLoadedFired) {
+    document.addEventListener('DOMContentLoaded', () => {
+      triggerOnPageLoad();
+    });
+  }
+  if (isTurbolinks) {
+    document.addEventListener('page:load', () => {
+      triggerOnPageLoad();
+    });
+  }
+}

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/index.js

@@ -0,0 +1,3 @@
+import './app';
+import './theme';
+import './time_ago';

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/theme.js

@@ -0,0 +1,14 @@
+import {onPageLoad} from './app';
+
+onPageLoad(() => {
+  Array.prototype.forEach.call(document.querySelectorAll('.app-nav-theme li button'), (button) => {
+    button.addEventListener('click', (evt) => {
+      const expiresAt = new Date();
+      expiresAt.setMonth(expiresAt.getMonth() + 12);
+      document.cookie = 'app-theme=' +
+          evt.currentTarget.parentNode.getAttribute('data-theme') +
+          ';expires=' + expiresAt + ';path=/';
+      document.location.reload();
+    });
+  });
+});

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/time_ago.js

@@ -0,0 +1,13 @@
+import {isAppPage, onPageLoad} from "./app";
+
+onPageLoad(() => {
+  if (!isAppPage()) return;
+  const COMPONENT_SELECTOR = '[data-time-ago]';
+  window.timeago().render(
+      document.querySelectorAll(COMPONENT_SELECTOR),
+      document.querySelector('#app-page-container')
+          .getAttribute('data-locale').replace('-', '_'));
+});
+document.addEventListener('turbolinks:before-cache', () => {
+  window.timeago.cancel();
+});

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/monkey-patch-turbolinks.js

@@ -0,0 +1,30 @@
+const Turbolinks = require('turbolinks');
+
+// Monkey patch Turbolinks to render 403, 404 & 500 normally
+// See https://github.com/turbolinks/turbolinks/issues/179
+Turbolinks.HttpRequest.prototype.requestLoaded = function() {
+    return this.endRequest(function() {
+        var code = this.xhr.status;
+        if (200 <= code && code < 300 ||
+            code === 403 || code === 404 || code === 500) {
+            this.delegate.requestCompletedWithResponse(
+                this.xhr.responseText,
+                this.xhr.getResponseHeader("Turbolinks-Location"));
+        } else {
+            this.failed = true;
+            this.delegate.requestFailedWithStatusCode(code, this.xhr.responseText);
+        }
+    }.bind(this));
+};
+
+// Turbolinks nonce CSP support.
+// See https://github.com/turbolinks/turbolinks/issues/430
+document.addEventListener('turbolinks:request-start', function(event) {
+    var nonceTag = document.querySelector("meta[name='csp-nonce']");
+    if (nonceTag) event.data.xhr.setRequestHeader('X-Turbolinks-Nonce', nonceTag.content);
+});
+document.addEventListener('turbolinks:before-cache', function() {
+    Array.prototype.forEach.call(document.querySelectorAll('script[nonce]'), function(element) {
+        if (element.nonce) element.setAttribute('nonce', element.nonce);
+    });
+});

data/lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/monkey-patch-turbolinks.js

@@ -14,3 +14,15 @@ window.Turbolinks.HttpRequest.prototype.requestLoaded = function() {
     }
   }.bind(this));
 };
+
+// Turbolinks nonce CSP support.
+// See https://github.com/turbolinks/turbolinks/issues/430
+document.addEventListener('turbolinks:request-start', function(event) {
+  var nonceTag = document.querySelector("meta[name='csp-nonce']");
+  if (nonceTag) event.data.xhr.setRequestHeader('X-Turbolinks-Nonce', nonceTag.content);
+});
+document.addEventListener('turbolinks:before-cache', function() {
+  Array.prototype.forEach.call(document.querySelectorAll('script[nonce]'), function(element) {
+    if (element.nonce) element.setAttribute('nonce', element.nonce);
+  });
+});

data/lib/thredded_create_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThreddedCreateApp
-  VERSION = '0.1.28'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thredded_create_app
 version: !ruby/object:Gem::Version
-  version: 0.1.28
+  version: 0.2.0
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -136,6 +136,7 @@ files:
 - lib/thredded_create_app/tasks/add_thredded/myapp_thredded.js
 - lib/thredded_create_app/tasks/add_thredded/spec/features/thredded_spec.rb
 - lib/thredded_create_app/tasks/add_thredded/thredded.en.yml
+- lib/thredded_create_app/tasks/add_thredded/thredded_imports.js.erb
 - lib/thredded_create_app/tasks/add_thredded/thredded_initializer_controller.rb
 - lib/thredded_create_app/tasks/base.rb
 - lib/thredded_create_app/tasks/create_rails_app.rb
@@ -156,12 +157,16 @@ files:
 - lib/thredded_create_app/tasks/setup_app_skeleton/home_show.html.erb.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/images/brightness.svg
 - lib/thredded_create_app/tasks/setup_app_skeleton/initializers/02_i18n.rb
+- lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/app.js
+- lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/index.js
+- lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/theme.js
+- lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/app/time_ago.js
+- lib/thredded_create_app/tasks/setup_app_skeleton/javascript_webpack/monkey-patch-turbolinks.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/monkey-patch-turbolinks.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/theme.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/app/time_ago.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/javascripts/application.js
-- lib/thredded_create_app/tasks/setup_app_skeleton/manifest.js
 - lib/thredded_create_app/tasks/setup_app_skeleton/seeds.rb.erb
 - lib/thredded_create_app/tasks/setup_app_skeleton/spec/controllers/users_controller_spec.rb
 - lib/thredded_create_app/tasks/setup_app_skeleton/spec/features/homepage_spec.rb

data/lib/thredded_create_app/tasks/setup_app_skeleton/manifest.js

@@ -1 +0,0 @@
-//= link_tree ../images