bullet_train-super_scaffolding 1.6.11 → 1.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deaf8ea96df90b0a99c72b3bd577ff05c2f41e13f111c60f596d73fdae10d3fd
-  data.tar.gz: 9142c1f14dc4b8fdab16ea68a5c8f11da7f0ae798ba1d6338e594347e5c25813
+  metadata.gz: e5a15e9fcfe1268219c9bf057521179f25cfeeaa5c0a9411bcdcbd8cbe270152
+  data.tar.gz: 613a44877e831dd2c1e3715666d4059a623716a2450c2bd7ceff0aa304371e0c
 SHA512:
-  metadata.gz: 0c1ba6932a9db1a870e8174f9aae58d011a600c030e0afd9f1beae3afd9a24ccd0a4c0060aa604f3ca5264b43decb8deecbde2585d951d6ae8077f0aa5e1f7eb
-  data.tar.gz: f1497afc9332d2db0eef6c0979cdc1065c8bf337dcc002a18203ded498c5cb7f50dfdd7ebc86111c4a8f0bdfe31426fad5fa84ae59392561bd04def404faa09e
+  metadata.gz: 2b076a56ddd441d854d649ba0dd5dd2e4f4494747bf1fde9b0b239eb32a82fbc04b2437186383da1fc90e2c025b446ed21899e5c5ef7c8e7b8f8ec9db2a0a4de
+  data.tar.gz: 713d83c5c6bc8d09653267cd7725548ffe7cad57d8000cf421e5ecf88c9373cab7048f4e8b4d39ca54bdfefcd2c84b841c63b39a756ca3d01ec55c2874944439

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.6.11"
+    VERSION = "1.6.12"
   end
 end

data/lib/generators/super_scaffold/USAGE

@@ -0,0 +1,36 @@
+Description:
+  Generate a production ready CRUD interface for a model. See the docs for more details:
+  https://bullettrain.co/docs/super-scaffolding
+
+  E.g. a Team has many Sites with some attributes:
+    rails g super_scaffold Site Team name:text_field url:text_area
+
+  E.g. a Section belongs to a Page, which belongs to a Site, which belongs to a Team:
+    rails g super_scaffold Section Page,Site,Team title:text_field body:text_area
+
+  E.g. an Image belongs to either a Page or a Site:
+    Doable! See https://bit.ly/2NvO8El for a step by step guide.
+
+  E.g. Pages belong to a Site and are sortable via drag-and-drop:
+    rails g super_scaffold Page Site,Team name:text_field path:text_area --sortable
+
+Example:
+  E.g. a Team has many Projects each having a name:
+  bin/rails generate super_scaffold Project Team name:text_field
+
+  This will create:
+      app/controllers/account/projects_controller.rb
+      app/controllers/api/v1/projects_controller.rb
+      app/models/project.rb
+      app/views/account/projects/
+      app/views/api/v1/projects/
+      config/locales/en/projects.en.yml
+      db/migrate/20231004190209_create_projects.rb
+      test/controllers/api/v1/projects_controller_test.rb
+      test/factories/projects.rb
+      test/models/project_test.rb
+
+🏆 Protip: Commit your other changes before running Super Scaffolding so it's easy to undo if you (or we) make any mistakes.
+If you do that, you can reset to your last commit state by using `git checkout .` and `git clean -d -f`.
+
+Give it a shot! Let us know if you have any trouble with it! ✌️

data/lib/generators/super_scaffold/field/USAGE

@@ -0,0 +1,15 @@
+Description:
+  Add a new field to an existing Super Scaffold. See the docs for more details:
+  https://bullettrain.co/docs/super-scaffolding
+
+Example:
+  bin/rails generate super_scaffold:field Project description:trix_editor
+
+  This will update:
+    app/models/project.rb
+    app/views/account/projects/_form.html.erb
+    app/views/account/projects/show.html.erb
+    config/locales/en/projects.en.yml
+    config/locales/en/projects.en.yml
+    app/controllers/account/projects_controller.rb
+    app/controllers/api/v1/projects_controller.rb

data/lib/generators/super_scaffold/field/field_generator.rb

@@ -0,0 +1,27 @@
+require_relative "../super_scaffold_base"
+
+class FieldGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold:field"
+
+  argument :model, type: :string
+  argument :attributes, type: :array, default: [], banner: "attribute:type attribute:type"
+
+  class_option :skip_migration_generation, type: :boolean, default: false, desc: "Don't generate the model migration"
+  class_option :skip_form, type: :boolean, default: false, desc: "Don't alter the new/edit form"
+  class_option :skip_show, type: :boolean, default: false, desc: "Don't alter the show view"
+  class_option :skip_table, type: :boolean, default: false, desc: "Only add to the new/edit form and show view."
+  class_option :skip_locales, type: :boolean, default: false, desc: "Don't alter locale files"
+  class_option :skip_api, type: :boolean, default: false, desc: "Don't alter the api payloads"
+  class_option :skip_model, type: :boolean, default: false, desc: "Don't alter the model file"
+
+  def generate
+    # We add the name of the specific super_scaffolding command that we want to
+    # invoke to the beginning of the argument string.
+    ARGV.unshift "crud-field"
+    BulletTrain::SuperScaffolding::Runner.new.run
+  end
+end

data/lib/generators/super_scaffold/incoming_webhooks/USAGE

@@ -0,0 +1,16 @@
+Description:
+  Generate a handler for incoming webhooks from an outside source.
+
+Example:
+  E.g. prepare to receive system-level webhooks from ClickFunnels
+    rails g bullet_train:incoming_webhooks ClickFunnels
+
+  This will create:
+    app/models/webhooks/incoming/click_funnel_webhook.rb
+    app/controllers/webhooks/incoming/click_funnel_webhooks_controller.rb
+    test/controllers/webhooks/incoming/click_funnel_webhooks_controller_test.rb
+  And update:
+    config/routes.rb
+
+🏆 Protip: Commit your other changes before running Super Scaffolding so it's easy to undo if you (or we) make any mistakes.
+If you do that, you can reset to your last commit state by using `git checkout .` and `git clean -d -f`.

data/lib/generators/super_scaffold/incoming_webhooks/incoming_webhooks_generator.rb

@@ -0,0 +1,18 @@
+require_relative "super_scaffold_base"
+
+class IncomingWebhooksGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold:incoming_webhooks"
+
+  argument :provider_name
+
+  def generate
+    # We add the name of the specific super_scaffolding command that we want to
+    # invoke to the beginning of the argument string.
+    ARGV.unshift "incoming-webhooks"
+    BulletTrain::SuperScaffolding::Runner.new.run
+  end
+end

data/lib/generators/super_scaffold/join_model/USAGE

@@ -0,0 +1,28 @@
+Description:
+  Generate a Bullet Train Join Model.
+
+Example:
+  E.g. Add project-specific tags to a project:
+
+  Given the following example models:
+
+    rails g super_scaffold Project Team name:text_field description:trix_editor
+    rails g super_scaffold Projects::Tag Team name:text_field
+
+  1️⃣  Use the standard Rails model generator to generate the join model:
+
+    rails g model Projects::AppliedTag project:references tag:references
+
+    👋 Don't run migrations yet! Sometimes Super Scaffolding updates them for you.
+
+  2️⃣  Use `join-model` scaffolding to prepare the join model for use in `crud-field` scaffolding:
+
+    rails g bullet_train:join_model Projects::AppliedTag project_id{class_name=Project} tag_id{class_name=Projects::Tag}
+
+  3️⃣  Now you can use `crud-field` scaffolding to actually add the field to the form of the parent model:
+
+    rails g super_scaffold:field Project tag_ids:super_select{class_name=Projects::Tag}
+
+    👋 Heads up! There will be one follow-up step output by this command that you need to take action on.
+
+  4️⃣  Now you can run your migrations.

data/lib/generators/super_scaffold/join_model/join_model_generator.rb

@@ -0,0 +1,28 @@
+require_relative "super_scaffold_base"
+
+class JoinModelGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold:join_model"
+
+  argument :join_model
+  argument :left_association
+  argument :right_association
+
+  class_option :skip_migration_generation, type: :boolean, default: false, desc: "Don't generate the model migration"
+  class_option :skip_form, type: :boolean, default: false, desc: "Don't alter the new/edit form"
+  class_option :skip_show, type: :boolean, default: false, desc: "Don't alter the show view"
+  class_option :skip_table, type: :boolean, default: false, desc: "Only add to the new/edit form and show view."
+  class_option :skip_locales, type: :boolean, default: false, desc: "Don't alter locale files"
+  class_option :skip_api, type: :boolean, default: false, desc: "Don't alter the api payloads"
+  class_option :skip_model, type: :boolean, default: false, desc: "Don't alter the model file"
+
+  def generate
+    # We add the name of the specific super_scaffolding command that we want to
+    # invoke to the beginning of the argument string.
+    ARGV.unshift "join-model"
+    BulletTrain::SuperScaffolding::Runner.new.run
+  end
+end

data/lib/generators/super_scaffold/oauth_provider/USAGE

@@ -0,0 +1,50 @@
+Description:
+  Generate the setup and configuration for using an external OAuth Provider.
+
+  For a list of readily available provider strategies, see https://github.com/omniauth/omniauth/wiki/List-of-Strategies
+
+Example:
+  E.g. what we actually did to start Shopify off:
+    bin/rails generate bullet_train:oauth_provider omniauth-shopify-oauth2 shopify Oauth::ShopifyAccount SHOPIFY_API_KEY SHOPIFY_API_SECRET_KEY --icon=ti-shopping-cart
+    (Please note here that the SHOPIFY_API_KEY and SHOPIFY_API_SECRET_KEY strings are not the actual values, just the names we give to the environment variables.)
+
+  This will create:
+    app/models/oauth/shopify_account.rb
+    app/models/concerns/oauth/shopify_accounts/base.rb
+    app/models/webhooks/incoming/oauth/shopify_account_webhook.rb
+    app/models/concerns/webhooks/incoming/oauth/shopify_account_webhooks/base.rb
+    app/controllers/account/oauth/shopify_accounts_controller.rb
+    app/controllers/webhooks/incoming/oauth/shopify_account_webhooks_controller.rb
+    app/views/account/oauth/shopify_accounts/index.html.erb
+    app/views/account/oauth/shopify_accounts/_menu_item.html.erb
+    app/views/account/oauth/shopify_accounts/_index.html.erb
+    app/views/account/oauth/shopify_accounts/edit.html.erb
+    app/views/account/oauth/shopify_accounts/show.html.erb
+    app/views/account/oauth/shopify_accounts/_form.html.erb
+    app/views/account/oauth/shopify_accounts/_breadcrumbs.html.erb
+    test/models/oauth/shopify_account_test.rb
+    test/factories/oauth/shopify_accounts.rb
+    config/locales/en/oauth/shopify_accounts.en.yml
+    app/views/devise/shared/oauth/_shopify.html.erb
+    app/models/integrations/shopify_installation.rb
+    app/models/concerns/integrations/shopify_installations/base.rb
+    app/controllers/account/integrations/shopify_installations_controller.rb
+    app/views/account/integrations/shopify_installations/index.html.erb
+    app/views/account/integrations/shopify_installations/_menu_item.html.erb
+    app/views/account/integrations/shopify_installations/_index.html.erb
+    app/views/account/integrations/shopify_installations/_list.html.erb
+    app/views/account/integrations/shopify_installations/edit.html.erb
+    app/views/account/integrations/shopify_installations/show.html.erb
+    app/views/account/integrations/shopify_installations/_form.html.erb
+    app/views/account/integrations/shopify_installations/new.html.erb
+    app/views/account/integrations/shopify_installations/_breadcrumbs.html.erb
+    test/models/integrations/shopify_installation_test.rb
+    test/factories/integrations/shopify_installations.rb
+    config/locales/en/integrations/shopify_installations.en.yml
+    app/models/webhooks/incoming/oauth/shopify_account_webhook.rb
+    app/controllers/webhooks/incoming/oauth/shopify_account_webhooks_controller.rb
+
+🏆 Protip: Commit your other changes before running Super Scaffolding so it's easy to undo if you (or we) make any mistakes.
+If you do that, you can reset to your last commit state by using `git checkout .` and `git clean -d -f`.
+
+

data/lib/generators/super_scaffold/oauth_provider/oauth_provider_generator.rb

@@ -0,0 +1,24 @@
+require_relative "super_scaffold_base"
+
+class OauthProviderGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold:oauth_provider"
+
+  argument :omniauth_gem
+  argument :gems_provider_name
+  argument :our_provider_name
+  argument :PROVIDER_API_KEY_ENV_VAR_NAME
+  argument :PROVIDER_API_SECRET_ENV_VAR_NAME
+
+  class_option :icon, type: :string, desc: "Specify an icon."
+
+  def generate
+    # We add the name of the specific super_scaffolding command that we want to
+    # invoke to the beginning of the argument string.
+    ARGV.unshift "oauth-provider"
+    BulletTrain::SuperScaffolding::Runner.new.run
+  end
+end

data/lib/generators/super_scaffold/super_scaffold_base.rb

@@ -0,0 +1,41 @@
+module SuperScaffoldBase
+  extend ActiveSupport::Concern
+
+  included do
+    # ##############################
+    #
+    # TODO: Should we retain some of these class options?
+    #
+    # By default we inherit a bunch of options that _would_ automatically be used if we
+    # were writing a normal Rails generator that used normal methods of generating files.
+    # So if you invoke this generator without passing any arguments (and without these
+    # remove_class_option lines) then at the top of the help text you'd see info about all
+    # of these options:
+    #
+    # ##############################
+    #
+    # rails g super_scaffold
+    #
+    # Options:
+    #   [--skip-namespace], [--no-skip-namespace]              # Skip namespace (affects only isolated engines)
+    #   [--skip-collision-check], [--no-skip-collision-check]  # Skip collision check
+    #
+    # Runtime options:
+    #   -f, [--force]                    # Overwrite files that already exist
+    #   -p, [--pretend], [--no-pretend]  # Run but do not make any changes
+    #   -q, [--quiet], [--no-quiet]      # Suppress status output
+    #   -s, [--skip], [--no-skip]        # Skip files that already exist
+    #
+    # ##############################
+    #
+    # Maye we have comparable options for some of these and should retain them and
+    # pass them through to the rake task?
+
+    remove_class_option :skip_namespace
+    remove_class_option :skip_collision_check
+    remove_class_option :force
+    remove_class_option :pretend
+    remove_class_option :quiet
+    remove_class_option :skip
+  end
+end

data/lib/generators/super_scaffold/super_scaffold_generator.rb

@@ -0,0 +1,34 @@
+require_relative "super_scaffold_base"
+
+class SuperScaffoldGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold"
+
+  argument :model, type: :string
+  argument :parent_models, type: :string
+  argument :attributes, type: :array, default: [], banner: "attribute:type attribute:type"
+
+  class_option :skip_migration_generation, type: :boolean, default: false, desc: "Don't generate the model migration"
+  class_option :sortable, type: :boolean, default: false, desc: "https://bullettrain.co/docs/super-scaffolding/sortable"
+  class_option :namespace, type: :string, desc: "https://bullettrain.co/docs/namespacing"
+  class_option :sidebar, type: :string, desc: "Pass the Themify icon or Font Awesome icon to automatically add it to the navbar"
+  class_option :only_index, type: :boolean, default: false, desc: "Only scaffold the index view for a model"
+  class_option :skip_views, type: :boolean, default: false, desc: "Don't generate views"
+  class_option :skip_form, type: :boolean, default: false, desc: "Don't generate a new/edit form"
+  class_option :skip_locales, type: :boolean, default: false, desc: "Don't generate locale files"
+  class_option :skip_api, type: :boolean, default: false, desc: "Don't generate api files"
+  class_option :skip_model, type: :boolean, default: false, desc: "Don't generate a model file"
+  class_option :skip_controller, type: :boolean, default: false, desc: "Don't generate a controller file"
+  class_option :skip_routes, type: :boolean, default: false, desc: "Don't generate any routes"
+  class_option :skip_parent, type: :boolean, default: false, desc: "Don't add child models to the show page of their parent"
+
+  def generate
+    # We add the name of the specific super_scaffolding command that we want to
+    # invoke to the beginning of the argument string.
+    ARGV.unshift "crud"
+    BulletTrain::SuperScaffolding::Runner.new.run
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.6.11
+  version: 1.6.12
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -163,6 +163,17 @@ files:
 - lib/bullet_train/super_scaffolding/scaffolders/oauth_provider_scaffolder.rb
 - lib/bullet_train/super_scaffolding/version.rb
 - lib/bullet_train/terminal_commands.rb
+- lib/generators/super_scaffold/USAGE
+- lib/generators/super_scaffold/field/USAGE
+- lib/generators/super_scaffold/field/field_generator.rb
+- lib/generators/super_scaffold/incoming_webhooks/USAGE
+- lib/generators/super_scaffold/incoming_webhooks/incoming_webhooks_generator.rb
+- lib/generators/super_scaffold/join_model/USAGE
+- lib/generators/super_scaffold/join_model/join_model_generator.rb
+- lib/generators/super_scaffold/oauth_provider/USAGE
+- lib/generators/super_scaffold/oauth_provider/oauth_provider_generator.rb
+- lib/generators/super_scaffold/super_scaffold_base.rb
+- lib/generators/super_scaffold/super_scaffold_generator.rb
 - lib/scaffolding.rb
 - lib/scaffolding/attribute.rb
 - lib/scaffolding/block_manipulator.rb