rails_app 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b73c531dad7b7d7b4edabbdc901203e9a0d2563e4242d5e03c0c3ecb50e43d
-  data.tar.gz: 1143480576ce1db9c61f9bccc64fc926c48f76df7a5c50ff1e8e9437e7cec3de
+  metadata.gz: abe9ca28918f70a2b71b19040764b860567c4ea7a58fc020dad211a80e10cfb7
+  data.tar.gz: '0283ec9fae9b1c6438830c486c3eadcbd090f7c74ba78fe965e930bc08c3453e'
 SHA512:
-  metadata.gz: 474c3b2e72b6f906ec8d3fce8916037f7ab6e0aae04171614c11fd020262f97fe82be39cff3ab04765e0e734ba4883a0a55bce1a77936b57d47061f3b47bf7f5
-  data.tar.gz: 1e74bc4238c3e44d46f5282664d98d6acc1787de9cb7f6985c2939810741c96ee7686bb1abc418f07e8065067ffd962a1b6682750105563e815b5265607fc312
+  metadata.gz: 70d9bb94900977be4b5b8d79589f44c93d97e916a6914ebec7b91792bb810a08fb4fe3fdaade63298b39b2fd751910993750da751cb00b6c444097d8bfb99a31
+  data.tar.gz: 93c4942b640be06a3bd09bd85af99b101b95eeff4f9ad389a03f1d2643da8e539f15afd6d527da59372eedd65aac60494f98e3f234d7a7d79eec012ec9365e77

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
-## [Unreleased](https://github.com/eclectic-coding/rails_app/tree/HEAD)
+## [0.3.0](https://github.com/eclectic-coding/rails_app/tree/0.3.0) (2024-04-03)
 
-[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.1.0...HEAD)
+[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.2.0...0.3.0)
+
+**Implemented enhancements:**
+
+- Add user option to select other styling systems [\#2](https://github.com/eclectic-coding/rails_app/issues/2)
+- add user option to select sass styling systems [\#7](https://github.com/eclectic-coding/rails_app/pull/7) ([eclectic-coding](https://github.com/eclectic-coding))
+
+## [0.2.0](https://github.com/eclectic-coding/rails_app/tree/0.2.0) (2024-04-03)
+
+[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.1.0...0.2.0)
 
 **Closed issues:**
 

data/README.md

@@ -8,7 +8,7 @@ The initial release of this gem is an opinionated template that includes the fol
 - Esbuild for JavaScript bundling
 - Bootstrap for CSS styling
 - RSpec for testing
-- Code quality tools: RuboCop, Brakeman, and Bundler Audit
+- 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.
 
@@ -21,11 +21,27 @@ 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 user will be prompted to enter the name of the new Rails application, and the select the assets pipeline to use (propshaft or sprockets), and a styling option:
+
+![](./screenshot_cli.png)
 
 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).
+### Testing
+The template includes RSpec for testing, which includes pre configured:
+- FactoryBot
+- Faker
+- Webmock
+- VCR
+- Simplecov
+
+### Code Quality Tools
+The template includes the following code quality tools:
+- Rubocop using the `rubocop-rails-omakase` gem with a few custom settings in a provided `.rubocop.yml`
+- Brakeman for security scanning
+- Bundler Audit for checking for vulnerable gems
+
+All of this tools can be run using the following command, which also will run the test suite: `bin/ci`
 
 ## Development
 

data/lib/rails_app/cli.rb

@@ -9,8 +9,16 @@ module RailsApp
 
       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])
+      styling_choices = [
+        {name: "Bootstrap", value: "bootstrap"},
+        {name: "Tailwind CSS", value: "tailwindcss", disabled: "(coming soon)"},
+        {name: "Bulma", value: "bulma", disabled: "(coming soon)"},
+        {name: "PostCSS", value: "postcss", disabled: "(coming soon)"},
+        {name: "SASS", value: "sass"}
+      ]
+      styling = prompt.select("How would you like to manage styling?", styling_choices)
 
-      Command.new(app_name: app_name, assets: assets).run
+      Command.new(app_name: app_name, assets: assets, styling: styling).run
     end
   end
 end

data/lib/rails_app/command.rb

@@ -4,9 +4,10 @@ module RailsApp
   class Command
     attr_reader :app_name, :bundling, :assets
 
-    def initialize(app_name:, assets:)
+    def initialize(app_name:, assets:, styling:)
       @app_name = app_name
       @assets = assets
+      @styling = styling
     end
 
     def template
@@ -15,6 +16,7 @@ module RailsApp
 
     def run
       command = "rails new #{@app_name} --no-rc #{skip_spring} #{asset_management} #{javascript_bundling} #{styling_framework} #{testing_framework} -m #{template}"
+      puts command
       system(command)
     end
 
@@ -31,7 +33,7 @@ module RailsApp
     end
 
     def styling_framework
-      "--css bootstrap"
+      "--css #{@styling}"
     end
 
     def testing_framework

data/lib/rails_app/template/app_sass/assets/stylesheets/application.sass.scss

@@ -0,0 +1,2 @@
+// Entry point for your Sass build
+@import 'custom.sass.scss';

data/lib/rails_app/template/app_sass/assets/stylesheets/custom.sass.scss

@@ -0,0 +1,49 @@
+a {
+  text-decoration: none;
+}
+
+body {
+  background-color: #eceeef;
+  font-family: Verdana, Helvetica, Arial;
+  font-size: 14px;
+
+  .container {
+    width: 80%;
+    margin: 0 auto;
+    background-color: #fff;
+    padding: 20px 40px;
+    margin-top: 25px;
+    border: solid 1px black;
+  }
+}
+
+nav ul {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+  overflow: hidden;
+  display: flex;
+
+  li {
+    margin-right: 1rem;
+
+    a {
+      display: block;
+      color: black;
+      text-align: center;
+      padding: 14px 16px;
+      text-decoration: none;
+
+      &:hover {
+        border-radius: 5px;
+        background-color: #ececec;
+        color: black;
+      }
+    }
+  }
+}
+
+.field,
+.actions {
+  margin-bottom: 1rem;
+}

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

@@ -0,0 +1,16 @@
+<h2>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="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email", value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Resend confirmation instructions" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

data/lib/rails_app/template/app_sass/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_sass/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_sass/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_sass/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_sass/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_sass/views/devise/passwords/edit.html.erb

@@ -0,0 +1,25 @@
+<h2>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="field">
+    <%= f.label :password, "New password" %><br />
+    <% if @minimum_password_length %>
+      <em>(<%= @minimum_password_length %> characters minimum)</em><br />
+    <% end %>
+    <%= f.password_field :password, autofocus: true, autocomplete: "new-password" %>
+  </div>
+
+  <div class="field">
+    <%= f.label :password_confirmation, "Confirm new password" %><br />
+    <%= f.password_field :password_confirmation, autocomplete: "new-password" %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Change my password" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

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

@@ -0,0 +1,16 @@
+<h2>Forgot 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 %>
+
+  <div class="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email" %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Send me reset password instructions" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

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

@@ -0,0 +1,43 @@
+<h2>Edit <%= resource_name.to_s.humanize %></h2>
+
+<%= 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="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email" %>
+  </div>
+
+  <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+    <div>Currently waiting confirmation for: <%= resource.unconfirmed_email %></div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :password %> <i>(leave blank if you don't want to change it)</i><br />
+    <%= f.password_field :password, autocomplete: "new-password" %>
+    <% if @minimum_password_length %>
+      <br />
+      <em><%= @minimum_password_length %> characters minimum</em>
+    <% end %>
+  </div>
+
+  <div class="field">
+    <%= f.label :password_confirmation %><br />
+    <%= f.password_field :password_confirmation, autocomplete: "new-password" %>
+  </div>
+
+  <div class="field">
+    <%= f.label :current_password %> <i>(we need your current password to confirm your changes)</i><br />
+    <%= f.password_field :current_password, autocomplete: "current-password" %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Update" %>
+  </div>
+<% end %>
+
+<h3>Cancel my account</h3>
+
+<div>Unhappy? <%= button_to "Cancel my account", registration_path(resource_name), data: { confirm: "Are you sure?", turbo_confirm: "Are you sure?" }, method: :delete %></div>
+
+<%= link_to "Back", :back %>

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

@@ -0,0 +1,29 @@
+<h2>Sign up</h2>
+
+<%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+  <%= render "devise/shared/error_messages", resource: resource %>
+
+  <div class="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email" %>
+  </div>
+
+  <div class="field">
+    <%= f.label :password %>
+    <% if @minimum_password_length %>
+    <em>(<%= @minimum_password_length %> characters minimum)</em>
+    <% end %><br />
+    <%= f.password_field :password, autocomplete: "new-password" %>
+  </div>
+
+  <div class="field">
+    <%= f.label :password_confirmation %><br />
+    <%= f.password_field :password_confirmation, autocomplete: "new-password" %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Sign up" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

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

@@ -0,0 +1,26 @@
+<h2>Log in</h2>
+
+<%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+  <div class="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email" %>
+  </div>
+
+  <div class="field">
+    <%= f.label :password %><br />
+    <%= f.password_field :password, autocomplete: "current-password" %>
+  </div>
+
+  <% if devise_mapping.rememberable? %>
+    <div class="field">
+      <%= f.check_box :remember_me %>
+      <%= f.label :remember_me %>
+    </div>
+  <% end %>
+
+  <div class="actions">
+    <%= f.submit "Log in" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

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

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

data/lib/rails_app/template/app_sass/views/devise/shared/_links.html.erb

@@ -0,0 +1,25 @@
+<%- if controller_name != 'sessions' %>
+  <%= link_to "Log in", new_session_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.registerable? && controller_name != 'registrations' %>
+  <%= link_to "Sign up", new_registration_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %>
+  <%= link_to "Forgot your password?", new_password_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
+  <%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
+  <%= link_to "Didn't receive unlock instructions?", new_unlock_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.omniauthable? %>
+  <%- resource_class.omniauth_providers.each do |provider| %>
+    <%= button_to "Sign in with #{OmniAuth::Utils.camelize(provider)}", omniauth_authorize_path(resource_name, provider), data: { turbo: false } %><br />
+  <% end %>
+<% end %>

data/lib/rails_app/template/app_sass/views/devise/unlocks/new.html.erb

@@ -0,0 +1,16 @@
+<h2>Resend unlock instructions</h2>
+
+<%= form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f| %>
+  <%= render "devise/shared/error_messages", resource: resource %>
+
+  <div class="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, autocomplete: "email" %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Resend unlock instructions" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

data/lib/rails_app/template/app_sass/views/layouts/application.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Catapp</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_include_tag "application", "data-turbo-track": "reload", type: "module" %>
+  </head>
+
+  <body>
+    <div class="container">
+      <%= render 'shared/navbar' %>
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/lib/rails_app/template/app_sass/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/rails_app/template/app_sass/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/lib/rails_app/template/app_sass/views/shared/_navbar.html.erb

@@ -0,0 +1,11 @@
+<nav>
+    <ul>
+        <li><%= link_to 'Home', root_path %></li>
+        <% if user_signed_in? %>
+          <li><%= button_to "Log out", destroy_user_session_path, method: :delete %></li>
+        <% else %>
+          <li><%= link_to "Login", new_user_session_path %></li>
+          <li><%= link_to "Sign Up", new_user_registration_path %></li>
+        <% end%>
+    </ul>
+</nav>

data/lib/rails_app/template/app_sass/views/static/home.html.erb

@@ -0,0 +1,2 @@
+<h1>Static#home</h1>
+<p>Find me in app/views/static/home.html.erb</p>

data/lib/rails_app/template/template.rb

@@ -3,8 +3,7 @@
 require "fileutils"
 require "shellwords"
 
-puts "options: #{options}"
-puts "args: #{args}"
+# puts "options: #{options}"
 
 def add_template_to_source_path
   source_paths.unshift(File.expand_path(File.join(__dir__)))
@@ -70,8 +69,18 @@ def add_static
   route "root to: 'static#home'"
 end
 
-def add_bootstrap
-  directory "app_bootstrap", "app", force: true
+def add_styling
+  if options[:css] == "bootstrap"
+    directory "app_bootstrap", "app", force: true
+  elsif options[:css] == "tailwindcss"
+    say "TAILWIND CSS COMING SOON", :red
+  elsif options[:css] == "bulma"
+    say "BULMA COMING SOON", :red
+  elsif options[:css] == "postcss"
+    say "POSTCSS COMING SOON", :red
+  elsif options[:css] == "sass"
+    directory "app_sass", "app", force: true
+  end
 end
 
 def setup_rspec
@@ -129,7 +138,7 @@ after_bundle do
   add_esbuild_script
   add_users
   add_static
-  add_bootstrap
+  add_styling
   setup_rspec
   copy_templates
   database_setup

data/lib/rails_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsApp
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_app
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -117,6 +117,27 @@ files:
 - lib/rails_app/template/app_bootstrap/views/shared/_navbar.html.erb
 - lib/rails_app/template/app_bootstrap/views/shared/_notices.html.erb
 - lib/rails_app/template/app_bootstrap/views/static/home.html.erb
+- lib/rails_app/template/app_sass/assets/stylesheets/application.sass.scss
+- lib/rails_app/template/app_sass/assets/stylesheets/custom.sass.scss
+- lib/rails_app/template/app_sass/views/devise/confirmations/new.html.erb
+- lib/rails_app/template/app_sass/views/devise/mailer/confirmation_instructions.html.erb
+- lib/rails_app/template/app_sass/views/devise/mailer/email_changed.html.erb
+- lib/rails_app/template/app_sass/views/devise/mailer/password_change.html.erb
+- lib/rails_app/template/app_sass/views/devise/mailer/reset_password_instructions.html.erb
+- lib/rails_app/template/app_sass/views/devise/mailer/unlock_instructions.html.erb
+- lib/rails_app/template/app_sass/views/devise/passwords/edit.html.erb
+- lib/rails_app/template/app_sass/views/devise/passwords/new.html.erb
+- lib/rails_app/template/app_sass/views/devise/registrations/edit.html.erb
+- lib/rails_app/template/app_sass/views/devise/registrations/new.html.erb
+- lib/rails_app/template/app_sass/views/devise/sessions/new.html.erb
+- lib/rails_app/template/app_sass/views/devise/shared/_error_messages.html.erb
+- lib/rails_app/template/app_sass/views/devise/shared/_links.html.erb
+- lib/rails_app/template/app_sass/views/devise/unlocks/new.html.erb
+- lib/rails_app/template/app_sass/views/layouts/application.html.erb
+- lib/rails_app/template/app_sass/views/layouts/mailer.html.erb
+- lib/rails_app/template/app_sass/views/layouts/mailer.text.erb
+- lib/rails_app/template/app_sass/views/shared/_navbar.html.erb
+- lib/rails_app/template/app_sass/views/static/home.html.erb
 - lib/rails_app/template/bin/ci
 - lib/rails_app/template/bin/setup
 - lib/rails_app/template/bin/yarn
@@ -131,6 +152,7 @@ files:
 - lib/rails_app/template/template.rb
 - lib/rails_app/version.rb
 - rails_app.gemspec
+- screenshot_cli.png
 homepage: https://github.com/eclectic-coding/rails_app
 licenses:
 - MIT