rails_app_generator 0.2.43 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d9ac313ea8fc5383a7d3d37ed9495fff8509f9b7dd1ff373ed97c80ce69ae23
-  data.tar.gz: bb65bdcc19d95bfb69abf92458dbe0eec353a8b3085ba8e679d72955ab55f425
+  metadata.gz: c53c84982de8f9b1f3180f4c84b7527a04cc623dac815cdec90d325f7e56183f
+  data.tar.gz: 0f2d44fc8597836b396faa7b3ef6995896e41222b34362a0cb73802bd2fbd70d
 SHA512:
-  metadata.gz: 6f0ccd26ef5090325cbb6a76408fd201bbce81d8bbd739618e14393eebe0cc6814bb9e24eecdfec7dd7fd07664fe9e52ed1e47d92343461b45ab3378d37e22f7
-  data.tar.gz: 70dee6a466c8976ba4f385d532b34325d188a83599df9d4fcd4330b6805f9f0dcc580141fc4ad5e9d1b9a393c4b2084698f7a2771254b7839a18a4f98471765c
+  metadata.gz: 0d2f6fe3d00ca2befc5acaf668f58f655c60e7f0a0d14f7670067f5e3847861e92cf93a927d284d36546a26bf85ea8beebb7ac76cc183d88c0bf2b06e8c60d18
+  data.tar.gz: 24704cce18d58445b1a1d69122df8e098e3f2b87627030df4b1e863931e7320e0da89e71b8e5d4ac7e886c03c01d7b593aec20da3cc3165703771e8b5945c4c9

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [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)
+
+
+### Features
+
+* add target_folder_exists handling ([cf0b7c6](https://github.com/klueless-io/rails_app_generator/commit/cf0b7c6d9b09fddc6cef940b17d3ce431b9c4eff))
+
+## [0.2.43](https://github.com/klueless-io/rails_app_generator/compare/v0.2.42...v0.2.43) (2022-08-31)
+
+
+### Bug Fixes
+
+* add scenic profile ([dc309e6](https://github.com/klueless-io/rails_app_generator/commit/dc309e6f399cec7085de3133aa32989bc7ff7ed4))
+* add scenic profile ([44614f7](https://github.com/klueless-io/rails_app_generator/commit/44614f70d73fe41cee5fd9cb9af5d20f0aa4f915))
+
 ## [0.2.42](https://github.com/klueless-io/rails_app_generator/compare/v0.2.41...v0.2.42) (2022-08-30)
 
 

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,82 @@
+# 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
+
+# Goals:
+# - Store Factories in subfolder under spec
+# -
+# - Use the faker GEM with both standard and custom data
+# - Custom data goes in custom locales folder, see: https://stackoverflow.com/questions/28153540/extending-faker-in-a-gem-where-do-i-put-the-yaml-file
+# - Use associations to affectively create related records
+# - Create default and NULL factory example
+# - Create Seed Data services
+# - Add support for STI
+# - Add support for polymorphic associations
+# Things to be aware of in faker
+# - Random focused data is better then sequence
+#   sequence(:name) { |n| "Category #{n}" }
+#   vs
+#   name { Faker::Hipster.word }
+# - 
+
+
+def scaffolds
+  add_scaffold('app', 'title', 'description', 'settings:json')
+  add_scaffold('tenant', 'name', 'slug', 'active:boolean', 'app:references')
+  add_scaffold('role', 'code') # contributor, moderator, admin
+  add_scaffold('employee', 'first_name', 'last_name', 'address:text', 'email', 'password', 'tenant:references', 'role:references')
+  add_scaffold('project', 'name', 'status', 'budget:decimal', 'country', 'progress:integer', 'tenant:references')
+  add_scaffold('article', 'title', 'body:text', 'is_featured:boolean', 'employee:references', 'tenant:references')
+  add_scaffold('video', 'title', 'youtube_id', '', 'article:references')
+end
+
+def setup_customizations
+  route("root 'home#index'")
+
+  force_copy
+  
+  add_controller('home', 'index', 'reseed')
+
+  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"
+  copy_file 'factories.rb'
+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,10 @@
+class HomeController < ApplicationController
+  def index
+  end
+
+  def reseed
+    SeedService.seed(variant: :reset)
+
+    redirect_back_or_to root_path
+  end
+end

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

@@ -0,0 +1,35 @@
+class SeedService
+  class << self
+    def seed(variant: :reset)
+      service = SeedService.new
+      service.call(variant: variant)
+    end
+  end
+
+  def call(variant: :reset)
+    reset     if variant == :reset
+    refresh   if variant == :refresh
+    create
+  end
+
+  private
+
+  def reset
+    Article.delete_all
+    Project.delete_all
+    Employee.delete_all
+    Tenant.delete_all
+    App.delete_all
+  end
+
+  def refresh
+  end
+
+  def create
+    app = FactoryBot.create(:app)
+    tenants = FactoryBot.create_list(:tenant, rand(10..20), app: app)
+    employees = FactoryBot.create_list(:employee, rand(10..20), tenant: tenants.sample)
+    _articles = FactoryBot.create_list(:article, rand(10..20), tenant: tenants.sample, employee: employees.sample)
+    _projects = FactoryBot.create_list(:project, rand(10..20), tenant: tenants.sample)
+  end
+end

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,10 @@
+<%= link_to 'Home', root_path %>
+| <%= link_to 'Apps', apps_path %>
+| <%= link_to 'Tenants', tenants_path %>
+| <%= link_to 'Employees', employees_path %>
+| <%= link_to 'Roles', roles_path %>
+| <%= link_to 'Projects', projects_path %>
+| <%= link_to 'Articles', articles_path %>
+| <%= link_to 'Videos', videos_path %>
+| <%= link_to 'Re-Seed', home_reseed_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/db/seeds.rb

@@ -0,0 +1 @@
+SeedService.seed

data/after_templates/addons/factory_bot/factories.rb

@@ -0,0 +1,73 @@
+FactoryBot.define do
+  factory :app do
+    title { Faker::Name.name } # Faker::App.name
+    description { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+    settings { { 'foo' => 'bar' } }
+  end
+
+  factory :tenant do
+    name { Faker::Name.name }
+    slug { Faker::Internet.slug }
+    active { [true, false].sample }
+    app
+  end
+
+  factory :employee do
+    first_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    email { Faker::Internet.email }
+    password { Faker::Internet.password }
+    address { Faker::Address.full_address }
+  end
+
+  factory :article do
+    title { Faker::Quote.famous_last_words }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+    is_featured { [true, false].sample }
+  end
+
+  factory :project do
+    name { Faker::App.name }
+    status { [:closed, :rejected, :failed, :loading, :running, :waiting, :done, :finalized, :archived, :finished].sample }
+    budget { Faker::Number.decimal(l_digits: 4) }
+    country { Faker::Address.country_code }
+    progress { Faker::Number.between(from: 0, to: 100) }
+  end
+end
+
+def examples
+  Faker::Name.name
+  Faker::Name.unique.name
+
+  Faker::Internet.email
+
+  Faker::Artist.name
+  Faker::Address.city #=> "Imogeneborough"
+  Faker::Address.street_name #=> "Larkin Fork"
+  Faker::Address.street_address #=> "282 Kevin Brook"
+  Faker::Address.secondary_address #=> "Apt. 672"
+  Faker::Address.building_number #=> "7304"
+  Faker::Address.mail_box #=> "PO Box 123"
+  Faker::Address.community #=> "University Crossing"
+  Faker::Address.zip_code #=> "58517" or "23285-4905"
+  Faker::Address.zip #=> "58517" or "66259-8212"
+  Faker::Address.postcode #=> "76032-4907" or "58517"
+  Faker::Address.time_zone #=> "Asia/Yakutsk"
+  Faker::Address.street_suffix #=> "Street"
+  Faker::Address.city_suffix #=> "fort"
+  Faker::Address.city_prefix #=> "Lake"
+  Faker::Address.state #=> "California"
+  Faker::Address.state_abbr #=> "AP"
+  Faker::Address.country #=> "French Guiana"
+
+  # Keyword arguments: code
+  Faker::Address.country_by_code(code: 'NL') #=> "Netherlands"
+
+  # Keyword arguments: name
+  Faker::Address.country_name_to_code(name: 'united_states') #=> "US"
+  Faker::Address.country_code #=> "IT"
+  Faker::Address.country_code_long #=> "ITA"
+  Faker::Address.latitude #=> "-58.17256227443719"
+  Faker::Address.longitude #=> "-156.65548382095133"
+  Faker::Address.full_address #=> "282 Kevin Brook, Imogeneborough, CA 58517"
+end

data/after_templates/application/klueless/.rubocop.yml

@@ -0,0 +1,40 @@
+require:
+  - rubocop-rails
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - bin/*
+    - db/schema.rb
+    - db/migrate/*
+    - node_modules/**/*
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc']
+  AllowedMethods: ['describe', 'context']
+
+Metrics/BlockLength:
+  AllowedMethods: ['describe', 'context']
+  Exclude:
+    - config/environments/*.rb
+    - '**/*.rake'
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/EmptyBlock:
+  Exclude:
+    - spec/factories/*
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false

data/after_templates/application/klueless/_.rb

@@ -14,9 +14,9 @@ after_bundle do
   force_copy
   create_db
   scaffolds
+  setup_avo
   setup_customizations
   migrate_db
-  setup_avo
 
   swap1 = '  resources :users'
   swap2 = "  devise_for :users, controllers: { sessions: 'users/sessions', registrations: 'users/registrations' }"
@@ -27,6 +27,8 @@ end
 def scaffolds
   add_scaffold_controller('users', 'name', 'email')
 
+  add_scaffold('booking', 'name', 'state')
+
   add_scaffold('rails_app', 'name', 'user:references') # name of the rails_app
 
   # no of records in each table per region
@@ -44,6 +46,9 @@ def scaffolds
   # add_scaffold('db_schema_foreign_key', 'left', 'right', 'name', 'on_update', 'on_delete', 'column', 'db_schema_table:references')
   # add_scaffold('db_schema_index', 'name', 'fields', 'using', 'order:jsonb', 'where', 'unique', 'db_schema_table:references')
   # add_scaffold('db_schema_view', 'name', 'materialized:boolean', 'sql_definition', 'db_schema_table:references')
+
+  generate('scenic:model rubocop_entry --materialized')
+  generate('scenic:model table_count_entry')
 end
 
 def setup_customizations
@@ -51,36 +56,50 @@ def setup_customizations
 
   force_copy
   
-  add_controller('home', 'index', 'quick_signin', 'reseed')
+  add_controller('home', 'index', 'quick_signin', 'reseed', 'refresh_material_view')
   
   directory "app/controllers"
   directory "app/models"
   directory "app/views"
   template  'app/views/layouts/application.html.erb', 'app/views/layouts/application.html.erb'
   directory "app/queries"
+  directory "app/services"
+  directory "db/views" # takes views from both scaffolds and customizations
+
+  copy_file '.rubocop.yml', '.rubocop.yml'
 end
 
 def setup_avo
-  # generate('avo:install')
+  generate('avo:resource rails_app')
+
+  generate('avo:resource table_count')
+  generate('avo:resource table_count_entry')
+  generate('avo:filter   table_count_tablename_filter')
+
+  generate('avo:resource rubocop')
+  generate('avo:resource_tool rubocop_info')
+
+  generate('avo:resource rubocop_entry')
+  generate('avo:filter   rubocop_entry_cop_filter')
+  generate('avo:filter   rubocop_entry_filename_filter')
+  generate('avo:filter   rubocop_entry_message_filter')
+  generate('avo:filter   rubocop_entry_status_filter')
+
+  generate('avo:resource db_schema')
+  generate('avo:resource user')
 
-  generate('avo:resource RailsApp')
-  generate('avo:resource TableCount')
-  generate('avo:resource Rubocop')
-  generate('avo:resource DbSchema')
-  generate('avo:resource User')
   # generate('avo:dashboard Dashboard')
 
   directory "app/avo"
   directory "config/initializers"
   directory "config/locales"
-
-  # # add devise support
-  # gsub_file 'config/initializers/avo.rb', %(# config.current_user_method = {}), 'config.current_user_method = :current_user'
 end
 
 def create_db
   gsub_file('config/database.yml', '  encoding: unicode', db_development_settings)
-  db(drop: true, create: true)
+
+  db_recreate(environment: :development)
+  db_recreate(environment: :test)
 end
 
 def migrate_db

data/after_templates/application/klueless/app/avo/cards/amount_raised.rb

@@ -0,0 +1,14 @@
+class AmountRaised < Avo::Dashboards::MetricCard
+  self.id = "amount_raised"
+  self.label = "Amount raised"
+  # self.description = "Some description"
+  # self.cols = 1
+  # self.initial_range = 30
+  # self.ranges = [7, 30, 60, 365, "TODAY", "MTD", "QTD", "YTD", "ALL"]
+  self.prefix = "$"
+  # self.suffix = ""
+
+  query do
+    result 9001
+  end
+end

data/after_templates/application/klueless/app/avo/cards/example_custom_partial.rb

@@ -0,0 +1,7 @@
+class ExampleCustomPartial < Avo::Dashboards::PartialCard
+  self.id = "users_custom_card"
+  self.cols = 3
+  self.rows = 4
+  self.partial = "avo/cards/custom_card"
+  self.description = "This card has been loaded from a custom partial."
+end

data/after_templates/application/klueless/app/avo/cards/example_metric.rb

@@ -0,0 +1,38 @@
+class ExampleMetric < Avo::Dashboards::MetricCard
+  self.id = "users_metric"
+  self.label = "Users count"
+  self.description = "Users description"
+  self.cols = 1
+  self.initial_range = 30
+  self.ranges = [7, 30, 60, 365, "TODAY", "MTD", "QTD", "YTD", "ALL"]
+  # self.prefix = "$"
+  # self.suffix = "%"
+  self.refresh_every = 10.minutes
+
+  # You have access to context, params, range, current dashboard, and current card
+  query do
+    from = Date.today.midnight - 1.week
+    to = DateTime.current
+
+    if range.present?
+      if range.to_s == range.to_i.to_s
+        from = DateTime.current - range.to_i.days
+      else
+        case range
+        when "TODAY"
+          from = DateTime.current.beginning_of_day
+        when "MTD"
+          from = DateTime.current.beginning_of_month
+        when "QTD"
+          from = DateTime.current.beginning_of_quarter
+        when "YTD"
+          from = DateTime.current.beginning_of_year
+        when "ALL"
+          from = Time.at(0)
+        end
+      end
+    end
+
+    result User.where(created_at: from..to).count
+  end
+end

data/after_templates/application/klueless/app/avo/cards/percent_done.rb

@@ -0,0 +1,10 @@
+class PercentDone < Avo::Dashboards::MetricCard
+  self.id = "percent_done"
+  self.label = "Percent done"
+  self.description = "This is the progress we made so far..."
+  self.suffix = "%"
+
+  query do
+    result 42
+  end
+end

data/after_templates/application/klueless/app/avo/cards/rubocop_card.rb

@@ -0,0 +1,10 @@
+class RubocopCard < Avo::Dashboards::PartialCard
+  self.id = "percent_done"
+  self.label = "Percent done"
+  self.description = "This is the progress we made so far..."
+
+  self.cols = 3
+  self.rows = 20
+  self.partial = "avo/cards/rubocop_card"
+
+end

data/after_templates/application/klueless/app/avo/filters/rubocop_entry_cop_filter.rb

@@ -0,0 +1,15 @@
+class RubocopEntryCopFilter < Avo::Filters::MultipleSelectFilter
+  self.name = "Cop"
+
+  def apply(_request, query, values)
+    query.where(cop: values)
+  end
+
+  def options
+    RubocopEntry
+      .select(:cop)
+      .distinct
+      .order(:cop)
+      .map { |entry| [entry.cop, entry.cop] }.to_h
+  end
+end

data/after_templates/application/klueless/app/avo/filters/rubocop_entry_filename_filter.rb

@@ -0,0 +1,13 @@
+class RubocopEntryFilenameFilter < Avo::Filters::TextFilter
+  self.name = "FileName"
+
+  def apply(_request, query, value)
+    values = value.split(" ")
+
+    values.each do |word|
+      query = query.where("file_name ILIKE ?", "%#{word}%")
+    end
+
+    query
+  end
+end

data/after_templates/application/klueless/app/avo/filters/rubocop_entry_message_filter.rb

@@ -0,0 +1,13 @@
+class RubocopEntryMessageFilter < Avo::Filters::TextFilter
+  self.name = "Message"
+
+  def apply(_request, query, value)
+    values = value.split(" ")
+
+    values.each do |word|
+      query = query.where("message ILIKE ?", "%#{word}%")
+    end
+
+    query
+  end
+end

data/after_templates/application/klueless/app/avo/filters/rubocop_entry_status_filter.rb

@@ -0,0 +1,15 @@
+class RubocopEntryStatusFilter < Avo::Filters::SelectFilter
+  self.name = "Status"
+
+  def apply(_request, query, value)
+    query.where(status: value)
+  end
+
+  def options
+    RubocopEntry
+      .select(:status)
+      .distinct
+      .order(:status)
+      .map { |entry| [entry.status, entry.status] }.to_h
+  end
+end

data/after_templates/application/klueless/app/avo/filters/table_count_entry_tablename_filter.rb

@@ -0,0 +1,13 @@
+class TableCountEntryTablenameFilter < Avo::Filters::TextFilter
+  self.name = "Table Name"
+
+  def apply(_request, query, value)
+    values = value.split(" ")
+
+    values.each do |word|
+      query = query.where("table_name ILIKE ?", "%#{word}%")
+    end
+
+    query
+  end
+end

data/after_templates/application/klueless/app/avo/resource_tools/rubocop_info.rb

@@ -0,0 +1,4 @@
+class RubocopInfo < Avo::BaseResourceTool
+  self.name = "Rubocop info"
+  self.partial = "avo/resource_tools/rubocop_info"
+end