Project

sun-sword

0.0
The project is in a healthy, maintained state
Sun Sword is a Generator for Clean Architecture.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.5.18
~> 13.2.1
~> 3.13.0
 Project Readme

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.

Installation

Add this line to your application's Gemfile:

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

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
    [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