layered_stack 0.0.5 → 0.0.7

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/lib/layered_stack_rails.rb

@@ -0,0 +1,26 @@
+require 'thor'
+require 'fileutils'
+
+# Require all .rb files in the layered_stack_rails folder recursively
+Dir[File.join(__dir__, 'layered_stack_rails/**/*.rb')].each { |file| require_relative file }
+
+module LayeredStackRails
+  class Cli < Thor
+    desc "product", "Creates an example product.yml resource file in the layered_stack/resources directory"
+    def example
+      LayeredStackRails::Example.execute
+    end
+
+    desc "generate", "Generates resources from ./layered_stack/resources.yml"
+    def generate
+      LayeredStackRails::Generate.execute
+    end
+
+    desc "dev", "Run example and generate with 'product' as the name"
+    def dev
+      example
+      generate
+      system('rails db:migrate')
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/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/templates/root/layered_stack/rails/rails/bin/layered_stack-rails

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

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

@@ -0,0 +1,29 @@
+require_relative 'lib/layered_stack_rails/version'
+
+Gem::Specification.new do |s|
+  # General
+  s.name                        = 'layered_stack-rails'
+  s.version                     = LayeredStackRails::VERSION
+  s.authors                     = ['Layered Stack']
+  s.email                       = ['support@layeredstack.org']
+
+  # About
+  s.summary                     = 'Layered Stack Rails'
+  s.description                 = 'Rails tools 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/rails'
+
+  # Ruby
+  s.required_ruby_version       = '>=3.3.4'
+
+  # Files and executables
+  s.files                       = Dir.glob('lib/**/*.rb') + Dir.glob('assets/**/*')
+  s.executables                 = ['layered_stack-rails']
+
+  # Dependencies
+  s.add_dependency "thor", "~> 1.3.2"
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/generators/layered_stack_rails/scaffold_generator.rb

@@ -0,0 +1,89 @@
+require "rails"
+require "rails/generators"
+require "yaml"
+
+class LayeredStackRails::ScaffoldGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+  argument :model_name, type: :string
+
+  def execute
+    yaml_content = YAML.load_file(File.join("layered_stack", "resources.yml"))
+
+    model_data = yaml_content["resources"][model_name]
+    if model_data
+      puts "Generating model #{model_name} with attributes: #{model_data["attributes"]}"
+      generate_scaffold(model_name, model_data["attributes"], model_data["associations"])
+    else
+      puts "Model #{model_name} not found in resources.yml"
+    end
+  end
+
+  def create_model_file
+    template "active_record/model/model.erb", File.join("app/models", "#{model_name}.rb")
+  end
+
+  private
+
+  def generate_scaffold(model_name, attributes, associations)
+    @attributes = attributes.map do |name, details|
+      if details['password_digest']
+        "#{name}:digest"
+      elsif details['token']
+        "#{name}:token"
+      else
+        attribute_string = if details['type'] == 'decimal'
+                             precision = details['precision']
+                             scale = details['scale']
+                             "#{name}:decimal{#{precision}.#{scale}}"
+                           else
+                             type = details['type']
+                             limit = details['limit']
+                             limit_string = limit ? "{#{limit}}" : ""
+                             "#{name}:#{type}#{limit_string}"
+                           end
+
+        attribute_string += ":index" if details['index'] == true
+        attribute_string += ":uniq" if details['index'] == 'uniq'
+
+        attribute_string
+      end
+    end.join(" ")
+
+    @class_name = model_name.classify
+
+    @validations = []
+    attributes.each do |name, details|
+      if details['required']
+        @validations << "validates :#{name}, presence: true"
+      end
+      if details['type'] == 'integer'
+        @validations << "validates :#{name}, numericality: { only_integer: true }"
+      end
+      if details['precision'] && details['scale']
+        @validations << "validates :#{name}, numericality: true"
+      end
+    end
+
+    @associations = []
+    associations.each do |name, details|
+      case details['type']
+      when 'has_many'
+        if details['through']
+          @associations << "has_many :#{name}, through: :#{details['through']}"
+        else
+          @associations << "has_many :#{name}"
+        end
+      when 'belongs_to'
+        @associations << "belongs_to :#{name}"
+      end
+    end if associations
+
+    # Generate the scaffold command
+    invoke "rails:scaffold", [model_name.camelize, *@attributes.split(" "), "--api"], force: true
+
+    # ToDo: Write a custom generator that avoids this workaround
+    # Delete the model file after scaffolding to avoid duplicate model files
+    model_file_path = File.join("app/models", "#{model_name}.rb")
+    File.delete(model_file_path) if File.exist?(model_file_path)
+  end
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/generators/layered_stack_rails/templates/active_record/model/model.erb

@@ -0,0 +1,9 @@
+class <%= @class_name %> < ApplicationRecord
+  <%= "# <associations>" %>
+  <%= @associations.map { |association| association }.join("\n  ") %>
+  <%= "# </associations>" %>
+
+  <%= "# <validations>" %>
+  <%= @validations.map { |validation| validation }.join("\n  ") %>
+  <%= "# </validations>" %>
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/layered_stack_rails/example.rb

@@ -0,0 +1,97 @@
+require 'thor'
+require 'logger'
+
+module LayeredStackRails
+  class Example < Thor
+    def self.execute
+      new.execute
+    end
+
+    no_commands do
+      def execute
+        logger.info("> layered_stack-rails/example")
+
+        # Ensure the directory exists
+        directory_path = 'layered_stack'
+        unless File.directory?(directory_path)
+          FileUtils.mkdir_p(directory_path)
+        end
+
+        # Create the example product.yml file
+        example_product = File.join(directory_path, 'resources.yml')
+        unless File.exist?(example_product)
+          File.open(example_product, 'w') do |file|
+            file.write(<<~YAML)
+              resources:
+                product:
+                  attributes:
+                    name:
+                      type: string
+                      required: true
+                      index: uniq
+                    description:
+                      type: text
+                    price:
+                      type: decimal
+                      precision: 10
+                      scale: 2
+                      required: true
+                    stock_quantity:
+                      type: integer
+                      required: true
+                  associations:
+                    order_items:
+                      type: has_many
+                    orders:
+                      type: has_many
+                      through: order_items
+
+                order:
+                  attributes:
+                    order_number:
+                      type: string
+                      required: true
+                      index: uniq
+                    order_date:
+                      type: datetime
+                      required: true
+                    total_amount:
+                      type: decimal
+                      precision: 10
+                      scale: 2
+                      required: true
+                  associations:
+                    order_items:
+                      type: has_many
+                    products:
+                      type: has_many
+                      through: order_items
+
+                order_item:
+                  attributes:
+                    quantity:
+                      type: integer
+                      required: true
+                    price:
+                      type: decimal
+                      precision: 10
+                      scale: 2
+                      required: true
+                  associations:
+                    order:
+                      type: belongs_to
+                    product:
+                      type: belongs_to
+            YAML
+          end
+        end
+      end
+
+      private
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/layered_stack_rails/generate.rb

@@ -0,0 +1,34 @@
+require 'thor'
+require 'logger'
+require 'yaml'
+require 'rails'
+
+module LayeredStackRails
+  class Generate < Thor
+    def self.execute
+      new.execute
+    end
+
+    no_commands do
+      def execute
+        logger.info("> layered_stack-rails/generate_new")
+
+        yaml_content = YAML.load_file(File.join("layered_stack", "resources.yml"))
+        resources = yaml_content["resources"]
+        resources.each do |model_name, model_data|
+          if model_data
+            system("rails generate layered_stack_rails:scaffold #{model_name}")
+          else
+            logger.error("Model #{model_name} not found in resources.yml")
+          end
+        end
+      end
+
+      private
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/layered_stack_rails/generate_new.rb

@@ -0,0 +1,34 @@
+require 'thor'
+require 'logger'
+require 'yaml'
+require 'rails'
+
+module LayeredStackRails
+  class GenerateNew < Thor
+    def self.execute
+      new.execute
+    end
+
+    no_commands do
+      def execute
+        logger.info("> layered_stack-rails/generate_new")
+
+        yaml_content = YAML.load_file(File.join("layered_stack", "resources.yml"))
+        resources = yaml_content["resources"]
+        resources.each do |model_name, model_data|
+          if model_data
+            system("rails generate layered_stack_rails:scaffold #{model_name}")
+          else
+            logger.error("Model #{model_name} not found in resources.yml")
+          end
+        end
+      end
+
+      private
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/layered_stack_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LayeredStackRails
+  VERSION = '0.0.1'
+end

data/templates/root/layered_stack/cli/cli/templates/root/layered_stack/rails/rails/lib/layered_stack_rails.rb

@@ -0,0 +1,26 @@
+require 'thor'
+require 'fileutils'
+
+# Require all .rb files in the layered_stack_rails folder recursively
+Dir[File.join(__dir__, 'layered_stack_rails/**/*.rb')].each { |file| require_relative file }
+
+module LayeredStackRails
+  class Cli < Thor
+    desc "product", "Creates an example product.yml resource file in the layered_stack/resources directory"
+    def example
+      LayeredStackRails::Example.execute
+    end
+
+    desc "generate", "Generates resources from ./layered_stack/resources.yml"
+    def generate
+      LayeredStackRails::Generate.execute
+    end
+
+    desc "dev", "Run example and generate with 'product' as the name"
+    def dev
+      example
+      generate
+      system('rails db:migrate')
+    end
+  end
+end

data/templates/root/layered_stack/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/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/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/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/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