super 0.18.0 → 0.19.0.rc1

data/frontend/super-frontend/dist/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@superadministration/super",
+  "description": "The frontend code for Super, a Rails admin framework",
+  "homepage": "https://github.com/zachahn/super",
+  "license": "LGPL-3.0-only",
+  "main": "application.js",
+  "files": [
+    "application.js",
+    "application.css",
+    "package.json"
+  ],
+  "version": "0.19.0-rc1"
+}

data/lib/generators/super/webpacker/USAGE

@@ -1,15 +1,9 @@
 Description:
     Creates the necessary files for assets to be served under Webpacker
 
-    Webpacker support requires that you install ERB support for Webpacker.
-
-    Installing ERB on webpacker is usually done by running the command:
-    `rails webpacker:install:erb`
-
 Example:
-    rails webpacker:install:erb             # if you hadn't set up ERB already
     rails generate super:webpacker
 
     This will:
-        Create app/javascript/packs/super/application.js.erb
+        Create app/javascript/packs/super/application.js
         Modify config/initializers/super.rb

data/lib/generators/super/webpacker/templates/pack_super_application.js.tt

@@ -0,0 +1,2 @@
+import Super from "@superadministration/super";
+import "@superadministration/super/application.css";

data/lib/generators/super/webpacker/webpacker_generator.rb

@@ -7,12 +7,12 @@ module Super
     def copy_the_pack_file
       path =
         if Gem::Dependency.new("webpacker", ">= 6.0.0.beta2", "!= 6.0.0.pre1", "!= 6.0.0.pre2").matching_specs.any?
-          "app/packs/entrypoints/super/application.js.erb"
+          "app/packs/entrypoints/super/application.js"
         else
-          "app/javascript/packs/super/application.js.erb"
+          "app/javascript/packs/super/application.js"
         end
 
-      template("pack_super_application.js.erb", path)
+      template("pack_super_application.js", path)
     end
 
     def set_asset_handler_to_webpacker
@@ -24,9 +24,13 @@ module Super
       )
     end
 
-    def remind_about_erb
-      say "Make sure ERB is set up for Webpacker!", :bold
-      say "Run if needed: bundle exec rails webpacker:install:erb"
+    def install_via_yarn
+      super_root = Pathname.new(__dir__).join("../../../..")
+      if super_root.join("dummy_path.rb").file?
+        run "yarn add file:#{super_root.join("frontend/super-frontend/dist")}"
+      else
+        run "yarn add @superadministration/super@#{Super::VERSION} --exact"
+      end
     end
   end
 end

data/lib/super/cheat.rb

@@ -8,6 +8,7 @@ module Super
         paths
         .map { |f| File.read(File.expand_path(f, __dir__)) }
         .flat_map { |content| content.scan(/^\s+(?:helper_method )?def .*$/) }
+        .reject { |method| method =~ /\bdef self\./ }
         .map { |method| method.strip.sub(/^(?:helper_method )?def /, "#") }
 
       puts "== Super::ApplicationController"

data/lib/super/display/schema_types.rb

@@ -129,6 +129,12 @@ module Super
         real(:column, &transform_block)
       end
 
+      def batch
+        real do |value|
+          Partial.new("batch_checkbox", locals: { value: value })
+        end
+      end
+
       def string; real(&:to_s); end
 
       def timestamp; real(&:to_s); end

data/lib/super/engine.rb

@@ -15,6 +15,11 @@ module Super
       Super::Plugin::Registry.controller.ordered do |klass, method_name|
         Super::ApplicationController.public_send(method_name, klass)
       end
+
+      Super::PackagedAsset.warning_message =
+        if !Super::PackagedAsset.version_matches_gem?(Rails.root.join("package.json"))
+          I18n.t("super.mismatching_package_json_gemfile_versions")
+        end
     end
   end
 end

data/lib/super/error.rb

@@ -37,5 +37,14 @@ module Super
       class ArgumentError < Enum; end
       class UndefinedCase < Enum; end
     end
+
+    class ReorderableHash < Error
+      class DuplicateKey < ReorderableHash; end
+      class KeyError < ReorderableHash; end
+    end
+
+    class ViewChain < Error
+      class ChainAlreadyStarted < ViewChain; end
+    end
   end
 end

data/lib/super/layout.rb

@@ -6,44 +6,20 @@ module Super
   class Layout
     include Super::Partial::Resolving
 
-    def initialize(headers: nil, asides: nil, mains: nil, footers: nil)
-      @headers = Array(headers).compact
-      @asides = Array(asides).compact
-      @mains = Array(mains).compact
-      @footers = Array(footers).compact
+    def initialize(header: nil, aside: nil, main: nil, footer: nil)
+      @header = header
+      @aside = aside
+      @main = main
+      @footer = footer
     end
 
-    attr_reader :headers
-    attr_reader :asides
-    attr_reader :mains
-    attr_reader :footers
+    attr_reader :header
+    attr_reader :aside
+    attr_reader :main
+    attr_reader :footer
 
     def to_partial_path
       "layout"
     end
-
-    def resolve(template)
-      @resolved_headers = resolve_for_rendering(template, headers, nil)
-      @resolved_asides = resolve_for_rendering(template, asides, nil)
-      @resolved_mains = resolve_for_rendering(template, mains, nil)
-      @resolved_footers = resolve_for_rendering(template, footers, nil)
-      self
-    end
-
-    def resolved_headers
-      @resolved_headers || []
-    end
-
-    def resolved_asides
-      @resolved_asides || []
-    end
-
-    def resolved_mains
-      @resolved_mains || []
-    end
-
-    def resolved_footers
-      @resolved_footers || []
-    end
   end
 end

data/lib/super/link.rb

@@ -107,13 +107,8 @@ module Super
       @href = Super::Compatability.polymorphic_path_container.polymorphic_path(@href)
     end
 
-    def to_s(default_options: nil, **)
-      default_options ||= {}
-      ActionController::Base.helpers.link_to(
-        text,
-        href,
-        default_options.deep_merge(options)
-      )
+    def to_partial_path
+      "link"
     end
 
     def ==(other)

data/lib/super/link_builder.rb

@@ -19,10 +19,6 @@ module Super
 
     attr_reader :requirements
 
-    def to_s(default_options: nil, **kwargs)
-      resolve(**kwargs).to_s(default_options: default_options)
-    end
-
     def resolve(**kwargs)
       Link.new(
         into_value(@text, kwargs),

data/lib/super/packaged_asset.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Super
+  class PackagedAsset
+    VERSION_BEGINNING = /\A\d+\.\d+.\d+/.freeze
+
+    class << self
+      attr_accessor :warning_message
+    end
+
+    def self.comparable_super_version
+      ::Super::VERSION[VERSION_BEGINNING]
+    end
+
+    def self.version_matches_gem?(package_json_path)
+      return true if ENV.key?("SUPER_IGNORE_PACKAGE_JSON_VERSION")
+
+      asset = new(package_json_path)
+
+      return true if !asset.comparable_version
+
+      asset.comparable_version == comparable_super_version
+    end
+
+    def initialize(package_json_path)
+      @package_json_path = package_json_path
+    end
+
+    def full_version
+      if instance_variable_defined?(:@full_version)
+        return @full_version
+      end
+
+      @full_version = JSON.parse(@package_json_path.read).dig("dependencies", "@superadministration/super")
+    rescue
+      @full_version = nil
+    end
+
+    def comparable_version
+      if instance_variable_defined?(:@asset_version)
+        return @asset_version
+      end
+
+      @asset_version = full_version[VERSION_BEGINNING]
+    rescue
+      @asset_version = nil
+    end
+  end
+end

data/lib/super/pagination.rb

@@ -76,9 +76,10 @@ module Super
     module ControllerMethods
       def index
         super
+        return if !@records
         @pagination = initialize_pagination
         @records = paginate_records
-        @view.mains.first.parts.push(:@pagination)
+        @view.main.insert(:pagination, @pagination, before: :main)
       end
     end
   end

data/lib/super/reorderable_hash.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Super
+  class ReorderableHash
+    include TSort
+    include Enumerable
+
+    UNDEFINED = BasicObject.new
+
+    def initialize(data = {})
+      @data = data
+      @ordering = {}
+      keys = @data.keys
+      dependencies = []
+      keys.each do |key|
+        @ordering[key] = dependencies.dup
+        dependencies.push(key)
+      end
+    end
+
+    def insert(key, value, before: UNDEFINED, after: UNDEFINED)
+      if @ordering.key?(key) || @data.key?(key)
+        raise Super::Error::ReorderableHash::DuplicateKey, "Duplicate key: #{key}"
+      end
+      @ordering[key] = []
+      @data[key] = value
+
+      order(key, before: before, after: after)
+
+      nil
+    end
+
+    def order(key, before: UNDEFINED, after: UNDEFINED)
+      if before != UNDEFINED
+        if !@ordering.key?(before)
+          raise KeyError, "Before key not found. Have: #{@data.keys} Requested: #{before}"
+        end
+        @ordering[before].push(key)
+      end
+
+      if after != UNDEFINED
+        if !@ordering.key?(after)
+          raise KeyError, "After key not found. Have: #{@data.keys} Requested: #{after}"
+        end
+        @ordering[key].push(after)
+      end
+    end
+
+    def tsort_each_node(&block)
+      @ordering.each_key(&block)
+    end
+
+    def tsort_each_child(node, &block)
+      dependencies = @ordering.fetch(node) { [] }
+      dependencies.each(&block)
+    end
+
+    def []=(key, where, value)
+      insert(key, value, **where)
+    end
+
+    def keys
+      tsort
+    end
+
+    def values
+      keys.each_with_object([]) do |key, array|
+        array.push(@data[key])
+      end
+    end
+
+    def to_h
+      keys.each_with_object({}) do |key, hash|
+        hash[key] = @data[key]
+      end
+    end
+
+    def each
+      if !block_given?
+        return enum_for(:each)
+      end
+
+      tsort_each do |key|
+        yield key, @data[key]
+      end
+    end
+  end
+end

data/lib/super/reset.rb

@@ -4,6 +4,20 @@ module Super
   module Reset
     extend ActiveSupport::Concern
 
+    KEEP = {
+      # Defined by Rails
+      _layout: true,
+      _generate_paths_by_default: true,
+
+      # Defined in Super::SubstructureController
+      navigation: true,
+      page_title: true,
+
+      # Defined in Super::ApplicationController
+      current_action: true,
+      with_current_action: true,
+    }
+
     included do
       undef_method :index
       undef_method :show
@@ -14,10 +28,12 @@ module Super
       undef_method :destroy
 
       Super::SubstructureController.private_instance_methods(false).each do |imethod|
-        next if imethod == :_layout
-        next if imethod == :_generate_paths_by_default
-        next if imethod == :navigation
-        next if imethod == :page_title
+        next if KEEP.key?(imethod)
+        undef_method imethod
+      end
+
+      Super::ApplicationController.private_instance_methods(false).each do |imethod|
+        next if KEEP.key?(imethod)
         undef_method imethod
       end
     end

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.18.0"
+  VERSION = "0.19.0.rc1"
 end

data/lib/super/view_chain.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Super
+  class ViewChain
+    def initialize(chain)
+      @data = ReorderableHash.new(chain)
+    end
+
+    def chain
+      @chain ||= @data.values
+    end
+
+    def insert(*args, **kwargs)
+      if instance_variable_defined?(:@chain)
+        raise Error::ViewChain::ChainAlreadyStarted
+      end
+
+      @data.insert(*args, **kwargs)
+    end
+
+    def to_partial_path
+      "view_chain"
+    end
+  end
+end

data/lib/super.rb

@@ -34,16 +34,19 @@ require "super/layout"
 require "super/link"
 require "super/link_builder"
 require "super/navigation"
+require "super/packaged_asset"
 require "super/pagination"
 require "super/panel"
 require "super/partial"
 require "super/plugin"
 require "super/query/form_object"
+require "super/reorderable_hash"
 require "super/reset"
 require "super/schema"
 require "super/schema/guesser"
 require "super/sort"
 require "super/version"
+require "super/view_chain"
 require "super/view_helper"
 
 require "super/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0.rc1
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -226,6 +226,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-bisect
+  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'
 description:
 email:
 - engineering@zachahn.com
@@ -243,7 +257,12 @@ files:
 - app/controllers/super/substructure_controller.rb
 - app/helpers/super/form_builder_helper.rb
 - app/views/layouts/super/application.html.erb
+- app/views/super/application/_batch_button.html.erb
+- app/views/super/application/_batch_checkbox.csv.erb
+- app/views/super/application/_batch_checkbox.html.erb
+- app/views/super/application/_batch_form.html.erb
 - app/views/super/application/_collection_header.html.erb
+- app/views/super/application/_csv_button.html.erb
 - app/views/super/application/_display_actions.html.erb
 - app/views/super/application/_display_index.html.erb
 - app/views/super/application/_display_rich_text.html.erb
@@ -257,6 +276,7 @@ files:
 - app/views/super/application/_form_has_many.html.erb
 - app/views/super/application/_form_has_one.html.erb
 - app/views/super/application/_layout.html.erb
+- app/views/super/application/_link.html.erb
 - app/views/super/application/_member_header.html.erb
 - app/views/super/application/_pagination.html.erb
 - app/views/super/application/_panel.html.erb
@@ -265,6 +285,7 @@ files:
 - app/views/super/application/_site_header.html.erb
 - app/views/super/application/_sort.html.erb
 - app/views/super/application/_sort_expression.html.erb
+- app/views/super/application/_view_chain.html.erb
 - app/views/super/application/edit.html.erb
 - app/views/super/application/index.csv.erb
 - app/views/super/application/index.html.erb
@@ -277,6 +298,7 @@ files:
 - config/routes.rb
 - frontend/super-frontend/dist/application.css
 - frontend/super-frontend/dist/application.js
+- frontend/super-frontend/dist/package.json
 - lib/generators/super/action_text/USAGE
 - lib/generators/super/action_text/action_text_generator.rb
 - lib/generators/super/action_text/templates/pack_super_action_text.css
@@ -289,7 +311,7 @@ files:
 - lib/generators/super/resource/resource_generator.rb
 - lib/generators/super/resource/templates/resources_controller.rb.tt
 - lib/generators/super/webpacker/USAGE
-- lib/generators/super/webpacker/templates/pack_super_application.js.erb.tt
+- lib/generators/super/webpacker/templates/pack_super_application.js.tt
 - lib/generators/super/webpacker/webpacker_generator.rb
 - lib/super.rb
 - lib/super/action_inquirer.rb
@@ -320,12 +342,14 @@ files:
 - lib/super/link.rb
 - lib/super/link_builder.rb
 - lib/super/navigation.rb
+- lib/super/packaged_asset.rb
 - lib/super/pagination.rb
 - lib/super/panel.rb
 - lib/super/partial.rb
 - lib/super/partial/resolving.rb
 - lib/super/plugin.rb
 - lib/super/query/form_object.rb
+- lib/super/reorderable_hash.rb
 - lib/super/reset.rb
 - lib/super/schema.rb
 - lib/super/schema/common.rb
@@ -334,6 +358,7 @@ files:
 - lib/super/useful/builder.rb
 - lib/super/useful/enum.rb
 - lib/super/version.rb
+- lib/super/view_chain.rb
 - lib/super/view_helper.rb
 - lib/tasks/super/cheat.rake
 homepage:
@@ -356,11 +381,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: A simple, powerful, zero dependency Rails admin framework

data/lib/generators/super/webpacker/templates/pack_super_application.js.erb.tt

@@ -1,2 +0,0 @@
-import Super from "<%%= Super::Assets.dist("super", "super-frontend").join("application") %>";
-import "<%%= Super::Assets.dist("super", "super-frontend").join("application.css") %>";