rails_ops 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf07735e6610693ed0a7595e5b85b2fa5c38f0cb1c470a9b7989a2d7105a4152
-  data.tar.gz: 33b92924b44d06b64309a057fb76fa7bac42c59faad7f67d2de584c819259766
+  metadata.gz: dcb574a4ebd4148a9db8bc6ae9e129b015140175352dccb01b0f9eb6e53a4afd
+  data.tar.gz: 31322cd290160be87eee75fe5ca3604d7611344f4b77faff2681364a34b166f5
 SHA512:
-  metadata.gz: 4ce25936523ca89e92e1aad1fbb0e884bd6bcd230afd1faa8e106a48f0f853d1305b1e6621063bc2b538e0a6e1e4ca1d8c8e395356489d552d764baf29410713
-  data.tar.gz: 970ffa94554885d4bcd9a2351a5b413d245f5f3b1ea7900d0220d1fe7e0d52fa98389025f61a29f7c0b300955741e09d8321502697d4a18235eaf97729952b49
+  metadata.gz: 81e0839e7d210cc6011868a3ea69bf5dd2714aabe96137ee6109468a00ff69400ccfe6fcc5a52a93c772dad15e3638bd0944ffc073f18f010ebd33f648cae1b1
+  data.tar.gz: 1bbc3608339025bd703a5a74a192056f462a5fb756f76531f570cedf754b0d5009d2e69319afc940a1dfc57e38a67fbf1a4fae8f62fb702fc35cb378adcc7825

data/.rubocop.yml

@@ -1,79 +1,151 @@
 AllCops:
   TargetRubyVersion: 2.3
-
+  DisplayCopNames: true
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-    - 'log/**/*'
-    - '*.gemspec'
+    - 'test/dummy/**/*'
     - 'test/tmp/**/*'
+    - 'vendor/**/*'
+    - 'rails_ops.gemspec'
 
-  DisplayCopNames: true
+# Make sure accessors are on separate lines for diff readability.
+Style/AccessorGrouping:
+  EnforcedStyle: separated
 
-Style/SafeNavigation:
+# Cop would break a lot of existing code.
+Style/OptionalBooleanParameter:
   Enabled: false
 
+# Multiline hashes should be aligned cleanly as a table to improve readability.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Template style is easier on the eyes.
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# file. This will be addressed when approaching the first ruby 3 application.
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+# Double negation is very useful to make sure you have a boolean in hand. Use it
+# wisely though and know what you're doing.
 Style/DoubleNegation:
   Enabled: false
 
+# Depending on the case, [].include? can be a lot harder to read and less
+# expressive than multiple comparisons.
+Style/MultipleComparison:
+  Enabled: false
+
+# Over time, the ruby guide changed from raise to fail back to raise. Both fail
+# and raise are programatically exactly the same and our decision fell to "fail"
+# for all kinds of exceptions.
 Style/SignalException:
   EnforcedStyle: only_fail
 
+# Enforced styles can sometimes be hard to read.
 Style/ConditionalAssignment:
   Enabled: false
 
-Style/IndentArray:
+# Enforce consistent array indentation.
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
+# Disable layout cop because methods just consisting of a number of returns
+# would look very odd with an extra empty line between each return.
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/MethodLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/ClassLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/ModuleLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
+Metrics/BlockLength:
+  Enabled: false
+
+# While not always desirable, it can be useful to have a lot of keyword
+# arguments on certain methods. Try to avoid it though.
 Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/AbcSize:
   Enabled: False
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/CyclomaticComplexity:
   Enabled: False
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/PerceivedComplexity:
   Enabled: False
 
-Metrics/LineLength:
+# In certain cases, "excessive" block nesting might just be useful. Try to keep
+# this down as much as possible though.
+Metrics/BlockNesting:
+  Enabled: false
+
+# A line length of 80 is not considered to be temporary anymore. That's why line
+# length is doubled to 160. If absolutely necessary, create a temporary rubocop
+# exclusion for the lines in question.
+Layout/LineLength:
   Max: 160
 
-Metrics/BlockNesting:
+# Disable variable number naming convention.
+Naming/VariableNumber:
   Enabled: false
 
-Metrics/BlockLength:
+# Disable method parameter naming convention.
+Naming/MethodParameterName:
   Enabled: false
 
+# Depending on the surrounding code, even simple if/unless clauses may be more
+# descriptive when on multiple lines.
 Style/IfUnlessModifier:
   Enabled: false
 
+# In most cases, timing does not allow documenting each and every bit of source
+# code. Do not hesitate to enable this cop otherwise.
 Style/Documentation:
   Enabled: false
 
+# Return should be used whenever there is more than one statement or line in a
+# method. This helps avoiding programming mistakes. This is not enforced yet as
+# this would require a custom cop. However, to allow this style of programming,
+# the RedundantReturn cop needs to be disabled.
 Style/RedundantReturn:
   Enabled: false
 
+# Non-ascii comments can be useful sometimes.
 Style/AsciiComments:
   Enabled: false
 
+# Depending on the case, if/unless can be more descriptive than guard clauses.
 Style/GuardClause:
   Enabled: false
 
+# For technical reasons, nested and compact styles must be mixed in certain
+# applications.
 Style/ClassAndModuleChildren:
   Enabled: false
   EnforcedStyle: compact
@@ -81,8 +153,27 @@ Style/ClassAndModuleChildren:
     - nested
     - compact
 
+# Depending on the case, it may be more descriptive to use i.e. == 0 instead of
+# .zero?, especially when testing against multiple numbers.
 Style/NumericPredicate:
   Enabled: false
 
+# Detection is not implemented in a reliable manner for all cases which can lead
+# to false positives and negatives.
 Style/FormatString:
   Enabled: false
+
+# Do not require MFA, as gems checked with sitrox_standards are only pushed to the
+# internal repo
+Gemspec/RequireMFA:
+  Enabled: false
+
+# Use explicit style
+Naming/BlockForwarding:
+  Enabled: true
+  EnforcedStyle: explicit
+
+# Don't require gemspec dependencies to be versioned. While it's generally a good
+# idea to require specifying versions of dependencies, we don't want to enforce it.
+Gemspec/DependencyVersion:
+  Enabled: false

data/Appraisals

@@ -1,19 +1,19 @@
-appraise "rails-7.0" do
-  gem "rails", "~> 7.0.1"
+appraise 'rails-7.0' do
+  gem 'rails', '~> 7.0.1'
 end
 
-appraise "rails-6.1" do
-  gem "rails", "~> 6.1.4"
+appraise 'rails-6.1' do
+  gem 'rails', '~> 6.1.4'
 end
 
-appraise "rails-6.0" do
-  gem "rails", "~> 6.0.4"
+appraise 'rails-6.0' do
+  gem 'rails', '~> 6.0.4'
 end
 
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.6"
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.6'
 end
 
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.7"
-end
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.7'
+end

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.4.3 (2023-03-27)
+
+* Extend the `operation` generator to accept additional flags to skip the
+  generation of certain actions. In particular, the `--skip-index`,
+  `--skip-show`, `--skip-create`, `--skip-update` and `--skip-destroy` flags
+  were added.
+
+  Internal reference: `#111041`.
+
+## 1.4.2 (2023-03-27)
+
+* Update the `operation` generator such that it complies with the naming
+  conventions laid out in [Placing and naming
+  operations](https://github.com/sitrox/rails_ops#placing-and-naming-operations).
+  The path were the operations reside and the validation schema key are now
+  generated in singular.
+
+  Internal reference: `#111055`.
 
 ## 1.4.1 (2023-02-21)
 

data/README.md

@@ -70,11 +70,11 @@ Requirements & Installation
 
    # Define the Operations module
    module Operations; end
-   
+
    # Add the folder to the autoloader, but namespaced
    loader = Rails.autoloaders.main
    loader.push_dir(app_operations, namespace: Operations)
-   
+
    # Add the folder to the watched directories (for re-loading in development)
    Rails.application.config.watchable_dirs.merge!({
      app_operations => [:rb]
@@ -1674,6 +1674,16 @@ flags:
 
 Or if you want to skip them all: `--only-operations`.
 
+If you want to skip a certain action, you can do so using the flags:
+* `--skip-index`
+* `--skip-show`
+* `--skip-create`
+* `--skip-update`
+* `--skip-destroy`
+
+This will skip the creation of the respective route, controller action, view file and the operation itself.
+For `--skip-create`, the `new` action will also be skipped and for `--skip-update`, the `edit` action will be skipped respectively.
+
 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.
 

data/Rakefile

@@ -7,7 +7,7 @@ task default: :test
 task :gemspec do
   gemspec = Gem::Specification.new do |spec|
     spec.name          = 'rails_ops'
-    spec.version       = IO.read('VERSION').chomp
+    spec.version       = File.read('VERSION').chomp
     spec.authors       = ['Sitrox']
     spec.summary       = 'An operations service layer for rails projects.'
     spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -22,7 +22,7 @@ task :gemspec do
     spec.add_development_dependency 'cancancan'
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'colorize'
-    spec.add_development_dependency 'rubocop', '0.47.1'
+    spec.add_development_dependency 'rubocop', '1.45.1'
     spec.add_development_dependency 'sprockets-rails'
     spec.add_dependency 'active_type', '>= 1.3.0'
     spec.add_dependency 'minitest'
@@ -31,11 +31,9 @@ task :gemspec do
     spec.add_dependency 'schemacop', '>= 2.4.2', '<= 3.1'
   end
 
-  File.open('rails_ops.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }
+  File.write('rails_ops.gemspec', gemspec.to_ruby.strip)
 end
 
-require 'rake/testtask'
-
 Rake::TestTask.new do |t|
   t.pattern = 'test/unit/**/*_test.rb'
   t.verbose = false

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.4.3

data/gemfiles/rails_6.0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 6.0.4"
+gem 'rails', '~> 6.0.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_6.1.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 6.1.4"
+gem 'rails', '~> 6.1.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_7.0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 7.0.1"
+gem 'rails', '~> 7.0.1'
 
-gemspec path: "../"
+gemspec path: '../'

data/lib/generators/operation/operation_generator.rb

@@ -1,16 +1,45 @@
 class OperationGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
+  class_option :skip_index, type: :boolean, desc: "Don't create the index route / view / controller action"
+  class_option :skip_show, type: :boolean, desc: "Don't create the show route / view / controller action and the load operation"
+  class_option :skip_create, type: :boolean, desc: "Don't create the new / create route / view / controller action and the create operation"
+  class_option :skip_update, type: :boolean, desc: "Don't create the edit / update route / view / controller action and the update operation"
+  class_option :skip_destroy, type: :boolean, desc: "Don't create the destroy route / view / controller action and the destroy operation"
   class_option :skip_controller, type: :boolean, desc: "Don't add a controller."
   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 excluded_actions
+    @excluded_actions = []
+
+    if options[:skip_index]
+      @excluded_actions += %i[index]
+    end
+
+    if options[:skip_show]
+      @excluded_actions += %i[show]
+    end
+
+    if options[:skip_create]
+      @excluded_actions += %i[new create]
+    end
+
+    if options[:skip_update]
+      @excluded_actions += %i[edit update]
+    end
+
+    if options[:skip_destroy]
+      @excluded_actions += %i[destroy]
+    end
+  end
+
   def add_operations
     @class_name = name.classify
-    @underscored_name = name.underscore
-    @underscored_pluralized_name = name.underscore.pluralize
+    @underscored_name = @class_name.underscore
+    @underscored_pluralized_name = @class_name.underscore.pluralize
 
     operations_path = 'app/operations/'
 
@@ -23,10 +52,18 @@ class OperationGenerator < Rails::Generators::NamedBase
 
     operations_path += @underscored_name.to_s
 
-    template 'load.erb', "#{operations_path}/load.rb"
-    template 'create.erb', "#{operations_path}/create.rb"
-    template 'update.erb', "#{operations_path}/update.rb"
-    template 'destroy.erb', "#{operations_path}/destroy.rb"
+    if !@excluded_actions.include?(:show)
+      template 'load.erb', "#{operations_path}/load.rb"
+    end
+    if !@excluded_actions.include?(:create)
+      template 'create.erb', "#{operations_path}/create.rb"
+    end
+    if !@excluded_actions.include?(:update)
+      template 'update.erb', "#{operations_path}/update.rb"
+    end
+    if !@excluded_actions.include?(:destroy)
+      template 'destroy.erb', "#{operations_path}/destroy.rb"
+    end
   end
 
   def add_controller
@@ -39,7 +76,7 @@ class OperationGenerator < Rails::Generators::NamedBase
     controller_file_path += "#{@underscored_pluralized_name}_controller.rb"
     @controller_name = "#{@class_name.pluralize}Controller"
 
-    template 'controller.erb', controller_file_path
+    template 'controller_wrapper.erb', controller_file_path
   end
 
   def add_views
@@ -51,7 +88,13 @@ class OperationGenerator < Rails::Generators::NamedBase
     end
     views_folder += @underscored_pluralized_name.to_s
 
-    %w(index show new edit).each do |view|
+    actions = %w[index show new edit]
+
+    @excluded_actions.each do |a|
+      actions.delete(a.to_s)
+    end
+
+    actions.each do |view|
       template 'view.erb', "#{views_folder}/#{view}.html.haml"
     end
   end
@@ -59,6 +102,10 @@ class OperationGenerator < Rails::Generators::NamedBase
   def add_routes
     return if options[:skip_routes] || options[:only_operations]
 
-    route "resources :#{@underscored_pluralized_name}"
+    if @excluded_actions.empty?
+      route "resources :#{@underscored_pluralized_name}"
+    else
+      route "resources :#{@underscored_pluralized_name}, except: #{@excluded_actions}"
+    end
   end
 end

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

@@ -1,56 +1,67 @@
-<%
-controller_code = <<-RUBY
-class #{@controller_name} < ApplicationController
+class <%=@controller_name%> < ApplicationController
+<% first=true -%>
+<% if !@excluded_actions&.include?(:index) -%>
+<% first=false -%>
   def index; end
+<% end -%>
+<% if !@excluded_actions&.include?(:show) -%>
+<% if first -%>
+<% first=false -%>
+<% else -%>
 
+<% end -%>
   def show
-    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Load
+    op Operations<%="::#{@module_name}" if @module_name.present?%>::<%=@class_name%>::Load
   end
+<% end -%>
+<% if !@excluded_actions&.include?(:create) -%>
+<% if first -%>
+<% first=false -%>
+<% else -%>
 
+<% end -%>
   def new
-    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Create
+    op Operations<%="::#{@module_name}" if @module_name.present?%>::<%=@class_name%>::Create
   end
 
   def create
-    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Create
+    if run Operations<%="::#{@module_name}" if @module_name.present?%>::<%=@class_name%>::Create
       # handle successful case
     else
       # handle error case
     end
   end
+<% end -%>
+<% if !@excluded_actions&.include?(:update) -%>
+<% if first -%>
+<% first=false -%>
+<% else -%>
 
+<% end -%>
   def edit
-    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Update
+    op Operations<%="::#{@module_name}" if @module_name.present?%>::<%=@class_name%>::Update
   end
 
   def update
-    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Update
+    if run Operations<%="::#{@module_name}" if @module_name.present?%>::<%=@class_name%>::Update
       # handle successful case
     else
       # handle error case
     end
   end
+<% end -%>
+<% if !@excluded_actions&.include?(:destroy) -%>
+<% if first -%>
+<% first=false -%>
+<% else -%>
 
+<% end -%>
   def destroy
-    if run Operations#{ "::#{@module_name}" if @module_name.present? }::#{@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/controller_wrapper.erb

@@ -0,0 +1,14 @@
+<% controller_template = ERB.new(File.read(File.join(File.dirname(__FILE__), '/controller.erb')), trim_mode: '-').result(binding).strip -%>
+<% if @module_name.present? -%>
+module <%= @module_name %>
+<% controller_template.split("\n").each do |line| -%>
+<% if line.blank? -%>
+
+<% else -%>
+  <%= line %>
+<% end -%>
+<% end -%>
+end
+<% else -%>
+<%= controller_template %>
+<% end -%>

data/lib/rails_ops/authorization_backend/abstract.rb

@@ -7,7 +7,7 @@ module RailsOps::AuthorizationBackend
     def exception_class
       @exception_class ||= self.class::EXCEPTION_CLASS.constantize
     rescue NameError
-      fail "Unable to constantize exception class #{self.class::EXCEPTION_CLASS.inspect} "\
+      fail "Unable to constantize exception class #{self.class::EXCEPTION_CLASS.inspect} " \
            "for authorization backend #{self.class.name}. Is the library loaded?"
     end
   end

data/lib/rails_ops/authorization_backend/can_can_can.rb

@@ -5,8 +5,10 @@ module RailsOps::AuthorizationBackend
     EXCEPTION_CLASS = 'CanCan::AccessDenied'.freeze
 
     def initialize
+      super
+
       unless defined?(CanCanCan)
-        fail 'RailsOps is configured to use CanCanCan authorization'\
+        fail 'RailsOps is configured to use CanCanCan authorization' \
              "backend, but the Gem 'cancancan' does not appear to be installed."
       end
     end

data/lib/rails_ops/controller_mixin.rb

@@ -100,7 +100,7 @@ module RailsOps
     end
 
     def model?
-      !!(@model || op? && op.respond_to?(:model) && op.model)
+      !!(@model || (op? && op.respond_to?(:model) && op.model))
     end
 
     # Filters the `params` hash for use with RailsOps. This removes certain

data/lib/rails_ops/hookup/dsl_validator.rb

@@ -1,5 +1,6 @@
 class RailsOps::Hookup::DSLValidator
-  attr_reader :error, :trace
+  attr_reader :error
+  attr_reader :trace
 
   def initialize(hooks)
     @hooks = hooks

data/lib/rails_ops/hookup.rb

@@ -55,7 +55,7 @@ class RailsOps::Hookup
 
     hooks = []
 
-    @hooks.slice('*', operation.class.name).values.each do |hooks_by_event|
+    @hooks.slice('*', operation.class.name).each_value do |hooks_by_event|
       hooks += hooks_by_event.slice('*', event).values.flatten || []
     end
 

data/lib/rails_ops/mixins/authorization.rb

@@ -48,12 +48,12 @@ module RailsOps::Mixins::Authorization
 
   # Determines whether authorize has been called for this operation.
   def authorize_called?
-    @_authorize_called ||= false
+    @authorize_called ||= false
   end
 
   # Manually marks the authorization as called for this operation.
   def authorize_called!
-    @_authorize_called = true
+    @authorize_called = true
   end
 
   # Operations within the given block will have disabled authorization.