rails_app_generator 0.2.21 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5040f4476242b440975bacea04755a6f5b2a3734b42bef7ff9af2716f5663477
-  data.tar.gz: d772aadc218e55633caa058345424bab72f0fc118be94bf175f0ea99523ce8a4
+  metadata.gz: f3b2288ae71fcb62d6d27a0c112af620c7ccebf29dad7f7a3ccf0b6b763960bd
+  data.tar.gz: 66acd6ef9f7663d0f71605564fa793e88e2f7c4c10427da39b21259cf9cb8ee4
 SHA512:
-  metadata.gz: 572437e5b7c05918ba39071fa9d3328aaf477924f9e738325d9c60b49563a76995245016b9af70824dc3a1c2934025d69419a68e47c274beaed7e570bb3ed27d
-  data.tar.gz: e56b65373ec558e9b854b8c39101e4f89e878b6d12a498f998b56db31b253c5dd3b99a513081546869d471c44366089ca52ea1cc3af7fd075b6563084e7d663a
+  metadata.gz: f58098fef783d509ff3005a5687c5d576c02b827ecb252b90e15f0150a73301d268dc4bd37412618b53bf4d82f21e60b02b9c46ae84ee0351ae9ddc85cc335bc
+  data.tar.gz: 02e741081aeec1eca92b1ae4260831cd0b556a243c98b3147c76b446b793d9fa1bee52949819bf02255dc00c0d9257192224fe8516834354f9d02fdf71a1017b

data/.builders/generators/project-plan.rb

@@ -41,20 +41,34 @@ KManager.action :project_plan do
 
         todo(title: 'add addon - acts_as_list')
         todo(title: 'add addon - administrate')
+        todo(title: 'add addon - annotate')
         todo(title: 'add addon - bcrypt')
         todo(title: 'add addon - browser')
         todo(title: 'add addon - chartkick')
+        # continuous_integration
+        # devise
+        # docker_compose
+        # docker
         todo(title: 'add addon - dotenv')
+        # factory_bot
         todo(title: 'add addon - faker')
+        # generators
+        todo(title: 'add addon - groupdate')
         todo(title: 'add addon - hexapdf')
-        todo(title: 'add addon - honeybadger')
         todo(title: 'add addon - httparty')
+        # high_voltage
+        todo(title: 'add addon - honeybadger')
         todo(title: 'add addon - lograge')
         todo(title: 'add addon - mini_magick')
         todo(title: 'add addon - motor_magick')
-        todo(title: 'add addon - phony_rails')
         todo(title: 'add addon - public_suffix')
+        todo(title: 'add addon - phony_rails')
+        # pundit
         todo(title: 'add addon - rails_html_sanitizer')
+        # rails_app_generator
+        # services
+        # shoulda
+        # sidekiq
         todo(title: 'add addon - redcarpet')
         todo(title: 'add addon - groupdate')
         todo(title: 'add addon - rubocop')

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## [0.2.23](https://github.com/klueless-io/rails_app_generator/compare/v0.2.22...v0.2.23) (2022-08-16)
+
+
+### Bug Fixes
+
+* add devise profile ([a665767](https://github.com/klueless-io/rails_app_generator/commit/a6657670b1fce4eb802a56ace36368505ede3c2e))
+* fix invalid gem ([377e547](https://github.com/klueless-io/rails_app_generator/commit/377e5479c4debbd0df9e1362694d1847cf7d58e0))
+* update addon to work with non gems ([f9b0b14](https://github.com/klueless-io/rails_app_generator/commit/f9b0b147859760abbb921a236cd1e7f6a97eb3f0))
+
+## [0.2.22](https://github.com/klueless-io/rails_app_generator/compare/v0.2.21...v0.2.22) (2022-08-14)
+
+
+### Bug Fixes
+
+* update avo profile ([79a3f36](https://github.com/klueless-io/rails_app_generator/commit/79a3f366f9f95e29a5f003a815c1fc963d796179))
+* update avo profile ([2830ddf](https://github.com/klueless-io/rails_app_generator/commit/2830ddff3fd327d2c162ef1e0128dc525b3a493c))
+
+## [0.2.21](https://github.com/klueless-io/rails_app_generator/compare/v0.2.20...v0.2.21) (2022-08-12)
+
+
+### Bug Fixes
+
+* add annotate profile ([1794612](https://github.com/klueless-io/rails_app_generator/commit/17946124c5600881a4d015c3283fc9e2e3278634))
+
 ## [0.2.20](https://github.com/klueless-io/rails_app_generator/compare/v0.2.19...v0.2.20) (2022-08-12)
 
 

data/after_templates/addons/avo/_.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Avo abstracts away the common parts of building apps, letting your engineers work on your app's essential components. The result is a full-featured admin panel that works out of the box, ready to give to your end-users.
+#
+# exe/rag addons/avo
+# 
+# based on: https://www.youtube.com/watch?v=WgNK-oINFww
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+prepare_environment
+
+add_controller('home', 'index')
+
+route("root 'home#index'")
+
+force_copy
+
+directory "app/controllers"
+directory "app/views/home"
+directory "app/views/layouts"
+template  'app/views/layouts/application.html.erb'        , 'app/views/layouts/application.html.erb'
+
+template  'db/seeds.rb'                                   , 'db/seeds.rb'
+
+after_bundle do
+  setup_db
+  setup_avo
+end
+
+def setup_db
+  add_scaffold('author', 'name:string', 'email:string', 'bio:text')
+  add_scaffold('category', 'title:string', 'description:text')
+  add_scaffold('post', 'title:string content:text', 'published:boolean', 'author:references', 'category:references')
+  add_scaffold('product', 'name', 'quantity:integer', 'price:decimal', 'author:references')
+
+  db_migrate
+  db_seed
+end
+
+def setup_avo
+  generate('avo:install')
+  generate('avo:resource Product')
+  generate('avo:resource Post')
+  generate('avo:resource Author')
+  generate('avo:resource Category')
+  generate('avo:resource User')
+  generate('avo:dashboard Dashboard')
+
+  # add devise support
+  gsub_file 'config/initializers/avo.rb', %(# config.current_user_method = {}), 'config.current_user_method = :current_user'
+end

data/after_templates/addons/avo/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/after_templates/addons/avo/app/views/home/index.html.erb

@@ -0,0 +1,3 @@
+<h1>Avo</h1>
+
+<p>Avo abstracts away the common parts of building apps, letting your engineers work on your app's essential components. The result is a full-featured admin panel that works out of the box, ready to give to your end-users.</p>

data/after_templates/addons/avo/app/views/layouts/_footer.html.erb

@@ -0,0 +1,3 @@
+<footer>
+  <hr />
+</footer>

data/after_templates/addons/avo/app/views/layouts/_navbar.html.erb

@@ -0,0 +1,8 @@
+<header>
+  <%= link_to 'Home', root_path %> |
+  <%= link_to 'Authors', authors_path %> |
+  <%= link_to 'Posts', posts_path %> |
+  <%= link_to 'Products', products_path %> |
+  <%= link_to 'ADMIN', avo_path %>
+  <hr />
+</header>

data/after_templates/addons/avo/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= camelized %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%%= csrf_meta_tags %>
+    <%%= csp_meta_tag %>
+
+    <%- if options[:skip_hotwire] || options[:skip_javascript] -%>
+    <%%= stylesheet_link_tag "application" %>
+    <%- else -%>
+    <%%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%- end -%>
+  </head>
+
+  <body>
+    <%%= render 'layouts/navbar' %>
+    <main>
+      <%%= yield %>
+    </main>
+    <%%= render 'layouts/footer' %>
+  </body>
+</html>

data/after_templates/addons/avo/db/seeds.rb

@@ -0,0 +1,132 @@
+def fake_category
+  [
+    'Action',
+    'Adventure',
+    'Biography',
+    'Comedy',
+    'Crime',
+    'Drama',
+    'Fantasy',
+  ]
+end
+
+def fake_title
+  [
+    'Fundamentals of Wavelets',
+    'Data Smart',
+    'God Created the Integers',
+    'Superfreakonomics',
+    'Orientalism',
+    'Nature of Statistical Learning Theory',
+    'Integration of the Indian States',
+    'Image Processing & Mathematical Morphology',
+    'How to Think Like Sherlock Holmes',
+    'Data Scientists at Work',
+    'Slaughterhouse Five',
+    'Birth of a Theorem',
+    'Structure & Interpretation of Computer Programs',
+    'Age of Wrath',
+    'Trial',
+    'Data Mining Handbook',
+    'New Machiavelli',
+    'Physics & Philosophy',
+    'Making Software',
+    'Analysis',
+    'Machine Learning for Hackers',
+    'Signal and the Noise',
+    'Python for Data Analysis',
+    'Introduction to Algorithms',
+    'Beautiful and the Damned',
+    'Outsider',
+    'Complete Sherlock Holmes',
+    'Complete Sherlock Holmes',
+    'Wealth of Nations',
+    'Pillars of the Earth',
+    'Mein Kampf',
+    'Tao of Physics',
+    'Farewell to Arms',
+    'Veteran',
+    'False Impressions',
+    'Last Lecture',
+    'Return of the Primitive',
+    'Jurassic Park',
+    'Russian Journal',
+    'Tales of Mystery and Imagination',
+    'Freakonomics',
+    'Hidden Connections',
+    'Story of Philosophy',
+    'Asami Asami',
+    'Journal of a Novel',
+    'Once There Was a War',
+    'Moon is Down',
+    'Brethren',
+    'In a Free State',
+    'Catch 22',
+    'Complete Mastermind',
+    'Dylan on Dylan',
+    'Soft Computing & Intelligent Systems',
+    'Textbook of Economic Theory',
+    'Econometric Analysis',
+    'Learning OpenCV',
+    'Data Structures Using C & C++',
+    'Computer Vision',
+    'Principles of Communication Systems',
+    'Let Us C',
+    'Amulet of Samarkand',
+    'Crime and Punishment',
+    'Angels & Demons',
+    'Argumentative Indian',
+    'Sea of Poppies',
+    'Idea of Justice',
+    'Raisin in the Sun',
+    'Prisoner of Birth',
+    'Scoop!',
+    'Ahe Manohar Tari',
+    'Last Mughal',
+    'Social Choice & Welfare',
+    'Radiowaril Bhashane & Shrutika',
+    'Gun Gayin Awadi',
+    'Aghal Paghal',
+    'Beyond Degrees',
+    'Manasa',
+    'India from Midnight to Milennium',
+    'Great Indian Novel',
+    'O Jerusalem!',
+    'City of Joy',
+    'Freedom at Midnight',
+    'Winter of Our Discontent',
+    'On Education',
+    'Free Will',
+    'Bookless in Baghdad',
+    'Case of the Lame Canary',
+    'Theory of Everything',
+    'New Markets & Other Essays',
+    'Electric Universe',
+    'Hunchback of Notre Dame',
+    'Burning Bright',
+    'Age of Discontuinity'
+  ].sample
+end
+
+60.times do
+  Author.create!(name: Faker::Name.name, bio: Faker::Lorem.words(number: 5).join(' '), email: Faker::Internet.email)
+end
+
+fake_category.each do |category|
+  Category.create!(title: category, description: Faker::Lorem.sentence)
+end
+
+100.times do |i|
+  Post.create!(title: fake_title,
+                    content: "This is the body of post #{i}",
+                    published: Faker::Boolean.boolean(true_ratio: 0.6),
+                    author: Author.all.sample)
+end
+
+200.times do
+  Product.create!(
+    name: Faker::Name.name,
+    quantity: Faker::Number.number(digits: 2),
+    price: Faker::Number.decimal(l_digits: 4)
+  )
+end

data/after_templates/addons/devise/_.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Based on guidance from:
+#   Rails 7 - Intro to Devise
+#   https://www.youtube.com/watch?v=m3uhldUGVes
+#
+# exe/rag addons/devise
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+prepare_environment
+
+after_bundle do
+  scaffolds
+  setup_customizations
+  setup_db
+end
+
+def scaffolds
+  add_scaffold('post', 'title', 'body:text', 'views:integer', 'user:references')
+end
+
+def setup_db
+  template  'db/seeds.rb'                                   , 'db/seeds.rb'
+
+  db_migrate
+  db_seed
+end
+
+def setup_customizations
+  route("root 'home#index'")
+
+  force_copy
+  
+  add_controller('home', 'index')
+  
+  directory "app/controllers"
+  directory "app/models"
+  directory "app/views"
+  template  'app/views/layouts/application.html.erb'        , 'app/views/layouts/application.html.erb'
+end
+
+# Other template command examples
+# prepare_environment
+# bundle_install
+# css_install('tailwind')
+# rails_command('db:migrate')
+# rails_command('db:migrate')
+# bundle_add('hotwire-rails')
+# rails_command('hotwire:install')
+# run('bin/importmap pin sortablejs')
+# run('npm install daisyui')
+# rubocop
+#
+# directory         'app/assets/images'
+# create_file       'app/assets/stylesheets/custom-bootstrap-import.scss' , read_template('custom-bootstrap-import.scss')
+# append_to_file    'app/assets/config/manifest.js'                       , read_template('manifest.js')
+# insert_into_file  'app/views/layouts/application.html.erb', read_template('application.html.erb'),
+#     before: %(    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>)
+# gsub_file         'app/views/layouts/application.html.erb', %(container mx-auto mt-28 px-5 flex), 'container mx-auto px-5'
+# template 'home.css', 'app/assets/stylesheets/home.css'
+#
+# add_controller('page', 'benefits', 'faq', 'terms', 'privacy', '--skip-routes')
+# route(<<-'RUBY')
+# PageController.action_methods.each do |action|
+#   get "/#{action}", to: "page##{action}", as: "page_#{action}"
+# end
+# RUBY

data/after_templates/addons/devise/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/after_templates/addons/devise/app/controllers/posts_controller.rb

@@ -0,0 +1,81 @@
+class PostsController < ApplicationController
+  before_action :authenticate_user!, except: %i[show index]
+  before_action :set_post, only: %i[show edit update destroy]
+  before_action :require_permission, only: %i[edit destroy]
+
+  def index
+    @posts = Post.all.order(updated_at: :desc)
+  end
+
+  def show
+    @post.update(views: @post.views + 1)
+  end
+
+  def new
+    @post = Post.new
+  end
+
+  def edit
+  end
+
+  def create
+    @post = Post.new(post_params)
+    @post.user = current_user
+
+    respond_to do |format|
+      if @post.save
+        format.html { redirect_to post_url(@post), notice: "Post was successfully created." }
+        format.json { render :show, status: :created, location: @post }
+      else
+        format.html { render :new, status: :unprocessable_entity }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def update
+    respond_to do |format|
+      if @post.update(post_params)
+        format.html { redirect_to post_url(@post), notice: "Post was successfully updated." }
+        format.json { render :show, status: :ok, location: @post }
+      else
+        format.html { render :edit, status: :unprocessable_entity }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    @post.destroy
+
+    respond_to do |format|
+      format.html { redirect_to posts_url, notice: "Post was successfully destroyed." }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    def set_post
+      @post = Post.find(params[:id])
+    end
+
+    def post_params
+      params.require(:post).permit(:title, :body, :views, :user_id)
+    end
+
+    def require_permission
+      current_user_name     = current_user.name.capitalize
+      post_user_name        = @post.user.name.capitalize
+      post_user_name_plural = "#{post_user_name}#{post_user_name.ends_with?('s') ? "'" : "s"}"
+
+      flash.notice = "#{current_user_name} is trying to #{action_name} #{post_user_name_plural} post."
+
+      return if current_user.admin?                                     # Administrators can do anything
+      return if current_user.moderator? && action_name == "edit"        # Moderators can edit any post (but not delete)
+      return if current_user.user? && @post.user == current_user        # Users can edit or delete their own posts
+
+      flash.alert = "You do not have permission to #{action_name} #{post_user_name_plural} post."
+
+      redirect_back(fallback_location: root_path)
+    end
+end

data/after_templates/addons/devise/app/models/post.rb

@@ -0,0 +1,11 @@
+class Post < ApplicationRecord
+  after_initialize :set_views, if: :new_record?
+
+  belongs_to :user
+
+  private
+
+  def set_views
+    self.views ||= 0
+  end
+end

data/after_templates/addons/devise/app/models/user.rb

@@ -0,0 +1,17 @@
+class User < ApplicationRecord
+  after_initialize :set_default_role, if: :new_record?
+
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+  devise :database_authenticatable, :registerable, :recoverable, :rememberable, :validatable
+
+  has_many :posts
+
+  enum role: { user: 0, moderator: 1, admin: 9 }
+
+  private
+
+  def set_default_role
+    self.role ||= :user
+  end
+end

data/after_templates/addons/devise/app/views/home/index.html.erb

@@ -0,0 +1,40 @@
+<h1>Devise</h1>
+
+<h4>Using a simple Enum based Role for permissions</h4>
+
+<ul>
+  <li>Anyone can view posts</li>
+  <li>Only signed in users can create, update or delete a post</li>
+  <li>If role <b>user</b>, you can update and delete your own posts only</li>
+  <li>If role <b>moderator</b>, you can update any post, but only delete your own posts</li>
+  <li>If role <b>admin</b>, you can update or delete any post</li>
+</ul>
+
+<h3>Sample users and passwords</h3>
+
+<style>
+  table {
+    border-collapse: collapse;
+  }
+  th, td {
+    border: 1px solid #ccc;
+    padding: 5px;
+  }
+</style>
+
+<table style='width: 600px;'>
+  <tr>
+    <th>Name</th>
+    <th>Email</th>
+    <th>Role</th>
+    <th>Password</th>
+  </tr>
+  <% User.all.each do |user| %>
+    <tr>
+      <td><%= user.name %></td>
+      <td><%= user.email %></td>
+      <td><%= user.role %></td>
+      <td>password</td>
+    </tr>
+  <% end %>
+</table>

data/after_templates/addons/devise/app/views/layouts/_footer.html.erb

@@ -0,0 +1 @@
+<hr />

data/after_templates/addons/devise/app/views/layouts/_navbar.html.erb

@@ -0,0 +1,10 @@
+<%= link_to 'Home', root_path %>
+| <%= link_to 'Posts', posts_path %>
+<% if current_user %>
+  <%= current_user.name || current_user.email %>
+| <%= link_to 'Edit', edit_user_registration_path %>
+| <%= link_to 'Sign Out', destroy_user_session_path, data: { turbo_method: :delete } %>
+<% else %>
+| <%= link_to 'Sign Up', new_user_registration_path %>
+| <%= link_to 'Sign In', new_user_session_path %>
+<% end%>

data/after_templates/addons/devise/app/views/layouts/application.html.erb

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= camelized %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%%= csrf_meta_tags %>
+    <%%= csp_meta_tag %>
+
+    <%- if options[:skip_hotwire] || options[:skip_javascript] -%>
+    <%%= stylesheet_link_tag "application" %>
+    <%- else -%>
+    <%%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%- end -%>
+    <%%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+    <style>
+    .notice {
+      color: green;
+    }
+    .alert {
+      color: red;
+    }
+    </style>
+  </head>
+
+  <body>
+    <header>
+      <%%= render 'layouts/navbar' %>
+      <hr />
+      <%%= render 'layouts/alerts' %>
+    </header>
+    <main>
+      <%%= yield %>
+    </main>
+    <footer>
+      <%%= render 'layouts/footer' %>
+    </footer>
+  </body>
+</html>

data/after_templates/addons/devise/app/views/posts/_form.html.erb

@@ -0,0 +1,27 @@
+<%= form_with(model: post) do |form| %>
+  <% if post.errors.any? %>
+    <div style="color: red">
+      <h2><%= pluralize(post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+        <% post.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.label :title, style: "display: block" %>
+    <%= form.text_field :title %>
+  </div>
+
+  <div>
+    <%= form.label :body, style: "display: block" %>
+    <%= form.text_area :body %>
+  </div>
+
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/after_templates/addons/devise/app/views/posts/_post.html.erb

@@ -0,0 +1,14 @@
+<div id="<%= dom_id post %>">
+  <h3>posted by <%= post.user.name || post.user.email %></h4>
+  <h4><%= pluralize(post.views, 'view') %></h4>
+
+  <p>
+    <strong>Title:</strong>
+    <%= post.title %>
+  </p>
+
+  <p>
+    <strong>Body:</strong>
+    <%= post.body %>
+  </p>
+</div>

data/after_templates/addons/devise/app/views/posts/index.html.erb

@@ -0,0 +1,12 @@
+<h1>Posts</h1>
+
+<div id="posts">
+  <% @posts.each do |post| %>
+    <%= render post %>
+    <p>
+      <%= link_to "Show this post", post %>
+    </p>
+  <% end %>
+</div>
+
+<%= link_to "New post", new_post_path %>

data/after_templates/addons/devise/app/views/posts/show.html.erb

@@ -0,0 +1,8 @@
+<%= render @post %>
+
+<div>
+  <%= link_to "Edit this post", edit_post_path(@post) %> |
+  <%= link_to "Back to posts", posts_path %>
+
+  <%= button_to "Destroy this post", @post, method: :delete %>
+</div>