bullet_train-super_scaffolding 1.7.11 → 1.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16465881966c5cc7bfb8056943d036dea6ee5e2284a4000a2f6182c41c1eb22d
-  data.tar.gz: aa40db2f84412ec08860dd6387f096c5e53622526ab17700bb66be85e8f0dd6b
+  metadata.gz: 6dd84e957ddefde70d191dc5cdfccd98934850f7ce7287ea636f79f3d40ee891
+  data.tar.gz: 61ff5d0bf0bf30ed71431b14fb80d05c2a4a934893962b9e34fb9441b53f915c
 SHA512:
-  metadata.gz: 4c78f397e90c8c4175ab3b5c02fbd841ab8a6f1f6c6f2929bdf4d850f88822ac6ce50f0359b51a88ee2ffde1f2a445b3084d1d23433122fd454e65e361795e43
-  data.tar.gz: 033dd98dd593f934b77f39214f35876da85ae9a9716c7e11d4b7ca93e2ba169d5e217e63326551f941a77a69277cf7a8598d140babd2c60d001186791a48f2e6
+  metadata.gz: 7f4d743ff8195358b9b4fdd3f41089baf03ec8d24a36c12cf6b3109bfc638c54bf2b0e0ac0340cca3eddee4286d1f529807abaeffd38196cd938eeff08d9b2a3
+  data.tar.gz: abc0ba2ad876758d0909b2b12651986d42026e410bb958cf72eed327e540c7d44ab2a5379245f9bc26addb844f5e4a60ae4eaef10a5ff52345bdbafa5713372a

data/lib/bullet_train/super_scaffolding/scaffolders/join_model_scaffolder.rb

@@ -82,8 +82,11 @@ module BulletTrain
           transformer.suppress_could_not_find = false
 
           # Add the `has_many ... through:` association in both directions.
-          transformer.add_has_many_through_associations(has_many_through_transformer)
-          inverse_transformer.add_has_many_through_associations(inverse_has_many_through_transformer)
+          # We pass the "opposing" attribute so that both the association name and the
+          # class name get wired up correctly in cases where they don't match. For instance
+          # if you want an `assigned_to_membership` relationship to the `memberships` table.
+          transformer.add_has_many_through_associations(has_many_through_transformer, attributes[1])
+          inverse_transformer.add_has_many_through_associations(inverse_has_many_through_transformer, attributes[0])
 
           additional_steps = (transformer.additional_steps + has_many_through_transformer.additional_steps + inverse_transformer.additional_steps + inverse_has_many_through_transformer.additional_steps).uniq
 

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.7.11"
+    VERSION = "1.7.12"
   end
 end

data/lib/bullet_train/super_scaffolding.rb

@@ -20,7 +20,9 @@ module BulletTrain
       "oauth-provider" => "BulletTrain::SuperScaffolding::Scaffolders::OauthProviderScaffolder",
       "action-models:targets-many" => "BulletTrain::ActionModels::Scaffolders::TargetsManyScaffolder",
       "action-models:targets-one" => "BulletTrain::ActionModels::Scaffolders::TargetsOneScaffolder",
-      "action-models:targets-one-parent" => "BulletTrain::ActionModels::Scaffolders::TargetsOneParentScaffolder"
+      "action-models:targets-one-parent" => "BulletTrain::ActionModels::Scaffolders::TargetsOneParentScaffolder",
+      "action-models:performs-export" => "BulletTrain::ActionModels::Scaffolders::PerformsExportScaffolder",
+      "action-models:performs-import" => "BulletTrain::ActionModels::Scaffolders::PerformsImportScaffolder"
     }
 
     class Runner

data/lib/generators/super_scaffold/action_models/performs_export/USAGE

@@ -0,0 +1,27 @@
+Description:
+  Generate an action to export a list of model records.
+
+Example:
+  E.g. Generate an Export action that exports many Posts from a Team.
+    rails generate super_scaffold:action_models:performs_export Export Post Team
+
+  This will create:
+    app/avo/resources/posts_export_action.rb
+    app/controllers/account/posts/
+    app/controllers/avo/posts_export_actions_controller.rb
+    app/models/posts.rb
+    app/models/posts/
+    app/views/account/posts/export_actions/
+    config/locales/en/posts/
+    db/migrate/20240612185709_create_posts_export_actions.rb
+    test/factories/posts/
+    test/models/posts/
+  And update:
+    app/models/team.rb
+    app/views/account/posts/_index.html.erb
+    config/models/roles.yml
+    config/routes.rb
+    config/routes/api/v1.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/action_models/performs_export/performs_export_generator.rb

@@ -0,0 +1,36 @@
+require_relative "../../super_scaffold_base"
+require "scaffolding/routes_file_manipulator"
+
+module ActionModels
+  class PerformsExportGenerator < Rails::Generators::Base
+    include SuperScaffoldBase
+
+    source_root File.expand_path("templates", __dir__)
+
+    namespace "super_scaffold:action_models:performs_export"
+
+    argument :action_model
+    argument :target_model
+    argument :parent_model
+
+    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
+      if defined?(BulletTrain::ActionModels)
+        # We add the name of the specific super_scaffolding command that we want to
+        # invoke to the beginning of the argument string.
+        ARGV.unshift "action-models:performs-export"
+        BulletTrain::SuperScaffolding::Runner.new.run
+      else
+        puts "You must have Action Models installed if you want to use this generator.".red
+        puts "Please refer to the documentation for more information: https://bullettrain.co/docs/action-models"
+      end
+    end
+  end
+end

data/lib/generators/super_scaffold/action_models/performs_import/USAGE

@@ -0,0 +1,26 @@
+Description:
+  Generate an action that imports a list of records to its parent.
+
+Example:
+  E.g. Generate a CSV Importer that creates many Posts on a Team.
+    rails generate super_scaffold:action_models:performs_import CsvImport Post Team
+
+  This will create:
+    app/avo/resources/posts_import_action.rb
+    app/controllers/account/posts/import_actions_controller.rb
+    app/controllers/avo/posts_import_actions_controller.rb
+    app/models/posts/import_action.rb
+    app/views/account/posts/import_actions/
+    config/locales/en/posts/import_actions.en.yml
+    db/migrate/20240612185843_create_posts_import_actions.rb
+    test/factories/posts/import_actions.rb
+    test/models/posts/import_action_test.rb
+  And update:
+    app/models/team.rb
+    app/views/account/posts/_index.html.erb
+    config/models/roles.yml
+    config/routes.rb
+    config/routes/api/v1.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/action_models/performs_import/performs_import_generator.rb

@@ -0,0 +1,36 @@
+require_relative "../../super_scaffold_base"
+require "scaffolding/routes_file_manipulator"
+
+module ActionModels
+  class PerformsImportGenerator < Rails::Generators::Base
+    include SuperScaffoldBase
+
+    source_root File.expand_path("templates", __dir__)
+
+    namespace "super_scaffold:action_models:performs_import"
+
+    argument :action_model
+    argument :model_to_process
+    argument :target_parent_model
+
+    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
+      if defined?(BulletTrain::ActionModels)
+        # We add the name of the specific super_scaffolding command that we want to
+        # invoke to the beginning of the argument string.
+        ARGV.unshift "action-models:performs-import"
+        BulletTrain::SuperScaffolding::Runner.new.run
+      else
+        puts "You must have Action Models installed if you want to use this generator.".red
+        puts "Please refer to the documentation for more information: https://bullettrain.co/docs/action-models"
+      end
+    end
+  end
+end

data/lib/scaffolding/attribute.rb

@@ -58,6 +58,20 @@ class Scaffolding::Attribute
     name.split("_id").first
   end
 
+  def plural_association_name
+    association_class_name.tableize
+  end
+
+  def class_name_matches?
+    # if namespaces are involved, just don't...
+    # TODO: I'm not entirely sure that extracting this conditional was the right thing to do.
+    # Are there scenarios where we want to assume a match even when namespaces are involved?
+    if options[:class_name].include?("::")
+      return false
+    end
+    name_without_id.tableize == options[:class_name].tableize.tr("/", "_")
+  end
+
   def is_association?
     is_belongs_to? || is_has_many?
   end

data/lib/scaffolding/transformer.rb

@@ -603,10 +603,27 @@ class Scaffolding::Transformer
     has_many_string.split(",").first.split(":").last
   end
 
-  def add_has_many_through_associations(has_many_through_transformer)
+  def add_has_many_through_associations(has_many_through_transformer, attribute_definition)
+    attribute = Scaffolding::Attribute.new(attribute_definition, :crud_field, 0)
     has_many_association = add_has_many_association
-    has_many_through_string = has_many_through_transformer.transform_string("has_many :completely_concrete_tangible_things, through: :$HAS_MANY_ASSOCIATION")
+    has_many_through_parts = [
+      "has_many :completely_concrete_tangible_things",
+      "through: :$HAS_MANY_ASSOCIATION"
+    ]
+
+    unless attribute.class_name_matches?
+      has_many_through_parts << "class_name: \"Scaffolding::CompletelyConcrete::TangibleThing\""
+    end
+    has_many_through_string = has_many_through_transformer.transform_string(has_many_through_parts.join(", "))
     has_many_through_string.gsub!("$HAS_MANY_ASSOCIATION", has_many_association)
+    unless attribute.class_name_matches?
+      # This handles the case where you're generating a join model where you want association names
+      # to be different than the class name, so it'll transform something like this:
+      # has_many :memberships, through: :assignments, class_name: "Membership"
+      # into something like this:
+      # has_many :assigned_to_memberships, through: :assignments, class_name: "Membership"
+      has_many_through_string.gsub!("has_many :#{attribute.plural_association_name}", "has_many :#{attribute.name_without_id.tableize}")
+    end
     add_line_to_file(transform_string("./app/models/scaffolding/absolutely_abstract/creative_concept.rb"), has_many_through_string, HAS_MANY_HOOK, prepend: true)
   end
 
@@ -1142,15 +1159,8 @@ class Scaffolding::Transformer
 
           end
 
-          class_name_matches = attribute.name_without_id.tableize == attribute.options[:class_name].tableize.tr("/", "_")
-
-          # but also, if namespaces are involved, just don't...
-          if attribute.options[:class_name].include?("::")
-            class_name_matches = false
-          end
-
           # unless the table name matches the association name.
-          unless class_name_matches
+          unless attribute.class_name_matches?
             if migration_file_name
               # There are two forms this association creation can take.
               replace_in_file(migration_file_name, "foreign_key: true", "foreign_key: {to_table: \"#{attribute.options[:class_name].tableize.tr("/", "_")}\"}", /t\.references :#{attribute.name_without_id}/)
@@ -1167,7 +1177,7 @@ class Scaffolding::Transformer
           # if the `belongs_to` is already there from `rails g model`..
           scaffold_replace_line_in_file(
             "./app/models/scaffolding/completely_concrete/tangible_thing.rb",
-            class_name_matches ?
+            attribute.class_name_matches? ?
               "belongs_to :#{attribute.name_without_id}#{optional_line}" :
               "belongs_to :#{attribute.name_without_id}, class_name: \"#{attribute.options[:class_name]}\"#{optional_line}",
             "belongs_to :#{attribute.name_without_id}"
@@ -1177,7 +1187,7 @@ class Scaffolding::Transformer
           # however, this won't do anything if the association is already there.
           scaffold_add_line_to_file(
             "./app/models/scaffolding/completely_concrete/tangible_thing.rb",
-            class_name_matches ?
+            attribute.class_name_matches? ?
               "belongs_to :#{attribute.name_without_id}#{optional_line}" :
               "belongs_to :#{attribute.name_without_id}, class_name: \"#{attribute.options[:class_name]}\"#{optional_line}",
             BELONGS_TO_HOOK,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.7.11
+  version: 1.7.12
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -164,6 +164,10 @@ files:
 - lib/bullet_train/super_scaffolding/version.rb
 - lib/bullet_train/terminal_commands.rb
 - lib/generators/super_scaffold/USAGE
+- lib/generators/super_scaffold/action_models/performs_export/USAGE
+- lib/generators/super_scaffold/action_models/performs_export/performs_export_generator.rb
+- lib/generators/super_scaffold/action_models/performs_import/USAGE
+- lib/generators/super_scaffold/action_models/performs_import/performs_import_generator.rb
 - lib/generators/super_scaffold/action_models/targets_many/USAGE
 - lib/generators/super_scaffold/action_models/targets_many/targets_many_generator.rb
 - lib/generators/super_scaffold/action_models/targets_one/USAGE