layered_stack 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f427f78d61429bd0cdf47d1573e5945efa2c00229d3b90268087d90c2a256b
-  data.tar.gz: 7a2d65ac4c1df34dcfeeed1bc5298d772260398203cdb1a06bc395c7ff5a77fd
+  metadata.gz: d066b3227b320111bc62272b17721d5e9dcc9d01efe1e62291849f4692b8498e
+  data.tar.gz: 4fba310d0d52deff404f2e89410085f1fec9ecdffb0880520470c503dcadf23e
 SHA512:
-  metadata.gz: e4523c1c8a0f52d4ab5308b55552a507e3b5e90eab7581f6cfeb18976161a0feb036517a55cf0df8566fe848a4e27e5a290ce14b53e501ba2a10c465926723aa
-  data.tar.gz: 92be417e561bc0c8794e195ecbcf502cae7a8a718a2d0cadf77090b169203d9092b153c3cf04c515ec0c863dc18f3a4a571f3364e0f4c3e6d2c48ed0c844e548
+  metadata.gz: b2b46898d4bd4cee84c3ee778db80d2216e262fa56b82a25bce8cd94c52409ed6c2cd4b003db536ece8aac23009146b85c9a17acf98fcf298d9044e6c1fcc2f6
+  data.tar.gz: c96fa4af60b3e3e49418d3c6333f54151a9bdc76ddf2b8aac1ebdcd98d3438ed60374ba20d4629bca2dbb855cd92e3c6f798966e1c987ec322ba061c6be34718

data/lib/layered_stack/backend/create.rb

@@ -33,8 +33,8 @@ module LayeredStack
         end
 
         def create_new_backend
-          template_path = File.expand_path('../../../assets/backend/template.rb', __dir__)
-          run_command("rails new backend --minimal --devcontainer --template=#{template_path}", 'Creating new Rails application named backend')
+          template_path = File.expand_path('../../../templates/backend/rails_template.rb', __dir__)
+          run_command("rails new backend --minimal --no-devcontainer --template=#{template_path}", 'Creating new Rails application named backend')
         end
       end
     end

data/lib/layered_stack/frontend/create.rb

@@ -12,7 +12,7 @@ module LayeredStack
       FRONTEND_DIR = "frontend"
 
       def self.asset_path(relative_path)
-        File.expand_path("../../../../assets/#{relative_path}", __FILE__)
+        File.expand_path("../../../../templates/frontend/#{relative_path}", __FILE__)
       end
 
       ASSET_FILES = {
@@ -24,8 +24,8 @@ module LayeredStack
       }
 
       LOGO_FILES = {
-        "assets/images/logo_dark.svg" => "frontend/src/app/logo_dark.svg",
-        "assets/images/logo_light.svg" => "frontend/src/app/logo_light.svg",
+        "images/logo_dark.svg" => "frontend/src/app/logo_dark.svg",
+        "images/logo_light.svg" => "frontend/src/app/logo_light.svg",
       }
 
       def self.execute
@@ -52,6 +52,11 @@ module LayeredStack
           @logger ||= Logger.new(STDOUT)
         end
 
+        def run_command(command, message)
+          logger.info(message)
+          system(command)
+        end
+
         def remove_existing_frontend
           if Dir.exist?(FRONTEND_DIR)
             logger.info("\n# Removing existing /#{FRONTEND_DIR} directory")
@@ -116,11 +121,6 @@ module LayeredStack
           end
         end
 
-        def run_command(command, message)
-          logger.info(message)
-          system(command)
-        end
-
         def update_file(file, old_content, new_content)
           content = File.read(file)
           new_content = content.gsub(old_content, new_content)

data/lib/layered_stack/root/create.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'thor'
+require 'logger'
+
+module LayeredStack
+  module Root
+    class Create < Thor
+      def self.execute(arg)
+        new.execute(arg)
+      end
+
+      no_commands do
+        def execute(arg)
+          logger.info("> layered_stack/create")
+
+          # Check if the folder exists
+          return if check_folder_exists?(arg)
+
+          # Create the folder
+          logger.info("Creating directory: #{arg}")
+          FileUtils.mkdir_p(arg)
+          logger.info("Directory created: #{arg}")
+
+          # Copy the templates
+          copy_template(arg)
+
+          # Rename the devcontainer directory to .devcontainer
+          rename_devcontainer(arg)
+
+          # Open the folder in VS Code
+          run_command("code #{arg}", "Opening #{arg} in VS Code")
+        end
+
+        private
+
+        def logger
+          @logger ||= Logger.new(STDOUT)
+        end
+
+        def run_command(command, message)
+          logger.info(message)
+          system(command)
+        end
+
+        def check_folder_exists?(folder)
+          if File.directory?(folder)
+            logger.info("Directory exists: #{folder}")
+            true
+          else
+            logger.info("Directory does not exist: #{folder}")
+            false
+          end
+        end
+
+        def copy_template(destination)
+          source = File.expand_path('../../../../templates/root', __FILE__)
+          logger.info("Copying templates from #{source} to #{destination}")
+          FileUtils.cp_r("#{source}/.", destination)
+          logger.info("Templates copied to #{destination}")
+        end
+
+
+        def rename_devcontainer(folder)
+          devcontainer_path = File.join(folder, 'devcontainer')
+          new_devcontainer_path = File.join(folder, '.devcontainer')
+
+          if File.directory?(devcontainer_path)
+            logger.info("Renaming #{devcontainer_path} to #{new_devcontainer_path}")
+            FileUtils.mv(devcontainer_path, new_devcontainer_path)
+            logger.info("Renamed to #{new_devcontainer_path}")
+          else
+            logger.info("No devcontainer directory to rename")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/layered_stack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LayeredStack
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/layered_stack.rb

@@ -5,12 +5,18 @@ Dir[File.join(__dir__, 'layered_stack/**/*.rb')].each { |file| require_relative
 
 module LayeredStack
   class Cli < Thor
-    desc "start", "Start"
-    def start
-      Frontend.new.start
-      Backend.new.start
+    # This is a Thor configuration that will exit the program if a command fails
+    def self.exit_on_failure?
+      true
     end
 
+    # Create a new layered stack
+    desc "create", "Create a new layered stack"
+    def create(arg)
+      LayeredStack::Root::Create.execute(arg)
+    end
+
+    # Frontend commands
     class Frontend < Thor
       namespace :frontend
 
@@ -32,6 +38,7 @@ module LayeredStack
     end
     register(Frontend, 'frontend', 'frontend [COMMAND]', 'Commands for the frontend')
 
+    # Backend commands
     class Backend < Thor
       namespace :backend
 

data/templates/backend/rails_template.rb

@@ -0,0 +1,51 @@
+gem "jbuilder", "~> 2.12.0"
+gem "rack-cors", "~> 2.0.2"
+
+# Use a local copy of the Layered Stack Rails gem in development
+if ENV['LAYERED_STACK_ENV'] == 'development'
+  gem "layered_stack-rails", path: "../layered_stack/rails", groups: [:development, :test]
+else
+  gem "layered_stack-rails", "~> 0.0.6", groups: [:development, :test]
+end
+
+after_bundle do
+  # rails_command "db:create"
+  # rails_command "db:migrate"
+
+  # Remove the line "allow_browser versions: :modern" in backend/app/controllers/application_controller.rb
+  gsub_file 'app/controllers/application_controller.rb', /^(\s*allow_browser versions: :modern)/, ''
+
+  # Create the cors.rb initializer with the rack-cors configuration
+  create_file 'config/initializers/cors.rb', <<-RUBY
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+  allow do
+    origins '*'
+    resource '*',
+      headers: :any,
+      methods: [:get, :post, :put, :patch, :delete, :options, :head]
+  end
+end
+  RUBY
+
+  # Create the example API controller file
+  create_file "app/controllers/api/v1/examples_controller.rb", <<-TEXT
+module Api
+  module V1
+    class ExamplesController < ApplicationController
+      def index
+        render json: { message: "Hello from Rails #{Rails.version}" }
+      end
+    end
+  end
+end
+  TEXT
+
+  # Create the example API route
+  route <<-TEXT
+namespace :api do
+  namespace :v1 do
+    resources 'examples', only: [:index]
+  end
+end
+  TEXT
+end

data/templates/root/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem "foreman", "0.88.1"
+gem "rails", ">= 7.2.1"
+
+# Use a local copy of the Layered Stack CLI gem in development
+if ENV['LAYERED_STACK_ENV'] == 'development'
+  gem "layered_stack", path: "layered_stack/cli"
+else
+  gem "layered_stack", "~> 0.0.6"
+end

data/templates/root/Procfile

@@ -0,0 +1,2 @@
+backend: cd backend && bin/rails s -p 3000
+frontend: cd frontend && npm run dev

data/templates/root/devcontainer/Dockerfile

@@ -0,0 +1,9 @@
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.3.4
+FROM ghcr.io/rails/devcontainer/images/ruby:$RUBY_VERSION
+
+# Install Node.js
+RUN apt-get update -qq && apt-get install -y nodejs npm
+
+# Copy the Visual Studio Code Extension
+COPY layered-stack-0.0.1.vsix /tmp/

data/templates/root/devcontainer/devcontainer.json

@@ -0,0 +1,19 @@
+{
+  "name": "Layered Stack Devcontainer",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspace",
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/rails/devcontainer/features/sqlite3": {}
+  },
+  "forwardPorts": [3000, 3001],
+  "postCreateCommand": "bundle install",
+  "settings": {
+    "terminal.integrated.shell.linux": "/bin/bash"
+  },
+  "extensions": [
+    "dbaeumer.vscode-eslint",
+    "/tmp/layered-stack-0.0.1.vsix"
+  ]
+}

data/templates/root/devcontainer/docker-compose.yml

@@ -0,0 +1,12 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ..:/workspace:cached
+    command: sleep infinity
+    environment:
+      NODE_ENV: development
+      RAILS_ENV: development
+      # LAYERED_STACK_ENV: development

data/templates/root/layered_stack/cli/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Layered Stack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/templates/root/layered_stack/cli/bin/layered_stack

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby -wU
+require 'layered_stack'
+LayeredStack::Cli.start(ARGV)

data/templates/root/layered_stack/cli/cli/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Layered Stack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/templates/root/layered_stack/cli/cli/bin/layered_stack

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby -wU
+require 'layered_stack'
+LayeredStack::Cli.start(ARGV)

data/templates/root/layered_stack/cli/cli/layered_stack.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/layered_stack/version'
+
+Gem::Specification.new do |s|
+  # General
+  s.name                        = 'layered_stack'
+  s.version                     = LayeredStack::VERSION
+  s.authors                     = ['Layered Stack']
+  s.email                       = ['support@layeredstack.org']
+
+  # About
+  s.summary                     = 'Layered Stack CLI'
+  s.description                 = 'CLI for Layered Stack'
+  s.homepage                    = 'https://www.layeredstack.org/'
+  s.license                     = 'MIT'
+
+  # Metadata
+  s.metadata['homepage_uri']    = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/LayeredStack/cli'
+
+  # Ruby
+  s.required_ruby_version       = '>=3.3.4'
+
+  # Files and executables
+  s.files                       = Dir.glob('lib/**/*.rb') + Dir.glob('templates/**/*')
+  s.executables                 = ['layered_stack']
+
+  # Dependencies
+  s.add_dependency "thor", "~> 1.3.2"
+  s.add_dependency "rails", "~> 7.2.1"
+end

data/templates/root/layered_stack/cli/cli/lib/layered_stack/backend/create.rb

@@ -0,0 +1,42 @@
+require 'fileutils'
+require 'thor'
+require 'logger'
+
+module LayeredStack
+  module Backend
+    class Create < Thor
+      def self.execute
+        new.execute
+      end
+
+      no_commands do
+        def execute
+          check_and_remove_backend
+          create_new_backend
+        end
+
+        private
+
+        def logger
+          @logger ||= Logger.new(STDOUT)
+        end
+
+        def run_command(command, message)
+          logger.info(message)
+          system(command)
+        end
+
+        def check_and_remove_backend
+          if Dir.exist?('backend')
+            run_command('rm -rf backend', 'Removing backend directory')
+          end
+        end
+
+        def create_new_backend
+          template_path = File.expand_path('../../../templates/backend/rails_template.rb', __dir__)
+          run_command("rails new backend --minimal --no-devcontainer --template=#{template_path}", 'Creating new Rails application named backend')
+        end
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/lib/layered_stack/backend/start.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require 'logger'
+
+module LayeredStack
+  module Backend
+    class Start < Thor
+      def self.execute
+        new.execute
+      end
+
+      no_commands do
+        def execute
+          logger.info("> layered_stack/frontend/start")
+          run_command('code backend', 'Starting VS Code in /backend directory')
+        end
+
+        private
+
+        def logger
+          @logger ||= Logger.new(STDOUT)
+        end
+
+        def run_command(command, message)
+          logger.info(message)
+          system(command)
+        end
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/lib/layered_stack/frontend/create.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'thor'
+require 'logger'
+
+module LayeredStack
+  module Frontend
+    class Create < Thor
+      CREATE_NEXT_APP_SWITCHES = "--js --tailwind --eslint --app --src-dir --import-alias @/* --use-npm"
+
+      FRONTEND_DIR = "frontend"
+
+      def self.asset_path(relative_path)
+        File.expand_path("../../../../templates/frontend/#{relative_path}", __FILE__)
+      end
+
+      ASSET_FILES = {
+        asset_path("tailwind.config.js") => "frontend/tailwind.config.js",
+        asset_path("layout.js") => "frontend/src/app/layout.js",
+        asset_path("page.js") => "frontend/src/app/page.js",
+        asset_path("images/logo_dark.svg") => "frontend/src/app/logo_dark.svg",
+        asset_path("images/logo_light.svg") => "frontend/src/app/logo_light.svg",
+      }
+
+      LOGO_FILES = {
+        "images/logo_dark.svg" => "frontend/src/app/logo_dark.svg",
+        "images/logo_light.svg" => "frontend/src/app/logo_light.svg",
+      }
+
+      def self.execute
+        new.execute
+      end
+
+      no_commands do
+        def execute
+          logger.info("> layered_stack/create")
+          remove_existing_frontend
+          run_create_next_app
+          Dir.chdir(FRONTEND_DIR) do
+            install_dependencies
+            update_package_json
+          end
+          copy_asset_files
+          copy_logo_files
+          print_next_step
+        end
+
+        private
+
+        def logger
+          @logger ||= Logger.new(STDOUT)
+        end
+
+        def run_command(command, message)
+          logger.info(message)
+          system(command)
+        end
+
+        def remove_existing_frontend
+          if Dir.exist?(FRONTEND_DIR)
+            logger.info("\n# Removing existing /#{FRONTEND_DIR} directory")
+            FileUtils.rm_rf(FRONTEND_DIR)
+          end
+        end
+
+        def run_create_next_app
+          command = "npx create-next-app@latest #{CREATE_NEXT_APP_SWITCHES} #{FRONTEND_DIR}"
+          run_command(command, "Running create-next-app")
+        end
+
+        def install_dependencies
+          dependencies = [
+            "next-themes",
+            "@heroicons/react@latest",
+            "@layeredstack/ui@latest"
+          ]
+          dependencies.each do |dep|
+            run_command("npm install #{dep}", "Installing #{dep}")
+          end
+        end
+
+        def update_package_json
+          logger.info("# Updating package.json to change the port to 3001")
+          update_file("package.json", '"dev": "next dev"', '"dev": "next dev -p 3001"')
+          update_file("package.json", '"start": "next start"', '"start": "next start -p 3001"')
+        end
+
+        def copy_asset_files
+          logger.info("\n# Copying asset files to the frontend directory")
+          copy_files(ASSET_FILES)
+        end
+
+        def copy_logo_files
+          logger.info("\n# Copying logo files to the frontend directory")
+          copy_files(LOGO_FILES) { |src, dest| copy_logo_file(src, dest) }
+        end
+
+        def copy_files(files)
+          files.each do |src, dest|
+            if block_given?
+              yield(src, dest)
+            else
+              FileUtils.cp(src, dest)
+            end
+          end
+        end
+
+        def copy_logo_file(src, dest)
+          if File.exist?(src)
+            logger.info("User provided logo exists in assets, copying #{src} to #{dest}")
+            FileUtils.cp(src, dest)
+          else
+            template_src = ASSET_FILES.find { |k, _| k.include?(File.basename(src)) }&.first
+            if template_src
+              logger.info("No user provided logo found in 'assets/images/', copying default logo from #{template_src} to #{dest}")
+              FileUtils.cp(template_src, dest)
+            else
+              logger.warn("Default logo file #{src} not found")
+            end
+          end
+        end
+
+        def update_file(file, old_content, new_content)
+          content = File.read(file)
+          new_content = content.gsub(old_content, new_content)
+          File.write(file, new_content)
+        end
+
+        def print_next_step
+          logger.info("\n# Next step:")
+          logger.info("bundle exec layered_stack frontend start")
+        end
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/lib/layered_stack/frontend/start.rb

@@ -0,0 +1,33 @@
+require 'thor'
+require 'logger'
+
+module LayeredStack
+  module Frontend
+    class Start < Thor
+      def self.execute
+        new.execute
+      end
+
+      no_commands do
+        def execute
+          logger.info("> layered_stack/frontend/start")
+          run_command('code frontend', 'Starting VS Code in frontend directory', 'Failed to start VS Code')
+        end
+
+        private
+
+        def logger
+          @logger ||= Logger.new(STDOUT)
+        end
+
+        def run_command(command, success_message, error_message)
+          if system(command)
+            logger.info(success_message)
+          else
+            logger.error(error_message)
+          end
+        end
+      end
+    end
+  end
+end