thredded_create_app 0.1.0

data/lib/thredded_create_app/logging.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'term/ansicolor'
+module ThreddedCreateApp
+  module Logging
+    def log_verbose(message = nil)
+      return unless verbose?
+      log_stderr Term::ANSIColor.bright_magenta(message || yield)
+    end
+
+    def log_command(message)
+      log_stderr Term::ANSIColor.bold message
+    end
+
+    def log_info(message)
+      log_stderr Term::ANSIColor.bright_blue message
+    end
+
+    def log_warn(message)
+      log_stderr Term::ANSIColor.yellow("#{program_name}: [WARN] #{message}")
+    end
+
+    def log_error(message)
+      log_stderr Term::ANSIColor.red Term::ANSIColor.bold(
+        "#{program_name}: #{message}"
+      )
+    end
+
+    def log_stderr(*args)
+      STDERR.puts(*args)
+    end
+
+    def program_name
+      @program_name ||= File.basename($PROGRAM_NAME)
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_devise.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require 'thredded_create_app/tasks/base'
+module ThreddedCreateApp
+  module Tasks
+    class AddDevise < Base
+      def summary
+        'Add devise with I18n and configure a User model'
+      end
+
+      def before_bundle
+        add_gem 'devise'
+        add_gem 'devise-i18n'
+      end
+
+      def after_bundle
+        replace 'config/initializers/filter_parameter_logging.rb',
+                ':password',
+                ':password, :password_confirmation'
+        run_generator 'devise:install'
+        run_generator 'devise User'
+        setup_views
+        setup_after_sign_in_behaviour
+        git_commit 'Setup Devise'
+      end
+
+      private
+
+      def setup_after_sign_in_behaviour
+        inject_into_file 'app/controllers/application_controller.rb',
+                         after:   /protect_from_forgery.*\n/,
+                         content: <<-'RUBY'
+
+  before_action :store_current_location, unless: :devise_controller?
+
+  private
+
+  def store_current_location
+    store_location_for(:user, request.url)
+  end
+
+  def after_sign_out_path_for(resource)
+    request.referrer || root_path
+  end
+        RUBY
+      end
+
+      def setup_views
+        run_generator 'devise:i18n:views -v sessions registrations'
+        # Make the views render-able outside Devise controllers
+        %w(app/views/devise/registrations/new.html.erb
+           app/views/devise/registrations/edit.html.erb
+           app/views/devise/sessions/new.html.erb
+           app/views/devise/shared/_links.html.erb).each do |path|
+          replace path, 'resource_name', ':user'
+          replace path, 'resource', ':user'
+          replace path, 'resource_class', 'User', optional: true
+          replace path, 'devise_mapping', 'Devise.mappings[:user]',
+                  optional: true
+        end
+      end
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_display_name_to_users.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+require 'thredded_create_app/tasks/base'
+module ThreddedCreateApp
+  module Tasks
+    class AddDisplayNameToUsers < Base
+      def initialize(simple_form: true, **args)
+        super
+        @simple_form = simple_form
+      end
+
+      def summary
+        'Add display_name to the Devise User model'
+      end
+
+      def after_bundle
+        add_display_name
+        configure_devise
+        configure_thredded
+      end
+
+      private
+
+      def add_display_name
+        run_generator 'migration add_display_name_to_users'
+        copy 'add_display_name_to_users/add_display_name_to_users.rb',
+             Dir['db/migrate/*_add_display_name_to_users.rb'][0]
+        model_path = 'app/models/user.rb'
+        inject_into_file model_path,
+                         after:   "ApplicationRecord\n",
+                         content: display_name_model_rb
+        inject_into_file model_path,
+                         before:  /end\n\z/,
+                         content: uniq_display_name_method_rb
+        git_commit 'Add a unique display_name User attribute'
+      end
+
+      def configure_devise
+        inject_into_file 'app/controllers/application_controller.rb',
+                         after:   /protect_from_forgery.*\n/,
+                         content: devise_permitted_params_rb
+        %w(app/views/devise/registrations/new.html.erb
+           app/views/devise/registrations/edit.html.erb).each do |path|
+          autofocus = File.read(path).include?(', autofocus: true')
+          replace path, ', autofocus: true', '' if autofocus
+          if @simple_form
+            inject_into_file path,
+                             after:   %(<div class="form-inputs">\n),
+                             content: simple_form_input_html(autofocus)
+          else
+            inject_into_file path,
+                             after:   /error_messages! %>\n\n/,
+                             content: actionview_input_html(autofocus)
+          end
+        end
+        git_commit 'Configure Devise to support display_name in forms'
+      end
+
+      def configure_thredded
+        replace 'config/initializers/thredded.rb',
+                'Thredded.user_name_column = :name',
+                'Thredded.user_name_column = :display_name'
+        git_commit 'Configure Thredded to use display_name as the user name'
+      end
+
+      def display_name_model_rb
+        <<-'RUBY'
+  validates :display_name, presence: true, uniqueness: true
+  before_validation :uniq_display_name!, on: :create
+
+  def display_name=(value)
+    super(value&.strip)
+  end
+
+        RUBY
+      end
+
+      def uniq_display_name_method_rb
+        <<-'RUBY'
+  private
+
+  # Makes the display_name unique by appending a number to it if necessary.
+  # "Gleb" => Gleb 1"
+  def uniq_display_name!
+    if display_name.present?
+      new_display_name = display_name
+      i  = 0
+      while User.exists?(display_name: new_display_name)
+        new_display_name = "#{display_name} #{i += 1}"
+      end
+      self.display_name = new_display_name
+    end
+  end
+        RUBY
+      end
+
+      def devise_permitted_params_rb
+        <<-'RUBY'
+  before_action :configure_permitted_parameters, if: :devise_controller?
+
+  protected
+
+  def configure_permitted_parameters
+    devise_parameter_sanitizer.permit(:sign_up, keys: %i(display_name))
+    devise_parameter_sanitizer.permit(:account_update, keys: %i(display_name))
+  end
+        RUBY
+      end
+
+      def simple_form_input_html(autofocus)
+        <<-HTML
+  <%= f.input :display_name, required: true#{', autofocus: true' if autofocus} %>
+        HTML
+      end
+
+      def actionview_input_html(autofocus)
+        <<-HTML
+  <div class="field">
+    <%= f.label :display_name %><br />
+    <%= f.text_field :display_name#{', autofocus: true' if autofocus} %>
+  </div>
+
+        HTML
+      end
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_display_name_to_users/add_display_name_to_users.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+class AddDisplayNameToUsers < ActiveRecord::Migration[5.0]
+  def up
+    add_column :users, :display_name, :text, null: false
+    DbTextSearch::CaseInsensitive.add_index connection, :users, :display_name,
+                                            unique: true
+  end
+
+  def down
+    remove_column :users, :display_name
+  end
+end

data/lib/thredded_create_app/tasks/add_simple_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'thredded_create_app/tasks/base'
+module ThreddedCreateApp
+  module Tasks
+    class AddSimpleForm < Base
+      def summary
+        'Add the simple_form gem'
+      end
+
+      def before_bundle
+        add_gem 'simple_form'
+      end
+
+      def after_bundle
+        run_generator 'simple_form:install'
+        git_commit 'Install SimpleForm (rails g simple_form:install)'
+      end
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_thredded.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+require 'thredded_create_app/tasks/base'
+module ThreddedCreateApp
+  module Tasks
+    class AddThredded < Base
+      def summary
+        'Add and setup Thredded with a User model'
+      end
+
+      def before_bundle
+        add_gem 'thredded'
+      end
+
+      def after_bundle
+        install_thredded
+        git_commit 'Install thredded (rails g thredded:install)'
+        add_thredded_routes
+        copy 'add_thredded/thredded.en.yml', 'config/locales/thredded.en.yml'
+        set_thredded_layout
+        configure_thredded_controller
+        add_thredded_styles
+        add_thredded_javascripts
+        copy 'add_thredded/spec/features/thredded_spec.rb',
+             'spec/features/thredded_spec.rb'
+        git_commit 'Configure Thredded (routes, assets, behaviour, tests)'
+        add_admin_column_to_users
+        git_commit 'Add the admin column to users'
+        run 'bundle exec rails thredded:install:emoji'
+        git_commit 'Copied emoji to public/emoji'
+      end
+
+      private
+
+      def install_thredded
+        run_generator 'thredded:install'
+        run 'bundle exec rails thredded:install:migrations' \
+            "#{' --quiet' unless verbose?}"
+      end
+
+      def add_thredded_routes
+        add_route "mount Thredded::Engine => '/forum'"
+      end
+
+      def set_thredded_layout
+        replace 'config/initializers/thredded.rb',
+                "Thredded.layout = 'thredded/application'",
+                "Thredded.layout = 'application'"
+      end
+
+      def configure_thredded_controller
+        copy 'add_thredded/thredded_initializer_controller.rb',
+             'config/initializers/thredded.rb',
+             mode: 'a'
+      end
+
+      def add_thredded_styles
+        copy 'add_thredded/_myapp-thredded.scss',
+             "app/assets/stylesheets/_#{app_name}-thredded.scss"
+        if File.file? 'app/assets/stylesheets/application.css'
+          File.delete 'app/assets/stylesheets/application.css'
+        end
+        File.write 'app/assets/stylesheets/application.scss',
+                   "@import \"#{app_name}-thredded\";\n",
+                   mode: 'a'
+      end
+
+      def add_thredded_javascripts
+        copy 'add_thredded/myapp_thredded.js',
+             "app/assets/javascripts/#{app_name}_thredded.js"
+      end
+
+      def add_admin_column_to_users
+        run_generator 'migration add_admin_to_users'
+        copy 'add_thredded/add_admin_to_users.rb',
+             Dir['db/migrate/*_add_admin_to_users.rb'][0]
+      end
+    end
+  end
+end

data/lib/thredded_create_app/tasks/add_thredded/_myapp-thredded.scss

@@ -0,0 +1,18 @@
+@import "variables";
+
+$thredded-brand: $brand-primary;
+$thredded-text-color: $text-color;
+$thredded-base-font-family: $base-font-family;
+$thredded-base-font-size: $base-font-size;
+$thredded-base-line-height: $base-line-height;
+$thredded-grid-container-max-width: $grid-container-max-width;
+@import "thredded";
+
+.thredded--main-container {
+  // The padding and max-width are handled by the app's container.
+  max-width: none;
+  padding: 0;
+  @include thredded-media-tablet-and-up {
+    padding: 0;
+  }
+}

data/lib/thredded_create_app/tasks/add_thredded/add_admin_to_users.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+class AddAdminToUsers < ActiveRecord::Migration[5.0]
+  def up
+    add_column :users, :admin, :boolean, null: false, default: false
+  end
+
+  def down
+    remove_column :users, :admin
+  end
+end

data/lib/thredded_create_app/tasks/add_thredded/myapp_thredded.js

@@ -0,0 +1 @@
+//= require thredded

data/lib/thredded_create_app/tasks/add_thredded/spec/features/thredded_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'rails_helper'
+
+RSpec.feature 'Thredded', type: :feature do
+  it 'root path responds with 200' do
+    visit thredded.root_path
+    expect(page.status_code).to be 200
+  end
+end

data/lib/thredded_create_app/tasks/add_thredded/thredded.en.yml

@@ -0,0 +1,8 @@
+en:
+  thredded:
+    messageboard:
+      index:
+        page_title: Forums
+    nav:
+      all_messageboards: Forums
+

data/lib/thredded_create_app/tasks/add_thredded/thredded_initializer_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+Rails.application.config.to_prepare do
+  Thredded::ApplicationController.module_eval do
+    rescue_from Thredded::Errors::LoginRequired do |exception|
+      flash.now[:notice] = exception.message
+      render template: 'devise/sessions/new', status: :forbidden
+    end
+  end
+end

data/lib/thredded_create_app/tasks/base.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+require 'shellwords'
+require 'fileutils'
+require 'erb'
+require 'thredded_create_app/logging'
+require 'thredded_create_app/command_error'
+module ThreddedCreateApp
+  module Tasks
+    # @abstract
+    class Base
+      include ThreddedCreateApp::Logging
+
+      def initialize(app_path:, verbose: false, **_args)
+        @app_path = app_path
+        @app_name = File.basename(File.expand_path(app_path))
+        @verbose  = verbose
+        @gems     = []
+      end
+
+      def summary
+        self.class.name
+      end
+
+      def before_bundle
+      end
+
+      def after_bundle
+      end
+
+      protected
+
+      def add_gem(gem_name, version: nil, groups: nil)
+        log_verbose "+ gem #{gem_name}"
+        @gems << [gem_name, version, groups]
+      end
+
+      def git_commit(message)
+        log_info "Commiting: #{message}"
+        system 'git add -A .'
+        system(*['git', 'commit', '-m', "[thredded_create_app] #{message}",
+                 ('--quiet' unless verbose?)].compact)
+      end
+
+      attr_reader :app_name, :app_path, :gems
+
+      def copy(src_path, target_path, mode: 'w')
+        copy_template src_path, target_path, process_erb: false, mode: mode
+      end
+
+      def copy_template(src_path, target_path, process_erb: true, mode: 'w')
+        src = File.read(File.expand_path(src_path, File.dirname(__FILE__)))
+        src = ERB.new(src).result(binding) if process_erb
+        FileUtils.mkdir_p(File.dirname(target_path))
+        File.write target_path, src, mode: mode
+      end
+
+      def replace(path, pattern, replacement = nil, optional: false, &block)
+        src = File.read(path)
+        unless src.gsub!(pattern, replacement, &block) || optional
+          raise ThreddedCreateApp::CommandError,
+                "No match found for #{pattern} in #{path}"
+        end
+        File.write path, src
+      end
+
+      def add_route(route_str, append: false)
+        log_verbose "Add route: #{route_str}"
+        inject_into_file 'config/routes.rb',
+                         content: "  #{route_str}\n",
+                         **(if append
+                              { after: /\.routes\.draw do\s*\n/m }
+                            else
+                              { before: /end\n\z/ }
+                            end)
+      end
+
+      def inject_into_file(path, content:, after: nil, before: nil)
+        replace path, (after || before), after ? '\0' + content : content + '\0'
+      end
+
+      def indent(n, s)
+        s.gsub(/^/, ' ' * n)
+      end
+
+      def run_generator(generate_args)
+        run "bundle exec rails g #{generate_args}#{' --quiet' unless verbose?}"
+      end
+
+      def run(*args, log: true)
+        if log
+          log_command args.length == 1 ? args[0] : Shellwords.shelljoin(args)
+        end
+        exit 1 unless system(*args)
+      end
+
+      def verbose?
+        @verbose
+      end
+    end
+  end
+end