rider-kick 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2da69cd31f4ccd9814e0e568898021f35bee72c122db6e9979e6cc498fd63cff
-  data.tar.gz: 126375cf6d4edd2c217ecfb9f8c3dd49bfc96fb1c02112768f06456ec75ce620
+  metadata.gz: d52c99f6ea8176455670ca8ea5cc9a9c22f43b593023e2403608f414b3e2c715
+  data.tar.gz: 7b53c42cc3739cba6e29c1fe831454f22bc52feca1942a14212e8d48d3107193
 SHA512:
-  metadata.gz: 61e7cd11f7d73d2a785467eb96259ec89d866e0edacfa48f8ec9c627f52efb2f867aa127ef71a1155fb258023924e0515fba30ff8c9b0d499bdee38577ae119d
-  data.tar.gz: 8791510f1e262cd77ba0bfd38ee7b9e23b45676ca4bf5d15828a6bb424292e5cbd25235c71201f5ca95cf7ecdcb90f621d91b93b459e2cee700d44eaa87d35b4
+  metadata.gz: df231703733194422cee357e0563ab18f48820d7650ef850f5e7f575164622e6e61e8614936f0e02dfa2b49729732a93d2aa0b78987ee1dcde63b89c09750c1e
+  data.tar.gz: da23c273017a080b6b55fd48078e1df07410788f6e90730d02dd9025904823425f95d0067822cd2e90282bab3a10b00112a8ebe88fba63795b36a0ae6271bdfa

data/README.md

@@ -12,9 +12,29 @@ gem 'rider-kick'
 ```
 
 And then execute:
-
+    $ rails new kotaro_minami -d=postgresql -T --skip-javascript --skip-asset-pipeline
     $ bundle install
-    $ bundle binstubs rider-kick
+    $ rails generate rider_kick:init
+    $ rails generate rider_kick:clean_arch --setup
+    $ rails db:drop db:create db:migrate db:seed
+
+## Usage
+```bash
+Description:
+     Clean Architecture 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 scaffold:
+        bin/rails  generate rider_kick:scaffold Models::Contact actor:user
+
+```
 
 ## Philosophy
 
@@ -26,20 +46,25 @@ This structure provides helper interfaces and classes to assist in the construct
 
 ```
 - app
-  - services
-    - api
+  - models
+    - models
       - ...
   - domains 
-    - entities (Contract Response)
-    - builder
-    - repositories (Business logic)
-    - use_cases (Just Usecase)
-    - utils (Class Reusable)
+    - core
+      ...
+        - 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
+  - models
+    - models
+      - ...
   - domains 
     - core
       ...

data/lib/generators/rider_kick/USAGE

@@ -0,0 +1,12 @@
+Description:
+     Clean Architecture generator
+
+Example:
+    To Generate Init:
+        bin/rails  generate rider_kick:init
+
+    To Generate Pattern:
+        bin/rails  generate rider_kick:clean_arch --setup
+
+    To Generate scaffold:
+        bin/rails  generate rider_kick:scaffold Models::Contact actor:user

data/lib/generators/rider_kick/clean_arch_generator.rb

@@ -0,0 +1,160 @@
+module RiderKick
+  class CleanArchGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    class_option :setup, type: :boolean, default: false, desc: 'Setup domain structure'
+
+    def validate_setup_option
+      raise Thor::Error, 'The --setup option must be specified to create the domain structure.' unless options.setup
+      validation!
+    end
+
+    def create_gem_dependencies
+      append_to_file('Gemfile', gem_dependencies)
+      say 'Gems added to Gemfile', :green
+    end
+
+    def setup_configuration
+      setup_domain_structure
+
+      setup_initializers
+      setup_dotenv
+      setup_gitignore
+      setup_rubocop
+      setup_init_migration
+      setup_active_storage
+      setup_rspec
+      setup_readme
+    end
+
+    private
+
+    def setup_active_storage
+      run 'rails active_storage:install'
+      run 'rails db:migrate'
+    end
+
+    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_domain_structure
+      empty_directory File.join("#{path_app}/domains/core/use_cases/contract")
+      empty_directory File.join("#{path_app}/domains/core/repositories")
+      empty_directory File.join("#{path_app}/domains/core/builders")
+      empty_directory File.join("#{path_app}/domains/core/entities")
+      empty_directory File.join("#{path_app}/domains/core/utils")
+
+      # then
+      copy_domain_file
+    end
+
+    def copy_domain_file
+      template 'domains/core/use_cases/contract/pagination.rb.tt', File.join("#{path_app}/domains/core/use_cases/contract", 'pagination.rb')
+      template 'domains/core/use_cases/contract/default.rb.tt', File.join("#{path_app}/domains/core/use_cases/contract", 'default.rb')
+      template 'domains/core/use_cases/get_version.rb.tt', File.join("#{path_app}/domains/core/use_cases", 'get_version.rb')
+
+      template 'domains/core/builders/error.rb.tt', File.join("#{path_app}/domains/core/builders", 'error.rb')
+      template 'domains/core/builders/pagination.rb.tt', File.join("#{path_app}/domains/core/builders", 'pagination.rb')
+
+      template 'domains/core/entities/error.rb.tt', File.join("#{path_app}/domains/core/entities", 'error.rb')
+      template 'domains/core/entities/pagination.rb.tt', File.join("#{path_app}/domains/core/entities", 'pagination.rb')
+
+      template 'domains/core/repositories/abstract_repository.rb.tt', File.join("#{path_app}/domains/core/repositories", 'abstract_repository.rb')
+      template 'domains/core/utils/request_methods.rb.tt', File.join("#{path_app}/domains/core/utils", 'request_methods.rb')
+    end
+
+    def setup_initializers
+      copy_initializer('clean_archithecture')
+      copy_initializer('generators')
+      copy_initializer('hashie')
+      copy_initializer('version')
+      copy_initializer('zeitwerk')
+      copy_initializer('pagy')
+    end
+
+    def setup_dotenv
+      copy_database_config
+      copy_env_development
+    end
+
+    def setup_gitignore
+      template '.gitignore', File.join('.gitignore')
+    end
+
+    def setup_rubocop
+      template '.rubocop.yml', File.join('.rubocop.yml')
+    end
+
+    def setup_readme
+      template 'README.md', File.join('README.md')
+    end
+
+    def setup_init_migration
+      template 'db/migrate/20220613145533_init_database.rb', File.join('db/migrate/20220613145533_init_database.rb')
+    end
+
+    # Helper untuk menyalin initializers
+    def copy_initializer(file_name)
+      template "config/initializers/#{file_name}.rb.tt", File.join("config/initializers/#{file_name}.rb")
+    end
+
+    def copy_database_config
+      template 'config/database.yml', File.join('config/database.yml')
+    end
+
+    def copy_env_development
+      template 'env.production', File.join('.env.production')
+      template 'env.development', File.join('.env.development')
+      template 'env.test', File.join('.env.test')
+      template 'env.test', File.join('env.example')
+    end
+
+    def gem_dependencies
+      inject_into_file 'Gemfile', after: "group :development, :test do\n" do
+        <<-CONFIG
+
+  gem "byebug"
+  gem "rspec-rails"
+  gem "factory_bot_rails"
+  gem "shoulda-matchers"
+        CONFIG
+      end
+
+      <<~RUBY
+
+        # Env Variables
+        gem 'dotenv-rails'
+
+        # Objectable
+        gem 'hashie'
+
+        # uploading
+        gem 'image_processing', '>= 1.2'
+        gem 'ruby-vips'
+
+        # pagination
+        gem 'pagy', '~> 9.2'
+      RUBY
+    end
+
+    def setup_rspec
+      say 'Menjalankan bundle install...'
+      run 'bundle install'
+      say 'Menginisialisasi RSpec...'
+      run 'rails generate rspec:install'
+      template '.rspec', File.join('.rspec')
+      template 'spec/support/repository_stubber.rb', File.join('spec/support/repository_stubber.rb')
+      template 'spec/support/file_stuber.rb', File.join('spec/support/file_stuber.rb')
+      say 'Mengonfigurasi FactoryBot...'
+      template 'spec/rails_helper.rb', File.join('spec/rails_helper.rb')
+    end
+
+    def path_app
+      'app'
+    end
+  end
+end

data/lib/generators/rider_kick/init_generator.rb

@@ -0,0 +1,15 @@
+module RiderKick
+  class InitGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def setup_configuration
+      copy_initializer('rider_kick')
+    end
+
+    private
+
+    def copy_initializer(file_name)
+      template "config/initializers/#{file_name}.rb", File.join("config/initializers/#{file_name}.rb")
+    end
+  end
+end

data/lib/generators/rider_kick/scaffold_generator.rb

@@ -0,0 +1,125 @@
+require 'yaml'
+module RiderKick
+  class ScaffoldGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :arg_structure, type: :string, default: '', banner: ''
+
+    def generate_use_case
+      validation!
+      setup_variables
+
+      generate_files('create')
+      generate_files('update')
+      generate_files('list')
+      generate_files('destroy')
+      generate_files('fetch', '_by_id')
+
+      copy_builder_and_entity_files
+    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 || {}
+      @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 || []
+
+      @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
+      @route_scope_path = @structure.controllers.route_scope.downcase rescue ''
+      @route_scope_class = @route_scope_path.camelize rescue ''
+
+      @type_mapping        = {
+        'uuid'     => ':string',
+        'string'   => ':string',
+        'text'     => ':string',
+        'integer'  => ':integer',
+        'boolean'  => ':bool',
+        'float'    => ':float',
+        'decimal'  => ':float',
+        'date'     => ':date',
+        'upload'   => 'Types::File',
+        'datetime' => ':string'
+      }
+      @entity_type_mapping = {
+        'uuid'     => 'Types::Strict::String',
+        'string'   => 'Types::Strict::String',
+        'text'     => 'Types::Strict::String',
+        'integer'  => 'Types::Strict::Integer',
+        'boolean'  => 'Types::Strict::Bool',
+        'float'    => 'Types::Strict::Float',
+        'decimal'  => 'Types::Strict::Decimal',
+        'date'     => 'Types::Strict::Date',
+        'datetime' => 'Types::Strict::Time'
+      }
+    end
+
+    def generate_files(action, suffix = '')
+      use_case_filename   = build_usecase_filename(action, suffix)
+      repository_filename = build_repository_filename(action, suffix)
+
+      @use_case_class   = use_case_filename.camelize
+      @repository_class = repository_filename.camelize
+
+      template "domains/core/use_cases/#{action + suffix}.rb.tt", File.join("#{root_path_app}/domains/core/use_cases/", @route_scope_path.to_s, @scope_path.to_s, "#{use_case_filename}.rb")
+      template "domains/core/repositories/#{action + suffix}.rb.tt", File.join("#{root_path_app}/domains/core/repositories/#{@scope_path}", "#{repository_filename}.rb")
+    end
+
+    def copy_builder_and_entity_files
+      template 'domains/core/builders/builder.rb.tt', File.join("#{root_path_app}/domains/core/builders", "#{@variable_subject}.rb")
+      template 'domains/core/entities/entity.rb.tt', File.join("#{root_path_app}/domains/core/entities", "#{@variable_subject}.rb")
+    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 get_column_type(field)
+      @uploaders.include?(field) ? 'upload' : @model_class.columns_hash[field.to_s].type
+    end
+
+    def root_path_app
+      'app'
+    end
+
+    def build_usecase_filename(action, suffix = '')
+      "#{@actor}_#{action}_#{@variable_subject}#{suffix}"
+    end
+
+    def build_repository_filename(action, suffix = '')
+      "#{action}_#{@variable_subject}#{suffix}"
+    end
+  end
+end

data/lib/generators/rider_kick/structure_generator.rb

@@ -0,0 +1,77 @@
+module RiderKick
+  class Structure < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :arg_model_name, type: :string, default: '', banner: 'Models::Name'
+    argument :arg_settings, type: :hash, default: '', banner: 'route_scope:dashboard actor:user uploader_filed:assets,images,picture,document'
+
+    def generate_use_case
+      validation!
+      setup_variables
+      generate_files(@scope_path)
+    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
+      @variable_subject  = arg_model_name.split('::').last.underscore.downcase
+      @model_class       = arg_model_name.camelize.constantize
+      @subject_class     = arg_model_name.split('::').last
+      @scope_path        = @subject_class.pluralize.underscore.downcase
+      @scope_class       = @scope_path.camelize
+      @fields            = contract_fields
+      @uploaders         = uploaders
+      @actor             = arg_settings['actor'].downcase
+      @route_scope_path  = arg_settings['route_scope'].downcase
+      @route_scope_class = @route_scope_path.camelize
+
+      @type_mapping        = {
+        'uuid'     => ':string',
+        'string'   => ':string',
+        'text'     => ':string',
+        'integer'  => ':integer',
+        'boolean'  => ':bool',
+        'float'    => ':float',
+        'decimal'  => ':float',
+        'date'     => ':date',
+        'upload'   => 'Types::File',
+        'datetime' => ':string'
+      }
+      @entity_type_mapping = {
+        'uuid'     => 'Types::Strict::String',
+        'string'   => 'Types::Strict::String',
+        'text'     => 'Types::Strict::String',
+        'integer'  => 'Types::Strict::Integer',
+        'boolean'  => 'Types::Strict::Bool',
+        'float'    => 'Types::Strict::Float',
+        'decimal'  => 'Types::Strict::Decimal',
+        'date'     => 'Types::Strict::Date',
+        'datetime' => 'Types::Strict::Time'
+      }
+    end
+
+    def generate_files(action)
+      template 'db/structures/example.yaml.tt', File.join("db/structures/#{action}_structure.yaml")
+    end
+
+    def contract_fields
+      @model_class.columns.reject { |column| (['id', 'created_at', 'updated_at', 'type'] + [RiderKick.scope_owner_column.to_s]).include?(column.name.to_s) }.map(&:name).map(&:to_s)
+    end
+
+    def get_column_type(field)
+      uploaders.include?(field) ? 'upload' : @model_class.columns_hash[field].type
+    end
+
+    def uploaders
+      return [] unless arg_settings['uploader_filed'].present?
+      arg_settings['uploader_filed'].split(',').map(&:strip)
+    end
+  end
+end

data/lib/generators/rider_kick/templates/.gitignore

@@ -0,0 +1,57 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+# editor
+.DS_Store
+.idea
+.env.*
+Procfile
+.ruby-gemset
+.irb-history
+.pry_history
+.byebug_history
+
+/app/assets/builds/*
+!/app/assets/builds/.keep
+
+/node_modules
+
+# Vite Ruby
+/public/vite*
+node_modules
+# Vite uses dotenv and suggests to ignore local-only env files. See
+# https://vitejs.dev/guide/env-and-mode.html#env-files
+*.local
+data
+volumes
+vendor/bundle/ruby/*
+ssl

data/lib/generators/rider_kick/templates/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--require rails_helper
+--color
+--profile
+--format documentation