rails_ops 1.1.23 → 1.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed23b56e03ae2bce9a83de4a57962debc4581f27438f1ccdc4de794621fd534b
-  data.tar.gz: a354184cdedfe424dd87149ceab88841f003576064475b4eb345bcd97d721c34
+  metadata.gz: 3bcce101893137c4a67443fb2f0c056695a9f31d9eddd4d8db480e2e27abb004
+  data.tar.gz: 360264275974a50bf59bde14c29ea5a10192d35bc7c983829a190b56aa4bc853
 SHA512:
-  metadata.gz: cee0572909ad80b1ee998dc7a29119435f34c585d4c46082f3d20ecf36a8fc7907166f4158c8bcb37e98438ba06869358820a666bc2195d43d72c156b5d18789
-  data.tar.gz: 4b7f33b883ac61c4e68dbd7a3d97bd45aaa10665052a26f2feadf7a4a22a312405a038595a84558d0b1d05546c1352dea3606f3adedefedd05bd6d296d101f22
+  metadata.gz: a3334b17bf543eb8168f13388a822e3572c9a6bb4522cc8db8d27755ffda18cccaba4a7283efc21e8d4da3bd5c5e2ab64d7eef2c5ad7478aef57b432dd23f06d
+  data.tar.gz: 87e7d4cc99de70f5287f1c639b9607dfac59a8fcf492225fbc3956f49f2f7f372724eb153dd9016cc2927d9e5116a0522531e681fcd577314118ecda484f7393

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: Rubocop check
+on: push
+
+jobs:
+  verify:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop

data/.github/workflows/ruby.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Unit tests
 
 on:
   push:
@@ -12,16 +12,46 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.3.0', '2.5.1', '2.6.2', '2.7.1', '3.0.1']
-
+        include:
+          - rails-version: '5.1'
+            ruby-version: '2.3.0'
+          - rails-version: '5.1'
+            ruby-version: '2.5.1'
+          - rails-version: '5.2'
+            ruby-version: '2.3.0'
+          - rails-version: '5.2'
+            ruby-version: '2.5.1'
+          - rails-version: '5.2'
+            ruby-version: '2.6.2'
+          - rails-version: '6.0'
+            ruby-version: '2.5.1'
+          - rails-version: '6.0'
+            ruby-version: '2.6.2'
+          - rails-version: '6.0'
+            ruby-version: '2.7.1'
+          - rails-version: '6.1'
+            ruby-version: '2.5.1'
+          - rails-version: '6.1'
+            ruby-version: '2.6.2'
+          - rails-version: '6.1'
+            ruby-version: '2.7.1'
+          - rails-version: '6.1'
+            ruby-version: '3.0.1'
+          - rails-version: '7.0'
+            ruby-version: '2.7.1'
+          - rails-version: '7.0'
+            ruby-version: '3.0.1'
+          - rails-version: '7.0'
+            ruby-version: '3.1.0'
+    name: Test against Ruby ${{ matrix.ruby-version }} / Rails ${{ matrix.rails-version }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails-version }}.gemfile
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
+    - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
     - name: Run rake tests
-      run: bundle exec rake test
-    - name: Run rubocop
-      run: bundle exec rubocop
+      run: bundle exec rake

data/.gitignore

@@ -12,3 +12,5 @@
 /vendor/bundle
 /test/dummy/tmp/
 /test/dummy/log/
+/test/tmp/
+/gemfiles/*.lock

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
     - 'tmp/**/*'
     - 'log/**/*'
     - '*.gemspec'
+    - 'test/tmp/**/*'
 
   DisplayCopNames: true
 

data/Appraisals

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

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Changelog
 
-## 1.1.21 (2021-11-01)
+## 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
+
+* Add compatibility for Rails 7 and Ruby 3.1.0
+
+## 1.1.25 (2022-01-17)
+
+* #24: Add generator `operation` that generates a controller, operations and empty
+  view files
+
+## 1.1.24 (2021-11-24)
+
+* Add support for STI in model operations
+
+## 1.1.23 (2021-11-01)
+
+* No changes to previous release
+
+## 1.1.22 (2021-11-01)
 
 * Add support for lazy model authorization
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2017-2021 Sitrox
+Copyright © 2017-2022 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,5 @@
-[![Build](https://github.com/sitrox/rails_ops/actions/workflows/ruby.yml/badge.svg)](https://github.com/sitrox/rails_ops/actions/workflows/ruby.yml)
+[![Unit tests](https://github.com/sitrox/rails_ops/actions/workflows/ruby.yml/badge.svg)](https://github.com/sitrox/rails_ops/actions/workflows/ruby.yml)
+[![Rubocop check](https://github.com/sitrox/rails_ops/actions/workflows/rubocop.yml/badge.svg)](https://github.com/sitrox/rails_ops/actions/workflows/rubocop.yml)
 [![Gem Version](https://badge.fury.io/rb/rails_ops.svg)](https://badge.fury.io/rb/rails_ops)
 
 rails_ops
@@ -22,9 +23,21 @@ Requirements & Installation
 
 ### Requirements
 
-- RailsOps only works with Rails applications and has been tested with Rails >=
-  3.2.0.
-- Prior Rails versions may be supported but this has not been verified.
+- RailsOps only works with Rails applications, with the following Rails versions being tested in the CI:
+  * Rails 5.1.x
+  * Rails 5.2.x
+  * Rails 6.0.x
+  * Rails 6.1.x
+  * Rails 7.0.x
+- Additionally, the following Ruby versions are covered by our unit tests:
+  * 2.3.0
+  * 2.5.1
+  * 2.6.2
+  * 2.7.1
+  * 3.0.1
+  * 3.1.0
+- Please see the [unit test workflow](https://github.com/sitrox/rails_ops/actions/workflows/ruby.yml) for the combinations of the Rails & Ruby versions, as only compatible versions are tested with each other.
+- Prior Rails and Ruby versions may be supported but they are not tested in the CI.
 - Rails Ops' model operations require ActiveRecord but are database / adapter
   agnostic
 
@@ -54,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
 ----------------
@@ -1194,8 +1208,8 @@ sensible default. See the respective class' source code for details.
 In case of operations inheriting from `RailsOps::Operation::Model::Update`, you
 can specify the `model_authorization_action` to be `lazy`, meaning that it will
 only be checked when *performing* the operation, but not on initialization. This
-can be useful for displaying readonly forms to users which do not have
-read-permissions only:
+can be useful for displaying readonly forms to users which have read-permissions
+only:
 
 ```ruby
 class Operations::User::Update < RailsOps::Operation::Model::Update
@@ -1204,7 +1218,7 @@ class Operations::User::Update < RailsOps::Operation::Model::Update
   # This automatically calls `authorize_model! :read`. Because it is set to be
   # `lazy`, the authorization will only run when the operation is actually
   # *performed*, and not already at instantiation.
-  model_authorization_action :read, lazy: true
+  model_authorization_action :update, lazy: true
 end
 ```
 
@@ -1270,6 +1284,34 @@ This block receives the params hash as it would be passed to the sub operation
 and allows to modify it. The block's return value is then passed to the
 sub-operation. Do not change the params inplace but instead return a new hash.
 
+### Single-table inheritance
+
+Model operations also support STI models (Single Table Inheritance). However,
+there is the caviat that if you do extend your model in the operation (e.g.
+`model Animal do { ... }`), RailsOps automatically creates an anonymous subclass
+of the given class (e.g. `Animal`). Operations will always load / create models
+that are instances of this anonymous class.
+
+Consider the following operation:
+
+```ruby
+class Animal < ApplicationRecord; end
+class Bird < Animal; end
+class Mouse < Animal; end
+
+class LoadAnimal < RailsOps::Operation::Model::Load
+  model Animal do
+    # Something
+  end
+end
+
+bird = Bird.create
+op_bird = LoadAnimal.new(id: bird.id)
+
+bird.class    # => Class "Bird", extending "Animal"
+op_bird.class # => Anonymous class, extending "Animal", not "Bird"
+```
+
 Record extension and virtual records
 ------------------------------------
 
@@ -1460,6 +1502,85 @@ sub-operations, see section *Calling sub-operations* for more information.
 Operation Inheritance
 ---------------------
 
+Generators
+----------
+
+RailsOps features a generator to easily create a structure for common CRUD-style
+constructs. The generator creates the CRUD operations, some empty view files, a
+controller and adds an entry in the routing file.
+
+This is e.g. useful when adding a new model to an application, as the basic structure
+is usually rather similar.
+
+### Usage
+
+Run the generator using the `operation` generator, specifying the name of the
+operation class:
+
+```ruby
+rails g operation User
+```
+
+This will generate the following operations:
+
+* `app/operations/user/load.rb`
+* `app/operations/user/create.rb`
+* `app/operations/user/update.rb`
+* `app/operations/user/destroy.rb`
+
+as well as the controller `app/controllers/users_controller.rb` and the following
+empty view files:
+
+* `app/views/users/index.html.haml`
+* `app/views/users/show.html.haml`
+* `app/views/users/new.html.haml`
+* `app/views/users/edit.html.haml`
+
+It will also add the entry `resources :users` to the `config/routes.rb` file.
+
+If you want to skip the controller, the views or the routes, you can do so using the
+flags:
+
+* `--skip-controller`
+* `--skip-routes`
+* `--skip-views`
+
+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.
+
 Caveats
 -------
 
@@ -1481,4 +1602,4 @@ Rails architecture.
 
 ## Copyright
 
-Copyright © 2017 - 2021 Sitrox. See `LICENSE` for further details.
+Copyright © 2017 - 2022 Sitrox. See `LICENSE` for further details.

data/Rakefile

@@ -15,11 +15,15 @@ task :gemspec do
     spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
     spec.require_paths = ['lib']
 
+    spec.add_development_dependency 'appraisal'
     spec.add_development_dependency 'bundler'
     spec.add_development_dependency 'rake'
     spec.add_development_dependency 'sqlite3'
     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 'sprockets-rails'
     spec.add_dependency 'active_type', '>= 1.3.0'
     spec.add_dependency 'minitest'
     spec.add_dependency 'rails'

data/VERSION

@@ -1 +1 @@
-1.1.23
+1.1.27

data/gemfiles/rails_5.1.gemfile

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

data/gemfiles/rails_5.2.gemfile

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

data/gemfiles/rails_6.0.gemfile

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

data/gemfiles/rails_6.1.gemfile

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

data/gemfiles/rails_7.0.gemfile

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

data/lib/generators/operation/USAGE

@@ -0,0 +1,21 @@
+Description:
+    Generates CRUD operations, along with a controller, views and an entry in the route file
+
+Example:
+    bin/rails generate operation User
+
+    This will create:
+        app/operations/user/load.rb
+        app/operations/user/create.rb
+        app/operations/user/update.rb
+        app/operations/user/destroy.rb
+
+        app/controllers/users_controller.rb
+
+        app/views/users/index.html.haml
+        app/views/users/show.html.haml
+        app/views/users/new.html.haml
+        app/views/users/edit.html.haml
+
+    And add a routing entry:
+        resources :users

data/lib/generators/operation/operation_generator.rb

@@ -0,0 +1,64 @@
+class OperationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  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 add_operations
+    @class_name = name.classify
+    @underscored_name = name.underscore
+    @underscored_pluralized_name = name.underscore.pluralize
+
+    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"
+    template 'update.erb', "#{operations_path}/update.rb"
+    template 'destroy.erb', "#{operations_path}/destroy.rb"
+  end
+
+  def add_controller
+    return if options[:skip_controller] || options[:only_operations]
+
+    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
+  end
+
+  def add_views
+    return if options[:skip_views] || options[:only_operations]
+
+    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"
+    end
+  end
+
+  def add_routes
+    return if options[:skip_routes] || options[:only_operations]
+
+    route "resources :#{@underscored_pluralized_name}"
+  end
+end

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

@@ -0,0 +1,56 @@
+<%
+controller_code = <<-RUBY
+class #{@controller_name} < ApplicationController
+  def index; end
+
+  def show
+    op Operations#{ "::#{@module_name}" if @module_name.present? }::#{@class_name}::Load
+  end
+
+  def new
+    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
+      # handle successful case
+    else
+      # handle error case
+    end
+  end
+
+  def edit
+    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
+      # handle successful case
+    else
+      # handle error case
+    end
+  end
+
+  def 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

@@ -0,0 +1,15 @@
+<% 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
+
+      end
+    end
+
+    model ::<%= @class_name %>
+  end
+end

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

@@ -0,0 +1,13 @@
+<% 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
+    end
+
+    model ::<%= @class_name %>
+  end
+end

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

@@ -0,0 +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

@@ -0,0 +1,16 @@
+<% 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
+      hsh? :<%= @underscored_name %> do
+
+      end
+    end
+
+    model ::<%= @class_name %>
+  end
+end

data/lib/rails_ops/model_mixins/sti_fixes.rb

@@ -0,0 +1,17 @@
+module RailsOps
+  module ModelMixins
+    module StiFixes
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def finder_needs_type_condition?
+          base_class.finder_needs_type_condition?
+        end
+
+        def name
+          base_class.name
+        end
+      end
+    end
+  end
+end

data/lib/rails_ops/model_mixins/virtual_attributes/virtual_column_wrapper.rb

@@ -6,4 +6,8 @@ class RailsOps::ModelMixins::VirtualAttributes::VirtualColumnWrapper
   def type
     @virtual_column.instance_variable_get(:@type_caster).instance_variable_get(:@type)
   end
+
+  def default_function
+    nil
+  end
 end