rails_app_generator 0.3.2 → 0.3.3

data/after_templates/addons/factory_bot/{factories.rb → custom_factories/_examples.rb}

@@ -1,45 +1,33 @@
-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
+  # description { Faker::Lorem.paragraphs(number: rand(1...3)).join("\n") }
   Faker::Name.name
   Faker::Name.unique.name
+  Faker::Name.unique.first_name
+  Faker::Name.unique.last_name
+  
+  Faker::Hacker.unique.say_something_smart
+  Faker::String.unique.troublesome
+
+  Faker::Lorem.unique.sentences.join(' ')
+  Faker::Lorem.unique.words.join(' ')
+  Faker::Lorem.unique.characters(10)
+  Faker::Lorem.unique.paragraphs.join("\n\n")
 
   Faker::Internet.email
+  Faker::Internet.unique.user_name
+  Faker::Internet.unique.url
+  Faker::Internet.unique.ip_v4_address
+
+  Faker::Number.unique.between(1, 10_000)
+  Faker::Number.unique.decimal(4, 2)
+
+  Faker::Company.catch_phrase
+  Faker::Company.buzzword
+  # When a straight answer won't do, BS to the rescue!
+  Faker::Company.bs
+  Faker::Company.logo #=> "https://pigment.github.com/fake-logos/logos/medium/color/5.png"
+  Faker::Company.profession #=> "firefighter"
+  Faker::Company.australian_business_number #=> "81137773602"
 
   Faker::Artist.name
   Faker::Address.city #=> "Imogeneborough"

data/after_templates/addons/factory_bot/custom_factories/article.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :article do
+    title { Faker::Quote.famous_last_words }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+    is_featured { [true, false].sample }
+    published { rand(1..10) > 8 ? nil : rand(1..20).days.ago }
+    # employee { nil }
+    # tenant { nil }
+    trait :unpublished do
+      published { nil }
+    end
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/company.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :company do
+    active { [true, false].sample }
+    name { Faker::Name.name }
+    slug { Faker::Internet.slug }
+    # region
+    # region { nil }
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/employee.rb

@@ -0,0 +1,37 @@
+FactoryBot.define do
+  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 }
+    role # { %i[role_contributor role_moderator role_admin].sample }
+    # tenant { nil }
+    # role { nil }
+
+    # trait :contributor do
+    #   role :contributor_role
+    # end
+
+    # trait :moderator do
+    #   role :moderator_role
+    # end
+
+    # trait :admin do
+    #   role :admin_role
+    # end
+
+    # factory :contributor_user , traits: [:contributor]
+    # factory :moderator_user   , traits: [:moderator]
+    # factory :admin_user       , traits: [:admin]
+
+  end
+
+  # factory :employee do
+  #   first_name { "MyString" }
+  #   last_name { "MyString" }
+  #   address { "MyText" }
+  #   email { "MyString" }
+  #   password { "MyString" }
+  # end
+end

data/after_templates/addons/factory_bot/custom_factories/project.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :project do
+    name { Faker::App.name }
+    status { %i[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) }
+    # tenant { nil }
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/region.rb

@@ -0,0 +1,32 @@
+FactoryBot.define do
+  factory :region do
+    name { Faker::Australia.location } # Faker::App.name
+    settings { Faker::Json.shallow_json(width: 3, options: { key: 'Name.first_name', value: 'Name.last_name' }) }
+
+    # These traits are used to define well known variations of a factory
+    trait :western_sydney do
+      name { 'Western Sydney' }
+      settings { { 'suburbs' => ['Blacktown', 'Parramatta', 'Penrith', 'Campbelltown', 'Liverpool'] } }
+    end
+
+    trait :sydney do
+      name { 'Sydney CBD' }
+      settings { { 'suburbs' => ['Sydney', 'Sydney CBD', 'Surry Hills', 'Darling Harbour', 'Barangaroo'] } }
+    end
+
+    trait :eastern_suburbs do
+      name { 'Eastern Suburbs' }
+      settings { { 'suburbs' => ['Bondi', 'Bondi Beach', 'Bondi Junction', 'Bronte', 'Coogee', 'Darlinghurst'] }}
+    end
+
+    trait :inner_west do
+      name { 'Inner West' }
+      settings { { 'suburbs' => ['Ashfield', 'Burwood', 'Campsie', 'Croydon', 'Newtown'] } }
+    end
+
+    trait :north_shore do
+      name { 'North Shore' }
+      settings { { 'suburbs' => ['Pymble', 'Castle Cove', 'Castlecrag', 'Chatswood', 'Crows Nest', 'Cremorne'] } }
+    end
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/role.rb

@@ -0,0 +1,21 @@
+FactoryBot.define do
+  factory :role do
+    code { 'user' }
+
+    trait :contributor do
+      code { 'contributor' }
+    end
+
+    trait :moderator do
+      code { 'moderator' }
+    end
+
+    trait :admin do
+      code { 'admin' }
+    end
+
+    # factory :contributor_role , traits: [:contributor]
+    # factory :moderator_role   , traits: [:moderator]
+    # factory :admin_role       , traits: [:admin]
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/user.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  # Attach factory name to a class, similar outcome to using aliases
+  factory :user, class: "Employee"  do
+    active { [true, false].sample }
+    name { 'User 1' }
+    slug { 'user-1' }
+    # region
+    # # region { nil }
+  end
+end

data/after_templates/addons/factory_bot/custom_factories/video.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :video do
+    title { Faker::Movie.title }
+    youtube_id { Faker::Barcode.ean }
+    # article { nil }
+  end
+end

data/after_templates/addons/rspec/_.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# BDD for Ruby
+#
+# exe/rag addons/rspec
+
+# NOTE: Currently not implemented fully
+
+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('post', 'title', 'body:text', 'user:references')
+  # add_scaffold('people', 'first_name', 'last_name', 'age:integer', 'address:text')
+  # add_scaffold('product', 'name', 'price:integer')
+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'
+  directory "app/services"
+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(drop: true, 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/rspec/app/controllers/home_controller.rb

@@ -0,0 +1,8 @@
+class HomeController < ApplicationController
+  def index
+  end
+
+  # def reseed
+  #   SeedService.seed
+  # end
+end

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

@@ -0,0 +1,31 @@
+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
+    # Person.delete_all
+    # Post.delete_all
+    # Project.delete_all
+  end
+
+  def refresh
+  end
+
+  def create
+    # FactoryBot.create_list(:post, rand(10..20))
+    # FactoryBot.create_list(:person, rand(10..20))
+    # FactoryBot.create_list(:project, rand(10..20))
+  end
+end

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

@@ -0,0 +1,3 @@
+<h1>Rspec</h1>
+
+<p>BD for Ruby</p>

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

@@ -0,0 +1,5 @@
+<%= link_to 'Home', root_path %>
+| <%= link_to 'Products', products_path %>
+| <%= link_to 'Posts', posts_path %>
+| <%= link_to 'People', people_path %>
+<hr />

data/after_templates/addons/rspec/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/rspec/db/seeds.rb

@@ -0,0 +1,8 @@
+# SeedService.seed
+# david = User.create(email: 'david@site.com', name: 'david', password: 'password')
+# james = User.create(email: 'james@site.com', name: 'james', password: 'password')
+# sally = User.create(email: 'sally@site.com', name: 'sally', password: 'password')
+
+# 10.times do |i|
+#   Post.create(title: "Post #{i}", body: "This is the body of post #{i}", user: User.all.sample)
+# end

data/docs/last_run/app_generator_class.json

@@ -70,10 +70,11 @@
     "add_pretender",
     "add_public_suffix",
     "add_rails_html_sanitizer",
-    "add_scenic",
     "add_ransack",
     "add_redcarpet",
     "add_rolify",
+    "add_scenic",
+    "add_rspec",
     "add_rubocop",
     "add_twilio_ruby"
   ],
@@ -568,13 +569,6 @@
       "default": false,
       "required": false
     },
-    {
-      "name": "add_scenic",
-      "description": "Indicates when to generate add scenic",
-      "type": "boolean",
-      "default": false,
-      "required": false
-    },
     {
       "name": "add_ransack",
       "description": "Indicates when to generate add ransack",
@@ -596,6 +590,20 @@
       "default": false,
       "required": false
     },
+    {
+      "name": "add_scenic",
+      "description": "Indicates when to generate add scenic",
+      "type": "boolean",
+      "default": false,
+      "required": false
+    },
+    {
+      "name": "add_rspec",
+      "description": "Indicates when to generate add rspec",
+      "type": "boolean",
+      "default": false,
+      "required": false
+    },
     {
       "name": "add_rubocop",
       "description": "Indicates when to generate add rubocop",

data/docs/last_run/app_generator_data.json

@@ -60,10 +60,11 @@
     "add_pretender": false,
     "add_public_suffix": false,
     "add_rails_html_sanitizer": false,
-    "add_scenic": false,
     "add_ransack": false,
     "add_redcarpet": false,
     "add_rolify": false,
+    "add_scenic": false,
+    "add_rspec": false,
     "add_rubocop": false,
     "add_twilio_ruby": false,
     "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/factory_bot/_.rb"

data/docs/last_run/rails_options_class.json

@@ -70,10 +70,11 @@
     "add_pretender",
     "add_public_suffix",
     "add_rails_html_sanitizer",
-    "add_scenic",
     "add_ransack",
     "add_redcarpet",
     "add_rolify",
+    "add_scenic",
+    "add_rspec",
     "add_rubocop",
     "add_twilio_ruby"
   ],
@@ -569,28 +570,35 @@
       "required": false
     },
     {
-      "name": "add_scenic",
+      "name": "add_ransack",
       "description": "",
       "type": "boolean",
       "default": false,
       "required": false
     },
     {
-      "name": "add_ransack",
+      "name": "add_redcarpet",
       "description": "",
       "type": "boolean",
       "default": false,
       "required": false
     },
     {
-      "name": "add_redcarpet",
+      "name": "add_rolify",
       "description": "",
       "type": "boolean",
       "default": false,
       "required": false
     },
     {
-      "name": "add_rolify",
+      "name": "add_scenic",
+      "description": "",
+      "type": "boolean",
+      "default": false,
+      "required": false
+    },
+    {
+      "name": "add_rspec",
       "description": "",
       "type": "boolean",
       "default": false,

data/docs/last_run/rails_options_data.json

@@ -70,13 +70,13 @@
     "add_pretender": false,
     "add_public_suffix": false,
     "add_rails_html_sanitizer": false,
-    "add_scenic": false,
     "add_ransack": false,
     "add_redcarpet": false,
     "add_rolify": false,
+    "add_scenic": false,
+    "add_rspec": false,
     "add_rubocop": false,
     "add_twilio_ruby": false,
-    "add_factory_bot": true,
-    "add_rspec": true
+    "add_factory_bot": true
   }
 }

data/lib/rails_app_generator/addons/rspec.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+# lib/rails_app_generator/rag_initializer.rb
+# add_if(:rspec)
+# rag.add_option :add_rspec            , type: :boolean, default: false
+
 module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
-    # Add RSpec unit testing support to rails application
+    # Add Rspec to rails application
     class Rspec < RailsAppGenerator::Addon
+      required_gem gem.version('rspec', '3.11.0', 'BDD for Ruby')
+
       depends_on :test
 
       def apply

data/lib/rails_app_generator/app_generator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# require 'rails/generators/rails/app/app_generator'
-
 module RailsAppGenerator
   #  AppGenerator is a wrapper for Rails::AppGenerator
   class AppGenerator < Rails::Generators::AppGenerator
@@ -153,15 +151,13 @@ module RailsAppGenerator
       add_if(:rubocop)
     end
 
-    # def create_test_files
-    #   return if options[:skip_test]
-
-    #   super if options[:test] == 'minitest'
+    def create_test_files
+      return if options[:skip_test]
 
-    #   # puts options[:testing_framework]
+      super if options[:test] == 'minitest'
 
-    #   # add(:rspec) if options[:testing_framework] == 'rspec'
-    # end
+      add(:rspec) if active?(:rspec) || options[:test] == 'rspec'
+    end
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def finish_template
@@ -209,6 +205,7 @@ module RailsAppGenerator
       add_if(:redcarpet) # tested
       add_if(:rolify) # tested
       add_if(:scenic)
+      # add_if(:rspec) # see: create_test_filers
       add_if(:services) # TODO: needs testing
       add_if(:shoulda) # TODO: needs testing
       add_if(:sidekiq) # TODO: needs testing

data/lib/rails_app_generator/rag_initializer.rb

@@ -10,6 +10,7 @@ KConfig.configure do |config|
   # https://github.com/carbonfive/raygun-rails
   # https://github.com/abhaynikam/boring_generators
 
+  # NOTE: currently this is being done using add_rspec, but I should support this technique as well.
   # rag.add_option :test                        , type: :string , default: 'rspec'
 
   # rag.add_option :skip_namespace                , type: :boolean    , default: false         , description: "Skip namespace (affects only isolated engines)"
@@ -68,6 +69,7 @@ KConfig.configure do |config|
   # future_option   :skip_hotwire               , type: :boolean, default: false              # , description: "Skip Hotwire integration"
   # future_option   :skip_jbuilder              , type: :boolean, default: false              # , description: "Skip jbuilder gem"
   # rag.add_option    :skip_test                  , type: :boolean, default: false              # , description: "Skip test files"
+  # NOTE: currently this is being done using add_rspec, but I should support this technique as well.
   rag.add_option    :test                       , type: :string , default: 'rspec'            # , description: "minitest or rspec (default: rspec)"
   # future_option   :skip_system_test           , type: :boolean, default: false              # , description: "Skip system test files"
   # future_option   :skip_bootsnap              , type: :boolean, default: false              # , description: "Skip bootsnap gem"
@@ -139,14 +141,15 @@ KConfig.configure do |config|
   rag.add_option :add_public_suffix           , type: :boolean, default: false
   # pundit
   rag.add_option :add_rails_html_sanitizer    , type: :boolean, default: false
-  rag.add_option :add_scenic                  , type: :boolean, default: false
   # rails_app_generator
   rag.add_option :add_ransack                 , type: :boolean, default: false
   rag.add_option :add_redcarpet               , type: :boolean, default: false
   rag.add_option :add_rolify                  , type: :boolean, default: false
+  rag.add_option :add_scenic                  , type: :boolean, default: false
   # services
   # shoulda
   # sidekiq
+  rag.add_option :add_rspec                   , type: :boolean, default: false
   rag.add_option :add_rubocop                 , type: :boolean, default: false
   rag.add_option :add_twilio_ruby             , type: :boolean, default: false
 end

data/lib/rails_app_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.3.2",
+      "version": "0.3.3",
       "dependencies": {
         "daisyui": "^2.20.0"
       },

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_app_generator",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

data/profiles/addons/factory_bot.json

@@ -5,14 +5,12 @@
     "when_folder_exist": "keep_git"
   },
   "opts": {
-    "skip_git": false,
     "skip_test": true,
     "add_minimal_css": true,
     "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/factory_bot/_.rb",
     "add_annotate": true,
     "add_factory_bot": true,
     "add_factory_bot_rails": true,
-    "add_faker": true,
-    "add_rspec": true
+    "add_faker": true
   }
 }

data/profiles/addons/rspec.json

@@ -0,0 +1,14 @@
+{
+  "args": {
+    "app_path": "r7_rspec",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/addons",
+    "when_folder_exist": "destroy"
+  },
+  "opts": {
+    "skip_git": true,
+    "add_minimal_css": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/rspec/_.rb",
+    "test": "rspec",
+    "add_rspec": true
+  }
+}