praxis 2.0.pre.31 → 2.0.pre.33

data/spec/praxis/extensions/pagination/active_record_pagination_handler_spec.rb

@@ -154,6 +154,34 @@ describe Praxis::Extensions::Pagination::ActiveRecordPaginationHandler do
         end
       end
     end
+    context 'adds SELECT fields when necessary' do
+      let(:order_params) { book_ordering_params_attribute.load(op) }
+      context 'when query comes with SELECT *' do
+        let(:query) { ActiveBook.includes(:author) }
+        let(:op) { '-writer.books.name' }
+        it 'does not add any specific SELECT' do
+          expect(subject.all.select_values).to be_empty
+        end
+      end
+      context 'when query comes with some SELECT fields' do
+        let(:query) { ActiveBook.includes(:author).select('simple_name') }
+        context 'with one ordering field' do
+          let(:op) { '-writer.books.name' }
+          it 'adds the field to SELECT (and keeps the original one)' do
+            expect(subject.all.select_values).to include('"/author/books"."simple_name"')
+            expect(subject.all.select_values).to include('simple_name')
+          end
+        end
+        context 'with multiple ordering fields' do
+          let(:op) { '-writer.books.name,author.id' }
+          it 'adds both fields to SELECT (and keeps the original one)' do
+            expect(subject.all.select_values).to include('"/author/books"."simple_name"')
+            expect(subject.all.select_values).to include('"/author"."id"')
+            expect(subject.all.select_values).to include('simple_name')
+          end
+        end
+      end
+    end
   end
 
   context '.association_info_for' do

data/spec/praxis/request_spec.rb

@@ -146,6 +146,16 @@ describe Praxis::Request do
     end
   end
 
+  context '#inspect' do
+    it 'includes action and params' do
+      request.action = 'eioio'
+      request.params = 'zzyzx'
+      expect(request.inspect).to match(
+        /#<Praxis::Request#[0-9]+ @action="eioio" @params="zzyzx">/
+      )
+    end
+  end
+
   context '#load_headers' do
     it 'is done preserving the original case' do
       request.load_headers(context[:headers])

data/spec/support/spec_blueprints.rb

@@ -5,10 +5,12 @@ class PersonBlueprint < Praxis::Blueprint
     attribute :name, String, example: /[:first_name:]/
     attribute :email, String, example: proc { |person| "#{person.name}@example.com" }
 
-    attribute :age, Integer
+    attribute :age, Integer, min: 0
+    # Weird, anonymous attribute built for specs only
+    attribute :funny_attribute, Struct, allow_extra: true
 
     attribute :full_name, FullName
-    attribute :aliases, Attributor::Collection.of(FullName)
+    attribute :aliases, FullName[]
 
     attribute :address, AddressBlueprint, null: true, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
     attribute :work_address, AddressBlueprint, null: true
@@ -19,7 +21,7 @@ class PersonBlueprint < Praxis::Blueprint
       attribute :mother, String
     end
 
-    attribute :tags, Attributor::Collection.of(String)
+    attribute :tags, Attributor::String[]
     attribute :href, String
     attribute :alive, Attributor::Boolean, default: true
     attribute :myself, PersonBlueprint, null: true
@@ -44,7 +46,7 @@ class AddressBlueprint < Praxis::Blueprint
   attributes do
     attribute :id, Integer
     attribute :name, String
-    attribute :street, String
+    attribute :street, String, description: 'The street'
     attribute :state, String, values: %w[OR CA]
 
     attribute :resident, PersonBlueprint, example: proc { |address, context| PersonBlueprint.example(context, address: address) }

data/tasks/thor/model.rb

@@ -13,6 +13,8 @@ module PraxisGen
     argument :model_name, required: true
     option :orm, required: false, default: 'activerecord', enum: %w[activerecord sequel]
     def g
+      models_dir = 'app/models'
+      models_dir = PraxisGenerator.scaffold_config[:models_dir] if PraxisGenerator.scaffold_config[:models_dir]
       # self.class.check_name(model_name)
       template_file = \
         if options[:orm] == 'activerecord'
@@ -21,7 +23,7 @@ module PraxisGen
           'models/sequel.rb'
         end
       puts "Generating Model for #{model_name}"
-      template template_file, "app/models/#{model_name}.rb"
+      template template_file, "#{models_dir}/#{model_name}.rb"
       nil
     end
     # Helper functions (which are available in the ERB contexts)

data/tasks/thor/scaffold.rb

@@ -13,7 +13,9 @@ module PraxisGen
 
     desc 'g', 'Generates an API design and implementation scaffold for managing a collection of <collection_name>'
     argument :collection_name, required: true
-    option :version, required: false, default: '1',
+    option :base, required: false,
+                  desc: 'Module name to enclose all generated files. Empty by default. You can pass things like MyApp, or MyApp::SubModule'
+    option :version, required: false,
                      desc: 'Version string for the API endpoint. This also dictates the directory structure (i.e., v1/endpoints/...))'
     option :design, type: :boolean, default: true,
                     desc: 'Include the Endpoint and MediaType files for the collection'
@@ -26,6 +28,11 @@ module PraxisGen
     option :actions, type: :string, default: 'crud', enum: %w[cr cru crud u ud d],
                      desc: 'Specifies the actions to generate for the API. cr=create, u=update, d=delete. Index and show actions are always generated'
     def g
+      incorporate_config_options
+      # Good defaults
+      options[:version] = '1' unless options[:version].presence
+      options[:models_dir] = 'app/models' unless options[:models_dir]
+
       self.class.check_name(collection_name)
       @actions_hash = self.class.compose_actions_hash(options[:actions])
       env_rb = Pathname.new(destination_root) + Pathname.new('config/environment.rb')
@@ -53,10 +60,31 @@ module PraxisGen
         template 'implementation/controllers/collection.rb', "app/#{version_dir}/controllers/#{collection_name}.rb"
       end
       nil
+      save_last_config_options
     end
 
     # Helper functions (which are available in the ERB contexts)
     no_commands do
+      def incorporate_config_options
+        @saved_original_options = options
+        self.options = options.dup
+        return if PraxisGenerator.scaffold_config.empty?
+
+        begin
+          options[:base] = PraxisGenerator.scaffold_config[:base] unless PraxisGenerator.scaffold_config[:base].presence
+          options[:version] = PraxisGenerator.scaffold_config[:version] unless PraxisGenerator.scaffold_config[:version].presence
+          options[:models_dir] = PraxisGenerator.scaffold_config[:models_dir] if PraxisGenerator.scaffold_config[:models_dir]
+        rescue StandardError # rubocop:disable Lint/SuppressedException
+        end
+      end
+
+      def save_last_config_options
+        return if @saved_original_options.slice('base', 'version').empty?
+
+        opts_to_save = options.slice('base', 'version').transform_keys(&:to_sym).reject { |_k, v| v.nil? }
+        PraxisGenerator.scaffold_config.merge!(opts_to_save)
+      end
+
       def plural_class
         collection_name.camelize
       end
@@ -65,16 +93,20 @@ module PraxisGen
         collection_name.singularize.camelize
       end
 
+      def base_module
+        options[:base]
+      end
+
       def version
         options[:version]
       end
 
       def version_module
-        "V#{version}"
+        base_module.presence ? "#{base_module}::V#{version}" : "V#{version}"
       end
 
       def version_dir
-        version_module.camelize(:lower)
+        "v#{version}"
       end
 
       def action_enabled?(action)

data/tasks/thor/templates/generator/scaffold/design/endpoints/collection.rb

@@ -77,6 +77,7 @@ module <%= version_module %>
           # attribute :name
         end
         response :no_content
+        response :not_found
         response :bad_request
       end
       <%- end -%>

data/tasks/thor/templates/generator/scaffold/design/media_types/item.rb

@@ -5,7 +5,7 @@ module <%= version_module %>
     class <%= singular_class %> < Praxis::MediaType
       identifier 'application/json'
 
-      domain_model '<%= version_module %>::Resources::<%= singular_class %>'
+      domain_model 'Resources::<%= singular_class %>'
       description 'Structural definition of a <%= singular_class %>'
 
       attributes do

data/tasks/thor/templates/generator/scaffold/implementation/controllers/collection.rb

@@ -11,7 +11,7 @@ module <%= version_module %>
       # Retrieve all <%= plural_class %> with the right necessary associations
       # and render them appropriately with the requested field selection
       def index
-        objects = build_query(model_class).all
+        objects = build_query(model_class)
         display(objects)
       end
       <%- end -%>
@@ -42,14 +42,12 @@ module <%= version_module %>
       <%- if action_enabled?(:update) -%>
       # Updates some of the information of a <%= singular_class %>
       def update(id:)
-        # A good pattern is to call the same name method on the corresponding resource, 
-        # passing the incoming id and payload (or massaging it first)
-        updated_resource = Resources::<%= singular_class %>.update(
-          id: id,
-          payload: request.payload,
-        )
-        return Praxis::Responses::NotFound.new unless updated_resource
+        # A good pattern is to retrieve the resource instance by id, and then
+        # call the same name method on it, by passing the incoming payload (or massaging it first)
+        resource = Resources::<%= singular_class %>.get(id: id)
+        return Praxis::Responses::NotFound.new unless resource
 
+        resource.update(payload: request.payload)
         Praxis::Responses::NoContent.new
       end
       <%- end -%>
@@ -57,13 +55,12 @@ module <%= version_module %>
       <%- if action_enabled?(:delete) -%>
       # Deletes an existing <%= singular_class %>
       def delete(id:)
-        # A good pattern is to call the same name method on the corresponding resource,
-        # maybe passing the already loaded model
-        deleted_resource = Resources::<%= singular_class %>.delete(
-          id: id
-        )
-        return Praxis::Responses::NotFound.new unless deleted_resource
+        # A good pattern is to retrieve the resource instance by id, and then
+        # call the same name method on it
+        resource = Resources::<%= singular_class %>.get(id: id)
+        return Praxis::Responses::NotFound.new unless resource
 
+        resource.delete(payload: request.payload)
         Praxis::Responses::NoContent.new
       end
       <%- end -%>

data/tasks/thor/templates/generator/scaffold/implementation/resources/item.rb

@@ -22,21 +22,17 @@ module <%= version_module %>
       <%- end -%>
 
       <%- if action_enabled?(:update) -%>
-      def self.update(id:, payload:)
-        record = model.find_by(id: id)
-        return nil unless record
+      def update(payload:)
         # Assuming the API field names directly map the the model attributes. Massage if appropriate.
         record.update(**payload.to_h)
-        self.new(record)
+        self
       end
       <%- end -%>
 
       <%- if action_enabled?(:delete) -%>
       def self.delete(id:)
-        record = model.find_by(id: id)
-        return nil unless record
         record.destroy
-        self.new(record)
+        self
       end
       <%- end -%>  
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.31
+  version: 2.0.pre.33
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -319,40 +333,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !ruby/object:Gem::Dependency
-  name: sequel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
 description:
 email:
 - blanquer@gmail.com
@@ -368,6 +348,7 @@ files:
 - ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -378,6 +359,10 @@ files:
 - Rakefile
 - SELECTOR_NOTES.txt
 - bin/praxis
+- gemfiles/active_6.gemfile
+- gemfiles/active_6.gemfile.lock
+- gemfiles/active_7.gemfile
+- gemfiles/active_7.gemfile.lock
 - lib/praxis.rb
 - lib/praxis/action_definition.rb
 - lib/praxis/action_definition/headers_dsl_compiler.rb