praxis 2.0.pre.36 → 2.0.pre.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832a3ffb62fa691ed10139478a2cc262978c8a4c382baf9392357d1b78548164
-  data.tar.gz: 85a4bf51dac77883338be30112725f380483db6b7cad121d193652095e886ab9
+  metadata.gz: b2f139dbbe5f48ceddf013eb18a84dc43fcdf41af033b19a40f565f8606b961f
+  data.tar.gz: 69b0200fd2ead2d713af52b7a0c56ca60a19bc4cb118ff0284017e7f1d19cda2
 SHA512:
-  metadata.gz: 78a6a4546a9abdc6764d72c04d4419a1895b51399f9d77789f7dd6a4e1c86983d210deabf5744e072ebf98a807c20d3fc26129f2384c85e061745263d3bc4c15
-  data.tar.gz: df6d66dbef7f356ee7adfa23211f8bcf6c8df4d67f1f158c410824d403fb354d7b472af707411f4b2e672a8a4356163c3e55978fb559b4f18f4b14cf971340ce
+  metadata.gz: cdcaed25ce9a8735f76a77e8f805432579eb4afa8893d0abf39b8054cd09053dc9a0103c1ea64d2330baa4280dc9d8b9a522022afce009c90814f367e3295920
+  data.tar.gz: 6a146584703308be70f70a54e3ebb53b10ff038578a5851e333cad95392729576e133c5079a85052487f3af023c831888e7cc2a8dd075b93b7aa8c7c30b5dc24

data/.ruby-version

@@ -1 +1 @@
-3.1.1
+3.2.2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Praxis Changelog
 
-## next
+## 2.0.pre.38
+
+- Stoped calling ::Oj.mimic_JSON in Praxis::Handlers::JSON. It breaks ActiveSupport::JSON's html escaping when called.
+
+## 2.0.pre.37
+
  - OpenAPI generation enhancement:
    - expose nullable: true, in situations where the 'null:' key isn't specified in an attribute, but the builtin default behavior is true
  - Change ActiveRecord query planner strategy for selecting fields in the root model when that model is also appearing in inner joins/associations (triggered by a new AR7 behavior)
@@ -11,6 +16,7 @@
      points to a loaded model with the same 'id' ... then we're at the mercy of whatever fields that initial model was loaded with.
      The current solution we've adopted, is to make our query planner smarter, and make sure that we use a top level model select clause that includes ALL of possible fields for that model, regardless of how deep the inner associations might be.
      This can technically add more loaded fields at the top (i.e., some memory bloat), but if that's the case, it is very likely that such extra bloat on field memory is compensated by the fact that any of the inner associations using the same model type will now likely not have to be loaded and instantiated. It really depends on the pattern of the query and the cardinality of such associations
+ - Update attributor to 8.0, this replaces the use of Randexp with (Faker)[https://github.com/faker-ruby/faker] and means support for generating examples from regular expressions is no longer supported.
 
 ## 2.0.pre.35
 - Fix reported nullability property in OpenAPI generation. Looking at null: true | false isn't enough. The system needs to look at the default null behavior from Attributor, to properly ascertain if the exclusion of a 'null' option means nullable or not. This PR fixes this.

data/lib/praxis/handlers/json.rb

@@ -8,12 +8,6 @@ module Praxis
       # @raise [Praxis::Exceptions::InvalidConfiguration] if the handler is unsupported
       def initialize
         require 'oj'
-        begin
-          require 'json'
-        rescue LoadError # rubocop:disable Lint/SuppressedException
-        end
-        # Enable mimicing needs to be done after loading the JSON gem (if there)
-        ::Oj.mimic_JSON
       rescue LoadError
         # Should never happen since JSON is a default gem; might as well be cautious!
         raise Praxis::Exceptions::InvalidConfiguration,

data/lib/praxis/tasks/console.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 namespace :praxis do
-  desc 'Run interactive pry/irb console'
+  desc 'Run interactive REPL'
   task :console do
     # Use irb if available (which it almost always is).
     require 'irb'
@@ -14,23 +14,29 @@ namespace :praxis do
     IRB.setup nil
     ARGV.concat(old_argv)
 
-    # Allow reentrant IRB
+    # Ensure that multi-irb has a context to work with (and, indirectly an instance of IRB::Irb).
     IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+
+    # Allow reentrant IRB
     require 'irb/ext/multi-irb'
 
+    # Ensure that we save history just like normal IRB
+    require 'irb/ext/save-history'
+
     # Remove main object from prompt (its stringify is not useful)
     nickname = File.basename(::Praxis::Application.instance.root)
     IRB.conf[:PROMPT][:DEFAULT] = {
       PROMPT_I: "%N(#{nickname}):%03n:%i> ",
       PROMPT_N: "%N(#{nickname}):%03n:%i> ",
       PROMPT_S: "%N(#{nickname}):%03n:%i%l ",
-      PROMPT_C: "%N(#{nickname}):%03n:%i* "
+      PROMPT_C: "%N(#{nickname}):%03n:%i* ",
     }
 
     # Disable inefficient, distracting autocomplete
     IRB.conf[:USE_AUTOCOMPLETE] = false
 
-    # Set the IRB main object.
+    # Invoke the REPL, then cleanly shut down
     IRB.irb(nil, Praxis::Application.instance)
+    IRB.irb_at_exit
   end
 end

data/lib/praxis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Praxis
-  VERSION = '2.0.pre.36'
+  VERSION = '2.0.pre.38'
 end

data/praxis.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.bindir = 'bin'
   spec.executables << 'praxis'
 
-  spec.add_dependency 'activesupport', '>= 3'
-  spec.add_dependency 'attributor', '>= 7.1'
+  spec.add_dependency 'activesupport', '>= 6'
+  spec.add_dependency 'attributor', '>= 8.0'
   spec.add_dependency 'mime', '~> 0'
   spec.add_dependency 'mustermann', '>=1.1'
   spec.add_dependency 'rack', '>= 1'
@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   else
     spec.add_development_dependency 'jdbc-sqlite3'
   end
+  spec.add_development_dependency 'activerecord', '~> 6'
   spec.add_development_dependency 'coveralls_reborn', '~> 0.27.0'
   spec.add_development_dependency 'fuubar', '~> 2'
   spec.add_development_dependency 'guard', '~> 2'
@@ -51,4 +52,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
   spec.add_development_dependency 'rspec-its', '~> 1'
+  spec.add_development_dependency 'sequel', '~> 5'
 end

data/spec/functional_cloud_spec.rb

@@ -366,8 +366,10 @@ describe 'Functional specs' do
   end
 
   context 'auth_plugin' do
+    let(:content_type) { 'application/json' }
+
     it 'can terminate' do
-      post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session, 'CONTENT_TYPE' => content_type
       expect(last_response.status).to eq(200)
     end
 

data/spec/praxis/blueprint_spec.rb

@@ -392,7 +392,7 @@ describe Praxis::Blueprint do
           email: 'bob@example.com',
           aliases: [],
           prior_addresses: [],
-          parents: { father: Randgen.first_name, mother: Randgen.first_name },
+          parents: { father: Faker::Name.first_name, mother: Faker::Name.first_name },
           href: 'www.example.com',
           alive: true
         }

data/spec/praxis/media_type_spec.rb

@@ -3,9 +3,9 @@
 require 'spec_helper'
 
 describe Praxis::MediaType do
-  let(:owner_resource) { instance_double(Person, id: 100, name: /[:name:]/.gen, href: '/') }
-  let(:manager_resource) { instance_double(Person, id: 101, name: /[:name:]/.gen, href: '/') }
-  let(:custodian_resource) { instance_double(Person, id: 102, name: /[:name:]/.gen, href: '/') }
+  let(:owner_resource) { instance_double(Person, id: 100, name: Faker::Name.first_name, href: '/') }
+  let(:manager_resource) { instance_double(Person, id: 101, name: Faker::Name.first_name, href: '/') }
+  let(:custodian_resource) { instance_double(Person, id: 102, name: Faker::Name.first_name, href: '/') }
   let(:residents_summary_resource) do
     instance_double(Person::CollectionSummary, href: '/people', size: 2)
   end

data/spec/praxis/types/multipart_array_spec.rb

@@ -16,7 +16,7 @@ describe Praxis::Types::MultipartArray do
 
       file 'files', multiple: true do
         header 'Content-Type', 'application/octet-stream'
-        filename String, regexp: /file/
+        filename String, regexp: /file/, example: 'file'
         payload Attributor::Tempfile
       end
 

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

@@ -6,7 +6,7 @@ class Instance < Praxis::MediaType
   attributes do
     attribute :id, Integer
     attribute :name, String,
-              example: /[:first_name:]/,
+              example: proc { Faker::Name.first_name },
               regexp: /^\w+$/
 
     attribute :href, String

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

@@ -5,7 +5,7 @@ class VolumeSnapshot < Praxis::MediaType
 
   attributes do
     attribute :id, Integer
-    attribute :name, String, regexp: /snapshot-(\w+)/
+    attribute :name, String, regexp: /snapshot-(\w+)/, example: proc { "snapshot-#{Faker::Number.number(digits: 8) }" }
   end
 
   default_fieldset do
@@ -17,7 +17,7 @@ class VolumeSnapshot < Praxis::MediaType
     identifier 'application/json'
 
     attributes do
-      attribute :name, String, regexp: /snapshots-(\w+)/
+      attribute :name, String, regexp: /snapshots-(\w+)/, example: proc { "snapshot-#{Faker::Number.number(digits: 8) }" }
       attribute :size, Integer
       attribute :href, String
     end

data/spec/spec_helper.rb

@@ -25,6 +25,10 @@ require 'rack/test'
 require 'rspec/its'
 require 'rspec/collection_matchers'
 
+require 'oj'
+require 'json'
+Oj.mimic_JSON
+
 Dir["#{File.dirname(__FILE__)}/../lib/praxis/plugins/*.rb"].sort.each do |file|
   require file
 end

data/spec/support/spec_blueprints.rb

@@ -2,7 +2,7 @@
 
 class PersonBlueprint < Praxis::Blueprint
   attributes do
-    attribute :name, String, example: /[:first_name:]/
+    attribute :name, String, example: proc { Faker::Name.first_name }
     attribute :email, String, example: proc { |person| "#{person.name}@example.com" }
 
     attribute :age, Integer, min: 0
@@ -55,8 +55,8 @@ end
 
 class FullName < Attributor::Model
   attributes do
-    attribute :first, String, example: /[:first_name:]/
-    attribute :last, String, example: /[:last_name:]/
+    attribute :first, String, example: proc { Faker::Name.first_name }
+    attribute :last, String, example: proc { Faker::Name.last_name }
   end
 end
 

data/spec/support/spec_media_types.rb

@@ -6,7 +6,7 @@ class Person < Praxis::MediaType
 
   attributes do
     attribute :id, Integer
-    attribute :name, String, example: /[:name:]/
+    attribute :name, String, example: proc { Faker::Name.full_name }
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
   end
 
@@ -115,9 +115,9 @@ class Post < Praxis::MediaType
               description: 'Href for use with this API'
 
     attribute :title, String,
-              example: /\w+/
+              example: proc { Faker::Lorem.sentence }
     attribute :content, String,
-              example: /[:sentence:]{4,5}/
+              example: proc { Faker::Lorem.words(10) }
     attribute :url, String,
               description: 'URL for a web browser',
               example: proc { |o, _ctx| "example.com/posts/#{o.id}" }
@@ -163,8 +163,8 @@ class User < Praxis::MediaType
     attribute :href, String,
               example: proc { |o, _ctx| "/api/v1.0/users/#{o.id}" }
 
-    attribute :first, String, example: /[:first_name:]/
-    attribute :last, String, example: /[:last_name:]/
+    attribute :first, String, example: proc { Faker::Name.first_name }
+    attribute :last, String, example: proc { Faker::Name.last_name }
     attribute :posts, Attributor::Collection.of(Post)
 
     attribute :post_matrix, Attributor::Collection.of(Attributor::Collection.of(Post)),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.36
+  version: 2.0.pre.38
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: attributor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
@@ -333,6 +347,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !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
@@ -677,7 +705,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Building APIs the way you want it.