sun-sword 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 kotarominami
+
+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/README.md

@@ -0,0 +1,96 @@
+# SunSword
+This gem provides helper interfaces and classes to assist in the construction of application with
+Clean Architecture, as described in [Robert Martin's seminal book](https://www.amazon.com/gp/product/0134494164).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rider-kick'
+gem 'sun-sword'
+
+```
+
+And then execute:
+$ rails new kotaro_minami -d=postgresql -T --skip-javascript --skip-asset-pipeline
+$ bundle install
+$ rails generate rider_kick:init
+$ rails generate rider_kick:clean_arch --setup
+$ rails db:drop db:create db:migrate db:seed
+$ rails generate sun_sword:frontend
+
+$ rubocop -a
+
+## Usage
+```bash
+Description:
+     Clean Architecture CRUD generator
+     rails new kotaro_minami -d=postgresql -T --skip-javascript --skip-asset-pipeline
+
+Example:
+    To Generate Init:
+        bin/rails  generate rider_kick:init
+
+    To Generate Pattern:
+        bin/rails  generate rider_kick:clean_arch --setup
+
+    To Generate Frontend:
+        bin/rails  generate sun_sword:frontend --setup
+        
+    To Generate scaffold:
+        bin/rails  generate sun_sword:scaffold Models::Contact actor:user
+```
+
+## Philosophy
+
+The intention of this gem is to help you build applications that are built from the use case down,
+and decisions about I/O can be deferred until the last possible moment.
+
+## Clean Architecture
+This structure provides helper interfaces and classes to assist in the construction of application with Clean Architecture, as described in Robert Martin's seminal book.
+
+```
+- app
+  - controllers
+    - ...
+  - models
+    - models
+      - ...
+  - domains 
+    - entities (Contract Response)
+    - builder
+    - repositories (Business logic)
+    - use_cases (Just Usecase)
+    - utils (Class Reusable)
+```
+## Screaming architecture - use cases as an organisational principle
+Uncle Bob suggests that your source code organisation should allow developers to easily find a listing of all use cases your application provides. Here's an example of how this might look in a this application.
+```
+- app
+  - controllers
+    - ...
+  - models
+    - models
+      - ...
+  - domains 
+    - core
+      ...
+      - usecase
+        - retail_customer_opens_bank_account.rb
+        - retail_customer_makes_deposit.rb
+        - ...
+```
+Note that the use case name contains:
+
+- the user role
+- the action
+- the (sometimes implied) subject
+```ruby
+    [user role][action][subject].rb
+    # retail_customer_opens_bank_account.rb
+    # admin_fetch_info.rb [specific usecase]
+    # fetch_info.rb [generic usecase] every role can access it
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/sun_sword/USAGE

@@ -0,0 +1,9 @@
+Description:
+     Clean Architecture CRUD generator
+     rails new jendral_jack -d=postgresql -T --skip-javascript --skip-asset-pipeline
+
+Example:
+    bin/rails generate sun_sword:frontend --setup
+    bin/rails generate sun_sword:scaffold contacts<check in db/structure>
+
+

data/lib/generators/sun_sword/frontend_generator.rb

@@ -0,0 +1,148 @@
+module SunSword
+  class FrontendGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates_frontend', __dir__)
+
+    class_option :setup, type: :boolean, default: false, desc: 'Setup domain structure'
+
+    def validate_setup_option
+      unless options.setup
+        raise Thor::Error, 'The --setup option must be specified to create the domain structure.'
+      end
+    end
+
+    desc 'This generator installs Vite with Rails 7 configuration'
+
+    def setup
+      remove_assets_folder
+      copy_assets_from_template
+
+      # copy_database_config
+      # copy_env_development
+
+      add_vite_to_gemfile
+      install_vite
+      configure_vite
+
+      modify_application_js
+      generate_default_frontend
+      generate_controllers_site
+      generate_components
+      modify_layout_for_vite
+    end
+
+    private
+
+    def remove_assets_folder
+      assets_path = "#{path_app}/assets"
+      if Dir.exist?(assets_path)
+        remove_dir(assets_path)
+        say "Folder '#{assets_path}' has been removed.", :green
+      else
+        say "Folder '#{assets_path}' does not exist.", :yellow
+      end
+    end
+
+    def copy_assets_from_template
+      template 'assets/config/manifest.js', File.join('assets/config/manifest.js')
+      say "File '#{path_app}/assets' has been copied from template.", :green
+    end
+
+    def copy_database_config
+      template 'config/database.yml', File.join('config/database.yml')
+    end
+
+    def copy_env_development
+      template 'env.development', File.join('.env.development')
+      template 'env.development', File.join('env.example')
+    end
+
+    def add_vite_to_gemfile
+      gem_dependencies = <<~RUBY
+
+        # --- SunSword Package frontend
+        gem "turbo-rails"
+        gem "stimulus-rails"
+        gem "vite_rails"
+      RUBY
+      append_to_file('Gemfile', gem_dependencies)
+      say 'Vite Rails gem added and bundle installed', :green
+    end
+
+    def install_vite
+      template 'package.json', 'package.json'
+      run 'bundle exec vite install'
+      run 'yarn add -D sass vite-plugin-full-reload vite-plugin-ruby vite-plugin-stimulus-hmr'
+      run 'yarn add -D tailwindcss @tailwindcss/forms @tailwindcss/typography @tailwindcss/aspect-ratio @tailwindcss/forms @tailwindcss/line-clamp autoprefixer'
+      run 'yarn add -D eslint prettier eslint-plugin-prettier eslint-config-prettier eslint-plugin-tailwindcss path'
+      run 'yarn add @hotwired/stimulus @hotwired/turbo-rails stimulus-vite-helpers vite animejs stimulus-use'
+      say 'Vite installed successfully', :green
+    end
+
+    def configure_vite
+      say 'Configuring Vite...'
+
+      # Add a basic Vite configuration file to your Rails app
+      template 'tailwind.config.js', 'tailwind.config.js'
+      template 'postcss.config.js', 'postcss.config.js'
+      template 'vite.config.ts.tt', 'vite.config.ts'
+      template 'Procfile.dev', 'Procfile.dev'
+      template 'bin/watch', 'bin/watch'
+      run 'chmod +x bin/watch'
+      template 'config/vite.json', 'config/vite.json'
+
+      say 'Vite configuration completed', :green
+    end
+
+    def modify_application_js
+      if File.exist?('app/javascript/application.js')
+
+        say 'Updated application.js for Vite', :green
+      end
+    end
+
+    def generate_default_frontend
+      directory('frontend', 'app/frontend')
+      say 'Generate default controller', :green
+    end
+
+    def generate_components
+      directory('views/components', 'app/views/components')
+      say 'Generate default controller', :green
+    end
+
+    def generate_controllers_site
+      run 'rails g controller site stimulus'
+      template 'controllers/site_controller.rb', File.join('app/controllers/site_controller.rb')
+      template 'controllers/application_controller.rb.tt', File.join('app/controllers/application_controller.rb')
+      site_route = <<-RUBY
+
+  root "site#stimulus"
+  get "site/jadi_a"
+  get "site/jadi_b"
+
+  namespace :dashboard do
+    get "site" => "site#index", as: :dashboard_site_index
+  end
+
+      RUBY
+      inject_into_file 'config/routes.rb', site_route, after: "Rails.application.routes.draw do\n"
+
+      say 'Generate default controller', :green
+    end
+
+    def path_app
+      'app'
+    end
+
+    def modify_layout_for_vite
+      template 'views/site/stimulus.html.erb.tt', 'app/views/site/stimulus.html.erb'
+      template 'views/site/_comment.html.erb.tt', 'app/views/site/_comment.html.erb'
+      template 'views/layouts/application.html.erb.tt', 'app/views/layouts/application.html.erb'
+
+      directory('views/layouts/dashboard', 'app/views/layouts/dashboard')
+      directory('helpers', 'app/helpers')
+      template('controllers/dashboard/site_controller.rb', 'app/controllers/dashboard/site_controller.rb')
+      say 'Updated application layout for Vite integration', :green
+    end
+  end
+end

data/lib/generators/sun_sword/scaffold_generator.rb

@@ -0,0 +1,97 @@
+module SunSword
+  class ScaffoldGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates_scaffold', __dir__)
+
+    argument :arg_structure, type: :string, default: '', banner: ''
+
+    def running
+      validation!
+      setup_variables
+      create_root_folder
+      create_controller_file
+      create_view_file
+      create_link_file
+    end
+
+    private
+
+    def validation!
+      unless File.exist?('config/initializers/rider_kick.rb')
+        say 'Error must create init configuration for rider_kick!'
+        raise Thor::Error, 'run: bin/rails generate rider_kick:init'
+      end
+    end
+
+    def setup_variables
+      config     = YAML.load_file("db/structures/#{arg_structure}_structure.yaml")
+      @structure = Hashie::Mash.new(config)
+
+      # Mengambil detail konfigurasi
+      model_name    = @structure.model
+      resource_name = @structure.resource_name.singularize.underscore.downcase
+      entity        = @structure.entity || {}
+
+      @actor                = @structure.actor
+      @uploaders            = @structure.uploaders || []
+      @search_able          = @structure.search_able || []
+      @services             = @structure.domains || {}
+      @controllers          = @structure.controllers || {}
+      @contract_list        = @services.action_list.use_case.contract || []
+      @contract_fetch_by_id = @services.action_fetch_by_id.use_case.contract || []
+      @contract_create      = @services.action_create.use_case.contract || []
+      @contract_update      = @services.action_update.use_case.contract || []
+      @contract_destroy     = @services.action_destroy.use_case.contract || []
+      @skipped_fields       = entity.skipped_fields || []
+      @custom_fields        = entity.custom_fields || []
+      @route_scope_path = @structure.controllers.route_scope.downcase rescue ''
+      @route_scope_class = @route_scope_path.camelize rescue ''
+
+      @variable_subject = model_name.split('::').last.underscore.downcase
+      @scope_path       = resource_name.pluralize.underscore.downcase
+      @scope_class      = @scope_path.camelize
+      @model_class      = model_name.camelize.constantize
+      @subject_class    = resource_name.camelize
+      @fields           = contract_fields
+    end
+
+    def build_usecase_filename(action, suffix = '')
+      "#{@actor}_#{action}_#{@variable_subject}#{suffix}".camelize
+    end
+
+    def create_root_folder
+      empty_directory File.join('app/views', @route_scope_path.to_s, @scope_path.to_s)
+    end
+
+    def create_controller_file
+      template 'controllers/controller.rb.tt', File.join('app/controllers', @route_scope_path.to_s, "#{@scope_path}_controller.rb")
+    end
+
+    def create_view_file
+      template 'views/_form.html.erb.tt', File.join('app/views', @route_scope_path.to_s, @scope_path.to_s, '_form.html.erb')
+      template 'views/edit.html.erb.tt', File.join('app/views', @route_scope_path.to_s, @scope_path.to_s, 'edit.html.erb')
+      template 'views/index.html.erb.tt', File.join('app/views', @route_scope_path.to_s, @scope_path.to_s, 'index.html.erb')
+      template 'views/new.html.erb.tt', File.join('app/views', @route_scope_path.to_s, @scope_path.to_s, 'new.html.erb')
+      template 'views/show.html.erb.tt', File.join('app/views', @route_scope_path.to_s, @scope_path.to_s, 'show.html.erb')
+    end
+
+    def create_link_file
+      template 'views/components/menu/link.html.erb.tt', File.join('app/views/components/menu', "_link_to_#{@scope_path}.html.erb")
+      link_to = "                <li><%= render 'components/menu/#{"link_to_#{@scope_path}"}' %></li>\n"
+      inject_into_file 'app/views/layouts/dashboard/_sidebar.html.erb', link_to, before: "                <%# generate_link %>\n"
+    end
+
+    def contract_fields
+      skip_contract_fields = @skipped_fields.map(&:strip).uniq
+      if RiderKick.scope_owner_column.present?
+        skip_contract_fields << RiderKick.scope_owner_column.to_s
+      end
+      @model_class.columns.reject { |column| skip_contract_fields.include?(column.name.to_s) }.map(&:name).map(&:to_s)
+    end
+
+    def strong_params
+      results = ''
+      @controllers.form_fields.map { |tc| results << ":#{tc}," }
+      results[0..-2]
+    end
+  end
+end

data/lib/generators/sun_sword/templates_frontend/Procfile.dev

@@ -0,0 +1 @@
+vite: bin/vite dev --clobber

data/lib/generators/sun_sword/templates_frontend/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link application.css

data/lib/generators/sun_sword/templates_frontend/bin/watch

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+vite dev --clobber

data/lib/generators/sun_sword/templates_frontend/config/database.yml

@@ -0,0 +1,21 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: <%%= ENV.fetch("DATABASE_POOL") { 50 } %>
+  database: <%%= ENV["DATABASE_NAME"] %>
+  username: <%%= ENV["DATABASE_USERNAME"] %>
+  password: <%%= ENV["DATABASE_PASSWORD"] %>
+  host: <%%= ENV['DATABASE_HOSTNAME'] %>
+  port: <%%= ENV['DATABASE_PORT'].to_i %>
+
+
+production:
+  primary:
+    <<: *default
+
+development:
+  primary:
+    <<: *default
+
+test:
+  <<: *default

data/lib/generators/sun_sword/templates_frontend/config/vite.json

@@ -0,0 +1,17 @@
+{
+  "all": {
+    "sourceCodeDir": "app/frontend",
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "host": "127.0.0.1",
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test",
+    "port": 3037
+  }
+}

data/lib/generators/sun_sword/templates_frontend/controllers/application_controller.rb.tt

@@ -0,0 +1,36 @@
+class ApplicationController < ActionController::Base
+  # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
+  allow_browser versions: :modern
+
+  protected
+
+  def build_contract(params)
+    # { "<%=RiderKick.scope_owner_column.to_s%>": current_auth.account.id SecureRandom.uuid }.merge(params)
+    { <%=RiderKick.scope_owner_column.to_s%>: SecureRandom.uuid }.merge(params)
+  end
+
+  def build_form_errors(params, model, errors)
+    params.keys.each do |key|
+      model[key] = params[key]
+    end
+    if errors.is_a?(Hash)
+      errors.keys.each do |key|
+        model.errors.add(key, :invalid, message: errors[key][0])
+      end
+    elsif errors.is_a?(Array)
+      errors.each do |error|
+        if error.options.present?
+          model.errors.add(error.attribute, error.type, message: error.options['message'])
+        else
+          model.errors.add(error.attribute, error.type)
+        end
+      end
+    end
+    model
+  end
+
+  def set_layouts
+    # "#{current_auth.user.role}/application"
+    'dashboard/application'
+  end
+end

data/lib/generators/sun_sword/templates_frontend/controllers/dashboard/site_controller.rb

@@ -0,0 +1,6 @@
+class Dashboard::SiteController < ApplicationController
+  layout :set_layouts
+  def index
+    render 'site/stimulus'
+  end
+end

data/lib/generators/sun_sword/templates_frontend/controllers/site_controller.rb

@@ -0,0 +1,15 @@
+class SiteController < ApplicationController
+  def stimulus
+    @comment = '- WELCOME -'
+  end
+
+  def jadi_a
+    @comment = 'Kotaro'
+    render partial: 'site/comment'
+  end
+
+  def jadi_b
+    @comment = 'Minami'
+    render partial: 'site/comment'
+  end
+end

data/lib/generators/sun_sword/templates_frontend/env.development

@@ -0,0 +1,14 @@
+BASE_URL="http://localhost:3000"
+
+# database primary
+DATABASE_NAME=<%= Rails.application.class.module_parent_name.underscore %>_development
+DATABASE_USERNAME=postgres
+DATABASE_PASSWORD=bayangan
+DATABASE_HOSTNAME=localhost
+DATABASE_PORT="5433"
+DATABASE_POOL="10"
+
+RAILS_MAX_THREADS="5"
+RAILS_ENV="development"
+WEB_CONCURRENCY="5"
+WORKER_TIMEOUT="3600"

data/lib/generators/sun_sword/templates_frontend/frontend/assets/images/logo.svg

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.4.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 1024 704" style="enable-background:new 0 0 1024 704;" xml:space="preserve">
+<path d="M759.9,602.1c-15.8,11.4-26.8,26.1-35.4,42.9c-5,9.7-5,9.6-15.4,6.4c-69.1-21-138.3-41.9-207.5-62.8
+	c-81.7-24.7-163.4-49.2-245.1-73.9c-75-22.6-150-45.3-225-68c-2.9-0.9-6.2-1.1-8.5-3.6c0.1-2.5,1.9-3.8,3.3-5.3
+	c79.8-89.3,172.4-162.3,278.4-218.3c20-10.5,40.3-20.4,60.9-29.5c5-2.2,6.2-4.5,4.7-10c-16.3-57.2,8-115.9,58.2-141.2
+	c44.8-22.6,104-7.6,129.9,32.8c6.9,10.8,8.8,23.1,10.6,35.4c0.6,4.1,1.2,8.4,2.6,12.3c4.1,11.4,12.4,17.9,24.5,18.9
+	c10.5,0.9,21-0.6,31.6-1.1c18.4-0.8,36.5,2.4,54.5,6.2c27.6,5.8,54,14.7,78.9,28.3c33,18.1,55.2,44.7,66.6,80.8
+	c6.3,20,10.2,40.4,13.4,60.9c3.3,21.6,15.9,35.8,35.2,44.6c21.7,9.9,43.8,18.7,67.8,21.5c10.5,1.2,20.9,2.1,31.4,3.2
+	c18.3,1.9,27.8,12.9,25,30.9c-4.5,29-11.2,57.6-22.1,84.8c-19.4,48.3-55.9,77.1-106.3,88.4c-14.5,3.3-29.4,2.5-44.1,1.1
+	C804,585.5,780.7,586.5,759.9,602.1 M725,357.5c4.3,7.8,9.3,15.1,16.1,21c11.6,10.1,23.4,10.3,35.5,0.7
+	c11.2-8.9,17.9-21.1,24.9-33.1c2.7-4.6,2-7.2-2.7-10.1c-23.7-14.2-47.1-28.9-70.6-43.3c-7.1-4.3-13.7-9.4-22.5-13.1
+	C707.4,307.2,712,332.9,725,357.5 M980.8,448.6c1.5,2.1,3,4.3,5.2,7.4c5.8-17.4,9.6-33.7,7.4-50.8c-0.8-6.1-4.2-10.8-9.8-13.9
+	c-5.7-3.1-11.9-4.1-18.1-4.9c-8.8-1.1-17.7-2.1-28.1-3.2C952.2,405.7,966.2,426.8,980.8,448.6z"/>
+</svg>

data/lib/generators/sun_sword/templates_frontend/frontend/entrypoints/application.js

@@ -0,0 +1,17 @@
+// LOAD everything
+import "@hotwired/turbo-rails"
+import {stimulus} from "./stimulus"
+
+import WebController from "../pages/web"
+import SiteStimulusController from "../pages/stimulus.js"
+
+import "../stylesheets/application.scss"
+console.log("Kotaro is here")
+console.log(window.location.hash.slice(1))
+
+const textElement = document.getElementById(window.location.hash.slice(1))
+if(textElement !== null){
+    textElement.scrollIntoView({behavior: "smooth"})
+}
+stimulus.register("web", WebController)
+stimulus.register("site-stimulus", SiteStimulusController)

data/lib/generators/sun_sword/templates_frontend/frontend/entrypoints/stimulus.js

@@ -0,0 +1,9 @@
+import {Application} from "@hotwired/stimulus"
+
+const stimulus = Application.start()
+
+// Configure Stimulus development experience
+stimulus.debug = false
+window.Stimulus = stimulus
+
+export {stimulus}

data/lib/generators/sun_sword/templates_frontend/frontend/pages/stimulus.js

@@ -0,0 +1,10 @@
+import {Controller} from "@hotwired/stimulus"
+
+export default class extends Controller {
+    static targets = ["name", "output"]
+
+    greet() {
+        this.outputTarget.textContent =
+            `Hello, ${this.nameTarget.value}!`
+    }
+}