praxis 2.0.pre.29 → 2.0.pre.30

data/spec/praxis/request_stages/action_spec.rb

@@ -26,7 +26,7 @@ describe Praxis::RequestStages::Action do
 
   context '.execute' do
     before do
-      expect(controller).to receive(action_stage.name) do |args|
+      expect(controller).to receive(action_stage.name) do |**args|
         if args
           expect(args).to eq({})
         else

data/spec/spec_app/app/controllers/authors.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'base_class'
+
+class Authors < BaseClass
+  include Praxis::Controller
+
+  implements ApiResources::Authors
+  include Praxis::Extensions::Rendering
+
+  def model_class
+    ActiveAuthor
+  end
+
+  def base_query
+    # Artificially set a base query that has joins, including a join against the base authors table (to test aliasing)
+    # Note: in order to make sure we know what table name to refer to, we need to add our special reference (based on path)
+    # This way, regardles of filters and/or ordering potentially being applied, we will always point to the correct alias
+    books_ref = Praxis::Extensions::AttributeFiltering::ActiveRecordFilterQueryBuilder.build_reference_value('/books', query: model_class)
+    inner_authors_ref = Praxis::Extensions::AttributeFiltering::ActiveRecordFilterQueryBuilder.build_reference_value('/books/author', query: model_class)
+    model_class.distinct.joins(books: :author)
+               .references(books_ref).where('"/books".simple_name LIKE ?', 'book%')
+               .references(inner_authors_ref).where("#{inner_authors_ref}.id > ?", 0)
+  end
+
+  def index
+    objs = build_query(base_query).all
+    display(objs)
+  end
+
+  def show(id:, **_args)
+    model = build_query(base_query.where(id: id)).first
+    return Praxis::Mapper::ResourceNotFound.new(id: id, type: model_class) if model.nil?
+
+    display(model)
+  end
+end

data/spec/spec_app/app/controllers/books.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Books < BaseClass
+  include Praxis::Controller
+
+  implements ApiResources::Books
+  include Praxis::Extensions::Rendering
+
+  def model_class
+    ActiveBook
+  end
+
+  def base_query
+    # Make sure we add the distinct clause, that's what we always want for index requests
+    # as we can have multiple copies of the same top level model if there were joins due
+    # to manual conditions added, or simply conditions added when filters are used on related tables
+    model_class.distinct
+  end
+
+  def index
+    objs = build_query(base_query).all
+    display(objs)
+  end
+
+  def show(id:, **_args)
+    model = build_query(base_query.where(id: id)).first
+    return Praxis::Mapper::ResourceNotFound.new(id: id, type: model_class) if model.nil?
+
+    display(model)
+  end
+end

data/spec/spec_app/app/resources/author.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Resources
+  class Author < Resources::Base
+    model ::ActiveAuthor
+
+    filters_mapping(
+      'books.name': 'books.name'
+    )
+    order_mapping(
+      'display_name': 'name'
+    )
+    property :display_name, dependencies: [:name]
+
+    def display_name
+      record.name
+    end
+  end
+end

data/spec/spec_app/app/resources/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Resources
+  class Base < Praxis::Mapper::Resource
+    include Praxis::Mapper::Resources::QueryMethods # So we can directly get wrapped models with get, all, first, last...
+
+    def self.inherited(klass)
+      klass.include Praxis::Mapper::Resources::Callbacks # So we can use callbacks (after/before/around) within resource code
+      # Add the code that allows to define typed method signatures (to be validated and coerced) to the concrete class
+      klass.include Praxis::Mapper::Resources::TypedMethods
+      super
+    end
+  end
+end

data/spec/spec_app/app/resources/book.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Resources
+  class Book < Resources::Base
+    model ::ActiveBook
+
+    filters_mapping(
+      name: :simple_name
+    )
+
+    order_mapping(
+      name: 'simple_name',
+      writer: 'author'
+    )
+
+    # Make name go through another nested property, before getting to simple_name
+    property :name, dependencies: [:nested_name]
+    def name
+      nested_name
+    end
+
+    property :nested_name, dependencies: [:simple_name]
+    def nested_name
+      record.simple_name
+    end
+
+    property_group :grouped, ::Book
+
+    property :grouped_id, dependencies: [:id]
+    def grouped_id
+      id
+    end
+
+    property :grouped_name, dependencies: [:name]
+    def grouped_name
+      name
+    end
+
+    property :grouped_moar_tags, as: :tags
+  end
+end

data/spec/spec_app/app/resources/tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Resources
+  class Tag < Resources::Base
+    model ::ActiveTag
+  end
+end

data/spec/spec_app/app/resources/tagging.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Resources
+  class Tagging < Resources::Base
+    model ::ActiveTagging
+  end
+end

data/spec/spec_app/config/environment.rb

@@ -33,7 +33,18 @@ Praxis::Application.configure do |application|
 
   application.bootloader.use SimpleAuthenticationPlugin, config_file: 'config/authentication.yml'
   application.bootloader.use AuthorizationPlugin
-
+  application.bootloader.use Praxis::Plugins::MapperPlugin
+  application.bootloader.use Praxis::Plugins::PaginationPlugin,
+                             **{
+                               # max_items: 500,  # Unlimited by default,
+                               # default_page_size: 100,
+                               # paging_default_mode: {by: :id},
+                               # disallow_paging_by_default: false,
+                               # disallow_cursor_by_default: false,
+                               # sorting: {
+                               #   enforce_all_fields: true
+                               # }
+                             }
   # enable "development-mode" options
   application.config.praxis.validate_responses = true
   application.config.praxis.validate_response_bodies = true
@@ -44,6 +55,9 @@ Praxis::Application.configure do |application|
     LowBudgetMutex.instance.after_app_controllers_called
   end
   application.bootloader.after :app do
+    # application.config.mapper.debug_queries = true # Enable this to see debug info about the query builder and plan
+
+    Praxis::Mapper::Resource.finalize!
     raise 'After sub-stage hooks not working!' unless LowBudgetMutex.instance.after_app_controllers == :worked
   end
 
@@ -58,6 +72,7 @@ Praxis::Application.configure do |application|
       map :app, 'app/' do
         map :models, 'models/**/*'
         map :concerns, '**/concerns/**/*'
+        map :resources, '**/resources/**/*'
         map :controllers, '**/controllers/**/*'
         map :responses, '**/responses/**/*'
       end

data/spec/spec_app/design/media_types/author.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Author < Praxis::MediaType
+  identifier 'application/vnd.acme.author'
+
+  domain_model 'Resources::Author'
+  attributes do
+    attribute :id, Integer
+    attribute :name, String
+    attribute :display_name, String
+    attribute :books, Praxis::Collection.of(Book)
+  end
+end

data/spec/spec_app/design/media_types/book.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Book < Praxis::MediaType
+  identifier 'application/vnd.acme.book'
+
+  domain_model 'Resources::Book'
+
+  attributes do
+    attribute :id, Integer
+    attribute :name, String
+    attribute :simple_name, String
+    attribute :category_uuid, String
+    attribute :author, Author
+    attribute :tags, Praxis::Collection.of(Tag)
+
+    group :grouped do
+      attribute :id
+      attribute :name
+      attribute :moar_tags, Praxis::Collection.of(Tag)
+    end
+  end
+end

data/spec/spec_app/design/media_types/tag.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Tag < Praxis::MediaType
+  identifier 'application/vnd.acme.tag'
+
+  domain_model 'Resources::Tag'
+  attributes do
+    attribute :name, String
+    attribute :taggings, Praxis::Collection.of(Tagging)
+  end
+end

data/spec/spec_app/design/media_types/tagging.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Tagging < Praxis::MediaType
+  identifier 'application/vnd.acme.tagging'
+
+  domain_model 'Resources::Tagging'
+  attributes do
+    attribute :tag, Tag
+  end
+end

data/spec/spec_app/design/resources/authors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ApiResources
+  class Authors
+    include Praxis::EndpointDefinition
+
+    media_type Author
+    version '1.0'
+
+    action :index do
+      routing { get '' }
+      params do
+        attribute :fields, Praxis::Types::FieldSelector.for(Author), description: 'Fields with which to render the result.'
+        attribute :filters, Praxis::Types::FilteringParams.for(Author) do
+          filter 'books.name', using: %w[= != !], fuzzy: true
+          filter 'id', using: %w[= !=]
+        end
+        attribute :order, Praxis::Extensions::Pagination::OrderingParams.for(Author) do
+          by_fields :id, :name, 'books.name'
+        end
+      end
+      response :ok, media_type: Praxis::Collection.of(Author)
+    end
+
+    action :show do
+      routing { get '/:id' }
+
+      params do
+        attribute :id, description: 'ID to find'
+        attribute :fields, Praxis::Types::FieldSelector.for(Author), description: 'Fields with which to render the result.'
+      end
+      response :ok
+    end
+  end
+end

data/spec/spec_app/design/resources/books.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ApiResources
+  class Books
+    include Praxis::EndpointDefinition
+
+    media_type Book
+    version '1.0'
+
+    action :index do
+      routing { get '' }
+      params do
+        attribute :fields, Praxis::Types::FieldSelector.for(Book), description: 'Fields with which to render the result.'
+        attribute :filters, Praxis::Types::FilteringParams.for(Book) do
+          filter 'author.name', using: %w[= != !], fuzzy: true
+          filter 'author', using: %w[! !!]
+          filter 'tags.name', using: %w[= !=]
+          filter 'author.id', using: %w[= !=]
+          filter 'id', using: %w[= !=]
+          filter 'tags.taggings.tag.name', using: %w[= !=]
+        end
+        attribute :order, Praxis::Extensions::Pagination::OrderingParams.for(Book) do
+          by_fields :id, 'author.name'
+        end
+      end
+      response :ok, media_type: Praxis::Collection.of(Book)
+    end
+
+    action :show do
+      routing { get '/:id' }
+
+      params do
+        attribute :id, description: 'ID to find'
+        attribute :fields, Praxis::Types::FieldSelector.for(Book), description: 'Fields with which to render the result.'
+      end
+      response :ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -48,7 +48,6 @@ RSpec.configure do |config|
   config.include Rack::Test::Methods
 
   config.before(:suite) do
-    Praxis::Mapper::Resource.finalize!
     Praxis::Blueprint.caching_enabled = true
     Praxis::Application.instance.setup(root: 'spec/spec_app')
   end

data/spec/support/spec_resources.rb

@@ -103,6 +103,7 @@ class ParentResource < BaseResource
   model ParentModel
 
   property :display_name, dependencies: %i[simple_name id other_attribute]
+  property :aliased_simple_children, as: :simple_children
 
   def display_name
     "#{id}-#{name}"
@@ -137,12 +138,14 @@ class SimpleResource < BaseResource
     end
   end
 
+  property :multi_column, dependencies: %i[column1 simple_name]
   property :aliased_method, dependencies: %i[column1 other_model]
   property :other_resource, dependencies: [:other_model]
-
   property :parent, dependencies: %i[parent added_column]
 
-  property :name, dependencies: [:simple_name]
+  property :name, dependencies: [:nested_name]
+  property :nested_name, dependencies: [:simple_name]
+
   property :direct_other_name, dependencies: ['other_model.name']
   property :aliased_other_name, dependencies: ['other_model.display_name']
 
@@ -150,13 +153,23 @@ class SimpleResource < BaseResource
   property :everything_from_parent, dependencies: ['parent.*']
   property :circular_dep, dependencies: %i[circular_dep column1]
   property :no_deps, dependencies: []
-
   property :deep_nested_deps, dependencies: ['parent.simple_children.other_model.parent.display_name']
-  property :aliased_association, as: :other_model, dependencies: [:name]
-  property :overriden_aliased_association, as: :other_model, dependencies: [:name]
-  property :deep_aliased_association, as: 'parent.simple_children' , dependencies: [:name]
 
-  property :sub_struct, as: :self, dependencies: [:alway_necessary_attribute]
+  property :aliased_association, as: :other_model
+  property :deep_aliased_association, as: 'parent.simple_children'
+  property :overriden_aliased_association, as: :other_model
+  property :aliased_parent, as: :parent
+  property :deep_overriden_aliased_association, as: 'parent.simple_children' # TODO!!! if I change it to 'aliased_parent.aliased_simple_children' things come empty!!!
+  property :sub_struct, as: :self
+
+  property :true_struct, dependencies: %i[name sub_id]
+  # property :true_struct, dependencies: [:sub_id]
+  property :sub_id, dependencies: [:inner_sub_id]
+  property :inner_sub_id, dependencies: [:id]
+
+  property :agroup, dependencies: %i[agroup_id agroup_name]
+  property :agroup_id, dependencies: [:id]
+  property :agroup_name, dependencies: [:name]
 
   before(:update!, :do_before_update)
   around(:update!, :do_around_update_nested)

data/spec/{praxis/extensions/support → support}/spec_resources_active_model.rb

@@ -87,6 +87,9 @@ end
 class ActiveAuthorResource < ActiveBaseResource
   model ActiveAuthor
 
+  order_mapping(
+    'display_name': 'name'
+  )
   property :display_name, dependencies: [:name]
 end
 
@@ -109,11 +112,22 @@ class ActiveBookResource < ActiveBaseResource
                    end,
     'category.books.name': 'category.books.simple_name'
   )
+
+  order_mapping(
+    'name': 'simple_name',
+    'writer': 'author'
+  )
   # Forces to add an extra column (added_column)...and yet another (author_id) that will serve
   # to check that if that's already automatically added due to an association, it won't interfere or duplicate
   property :author, dependencies: %i[author added_column author_id]
 
   property :name, dependencies: [:simple_name]
+  property :writer, dependencies: %i[author]
+
+  # Silly alias to test dependencies and order aliasing
+  def writer
+    author
+  end
 end
 
 def seed_data

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.29
+  version: 2.0.pre.30
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -376,6 +376,7 @@ files:
 - MAINTAINERS.md
 - README.md
 - Rakefile
+- SELECTOR_NOTES.txt
 - bin/praxis
 - lib/praxis.rb
 - lib/praxis/action_definition.rb
@@ -384,6 +385,7 @@ files:
 - lib/praxis/api_general_info.rb
 - lib/praxis/application.rb
 - lib/praxis/blueprint.rb
+- lib/praxis/blueprint_attribute_group.rb
 - lib/praxis/bootloader.rb
 - lib/praxis/bootloader_stages/environment.rb
 - lib/praxis/bootloader_stages/file_loader.rb
@@ -512,7 +514,8 @@ files:
 - lib/praxis/validation_handler.rb
 - lib/praxis/version.rb
 - praxis.gemspec
-- spec/functional_spec.rb
+- spec/functional_cloud_spec.rb
+- spec/functional_library_spec.rb
 - spec/praxis/action_definition_spec.rb
 - spec/praxis/api_definition_spec.rb
 - spec/praxis/api_general_info_spec.rb
@@ -534,9 +537,8 @@ files:
 - spec/praxis/extensions/field_selection/field_selector_spec.rb
 - spec/praxis/extensions/field_selection/sequel_query_selector_spec.rb
 - spec/praxis/extensions/pagination/active_record_pagination_handler_spec.rb
+- spec/praxis/extensions/pagination/ordering_params_spec.rb
 - spec/praxis/extensions/rendering_spec.rb
-- spec/praxis/extensions/support/spec_resources_active_model.rb
-- spec/praxis/extensions/support/spec_resources_sequel.rb
 - spec/praxis/field_expander_spec.rb
 - spec/praxis/file_group_spec.rb
 - spec/praxis/handlers/json_spec.rb
@@ -571,9 +573,16 @@ files:
 - spec/spec_app/app/concerns/authenticated.rb
 - spec/spec_app/app/concerns/basic_api.rb
 - spec/spec_app/app/concerns/log_wrapper.rb
+- spec/spec_app/app/controllers/authors.rb
 - spec/spec_app/app/controllers/base_class.rb
+- spec/spec_app/app/controllers/books.rb
 - spec/spec_app/app/controllers/instances.rb
 - spec/spec_app/app/controllers/volumes.rb
+- spec/spec_app/app/resources/author.rb
+- spec/spec_app/app/resources/base.rb
+- spec/spec_app/app/resources/book.rb
+- spec/spec_app/app/resources/tag.rb
+- spec/spec_app/app/resources/tagging.rb
 - spec/spec_app/app/responses/multipart.rb
 - spec/spec_app/app/responses/other_response.rb
 - spec/spec_app/config.ru
@@ -587,9 +596,15 @@ files:
 - spec/spec_app/config/stats.yml
 - spec/spec_app/config/stats.yml.dis
 - spec/spec_app/design/api.rb
+- spec/spec_app/design/media_types/author.rb
+- spec/spec_app/design/media_types/book.rb
 - spec/spec_app/design/media_types/instance.rb
+- spec/spec_app/design/media_types/tag.rb
+- spec/spec_app/design/media_types/tagging.rb
 - spec/spec_app/design/media_types/volume.rb
 - spec/spec_app/design/media_types/volume_snapshot.rb
+- spec/spec_app/design/resources/authors.rb
+- spec/spec_app/design/resources/books.rb
 - spec/spec_app/design/resources/instances.rb
 - spec/spec_app/design/resources/volume_snapshots.rb
 - spec/spec_app/design/resources/volumes.rb
@@ -601,6 +616,8 @@ files:
 - spec/support/spec_endpoint_definitions.rb
 - spec/support/spec_media_types.rb
 - spec/support/spec_resources.rb
+- spec/support/spec_resources_active_model.rb
+- spec/support/spec_resources_sequel.rb
 - spec/support/spec_simple_authentication_plugin.rb
 - tasks/loader.thor
 - tasks/thor/app.rb
@@ -669,14 +686,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Building APIs the way you want it.