brick 1.0.104 → 1.0.105

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d30161a8558282149a49e7eafbd43bb175ce95574178c65a75323eaacf96422
-  data.tar.gz: 6d56c5e77c2a0d120bc8e878bde9d33fdfa7d58bed690a21fea176d5d6b55d50
+  metadata.gz: 48fc69654d7cbdf5c7feb9ba7803b7a953c6c0ccd3c176614fe9a61994bb39e1
+  data.tar.gz: f3a4837d334cf97cb491cacd658cb6e6d8e3f3a5c640f80c151a083bf6811b7a
 SHA512:
-  metadata.gz: 14bfffec6fd768d4b3abff2b3ceaeb2a2dca29b167edd64c2e57a63c72eaa70bf46fc8056af25fca86812bfac63d3b793bdeaf7f13a8c2ba7834ac9e65f1fb16
-  data.tar.gz: 97f7c94051bb068c4d8bdb5e847e53576c8ebbe18d5c4c93e12d52566008ac612bb40f7088ba81fea21337a3c13c29f366fb993b77f2f88f9fbddea4ffb95982
+  metadata.gz: e51134710bae78f033b9dcf7827cd7c087cfd642ef8bc6244e2429f22158a80e9f804022bc703f55fa55f85cbc009ff25440289205ade1b415f5ba0af3d44c77
+  data.tar.gz: d6069676ad70e8401f7597b92b641f0f95e3c28fffa54747f630932500c778d7b4ac967c5bbd70059647d11d398598362d9c0bb5c82ef0500b1025371104a578

data/lib/brick/config.rb

@@ -94,13 +94,13 @@ module Brick
       @mutex.synchronize { @enable_api = enable }
     end
 
-    def api_root
+    def api_roots
       ver = api_version
-      @mutex.synchronize { @api_root || "/api/#{ver}/" }
+      @mutex.synchronize { @api_roots || ["/api/#{ver}/"] }
     end
 
-    def api_root=(path)
-      @mutex.synchronize { @api_root = path }
+    def api_roots=(path)
+      @mutex.synchronize { @api_roots = path }
     end
 
     def api_version

data/lib/brick/extensions.rb

@@ -1526,7 +1526,11 @@ class Object
         self.protect_from_forgery unless: -> { self.request.format.js? }
         unless is_avo
           self.define_method :index do
-            if (is_openapi || request.env['REQUEST_PATH'].start_with?(::Brick.api_root)) &&
+            current_api_root = ::Brick.config.api_roots.find do |ar|
+              request.path.start_with?(ar) || # Exact match?
+              request.path.split('/')[-2] == ar.split('/').last # Version at least matches?
+            end
+            if (current_api_root || is_openapi) &&
                !params&.key?('_brick_schema') &&
                (referrer_params = request.env['HTTP_REFERER']&.split('?')&.last&.split('&')&.map { |x| x.split('=') }).present?
               if params
@@ -1538,6 +1542,7 @@ class Object
             _schema, @_is_show_schema_list = ::Brick.set_db_schema(params || api_params)
 
             if is_openapi
+              current_api_ver = current_api_root.split('/').last&.[](1..-1).to_i
               json = { 'openapi': '3.0.1', 'info': { 'title': Rswag::Ui.config.config_object[:urls].last&.fetch(:name, 'API documentation'), 'version': ::Brick.config.api_version },
                        'servers': [
                          { 'url': '{scheme}://{defaultHost}', 'variables': {
@@ -1546,15 +1551,19 @@ class Object
                          } }
                        ]
                      }
-              json['paths'] = relations.inject({}) do |s, relation|
+              json['paths'] = relations.each_with_object({}) do |relation, s|
                 unless ::Brick.config.enable_api == false
+                  next if (api_vers = relation.last.fetch(:api, nil)) &&
+                          !(api_ver_path = api_vers[current_api_ver])
+
+                  relation_name = api_ver_path || relation.first.tr('.', '/')
                   table_description = relation.last[:description]
-                  s["#{::Brick.config.api_root}#{relation.first.tr('.', '/')}"] = {
+                  s["#{current_api_root}#{relation_name}"] = {
                     'get': {
                       'summary': "list #{relation.first}",
                       'description': table_description,
                       'parameters': relation.last[:cols].map do |k, v|
-                                      param = { 'name' => k, 'schema': { 'type': v.first } }
+                                      param = { in: 'query', 'name' => k, 'schema': { 'type': v.first } }
                                       if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k, nil))
                                         param['description'] = col_descrip
                                       end
@@ -1564,7 +1573,7 @@ class Object
                     }
                   }
 
-                  s["#{::Brick.config.api_root}#{relation.first.tr('.', '/')}/{id}"] = {
+                  s["#{current_api_root}#{relation_name}/{id}"] = {
                     'patch': {
                       'summary': "update a #{relation.first.singularize}",
                       'description': table_description,
@@ -1578,7 +1587,6 @@ class Object
                       'responses': { '200': { 'description': 'successful' } }
                     }
                   } unless relation.last.fetch(:isView, nil)
-                  s
                 end
               end
               render inline: json.to_json, content_type: request.format
@@ -1592,9 +1600,10 @@ class Object
               end
               render inline: exported_csv, content_type: request.format
               return
-            elsif request.format == :js || request.path.start_with?('/api/') # Asking for JSON?
+            elsif request.format == :js || current_api_root # Asking for JSON?
+              # %%% Add:  where, order, page, page_size, offset, limit
               data = (model.is_view? || !Object.const_defined?('DutyFree')) ? model.limit(1000) : model.df_export(model.brick_import_template)
-              render inline: data.to_json, content_type: request.format == '*/*' ? 'application/json' : request.format
+              render inline: { data: data }.to_json, content_type: request.format == '*/*' ? 'application/json' : request.format
               return
             end
 

data/lib/brick/frameworks/rails/engine.rb

@@ -464,7 +464,7 @@ window.addEventListener(\"popstate\", linkSchemas);
               table_options << "<option value=\"#{prefix}brick_orphans\">(Orphans)</option>".html_safe if is_orphans
               table_options << "<option value=\"#{prefix}brick_orphans\">(Crosstab)</option>".html_safe if is_crosstab
               css = +"<style>
-#titleBox {
+#titleSticky {
   position: sticky;
   display: inline-block;
   left: 0;
@@ -881,6 +881,7 @@ if (grid) {
   // });
 }
 function setHeaderSizes() {
+  document.getElementById(\"titleBox\").style.width = grid.clientWidth;
   // console.log(\"start\");
   // See if the headerTop is already populated
   // %%% Grab the TRs from headerTop, clear it out, do this stuff, add them back
@@ -1127,7 +1128,7 @@ erDiagram
 %></title>
 </head>
 <body>
-<div id=\"titleBox\">
+<div id=\"titleBox\"><div id=\"titleSticky\">
 <p style=\"color: green\"><%= notice %></p>#{"
 #{schema_options}" if schema_options}
 <select id=\"tbl\">#{table_options}</select>
@@ -1182,7 +1183,7 @@ erDiagram
     });
   </script>
 <% end %>
-</div>
+</div></div>
 #{erd_markup}
 
 <%= # Consider getting the name from the association -- hm.first.name -- if a more \"friendly\" alias should be used for a screwy table name

data/lib/brick/version_number.rb

@@ -5,7 +5,7 @@ module Brick
   module VERSION
     MAJOR = 1
     MINOR = 0
-    TINY = 104
+    TINY = 105
 
     # PRE is nil unless it's a pre-release (beta, RC, etc.)
     PRE = nil

data/lib/brick.rb

@@ -334,12 +334,17 @@ module Brick
 
     # @api public
     def api_root=(path)
-      Brick.config.api_root = path
+      Brick.config.api_roots = [path]
     end
 
     # @api public
-    def api_root
-      Brick.config.api_root
+    def api_roots=(paths)
+      Brick.config.api_roots = paths
+    end
+
+    # @api public
+    def api_roots
+      Brick.config.api_roots
     end
 
     # @api public
@@ -657,19 +662,65 @@ In config/initializers/brick.rb appropriate entries would look something like:
                              # Turn something like {"::Spouse"=>"Person", "::Friend"=>"Person"} into {"Person"=>["Spouse", "Friend"]}
                              s[v.last] << v.first[2..-1] unless v.first.end_with?('::')
                            end
+          versioned_views = {} # Track which views have already been done for each api_root
           ::Brick.relations.each do |k, v|
             next if !(controller_name = v.fetch(:resource, nil)&.pluralize) || existing_controllers.key?(controller_name)
 
+            schema_name = v.fetch(:schema, nil)
             options = {}
             options[:only] = [:index, :show] if v.key?(:isView)
-            # First do the API routes
+            # First do the API routes if necessary
             full_resource = nil
-            if (schema_name = v.fetch(:schema, nil))
-              full_resource = "#{schema_name}/#{v[:resource]}"
-              send(:get, "#{::Brick.api_root}#{full_resource}", { to: "#{controller_prefix}#{schema_name}/#{controller_name}#index" }) if Object.const_defined?('Rswag::Ui')
-            else
-              # Normally goes to something like:  /api/v1/employees
-              send(:get, "#{::Brick.api_root}#{v[:resource]}", { to: "#{controller_prefix}#{controller_name}#index" }) if Object.const_defined?('Rswag::Ui')
+            ::Brick.api_roots&.each do |api_root|
+              api_done_views = (versioned_views[api_root] ||= {})
+              found = nil
+              view_relation = nil
+              # If it's a view then see if there's a versioned one available by searching for resource names
+              # versioned with the closest number (equal to or less than) compared with our API version number.
+              if v.key?(:isView) && (ver = k.match(/^v([\d_]*)/).captures.first)[-1] == '_'
+                next if api_done_views.key?(unversioned = k[ver.length + 1..-1])
+
+                # # if ().length.positive? # Does it have a version number?
+                # try_num = (ver_num = (ver = ver[1..-1].gsub('_', '.')).to_d)
+
+                # Expect that the last item in the path generally holds versioning information
+                api_ver = api_root.split('/')[-1]&.gsub('_', '.')
+                vn_idx = api_ver.rindex(/[^\d._]/) # Position of the first numeric digit at the end of the version number
+                # Was:  .to_d
+                api_ver_num = api_ver[vn_idx + 1..-1].gsub('_', '.').to_i # Attempt to turn something like "v3" into the decimal value 3
+                # puts [api_ver, vn_idx, api_ver_num, unversioned].inspect
+
+                next if ver.to_i > api_ver_num # Don't surface any newer views in an older API
+
+                api_ver_num -= 1 until api_ver_num.zero? ||
+                                       (view_relation = ::Brick.relations.fetch(
+                                         found = "v#{api_ver_num}_#{k[ver.length + 1..-1]}", nil
+                                       ))
+                api_done_views[unversioned] = nil # Mark that for this API version this view is done
+
+                # puts "Found #{found}" if view_relation
+                # If we haven't found "v3_view_name" or "v2_view_name" or so forth, at the last
+                # fall back to simply looking for "v_view_name", and then finally  "view_name".
+                unversioned = "v_#{unversioned}"
+                view_relation ||= ::Brick.relations.fetch(found = unversioned,
+                                                          ::Brick.relations.fetch(found = unversioned, nil)
+                                                         )
+                if found && view_relation && k != (found = unversioned)
+                  view_relation[:api][api_ver_num] = found
+                end
+              end
+
+              # view_ver_num = if (first_part = k.split('_').first) =~ /^v[\d_]+/
+              #                  first_part[1..-1].gsub('_', '.').to_i
+              #                end
+              controller_name = view_relation.fetch(:resource, nil)&.pluralize if view_relation
+              if schema_name
+                full_resource = "#{schema_name}/#{found || v[:resource]}"
+                send(:get, "#{api_root}#{full_resource}", { to: "#{controller_prefix}#{schema_name}/#{controller_name}#index" })
+              else
+                # Normally goes to something like:  /api/v1/employees
+                send(:get, "#{api_root}#{found || v[:resource]}", { to: "#{controller_prefix}#{controller_name}#index" })
+              end
             end
 
             # Track routes being built
@@ -716,15 +767,19 @@ In config/initializers/brick.rb appropriate entries would look something like:
           unless ::Brick.routes_done
             if Object.const_defined?('Rswag::Ui')
               rswag_path = ::Rails.application.routes.routes.find { |r| r.app.app == Rswag::Ui::Engine }&.instance_variable_get(:@path_formatter)&.instance_variable_get(:@parts)&.join
-              if (doc_endpoint = Rswag::Ui.config.config_object[:urls]&.last)
+              first_endpoint_parts = nil
+              (doc_endpoints = Rswag::Ui.config.config_object[:urls]&.uniq!)&.each do |doc_endpoint|
                 puts "Mounting OpenApi 3.0 documentation endpoint for \"#{doc_endpoint[:name]}\" on #{doc_endpoint[:url]}"
                 send(:get, doc_endpoint[:url], { to: 'brick_openapi#index' })
                 endpoint_parts = doc_endpoint[:url]&.split('/')
-                if rswag_path && endpoint_parts
-                  puts "API documentation now available when navigating to:  /#{endpoint_parts&.find(&:present?)}/index.html"
+                first_endpoint_parts ||= endpoint_parts
+              end
+              if doc_endpoints.present?
+                if rswag_path && first_endpoint_parts
+                  puts "API documentation now available when navigating to:  /#{first_endpoint_parts&.find(&:present?)}/index.html"
                 else
                   puts "In order to make documentation available you can put this into your routes.rb:"
-                  puts "  mount Rswag::Ui::Engine => '/#{endpoint_parts&.find(&:present?) || 'api-docs'}'"
+                  puts "  mount Rswag::Ui::Engine => '/#{first_endpoint_parts&.find(&:present?) || 'api-docs'}'"
                 end
               else
                 sample_path = rswag_path || '/api-docs'

data/lib/generators/brick/install_generator.rb

@@ -159,8 +159,9 @@ if ActiveRecord::Base.respond_to?(:brick_select)
   # Brick.enable_views = true # Setting this to \"false\" will disable views in development
 
   # # If The Brick sees that RSwag gem is present, it allows for API resources to be automatically served out.
-  # # You can configure the root path for these resources:
-  # ::Brick.api_root = '/api/v1/'
+  # # You can configure one or more root path(s) for these resources, and when there are multiple then an attempt
+  # # is made to return data from that version of the view or table name, or the most recent prior to that version:
+  # ::Brick.api_roots = ['/api/v1/']
   # # You may also want to add an OpenAPI 3.0 documentation endpoint using Rswag::Ui:
   # Rswag::Ui.configure do |config|
   #   config.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.104
+  version: 1.0.105
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement