standardapi 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0f6e2d86659b79df8b56eb7b998118541facdc0fd516ad878f4afb0c531299
-  data.tar.gz: dcfebcfd01bd96dbaa8a4a2aef53ea1549c0820b7879845a2e812311efbd3556
+  metadata.gz: 692542999da28b20821233c6649dcc8e4b66bdf76183b44ab665ff2452cd0cfd
+  data.tar.gz: 92cf5184a56a2695f34478bd29895d5aa6ba01181548eb77a990da5b8e62f28b
 SHA512:
-  metadata.gz: e7b0189b209ce50457ba90a8f2c89653557f1f7ff61b0a955f479c40beefc8666f47e9dfe9c2e6b17193fc197510305ff442ea49c0bf31ab482011d729b7b09e
-  data.tar.gz: a31458fac536e7d0e074a3c4c5efee56123f264771316503df1ff69b8a4539e782e29c109d5c9f89a789d5f54b576300fde5de91852dc4a67a526b665bc793ff
+  metadata.gz: 99356387601124215ce2d86926cdb98d04b38c3141d4a6affa7ba6464c2f0d6342fe506ce34859a284499e626eb1cc0c2573364cf13cb4d8d9216210b24a8120
+  data.tar.gz: b54933f7376b9f672f2a37ef8c2fd21893c37650907b906b6ccfdc2f489a0b37a6bc3fa639e3e374d023a8645557c33b408a0024763d2ae8f24a9bc822154975

data/lib/standard_api/version.rb

@@ -1,3 +1,3 @@
 module StandardAPI
-  VERSION = '7.1.1'
+  VERSION = '7.1.3'
 end

data/lib/standard_api/views/application/_schema.json.jbuilder

@@ -69,7 +69,17 @@ else
         # TODO: it would be nice if rails responded with a true or false here
         # instead of the function itself
         json.set! 'auto_populated', !!column.auto_populated? if column.respond_to?(:auto_populated?)
-      end
+
+        json.set! 'readonly', (if controller.respond_to?("#{ model.model_name.singular }_attributes")
+          !controller.send("#{ model.model_name.singular }_attributes").include?(column.name)
+        else
+          model.readonly_attribute?(column.name)
+        end)
+        
+        visitor = StandardAPI::Visitors::Validator.new
+        validations = model.validators.select { |v| v.attributes.include?(column.name.to_sym) }.map { |v| visitor.accept(v, {}) }.compact
+        json.set! 'validations', validations
+       end
     end
   end
 

data/lib/standard_api/views/application/_schema.streamer

@@ -79,6 +79,16 @@ else
               # TODO: it would be nice if rails responded with a true or false here
               # instead of the function itself
               json.set! 'auto_populated', !!column.auto_populated? if column.respond_to?(:auto_populated?)
+              
+              json.set! 'readonly', (if controller.respond_to?("#{ model.model_name.singular }_attributes")
+                !controller.send("#{ model.model_name.singular }_attributes").include?(column.name)
+              else
+                true
+              end)
+              
+              visitor = StandardAPI::Visitors::Validator.new
+              validations = model.validators.select { |v| v.attributes.include?(column.name.to_sym) }.map { |v| visitor.accept(v, {}) }.compact
+              json.set! 'validations', validations
             end
           end
         end

data/lib/standard_api/visitors/validations.rb

@@ -0,0 +1,73 @@
+module StandardAPI
+  module Visitors
+
+    class Validator < Arel::Visitors::Visitor
+
+      def visit_ActiveRecord_Validations_AbsenceValidator(o, col)
+        visit_validator(:absence, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_AcceptanceValidator(o, col)
+        visit_validator(:acceptance, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_ComparisonValidator(o, col)
+        visit_validator(:comparison, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_ConfirmationValidator(o, col)
+        visit_validator(:confirmation, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_ExclusionValidator(o, col)
+        visit_validator(:exclusion, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_FormatValidator(o, col)
+        visit_validator(:format, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_InclusionValidator(o, col)
+        visit_validator(:inclusion, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_LengthValidator(o, col)
+        visit_validator(:length, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_NumericalityValidator(o, col)
+        visit_validator(:numericality, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_PresenceValidator(o, col)
+        visit_validator(:presence, o.options)
+      end
+
+      def visit_ActiveRecord_Validations_WithValidator(o, col)
+        visit_validator(:with, o.options)
+      end
+
+      def visit_ActiveModel_Validations_FormatValidator(o, col)
+        visit_validator(:format, o.options)
+      end
+
+      private
+
+      def visit_validator(name, options)
+        { name => options.empty? ? true : options.as_json }
+      end
+
+      def visit(object, collector = nil)
+        dispatch_method = dispatch[object.class]
+        if collector
+          send dispatch_method, object, collector
+        else
+          send dispatch_method, object
+        end
+      rescue NoMethodError => e
+      end
+
+    end
+
+  end
+end

data/lib/standard_api.rb

@@ -16,6 +16,7 @@ require 'standard_api/helpers'
 require 'standard_api/route_helpers'
 require 'standard_api/active_record/connection_adapters/postgresql/schema_statements'
 require 'standard_api/railtie'
+require 'standard_api/visitors/validations'
 
 module StandardAPI
   autoload :AccessControlList, 'standard_api/access_control_list'

data/test/standard_api/standard_api_test.rb

@@ -161,6 +161,31 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
       end
     end
 
+    assert_equal true, schema['models']['Account']['attributes']['id']['readonly']
+    assert_equal false, schema['models']['Account']['attributes']['name']['readonly']
+
+    assert_equal [
+      {"format"=>{"allow_nil"=>true, "with"=>"(?-mix:.+@.+)"}}
+    ], schema['models']['Account']['attributes']['email']['validations']
+    
+    assert_equal [
+      { "presence" => true }
+    ], schema['models']['Property']['attributes']['name']['validations']
+    
+    assert_equal [
+      { "numericality" => {
+          "greater_than" => 1,
+          "greater_than_or_equal_to" => 2,
+          "equal_to" => 2,
+          "less_than_or_equal_to" => 2,
+          "less_than" => 3,
+          "other_than" => 0,
+          "even" => true,
+          "in" => "1..3"
+        }
+      }
+    ], schema['models']['Property']['attributes']['numericality']['validations']
+
     assert_equal 'test comment', schema['comment']
   end
 
@@ -756,4 +781,6 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     end
   end
 
+
+
 end

data/test/standard_api/test_app/app/controllers/acl/property_acl.rb

@@ -7,7 +7,8 @@ module PropertyACL
       :description,
       :constructed,
       :size,
-      :active
+      :active,
+      :numericality
       # :photos_attributes,
       # { photos_attributes: [ :id, :account_id, :property_id, :format] }
     ]
@@ -15,7 +16,17 @@ module PropertyACL
 
   # Orderings allowed
   def orders
-    ["id", "name", "aliases", "description", "constructed", "size", "created_at", "active"]
+    [
+      "id",
+      "name",
+      "aliases",
+      "description",
+      "constructed",
+      "size",
+      "created_at",
+      "active",
+      "numericality"
+    ]
   end
 
   # Sub resources allowed to be included in the response

data/test/standard_api/test_app/models.rb

@@ -1,6 +1,7 @@
 # = Models
 
 class Account < ActiveRecord::Base
+  validates :email, format: /.+@.+/, allow_nil: true
   has_many :photos, -> { order(:created_at) }
   belongs_to :property
   belongs_to :subject, polymorphic: true
@@ -14,7 +15,7 @@ end
 
 class Document < ActiveRecord::Base
   attr_accessor :file
-  
+
   enum level:   { public: 0, secret: 1 }, _suffix: true
   enum rating:  { poor: 0, ok: 1, good: 2 }
 end
@@ -29,13 +30,25 @@ class Property < ActiveRecord::Base
   has_one :document_attachments, class_name: "Attachment", as: :record, inverse_of: :record
   has_one :document, through: "document_attachments"
 
-
   validates :name, presence: true
   accepts_nested_attributes_for :photos
 
   def english_name
     'A Name'
   end
+
+  # Numericality Validation
+  validates :numericality, numericality: {
+    greater_than: 1,
+    greater_than_or_equal_to: 2,
+    equal_to: 2,
+    less_than_or_equal_to: 2,
+    less_than: 3,
+    other_than: 0,
+    even: true,
+    in: 1..3
+  }
+  
 end
 
 class LSNType < ActiveRecord::Type::Value
@@ -101,6 +114,7 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
 
     create_table "accounts", force: :cascade do |t|
       t.string   'name',                 limit: 255
+      t.string   'email',                limit: 255
       t.integer  'property_id'
       t.integer  "subject_id"
       t.string   "subject_type"
@@ -129,6 +143,7 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
       t.decimal  "size"
       t.datetime "created_at",                         null: false
       t.boolean  "active",             default: false
+      t.integer  "numericality",       default: 2
     end
 
     create_table "references", force: :cascade do |t|
@@ -167,12 +182,12 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
       t.integer  'record_id'
       t.integer  'document_id'
     end
-    
+
     create_table "uuid_models", id: :uuid, force: :cascade do |t|
       t.string 'title', default: 'recruit'
       t.string 'name', default: -> { 'round(random() * 1000)' }
     end
-    
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.3
 platform: ruby
 authors:
 - James Bracy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -306,6 +306,7 @@ files:
 - lib/standard_api/views/application/schema.streamer
 - lib/standard_api/views/application/show.json.jbuilder
 - lib/standard_api/views/application/show.streamer
+- lib/standard_api/visitors/validations.rb
 - test/standard_api/caching_test.rb
 - test/standard_api/controller/include_test.rb
 - test/standard_api/controller/subresource_test.rb
@@ -361,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: StandardAPI makes it easy to expose a query interface for your Rails models