super 0.0.4 → 0.0.9

data/lib/generators/super/action_text/USAGE

@@ -0,0 +1,23 @@
+Description:
+    Creates the necessary files for Super to support ActionText
+
+    Prerequisites:
+
+        * Webpacker must be installed on your Rails app
+            * Run: bundle exec rails webpacker:install
+
+        * ActionText must be installed on your Rails app
+            * Run: bundle exec rails action_text:install
+
+    Note that Super does NOT need to be configured to use Webpacker. But if you
+    do use Super with Webpacker, you can merge `action_text.js` into
+    `application.js.erb` file.
+
+Example:
+    bin/rails webpacker:install             # if you haven't already
+    bin/rails action_text:install           # if you haven't already
+    bin/rails generate super:action_text
+
+    This will:
+        Create app/javascript/packs/super/action_text.js
+        Modify config/initializers/super.rb

data/lib/generators/super/action_text/action_text_generator.rb

@@ -0,0 +1,30 @@
+module Super
+  class ActionTextGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_the_pack_files
+      template(
+        "pack_super_action_text.js",
+        "app/javascript/packs/super/action_text.js"
+      )
+      template(
+        "pack_super_action_text.css",
+        "app/javascript/packs/super/action_text.css"
+      )
+    end
+
+    def add_action_text_assets_to_config
+      insert_into_file(
+        "config/initializers/super.rb",
+        "  c.javascripts.push(Super::Assets.webpacker(\"super/action_text\"))\n" \
+        "  c.stylesheets.push(Super::Assets.webpacker(\"super/action_text\"))\n",
+        before: /\bend\b/
+      )
+    end
+
+    def remind_about_webpacker
+      say "Make sure Webpacker is set up on your application!", :bold
+      say "Run if needed: bundle exec rails webpacker:install"
+    end
+  end
+end

data/lib/generators/super/action_text/templates/pack_super_action_text.css

@@ -0,0 +1,23 @@
+@import "trix/dist/trix";
+
+/* This is the SCSS that the ActionText installation generator adds, compiled to CSS */
+.trix-content .attachment-gallery > action-text-attachment,
+.trix-content .attachment-gallery > .attachment {
+  flex: 1 0 33%;
+  padding: 0 0.5em;
+  max-width: 33%; }
+.trix-content .attachment-gallery.attachment-gallery--2 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--2 > .attachment,
+.trix-content .attachment-gallery.attachment-gallery--4 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--4 > .attachment {
+  flex-basis: 50%;
+  max-width: 50%; }
+.trix-content action-text-attachment .attachment {
+  padding: 0 !important;
+  max-width: 100% !important; }
+
+/* This is for getting Tailwind to work with Trix */
+.trix-content ul {
+  list-style-type: disc; }
+.trix-content ol {
+  list-style-type: decimal; }

data/lib/generators/super/action_text/templates/pack_super_action_text.js

@@ -0,0 +1,4 @@
+import * as ActiveStorage from "@rails/activestorage"
+ActiveStorage.start()
+require("trix")
+require("@rails/actiontext")

data/lib/generators/super/install/install_generator.rb

@@ -29,6 +29,22 @@ module Super
       create_file("app/controllers/#{controller_namespace}/.keep", "")
     end
 
+    def copy_cheatsheet
+      super_path = Pathname.new(Gem.loaded_specs["super"].full_gem_path).expand_path
+      super_cheat_path = super_path.join("docs", "cheat.md")
+
+      path =
+        if options["controller_namespace"].present?
+          "app/controllers/#{controller_namespace}/README.md"
+        else
+          "app/controllers/README.md"
+        end
+
+      create_file(path) do
+        super_cheat_path.read.sub(%r{<!--.*?-->}m, "").strip + "\n"
+      end
+    end
+
     def setup_sprockets4_manifest
       append_to_file "app/assets/config/manifest.js", "//= link super_manifest.js\n"
     end

data/lib/generators/super/resource/templates/resources_controller.rb.tt

@@ -6,40 +6,10 @@ class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
     Controls.new
   end
 
-  class Controls
-    def title
-      <%= class_name %>.name.pluralize
-    end
-
+  class Controls < Super::Controls
     def model
       <%= class_name %>
     end
-
-    def scope(action:)
-      if action.read?
-        <%= class_name %>.all
-      else
-        <%= class_name %>.all
-      end
-    end
-
-    def permitted_params(params, action:)
-      if action.create?
-        params.require(:<%= file_name %>).permit()
-      else
-        params.require(:<%= file_name %>).permit()
-      end
-    end
-
-    def display_schema(action:)
-      Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
-      end
-    end
-
-    def form_schema(action:)
-      Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
-      end
-    end
   end
 end
 <% end -%>

data/lib/generators/super/webpacker/USAGE

@@ -1,14 +1,15 @@
 Description:
     Creates the necessary files for assets to be served under Webpacker
 
-    Webpacker support requires ERB support. There are no other dependencies.
+    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:install:webpacker
+    rails generate super:webpacker
 
-    This will create:
-        app/javascript/packs/super/application.js.erb
+    This will:
+        Create app/javascript/packs/super/application.js.erb
+        Modify config/initializers/super.rb

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

@@ -9,9 +9,18 @@ module Super
       )
     end
 
+    def set_asset_handler_to_webpacker
+      insert_into_file(
+        "config/initializers/super.rb",
+        "  c.javascripts = Super::Assets.use_webpacker(c.javascripts)\n" \
+        "  c.stylesheets = Super::Assets.use_webpacker(c.stylesheets)\n",
+        before: /\bend\b/
+      )
+    end
+
     def remind_about_erb
       say "Make sure ERB is set up for Webpacker!", :bold
-      say "Run if needed: rails webpacker:install:erb", :bold
+      say "Run if needed: bundle exec rails webpacker:install:erb"
     end
   end
 end

data/lib/super.rb

@@ -1,17 +1,30 @@
 require "tsort"
-require "active_support/concern"
 
-require "super/action"
-require "super/action/step"
+require "rails/engine"
+
+require "super/schema/common"
+
 require "super/action_inquirer"
 require "super/assets"
+require "super/client_error"
+require "super/compatibility"
 require "super/configuration"
 require "super/controls"
-require "super/engine"
-require "super/error"
 require "super/display"
+require "super/display/guesser"
 require "super/display/schema_types"
+require "super/error"
+require "super/filter"
+require "super/filter/form_object"
+require "super/filter/guesser"
+require "super/filter/operator"
+require "super/filter/plugin"
+require "super/filter/schema_types"
+require "super/form"
+require "super/form/builder"
+require "super/form/guesser"
 require "super/form/schema_types"
+require "super/form/strong_params"
 require "super/layout"
 require "super/link"
 require "super/navigation/automatic"
@@ -20,4 +33,8 @@ require "super/panel"
 require "super/partial"
 require "super/plugin"
 require "super/schema"
+require "super/schema/guesser"
 require "super/version"
+require "super/view_helper"
+
+require "super/engine"

data/lib/super/action_inquirer.rb

@@ -1,7 +1,7 @@
 module Super
   # ```ruby
   # action = Super::ActionInquirer.new(
-  #   Super::ActionInquirer.default_resources,
+  #   Super::ActionInquirer.default_for_resources,
   #   :index
   # )
   #
@@ -15,7 +15,7 @@ module Super
 
     # @return [Hash<Symbol, Array<Symbol>>] default settings for initialization
     #
-    def self.default_resources
+    def self.default_for_resources
       {
         read: %i[index show new edit],
         write: %i[create update destroy],

data/lib/super/assets.rb

@@ -1,8 +1,64 @@
 module Super
   # Utilities for determining whether to use Sprockets or Webpacker
   class Assets
-    def self.sprockets_available?
-      Gem::Dependency.new("sprockets").matching_specs.any?
+    def self.webpacker(path, **arguments)
+      Asset.new(handler: Handler.webpacker, path: path, arguments: arguments)
+    end
+
+    def self.sprockets(path, **arguments)
+      Asset.new(handler: Handler.sprockets, path: path, arguments: arguments)
+    end
+
+    def self.auto(path, **arguments)
+      Asset.new(handler: Handler.auto, path: path, arguments: arguments)
+    end
+
+    def self.use_webpacker(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@handler, Handler.webpacker)
+        end
+
+        asset
+      end
+    end
+
+    def self.use_sprockets(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@asset_handler, Handler.sprockets)
+        end
+
+        asset
+      end
+    end
+
+    class Asset
+      def initialize(handler:, path:, arguments:)
+        @handler = handler
+        @path = path
+        @arguments = arguments
+      end
+
+      attr_reader :handler
+      attr_reader :path
+      attr_reader :arguments
+
+      def ===(other)
+        return true if path == other
+        return true if other.is_a?(Regexp) && path.match?(other)
+        return true if handler == other
+        return true if handler.to_sym == other
+        return true if handler.to_s == other
+
+        false
+      end
     end
 
     def self.dist(gem_name, package_name)
@@ -15,49 +71,67 @@ module Super
       gem_path.join("frontend", package_name, "dist")
     end
 
-    def self.auto
-      @auto ||=
-        if Gem::Dependency.new("sprockets", "~> 4.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("sprockets", "~> 3.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("sprockets", "~> 2.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("webpacker", "~> 4.0").matching_specs.any?
-          webpacker
-        elsif Gem::Dependency.new("webpacker", "~> 3.0").matching_specs.any?
-          webpacker
-        else
-          none
-        end
-    end
+    class Handler
+      def self.auto
+        @auto ||=
+          if Gem::Dependency.new("sprockets", "~> 4.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("sprockets", "~> 3.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("sprockets", "~> 2.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("webpacker", "~> 6.0").matching_specs.any?
+            webpacker
+          elsif Gem::Dependency.new("webpacker", "~> 5.0").matching_specs.any?
+            webpacker
+          elsif Gem::Dependency.new("webpacker", "~> 4.0").matching_specs.any?
+            webpacker
+          elsif Gem::Dependency.new("webpacker", "~> 3.0").matching_specs.any?
+            webpacker
+          else
+            none
+          end
+      end
 
-    def self.sprockets
-      new(:sprockets)
-    end
+      def self.sprockets_available?
+        Gem::Dependency.new("sprockets").matching_specs.any? && defined?(Sprockets)
+      end
 
-    def self.webpacker
-      new(:webpacker)
-    end
+      def self.sprockets
+        @sprockets ||= new(:sprockets)
+      end
 
-    def self.none
-      new(:none)
-    end
+      def self.webpacker
+        @webpacker ||= new(:webpacker)
+      end
 
-    def initialize(asset_handler)
-      @asset_handler = asset_handler
-    end
+      def self.none
+        @none ||= new(:none)
+      end
 
-    def sprockets?
-      @asset_handler == :sprockets
-    end
+      def initialize(asset_handler)
+        @asset_handler = asset_handler
+      end
 
-    def webpacker?
-      @asset_handler == :webpacker
-    end
+      def sprockets?
+        @asset_handler == :sprockets
+      end
+
+      def webpacker?
+        @asset_handler == :webpacker
+      end
+
+      def none?
+        @asset_handler == :none
+      end
+
+      def to_sym
+        @asset_handler
+      end
 
-    def none?
-      @asset_handler == :none
+      def to_s
+        @asset_handler.to_s
+      end
     end
   end
 end

data/lib/super/client_error.rb

@@ -0,0 +1,43 @@
+module Super
+  # A container class for all user-facing (4xx) errors thrown by this library.
+  #
+  # See also `Super::Error`
+  class ClientError < StandardError
+    class BadRequest < ClientError; end
+    class Unauthorized < ClientError; end
+    class Forbidden < ClientError; end
+    class NotFound < ClientError; end
+    class UnprocessableEntity < ClientError; end
+
+    module Handling
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from ::Super::ClientError do |exception|
+          code, default_message =
+            case exception
+            when ClientError::UnprocessableEntity
+              [422, "Unprocessable entity"]
+            when ClientError::NotFound
+              [404, "Not found"]
+            when ClientError::Forbidden
+              [403, "Forbidden"]
+            when ClientError::Unauthorized
+              [401, "Unauthorized"]
+            when ClientError::BadRequest, ClientError
+              [400, "Bad request"]
+            end
+
+          flash.now.alert =
+            if exception.message == exception.class.name.to_s
+              default_message
+            else
+              exception.message
+            end
+
+          render "nothing", status: code
+        end
+      end
+    end
+  end
+end