rails_ops 1.1.26 → 1.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f526737c309842ce86558e77bc8ac5292d0d5e4faa82a848926cb03e725e51cf
-  data.tar.gz: fba2d918a81609ce6c778eecfe772d0aa252932403774234718309764b2ba348
+  metadata.gz: 3bcce101893137c4a67443fb2f0c056695a9f31d9eddd4d8db480e2e27abb004
+  data.tar.gz: 360264275974a50bf59bde14c29ea5a10192d35bc7c983829a190b56aa4bc853
 SHA512:
-  metadata.gz: a3abbc42c29d64386772eceb6095edeecf667ac65987f83acaebe9e93f9a1c6d030536130f9d5430073a6beb8f91e9162f86d0d4e624e214e2a2377ed006ef41
-  data.tar.gz: 5c396aae16103eeec31349daf26708c6eb24b66c9cf39b29a40a1f70e7686d1b6c6b21c8e49af6c5bd000b3ad24ef18c0beb8cf088094192dbaf70a6a45fe512
+  metadata.gz: a3334b17bf543eb8168f13388a822e3572c9a6bb4522cc8db8d27755ffda18cccaba4a7283efc21e8d4da3bd5c5e2ab64d7eef2c5ad7478aef57b432dd23f06d
+  data.tar.gz: 87e7d4cc99de70f5287f1c639b9607dfac59a8fcf492225fbc3956f49f2f7f372724eb153dd9016cc2927d9e5116a0522531e681fcd577314118ecda484f7393

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.27 (2022-02-15)
+
+* Add `module` option to `operation` generator
+
 ## 1.1.26 (2022-01-18)
 
 * #25: Add test matrix for unit tests

data/README.md

@@ -67,15 +67,16 @@ Requirements & Installation
    following inside of the `Application` class within your
    `config/application.rb`:
 
-    ```ruby
-    config.paths = Rails::Paths::Root.new(Rails.root)
-    config.paths.add 'app/models', eager_load: true
-    config.paths.add 'app', eager_load: true
+   ```ruby
+   app_operations = "#{Rails.root}/app/operations"
+   ActiveSupport::Dependencies.autoload_paths.delete(app_operations)
+
+   module Operations; end
+   loader = Rails.autoloaders.main
+   loader.push_dir(app_operations, namespace: Operations)
+   ```
 
-    # WARNING: Skip this if you have any script files in your lib/ directory
-    # that will run when loaded.
-    config.paths.add 'lib', eager_load: true
-    ```
+   Taken from [this github issues comment](https://github.com/rails/rails/issues/40126#issuecomment-816275285).
 
 Operation Basics
 ----------------
@@ -1546,6 +1547,36 @@ flags:
 
 Or if you want to skip them all: `--only-operations`.
 
+You can also add a module as a namespace, all generated files will be put in
+the proper subfolders and modules by using the `--module` option.
+
+As an example:
+
+```ruby
+rails g operation User --module Admin
+```
+
+This will generate the following operations:
+
+* `app/operations/admin/user/load.rb`
+* `app/operations/admin/user/create.rb`
+* `app/operations/admin/user/update.rb`
+* `app/operations/admin/user/destroy.rb`
+
+These operations will be namespaced in the `Admin` module, e.g. `app/operations/admin/user/load.rb` will define `Operations::Admin::User::Load`.
+
+It will also generate the controller `app/controllers/admin/users_controller.rb` and the following
+empty view files:
+
+* `app/views/admin/users/index.html.haml`
+* `app/views/admin/users/show.html.haml`
+* `app/views/admin/users/new.html.haml`
+* `app/views/admin/users/edit.html.haml`
+
+Both lower- and uppercase will generate the same files (i.e. `--module Admin` and `--module admin` are equal).
+
+You can even nest the generated files deeper, `--module Admin::Foo` and `--module admin/foo` will both work.
+
 Of course, at this point, the operations will need some adaptions, especially the
 [parameter schemas](#validating-params), and the controllers need the logic for the
 success and failure cases, as this depends on your application.

data/VERSION

@@ -1 +1 @@
-1.1.26
+1.1.27

data/lib/generators/operation/operation_generator.rb

@@ -5,13 +5,23 @@ class OperationGenerator < Rails::Generators::NamedBase
   class_option :skip_views, type: :boolean, desc: "Don't add the views."
   class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
   class_option :only_operations, type: :boolean, desc: 'Only add the operations. This is equal to specifying --skip-controller --skip-routes --skip-views'
+  class_option :module, type: :string, desc: 'Add the operations in a module, e.g. "Admin" results in namespacing everything in the Admin module'
 
   def add_operations
     @class_name = name.classify
     @underscored_name = name.underscore
     @underscored_pluralized_name = name.underscore.pluralize
 
-    operations_path = "app/operations/#{@underscored_name}"
+    operations_path = 'app/operations/'
+
+    if options[:module].present?
+      @module_name = options[:module].classify
+      @module_underscored_name = @module_name.underscore
+
+      operations_path += "#{@module_underscored_name}/"
+    end
+
+    operations_path += @underscored_name.to_s
 
     template 'load.erb', "#{operations_path}/load.rb"
     template 'create.erb', "#{operations_path}/create.rb"
@@ -22,7 +32,11 @@ class OperationGenerator < Rails::Generators::NamedBase
   def add_controller
     return if options[:skip_controller] || options[:only_operations]
 
-    controller_file_path = "app/controllers/#{@underscored_pluralized_name}_controller.rb"
+    controller_file_path = 'app/controllers/'
+    if @module_underscored_name.present?
+      controller_file_path += "#{@module_underscored_name}/"
+    end
+    controller_file_path += "#{@underscored_pluralized_name}_controller.rb"
     @controller_name = "#{@class_name.pluralize}Controller"
 
     template 'controller.erb', controller_file_path
@@ -31,7 +45,11 @@ class OperationGenerator < Rails::Generators::NamedBase
   def add_views
     return if options[:skip_views] || options[:only_operations]
 
-    views_folder = "app/views/#{@underscored_pluralized_name}"
+    views_folder = 'app/views/'
+    if @module_underscored_name.present?
+      views_folder += "#{@module_underscored_name}/"
+    end
+    views_folder += @underscored_pluralized_name.to_s
 
     %w(index show new edit).each do |view|
       template 'view.erb', "#{views_folder}/#{view}.html.haml"

data/lib/generators/operation/templates/controller.erb

@@ -1,16 +1,18 @@
-class <%= @controller_name %> < ApplicationController
+<%
+controller_code = <<-RUBY
+class #{@controller_name} < ApplicationController
   def index; end
 
   def show
-    op Operations::<%= @class_name %>::Load
+    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Load
   end
 
   def new
-    op Operations::<%= @class_name %>::Create
+    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Create
   end
 
   def create
-    if run Operations::<%= @class_name %>::Create
+    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Create
       # handle successful case
     else
       # handle error case
@@ -18,11 +20,11 @@ class <%= @controller_name %> < ApplicationController
   end
 
   def edit
-    op Operations::<%= @class_name %>::Update
+    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Update
   end
 
   def update
-    if run Operations::<%= @class_name %>::Update
+    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Update
       # handle successful case
     else
       # handle error case
@@ -30,10 +32,25 @@ class <%= @controller_name %> < ApplicationController
   end
 
   def destroy
-    if run Operations::<%= @class_name %>::Destroy
+    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Destroy
       # handle successful case
     else
       # handle error case
     end
   end
 end
+RUBY
+-%>
+<% if @module_name.present? -%>
+module <%= @module_name %>
+<% controller_code.split("\n").each do |line| -%>
+<% if line.blank? -%>
+
+<% else -%>
+  <%= line %>
+<% end -%>
+<% end -%>
+end
+<% else -%>
+<%= controller_code -%>
+<% end -%>

data/lib/generators/operation/templates/create.erb

@@ -1,4 +1,8 @@
+<% if @module_name.present? -%>
+module Operations::<%= @module_name %>::<%= @class_name %>
+<% else -%>
 module Operations::<%= @class_name %>
+<% end -%>
   class Create < RailsOps::Operation::Model::Create
     schema3 do
       hsh? :<%= @underscored_name %> do

data/lib/generators/operation/templates/destroy.erb

@@ -1,4 +1,8 @@
+<% if @module_name.present? -%>
+module Operations::<%= @module_name %>::<%= @class_name %>
+<% else -%>
 module Operations::<%= @class_name %>
+<% end -%>
   class Destroy < RailsOps::Operation::Model::Destroy
     schema3 do
       str! :id

data/lib/generators/operation/templates/load.erb

@@ -1,5 +1,13 @@
+<% if @module_name.present? -%>
+module Operations::<%= @module_name %>::<%= @class_name %>
+<% else -%>
 module Operations::<%= @class_name %>
+<% end -%>
   class Load < RailsOps::Operation::Model::Load
+    schema3 do
+      str! :id
+    end
+
     model ::<%= @class_name %>
   end
 end

data/lib/generators/operation/templates/update.erb

@@ -1,4 +1,8 @@
+<% if @module_name.present? -%>
+module Operations::<%= @module_name %>::<%= @class_name %>
+<% else -%>
 module Operations::<%= @class_name %>
+<% end -%>
   class Update < RailsOps::Operation::Model::Update
     schema3 do
       str! :id

data/rails_ops.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rails_ops 1.1.26 ruby lib
+# stub: rails_ops 1.1.27 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails_ops".freeze
-  s.version = "1.1.26"
+  s.version = "1.1.27"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2022-01-18"
+  s.date = "2022-02-15"
   s.files = [".github/workflows/rubocop.yml".freeze, ".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "Appraisals".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "gemfiles/rails_5.1.gemfile".freeze, "gemfiles/rails_5.2.gemfile".freeze, "gemfiles/rails_6.0.gemfile".freeze, "gemfiles/rails_6.1.gemfile".freeze, "gemfiles/rails_7.0.gemfile".freeze, "lib/generators/operation/USAGE".freeze, "lib/generators/operation/operation_generator.rb".freeze, "lib/generators/operation/templates/controller.erb".freeze, "lib/generators/operation/templates/create.erb".freeze, "lib/generators/operation/templates/destroy.erb".freeze, "lib/generators/operation/templates/load.erb".freeze, "lib/generators/operation/templates/update.erb".freeze, "lib/generators/operation/templates/view.erb".freeze, "lib/rails_ops.rb".freeze, "lib/rails_ops/authorization_backend/abstract.rb".freeze, "lib/rails_ops/authorization_backend/can_can_can.rb".freeze, "lib/rails_ops/configuration.rb".freeze, "lib/rails_ops/context.rb".freeze, "lib/rails_ops/controller_mixin.rb".freeze, "lib/rails_ops/exceptions.rb".freeze, "lib/rails_ops/hooked_job.rb".freeze, "lib/rails_ops/hookup.rb".freeze, "lib/rails_ops/hookup/dsl.rb".freeze, "lib/rails_ops/hookup/dsl_validator.rb".freeze, "lib/rails_ops/hookup/hook.rb".freeze, "lib/rails_ops/log_subscriber.rb".freeze, "lib/rails_ops/mixins.rb".freeze, "lib/rails_ops/mixins/authorization.rb".freeze, "lib/rails_ops/mixins/log_settings.rb".freeze, "lib/rails_ops/mixins/model.rb".freeze, "lib/rails_ops/mixins/model/authorization.rb".freeze, "lib/rails_ops/mixins/model/nesting.rb".freeze, "lib/rails_ops/mixins/param_authorization.rb".freeze, "lib/rails_ops/mixins/policies.rb".freeze, "lib/rails_ops/mixins/require_context.rb".freeze, "lib/rails_ops/mixins/routes.rb".freeze, "lib/rails_ops/mixins/schema_validation.rb".freeze, "lib/rails_ops/mixins/sub_ops.rb".freeze, "lib/rails_ops/model_casting.rb".freeze, "lib/rails_ops/model_mixins.rb".freeze, "lib/rails_ops/model_mixins/ar_extension.rb".freeze, "lib/rails_ops/model_mixins/parent_op.rb".freeze, "lib/rails_ops/model_mixins/sti_fixes.rb".freeze, "lib/rails_ops/model_mixins/virtual_attributes.rb".freeze, "lib/rails_ops/model_mixins/virtual_attributes/virtual_column_wrapper.rb".freeze, "lib/rails_ops/model_mixins/virtual_has_one.rb".freeze, "lib/rails_ops/model_mixins/virtual_model_name.rb".freeze, "lib/rails_ops/operation.rb".freeze, "lib/rails_ops/operation/model.rb".freeze, "lib/rails_ops/operation/model/create.rb".freeze, "lib/rails_ops/operation/model/destroy.rb".freeze, "lib/rails_ops/operation/model/load.rb".freeze, "lib/rails_ops/operation/model/update.rb".freeze, "lib/rails_ops/patches/active_type_patch.rb".freeze, "lib/rails_ops/profiler.rb".freeze, "lib/rails_ops/profiler/node.rb".freeze, "lib/rails_ops/railtie.rb".freeze, "lib/rails_ops/scoped_env.rb".freeze, "lib/rails_ops/virtual_model.rb".freeze, "rails_ops.gemspec".freeze, "test/db/models.rb".freeze, "test/db/schema.rb".freeze, "test/dummy/Rakefile".freeze, "test/dummy/app/assets/config/manifest.js".freeze, "test/dummy/app/assets/images/.keep".freeze, "test/dummy/app/assets/javascripts/application.js".freeze, "test/dummy/app/assets/javascripts/cable.js".freeze, "test/dummy/app/assets/javascripts/channels/.keep".freeze, "test/dummy/app/assets/stylesheets/application.css".freeze, "test/dummy/app/channels/application_cable/channel.rb".freeze, "test/dummy/app/channels/application_cable/connection.rb".freeze, "test/dummy/app/controllers/application_controller.rb".freeze, "test/dummy/app/controllers/concerns/.keep".freeze, "test/dummy/app/helpers/application_helper.rb".freeze, "test/dummy/app/jobs/application_job.rb".freeze, "test/dummy/app/mailers/application_mailer.rb".freeze, "test/dummy/app/models/animal.rb".freeze, "test/dummy/app/models/application_record.rb".freeze, "test/dummy/app/models/bird.rb".freeze, "test/dummy/app/models/cat.rb".freeze, "test/dummy/app/models/concerns/.keep".freeze, "test/dummy/app/models/dog.rb".freeze, "test/dummy/app/models/flower.rb".freeze, "test/dummy/app/models/group.rb".freeze, "test/dummy/app/models/nightingale.rb".freeze, "test/dummy/app/models/phoenix.rb".freeze, "test/dummy/app/models/user.rb".freeze, "test/dummy/app/views/layouts/application.html.erb".freeze, "test/dummy/app/views/layouts/mailer.html.erb".freeze, "test/dummy/app/views/layouts/mailer.text.erb".freeze, "test/dummy/bin/bundle".freeze, "test/dummy/bin/rails".freeze, "test/dummy/bin/rake".freeze, "test/dummy/bin/setup".freeze, "test/dummy/bin/update".freeze, "test/dummy/bin/yarn".freeze, "test/dummy/config.ru".freeze, "test/dummy/config/application.rb".freeze, "test/dummy/config/boot.rb".freeze, "test/dummy/config/cable.yml".freeze, "test/dummy/config/database.yml".freeze, "test/dummy/config/environment.rb".freeze, "test/dummy/config/environments/development.rb".freeze, "test/dummy/config/environments/production.rb".freeze, "test/dummy/config/environments/test.rb".freeze, "test/dummy/config/initializers/application_controller_renderer.rb".freeze, "test/dummy/config/initializers/assets.rb".freeze, "test/dummy/config/initializers/backtrace_silencers.rb".freeze, "test/dummy/config/initializers/cookies_serializer.rb".freeze, "test/dummy/config/initializers/filter_parameter_logging.rb".freeze, "test/dummy/config/initializers/inflections.rb".freeze, "test/dummy/config/initializers/mime_types.rb".freeze, "test/dummy/config/initializers/rails_ops.rb".freeze, "test/dummy/config/initializers/wrap_parameters.rb".freeze, "test/dummy/config/locales/en.yml".freeze, "test/dummy/config/puma.rb".freeze, "test/dummy/config/routes.rb".freeze, "test/dummy/config/secrets.yml".freeze, "test/dummy/config/spring.rb".freeze, "test/dummy/db/schema.rb".freeze, "test/dummy/lib/assets/.keep".freeze, "test/dummy/log/.keep".freeze, "test/dummy/package.json".freeze, "test/dummy/public/404.html".freeze, "test/dummy/public/422.html".freeze, "test/dummy/public/500.html".freeze, "test/dummy/public/apple-touch-icon-precomposed.png".freeze, "test/dummy/public/apple-touch-icon.png".freeze, "test/dummy/public/favicon.ico".freeze, "test/dummy/tmp/.keep".freeze, "test/test_helper.rb".freeze, "test/unit/rails_ops/generators/operation_generator_test.rb".freeze, "test/unit/rails_ops/mixins/model/nesting.rb".freeze, "test/unit/rails_ops/mixins/policies_test.rb".freeze, "test/unit/rails_ops/operation/model/create_test.rb".freeze, "test/unit/rails_ops/operation/model/load_test.rb".freeze, "test/unit/rails_ops/operation/model/sti_test.rb".freeze, "test/unit/rails_ops/operation/model/update_test.rb".freeze, "test/unit/rails_ops/operation/model_test.rb".freeze, "test/unit/rails_ops/operation/update_auth_test.rb".freeze, "test/unit/rails_ops/operation/update_lazy_auth_test.rb".freeze, "test/unit/rails_ops/operation_test.rb".freeze]
   s.rubygems_version = "3.2.15".freeze
   s.summary = "An operations service layer for rails projects.".freeze

data/test/unit/rails_ops/generators/operation_generator_test.rb

@@ -125,6 +125,90 @@ class OperationGeneratorTest < Rails::Generators::TestCase
     assert_routes
   end
 
+  def test_module_name
+    optiongroups = [['User', '--module=Admin'], ['User', '--module=admin']]
+
+    optiongroups.each do |optiongroup|
+      run_generator optiongroup
+
+      # Check that namespaced operations are generated
+      assert_file 'app/operations/admin/user/create.rb' do |operation|
+        assert_match(/module Operations::Admin::User/, operation)
+        assert_match(/class Create < RailsOps::Operation::Model::Create/, operation)
+        assert_match(/model ::User/, operation)
+      end
+      assert_file 'app/operations/admin/user/destroy.rb' do |operation|
+        assert_match(/module Operations::Admin::User/, operation)
+        assert_match(/class Destroy < RailsOps::Operation::Model::Destroy/, operation)
+        assert_match(/model ::User/, operation)
+      end
+      assert_file 'app/operations/admin/user/load.rb' do |operation|
+        assert_match(/module Operations::Admin::User/, operation)
+        assert_match(/class Load < RailsOps::Operation::Model::Load/, operation)
+        assert_match(/model ::User/, operation)
+      end
+      assert_file 'app/operations/admin/user/update.rb' do |operation|
+        assert_match(/module Operations::Admin::User/, operation)
+        assert_match(/class Update < RailsOps::Operation::Model::Update/, operation)
+        assert_match(/model ::User/, operation)
+      end
+
+      # Check that views are generated
+      %w(index show new edit).each do |view|
+        assert_file "app/views/admin/users/#{view}.html.haml"
+      end
+
+      # Check that the controller is generated
+      assert_file 'app/controllers/admin/users_controller.rb' do |controller|
+        assert_match(/module Admin/, controller)
+        assert_match(/class UsersController < ApplicationController/, controller)
+      end
+
+      # Check that the routes entry is added
+      assert_routes
+    end
+  end
+
+  def test_nested_module_name
+    run_generator ['User', '--module=admin/foo']
+
+    # Check that namespaced operations are generated
+    assert_file 'app/operations/admin/foo/user/create.rb' do |operation|
+      assert_match(/module Operations::Admin::Foo::User/, operation)
+      assert_match(/class Create < RailsOps::Operation::Model::Create/, operation)
+      assert_match(/model ::User/, operation)
+    end
+    assert_file 'app/operations/admin/foo/user/destroy.rb' do |operation|
+      assert_match(/module Operations::Admin::Foo::User/, operation)
+      assert_match(/class Destroy < RailsOps::Operation::Model::Destroy/, operation)
+      assert_match(/model ::User/, operation)
+    end
+    assert_file 'app/operations/admin/foo/user/load.rb' do |operation|
+      assert_match(/module Operations::Admin::Foo::User/, operation)
+      assert_match(/class Load < RailsOps::Operation::Model::Load/, operation)
+      assert_match(/model ::User/, operation)
+    end
+    assert_file 'app/operations/admin/foo/user/update.rb' do |operation|
+      assert_match(/module Operations::Admin::Foo::User/, operation)
+      assert_match(/class Update < RailsOps::Operation::Model::Update/, operation)
+      assert_match(/model ::User/, operation)
+    end
+
+    # Check that views are generated
+    %w(index show new edit).each do |view|
+      assert_file "app/views/admin/foo/users/#{view}.html.haml"
+    end
+
+    # Check that the controller is generated
+    assert_file 'app/controllers/admin/foo/users_controller.rb' do |controller|
+      assert_match(/module Admin::Foo/, controller)
+      assert_match(/class UsersController < ApplicationController/, controller)
+    end
+
+    # Check that the routes entry is added
+    assert_routes
+  end
+
   private
 
   def assert_operations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_ops
 version: !ruby/object:Gem::Version
-  version: 1.1.26
+  version: 1.1.27
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal