brick 1.0.112 → 1.0.114

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69051263cec00b3672b8d48b0c595ff6875b81f27e7995be72a03d6699ad6d02
-  data.tar.gz: 217687ad2f6b93c33dc781f5930a0475a60fb27d782593109055beaae19f4e55
+  metadata.gz: 5006a6dabf5c9e86965e57a40ae344f9d67c2fc5e76caec8a00e978117089062
+  data.tar.gz: 5bd0fef75e305514b4ef22e4930660cdbf9385c22b07ee92d6eb77a626a13943
 SHA512:
-  metadata.gz: 6eff4c8a9f59673d14be1d890b067e17e631b1d6938a22b81c1ec45c3785489195d5d9e93939a38c681d36d844df2ad9a932584d8269b0fd2ef678de428c805c
-  data.tar.gz: 723425258d449708f18e086f289147b3402f728c93fbcba3a16654c3d15b4fe715022e427cb3f87e731bf9b73d693a5d4f43a500bdbde3641b69ac61e4c35e35
+  metadata.gz: b0621761d15baec575a9cd16fdb1b22e9a1d4784308c071d9878121ac841f6cf7419cb6fbcc210afad2ce98a69814c27279dc951a5d84750e7573e203d2f806a
+  data.tar.gz: ed4b5c992076b4f28c85ab8af48bab847ab80105f2999371475529219cc6b0053444dc722a700d686fc7ed7ea39d3d939cb448c43d798bde18a0b5cfd80be23e

data/lib/brick/config.rb

@@ -213,6 +213,14 @@ module Brick
       @mutex.synchronize { @polymorphics = polys }
     end
 
+    def json_columns
+      @mutex.synchronize { @json_columns ||= {} }
+    end
+
+    def json_columns=(cols)
+      @mutex.synchronize { @json_columns = cols }
+    end
+
     def model_descrips
       @mutex.synchronize { @model_descrips ||= {} }
     end

data/lib/brick/extensions.rb

@@ -274,7 +274,7 @@ module ActiveRecord
       tbl_parts.unshift(::Brick.config.path_prefix) if ::Brick.config.path_prefix
       index = tbl_parts.map(&:underscore).join(separator)
       # Rails applies an _index suffix to that route when the resource name is singular
-      index << '_index' if mode != :singular && index == index.singularize
+      index << '_index' if mode != :singular && separator == '_' && index == index.singularize
       index
     end
 
@@ -1602,11 +1602,11 @@ class Object
                                       else
                                         relation.last[:cols]
                                       end
-                    { :index => [:get, 'list'], :create => [:post, 'create a'] }.each do |k, v|
+                    { :index => [:get, 'list', true], :create => [:post, 'create a', false] }.each do |k, v|
                       unless actions&.exclude?(k)
                         this_resource = (s["#{current_api_root}#{relation_name}"] ||= {})
                         this_resource[v.first] = {
-                          'summary': "#{v[1]} #{relation.first}",
+                          'summary': "#{v[1]} #{relation.first.send(v[2] ? :pluralize : :singularize)}",
                           'description': table_description,
                           'parameters': renamed_columns.map do |k2, v2|
                                           param = { in: 'query', 'name': k2, 'schema': { 'type': v2.first } }
@@ -1841,7 +1841,19 @@ class Object
               end
 
               instance_variable_set("@#{singular_table_name}".to_sym, (obj = find_obj))
-              obj.send(:update, send(params_name_sym))
+              upd_params = send(params_name_sym)
+              if (json_cols = model.columns.select { |c| c.type == :json }.map(&:name)).present?
+                upd_hash = upd_params.to_h
+                json_cols.each do |c|
+                  begin
+                    upd_hash[c] = JSON.parse(upd_hash[c]) # At least attempt to turn this into a parsed hash or array object
+                  rescue
+                  end
+                end
+                obj.send(:update, upd_hash)
+              else
+                obj.send(:update, upd_params)
+              end
             end
 
             code << "  def destroy\n"
@@ -1865,11 +1877,14 @@ class Object
     @#{singular_table_name} = #{model.name}.find(id.is_a?(Array) && id.length == 1 ? id.first : id)
   end\n"
             self.define_method :find_obj do
-              id = if model.columns_hash[pk.first]&.type == :string
-                     is_pk_string = true
+              id = if pk.length == 1 # && model.columns_hash[pk.first]&.type == :string
                      params[:id].gsub('^^sl^^', '/')
                    else
-                     params[:id]&.split(/[\/,_]/).map do |val_part|
+                     if model.columns_hash[pk.first]&.type == :string
+                       params[:id]&.split('/')
+                     else
+                       params[:id]&.split(/[\/,_]/)
+                     end.map do |val_part|
                        val_part.gsub('^^sl^^', '/')
                      end
                    end

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

@@ -245,7 +245,7 @@ window.addEventListener(\"popstate\", linkSchemas);
                 @_name = name || ''
               end
               def to_s
-                @_name.html_safe + @vc.instance_variable_get(:@__vc_helpers)&.link_to_brick(nil,
+                @_name.to_s.html_safe + @vc.instance_variable_get(:@__vc_helpers)&.link_to_brick(nil,
                   "<svg version=\"1.1\" style=\"display: inline; padding-left: 0.5em;\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"
   viewBox=\"0 0 58 58\" height=\"1.4em\" xml:space=\"preserve\">
 <g>
@@ -304,6 +304,26 @@ window.addEventListener(\"popstate\", linkSchemas);
           end
         end # Avo compatibility
 
+        # ActiveAdmin compatibility
+        if Object.const_defined?('ActiveAdmin') && ::ActiveAdmin.application&.site_title.present?
+          ::ActiveAdmin.class_exec do
+            class << self
+              ActiveAdmin.load!
+              alias _brick_routes routes
+              def routes(*args)
+                ::Brick.relations.each do |k, v|
+                  next if k == 'active_admin_comments'
+
+                  if (class_name = Object.const_get(v.fetch(:class_name, nil)))
+                    ::ActiveAdmin.register(class_name) { config.clear_batch_actions! }
+                  end
+                end
+                _brick_routes(*args)
+              end
+            end
+          end
+        end
+
         # ====================================
         # Dynamically create generic templates
         # ====================================
@@ -648,15 +668,19 @@ input+svg.revert {
 </style>
 
 <% is_includes_dates = nil
+   is_includes_json = nil
 def is_bcrypt?(val)
   val.is_a?(String) && val.length == 60 && val.start_with?('$2a$')
 end
-def hide_bcrypt(val, max_len = 200)
+def hide_bcrypt(val, is_xml = nil, max_len = 200)
   if is_bcrypt?(val)
     '(hidden)'
   else
     if val.is_a?(String)
-      if (val = val.dup.strip).length > max_len
+      val = val.dup.force_encoding('UTF-8').strip
+      return CGI.escapeHTML(val) if is_xml
+
+      if val.length > max_len
         if val[0] == '<' # Seems to be HTML?
           cur_len = 0
           cur_idx = 0
@@ -703,7 +727,6 @@ def hide_bcrypt(val, max_len = 200)
         end
         val = \"#\{val}...\"
       end
-      val = val.dup.force_encoding('UTF-8') unless val.encoding.name == 'UTF-8'
       val
     else
       val.to_s
@@ -768,7 +791,7 @@ def display_value(col_type, val)
     display_binary(val) if val
   else
     if col_type
-      hide_bcrypt(val)
+      hide_bcrypt(val, col_type == :xml)
     else
       '?'
     end
@@ -1362,7 +1385,7 @@ erDiagram
 <% end %>
 </table>
 <%
-if (description = (relation = Brick.relations[#{model_name}.table_name])&.fetch(:description, nil)) %><%=
+if (description = (relation = Brick.relations[tbl_name = #{model_name}.table_name])&.fetch(:description, nil)) %><%=
   description %><br><%
 end
 %><%= link_to '(See all #{obj_name.pluralize})', #{@_brick_model._brick_index}_path %>
@@ -1434,12 +1457,18 @@ end
             \"<span class=\\\"orphan\\\">Orphaned ID: #\{val}</span>\".html_safe
           end %>
     <% else
-      col_type = col&.sql_type == 'geography' ? col.sql_type : col&.type
+      col_type = if ::Brick.config.json_columns[tbl_name]&.include?(k)
+                   :json
+                 elsif col&.sql_type == 'geography'
+                   col.sql_type
+                 else
+                   col&.type
+                 end
       case (col_type ||= col&.sql_type)
       when :string, :text %>
         <% if is_bcrypt?(val) # || .readonly?
              is_revert = false %>
-          <%= hide_bcrypt(val, 1000) %>
+          <%= hide_bcrypt(val, nil, 1000) %>
         <% else %>
           <%= f.text_field(k.to_sym, html_options) %>
         <% end %>
@@ -1476,6 +1505,13 @@ end
            end %>
       <% when :primary_key
            is_revert = false %>
+      <% when :json
+           is_includes_json = true %>
+        <%= # Because there are so danged many quotes in JSON, escape them specially by converting to backticks.
+            # (and previous to this, escape backticks with our own goofy code of ^^br_btick__ )
+            val_str = val.is_a?(String) ? val : val.to_json # Clean up bogus JSON if necessary
+            json_field = f.hidden_field k.to_sym, { class: 'jsonpicker', value: val_str.gsub('`', '^^br_btick__').tr('\"', '`').html_safe } %>
+        <div id=\"_br_json_<%= f.field_id(k) %>\"></div>
       <% else %>
         <%= is_revert = false
            display_value(col_type, val).html_safe %>
@@ -1579,6 +1615,35 @@ flatpickr(\".timepicker\", {enableTime: true, noCalendar: true});
 <link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdnjs.cloudflare.com/ajax/libs/slim-select/1.27.1/slimselect.min.css\">
 <% end %>
 
+<% # Started with v0.14.4 of vanilla-jsoneditor
+   if is_includes_json %>
+<link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdn.jsdelivr.net/npm/vanilla-jsoneditor/themes/jse-theme-default.min.css\">
+<script type=\"module\">
+  import { JSONEditor } from \"https://cdn.jsdelivr.net/npm/vanilla-jsoneditor/index.min.js\";
+  document.querySelectorAll(\"input.jsonpicker\").forEach(function (inp) {
+    var jsonDiv;
+    if (jsonDiv = document.getElementById(\"_br_json_\" + inp.id)) {
+      new JSONEditor({
+        target: jsonDiv,
+        props: {
+          // Instead of text can also do: { json: JSONValue }
+          // Other options:  name: \"taco\", mode: \"tree\", navigationBar: false, mainMenuBar: false, statusBar: false, search: false, templates:, history: false
+          content: {text: inp.value.replace(/`/g, '\"').replace(/\\^\\^br_btick__/g, \"`\")},
+          onChange: (function (inp2) {
+            return function (updatedContent, previousContent, contentErrors, patchResult) {
+              // console.log('onChange', updatedContent.json, updatedContent.text);
+              inp2.value = updatedContent.text || JSON.stringify(updatedContent.json);
+            };
+          })(inp)
+        }
+      });
+    } else {
+      console.log(\"Could not find JSON picker for \" + inp.id);
+    }
+  });
+</script>
+<% end %>
+
 <% if true # @_brick_erd
 %>
 <script>

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

@@ -116,7 +116,7 @@ module Brick::Rails::FormTags
             end
           end
         elsif (col = cols[col_name]).is_a?(ActiveRecord::ConnectionAdapters::Column)
-          binding.pry if col.is_a?(Array)
+          # binding.pry if col.is_a?(Array)
           col_type = col&.sql_type == 'geography' ? col.sql_type : col&.type
           out << display_value(col_type || col&.sql_type, val).to_s
         elsif cust_col
@@ -201,7 +201,8 @@ module Brick::Rails::FormTags
       end
       filter = "?#{filter_parts.join('&')}" if filter_parts.present?
       app_routes = Rails.application.routes # In case we're operating in another engine, reference the application since Brick routes are placed there.
-      relation = ::Brick.relations.fetch(rel_name || args.first.table_name, nil)
+      klass = klass_or_obj.is_a?(ActiveRecord::Base) ? klass_or_obj.class : klass_or_obj
+      relation = ::Brick.relations.fetch(rel_name || klass.table_name, nil)
       if (klass_or_obj&.is_a?(Class) && klass_or_obj < ActiveRecord::Base) ||
          (klass_or_obj&.is_a?(ActiveRecord::Base) && klass_or_obj.new_record? && (klass_or_obj = klass_or_obj.class))
         path = (proc = kwargs[:index_proc]) ? proc.call(klass_or_obj, relation) : "#{app_routes.path_for(controller: klass_or_obj.base_class._brick_index(nil, '/', relation), action: :index)}#{filter}"

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -458,6 +458,11 @@ module Brick
       Brick.config.polymorphics = polys || {}
     end
 
+    # @api public
+    def json_columns=(cols)
+      Brick.config.json_columns = cols
+    end
+
     # DSL templates for individual models to provide prettier descriptions of objects
     # @api public
     def model_descrips=(descrips)
@@ -529,7 +534,7 @@ module Brick
 You might be missing an STI namespace prefix entry for these tables:  #{missing_stis.keys.join(', ')}.
 In config/initializers/brick.rb appropriate entries would look something like:
   Brick.sti_namespace_prefixes = {"
-            puts missing_stis.map { |_k, missing_sti| "\n    '::#{missing_sti}' => 'SomeParentModel'" }.join(',')
+            puts missing_stis.map { |_k, missing_sti| "\n    '#{missing_sti}' => 'SomeParentModel'" }.join(',')
             puts "  }
 (Just trade out SomeParentModel with some more appropriate one.)"
           end
@@ -654,205 +659,205 @@ In config/initializers/brick.rb appropriate entries would look something like:
 
   module RouteSet
     def finalize!
-      # %%% Was: ::Rails.application.routes.named_routes.route_defined?(:brick_status_path)
-      unless ::Rails.application.routes.named_routes.names.include?(:brick_status)
-        path_prefix = ::Brick.config.path_prefix
-        existing_controllers = routes.each_with_object({}) do |r, s|
-          c = r.defaults[:controller]
-          s[c] = nil if c
+      routeset_to_use = ::Rails.application.routes
+      return super unless self == routeset_to_use
+
+      path_prefix = ::Brick.config.path_prefix
+      existing_controllers = routes.each_with_object({}) do |r, s|
+        c = r.defaults[:controller]
+        s[c] = nil if c
+      end
+      append do
+        tables = []
+        views = []
+        table_class_length = 38 # Length of "Classes that can be built from tables:"
+        view_class_length = 37 # Length of "Classes that can be built from views:"
+
+        brick_namespace_create = lambda do |path_names, res_name, options|
+          if path_names&.present?
+            if (path_name = path_names.pop).is_a?(Array)
+              module_name = path_name[1]
+              path_name = path_name.first
+            end
+            send(:scope, { module: module_name || path_name, path: path_name, as: path_name }) do
+              brick_namespace_create.call(path_names, res_name, options)
+            end
+          else
+            send(:resources, res_name.to_sym, **options)
+          end
         end
-        ::Rails.application.routes.append do
-          tables = []
-          views = []
-          table_class_length = 38 # Length of "Classes that can be built from tables:"
-          view_class_length = 37 # Length of "Classes that can be built from views:"
-
-          brick_namespace_create = lambda do |path_names, res_name, options|
-            if path_names&.present?
-              if (path_name = path_names.pop).is_a?(Array)
-                module_name = path_name[1]
-                path_name = path_name.first
-              end
-              send(:scope, { module: module_name || path_name, path: path_name, as: path_name }) do
-                brick_namespace_create.call(path_names, res_name, options)
-              end
+
+        # %%% TODO: If no auto-controllers then enumerate the controllers folder in order to build matching routes
+        # If auto-controllers and auto-models are both enabled then this makes sense:
+        controller_prefix = (path_prefix ? "#{path_prefix}/" : '')
+        sti_subclasses = ::Brick.config.sti_namespace_prefixes.each_with_object(Hash.new { |h, k| h[k] = [] }) do |v, s|
+                            # 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|
+          if (schema_name = v.fetch(:schema, nil))
+            schema_prefix = "#{schema_name}."
+          end
+
+          next if !(resource_name = v.fetch(:resource, nil)) ||
+                  existing_controllers.key?(
+                    controller_prefix + (resource_name = "#{schema_prefix&.tr('.', '/')}#{resource_name}".pluralize)
+                  )
+
+          object_name = k.split('.').last # Take off any first schema part
+
+          full_schema_prefix = if (aps = v.fetch(:auto_prefixed_schema, nil))
+                                  aps = aps[0..-2] if aps[-1] == '_'
+                                  (schema_prefix&.dup || +'') << "#{aps}."
+                                else
+                                  schema_prefix
+                                end
+
+          # Track routes being built
+          if (class_name = v.fetch(:class_name, nil))
+            if v.key?(:isView)
+              view_class_length = class_name.length if class_name.length > view_class_length
+              views
             else
-              send(:resources, res_name.to_sym, **options)
-            end
+              table_class_length = class_name.length if class_name.length > table_class_length
+              tables
+            end << [class_name, aps, resource_name]
           end
 
-          # %%% TODO: If no auto-controllers then enumerate the controllers folder in order to build matching routes
-          # If auto-controllers and auto-models are both enabled then this makes sense:
-          controller_prefix = (path_prefix ? "#{path_prefix}/" : '')
-          sti_subclasses = ::Brick.config.sti_namespace_prefixes.each_with_object(Hash.new { |h, k| h[k] = [] }) do |v, s|
-                             # 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|
-            if (schema_name = v.fetch(:schema, nil))
-              schema_prefix = "#{schema_name}."
-            end
+          options = {}
+          options[:only] = [:index, :show] if v.key?(:isView)
+
+          # First do the normal routes
+          prefixes = []
+          prefixes << [aps, v[:class_name]&.split('::')[-2]&.underscore] if aps
+          prefixes << schema_name if schema_name
+          prefixes << path_prefix if path_prefix
+          brick_namespace_create.call(prefixes, v[:resource], options)
+          sti_subclasses.fetch(class_name, nil)&.each do |sc| # Add any STI subclass routes for this relation
+            brick_namespace_create.call(prefixes, sc.underscore.tr('/', '_').pluralize, options)
+          end
 
-            next if !(resource_name = v.fetch(:resource, nil)) ||
-                    existing_controllers.key?(controller_name = (
-                                                resource_name = "#{schema_prefix&.tr('.', '/')}#{resource_name}"
-                                             ).pluralize)
-
-            object_name = k.split('.').last # Take off any first schema part
-
-            full_schema_prefix = if (aps = v.fetch(:auto_prefixed_schema, nil))
-                                   aps = aps[0..-2] if aps[-1] == '_'
-                                   (schema_prefix&.dup || +'') << "#{aps}."
-                                 else
-                                   schema_prefix
-                                 end
-
-            # Track routes being built
-            if (class_name = v.fetch(:class_name, nil))
-              if v.key?(:isView)
-                view_class_length = class_name.length if class_name.length > view_class_length
-                views
+          # Now the API routes if necessary
+          full_resource = nil
+          ::Brick.api_roots&.each do |api_root|
+            api_done_views = (versioned_views[api_root] ||= {})
+            found = nil
+            test_ver_num = 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)
+              if (ver = object_name.match(/^v([\d_]*)/)&.captures&.first) && ver[-1] == '_'
+                core_object_name = object_name[ver.length + 1..-1]
+                next if api_done_views.key?(unversioned = "#{schema_prefix}v_#{core_object_name}")
+
+                # 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
+                test_ver_num = 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
+
+                test_ver_num -= 1 until test_ver_num.zero? ||
+                                        (view_relation = ::Brick.relations.fetch(
+                                          found = "#{schema_prefix}v#{test_ver_num}_#{core_object_name}", 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".
+                no_v_prefix_name = "#{schema_prefix}#{core_object_name}"
+                standard_prefix = 'v_'
               else
-                table_class_length = class_name.length if class_name.length > table_class_length
-                tables
-              end << [class_name, aps, resource_name]
-            end
-
-            options = {}
-            options[:only] = [:index, :show] if v.key?(:isView)
-
-            # First do the normal routes
-            prefixes = []
-            prefixes << [aps, v[:class_name]&.split('::')[-2]&.underscore] if aps
-            prefixes << schema_name if schema_name
-            prefixes << path_prefix if path_prefix
-            brick_namespace_create.call(prefixes, v[:resource], options)
-            sti_subclasses.fetch(class_name, nil)&.each do |sc| # Add any STI subclass routes for this relation
-              brick_namespace_create.call(prefixes, sc.underscore.tr('/', '_').pluralize, options)
+                core_object_name = object_name
+              end
+              if (rvp = ::Brick.config.api_remove_view_prefix) && core_object_name.start_with?(rvp)
+                core_object_name.slice!(0, rvp.length)
+              end
+              no_prefix_name = "#{schema_prefix}#{core_object_name}"
+              unversioned = "#{schema_prefix}#{standard_prefix}#{::Brick.config.api_add_view_prefix}#{core_object_name}"
+            else
+              unversioned = k
             end
 
-            # Now the API routes if necessary
-            full_resource = nil
-            ::Brick.api_roots&.each do |api_root|
-              api_done_views = (versioned_views[api_root] ||= {})
-              found = nil
-              test_ver_num = 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)
-                if (ver = object_name.match(/^v([\d_]*)/)&.captures&.first) && ver[-1] == '_'
-                  core_object_name = object_name[ver.length + 1..-1]
-                  next if api_done_views.key?(unversioned = "#{schema_prefix}v_#{core_object_name}")
-
-                  # 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
-                  test_ver_num = 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
-
-                  test_ver_num -= 1 until test_ver_num.zero? ||
-                                          (view_relation = ::Brick.relations.fetch(
-                                            found = "#{schema_prefix}v#{test_ver_num}_#{core_object_name}", 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".
-                  no_v_prefix_name = "#{schema_prefix}#{core_object_name}"
-                  standard_prefix = 'v_'
-                else
-                  core_object_name = object_name
-                end
-                if (rvp = ::Brick.config.api_remove_view_prefix) && core_object_name.start_with?(rvp)
-                  core_object_name.slice!(0, rvp.length)
+            view_relation ||= ::Brick.relations.fetch(found = unversioned, nil) ||
+                              (no_v_prefix_name && ::Brick.relations.fetch(found = no_v_prefix_name, nil)) ||
+                              (no_prefix_name && ::Brick.relations.fetch(found = no_prefix_name, nil))
+            if view_relation
+              actions = view_relation.key?(:isView) ? [:index, :show] : ::Brick::ALL_API_ACTIONS # By default all actions are allowed
+              # Call proc that limits which endpoints get surfaced based on version, table or view name, method (get list / get one / post / patch / delete)
+              # Returning nil makes it do nothing, false makes it skip creating this endpoint, and an array of up to
+              # these 3 things controls and changes the nature of the endpoint that gets built:
+              # (updated api_name, name of different relation to route to, allowed actions such as :index, :show, :create, etc)
+              proc_result = if (filter = ::Brick.config.api_filter).is_a?(Proc)
+                              begin
+                                num_args = filter.arity.negative? ? 6 : filter.arity
+                                filter.call(*[unversioned, k, view_relation, actions, api_ver_num, found, test_ver_num][0...num_args])
+                              rescue StandardError => e
+                                puts "::Brick.api_filter Proc error: #{e.message}"
+                              end
+                            end
+              # proc_result expects to receive back: [updated_api_name, to_other_relation, allowed_actions]
+
+              case proc_result
+              when NilClass
+                # Do nothing differently than what normal behaviour would be
+              when FalseClass # Skip implementing this endpoint
+                view_relation[:api][api_ver_num] = nil
+                next
+              when Array # Did they give back an array of actions?
+                unless proc_result.any? { |pr| ::Brick::ALL_API_ACTIONS.exclude?(pr) }
+                  proc_result = [unversioned, to_relation, proc_result]
                 end
-                no_prefix_name = "#{schema_prefix}#{core_object_name}"
-                unversioned = "#{schema_prefix}#{standard_prefix}#{::Brick.config.api_add_view_prefix}#{core_object_name}"
+                # Otherwise don't change this array because it's probably legit
+              when String
+                proc_result = [proc_result] # Treat this as the surfaced api_name (path) they want to use for this endpoint
               else
-                unversioned = k
+                puts "::Brick.api_filter Proc warning: Unable to parse this result returned: \n  #{proc_result.inspect}"
+                proc_result = nil # Couldn't understand what in the world was returned
               end
 
-              view_relation ||= ::Brick.relations.fetch(found = unversioned, nil) ||
-                                (no_v_prefix_name && ::Brick.relations.fetch(found = no_v_prefix_name, nil)) ||
-                                (no_prefix_name && ::Brick.relations.fetch(found = no_prefix_name, nil))
-              if view_relation
-                actions = view_relation.key?(:isView) ? [:index, :show] : ::Brick::ALL_API_ACTIONS # By default all actions are allowed
-                # Call proc that limits which endpoints get surfaced based on version, table or view name, method (get list / get one / post / patch / delete)
-                # Returning nil makes it do nothing, false makes it skip creating this endpoint, and an array of up to
-                # these 3 things controls and changes the nature of the endpoint that gets built:
-                # (updated api_name, name of different relation to route to, allowed actions such as :index, :show, :create, etc)
-                proc_result = if (filter = ::Brick.config.api_filter).is_a?(Proc)
-                                begin
-                                  num_args = filter.arity.negative? ? 6 : filter.arity
-                                  filter.call(*[unversioned, k, view_relation, actions, api_ver_num, found, test_ver_num][0...num_args])
-                                rescue StandardError => e
-                                  puts "::Brick.api_filter Proc error: #{e.message}"
-                                end
-                              end
-                # proc_result expects to receive back: [updated_api_name, to_other_relation, allowed_actions]
-
-                case proc_result
-                when NilClass
-                  # Do nothing differently than what normal behaviour would be
-                when FalseClass # Skip implementing this endpoint
-                  view_relation[:api][api_ver_num] = nil
-                  next
-                when Array # Did they give back an array of actions?
-                  unless proc_result.any? { |pr| ::Brick::ALL_API_ACTIONS.exclude?(pr) }
-                    proc_result = [unversioned, to_relation, proc_result]
+              if proc_result&.present?
+                if proc_result[1] # to_other_relation
+                  if (new_view_relation = ::Brick.relations.fetch(proc_result[1], nil))
+                    k = proc_result[1] # Route this call over to this different relation
+                    view_relation = new_view_relation
+                  else
+                    puts "::Brick.api_filter Proc warning: Unable to find new suggested relation with name #{proc_result[1]} -- sticking with #{k} instead."
                   end
-                  # Otherwise don't change this array because it's probably legit
-                when String
-                  proc_result = [proc_result] # Treat this as the surfaced api_name (path) they want to use for this endpoint
-                else
-                  puts "::Brick.api_filter Proc warning: Unable to parse this result returned: \n  #{proc_result.inspect}"
-                  proc_result = nil # Couldn't understand what in the world was returned
                 end
-
-                if proc_result&.present?
-                  if proc_result[1] # to_other_relation
-                    if (new_view_relation = ::Brick.relations.fetch(proc_result[1], nil))
-                      k = proc_result[1] # Route this call over to this different relation
-                      view_relation = new_view_relation
-                    else
-                      puts "::Brick.api_filter Proc warning: Unable to find new suggested relation with name #{proc_result[1]} -- sticking with #{k} instead."
-                    end
-                  end
-                  if proc_result.first&.!=(k) # updated_api_name -- a different name than this relation would normally have
-                    found = proc_result.first
-                  end
-                  actions &= proc_result[2] if proc_result[2] # allowed_actions
+                if proc_result.first&.!=(k) # updated_api_name -- a different name than this relation would normally have
+                  found = proc_result.first
                 end
-                (view_relation[:api][api_ver_num] ||= {})[unversioned] = actions # Add to the list of API paths this resource responds to
-
-                # view_ver_num = if (first_part = k.split('_').first) =~ /^v[\d_]+/
-                #                  first_part[1..-1].gsub('_', '.').to_i
-                #                end
-                controller_name = if (last = view_relation.fetch(:resource, nil)&.pluralize)
-                                    "#{full_schema_prefix}#{last}"
-                                  else
-                                    found
-                                  end.tr('.', '/')
-
-                { :index => 'get', :create => 'post' }.each do |action, method|
-                  if actions.include?(action)
-                    # Normally goes to something like:  /api/v1/employees
-                    send(method, "#{api_root}#{unversioned.tr('.', '/')}", { to: "#{controller_prefix}#{controller_name}##{action}" })
-                  end
+                actions &= proc_result[2] if proc_result[2] # allowed_actions
+              end
+              (view_relation[:api][api_ver_num] ||= {})[unversioned] = actions # Add to the list of API paths this resource responds to
+
+              # view_ver_num = if (first_part = k.split('_').first) =~ /^v[\d_]+/
+              #                  first_part[1..-1].gsub('_', '.').to_i
+              #                end
+              controller_name = if (last = view_relation.fetch(:resource, nil)&.pluralize)
+                                  "#{full_schema_prefix}#{last}"
+                                else
+                                  found
+                                end.tr('.', '/')
+
+              { :index => 'get', :create => 'post' }.each do |action, method|
+                if actions.include?(action)
+                  # Normally goes to something like:  /api/v1/employees
+                  send(method, "#{api_root}#{unversioned.tr('.', '/')}", { to: "#{controller_prefix}#{controller_name}##{action}" })
                 end
-                # %%% We do not yet surface the #show action
-                if (id_col = view_relation[:pk]&.first) # ID-dependent stuff
-                  { :update => ['put', 'patch'], :destroy => ['delete'] }.each do |action, methods|
-                    if actions.include?(action)
-                      methods.each do |method|
-                        send(method, "#{api_root}#{unversioned.tr('.', '/')}/:#{id_col}", { to: "#{controller_prefix}#{controller_name}##{action}" })
-                      end
+              end
+              # %%% We do not yet surface the #show action
+              if (id_col = view_relation[:pk]&.first) # ID-dependent stuff
+                { :update => ['put', 'patch'], :destroy => ['delete'] }.each do |action, methods|
+                  if actions.include?(action)
+                    methods.each do |method|
+                      send(method, "#{api_root}#{unversioned.tr('.', '/')}/:#{id_col}", { to: "#{controller_prefix}#{controller_name}##{action}" })
                     end
                   end
                 end
@@ -860,64 +865,72 @@ In config/initializers/brick.rb appropriate entries would look something like:
             end
           end
 
-          if ::Brick.config.add_status && instance_variable_get(:@set).named_routes.names.exclude?(:brick_status)
-            get("/#{controller_prefix}brick_status", to: 'brick_gem#status', as: 'brick_status')
+          # Trestle compatibility
+          if Object.const_defined?('Trestle') && ::Trestle.config.options&.key?(:site_title) &&
+             !Object.const_defined?("#{resource_name.camelize}Admin")
+            ::Trestle.resource(res_sym = k.to_sym) do
+              menu { item res_sym, icon: "fa fa-star" }
+            end
           end
+        end
 
-          if ::Brick.config.add_orphans && instance_variable_get(:@set).named_routes.names.exclude?(:brick_orphans)
-            get("/#{controller_prefix}brick_orphans", to: 'brick_gem#orphans', as: 'brick_orphans')
-          end
+        if ::Brick.config.add_status && instance_variable_get(:@set).named_routes.names.exclude?(:brick_status)
+          get("/#{controller_prefix}brick_status", to: 'brick_gem#status', as: 'brick_status')
+        end
 
-          if instance_variable_get(:@set).named_routes.names.exclude?(:brick_crosstab)
-            get("/#{controller_prefix}brick_crosstab", to: 'brick_gem#crosstab', as: 'brick_crosstab')
-            get("/#{controller_prefix}brick_crosstab/data", to: 'brick_gem#crosstab_data')
-          end
+        if ::Brick.config.add_orphans && instance_variable_get(:@set).named_routes.names.exclude?(:brick_orphans)
+          get("/#{controller_prefix}brick_orphans", to: 'brick_gem#orphans', as: 'brick_orphans')
+        end
 
-          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
-              first_endpoint_parts = nil
-              (doc_endpoints = Rswag::Ui.config.config_object[:urls])&.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('/')
-                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 => '/#{first_endpoint_parts&.find(&:present?) || 'api-docs'}'"
-                end
+        if instance_variable_get(:@set).named_routes.names.exclude?(:brick_crosstab)
+          get("/#{controller_prefix}brick_crosstab", to: 'brick_gem#crosstab', as: 'brick_crosstab')
+          get("/#{controller_prefix}brick_crosstab/data", to: 'brick_gem#crosstab_data')
+        end
+
+        unless ::Brick.routes_done
+          if Object.const_defined?('Rswag::Ui')
+            rswag_path = routeset_to_use.routes.find { |r| r.app.app == Rswag::Ui::Engine }&.instance_variable_get(:@path_formatter)&.instance_variable_get(:@parts)&.join
+            first_endpoint_parts = nil
+            (doc_endpoints = Rswag::Ui.config.config_object[:urls])&.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('/')
+              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
-                sample_path = rswag_path || '/api-docs'
+                puts "In order to make documentation available you can put this into your routes.rb:"
+                puts "  mount Rswag::Ui::Engine => '/#{first_endpoint_parts&.find(&:present?) || 'api-docs'}'"
+              end
+            else
+              sample_path = rswag_path || '/api-docs'
+              puts
+              puts "Brick:  rswag-ui gem detected -- to make OpenAPI 3.0 documentation available from a path such as  '#{sample_path}/v1/swagger.json',"
+              puts '        put code such as this in an initializer:'
+              puts '  Rswag::Ui.configure do |config|'
+              puts "    config.swagger_endpoint '#{sample_path}/v1/swagger.json', 'API V1 Docs'"
+              puts '  end'
+              unless rswag_path
                 puts
-                puts "Brick:  rswag-ui gem detected -- to make OpenAPI 3.0 documentation available from a path such as  '#{sample_path}/v1/swagger.json',"
-                puts '        put code such as this in an initializer:'
-                puts '  Rswag::Ui.configure do |config|'
-                puts "    config.swagger_endpoint '#{sample_path}/v1/swagger.json', 'API V1 Docs'"
-                puts '  end'
-                unless rswag_path
-                  puts
-                  puts '        and put this into your routes.rb:'
-                  puts "  mount Rswag::Ui::Engine => '/api-docs'"
-                end
+                puts '        and put this into your routes.rb:'
+                puts "  mount Rswag::Ui::Engine => '/api-docs'"
               end
             end
+          end
 
-            ::Brick.routes_done = true
-            puts "\n" if tables.present? || views.present?
-            if tables.present?
-              puts "Classes that can be built from tables:#{' ' * (table_class_length - 38)}  Path:"
-              puts "======================================#{' ' * (table_class_length - 38)}  ====="
-              ::Brick.display_classes(controller_prefix, tables, table_class_length)
-            end
-            if views.present?
-              puts "Classes that can be built from views:#{' ' * (view_class_length - 37)}  Path:"
-              puts "=====================================#{' ' * (view_class_length - 37)}  ====="
-              ::Brick.display_classes(controller_prefix, views, view_class_length)
-            end
+          ::Brick.routes_done = true
+          puts "\n" if tables.present? || views.present?
+          if tables.present?
+            puts "Classes that can be built from tables:#{' ' * (table_class_length - 38)}  Path:"
+            puts "======================================#{' ' * (table_class_length - 38)}  ====="
+            ::Brick.display_classes(controller_prefix, tables, table_class_length)
+          end
+          if views.present?
+            puts "Classes that can be built from views:#{' ' * (view_class_length - 37)}  Path:"
+            puts "=====================================#{' ' * (view_class_length - 37)}  ====="
+            ::Brick.display_classes(controller_prefix, views, view_class_length)
           end
         end
       end

data/lib/generators/brick/install_generator.rb

@@ -261,6 +261,10 @@ if ActiveRecord::Base.respond_to?(:brick_select) && !::Brick.initializer_loaded
   # # Designated by <table name>.<column name>
   # Brick.not_nullables = ['users.name']
 
+  # # String or text columns which for editing purposes should be treated as JSON.  Format for the hash is:
+  # # { table_name => [column names] }
+  # Brick.json_columns = { 'users' => ['info'] }
+
   # # FRIENDLY DSL
 
   # # A simple DSL is available to allow more user-friendly display of objects.  Normally a user object might be shown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.112
+  version: 1.0.114
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord