flamerb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27b827963415a5a78744f0ee9188375a86f7fb12ea2af70b7de692e69d005879
+  data.tar.gz: 2d6fc4655d6fbd865e9f65024eb10c92a12a90b924c5d9617b90424f9595c6dd
+SHA512:
+  metadata.gz: 88d0abbb6d5773d5c4c36143e290c2a83ed9d2af9c97d524306fd50a7f9362eb805f7144beb996915b4d2bbdc7c2fbefa91113c4814474480f076aaa293fe8be
+  data.tar.gz: 1ec41342b515ae8727d60be8146d4534c25532d86e901641957ad3baaf31faeb7a370b4319b34b7015d5388e9ebf7b28324b5677516125b4c63e8e65fcdea8c2

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## v0.1.1 (2023-07-10)
+
+### Fix
+
+- conflicts with templates
+
+## v0.1.0 (2023-07-10)
+
+### Feat
+
+- add frontend template with basic configuration
+- some changes :p
+- remove devise-jwt integration
+- rename all modules
+- add devise and devise-jwt at the app generator
+- add pagination gems on the gemfile template
+- add active_model_serializer to the gemfile.erb
+- add annotate and rspec on the app generator
+- add configuration for default generators in the app builder
+- add gemfile template in app builder
+- add commitizen configuration
+
+### Refactor
+
+- refactor function on app builder on generators

data/README.md

@@ -0,0 +1,59 @@
+# Flame
+
+Flame is rails app generator inspired in [Suspenders](https://github.com/thoughtbot/suspenders)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+
+    $ gem install flame
+    $ flame <app_name>
+
+## Gemfile
+
+* [AMS](https://github.com/rails-api/active_model_serializers) for serialize json (api)
+* [Devise](https://github.com/heartcombo/devise) for user authentication
+* [Haml](https://github.com/haml/haml) we prefer use haml extension instead classic .erb
+* [Pager API](https://github.com/IcaliaLabs/pager-api) & [Pagy](https://github.com/ddnexus/pagy) for api pagination
+* [Vite](https://github.com/ElMassimo/vite_ruby) instead webpack
+* [Annotate](https://github.com/ctran/annotate_models) generate comments on the model with current schema
+
+
+for test environment we use:
+* [FactoryBot](https://github.com/thoughtbot/factory_bot)
+* [FFaker](https://github.com/ffaker/ffaker)
+* [RSpec](https://github.com/rspec/rspec-rails)
+* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers)
+* [Database Cleanner](https://github.com/DatabaseCleaner/database_cleaner)
+
+## Package.json
+* [react](https://yarnpkg.com/package/react) & [react-dom](https://yarnpkg.com/package/react-dom)
+* [formik](https://yarnpkg.com/package/formik) & [yup](https://yarnpkg.com/package/yup) for handle and validate forms.
+* [axios](https://yarnpkg.com/package/axios) for http request
+* [@reduxjs/toolkit](https://yarnpkg.com/package/@reduxjs/toolkit)
+* [react-router-dom](https://yarnpkg.com/package/react-router-dom) for routing
+* [@mui/material](https://yarnpkg.com/package/@mui/material) library for components
+* [@mui/icons-material](https://yarnpkg.com/package/@mui/icons-material) library for icons
+* [react-toastify](https://yarnpkg.com/package/react-toastify) simple and beauty notifcations.
+* [sass](https://yarnpkg.com/package/sass)
+
+for dev dependencies
+* standard
+* @vitejs/plugin-react-swc
+* eslint-plugin-react
+
+
+## Style Guide
+
+Projects created with Flame come with  [Standard](https://github.com/standardrb/standard)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/Flame.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/bin/flame

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'flame'
+
+if ARGV.empty?
+  puts "Please provide a path for the new application"
+  puts
+  puts "See --help for more info"
+  exit 0
+elsif ["-v", "--version"].include? ARGV[0]
+  puts Suspenders::VERSION
+  exit 0
+end
+
+ARGV << "--skip-javascript"
+ARGV << "--skip-jbuilder"
+ARGV << "--database=postgresql"
+ARGV << "-T"
+
+templates_path = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Flame::Generators::App.source_paths << Rails::Generators::AppGenerator.source_root << templates_path
+Flame::Generators::App.start

data/lib/flame/app_builder.rb

@@ -0,0 +1,26 @@
+module Flame
+  class AppBuilder < Rails::AppBuilder
+    def gemfile
+      template "Gemfile.erb", "Gemfile"
+    end
+
+    def configure_generators
+      config = <<-RUBY
+    config.generators do |generate|
+      generate.helper false
+      generate.javascripts false
+      generate.controller_specs false
+      generate.request_specs true
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+      generate.template_engine :haml
+    end
+
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+  end
+end

data/lib/flame/generators/app.rb

@@ -0,0 +1,51 @@
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Flame
+  module Generators
+    class App < Rails::Generators::AppGenerator
+      hide!
+      def finish_template
+        invoke :custom_template
+        invoke :generators
+        super
+      end
+
+      def custom_template
+        build :configure_generators
+      end
+
+      def generators
+        run("spring stop > /dev/null 2>&1 || true")
+        run("bundle install")
+        invoke "flame:haml"
+        rails_command "db:create"
+
+        invoke "flame:testing"
+        invoke "flame:cors"
+        invoke "flame:devise"
+        invoke "flame:vite"
+
+        generate("annotate:install")
+        run("bundle exec standardrb --fix-unsafely")
+        run("bundle exec haml-lint app/views -A -a")
+        rails_command("db:migrate") if yes?("\nDo you want to run migrations? [y/n]")
+        rails_command("db:seed") if yes?("\nDo you want to run seed? [y/n]")
+        welcome_message
+
+        exit 0
+      end
+
+      protected
+
+      def welcome_message
+        say "Flame app successfully created!", :green
+        say "Run `foreman start -f Procfile.dev` to start the server", :green
+      end
+
+      def get_builder_class
+        Flame::AppBuilder
+      end
+    end
+  end
+end

data/lib/flame/generators/base.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+require "rails/generators/base"
+
+module Flame
+  module Generators
+    class Base < Rails::Generators::Base
+      source_root File.expand_path("../../../templates", __dir__)
+
+      private
+
+      # @param [Array] packages
+      # @return [void]
+      # @example
+      #  yarn_install(["vite", "react", "react-dom"])
+      def yarn_install(packages)
+        run("yarn add #{packages.join(" ")} --silent")
+      end
+
+      # @param [Array] packages
+      # @return [void]
+      # @example
+      # yarn_install_dev(["vite", "react", "react-dom"])
+      def yarn_install_dev(packages)
+        run("yarn add -D #{packages.join(" ")} --silent")
+      end
+    end
+  end
+end

data/lib/flame/generators/cors_generator.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+
+module Flame
+  class CorsGenerator < Generators::Base
+    CONFIG = <<~RUBY
+      Rails.application.config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins Rails.env.development? ? ["localhost:5100", "127.0.0.1:5100"] : ENV["FRONTEND_URL"]
+          resource "*",
+            headers: %w[Authorization],
+            methods: :any,
+            expose: %w[Authorization],
+            max_age: 600,
+            credentials: true
+        end
+      end
+    RUBY
+
+    def create_cors_file
+      create_file("config/initializers/cors.rb", CONFIG)
+    end
+  end
+end

data/lib/flame/generators/devise_generator.rb

@@ -0,0 +1,88 @@
+require_relative "base"
+
+module Flame
+  class DeviseGenerator < Generators::Base
+    APP_CONTROLLER = <<~RUBY
+      before_action :authenticate_user!, only: [:current]
+      protect_from_forgery with: :exception, unless: :json_request?
+
+      def current
+        render json: current_user
+      end
+
+
+      private
+
+      def json_request?
+        request.format.json?
+      end
+    RUBY
+
+    SESSION_CONTROLLER = <<~RUBY
+      class SessionsController < Devise::SessionsController
+        respond_to :json
+      
+        private
+      
+        def respond_with(resource, _opts = {})
+          render json: resource
+        end
+      
+        def respond_to_on_destroy
+          head :no_content
+        end
+      end
+    RUBY
+
+    def install
+      generate("devise:install")
+      generate("devise", "User")
+    end
+
+    def add_timeoutable
+      gsub_file(
+        "app/models/user.rb",
+        /^\s*devise\s*:[a-z_]+(?:,\s*:[a-z_]+)*\s*$/,
+        "  devise :database_authenticatable, :registerable, :timeoutable, timeout_in: 1.day"
+      )
+    end
+
+    def generate_session_controller
+      create_file(
+        "app/controllers/sessions_controller.rb",
+        SESSION_CONTROLLER
+      )
+    end
+
+    def modify_session_route
+      gsub_file(
+        "config/routes.rb",
+        /devise_for\s*:\s*users/,
+        <<~RUBY
+          devise_for :users, defaults: {format: :json}, controllers: {sessions: "sessions"}
+          get "/users/current", to: "application#current", defaults: {format: :json}
+
+          get "*path", to: "pages#index", constraints: ->(request) do
+            !request.xhr? && request.format.html?
+          end
+        RUBY
+      )
+    end
+
+    def modify_app_controller
+      inject_into_class(
+        "app/controllers/application_controller.rb",
+        "ApplicationController",
+        APP_CONTROLLER
+      )
+    end
+
+    def insert_secret_key
+      inject_into_file(
+        "config/initializers/devise.rb",
+        "  config.secret_key = Rails.application.credentials.secret_key_base\n",
+        after: "Devise.setup do |config|\n"
+      )
+    end
+  end
+end

data/lib/flame/generators/haml_generator.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Flame
+  class HamlGenerator < Generators::Base
+    def convert_erb_to_haml
+      run("HAML_RAILS_DELETE_ERB=true rails haml:erb2haml")
+    end
+  end
+end

data/lib/flame/generators/testing_generator.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Flame
+  class TestingGenerator < Generators::Base
+    def install_rspec
+      generate("rspec:install")
+    end
+
+    def install_gems
+    end
+  end
+end

data/lib/flame/generators/vite_generator.rb

@@ -0,0 +1,76 @@
+require_relative "base"
+
+module Flame
+  class ViteGenerator < Generators::Base
+    source_root File.expand_path("../../../templates", __dir__)
+
+    def install
+      run("rm -rf ./package.lock")
+      run("yarn init -y")
+
+      run("bundle exec vite install")
+
+      run("rm -rf ./package-lock.json")
+      run("rm -rf ./yarn.lock")
+      run("rm -rf ./node_modules")
+    end
+
+    def install_packages
+      packages = %w[
+        react
+        react-dom
+        formik
+        yup
+        axios
+        @reduxjs/toolkit
+        react-redux
+        react-router-dom
+        @mui/material
+        @mui/icons-material
+        @emotion/react
+        @emotion/styled
+        react-toastify
+        styled-components
+        sass
+      ]
+      yarn_install(packages)
+    end
+
+    def install_dev_packages
+      packages = %w[
+        standard
+        @vitejs/plugin-react-swc
+        eslint-plugin-react
+      ]
+
+      yarn_install_dev(packages)
+    end
+
+    def copy_templates
+      remove_file "vite.config.js"
+      remove_file "vite.config.ts"
+      template("vite.config.js", "vite.config.js")
+      template("jsconfig.json", "jsconfig.json")
+      run("rm -rf app/frontend")
+      run("rm -rf db/seeds.rb")
+      run("rm app/views/layouts/application.html.haml")
+      directory("frontend", "app/frontend")
+      template("app/views/layouts/application.html.haml", "app/views/layouts/application.html.haml")
+      template("db/seeds.rb", "db/seeds.rb")
+    end
+
+    def install_standardjs
+      template("eslintrc.js", ".eslintrc.js")
+    end
+
+    def generate_home
+      generate("controller", "pages", "index", "--skip-routes", "--no-test-framework")
+      run("echo '' > app/views/pages/index.html.haml")
+      append_to_file("app/views/pages/index.html.haml", "#root\n")
+    end
+
+    def generate_root_route
+      route("root to: 'pages#index'")
+    end
+  end
+end

data/lib/flame/version.rb

@@ -0,0 +1,5 @@
+module Flame
+  VERSION = "0.1.1"
+  RUBY_VERSION = "3.2.2"
+  RAILS_VERSION = "6.1.7"
+end

data/lib/flame.rb

@@ -0,0 +1,8 @@
+require "flame/version"
+require "flame/generators/cors_generator"
+require "flame/generators/testing_generator"
+require "flame/generators/devise_generator"
+require "flame/generators/vite_generator"
+require "flame/generators/haml_generator"
+require "flame/generators/app"
+require "flame/app_builder"

data/templates/Gemfile.erb

@@ -0,0 +1,39 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "<%= Flame::RUBY_VERSION %>"
+
+gem "active_model_serializers", "~> 0.9.9"
+gem "bootsnap", require: false
+gem "devise"
+gem "haml-rails"
+gem "pager_api"
+gem "pagy"
+gem "pg"
+gem "puma"
+gem "rails", "<%= Flame::RAILS_VERSION %>"
+gem "rack-cors"
+gem "vite_rails"
+
+gem "tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby]
+
+group :development do
+  gem "annotate"
+  gem "listen"
+  gem "spring"
+  gem "standard"
+  gem "html2haml" # Remove this gem!
+  gem "haml_lint", require: false
+end
+
+group :development, :test do
+  gem "byebug", platforms: %i[mri mingw x64_mingw]
+  gem "factory_bot_rails", "~> 6.2"
+  gem "ffaker", "~> 2.21"
+  gem "rspec-rails", "~> 6.0.0"
+  gem "shoulda-matchers", "~> 5.0"
+end
+
+group :test do
+  gem "database_cleaner-active_record", "2.1"
+end

data/templates/app/views/layouts/application.html.haml

@@ -0,0 +1,14 @@
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %title TestLast
+    %meta{:content => "width=device-width,initial-scale=1", :name => "viewport"}/
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag 'application', media: 'all'
+    = vite_client_tag
+    = vite_react_refresh_tag
+    = vite_javascript_tag 'application.jsx'
+%body
+  = yield

data/templates/db/seeds.rb

@@ -0,0 +1,5 @@
+User.create(
+  email: "admin@example.com",
+  password: "admin123",
+  password_confirmation: "admin123"
+)

data/templates/eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['./node_modules/standard/eslintrc.json']
+}

data/templates/frontend/assets/react.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

data/templates/frontend/assets/stylesheets/application.sass

@@ -0,0 +1,8 @@
+
+html, body, #root
+  height: 100%
+  width: 100%
+  margin: 0
+  padding: 0
+  background-color: #F7F8FA
+

data/templates/frontend/common/components/sidebar/index.jsx

@@ -0,0 +1,43 @@
+import { List, ListSubheader } from '@mui/material/'
+
+import { Home as HomeIcon } from '@mui/icons-material/'
+import { styled } from '@mui/system'
+import { SidebarLink } from './sidebar-link'
+
+const Sidebar = () => {
+  const SidebarContainer = styled('nav')({
+    display: 'flex',
+    padding: 10,
+    pr: 0,
+    flex: 1
+  })
+
+  const SidebarSubHeader = styled(ListSubheader)(({ theme }) => ({
+    fontSize: 18,
+    fontWeight: 'bold',
+    pl: 0,
+    backgroundColor: theme.palette.background.default
+  }))
+
+  return (
+    <SidebarContainer>
+      <List
+        sx={{
+          width: '100%',
+          maxWidth: '100%',
+          fontSize: '1.5rem'
+        }}
+        component='nav'
+        subheader={
+          <SidebarSubHeader>
+            General
+          </SidebarSubHeader>
+        }
+      >
+        <SidebarLink to='/' label='Home' icon={<HomeIcon />} />
+
+      </List>
+    </SidebarContainer>
+  )
+}
+export default Sidebar

data/templates/frontend/common/components/sidebar/sidebar-link.jsx

@@ -0,0 +1,32 @@
+import { ListItemText, ListItemButton, ListItemIcon } from '@mui/material'
+import PropTypes from 'prop-types'
+import { Link } from 'react-router-dom'
+
+export const SidebarLink = ({ label, icon, route }) => {
+  return (
+    <ListItemButton
+      component={Link}
+      to={route}
+      sx={{ py: 0, px: 1 }}
+    >
+      <ListItemIcon
+        sx={{
+          minWidth: 30
+        }}
+      >
+        {icon}
+      </ListItemIcon>
+      <ListItemText
+        primaryTypographyProps={{ fontSize: 14, fontWeight: 'medium' }}
+        primary={label}
+      />
+    </ListItemButton>
+
+  )
+}
+
+SidebarLink.propTypes = {
+  label: PropTypes.string,
+  icon: PropTypes.node,
+  to: PropTypes.string
+}

data/templates/frontend/entrypoints/application.js

@@ -0,0 +1,28 @@
+// To see this message, add the following to the `<head>` section in your
+// views/layouts/application.html.erb
+//
+//    <%= vite_client_tag %>
+//    <%= vite_javascript_tag 'application' %>
+console.log('Vite ⚡️ Rails')
+
+// If using a TypeScript entrypoint file:
+//     <%= vite_typescript_tag 'application' %>
+//
+// If you want to use .jsx or .tsx, add the extension:
+//     <%= vite_javascript_tag 'application.jsx' %>
+
+console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
+
+// Example: Load Rails libraries in Vite.
+//
+// import * as Turbo from '@hotwired/turbo'
+// Turbo.start()
+//
+// import ActiveStorage from '@rails/activestorage'
+// ActiveStorage.start()
+//
+// // Import all channels.
+// const channels = import.meta.globEager('./**/*_channel.js')
+
+// Example: Import a stylesheet in app/frontend/index.css
+// import '~/index.css'

data/templates/frontend/entrypoints/application.jsx

@@ -0,0 +1,27 @@
+import '@/assets/stylesheets/application.sass'
+import 'react-toastify/dist/ReactToastify.css'
+
+import React from 'react'
+import { ToastContainer } from 'react-toastify'
+import { CssBaseline, ThemeProvider } from '@mui/material'
+import { createRoot } from 'react-dom/client'
+import { RouterProvider } from 'react-router-dom'
+import router from '@/router'
+import { Provider } from 'react-redux'
+import { store } from '@/store'
+import { theme } from '@/theme'
+
+const container = document.getElementById('root')
+const root = createRoot(container)
+
+root.render(
+  <React.StrictMode>
+    <CssBaseline />
+    <ToastContainer />
+    <Provider store={store}>
+      <ThemeProvider theme={theme}>
+        <RouterProvider router={router} />
+      </ThemeProvider>
+    </Provider>
+  </React.StrictMode>
+)

data/templates/frontend/layouts/content.jsx

@@ -0,0 +1,11 @@
+import { Box, Card } from '@mui/material'
+
+const Content = ({ children }) => {
+  return (
+    <Box sx={{ m: 1, boxShadow: 3 }} component={Card} flex={7} px={3} py={2}>
+      {children}
+    </Box>
+  )
+}
+
+export default Content

data/templates/frontend/layouts/main-layout.jsx

@@ -0,0 +1,16 @@
+import { Stack } from '@mui/material'
+import Content from './content'
+import Sidebar from '@/common/components/sidebar'
+
+const MainLayout = ({ children }) => {
+  return (
+    <Stack sx={{ width: '100%', height: '100%' }} direction='row' justifyContent='flex-start' gap={1}>
+      <Sidebar />
+      <Content>
+        {children}
+      </Content>
+    </Stack>
+  )
+}
+
+export default MainLayout

data/templates/frontend/layouts/page-layout.jsx

@@ -0,0 +1,28 @@
+import { Box, Divider, Stack, Typography } from '@mui/material'
+import PropTypes from 'prop-types'
+
+const PageLayout = ({ title, children }) => {
+  return (
+    <Stack>
+      <Box sx={{mb:2}}>
+        <Typography gutterBottom variant='h5' sx={{ fontWeight: 'bold' }}>{title}</Typography>
+        <Divider />
+      </Box>
+
+      <div>
+        {children}
+      </div>
+    </Stack>
+  )
+}
+
+PageLayout.propTypes = {
+  title: PropTypes.string,
+  children: PropTypes.node
+}
+
+PageLayout.defaultProps = {
+  title: 'Custom'
+}
+
+export default PageLayout

data/templates/frontend/pages/home/index.jsx

@@ -0,0 +1,25 @@
+import { Button, Typography } from '@mui/material'
+import { useNavigate } from 'react-router-dom'
+import { usersService } from '@/services/users-service'
+import PageLayout from '@/layouts/page-layout'
+
+const Home = () => {
+  const navigate = useNavigate()
+  const handleLogout = async () => {
+    try {
+      await usersService.signOut()
+      navigate('/sign_in')
+    } catch (e) {
+      /* handle error */
+    }
+  }
+
+  return (
+    <PageLayout>
+      <Typography variant='h4'>Home</Typography>
+      <Button variant='contained' onClick={() => handleLogout()}>Log out</Button>
+    </PageLayout>
+  )
+}
+
+export default Home

data/templates/frontend/pages/sign-in/components/login-form/index.jsx

@@ -0,0 +1,66 @@
+import { Button, TextField, Typography } from '@mui/material'
+import { CardLogin, Form } from './login-form.styled'
+import { useFormik } from 'formik'
+import { usersService } from '@/services/users-service'
+import validationSchema from './validation-schema'
+import { toast } from 'react-toastify'
+import { useNavigate } from 'react-router-dom'
+
+const LoginForm = () => {
+  const navigate = useNavigate()
+  const handleLogin = async (values) => {
+    try {
+      await usersService.signIn({ user: values })
+      navigate('/')
+    } catch ({ response }) {
+      toast.error(response.data.error)
+    }
+  }
+
+  const { touched, errors, handleBlur, handleSubmit, handleChange, values } = useFormik({
+    initialValues: { email: 'admin@example.com', password: 'admin123' },
+    validationSchema,
+    onSubmit: handleLogin
+  })
+
+  return (
+    <CardLogin>
+      <Form onSubmit={handleSubmit}>
+        <Typography variant='h5' align='center'>
+          Sign in to your account
+        </Typography>
+        <TextField
+          fullWidth
+          name='email'
+          placeholder='john.doe@example.com'
+          onChange={handleChange}
+          value={values.email}
+          error={touched.email && Boolean(errors.email)}
+          onBlur={handleBlur}
+        />
+
+        <TextField
+          fullWidth
+          name='password'
+          type='password'
+          placeholder='********'
+          onChange={handleChange}
+          value={values.password}
+          error={touched.email && Boolean(errors.email)}
+          onBlur={handleBlur}
+        />
+        <Button
+          type='submit'
+          variant='contained'
+        >
+          Sign in
+        </Button>
+        <Typography variant='subtitle2' align='center'>
+          Forgot your password?
+        </Typography>
+      </Form>
+    </CardLogin>
+  )
+}
+
+export default LoginForm

data/templates/frontend/pages/sign-in/components/login-form/login-form.styled.js

@@ -0,0 +1,14 @@
+import { styled } from '@mui/system'
+import { Card } from '@mui/material'
+
+export const CardLogin = styled(Card)({
+  width: '100%',
+  maxWidth: '31.25rem',
+  padding: '2rem'
+})
+
+export const Form = styled('form')({
+  display: 'flex',
+  flexDirection: 'column',
+  gap: '1rem'
+})

data/templates/frontend/pages/sign-in/components/login-form/utils/index.js

@@ -0,0 +1,11 @@
+import usersService from '@/services/users-service'
+/**
+ * Handle login request for login-form
+ * @param {object} params
+ * @param {string} params.email - user email
+ * @param {string} params.password - user password
+ * @returns {void}
+ */
+export const handleLogin = async (params) => {
+  const response = await usersService.login(params)
+}

data/templates/frontend/pages/sign-in/components/login-form/validation-schema.js

@@ -0,0 +1,6 @@
+import * as yup from 'yup'
+
+export default yup.object({
+  email: yup.string().email().required(),
+  password: yup.string().required()
+})

data/templates/frontend/pages/sign-in/index.jsx

@@ -0,0 +1,22 @@
+import { styled } from '@mui/system'
+import LoginForm from './components/login-form'
+
+const SignIn = () => {
+  const LayoutLogin = styled('div')({
+    width: '100%',
+    height: '100%',
+    maxWidth: '31.25rem',
+    padding: '1rem',
+    margin: '0 auto',
+    display: 'flex',
+    alignItems: 'center'
+  })
+
+  return (
+    <LayoutLogin>
+      <LoginForm />
+    </LayoutLogin>
+  )
+}
+
+export default SignIn

data/templates/frontend/router/index.jsx

@@ -0,0 +1,43 @@
+import Home from '@/pages/home'
+import SignIn from '@/pages/sign-in'
+import { Navigate, Outlet, createBrowserRouter } from 'react-router-dom'
+import { useSelector } from 'react-redux'
+import { validateCurrentUser } from '@/store/slices/userSlice'
+import { store } from '@/store'
+import MainLayout from '@/layouts/main-layout'
+
+const PrivateRoute = () => {
+  const user = useSelector(state => state.user)
+  console.log(user)
+  return (
+    user.isLogged ? <MainLayout><Outlet /></MainLayout> : <Navigate to='/sign_in' />
+  )
+}
+
+const router = createBrowserRouter([
+  {
+    element: <PrivateRoute />,
+    loader: () => {
+      return store.dispatch(validateCurrentUser())
+    },
+    children: [
+      {
+        path: '/',
+        element: <Home />,
+        exact: true
+      },
+      {
+        path: '/home',
+        element: <Home />,
+        exact: true
+      }
+    ]
+  },
+  {
+    path: '/sign_in',
+    element: <SignIn />
+
+  }
+])
+
+export default router

data/templates/frontend/services/base.js

@@ -0,0 +1,6 @@
+import axios from 'axios'
+
+export default axios.create({
+  timeout: 1000,
+  withCredentials: true
+})

data/templates/frontend/services/users-service/index.js

@@ -0,0 +1,21 @@
+import api from '@/services/base'
+
+export const usersService = {
+  /**
+   * Sign in request
+   * @param {object} params
+   * @param {string} params.user.email - user email
+   * @param {string} params.user.password - user password
+   * @returns {Promise<object>} - response
+   * @example
+   * const response = await usersService.signIn({
+   *  user: {
+   *    email: 'admin@example.com',
+   *    password: 'password'
+   *  }
+   * })
+   */
+  signIn: (params) => api.post('/users/sign_in', params),
+  currentUser: () => api.get('/users/current'),
+  signOut: () => api.delete('/users/sign_out')
+}

data/templates/frontend/store/index.js

@@ -0,0 +1,8 @@
+import { configureStore } from '@reduxjs/toolkit'
+import userSlice from '@/store/slices/userSlice'
+
+export const store = configureStore({
+  reducer: {
+    user: userSlice
+  }
+})

data/templates/frontend/store/slices/userSlice.js

@@ -0,0 +1,42 @@
+import { createAsyncThunk, createSlice } from '@reduxjs/toolkit'
+import { usersService } from '@/services/users-service'
+import { toast } from 'react-toastify'
+
+const validateCurrentUser = createAsyncThunk(
+  'user/current-user',
+  async (_, { rejectWithValue }) => {
+    try {
+      const response = await usersService.currentUser()
+      return response
+    } catch ({ response }) {
+      throw rejectWithValue(response.data)
+    }
+  }
+)
+
+const initialState = {
+  isLogged: false
+}
+
+export const userSlice = createSlice({
+  name: 'user',
+  initialState,
+  reducers: {},
+  extraReducers: (builder) => {
+    builder.addCase(validateCurrentUser.fulfilled, (state, action) => {
+      state.isLogged = true
+    })
+
+    builder.addCase(validateCurrentUser.rejected, (state, action) => {
+      state.isLogged = false
+      toast.error(action.payload.error)
+    })
+  }
+})
+
+// export const { increment, decrement, incrementByAmount } = userSlice.actions
+
+export {
+  validateCurrentUser
+}
+export default userSlice.reducer

data/templates/frontend/theme/index.js

@@ -0,0 +1,13 @@
+import { createTheme } from '@mui/material'
+
+export const theme = createTheme({
+  palette: {
+    primary: {
+      main: '#09090D'
+    },
+    background: {
+      paper: '#fff',
+      default: '#F7F8FA'
+    }
+  }
+})

data/templates/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "baseUrl": "./app/frontend"
+  },
+  "include": ["app/frontend/**/*"]
+}

data/templates/vite.config.js

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vite'
+import path from 'path'
+import RubyPlugin from 'vite-plugin-ruby'
+import react from '@vitejs/plugin-react-swc'
+
+export default defineConfig({
+  plugins: [
+    RubyPlugin(),
+    react()
+  ],
+  resolve: {
+    alias: [
+      { find: '@', replacement: path.resolve(__dirname, 'app/frontend') }
+    ]
+  }
+})

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: flamerb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- n0tbot
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+description: Flame is a powerful Ruby gem designed to simplify and streamline application
+  development by providing a comprehensive set of tools and functionalities.
+email:
+- wilber.garcia@outlook.es
+executables:
+- flame
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- README.md
+- bin/flame
+- lib/flame.rb
+- lib/flame/app_builder.rb
+- lib/flame/generators/app.rb
+- lib/flame/generators/base.rb
+- lib/flame/generators/cors_generator.rb
+- lib/flame/generators/devise_generator.rb
+- lib/flame/generators/haml_generator.rb
+- lib/flame/generators/testing_generator.rb
+- lib/flame/generators/vite_generator.rb
+- lib/flame/version.rb
+- templates/Gemfile.erb
+- templates/app/views/layouts/application.html.haml
+- templates/db/seeds.rb
+- templates/eslintrc.js
+- templates/frontend/assets/react.svg
+- templates/frontend/assets/stylesheets/application.sass
+- templates/frontend/common/components/sidebar/index.jsx
+- templates/frontend/common/components/sidebar/sidebar-link.jsx
+- templates/frontend/common/components/sidebar/sidebar.styled.jsx
+- templates/frontend/entrypoints/application.js
+- templates/frontend/entrypoints/application.jsx
+- templates/frontend/layouts/content.jsx
+- templates/frontend/layouts/main-layout.jsx
+- templates/frontend/layouts/page-layout.jsx
+- templates/frontend/pages/home/index.jsx
+- templates/frontend/pages/sign-in/components/login-form/index.jsx
+- templates/frontend/pages/sign-in/components/login-form/login-form.styled.js
+- templates/frontend/pages/sign-in/components/login-form/utils/index.js
+- templates/frontend/pages/sign-in/components/login-form/validation-schema.js
+- templates/frontend/pages/sign-in/index.jsx
+- templates/frontend/router/index.jsx
+- templates/frontend/services/base.js
+- templates/frontend/services/users-service/index.js
+- templates/frontend/store/index.js
+- templates/frontend/store/slices/userSlice.js
+- templates/frontend/theme/index.js
+- templates/jsconfig.json
+- templates/vite.config.js
+homepage: https://github.com/notb0t/flame
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Generate a Rails app with best practices
+test_files: []