rider-kick 0.0.1 → 0.0.3

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

@@ -0,0 +1,69 @@
+## Setup project
+
+### Init Project
+```bash
+$ cp env.example .env.development
+$ bundle install
+$ rails db:create
+$ rails db:migrate
+$ rails db:seed
+```
+### Run Server
+```bash
+$ rails s -b 0.0.0.0 -e development
+# open new tab then run
+# open your browser then serve to http://0.0.0.0:3000
+```
+
+### Run Console
+```bash
+$ rails console
+(dev)> use_case = Core::UseCases::GetVersion
+(dev)> contract = use_case.contract!({})
+(dev)> result   = use_case.new(contract).result
+=> Success({:version=>"v1"}) # success
+(dev)> result.success?
+=> true
+(dev)> result.success
+=> {:version=>"0.0.1"}
+```
+
+Project Structure
+## 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
+  - domains 
+    - 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
+  - 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
+    ```
+
+Happy Coding!

data/lib/generators/rider_kick/templates/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/rider_kick/templates/config/initializers/clean_archithecture.rb.tt

@@ -0,0 +1,10 @@
+# typed: ignore
+# frozen_string_literal: true
+
+require 'dry/monads/all'
+require 'dry-types'
+module Types
+  include Dry.Types()
+    File = Types.Instance(::File) | Types.Instance(ActionDispatch::Http::UploadedFile) | Types.Instance(Rack::Test::UploadedFile)
+  public_constant :File
+end

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

@@ -0,0 +1,14 @@
+Rails.application.config.generators do |gs|
+  gs.orm :active_record, primary_key_type: :uuid
+  gs.fixture_replacement :factory_bot
+  gs.assets          = false
+  gs.helper          = false
+  gs.test_framework :rspec,
+                    fixtures:         false,
+                    view_specs:       false,
+                    model_specs:      false,
+                    helper_specs:     false,
+                    routing_specs:    false,
+                    request_specs:    false,
+                    controller_specs: false
+end

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

@@ -0,0 +1,16 @@
+as_attributes = <<-RUBY
+def attributes
+ ActiveSupport::HashWithIndifferentAccess.new(self.as_json).symbolize_keys
+end
+RUBY
+
+to_methods = <<-RUBY
+def to_mash
+  Hashie::Mash.new(self)
+end
+RUBY
+
+Hash.class_eval(as_attributes)
+Hash.class_eval(to_methods)
+Hashie::Mash.class_eval(as_attributes)
+ActiveSupport::HashWithIndifferentAccess.class_eval(as_attributes)

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

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# Optionally override some pagy default with your own in the pagy initializer
+Pagy::DEFAULT[:limit] = 30 # items per page
+Pagy::DEFAULT[:size]  = 9  # nav bar links
+# Better user experience handled automatically
+require 'pagy/extras/overflow'
+Pagy::DEFAULT[:overflow] = :empty_page
+require 'pagy/extras/elasticsearch_rails'
+require 'pagy/extras/array'
+
+include Pagy::Backend

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

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

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module <%= Rails.application.class.module_parent_name %>
+  VERSION = '0.0.1'
+  public_constant :VERSION
+end

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

@@ -0,0 +1,3 @@
+Rails.autoloaders.each do |autoloader|
+  autoloader.ignore(Rails.root.join('**', '*_spec.rb'))
+end

data/lib/generators/rider_kick/templates/db/migrate/20220613145533_init_database.rb

@@ -0,0 +1,5 @@
+class InitDatabase < ActiveRecord::Migration[7.2]
+  def change
+    enable_extension 'pgcrypto'
+  end
+end

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

@@ -0,0 +1,96 @@
+model: <%= @model_class %>
+resource_name: <%= @scope_path %>
+actor: <%= @actor %>
+fields:
+<% @model_class.columns.each do |field| -%>
+  - <%= field.name.to_s %>
+<% end -%>
+uploaders:
+<% @uploaders.each do |field| -%>
+  - <%= field %>
+<% end -%>
+search_able:
+<% contract_fields.each do |field| -%>
+<% if ['title', 'name'].include?(field) -%>
+  - <%= field %>
+<% end -%>
+<% end -%>
+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:
+    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| -%>
+  <% column_type = get_column_type(field) -%>
+  <% dry_type = @type_mapping[column_type.to_s] || ':string' -%>
+<% if @uploaders.include?(field) -%>
+    - optional(:<%= field %>).maybe(<%= dry_type %>)
+<% else -%>
+    - required(:<%= field %>).filled(<%= dry_type %>)
+<% end -%>
+<% end -%>
+  action_update:
+    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 %>)
+<% else -%>
+        - optional(:<%= field %>).maybe(<%= dry_type %>)
+<% end -%>
+<% end -%>
+  action_destroy:
+    endpoint:
+      is_auth: true
+      is_skip: false
+      parameters:
+    use_case:
+      contract:
+        - required(:id).filled(:string)
+entity:
+  skipped_fields:
+    - id
+    - created_at
+    - updated_at
+<% if @model_class.columns.map(&:name).include?(:type) -%>
+    - type
+<% end -%>

data/lib/generators/rider_kick/templates/domains/core/builders/builder.rb.tt

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Core::Builders::<%=  @subject_class %> < RiderKick::Builders::AbstractActiveRecordEntityBuilder
+  acts_as_builder_for_entity Core::Entities::<%= @subject_class%>
+<% if @uploaders.present? -%>
+  def attributes_for_entity
+    {
+<% @uploaders.each_with_index do |upload, index| -%>
+      <%= upload %>: (Rails.application.routes.url_helpers.polymorphic_url(params.<%= upload %>) rescue '')<%= ',' if index < @uploaders.size - 1 %>
+<% end -%>
+    }
+  end
+<% end -%>
+end

data/lib/generators/rider_kick/templates/domains/core/builders/error.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Core::Builders::Error < RiderKick::Builders::AbstractActiveRecordEntityBuilder
+  acts_as_builder_for_entity Core::Entities::Error
+end

data/lib/generators/rider_kick/templates/domains/core/builders/pagination.rb.tt

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Core::Builders::Pagination < RiderKick::Builders::AbstractActiveRecordEntityBuilder
+  acts_as_builder_for_entity Core::Entities::Pagination
+
+  def attributes_for_entity
+    {
+      total_count: params[:count],
+      page:        params.page,
+      per_page:    params.limit,
+      page_count:  params.last
+    }
+  end
+end

data/lib/generators/rider_kick/templates/domains/core/entities/entity.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Core::Entities::<%=  @subject_class %> < Dry::Struct
+<% (['id'] + @fields + @uploaders + ['created_at', 'updated_at']).each do |field| -%>
+<% column_type = get_column_type(field) -%>
+<% dry_type = @entity_type_mapping[column_type.to_s] || 'Types::Strict::String' -%>
+  attribute :<%= field %>, <%= dry_type %>
+<% end -%>
+end

data/lib/generators/rider_kick/templates/domains/core/entities/error.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Core::Entities::Error < Dry::Struct
+  attribute :attribute, Types::Strict::String
+  attribute :type, Types::Strict::String
+  attribute :options, Types::Hash.optional
+end

data/lib/generators/rider_kick/templates/domains/core/entities/pagination.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Core::Entities::Pagination < Dry::Struct
+  attribute :total_count, Types::Strict::Integer
+  attribute :page, Types::Strict::Integer
+  attribute :per_page, Types::Strict::Integer
+  attribute :page_count, Types::Strict::Integer
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Core::Repositories::AbstractRepository
+  include Dry::Monads[:result, :do]
+
+  def http
+    extend(Core::Utils::RequestMethods)
+  end
+
+  def parse_response(response)
+    begin
+      res = JSON.parse(response.body)
+    rescue => e
+      return Failure e
+    end
+    unless ['200', '201', '202'].include?(response.code.to_s)
+      return Failure Hashie::Mash.new(res)
+    end
+    Success Hashie::Mash.new(res)
+  end
+
+  def error_messages_for(record)
+    record.errors.to_a.join(', ')
+  end
+
+  def build_errors(resource)
+    errors = []
+    resource.errors.each do |error|
+      errors << Core::Builders::Error.new(error.as_json).build
+    end
+    errors
+  end
+
+  def prepare!(params, sanitize: true)
+    if sanitize
+      Hashie::Mash.new(params.reject { |_, v| v.nil? || (v.is_a?(String) && v.blank?) })
+    else
+      Hashie::Mash.new(params)
+    end
+  end
+
+  def paginate!(pagy)
+    Core::Builders::Pagination.new(Hashie::Mash.new(pagy.as_json)).build
+  end
+
+  def build_pagination_variable!(params)
+    @per_page = params[:per_page] || Pagy::DEFAULT[:limit]
+    @page     = params[:page] || Pagy::DEFAULT[:page]
+    @search   = params[:search]
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Core::Repositories::<%= @scope_class %>::<%= @repository_class %> < Core::Repositories::AbstractRepository
+  def initialize(params: {})
+    @params     = prepare! params, sanitize: true
+  end
+
+  def call(builder: true)
+    resource = <%= @model_class %>.new(@params.to_h)
+    unless resource.save
+      return Failure build_errors(resource)
+    end
+    Success Core::Builders::<%= @subject_class %>.new(resource).build
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Core::Repositories::<%= @scope_class %>::<%= @repository_class %> < Core::Repositories::AbstractRepository
+  def initialize(id:)
+    @id  = id
+  end
+
+  def call(builder: true)
+    resource = <%= @model_class %>.find_by(id: @id)
+    return Failure '<%= @subject_class %> not found' unless resource.present?
+    unless resource.destroy
+      return Failure build_errors(resource)
+    end
+    Success '<%= @subject_class%> Destroyed.'
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Core::Repositories::<%= @scope_class %>::<%= @repository_class %> < Core::Repositories::AbstractRepository
+  def initialize(id:)
+    @id  = id
+  end
+
+  def call(builder: true)
+    resource = <%= @model_class %>.find_by(id: @id)
+    return Failure '<%= @subject_class %> not found' unless resource.present?
+    Success Core::Builders::<%= @subject_class %>.new(resource).build
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Core::Repositories::<%= @scope_class %>::<%= @repository_class%> < Core::Repositories::AbstractRepository
+  def initialize(params:)
+    @params = prepare! params, sanitize: true
+    build_pagination_variable! @params
+  end
+
+  def call(builder: true)
+    resources = <%= @model_class %>
+    if @search.present?
+      resources = resources.where('<%= @search_able.map { |field| "LOWER(#{field}) LIKE :search" }.join(' OR ')%>', search: "%#{search}%")
+    end
+    return Success [] unless resources.present?
+    pagy, results = pagy(resources.order(created_at: :desc), limit: @per_page, page: @page)
+    response      = results.map { |result| Core::Builders::<%= @subject_class %>.new(result).build }
+    Success Hashie::Mash.new(response: response, meta: paginate!(pagy))
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Core::Repositories::<%= @scope_class %>::<%= @repository_class %> < Core::Repositories::AbstractRepository
+  def initialize(id:, params: {})
+    @id     = id
+    @params = prepare! params, sanitize: true
+  end
+
+  def call(builder: true)
+    resource = <%= @model_class %>.find_by(id: @id)
+    return Failure '<%= @subject_class %> not found' unless resource.present?
+<% if @uploaders.present? -%>
+    # Remove the existing images if a new one is being uploaded
+<% @uploaders.each do |uplaoder| -%>
+    resource.<%=uplaoder %>.purge if @params.<%=uplaoder %>.present? && resource.<%=uplaoder %>.attached?
+<% end -%>
+<% end -%>
+    unless resource.update(@params.to_h)
+      return Failure build_errors(resource)
+    end
+    Success Core::Builders::<%= @subject_class %>.new(resource).build
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Core::UseCases::Contract::Default
+  def call
+    default
+  end
+
+  private
+
+  def default
+    Dry::Schema.Params do
+<% if RiderKick.scope_owner_column.present? -%>
+      required(:<%=RiderKick.scope_owner_column%> ).filled(:string)
+<% end-%>
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class Core::UseCases::Contract::Pagination
+  def call
+    pagination
+  end
+
+  private
+
+  def pagination
+    Dry::Schema.Params do
+      optional(:page).maybe(:integer)
+      optional(:per_page).maybe(:integer)
+      optional(:search).maybe(:string)
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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| -%>
+      <%= field %>
+<% end -%>
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params = yield build_parameter!
+    Core::Repositories::<%= @scope_class%>::<%= @repository_class%>.new(params: params).call(builder: true)
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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| -%>
+      <%= field %>
+<% end -%>
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params = yield build_parameter!
+    Core::Repositories::<%= @scope_class%>::<%= @repository_class%>.new(id: params.id).call(builder: true)
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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| -%>
+      <%= field %>
+<% end -%>
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params = yield build_parameter!
+    Core::Repositories::<%= @scope_class%>::<%= @repository_class%>.new(id: params.id).call(builder: true)
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Core::UseCases::GetVersion < RiderKick::UseCases::AbstractUseCase
+  contract do
+    params do
+      # required(:version).filled(:string)
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params   = yield build_parameter!
+    response = { version:  <%= Rails.application.class.module_parent_name %>::VERSION }
+    Success response
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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| -%>
+      <%= field %>
+<% end -%>
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params = yield build_parameter!
+    Core::Repositories::<%= @scope_class%>::<%= @repository_class%>.new(params: params).call(builder: true)
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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| -%>
+      <%= field %>
+<% end -%>
+    end
+  end
+  # Set specific return monads at method 'result'
+  include Dry::Monads::Do.for(:result)
+
+  def result
+    params = yield build_parameter!
+    Core::Repositories::<%= @scope_class%>::<%= @repository_class%>.new(id: params.id, params: params.except(:id)).call(builder: true)
+  end
+end