rails_ops 1.1.24 → 1.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5db505fe961fecc4e9723b857f989860cf5056d76eb9814a4d4903bb0a6bfe
-  data.tar.gz: 3ab7053bc62a8bfb77b8c81ac90c97467ccdde7778e906097c4328c68c47607c
+  metadata.gz: 47bf9f1036ce2dc4920702cf743def5630af73960f1a750abedc578708454d61
+  data.tar.gz: d0ddd78f73c479e26f6d601d3dfdbeeefc0f667f0b5d094538f2e1faa210275d
 SHA512:
-  metadata.gz: 91c83b59903d7b82539e04c87a4604b6878a8f837a89931f95dcbf542d209e446e3caa849825f5042be68d0c95277f888445438f44ac7e9971f8140d02b4f124
-  data.tar.gz: 80c4f9044744f71f34c07b70c73b584d74fad04d958db6055246d7d13aeb592a1a8bdae58ee258ae1f1513f325b2f9978e1ed50cf14dbe50f560dbc3899c532c
+  metadata.gz: 47bd674965ba4ff732f343391b1ad77d11c8ceed69505d519979a2c9a81d45344a9dd21151b1a749ad24fed922c15d3223eee4418317acee947b5cfcb3dbf8cd
+  data.tar.gz: dea5e80197169cf93b06ea713ca198b97ff711b9171a3869d0da922341d6ebe5286993045009051b03f3eec2e41ed2172bdcc4c9a15943bea93a5bf042fdfbca

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,10 +1,33 @@
 # Changelog
 
-## 1.1.22 (2021-11-25)
+## 1.1.28 (2022-02-16)
+
+* [#22](https://github.com/sitrox/rails_ops/issues/22): Fix error with active_type `>= 2`
+
+## 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.21 (2021-11-01)
+## 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
 ----------------
@@ -1488,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
 -------
 
@@ -1509,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,6 +15,7 @@ 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'
@@ -22,6 +23,7 @@ task :gemspec do
     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.24
+1.1.28

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/mixins/model/authorization.rb

@@ -70,8 +70,6 @@ module RailsOps::Mixins::Model::Authorization
   # Cast {ActiveType::Record} classes or instances to regular AR models in order
   # for cancan(can) to work properly. Classes and instances that are no active
   # type records will be returned as-is.
-  #
-  # TODO: Use ModelCasting module instead?
   def cast_model_for_authorization(model_class_or_instance)
     if model_class_or_instance.is_a?(Class)
       if model_class_or_instance.respond_to?(:extended_record_base_class)
@@ -80,7 +78,7 @@ module RailsOps::Mixins::Model::Authorization
         return model_class_or_instance
       end
     elsif model_class_or_instance.class.respond_to?(:extended_record_base_class)
-      return ActiveType.cast(model_class_or_instance, model_class_or_instance.class.extended_record_base_class)
+      model_class_or_instance.becomes(model_class_or_instance.class.extended_record_base_class)
     else
       model_class_or_instance
     end

data/lib/rails_ops/model_mixins/sti_fixes.rb

@@ -5,15 +5,11 @@ module RailsOps
 
       class_methods do
         def finder_needs_type_condition?
-          superclass.finder_needs_type_condition?
-        end
-
-        def descendants
-          superclass.descendants
+          base_class.finder_needs_type_condition?
         end
 
         def name
-          superclass.name
+          base_class.name
         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

data/lib/rails_ops.rb

@@ -1,3 +1,4 @@
+require 'active_type'
 require 'schemacop'
 require 'request_store'
 
@@ -46,18 +47,6 @@ module RailsOps
   end
 end
 
-# ---------------------------------------------------------------
-# Require Gem active_type and monkey patch
-# ---------------------------------------------------------------
-require 'active_type'
-require 'active_type/type_caster'
-require 'rails_ops/patches/active_type_patch'
-
-# ---------------------------------------------------------------
-# Require Schemacop
-# ---------------------------------------------------------------
-require 'schemacop'
-
 # ---------------------------------------------------------------
 # Require RailsOps
 # ---------------------------------------------------------------
@@ -84,7 +73,6 @@ require 'rails_ops/mixins/require_context.rb'
 require 'rails_ops/mixins/routes.rb'
 require 'rails_ops/mixins/schema_validation.rb'
 require 'rails_ops/mixins/sub_ops.rb'
-require 'rails_ops/model_casting.rb'
 require 'rails_ops/model_mixins.rb'
 require 'rails_ops/model_mixins/ar_extension.rb'
 require 'rails_ops/model_mixins/parent_op.rb'