scaffold_plus 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50d302dc3f95b88359a6225eecd90c2b42e2b1a1
-  data.tar.gz: 84209f42800021b06ef49179f759976c885b477a
+  metadata.gz: a08fcefd45e286fd8445802b84da15d435af04e8
+  data.tar.gz: 07646c0fcff9389f982d2b2b5c3972e43715bdae
 SHA512:
-  metadata.gz: ef3389982dd0ffc31a98b44dc697986e26b7c4c1360f4b402065e9fc6f0e54a7b7c546922f0921ca55ac0550fd2dc66cbb8d6650d8104d2d221fbe2528532fc8
-  data.tar.gz: 0f244a6fc9a876c2573b7a4421a41e7052c2101044469e3da5b4ed266a78573ff20dc9b4eccb644c3ffeb83cd53bc2d6a53efc3a71b077145b9e6ffb72ceecc7
+  metadata.gz: 2bc399c4a5be223a17ec05c73d750831c2648ed236539aefa70a10c5d878c794eeb9cd2be86e54e184979f878b19ad8ef443121b71a93406007fbb850bda7fb6
+  data.tar.gz: 82b65abe4d9d91a9c5890949608fd822833129a57bd586d784461f95e751c525c82281f4c89ae86115f7c3ae4939b2d9a90f02daef0ce20a279bc18fde14294d

data/README.md

@@ -34,6 +34,16 @@ to a newly created resource route.
 ### Add ancestry to create a tree structure (or hierarchy)
     rails generate scaffold_plus:ancestry
 
+This helper adds has_ancestry to the model and updates the mass assignment
+whitelist in the controller. It can also add a migration.
+
+### Add many-to-many association with intermediate join table
+    rails generate scaffold_plus:many_to_many
+
+This helper creates a join table and updates the two parent resources.
+It can handle additional attributes in the join table incl. whitelisting
+and accepts_nested_attributes_for in one of the parents.
+
 ## Testing
 
 Since I have no experience with test driven development (yet), this is

data/lib/generators/scaffold_plus/has_many/has_many_generator.rb

@@ -41,9 +41,9 @@ module ScaffoldPlus
           text = before_array.include?(name) ? "\n" : ""
           text << "  has_many :#{children}"
           text << ", inverse_of: :#{name}" if options.inverse?
-          text << ", dependent: :#{dependent}" if options[:dependent]
+          text << ", dependent: :#{dependent}" if options[:dependent].present?
           text << "\n"
-          text << "  accepts_nested_attributes_for :#{children}\n" if options[:nested]
+          text << "  accepts_nested_attributes_for :#{children}\n" if options[:nested].present?
           text << "\n" if after_array.include?(name)
           text
         end
@@ -61,7 +61,7 @@ module ScaffoldPlus
       end
       
       def add_to_permit
-        return unless options[:nested]
+        return unless options[:nested].present?
         list = options[:nested].map{|n| ":#{n}"}.join(', ')
         text = "#{children}_attributes: [ #{list} ]"
         file = "app/controllers/#{table_name}_controller.rb"
@@ -81,7 +81,7 @@ module ScaffoldPlus
       end
       
       def dependent
-        if options[:dependent] && options[:dependent] == "restrict"
+        if options[:dependent].present? && options[:dependent] == "restrict"
           "restrict_with_exception"
         else
           options[:dependent]

data/lib/generators/scaffold_plus/many_to_many/many_to_many_generator.rb

@@ -0,0 +1,110 @@
+require 'rails/generators/active_record'
+
+module ScaffoldPlus
+  module Generators
+    class ManyToManyGenerator < ActiveRecord::Generators::Base
+      desc "Add many-to-many association with intermediate join table"
+      argument :name, type: :string,
+               desc: "The name of the intermediate table"
+      argument :one, type: :string,
+               desc: "The first object that has_many TWO objects through NAME"
+      argument :two, type: :string,
+               desc: "The second object that has_many ONE objects through NAME"
+      class_option :attributes, type: :array, banner: 'name:type [...]',
+               desc: 'Additional attributes for the join table'
+      class_option :dependent, type: :string, banner: 'ACTION',
+               desc: 'Can be destroy, delete, or restrict'
+      class_option :nested, type: :array, banner: 'attribute [...]',
+               desc: 'Add accepts_nested_attributes_for to ONE incl. whitelisting'
+      class_option :counter, type: :boolean, default: false,
+               desc: 'Add counter_cache to ONE (and only to ONE)'
+      class_option :before, type: :array,
+               desc: 'Add a line before generated text in models'
+      class_option :after, type: :array,
+               desc: 'Add a line after generated text in models'
+      class_option :migration, type: :boolean, default: true,
+               desc: 'Create a migration for the join table'
+      class_option :index, type: :boolean, default: true,
+               desc: 'Add an index to the migration'
+      source_root File.expand_path('../templates', __FILE__)
+      
+      def add_migration
+        return unless options.migration?
+        migration_template 'many_to_many_migration.rb', "db/migrate/#{migration_name}.rb"
+      end
+      
+      def add_counter
+        return unless options.counter?
+        migration_template 'counter_migration.rb', "db/migrate/#{counter_migration}.rb"
+      end
+      
+      def add_to_models
+        [[one, two], [two, one]].each do |pair|
+          current, partner = pair
+          inject_into_class "app/models/#{current}.rb", current.camelize do
+            text = before_array.include?(current) ? "\n" : ""
+            text << "  has_many :#{table_name}"
+            text << ", dependent: :#{dependent}" if options[:dependent].present?
+            text << "\n"
+            text << "  has_many :#{partner.pluralize}, through: :#{table_name}\n"
+            if current == one
+              text << "  accepts_nested_attributes_for :#{table_name}\n" if options[:nested].present?
+            end
+            text << "\n" if after_array.include?(current)
+            text
+          end
+        end
+        
+        template 'many_to_many_model.rb', "app/models/#{name}.rb"
+      end
+      
+      def add_to_permit
+        return unless options[:nested].present?
+        list = options[:nested].map{|n| ":#{n}"}.join(', ')
+        text = "#{table_name}_attributes: [ #{list} ]"
+        file = "app/controllers/#{one.pluralize}_controller.rb"
+        gsub_file file, /(permit\(.*)\)/, "\\1, #{text})"
+        # Special case: no previous permit
+        gsub_file file, /^(\s*params)\[:#{name}\]$/, "\\1.require(:#{name}).permit(#{text})"
+      end
+      
+      protected
+      
+      def before_array
+        options['before'] || []
+      end
+      
+      def after_array
+        options['after'] || []
+      end
+      
+      def dependent
+        if options[:dependent].present? && options[:dependent] == "restrict"
+          "restrict_with_exception"
+        else
+          options[:dependent]
+        end
+      end
+      
+      def migration_name
+        "create_#{table_name}"
+      end
+      
+      def create_index?
+        options.index?
+      end
+      
+      def counter_migration
+        "add_#{table_name}_count_to_#{one}"
+      end
+      
+      def counter_cache
+        options.counter? ? ", counter_cache: true" : ""
+      end
+      
+      def attributes
+        options[:attributes] || []
+      end
+    end
+  end
+end

data/lib/generators/scaffold_plus/many_to_many/templates/counter_migration.rb

@@ -0,0 +1,5 @@
+class <%= counter_migration.camelize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= one.pluralize %>, :<%= table_name %>_count, :integer
+  end
+end

data/lib/generators/scaffold_plus/many_to_many/templates/many_to_many_migration.rb

@@ -0,0 +1,17 @@
+class <%= migration_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+      t.belongs_to :<%= one %>
+      t.belongs_to :<%= two %>
+<%- attributes.each do |attribute| -%>
+      t.<%= attribute.split(':').second %> :<%= attribute.split(':').first %>
+<%- end -%>
+
+      t.timestamps
+    end
+<%- if create_index? -%>
+    add_index :<%= table_name %>, :<%= one %>_id
+    add_index :<%= table_name %>, :<%= two %>_id
+<%- end -%>
+  end
+end

data/lib/generators/scaffold_plus/many_to_many/templates/many_to_many_model.rb

@@ -0,0 +1,4 @@
+class <%= class_name %> < ActiveRecord::Base
+  belongs_to :<%= one %><%= counter_cache %>
+  belongs_to :<%= two %>
+end

data/lib/scaffold_plus/version.rb

@@ -1,3 +1,3 @@
 module ScaffoldPlus
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scaffold_plus
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Volker Wiegand
@@ -86,6 +86,10 @@ files:
 - lib/generators/scaffold_plus/has_many/has_many_generator.rb
 - lib/generators/scaffold_plus/has_many/templates/child_migration.rb
 - lib/generators/scaffold_plus/has_many/templates/counter_migration.rb
+- lib/generators/scaffold_plus/many_to_many/many_to_many_generator.rb
+- lib/generators/scaffold_plus/many_to_many/templates/counter_migration.rb
+- lib/generators/scaffold_plus/many_to_many/templates/many_to_many_migration.rb
+- lib/generators/scaffold_plus/many_to_many/templates/many_to_many_model.rb
 - lib/scaffold_plus.rb
 - lib/scaffold_plus/version.rb
 - scaffold_plus.gemspec