rockstart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ba7c0a5317e53f705cd38bd10ada153e28d5adab8ac3b4d8a182a6312a8a5e7
+  data.tar.gz: 9113486cc9d6f7087d91fa29a54e7c39fda7fb2daf0a386e3739913432344c5a
+SHA512:
+  metadata.gz: 3742b345254b2baf3eb6433af39d686c90bc9c80308128d738b47ea031112b1fd6b888c0f603953439dd60f5349662b279ac94bf2a7858bacb565c31238d82ac
+  data.tar.gz: 8c3a806404352d26ab4f424d71ddb315378d4eb33fa9be666872328f3890f337d993aa6560d31d63a5334ebd8e9411d6b95a8586d441b2a11d3c09d9b947d83d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Ben Morrall
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Rockstart
+A collection of generators to rapidly start and update ready-to-run Rails Applications.
+
+## Usage
+Most applications can be configured using the standard generator:
+
+```bash
+bundle exec rails g rockstart
+```
+
+For those wanting more control; Rockstart provides a number of generators that can be used as required.
+
+### Postgres
+Rockstart creates a config/database.yml suitable for Heroku or Docker installations.
+
+```bash
+bundle exec rails g rockstart:postgres
+```
+
+### Docker
+Rockstart can configure your Rails
+
+```bash
+bundle exec rails g rockstart:docker
+```
+
+It uses the current Ruby Version, your Rails configuration, along with the current Application Name, to generate a Dockerfile with sensible defaults.
+
+### RSpec
+
+Rockstart can pre-configure RSpec for your repository.
+
+```bash
+bundle exec rails g rockstart:rspec
+```
+
+### Security
+
+Rockstart can install a rake task for checking the security of your app
+
+```
+bundle exec rails g rockstart:security
+```
+
+### Quality
+
+Rockstart can add tasks for maintaining the quality of your codebase.
+
+```bash
+bundle exec rails g rockstart:quality
+```
+
+It will install [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails), add a basic set of rule guidelines and auto-generates a configuration file to highlight any existing problems.
+
+Provides a "quality" rake task, which runs all code quality tests on your Application.
+
+```
+bundle exec rake quality
+```
+
+### Frontend Helpers
+
+Installs helpers for easy developer of Frontend Interfaces:
+
+```
+bundle exec rails g rockstart:frontend_helpers
+```
+
+### Tailwind CSS
+
+[Tailwind CSS](https://tailwindcss.com) is a CSS framework for rapidly prototyping applications.
+
+Install it, via Webpacker, by running:
+
+```bash
+bundle exec rails g rockstart:tailwindcss
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rockstart', group: :development
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rockstart
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Rockstart"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"

data/lib/generators/rockstart/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Configures an application with the default rockstart setup
+
+Example:
+    rails generate rockstart
+
+    This will run the following generators:
+        rockstart:logging
+        rockstart:rspec
+        rockstart:quality
+        rockstart:postgres (depending on database)
+        rockstart:smtp_mailer
+        rockstart:docker

data/lib/generators/rockstart/devise/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Installs Device for User Authentication
+
+Example:
+    rails generate rockstart:devise
+
+    This will create:
+        A basic devise Install
+        A User model with a UUID primary key

data/lib/generators/rockstart/devise/devise_generator.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+require "rockstart/base_generator"
+
+class Rockstart::DeviseGenerator < Rockstart::BaseGenerator
+  include Rails::Generators::Migration
+
+  # Implement the required interface for Rails::Generators::Migration.
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :devise_layout, type: :string,
+                               desc: "Custom layout used by all devise controllers",
+                               default: "application"
+
+  class_option :pundit, type: :boolean,
+                        desc: "Include Pundit support",
+                        default: true
+
+  class_option :skip_controllers, type: :boolean,
+                                  desc: "Skip Generating custom Devise Controllers",
+                                  default: false
+
+  class_option :skip_migration, type: :boolean,
+                                desc: "Skip create user model migration generation",
+                                default: false
+
+  class_option :skip_model, type: :boolean,
+                            desc: "Skip model generation",
+                            default: false
+
+  def add_namae_gem
+    gem "namae"
+  end
+
+  def add_user_model
+    directory "models", "app/models"
+  end
+
+  def add_user_migration
+    return if options[:skip_migration]
+
+    migration_template "create_user_migration.rb.tt", "db/migrate/create_users.rb"
+  end
+
+  def install_devise
+    gem "devise"
+
+    bundle_install do
+      Dir.mktmpdir do |dir|
+        generate_devise_install(dir)
+        directory File.join(dir, "config"), "config"
+      end
+    end
+  end
+
+  def add_devise_controllers
+    return if options[:skip_controllers]
+
+    Bundler.with_clean_env do
+      Dir.mktmpdir do |dir|
+        generate_devise_controllers(dir)
+        add_pundit_support(dir) if options[:pundit]
+        devise_controllers.each do |controller|
+          copy_file File.join(dir, controller_path(controller)), controller_path(controller)
+        end
+      end
+    end
+  end
+
+  def generate_user_model
+    return if options[:skip_model]
+
+    Bundler.with_clean_env do
+      generate "devise", "User"
+    end
+  end
+
+  def inject_routes
+    return if options[:skip_controllers]
+
+    controller_templates = devise_controllers.map do |controller|
+      "    #{controller}: \"users/#{controller}\""
+    end.join(",\n")
+
+    gsub_file "config/routes.rb", /devise_for :users.*$$/ do
+      ["devise_for :users, controllers: {", controller_templates, "  }"].join("\n")
+    end
+  end
+
+  def add_rspec_coverage
+    directory "spec"
+  end
+
+  def update_application_url_concerns
+    change_application_url("url_for_authentication", "new_user_session_path")
+  end
+
+  def add_testing_variables
+    append_file ".env.development", "DEVISE_MAILER_SENDER=devise-mailer@localhost\n"
+    append_file ".env.test", "DEVISE_MAILER_SENDER=devise-mailer@example.com\n"
+  end
+
+  private
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5_and_up?
+  end
+
+  def generate_devise_install(dir)
+    initializer = build_devise_install_generator(dir)
+    initializer.invoke_all
+
+    update_initializer(dir)
+    make_devise_paranoid(dir)
+    send_email_on_email_change(dir)
+    send_email_on_password_change(dir)
+    add_translations(dir)
+  end
+
+  def build_devise_install_generator(dir)
+    require "generators/devise/install_generator"
+
+    initializer = ::Devise::Generators::InstallGenerator.new(
+      report_stream: StringIO.new
+    )
+    initializer.destination_root = dir
+    initializer
+  end
+
+  def update_initializer(dir)
+    gsub_file devise_initializer(dir),
+              /config\.mailer_sender = ['"][^'"]+['']/,
+              'config.mailer_sender = ENV.fetch("DEVISE_MAILER_SENDER",' \
+              " Rails.application.credentials.devise_mailer_sender)"
+    gsub_file devise_initializer(dir),
+              /config\.secret_key = ['"][^'"]+['']/,
+              'config.secret_key = ENV.fetch("DEVISE_SECRET_KEY")'
+    gsub_file devise_initializer(dir),
+              /config\.pepper = ['"][^'"]+['']/,
+              'config.pepper = ENV.fetch("DEVISE_PEPPER")'
+  end
+
+  def make_devise_paranoid(dir)
+    gsub_file devise_initializer(dir),
+              /config\.paranoid = (true|false)/,
+              "config.paranoid = true"
+    uncomment_lines devise_initializer(dir), /config\.paranoid = true/
+  end
+
+  def send_email_on_email_change(dir)
+    gsub_file devise_initializer(dir),
+              /config\.send_email_changed_notification = (true|false)/,
+              "config.send_email_changed_notification = true"
+    uncomment_lines devise_initializer(dir), /config\.send_email_changed_notification = true/
+  end
+
+  def send_email_on_password_change(dir)
+    gsub_file devise_initializer(dir),
+              /config\.send_password_change_notification = (true|false)/,
+              "config.send_password_change_notification = true"
+    uncomment_lines devise_initializer(dir), /config\.send_password_change_notification = true/
+  end
+
+  def add_translations(dir)
+    inject_into_file File.join(dir, "config/locales/devise.en.yml"), after: /failure:$/ do
+      "\n      deleted_account: " \
+        "\"You've deleted your account. Please contact support if you want to recover it!\""
+    end
+  end
+
+  def devise_initializer(dir)
+    File.join(dir, "config", "initializers", "devise.rb")
+  end
+
+  def generate_devise_controllers(dir)
+    require "generators/devise/controllers_generator"
+
+    initializer = build_devise_controllers_generator(dir)
+    initializer.scope = "users"
+    initializer.invoke_all
+
+    devise_controllers.each do |controller|
+      add_layout_to_controller(dir, controller)
+    end
+  end
+
+  def build_devise_controllers_generator(dir)
+    initializer = ::Devise::Generators::ControllersGenerator.new(
+      report_stream: StringIO.new
+    )
+    initializer.destination_root = dir
+    initializer.source_paths.insert(1, File.join(self.class.source_root, "controllers"))
+    initializer
+  end
+
+  def add_layout_to_controller(dir, controller)
+    inject_into_file File.join(dir, controller_path(controller)), after: /< Devise::.*$/ do
+      "\n  layout \"#{options[:devise_layout]}\"\n"
+    end
+
+    # Replace Generic resource routes with users
+    gsub_file File.join(dir, controller_path(controller)), "/resource", "/users"
+  end
+
+  def add_pundit_support(dir)
+    use_pundit_for_update_user_details(dir)
+    add_pudit_authorize_current_user_method(dir)
+    add_pudit_authorize_current_user_callback(dir)
+    add_pudit_error_handling_concern(dir)
+  end
+
+  def use_pundit_for_update_user_details(dir)
+    gsub_file File.join(dir, controller_path("registrations")),
+              /\.permit\(:account_update.*\)/,
+              ".permit(:account_update, keys: policy(current_user).permitted_attributes_for_update)"
+  end
+
+  def add_pudit_authorize_current_user_method(dir)
+    inject_into_file File.join(dir, controller_path("registrations")), after: "protected\n" do
+      "\n" + <<~'METHOD'.gsub(/([^\n]*)\n/, "  \\1\n")
+        # Ensure the logged in user is able to update or destroy their account
+        def authorize_current_user
+          authorize current_user
+        end
+      METHOD
+    end
+  end
+
+  def add_pudit_authorize_current_user_callback(dir)
+    inject_into_file File.join(dir, controller_path("registrations")),
+                     after: /before_action :configure_account_update_params.*$/ do
+      "\n  before_action :authorize_current_user, only: %i[edit update destroy]"
+    end
+  end
+
+  def add_pudit_error_handling_concern(dir)
+    inject_into_file File.join(dir, controller_path("registrations")), after: /< Devise::.*$/ do
+      "\n  include PunditErrorHandling\n"
+    end
+  end
+
+  def controller_path(controller)
+    File.join("app", "controllers", "users", "#{controller}_controller.rb")
+  end
+
+  def devise_controllers
+    %w[sessions passwords registrations]
+  end
+end

data/lib/generators/rockstart/devise/templates/controllers/passwords_controller.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Updated Passwords Controller provided by rockstart
+class Users::PasswordsController < Devise::PasswordsController
+  # Store reset token in session so that it is not in Referer
+  before_action :move_reset_token_to_session, only: [:edit]
+
+  # GET /resource/password/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/password
+  # def create
+  #   super
+  # end
+
+  # GET /resource/password/edit?reset_password_token=abcdef
+  def edit
+    super
+    resource.reset_password_token = session[:reset_password_token]
+  end
+
+  # PUT /resource/password
+  # def update
+  #   super
+  # end
+
+  protected
+
+  def move_reset_token_to_session
+    token = params.delete(:reset_password_token)
+    return unless token
+
+    session[:reset_password_token] = token
+    redirect_to edit_password_path(resource_class.new)
+  end
+
+  def assert_reset_token_passed
+    session[:reset_password_token].blank? && super
+  end
+
+  def sign_in(resource_name, resource)
+    session.delete(:reset_password_token)
+    super
+  end
+
+  # def after_resetting_password_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sending reset password instructions
+  # def after_sending_reset_password_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+end

data/lib/generators/rockstart/devise/templates/controllers/registrations_controller.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Updated Registrations Controller provided by rockstart
+class Users::RegistrationsController < Devise::RegistrationsController
+  # before_action :configure_sign_up_params, only: %i[create]
+  before_action :configure_account_update_params, only: %i[update]
+
+  # GET /users/sign_up
+  # def new
+  #   super
+  # end
+
+  # POST /users
+  # def create
+  #   super
+  # end
+
+  # GET /users/edit
+  # def edit
+  #   super
+  # end
+
+  # PUT /users
+  # def update
+  #   super
+  # end
+
+  # DELETE /users
+  def destroy
+    resource.soft_delete
+    Devise.sign_out_all_scopes ? sign_out : sign_out(resource_name)
+    set_flash_message :notice, :destroyed
+    yield resource if block_given?
+    respond_with_navigational(resource) { redirect_to after_sign_out_path_for(resource_name) }
+  end
+
+  # GET /users/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+
+  protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_up_params
+  #   devise_parameter_sanitizer.permit(:sign_up, keys: [:attribute])
+  # end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  def configure_account_update_params
+    devise_parameter_sanitizer.permit(:account_update, keys: %i[name])
+  end
+
+  # The path used after deleting account
+  def after_sign_out_path_for(_resource)
+    new_user_registration_path
+  end
+
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # Allow the user to edit their account without providing a password
+  def update_resource(resource, params)
+    if account_update_params[:password].blank?
+      resource.update_without_password(params)
+    else
+      super
+    end
+  end
+
+  def account_update_params
+    super.tap do |params|
+      # Ensure password confirmation is included with password
+      params[:password_confirmation] ||= "" if params[:password].present?
+    end
+  end
+end

data/lib/generators/rockstart/devise/templates/controllers/sessions_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Updated Sessions Controller provided by rockstart
+class Users::SessionsController < Devise::SessionsController
+  # before_action :configure_sign_in_params, only: [:create]
+
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  protected
+
+  def after_sign_out_path_for(_resource)
+    url_for_authentication
+  end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.permit(:sign_in, keys: [:attribute])
+  # end
+end

data/lib/generators/rockstart/devise/templates/create_user_migration.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateUsers < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :users, id: :uuid do |t|
+      t.string :name
+      t.boolean :admin, default: false, null: false
+      t.datetime :deleted_at
+    end
+  end
+end

data/lib/generators/rockstart/devise/templates/models/user.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# User model used to represent registered User
+class User < ApplicationRecord
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :validatable
+
+  # email:string
+  # name:string
+  # admin:boolean
+  # deleted_at:datetime
+
+  delegate :given, :family, to: :namae
+
+  # instead of deleting users, mark them as soft deleted
+  def soft_delete
+    update_attribute(:deleted_at, Time.current)
+  end
+
+  # [devise] ensure user account is active
+  def active_for_authentication?
+    super && !deleted_at?
+  end
+
+  # [devise] provide a custom message for a soft-deleted account
+  def inactive_message
+    !deleted_at? ? super : :deleted_account
+  end
+
+  def to_s
+    # Use the stored name value for labels
+    (name_changed? ? name_was : name) || (id? ? "User ##{id}" : "Guest User")
+  end
+
+  private
+
+  def namae
+    @namae ||= Namae::Name.parse(name)
+  end
+end

data/lib/generators/rockstart/devise/templates/spec/factories/users.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    email { Faker::Internet.email }
+    password { Faker::Internet.password }
+    name { Faker::Name.name }
+
+    trait :admin do
+      admin { true }
+    end
+
+    trait :soft_deleted do
+      deleted_at { Time.zone.now }
+    end
+  end
+end