rails_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36c17f77988b58a87e4316db69ccc49e857183fc86fbb6bd29b0cbec3f9074a4
+  data.tar.gz: 6a13aa68f3ad243da3578e59177eaa3c320147bddd3623b404820bd32e3f0d26
+SHA512:
+  metadata.gz: '051813c1c44650894418ad7c8486ccf001f977a27dbf8b0aafb55d55a4b393046cd5b9446c94e8cb2d786b139215811c316e98ce9abd61f50bdafe85c76f8900'
+  data.tar.gz: d94d2918acbd20eae15a8ca93be081283d622a7db3e36efef52964489368ee31d68598048d526ce487e6b0d47a906ca2ffd9785210c48f8625a0b3eeeaaf9cf9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-01
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chuck Smith
+
+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,42 @@
+![GitHub License](https://img.shields.io/github/license/eclectic-coding/rails_app)
+[![Tests](https://github.com/eclectic-coding/rails_app/actions/workflows/ci.yml/badge.svg)](https://github.com/eclectic-coding/rails_app/actions/workflows/ci.yml)
+# RailsApp
+
+RailsApp is a gem that provides a simple way to create a new Rails application with a pre-configured set of gems and settings, utilizing the Rails application templates feature.
+
+The initial release of this gem is an opinionated template that includes the following dependencies and settings:
+- Esbuild for JavaScript bundling
+- Bootstrap for CSS styling
+- RSpec for testing
+- Code quality tools: RuboCop, Brakeman, and Bundler Audit
+
+The initial release of this gem **v.0.1.0** is starting with my personal preferences and a Rails template I have developed locally. I plan to expand the template to include more options and configurations with future releases which will make this template less opinionated.
+
+## Installation
+Install globally:
+```bash
+gem install rails_app
+```
+
+## Usage
+To bootstrap a new Rails application: `rails_app`
+
+The user will be prompted to enter the name of the new Rails application, and the select the assets pipeline to use (propshaft or sprockets).
+
+The template will then create a new Rails application with the selected options.
+
+In addition, there is a custom binstub (`bin/ci`) that can be used to run the test suite and code quality tools (rubocop, brakeman, and bundle-audit).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eclectic-coding/rails_app.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/bin/rails_app

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rails_app"
+
+RailsApp::App.rails_app

data/lib/rails_app/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+module RailsApp
+  class CLI
+    def self.start
+      prompt = TTY::Prompt.new
+
+      app_name = prompt.ask("What is the name of your application?", required: true)
+      assets = prompt.select("How would you like to manage assets?", %w[propshaft sprockets])
+
+      Command.new(app_name: app_name, assets: assets).run
+    end
+  end
+end

data/lib/rails_app/command.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RailsApp
+  class Command
+    attr_reader :app_name, :bundling, :assets
+
+    def initialize(app_name:, assets:)
+      @app_name = app_name
+      @assets = assets
+    end
+
+    def template
+      File.join(__dir__, "template", "template.rb")
+    end
+
+    def run
+      command = "rails new #{@app_name} --no-rc #{skip_spring} #{asset_management} #{javascript_bundling} #{styling_framework} #{testing_framework} -m #{template}"
+      system(command)
+    end
+
+    def skip_spring
+      "--skip-spring"
+    end
+
+    def javascript_bundling
+      "-j esbuild"
+    end
+
+    def asset_management
+      "-a propshaft" unless assets == "sprockets"
+    end
+
+    def styling_framework
+      "--css bootstrap"
+    end
+
+    def testing_framework
+      "-T"
+    end
+  end
+end

data/lib/rails_app/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsApp
+  class Error < StandardError
+  end
+end

data/lib/rails_app/rails_app.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RailsApp
+  class App
+    def self.rails_app
+      RailsApp::CLI.start
+    end
+  end
+end

data/lib/rails_app/template/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format Fuubar
+--color

data/lib/rails_app/template/.rubocop.yml

@@ -0,0 +1,5 @@
+# Omakase Ruby styling for Rails
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
+
+# Your own specialized rules go here

data/lib/rails_app/template/Brewfile

@@ -0,0 +1,11 @@
+# Install non-ruby dependencies required
+
+# Redis - For ActionCable support (and Sidekiq, caching, etc)
+# brew "redis"
+
+# Imagemagick or libvips - for processing images (avatars, file uploads, etc)
+brew "vips"
+
+# For local certs and SSL local development
+brew "mkcert"
+brew "nss"

data/lib/rails_app/template/app_bootstrap/assets/stylesheets/_customized_bootstrap.scss

@@ -0,0 +1,20 @@
+/**
+* 1 - Set SCSS variables below
+*/
+//$primary: hsl(250,78%,63%);
+//$secondary: hsl(216, 15%, 52%);
+$link-decoration: none;
+$form-label-margin-bottom: 0;
+
+//New theme
+
+/**
+* 2 - Import bare minimum of bootstrap
+*/
+@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+
+/**
+* 3 - Now you can refine Bootstrap here
+*/
+

data/lib/rails_app/template/app_bootstrap/assets/stylesheets/application.bootstrap.scss

@@ -0,0 +1,4 @@
+@import "customized_bootstrap";
+@import 'bootstrap/scss/bootstrap';
+@import 'bootstrap-icons/font/bootstrap-icons';
+@import "custom";

data/lib/rails_app/template/app_bootstrap/assets/stylesheets/custom.scss

@@ -0,0 +1,140 @@
+body {
+  font-size: 16px;
+
+  .application {
+    font-size: 20px;
+  }
+}
+
+.nav-pills {
+  & .nav-item {
+    margin: 0.13rem 0;
+    width: 100%;
+  }
+
+  & .nav-link {
+    @media (max-width: 981px) {
+      padding: 0.5rem 0.5rem;
+    }
+    padding-right: 0;
+
+    &:hover {
+      color: white;
+      background: rgba(white, 0.05);
+      width: 100%;
+    }
+
+    &.sidebar__active {
+      color: inherit;
+      background: rgba(white, 0.1);
+      padding-right: 0;
+    }
+  }
+}
+
+.icon {
+  font-size: 20px;
+}
+
+.sort {
+  position: absolute;
+  top: 1rem;
+  right: 0.5rem;
+  width: 0;
+  height: 0;
+  border-left: 6px solid transparent;
+  border-right: 6px solid transparent;
+}
+
+.sort-desc {
+  border-top: 8px solid #000000;
+}
+
+.sort-asc {
+  border-bottom: 8px solid #000000;
+}
+
+.pagy-bootstrap-nav .pagination {
+  margin-bottom: 0;
+}
+
+.trix-button-group--file-tools {
+  display: none !important;
+  margin-left: 0 !important;
+}
+
+.trix-button-group--history-tools,
+.trix-button-group--block-tools {
+  margin-left: 0 !important;
+}
+
+.trix-button-group-spacer {
+  display: none !important;
+}
+
+.trix-button--icon-link,
+.trix-button--icon-code,
+.trix-button--icon-attach {
+  display: none;
+}
+
+.event-title {
+  a {
+    color: inherit;
+    text-decoration: none;
+
+    a:hover {
+      text-decoration: underline !important;
+    }
+  }
+}
+
+address {
+  font-size: 14px;
+
+  .event-venue {
+    font-weight: 700;
+  }
+}
+
+.title-area {
+  margin-top: 0.5rem;
+  padding-bottom: 0.25rem;
+  width: 18.75rem;
+  border-bottom: 3px solid $danger;
+  text-transform: uppercase;
+}
+
+.iframe-container {
+  position: relative;
+  overflow: hidden;
+  width: 100%;
+  padding-top: 56.25%;
+}
+
+.responsive-iframe {
+  position: absolute;
+  top: 0;
+  left: 0;
+  bottom: 0;
+  right: 0;
+  width: 100%;
+  height: 100%;
+}
+
+.info-card {
+  width: 50vw !important;
+
+  @media (max-width: 600px) {
+    width: 100vw !important;
+  }
+}
+
+.read-more {
+  font-size: 15px;
+  font-weight: 700;
+  text-transform: uppercase;
+  border-radius: 0;
+  border-bottom: 3px solid $danger;
+}
+

data/lib/rails_app/template/app_bootstrap/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/lib/rails_app/template/app_bootstrap/helpers/bootstrap_helper.rb

@@ -0,0 +1,10 @@
+module BootstrapHelper
+  def bootstrap_class_for(flash_type)
+    {
+      success: "alert-success",
+      error: "alert-danger",
+      alert: "alert-warning",
+      notice: "alert-primary"
+    }.stringify_keys[flash_type.to_s] || flash_type.to_s
+  end
+end

data/lib/rails_app/template/app_bootstrap/views/devise/confirmations/new.html.erb

@@ -0,0 +1,22 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h2 class="text-center">Resend confirmation instructions</h2>
+
+    <%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
+      <%= render "devise/shared/error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.label :email, class: 'form-label' %><br />
+        <%= f.email_field :email, autofocus: true, class: 'form-control', value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %>
+      </div>
+
+      <div class="actions d-grid">
+        <%= f.submit "Resend confirmation instructions", class: 'btn btn-primary btn-lg' %>
+      </div>
+    <% end %>
+
+    <div class="text-center">
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,5 @@
+<p>Welcome <%= @email %>!</p>
+
+<p>You can confirm your account email through the link below:</p>
+
+<p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>

data/lib/rails_app/template/app_bootstrap/views/devise/mailer/email_changed.html.erb

@@ -0,0 +1,7 @@
+<p>Hello <%= @email %>!</p>
+
+<% if @resource.try(:unconfirmed_email?) %>
+	  <p>We're contacting you to notify you that your email is being changed to <%= @resource.unconfirmed_email %>.</p>
+<% else %>
+	<p>We're contacting you to notify you that your email has been changed to <%= @resource.email %>.</p>
+<% end %>

data/lib/rails_app/template/app_bootstrap/views/devise/mailer/password_change.html.erb

@@ -0,0 +1,3 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>We're contacting you to notify you that your password has been changed.</p>

data/lib/rails_app/template/app_bootstrap/views/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has requested a link to change your password. You can do this through the link below.</p>
+
+<p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
+
+<p>If you didn't request this, please ignore this email.</p>
+<p>Your password won't change until you access the link above and create a new one.</p>

data/lib/rails_app/template/app_bootstrap/views/devise/mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
+
+<p>Click the link below to unlock your account:</p>
+
+<p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>

data/lib/rails_app/template/app_bootstrap/views/devise/passwords/edit.html.erb

@@ -0,0 +1,29 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h2 class="text-center">Change your password</h2>
+
+    <%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
+      <%= render "devise/shared/error_messages", resource: resource %>
+      <%= f.hidden_field :reset_password_token %>
+
+      <div class="mb-3">
+        <%= f.password_field :password, autofocus: true, autocomplete: "off", class: 'form-control', placeholder: "Password" %>
+        <% if @minimum_password_length %>
+          <p class="text-muted"><small><%= @minimum_password_length %> characters minimum</small></p>
+        <% end %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :password_confirmation, autocomplete: "off", class: 'form-control', placeholder: "Confirm Password" %>
+      </div>
+
+      <div class="mb-3 d-grid">
+        <%= f.submit "Change my password", class: 'btn btn-primary btn-lg' %>
+      </div>
+    <% end %>
+
+    <div class="text-center">
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/passwords/new.html.erb

@@ -0,0 +1,20 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h2 class="text-center">Reset your password</h2>
+    <%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
+      <%= render "devise/shared/error_messages", resource: resource %>
+      <p class="text-center">Enter your email address below and we will send you a link to reset your password.</p>
+
+      <div class="mb-3">
+        <%= f.email_field :email, autofocus: true, placeholder: 'Email address', class: 'form-control' %>
+      </div>
+
+      <div class="mb-3 d-grid">
+        <%= f.submit "Send password reset email", class: 'btn btn-primary btn-lg' %>
+      </div>
+    <% end %>
+    <div class="text-center">
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/registrations/edit.html.erb

@@ -0,0 +1,45 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h1 class="text-center">Account</h1>
+
+    <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %>
+      <%= render "devise/shared/error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.email_field :email, class: 'form-control', placeholder: 'Email Address' %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :avatar, class: "form-label" %>
+        <%= f.file_field :avatar, accept:'image/*' %>
+      </div>
+
+      <%= image_tag avatar_path(f.object), class: "rounded border shadow-sm d-block mx-auto my-3" %>
+
+      <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+        <div class="alert alert-warning">Currently waiting confirmation for: <%= resource.unconfirmed_email %></div>
+      <% end %>
+
+      <div class="mb-3">
+        <%= f.password_field :password, autocomplete: "off", class: 'form-control', placeholder: 'Password'  %>
+        <p class="form-text text-muted"><small>Leave password blank if you don't want to change it</small></p>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :password_confirmation, autocomplete: "off", class: 'form-control', placeholder: 'Confirm Password'  %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :current_password, autocomplete: "off", class: 'form-control', placeholder: 'Current Password'  %>
+        <p class="form-text text-muted"><small>We need your current password to confirm your changes</small></p>
+      </div>
+
+      <div class="mb-3 d-grid">
+        <%= f.submit "Save Changes", class: 'btn btn-lg btn-primary' %>
+      </div>
+    <% end %>
+    <hr>
+
+    <p class="text-center"><%= link_to "Deactivate my account", registration_path(resource_name), data: { confirm: "Are you sure? You cannot undo this." }, method: :delete %></p>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/registrations/new.html.erb

@@ -0,0 +1,29 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h1 class="text-center">Sign Up</h1>
+
+    <%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+      <%= render "devise/shared/error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.email_field :email, autofocus: false, class: 'form-control', placeholder: "Email Address" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :password, autocomplete: "off", class: 'form-control', placeholder: 'Password' %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :password_confirmation, autocomplete: "off", class: 'form-control', placeholder: 'Confirm Password' %>
+      </div>
+
+      <div class="mb-3 d-grid">
+        <%= f.submit "Sign up", class: "btn btn-primary btn-lg" %>
+      </div>
+    <% end %>
+
+    <div class="text-center">
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/sessions/new.html.erb

@@ -0,0 +1,32 @@
+<div class="row">
+  <div class="col-lg-4 offset-lg-4">
+    <h1 class="text-center">Log in</h1>
+
+    <%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+      <div class="mb-3">
+        <%= f.email_field :email, autofocus: true, placeholder: 'Email Address', class: 'form-control' %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.password_field :password, autocomplete: "off", placeholder: 'Password', class: 'form-control' %>
+      </div>
+
+      <% if devise_mapping.rememberable? -%>
+        <div class="form-check">
+          <label class="form-check-label">
+            <%= f.check_box :remember_me, class: "form-check-input" %>
+            Remember me
+          </label>
+        </div>
+      <% end -%>
+
+      <div class="mb-3 d-grid">
+        <%= f.submit "Log in", class: "btn btn-primary btn-lg" %>
+      </div>
+    <% end %>
+
+    <div class="text-center">
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/lib/rails_app/template/app_bootstrap/views/devise/shared/_error_messages.html.erb

@@ -0,0 +1,15 @@
+<% if resource.errors.any? %>
+  <div id="error_explanation" class="alert alert-danger">
+    <h6>
+      <%= I18n.t("errors.messages.not_saved",
+                 count: resource.errors.count,
+                 resource: resource.class.model_name.human.downcase)
+       %>
+    </h6>
+    <ul>
+      <% resource.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>