rider-kick 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2202ce45cec1f54ec7ad7d7e7cea9f9cbca29644d5ea99500d5b5168198b1f55
-  data.tar.gz: 0b79036ead139ee15e1d3f7180be8c3c98b16453cbe9166d9185fa9eb5397d8f
+  metadata.gz: d52c99f6ea8176455670ca8ea5cc9a9c22f43b593023e2403608f414b3e2c715
+  data.tar.gz: 7b53c42cc3739cba6e29c1fe831454f22bc52feca1942a14212e8d48d3107193
 SHA512:
-  metadata.gz: 45a3430a608c8ed6509f56127082c9f54545f6af7fd19105d500d1ecf9f5ff32f48f988208c1b877b52720b712b15568c85d107f5f056eee29e782b1b214d0b7
-  data.tar.gz: d7296b1a448f475f8c6b0a980530e2b535a7ac54e364d4ca72719012f59f6f2a6a906ef30b0c0704f1fd402c15f558fcd2fa4059ce372eeb7a7c4d6bb24b7d51
+  metadata.gz: df231703733194422cee357e0563ab18f48820d7650ef850f5e7f575164622e6e61e8614936f0e02dfa2b49729732a93d2aa0b78987ee1dcde63b89c09750c1e
+  data.tar.gz: da23c273017a080b6b55fd48078e1df07410788f6e90730d02dd9025904823425f95d0067822cd2e90282bab3a10b00112a8ebe88fba63795b36a0ae6271bdfa

data/README.md

@@ -12,37 +12,28 @@ 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
-    $ rubocop -a
 
 ## Usage
 ```bash
 Description:
-Clean Architecture generator
-
+     Clean Architecture generator
+     rails new kotaro_minami -d=postgresql -T --skip-javascript --skip-asset-pipeline
+     
 Example:
-    To Generate Structure:
-        bin/rails  generate rider_kick:clean_arch --setup
+    To Generate Init:
+        bin/rails  generate rider_kick:init
 
-        To undo:
-           bin/rails destroy rider_kick:clean_arch --setup
+    To Generate Pattern:
+        bin/rails  generate rider_kick:clean_arch --setup
 
     To Generate scaffold:
         bin/rails  generate rider_kick:scaffold Models::Contact actor:user
 
-        To undo:
-           bin/rails destroy rider_kick:scaffold Models::Contact actor:user
-
-    To Generate Domain:
-        bin/rails  generate rider_kick:blank actor:user action:create scope:Contact --use_case --repository --builder --entity
-
-        To undo:
-           bin/rails destroy rider_kick:blank actor:user action:create scope:Contact --use_case --repository --builder --entity
-
 ```
 
 ## Philosophy
@@ -55,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/scaffold_generator.rb

@@ -39,22 +39,25 @@ module RiderKick
       @actor                = @structure.actor
       @uploaders            = @structure.uploaders || []
       @search_able          = @structure.search_able || []
-      @services             = @structure.services || {}
-      @contract_list        = @services.action_list.contract || []
-      @contract_fetch_by_id = @services.action_fetch_by_id.contract || []
-      @contract_create      = @services.action_create.contract || []
-      @contract_update      = @services.action_update.contract || []
-      @contract_destroy     = @services.action_destroy.contract || []
+      @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 = {
+      @type_mapping        = {
         'uuid'     => ':string',
         'string'   => ':string',
         'text'     => ':string',
@@ -83,11 +86,10 @@ module RiderKick
       use_case_filename   = build_usecase_filename(action, suffix)
       repository_filename = build_repository_filename(action, suffix)
 
-      @scope_class      = @scope_path.camelize
       @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/#{@scope_path}", "#{use_case_filename}.rb")
+      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
 

data/lib/generators/rider_kick/structure_generator.rb

@@ -3,7 +3,7 @@ module RiderKick
     source_root File.expand_path('templates', __dir__)
 
     argument :arg_model_name, type: :string, default: '', banner: 'Models::Name'
-    argument :arg_settings, type: :hash, default: '', banner: 'actor:user uploader_filed:assets,images,picture,document'
+    argument :arg_settings, type: :hash, default: '', banner: 'route_scope:dashboard actor:user uploader_filed:assets,images,picture,document'
 
     def generate_use_case
       validation!
@@ -21,16 +21,18 @@ module RiderKick
     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
+      @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 = {
+      @type_mapping        = {
         'uuid'     => ':string',
         'string'   => ':string',
         'text'     => ':string',

data/lib/generators/rider_kick/templates/db/structures/example.yaml.tt

@@ -15,44 +15,82 @@ search_able:
   - <%= field %>
 <% end -%>
 <% end -%>
-services:
+controllers:
+  route_scope: <%= @route_scope_path %>
+  list_fields:
+<% @fields.each do |field| -%>
+    - <%= field %>
+<% end -%>
+  show_fields:
+<% @model_class.columns.each do |field| -%>
+    - <%= field.name.to_s %>
+<% end -%>
+  form_fields:
+<% (@fields + @uploaders).each do |field| -%>
+    - <%= field %>
+<% end -%>
+domains:
   action_list:
-    contract:
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
   action_fetch_by_id:
-    is_auth: true
-    is_skip_endpoint: false
-    use_case_class: <%= "#{@actor}_fetch_#{@variable_subject}_by_id".camelize %>
-    contract:
-      - required(:id).filled(:string)
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
+        - required(:id).filled(:string)
   action_create:
-    contract:
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
 <% (@fields + @uploaders).each do |field| -%>
   <% column_type = get_column_type(field) -%>
   <% dry_type = @type_mapping[column_type.to_s] || ':string' -%>
 <% if @uploaders.include?(field) -%>
-  - optional(:<%= field %>).maybe(<%= dry_type %>)
+    - optional(:<%= field %>).maybe(<%= dry_type %>)
 <% else -%>
-  - required(:<%= field %>).filled(<%= dry_type %>)
+    - required(:<%= field %>).filled(<%= dry_type %>)
 <% end -%>
 <% end -%>
   action_update:
-    contract:
-      - required(:id).filled(:string)
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
+        - required(:id).filled(:string)
 <% (@fields + @uploaders).each do |field| -%>
 <% column_type = get_column_type(field) -%>
 <% dry_type = @type_mapping[column_type.to_s] || ':string' -%>
 <% if @uploaders.include?(field) -%>
-      - optional(:<%= field %>).maybe(<%= dry_type %>)
+        - optional(:<%= field %>).maybe(<%= dry_type %>)
 <% else -%>
-      - optional(:<%= field %>).maybe(<%= dry_type %>)
+        - optional(:<%= field %>).maybe(<%= dry_type %>)
 <% end -%>
 <% end -%>
   action_destroy:
-    contract:
-      - required(:id).filled(:string)
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
+        - required(:id).filled(:string)
 entity:
   skipped_fields:
     - id
     - created_at
     - updated_at
-    - type
+<% if @model_class.columns.map(&:name).include?(:type) -%>
+    - type
+<% end -%>

data/lib/generators/rider_kick/templates/domains/core/use_cases/create.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Core::UseCases::<%= @scope_class %>::<%= @use_case_class %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call) do
 <% @contract_create.each do |field| -%>

data/lib/generators/rider_kick/templates/domains/core/use_cases/destroy.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Core::UseCases::<%= @scope_class %>::<%= @use_case_class %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call) do
 <% @contract_destroy.each do |field| -%>

data/lib/generators/rider_kick/templates/domains/core/use_cases/fetch_by_id.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Core::UseCases::<%= @scope_class %>::<%= @use_case_class %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call) do
 <% @contract_fetch_by_id.each do |field| -%>

data/lib/generators/rider_kick/templates/domains/core/use_cases/list.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Core::UseCases::<%= @scope_class %>::<%= @use_case_class %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call, Core::UseCases::Contract::Pagination.new.call) do
 <% @contract_list.each do |field| -%>

data/lib/generators/rider_kick/templates/domains/core/use_cases/update.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Core::UseCases::<%= @scope_class %>::<%= @use_case_class %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call) do
 <% @contract_update.each do |field| -%>

data/lib/rider_kick/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module RiderKick
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rider-kick
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kotaro Minami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher