domain_engine 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5754785172c640582cb6a3f167192920be3d02a4a21079137126cdc2bcbe79a
+  data.tar.gz: d13ffd999cd838669b9f563b01a7192ceed44892d08fa0a3185fcfdee52724ac
+SHA512:
+  metadata.gz: 71dc0bc572601fb9f2da82cca6bfdae3ce659528fdd6a5d26c3bcdc484a4cf8c569fbaaad90a0472ad39d8f1067f388fa45cab71b2e08db34ea14c90e9b10bd6
+  data.tar.gz: 507e0274e5fcc7bade0f6d259fe7808b8c0763267290acab007e0f8bc935df538ddcb546b545dce4b4af9af9068dbeaac0c87f5801336bb2455a7d913eefdd65

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+# Domain Engine
+
+This gem provides a rails generator for scaffolding new domain engines in a Rails project.
+
+## Installation
+
+Add it to your Gemfile under the development dependencies:
+
+```ruby
+group :development do
+  gem "domain_engine"
+end
+```
+
+## Usage
+
+You can invoke it like any other generator. It requires an argument for the name of your domain.
+The name can be provided as a class name (`MyDomain`) or a file name (`my_domain`)
+
+`rails g domain_engine:new MyDomain`
+
+The following folders are created under a `domains` folder in the root of the Rails app (`domains` is also created if it does not exist):
+
+``` shell
+domains/my_domain/
+├── app
+│   ├── blueprints
+│   │   └── my_domain
+│   ├── commands
+│   │   └── my_domain
+│   ├── controllers
+│   │   └── my_domain
+│   │       ├── application_controller.rb
+│   │       └── hellos_controller.rb
+│   ├── domain
+│   │   └── my_domain
+│   ├── infrastructure
+│   │   └── my_domain
+│   ├── jobs
+│   │   └── my_domain
+│   ├── models
+│   │   └── my_domain
+│   └── queries
+│       └── my_domain
+├── config
+│   └── routes.rb
+├── doc
+├── lib
+│   ├── engine.rb
+│   └── tasks
+├── package.yml
+└── spec
+    ├── commands
+    │   └── my_domain
+    ├── controllers
+    │   └── my_domain
+    │       └── hellos_controller_spec.rb
+    ├── domain
+    │   └── my_domain
+    ├── factories
+    ├── fixtures
+    ├── infrastructure
+    │   └── my_domain
+    ├── jobs
+    │   └── my_domain
+    ├── models
+    │   └── my_domain
+    ├── package_helper.rb
+    ├── queries
+    │   └── my_domain
+    ├── requests
+    │   └── my_domain
+    └── support
+        └── controller_extension.rb
+```
+
+## Verify
+
+Once completed you can verify that your domain works by running `rspec domains/my_domain` and see the example spec pass.

data/domain_engine.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('lib/domain_engine/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'domain_engine'
+  spec.version               = DomainEngine::VERSION
+  spec.authors               = ['Josh Cass']
+  spec.email                 = ['josh@bonus.ly']
+  spec.summary               = 'Provides a rails generator for Bonusly domain engines'
+  spec.homepage              = 'https://gitlab.com/bonusly/engineering/gems/domain-engine'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = '>= 3.2.2'
+  spec.require_paths = ['lib']
+  spec.files = Dir['README.md', 'lib/**/*.rb', 'lib/**/*.rb.tt', 'lib/**/*.yml.tt', 'domain_engine.gemspec', 'Gemfile', 'Rakefile']
+
+  spec.add_dependency 'railties', '>= 7.0'
+
+  spec.add_development_dependency 'solargraph', '>= 0.50'
+end

data/lib/domain_engine/version.rb

@@ -0,0 +1,3 @@
+module DomainEngine
+  VERSION = '1.1.0'
+end

data/lib/domain_engine.rb

@@ -0,0 +1,4 @@
+require 'rails'
+
+module DomainEngine
+end

data/lib/generators/domain_engine/new_generator.rb

@@ -0,0 +1,70 @@
+require 'rails/generators'
+
+module DomainEngine
+  module Generators
+    class NewGenerator < Rails::Generators::NamedBase
+      desc 'Generates scaffolding for a package engine under /domains/NAME'
+
+      source_root File.expand_path('../templates', __dir__)
+
+      def create_top_level_directories
+        empty_directory 'domains'
+        empty_directory "domains/#{file_name}"
+        empty_directory "domains/#{file_name}/app"
+        empty_directory "domains/#{file_name}/config"
+        empty_directory "domains/#{file_name}/lib"
+        empty_directory "domains/#{file_name}/spec"
+        empty_directory_with_keep_file "domains/#{file_name}/doc"
+      end
+
+      def create_sub_directories
+        empty_directory "domains/#{file_name}/app/controllers/#{file_name}"
+        empty_directory "domains/#{file_name}/spec/controllers/#{file_name}"
+        empty_directory "domains/#{file_name}/spec/support"
+
+        empty_directory_with_keep_file "domains/#{file_name}/app/blueprints/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/commands/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/domain/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/infrastructure/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/jobs/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/models/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/app/queries/#{file_name}"
+
+        empty_directory_with_keep_file "domains/#{file_name}/lib/tasks"
+
+        empty_directory_with_keep_file "domains/#{file_name}/spec/factories"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/fixtures"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/commands/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/domain/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/infrastructure/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/jobs/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/models/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/queries/#{file_name}"
+        empty_directory_with_keep_file "domains/#{file_name}/spec/requests/#{file_name}"
+      end
+
+      def create_files
+        template 'package.yml', "domains/#{file_name}/package.yml"
+        template 'engine.rb', "domains/#{file_name}/lib/engine.rb"
+        template 'routes.rb', "domains/#{file_name}/config/routes.rb"
+        template 'application_controller.rb', "domains/#{file_name}/app/controllers/#{file_name}/application_controller.rb"
+        template 'hellos_controller.rb', "domains/#{file_name}/app/controllers/#{file_name}/hellos_controller.rb"
+        template 'package_helper.rb', "domains/#{file_name}/spec/package_helper.rb"
+        template 'controller_extension.rb', "domains/#{file_name}/spec/support/controller_extension.rb"
+        template 'hellos_controller_spec.rb',
+                 "domains/#{file_name}/spec/controllers/#{file_name}/hellos_controller_spec.rb"
+      end
+
+      private
+
+      def empty_directory_with_keep_file(destination)
+        empty_directory destination
+        keep_file destination
+      end
+
+      def keep_file(destination)
+        create_file("#{destination}/.keep")
+      end
+    end
+  end
+end

data/lib/generators/templates/application_controller.rb.tt

@@ -0,0 +1,4 @@
+module <%= class_name %>
+  class ApplicationController < ActionController::API
+  end
+end

data/lib/generators/templates/controller_extension.rb.tt

@@ -0,0 +1,20 @@
+module <%= class_name %>
+  module ControllerExtension
+    def self.included(base)
+      base.routes { <%=class_name %>::Engine.routes }
+    end
+
+    # You may add more controller extension code here
+    # for example you might want to provide a method to
+    # easily authenticate a user in your specs:
+    #
+    # def authenticate_user(user_id: BSON::ObjectId.new, company_id: BSON::ObjectId.new)
+    #   allow(controller).to receive(:authenticator).and_return(
+    #     double("Mock::Api::Authenticator",
+    #            authenticate: true,
+    #            authenticated_user_id: user_id,
+    #            authenticated_company_id: company_id)
+    #     )
+    # end
+  end
+end

data/lib/generators/templates/engine.rb.tt

@@ -0,0 +1,5 @@
+module <%= class_name %>
+  class Engine < Rails::Engine
+    isolate_namespace <%= class_name %>
+  end
+end

data/lib/generators/templates/hellos_controller.rb.tt

@@ -0,0 +1,7 @@
+module <%= class_name %>
+  class HellosController < ApplicationController
+    def index
+      render json: { message: "hello world!" }
+    end
+  end
+end

data/lib/generators/templates/hellos_controller_spec.rb.tt

@@ -0,0 +1,11 @@
+require_relative '../../package_helper'
+
+RSpec.describe <%= class_name %>::HellosController do
+  include <%= class_name %>::ControllerExtension
+
+  it "says hello" do
+    get :index
+
+    expect(JSON.parse(response.body)["message"]).to eq "hello world!"
+  end
+end

data/lib/generators/templates/package.yml.tt

@@ -0,0 +1,2 @@
+enforce_dependencies: true
+enforce_privacy: true

data/lib/generators/templates/package_helper.rb.tt

@@ -0,0 +1,8 @@
+# Load spec helper from the main app
+require File.expand_path("../../../spec/spec_helper.rb", __dir__)
+
+# Load package engine factories
+Dir.glob(File.expand_path("factories/**/*.rb", __dir__)).sort.each { |f| require f }
+
+# Load package engine spec support
+Dir.glob(File.expand_path("support/**/*.rb", __dir__)).sort.each { |f| require f }

data/lib/generators/templates/routes.rb.tt

@@ -0,0 +1,3 @@
+<%= class_name %>::Engine.routes.draw do
+  resources :hellos, only: :index
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: domain_engine
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Josh Cass
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description:
+email:
+- josh@bonus.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- domain_engine.gemspec
+- lib/domain_engine.rb
+- lib/domain_engine/version.rb
+- lib/generators/domain_engine/new_generator.rb
+- lib/generators/templates/application_controller.rb.tt
+- lib/generators/templates/controller_extension.rb.tt
+- lib/generators/templates/engine.rb.tt
+- lib/generators/templates/hellos_controller.rb.tt
+- lib/generators/templates/hellos_controller_spec.rb.tt
+- lib/generators/templates/package.yml.tt
+- lib/generators/templates/package_helper.rb.tt
+- lib/generators/templates/routes.rb.tt
+homepage: https://gitlab.com/bonusly/engineering/gems/domain-engine
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Provides a rails generator for Bonusly domain engines
+test_files: []