rails_app_generator 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c6189ce2463be4e23bbda3e3b1d17c03142b60a7a754feeb7d7dcc75c26fc5f
-  data.tar.gz: 2d216396594ae4ee2d86626c9b3202419ae6a69536f564e7ba3a044771f7bd0d
+  metadata.gz: 7ceb2efc08d6f164b434c85b95ad2f33648e545d7482fd78ec3678aa50c91b11
+  data.tar.gz: d8380a66709a7907f26cf22db768c714e32cb9058e336207fd19b9f64e76b17f
 SHA512:
-  metadata.gz: 56a17d613f635bb7242ca6c04a93f0ec0f8a03ca987a30813ad15ce3f9d015eb174d8ec7d14d24a12cab3e0011756d702e67704ddfb2841e39ca1e18b1921683
-  data.tar.gz: 35bb905e32d9d650f828754ac4696ddd13c55ed9503f9bd270f30addae97c3a8b6e53ef8cd450c70a65b5630ac5437e1db8e0fc1a4a55a25c5a416c71e92c82f
+  metadata.gz: f77a3033aa8900f2f13c7324c864d74acaee2dd3159f47c476f2ff4c7ed5b1ca50f7f8a2c3ef5dd8fdee2199663f1d7afd634d43f655ea9a3b287c39f9d77d87
+  data.tar.gz: 267b51005953b88b77f692ab24693a49b494c66f774f0e0afa0cd7d93613d21694164e17a3b0d7e4a7c9eb1c39d704b924c9b11b67379e8c3f41d57028098ecd

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.3.2](https://github.com/klueless-io/rails_app_generator/compare/v0.3.1...v0.3.2) (2022-09-11)
+
+
+### Bug Fixes
+
+* update factory_bot profile ([aa121e3](https://github.com/klueless-io/rails_app_generator/commit/aa121e35efd88b9ed5704cacf4f348e50e4c7dc2))
+* update factory_bot profile ([7b5247d](https://github.com/klueless-io/rails_app_generator/commit/7b5247dd44e239ec20eff74dd64be9d5d05d0e72))
+
+## [0.3.1](https://github.com/klueless-io/rails_app_generator/compare/v0.3.0...v0.3.1) (2022-09-02)
+
+
+### Bug Fixes
+
+* rename to when_folder_exist ([3363b0c](https://github.com/klueless-io/rails_app_generator/commit/3363b0c5df5c161f3578ae422b79c3bb7f3b863e))
+
 # [0.3.0](https://github.com/klueless-io/rails_app_generator/compare/v0.2.43...v0.3.0) (2022-09-02)
 
 

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 gem install rails_app_generator
 ```
 
-Use the Gem
+### Use the Gem
 
 ```
 rag rag-simple
@@ -30,6 +30,27 @@ rag rag-tailwind
 rag rag-bootstrap
 ```
 
+### Create new Addon to Rails App Generator
+
+If you need to make a new addon available then use `thor addon:new`
+
+Generally an Addon will be for a gem so if you use the `--gem` option, it will bring in the GEM info such as latest version number
+
+```
+thor addon:new image_processing --gem
+thor addon:new kaminari --gem
+```
+
+### Create new Profile to Rails App Generator
+
+A profile is a sample Rails application template with files that allows you to test one or more Addons and produces a working Rails 7 application.
+
+If you are just keeping the example to a simple GEM then use the `--variant` option with the folder you would like to write code into, e.g. `addons`
+
+```
+thor profile:new factory_bot --variant=addons
+thor profile:new kaminari --variant=addons
+```
 
 ## Notes
 

data/after_templates/addons/factory_bot/_.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# factory_bot provides a framework and DSL for defining and using factories - less error-prone, more explicit, and all-around easier to work with than fixtures.
+#
+# exe/rag addons/factory_bot
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+prepare_environment
+
+after_bundle do
+  create_db
+  scaffolds
+  setup_customizations
+  migrate_db
+end
+
+def scaffolds
+  add_scaffold('region', 'name', 'settings:json')
+  add_scaffold('company', 'name', 'slug', 'active:boolean', 'region:references')
+  add_scaffold('role', 'code', 'description') # contributor, moderator, admin
+  add_scaffold('employee', 'first_name', 'last_name', 'address:text', 'email', 'password', 'company:references')
+  add_scaffold('employee_role', 'employee:references', 'role:references')
+  add_scaffold('project', 'name', 'status', 'budget:decimal', 'country', 'progress:integer', 'company:references')
+  add_scaffold('article', 'title', 'body:text', 'is_featured:boolean', 'published:datetime', 'employee:references', 'company:references')
+  add_scaffold('video', 'title', 'youtube_id', '', 'article:references')
+  add_scaffold('reserved', 'new', 'do', 'end')
+end
+
+# https://speakerdeck.com/toshimaru/factorybot-the-right-way
+def setup_customizations
+  route("root 'home#index'")
+
+  force_copy
+  
+  add_controller('home', 'index', 'test_data', 'sample_data')
+
+  directory "app/controllers"
+  directory "app/models"
+  directory "app/views"
+  template  'app/views/layouts/application.html.erb'        , 'app/views/layouts/application.html.erb'
+  directory "app/services"
+  directory 'config'
+  directory 'custom_factories'
+end
+
+def create_db
+  # uncomment this if you need custom configuration in database.yml
+  # gsub_file('config/database.yml', '  encoding: unicode', db_development_settings)
+  db(create: true)
+end
+
+def migrate_db
+  template  'db/seeds.rb'                                   , 'db/seeds.rb'
+
+  db(migrate: true, seed: true)
+end
+
+def db_development_settings
+  <<-'RUBY'
+  encoding: unicode
+  host: 127.0.0.1
+  username: printspeak
+  password: printspeak
+  RUBY
+end

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

@@ -0,0 +1,16 @@
+class HomeController < ApplicationController
+  def index
+  end
+
+  def test_data
+    SeedService.seed(variant: :test_data)
+
+    redirect_back_or_to root_path
+  end
+
+  def seed_data
+    SeedService.seed(variant: :seed_data)
+
+    redirect_back_or_to root_path
+  end
+end

data/after_templates/addons/factory_bot/app/services/seed_service.rb

@@ -0,0 +1,68 @@
+class SeedService
+  include FactoryBot::Syntax::Methods
+
+  class << self
+    def seed(variant: :test_data)
+      service = SeedService.new
+      service.call(variant: variant)
+    end
+  end
+
+  def call(variant: :reset)
+    reset
+    generate_test_data    if variant == :test_data
+    generate_sample_data  if variant == :sample_data
+  end
+
+  private
+
+  def reset
+    Video.delete_all
+    Article.delete_all
+    Project.delete_all
+    EmployeeRole.delete_all
+    Employee.delete_all
+    Role.delete_all
+    Company.delete_all
+    Region.delete_all
+  end
+
+  # add_scaffold('region', 'name', 'settings:json')
+  # add_scaffold('company', 'name', 'slug', 'active:boolean', 'region:references')
+  # add_scaffold('role', 'code', 'description') # contributor, moderator, admin
+  # add_scaffold('employee', 'first_name', 'last_name', 'address:text', 'email', 'password', 'company:references')
+  # add_scaffold('employee_role', 'employee:references', 'role:references')
+  # add_scaffold('project', 'name', 'status', 'budget:decimal', 'country', 'progress:integer', 'company:references')
+  # add_scaffold('article', 'title', 'body:text', 'is_featured:boolean', 'published:datetime', 'employee:references', 'company:references')
+  # add_scaffold('video', 'title', 'youtube_id', '', 'article:references')
+
+  def generate_test_data
+    test_data_regions
+    # companies = create_list(:company, rand(3..5))#, region: region)
+    # companies = create_list(:company, rand(3..5))#, region: region)
+    # employees = create_list(:employee, rand(10..20), company: companies.sample)
+    # _articles = create_list(:article, rand(10..20), company: companies.sample, employee: employees.sample)
+    # _projects = create_list(:project, rand(10..20), company: companies.sample)
+  end
+
+  def generate_sample_data
+    regions = create_list(:region, rand(2..5))
+    companies = create_list(:company, rand(3..5))#, region: region)
+    # companies = create_list(:company, rand(3..5))#, region: region)
+    # employees = create_list(:employee, rand(10..20), company: companies.sample)
+    # _articles = create_list(:article, rand(10..20), company: companies.sample, employee: employees.sample)
+    # _projects = create_list(:project, rand(10..20), company: companies.sample)
+  end
+
+  private
+
+  def test_data_regions
+    @region_western_sydney = create(:region, :western_sydney)
+    @region_western_sydney2 = create(:region, :western_sydney) # create it again Sam
+    @region_sydney = create(:region, :sydney)
+    @region_eastern_suburbs = create(:region, :eastern_suburbs)
+    @region_inner_west = create(:region, :inner_west)
+    @region_north_shore = create(:region, :north_shore)
+    @regions_random = create_list(:region, 4)
+  end
+end

data/after_templates/addons/factory_bot/app/views/articles/index.html.erb

@@ -0,0 +1,32 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Articles</h1>
+
+<div id="articles">
+  <table>
+    <thead>
+      <tr>
+        <th>title</th>
+        <th>Youtube ID</th>
+        <th>Article</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @videos.each do |video| %>
+      <tr>
+        <td><%= video.name %></td>
+        <td><%= video.status %></td>
+        <td><%= video.budget %></td>
+        <td><%= video.country %></td>
+        <td><%= video.company&.name %></td>
+        <td><%= link_to "Show", video %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+  
+</div>
+
+<%= link_to "New article", new_article_path %>

data/after_templates/addons/factory_bot/app/views/companies/index.html.erb

@@ -0,0 +1,33 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Companies</h1>
+
+<div id="companies">
+
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Slug</th>
+        <th>Active</th>
+        <th>Region</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @companies.each do |company| %>
+      <tr>
+        <td><%= company.name %></td>
+        <td><%= company.slug %></td>
+        <td><%= company.active %></td>
+        <td><%= company.region&.name %></td>
+        <td><%= link_to "Show", company %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New company", new_company_path %>

data/after_templates/addons/factory_bot/app/views/employee_roles/index.html.erb

@@ -0,0 +1,30 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Employee roles</h1>
+
+<div id="employee_roles">
+
+  <table>
+    <thead>
+      <tr>
+        <th>Employee</th>
+        <th>Role</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @employee_roles.each do |employee_role| %>
+      <tr>
+        <td><%= employee_role.employee&.name %></td>
+        <td><%= employee_role.role&.name %></td>
+        <td><%= link_to "Show", employee_role %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+
+</div>
+
+<%= link_to "New employee role", new_employee_role_path %>

data/after_templates/addons/factory_bot/app/views/employees/index.html.erb

@@ -0,0 +1,36 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Employees</h1>
+
+<div id="employees">
+  <table>
+    <thead>
+      <tr>
+        <th>First Name</th>
+        <th>Last Name</th>
+        <th>Address</th>
+        <th>Email</th>
+        <th>Password</th>
+        <th>Company</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @employees.each do |employee| %>
+      <tr>
+        <td><%= employee.first_name %></td>
+        <td><%= employee.last_name %></td>
+        <td><%= employee.address %></td>
+        <td><%= employee.email %></td>
+        <td><%= employee.password %></td>
+        <td><%= employee.company&.name %></td>
+        <td><%= link_to "Show", employee %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New employee", new_employee_path %>

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

@@ -0,0 +1,3 @@
+<h1>Factory bot</h1>
+
+<p>factory_bot provides a framework and DSL for defining and using factories - less error-prone, more explicit, and all-around easier to work with than fixtures.</p>

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

@@ -0,0 +1,17 @@
+<%= link_to 'Home', root_path %>
+| <%= link_to 'Region', regions_path %>
+| <%= link_to 'Company', companies_path %>
+
+
+
+| <%= link_to 'Video', videos_path %>
+| <%= link_to 'Article', articles_path %>
+| <%= link_to 'Project', projects_path %>
+| <%= link_to 'EmployeeRole', employee_roles_path %>
+| <%= link_to 'Employee', employees_path %>
+| <%= link_to 'Role', roles_path %>
+| <%= link_to 'Reserved', reserveds_path %>
+
+| <%= link_to 'Test Data', home_test_data_path, style: 'color: blue; font-weight: 600;' %>
+| <%= link_to 'Sample Data', home_sample_data_path, style: 'color: blue; font-weight: 600;' %>
+<hr />

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

@@ -0,0 +1,29 @@
+<!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>
+    <header>
+      <%%= render 'layouts/navbar' %>
+      <hr />
+    </header>
+    <main>
+      <%%= yield %>
+    </main>
+    <footer>
+      <%%= render 'layouts/footer' %>
+    </footer>
+  </body>
+</html>
+

data/after_templates/addons/factory_bot/app/views/projects/index.html.erb

@@ -0,0 +1,36 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Projects</h1>
+
+<div id="projects">
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Status</th>
+        <th>Budget</th>
+        <th>Country</th>
+        <th>Progress</th>
+        <th>Project</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @projects.each do |project| %>
+      <tr>
+        <td><%= project.name %></td>
+        <td><%= project.status %></td>
+        <td><%= project.budget %></td>
+        <td><%= project.country %></td>
+        <td><%= project.progress %></td>
+        <td><%= project.project&.name %></td>
+        <td><%= link_to "Show", project %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New project", new_project_path %>

data/after_templates/addons/factory_bot/app/views/regions/index.html.erb

@@ -0,0 +1,29 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Regions</h1>
+
+<div id="regions">
+
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Settings</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @regions.each do |region| %>
+      <tr>
+        <td><%= region.name %></td>
+        <td><%= region.settings %></td>
+        <td><%= link_to "Show", region %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New region", new_region_path %>

data/after_templates/addons/factory_bot/app/views/roles/index.html.erb

@@ -0,0 +1,29 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Roles</h1>
+
+<div id="roles">
+  <table>
+    <thead>
+      <tr>
+        <th>title</th>
+        <th>Youtube ID</th>
+        <th>Article</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @roles.each do |role| %>
+      <tr>
+        <td><%= role.code %></td>
+        <td><%= role.description %></td>
+        <td><%= link_to "Show", role %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New role", new_role_path %>

data/after_templates/addons/factory_bot/app/views/videos/index.html.erb

@@ -0,0 +1,31 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Videos</h1>
+
+<div id="videos">
+
+  <table>
+    <thead>
+      <tr>
+        <th>title</th>
+        <th>Youtube ID</th>
+        <th>Article</th>
+      </tr>
+    </thead>
+    <tbody>
+
+    <% @videos.each do |video| %>
+      <tr>
+        <td><%= video.name %></td>
+        <td><%= video.slug %></td>
+        <td><%= video.article&.title %></td>
+        <td><%= link_to "Show", video %></td>
+      </tr>
+    <% end %>
+
+    </tbody>
+  </table>
+
+</div>
+
+<%= link_to "New video", new_video_path %>