jets-railtie 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d4d29cdd04a8e856cacc269780141d118483015e3fe7ed3ab9bec6cd28e002
-  data.tar.gz: 6aefe043bf6070c6b4eea6126b0750cb201b9ce579e3cdc56e6c8237eb3cd6df
+  metadata.gz: 1d88132a962ea916b76cb977db82b70ec9911e6331b46686ad32d5b81fa273d5
+  data.tar.gz: 600db5cb2897447a3a26df713338b9b0e17f8261fb40382d02c6abfe2588abc5
 SHA512:
-  metadata.gz: a7c7e987600ef48095b9b7ab2ad195322381b956ef186aa1a0ef1c8dee4b31909e8fefb1585c9cc65e6bef82ec24ea15d6f9d8ed52d48a3705f8c30daf4b84e2
-  data.tar.gz: 9757b2e3a5953e7e217d4183a8d36d907d536b04ee4460ca668bca6dd2fb3decf14f8a4ead3fc3d3d3bcc1d70e613514545517b73c292c9a5cdcec2433a607b6
+  metadata.gz: 6f4aace375c8ae534a1afb2b1b4515895331c86452dca29bed5e5a9375ce16be137d67e0326cd1b2ed7aacf67482c651773c9807e7b8a68ccbcd993e4d0f1a29
+  data.tar.gz: acd0ab0b46ca22140e66aca065c4330406a158b6da74672bdc2bd3af460bcbec847582726cb7b580ba062c09cf401602033dbcadf46335b178c91b3e6665b642

data/README.md

@@ -16,3 +16,15 @@ This library officially supports the following Ruby versions:
 ## License
 
 See `LICENSE` file.
+
+## Credits
+
+Original inspiration for the Jets project comes from [Vladimir Dementyev's](https://github.com/palkan)
+excellent presentation on component-based Rails monolith applications and his [Engems](https://github.com/palkan/engems)
+showcase repository.
+
+Code:
+- [Engems](https://github.com/palkan/engems)
+
+Talks:
+- [Between monoliths and microservices](https://noti.st/palkan/VWPOSd/between-monoliths-and-microservices)

data/lib/generators/jets/engine/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator creates a skeleton of a Rails engine with Jets conventions and configurations.
+
+Example:
+    rails generate jets:engine <name>

data/lib/generators/jets/engine/engine_generator.rb

@@ -17,6 +17,14 @@ module Jets
         chmod "engines/#{name}/bin/console", 0o755, verbose: false
         chmod "engines/#{name}/bin/rails", 0o755, verbose: false
       end
+
+      def mount_engine_to_routes
+        route "mount #{class_name}::Engine, at: \"/\", as: :#{name}_root"
+      end
+
+      def add_engine_to_gemfile_as_component
+        append_to_file "Gemfile", "component \"#{name}\""
+      end
     end
   end
 end

data/lib/generators/jets/engine/templates/app/controllers/%name%/application_controller.rb.tt

@@ -0,0 +1,4 @@
+module <%= class_name %>
+  class ApplicationController < Engine.config.application_controller.constantize
+  end
+end

data/lib/generators/jets/engine/templates/config/routes.rb.tt

@@ -0,0 +1,2 @@
+<%= class_name %>::Engine.routes.draw do
+end

data/lib/generators/jets/engine/templates/lib/%name%/engine.rb.tt

@@ -14,6 +14,9 @@ module <%= class_name %>
 
     config.autoload_paths += Dir["#{config.root}/app/**/concerns"]
 
+    # Specify the application controller base class, defaults to main application's ApplicationController
+    config.application_controller = "ApplicationController"
+
     initializer "<%= name %>" do |app|
       app.config.paths["db/migrate"].concat(config.paths["db/migrate"].expanded)
 
@@ -27,5 +30,20 @@ module <%= class_name %>
         FactoryBot.definition_file_paths.unshift engine_factories_path
       end
     end
+
+    initialize "<%= name %>.subscribe_to_events" do
+      ActiveSupport.on_load :active_event_store do |store|
+        # async subscriber is invoked from a background job, enqueued after the transaction commits
+        # store.subscribe MyEventHandler, to: EventHappened
+
+        # anonymous handler
+        # store.subscribe(to: EventHappened, sync: true) do |event|
+        #   # do something
+        # end
+
+        # subscribes to EventHappened automatically
+        # store.subscribe OnEventHappened::DoThat
+      end
+    end
   end
 end

data/lib/generators/jets/engine/templates/spec/internal/config/database.yml.tt

@@ -1,6 +1,6 @@
 test:
   adapter: postgresql
-  url: <%%= ENV["DATABASE_URL"].sub("postgres://", "postgis://") %>
+  url: <%%= ENV["DATABASE_URL"] %>
   pool: <%%= ENV["DB_POOL_SIZE"] || 5 %>
   timeout: 5000
   database: engine_<%= name %>_test

data/lib/generators/jets/engine/templates/spec/rails_helper.rb.tt

@@ -3,7 +3,9 @@
 # Engine root is used by rails_configuration to correctly
 # load fixtures and support files
 
-ENGINE_ROOT = Pathname.new(File.expand_path("..", __dir__))
+unless defined?(ENGINE_ROOT)
+  ENGINE_ROOT = Pathname.new(File.expand_path("..", __dir__))
+end
 
 ENV["RAILS_ENV"] = "test"
 ENV["BOOTSNAP_CACHE_DIR"] = File.join(ENGINE_ROOT, "spec", "internal", "tmp", "cache")
@@ -41,7 +43,12 @@ end
 # Rails.application.default_url_options[:host] = "localhost"
 # <%= class_name %>::Engine.routes.default_url_options[:host] = "localhost"
 
-require "jets/testing/rails_configuration"
+module Jets
+  module Testing
+  end
+end
+
+require "jets/testing/rails"
 
 # action_policy helpers
 # require "action_policy/rspec"

data/lib/generators/jets/engine/templates/spec/spec_helper.rb

@@ -3,4 +3,4 @@
 require "bundler/setup"
 require "pry-byebug"
 
-require "jets/testing/rspec_configuration"
+require "jets/testing/rspec"

data/lib/generators/jets/gem/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator creates skeleton of a shared gem for the project.
+
+Example:
+    rails generate jets:gem <name>

data/lib/generators/jets/gem/gem_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Jets
+  module Generators
+    class GemGenerator < ::Rails::Generators::NamedBase
+      namespace "jets:gem"
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a gem with given NAME with Jets conventions " \
+            "and configurations. \n\n"
+
+      def create_gem_file
+        directory(".", "gems/#{name}")
+
+        chmod "engines/#{name}/bin/console", 0o755, verbose: false
+      end
+    end
+  end
+end

data/lib/generators/jets/gem/templates/%name%.gemspec.tt

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require "<%= name %>/version"
+
+Gem::Specification.new do |s|
+  s.name = "<%= name %>"
+  s.version = <%= class_name %>::VERSION
+  s.authors = ["TODO"]
+  s.summary = "TODO:"
+  s.description = "TODO:"
+
+  s.files = Dir["{config,lib}/**/*", "Rakefile"]
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 2"
+  s.add_development_dependency "pry-byebug", "~> 3.4"
+  s.add_development_dependency "rake", "~> 13.0"
+
+  # Internal
+  s.add_development_dependency "jets-rubocop", "~> 0.1"
+  s.add_development_dependency "jets-testing", "~> 0.1"
+end

data/lib/generators/jets/gem/templates/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gemspec
+
+eval_gemfile "./Gemfile.runtime"
+
+gem "jets-testing"
+gem "jets-rubocop"

data/lib/generators/jets/gem/templates/README.md.tt

@@ -0,0 +1,29 @@
+# <%= class_name %>
+
+## Purpose
+
+TODO: Purpose of this gem.
+
+## Architecture
+
+TODO: Define the architecture of this gem.
+
+## Development Environment
+
+TODO: Write instructions how to set up a development environment for this gem.
+
+## Test Environment
+
+TODO: Write instructions how to set up a test environment for this gem.
+
+## Production Environment
+
+TODO: Write instructions how to use this gem in production.
+
+## Continuous Integration
+
+TODO: Write instructions on how this gem is continuously integrated.
+
+## Coding Style
+
+TODO: Define coding style for this gem.

data/lib/generators/jets/gem/templates/Rakefile.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/jets/gem/templates/bin/console.tt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "<%= name %>"
+
+require "pry"
+Pry.start

data/lib/generators/jets/gem/templates/lib/%name%.rb.tt

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "<%= name %>/version"

data/lib/generators/jets/gem/templates/lib/%name%/version.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module <%= class_name %>
+  VERSION = "0.1.0"
+end

data/lib/generators/jets/gem/templates/spec/rails_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] = "test"
+
+require "jets/testing/rails"

data/lib/generators/jets/gem/templates/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pry-byebug"
+
+require "jets/testing/rspec"

data/lib/generators/jets/install/install_generator.rb

@@ -13,6 +13,11 @@ module Jets
       def set_rails_version
         template ".rails-version", "./.rails-version"
       end
+
+      def modify_gemfile
+        prepend_to_file "Gemfile", 'require "bundler/component"'
+        prepend_to_file "Gemfile", 'require "bundler/eval_gemfile"'
+      end
     end
   end
 end

data/lib/jets/rails/railtie.rb

@@ -10,6 +10,7 @@ module Jets
     class Railtie < ::Rails::Railtie
       generators do
         require "generators/jets/engine/engine_generator"
+        require "generators/jets/gem/gem_generator"
         require "generators/jets/install/install_generator"
       end
     end

data/lib/jets/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Jets
   module Rails
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets-railtie
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lauri Jutila
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jets-bundler
@@ -159,14 +159,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - jets-railtie.gemspec
+- lib/generators/jets/engine/USAGE
 - lib/generators/jets/engine/engine_generator.rb
 - lib/generators/jets/engine/templates/%name%.gemspec.tt
 - lib/generators/jets/engine/templates/Gemfile
 - lib/generators/jets/engine/templates/Gemfile.runtime
 - lib/generators/jets/engine/templates/README.md.tt
 - lib/generators/jets/engine/templates/Rakefile.tt
+- lib/generators/jets/engine/templates/app/controllers/%name%/application_controller.rb.tt
 - lib/generators/jets/engine/templates/bin/console.tt
 - lib/generators/jets/engine/templates/bin/rails.tt
+- lib/generators/jets/engine/templates/config/routes.rb.tt
 - lib/generators/jets/engine/templates/lib/%name%.rb.tt
 - lib/generators/jets/engine/templates/lib/%name%/engine.rb.tt
 - lib/generators/jets/engine/templates/lib/%name%/version.rb.tt
@@ -175,6 +178,18 @@ files:
 - lib/generators/jets/engine/templates/spec/internal/db/schema.rb
 - lib/generators/jets/engine/templates/spec/rails_helper.rb.tt
 - lib/generators/jets/engine/templates/spec/spec_helper.rb
+- lib/generators/jets/gem/USAGE
+- lib/generators/jets/gem/gem_generator.rb
+- lib/generators/jets/gem/templates/%name%.gemspec.tt
+- lib/generators/jets/gem/templates/Gemfile
+- lib/generators/jets/gem/templates/Gemfile.runtime
+- lib/generators/jets/gem/templates/README.md.tt
+- lib/generators/jets/gem/templates/Rakefile.tt
+- lib/generators/jets/gem/templates/bin/console.tt
+- lib/generators/jets/gem/templates/lib/%name%.rb.tt
+- lib/generators/jets/gem/templates/lib/%name%/version.rb.tt
+- lib/generators/jets/gem/templates/spec/rails_helper.rb
+- lib/generators/jets/gem/templates/spec/spec_helper.rb
 - lib/generators/jets/install/install_generator.rb
 - lib/jets-railtie.rb
 - lib/jets/rails.rb