rider-kick 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52c99f6ea8176455670ca8ea5cc9a9c22f43b593023e2403608f414b3e2c715
-  data.tar.gz: 7b53c42cc3739cba6e29c1fe831454f22bc52feca1942a14212e8d48d3107193
+  metadata.gz: ca2aedb4749c52fc2cf24c4ab16564c3bb334eca159e674b4e0ce2e1b138af7c
+  data.tar.gz: d48958c8210c77dc852a9a9f7ccb51c1a439848e7397581be5e8546929a1153b
 SHA512:
-  metadata.gz: df231703733194422cee357e0563ab18f48820d7650ef850f5e7f575164622e6e61e8614936f0e02dfa2b49729732a93d2aa0b78987ee1dcde63b89c09750c1e
-  data.tar.gz: da23c273017a080b6b55fd48078e1df07410788f6e90730d02dd9025904823425f95d0067822cd2e90282bab3a10b00112a8ebe88fba63795b36a0ae6271bdfa
+  metadata.gz: a3b44f67e107355e1cb5f6c56df0e071393c612d5b5e36d6b8cba84f7cefb36570c9ef4d0b4e38df94ee6ee5eca1a66f2bca03bfaacc812cffb466c490b01b79
+  data.tar.gz: fc8999432b430ddc353aad9d64f459acbb8974ae42ee824928f4821358e1c1ea98a6531322cec9fa10e75f8f98eca4a93f5791edd4ba689d4fe2592298b4ff38

data/README.md

@@ -12,11 +12,16 @@ gem 'rider-kick'
 ```
 
 And then execute:
+```bash
     $ rails new kotaro_minami -d=postgresql -T --skip-javascript --skip-asset-pipeline
     $ bundle install
-    $ rails generate rider_kick:init
+    $ bundle add rider-kick
+    $ bundle add sun-sword
     $ rails generate rider_kick:clean_arch --setup
     $ rails db:drop db:create db:migrate db:seed
+    $ rails generate rider_kick:structure Models::User actor:owner
+    $ rails generate rider_kick:scaffold users scope:dashboard
+```
 
 ## Usage
 ```bash
@@ -25,14 +30,10 @@ Description:
      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
+        bin/rails generate rider_kick:clean_arch --setup
+        bin/rails generate rider_kick:structure Models::User actor:owner
+        bin/rails generate rider_kick:scaffold users scope:dashboard
 
 ```
 

data/lib/generators/rider_kick/USAGE

@@ -1,12 +1,9 @@
 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
+        bin/rails generate rider_kick:clean_arch --setup
+        bin/rails generate rider_kick:structure Models::User actor:owner
+        bin/rails generate rider_kick:scaffold users scope:dashboard

data/lib/generators/rider_kick/clean_arch_generator.rb

@@ -6,7 +6,6 @@ module RiderKick
 
     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
@@ -22,6 +21,7 @@ module RiderKick
       setup_gitignore
       setup_rubocop
       setup_init_migration
+      setup_models
       setup_active_storage
       setup_rspec
       setup_readme
@@ -34,13 +34,6 @@ module RiderKick
       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")
@@ -106,6 +99,11 @@ module RiderKick
       template 'config/database.yml', File.join('config/database.yml')
     end
 
+    def setup_models
+      template 'models/application_record.rb', File.join('app/models/application_record.rb')
+      template 'models/models.rb', File.join('app/models/models.rb')
+    end
+
     def copy_env_development
       template 'env.production', File.join('.env.production')
       template 'env.development', File.join('.env.development')

data/lib/generators/rider_kick/scaffold_generator.rb

@@ -4,6 +4,7 @@ module RiderKick
     source_root File.expand_path('templates', __dir__)
 
     argument :arg_structure, type: :string, default: '', banner: ''
+    argument :arg_scope, type: :hash, default: '', banner: 'scope:dashboard'
 
     def generate_use_case
       validation!
@@ -21,9 +22,9 @@ module RiderKick
     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'
+      unless Dir.exist?('app/domains')
+        say 'Error must create clean arch structure first!'
+        raise Thor::Error, 'run: bin/rails generate rider_kick:clean_arch --setup'
       end
     end
 
@@ -54,7 +55,7 @@ module RiderKick
       @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_path = arg_scope['scope'].to_s.downcase rescue ''
       @route_scope_class = @route_scope_path.camelize rescue ''
 
       @type_mapping        = {
@@ -100,8 +101,8 @@ module RiderKick
 
     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
+      if @scope_owner_column.present?
+        skip_contract_fields << @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

data/lib/generators/rider_kick/structure_generator.rb

@@ -14,25 +14,24 @@ module RiderKick
     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'
+      unless Dir.exist?('app/domains')
+        say 'Error must create clean arch structure first!'
+        raise Thor::Error, 'run: bin/rails generate rider_kick:clean_arch --setup'
       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
+      @scope_owner_column = (SunSword.scope_owner_column.to_s rescue '')
+      @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
 
-      @type_mapping        = {
+      @type_mapping = {
         'uuid'     => ':string',
         'string'   => ':string',
         'text'     => ':string',
@@ -62,7 +61,7 @@ module RiderKick
     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)
+      @model_class.columns.reject { |column| (['id', 'created_at', 'updated_at', 'type'] + [@scope_owner_column.to_s]).include?(column.name.to_s) }.map(&:name).map(&:to_s)
     end
 
     def get_column_type(field)

data/lib/generators/rider_kick/templates/README.md

@@ -4,9 +4,7 @@
 ```bash
 $ cp env.example .env.development
 $ bundle install
-$ rails db:create
-$ rails db:migrate
-$ rails db:seed
+$ rails db:drop db:create db:migrate  db:seed
 ```
 ### Run Server
 ```bash

data/lib/generators/rider_kick/templates/config/initializers/hashie.rb.tt

@@ -10,6 +10,7 @@ def to_mash
 end
 RUBY
 
+Pagy.class_eval(as_attributes)
 Hash.class_eval(as_attributes)
 Hash.class_eval(to_methods)
 Hashie::Mash.class_eval(as_attributes)

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

@@ -5,6 +5,9 @@ fields:
 <% @model_class.columns.each do |field| -%>
   - <%= field.name.to_s %>
 <% end -%>
+<% @uploaders.each do |field| -%>
+  - <%= field %>
+<% end -%>
 uploaders:
 <% @uploaders.each do |field| -%>
   - <%= field %>
@@ -16,7 +19,6 @@ search_able:
 <% end -%>
 <% end -%>
 controllers:
-  route_scope: <%= @route_scope_path %>
   list_fields:
 <% @fields.each do |field| -%>
     - <%= field %>
@@ -25,31 +27,27 @@ controllers:
 <% @model_class.columns.each do |field| -%>
     - <%= field.name.to_s %>
 <% end -%>
-  form_fields:
-<% (@fields + @uploaders).each do |field| -%>
+<% @uploaders.each do |field| -%>
     - <%= field %>
+<% end -%>
+  form_fields:
+<% (@fields).each do |field| -%>
+    - name: <%= field %>
+      type: string
+<% end -%>
+<% (@uploaders).each do |field| -%>
+    - name: <%= field %>
+      type: file
 <% end -%>
 domains:
   action_list:
-    endpoint:
-      is_auth: true
-      is_skip: false
-      parameters:
     use_case:
       contract:
   action_fetch_by_id:
-    endpoint:
-      is_auth: true
-      is_skip: false
-      parameters:
     use_case:
       contract:
         - required(:id).filled(:string)
   action_create:
-    endpoint:
-      is_auth: true
-      is_skip: false
-      parameters:
     use_case:
       contract:
 <% (@fields + @uploaders).each do |field| -%>
@@ -62,10 +60,6 @@ domains:
 <% end -%>
 <% end -%>
   action_update:
-    endpoint:
-      is_auth: true
-      is_skip: false
-      parameters:
     use_case:
       contract:
         - required(:id).filled(:string)
@@ -79,10 +73,6 @@ domains:
 <% end -%>
 <% end -%>
   action_destroy:
-    endpoint:
-      is_auth: true
-      is_skip: false
-      parameters:
     use_case:
       contract:
         - required(:id).filled(:string)

data/lib/generators/rider_kick/templates/domains/core/repositories/abstract_repository.rb.tt

@@ -40,7 +40,7 @@ class Core::Repositories::AbstractRepository
   end
 
   def paginate!(pagy)
-    Core::Builders::Pagination.new(Hashie::Mash.new(pagy.as_json)).build
+    Core::Builders::Pagination.new(pagy).build
   end
 
   def build_pagination_variable!(params)

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

@@ -9,9 +9,9 @@ class Core::UseCases::Contract::Default
 
   def default
     Dry::Schema.Params do
-<% if RiderKick.scope_owner_column.present? -%>
-      required(:<%=RiderKick.scope_owner_column%> ).filled(:string)
-<% end-%>
+        if @scope_owner_column.present?
+          required(@scope_owner_column).filled(:string)
+        end
     end
   end
 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::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].reject { |c| c.empty? }.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::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].reject { |c| c.empty? }.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::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].reject { |c| c.empty? }.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::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].reject { |c| c.empty? }.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::<%= [@route_scope_class, @scope_class, @use_case_class].join("::") %> < RiderKick::UseCases::AbstractUseCase
+class Core::UseCases::<%= [@route_scope_class, @scope_class, @use_case_class].reject { |c| c.empty? }.join("::") %> < RiderKick::UseCases::AbstractUseCase
   contract do
     params(Core::UseCases::Contract::Default.new.call) do
 <% @contract_update.each do |field| -%>

data/lib/generators/rider_kick/templates/models/application_record.rb

@@ -0,0 +1,7 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+  self.abstract_class = true
+
+  # Adjust default sort order
+  self.implicit_order_column = :created_at
+end

data/lib/generators/rider_kick/templates/models/models.rb

@@ -0,0 +1,2 @@
+module Models
+end

data/lib/rider-kick.rb

@@ -5,10 +5,7 @@ require 'rider_kick/builders/abstract_active_record_entity_builder'
 require 'rider_kick/matchers/use_case_result'
 require 'rider_kick/use_cases/abstract_use_case'
 require 'rider_kick/use_cases/contract'
-require 'rider_kick/configuration'
 require 'rider_kick/version'
 
 module RiderKick
-  extend RiderKick::Configuration
-  define_setting :scope_owner_column, ''
 end

data/lib/rider_kick/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rider-kick
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kotaro Minami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher
@@ -151,7 +151,6 @@ files:
 - Rakefile
 - lib/generators/rider_kick/USAGE
 - lib/generators/rider_kick/clean_arch_generator.rb
-- lib/generators/rider_kick/init_generator.rb
 - lib/generators/rider_kick/scaffold_generator.rb
 - lib/generators/rider_kick/structure_generator.rb
 - lib/generators/rider_kick/templates/.gitignore
@@ -163,7 +162,6 @@ files:
 - lib/generators/rider_kick/templates/config/initializers/generators.rb.tt
 - lib/generators/rider_kick/templates/config/initializers/hashie.rb.tt
 - lib/generators/rider_kick/templates/config/initializers/pagy.rb.tt
-- lib/generators/rider_kick/templates/config/initializers/rider_kick.rb
 - lib/generators/rider_kick/templates/config/initializers/version.rb.tt
 - lib/generators/rider_kick/templates/config/initializers/zeitwerk.rb.tt
 - lib/generators/rider_kick/templates/db/migrate/20220613145533_init_database.rb
@@ -192,6 +190,8 @@ files:
 - lib/generators/rider_kick/templates/env.development
 - lib/generators/rider_kick/templates/env.production
 - lib/generators/rider_kick/templates/env.test
+- lib/generators/rider_kick/templates/models/application_record.rb
+- lib/generators/rider_kick/templates/models/models.rb
 - lib/generators/rider_kick/templates/spec/fixtures/sample.pdf
 - lib/generators/rider_kick/templates/spec/rails_helper.rb
 - lib/generators/rider_kick/templates/spec/support/file_stuber.rb
@@ -199,7 +199,6 @@ files:
 - lib/rider-kick.rb
 - lib/rider_kick/builders/abstract_active_record_entity_builder.rb
 - lib/rider_kick/builders/abstract_active_record_entity_builder_spec.rb
-- lib/rider_kick/configuration.rb
 - lib/rider_kick/entities/failure_details.rb
 - lib/rider_kick/matchers/use_case_result.rb
 - lib/rider_kick/matchers/use_case_result_spec.rb

data/lib/generators/rider_kick/init_generator.rb

@@ -1,15 +0,0 @@
-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/templates/config/initializers/rider_kick.rb

@@ -1,3 +0,0 @@
-RiderKick.setup do |config|
-  config.scope_owner_column = :organization_id
-end

data/lib/rider_kick/configuration.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RiderKick
-  module Configuration
-    def setup
-      yield self
-    end
-
-    def define_setting(name, default = nil)
-      class_variable_set("@@#{name}", default)
-
-      define_class_method "#{name}=" do |value|
-        class_variable_set("@@#{name}", value)
-      end
-
-      define_class_method name do
-        class_variable_get("@@#{name}")
-      end
-    end
-
-    private
-
-    def define_class_method(name, &block)
-      (class << self; self; end).instance_eval do
-        define_method name, &block
-      end
-    end
-  end
-end