rails_steroids 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575fafaef4cda7385ace12ae8c8c6ba3469ca6a8720eb54692240a79739ca6c1
-  data.tar.gz: 764ba190e5246e78820af6bae9598ab498258133b513f0cc26f7767bd90bb2ee
+  metadata.gz: 9e8022f4d9c1864d8fb7886a799f32b7f8d0f7db85152a7f29db9810ce104367
+  data.tar.gz: 04571a62c83ac2d43d3294189265a9563e351fd43350dea47c413e2738d1b76e
 SHA512:
-  metadata.gz: 73d18703d85c492632f3348941505cd748ff34855f4b293a8127128a5c278b07e7716b1e5f9754d296560846f0ce0304b23e7d0452a71b60b2f119d375a3453b
-  data.tar.gz: c9e6807f7f94a24e956ba7f1e7c8d0348495168c761f149cb8b573a7882f6bbfd823b90dcde840ffc4fa5ea4a8fea2c801f01d398936b60a5a8a9776fcb06492
+  metadata.gz: 30fb811636d668a114df763e0f0eb50dffae19cef6ab6e2246a12772cfbabd8e6f3f4d8b66e948bbcd80f646d9233aca061259456b39712c16ecec78b91f36bd
+  data.tar.gz: 902918a36f478d5da29a785da787ab4eaf19896354f6c24fe2ca3143aba778b07535f6a689902fea8042085220f22b5e270a846f7f0c50cf37d9d42799e8dbb9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.7.0] - 2024-02-08
+
+- Improvement in steroid recipe: migration
+  - Create new migration interactively for modify table with
+    * add_column, remove_column
+    * add_index, remove_index
+    * add_remove, remove_reference
+
+## [0.6.0] - 2024-02-07
+
+- New steroid recipe: migration
+  - Create new migration interactively for
+    * Create table
+    * Create join table
+    * Drop table
+
 ## [0.5.0] - 2024-02-06
 
 - New steroid recipe: model (Create new model interactively)

data/README.md

@@ -49,6 +49,7 @@ and then enjoy easily entering or selecting options interactively to the questio
 
 | Functionality | Command |
 |---|---|
+|migration|`rails_steroids inject steroid:migration`|
 |model|`rails_steroids inject steroid:model`|
 |controller|`rails_steroids inject steroid:controller`|
 |new_project|`rails_steroids inject steroid:new_project`|

data/lib/generators/steroid/migration/USAGE

@@ -0,0 +1,25 @@
+Description:
+    `steroid:migration` will create Migration interactively.
+
+Usage Example:
+    # with installed gem
+    rails_steroids inject steroid:migration
+    # with bundler
+    bin/rails g steroid:migration
+
+What will this do?:
+    Create new Rails migration with configurations selected interactively.
+    Current options available to customize are:
+        * Create table, Create join table and Drop table
+        * Specify columns with column type and some other metadata
+        * Column metadata includes:
+            - limit for integer, string, text, binary
+            - precision and scale for decimal
+            - polymorphic for references
+            - index and unique index
+            - id column, custom join table name for join table creation
+            - Addition to original migration generator is we can set default value as well
+        * Modify table with
+            - add_column, remove_column
+            - add_index, remove_index
+            - add_remove, remove_reference

data/lib/generators/steroid/migration/migration_generator.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+require 'tty/prompt'
+require 'rails/version'
+require 'rails/generators/active_record'
+require 'rails/generators/active_record/migration'
+
+module Steroid
+  class MigrationGenerator < Rails::Generators::Base
+    desc "Adds Migration to the application"
+    source_root File.expand_path("templates", __dir__)
+    include ActiveRecord::Generators::Migration
+    include ActiveRecord::Migration::JoinTable
+
+    def add_migration
+      say "Injecting steroid: Migration", :green
+      cmd = ["rails generate migration"]
+
+      action_choices = [
+        {name: 'Create table', value: 'create_table'},
+        {name: 'Create join table', value: 'create_join_table'},
+        {name: 'Drop table', value: 'drop_table'},
+        {name: 'Modify table columns/index', value: 'modify_table'},
+      ]
+      @action = prompt.select("What would you like to do?", action_choices)
+
+      case @action
+      when 'create_table'
+        table_name = prompt.ask("What is the name of table to be created?", required: true) { |q| q.modify :remove }
+        @content = content_for_create_table(table_name, collect_columns_data)
+        migration_template "migration.rb", "#{db_migrate_path}/create_#{table_name}.rb"
+      when 'create_join_table'
+        table1_name = prompt.ask("What is the name of first table to be joined?", required: true) { |q| q.modify :remove }
+        table2_name = prompt.ask("What is the name of second table to be joined?", required: true) { |q| q.modify :remove }
+        table_name = prompt.ask("What is the custom name for join table?", default: find_join_table_name(table1_name, table2_name), required: true) { |q| q.modify :remove }
+        columns_data = []
+        if prompt.select("Add `id` column?", boolean_choices)
+          columns_data << {name: 'id', type: 'primary_key'}
+        end
+        if prompt.select("Add index for #{table1_name} foreign_key?", boolean_choices)
+          columns_data << {name: "#{table1_name.singularize}_id", type: 'index'}
+        end
+        if prompt.select("Add index for #{table2_name} foreign_key?", boolean_choices)
+          columns_data << {name: "#{table2_name.singularize}_id", type: 'index'}
+        end
+        if prompt.select("Add composite index for #{table1_name} and #{table2_name} foreign_key?", boolean_choices)
+          uniq_index_option = prompt.select("Unique combination index?", boolean_choices) ? {meta: {unique: true}} : {}
+          columns_data << {name: ["#{table2_name.singularize}_id", "#{table2_name.singularize}_id"], type: 'index'}.merge(uniq_index_option)
+        end
+        @content = content_for_create_join_table(table1_name, table2_name, table_name, (columns_data + collect_columns_data))
+        migration_template "migration.rb", "#{db_migrate_path}/create_join_table_#{table_name}.rb"
+      when 'drop_table'
+        table_name = prompt.ask("What is the name of table to be dropped?", required: true) { |q| q.modify :remove }
+        @content = content_for_drop_table(table_name)
+        migration_template "migration.rb", "#{db_migrate_path}/drop_#{table_name}.rb"
+      when 'modify_table'
+        table_name = prompt.ask("What is the name of table to add/remove columns/index?", required: true) { |q| q.modify :remove }
+        modify_table_choices = [
+          {name: 'Add column', value: 'add_column'}, {name: 'Remove column', value: 'remove_column'},
+          {name: 'Add index', value: 'add_index'}, {name: 'Remove index', value: 'remove_index'},
+          {name: 'Add reference', value: 'add_reference'}, {name: 'Remove reference', value: 'remove_reference'},
+          # {name: 'Add timestamps', value: 'add_timestamps'}, {name: 'Remove timestamps', value: 'remove_timestamps'},
+          {name: 'Exit', value: 'exit'}
+        ]
+        @content = []
+        file_name = []
+        while (modify_table_action = prompt.select("What would you like to do?", modify_table_choices)) != 'exit'
+          for_removal = modify_table_action.start_with?('remove_')
+          if modify_table_action.end_with?('_index') || modify_table_action.end_with?('_reference')
+            data = modify_table_action.end_with?('_index') ? ask_index_data(for_removal: for_removal) : ask_reference_data(for_removal: for_removal)
+            file_name << modify_table_action << data[:name]
+          else
+            data = ask_column_data(for_removal: for_removal)
+            file_name << (for_removal ? 'remove' : 'add') << data[:name]
+          end
+          @content << format_statement_for_modify_table(modify_table_action, table_name, data)
+        end
+        @content = content_for_modify_table(@content.join("\n    "))
+        migration_template "migration.rb", "#{db_migrate_path}/#{file_name.join('_')}_in_#{table_name}.rb"
+      end
+    end
+
+    private
+
+    def prompt
+      TTY::Prompt.new
+    end
+
+    def boolean_choices
+      [{name: "yes", value: true}, {name: "no", value: false}]
+    end
+
+    def collect_columns_data
+      columns_data = []
+      while prompt.select("Would you like to add model attributes(columns)?", boolean_choices)
+        columns_data << ask_column_data
+      end
+      timestamps_data = ask_timestamps_data
+      columns_data << timestamps_data if timestamps_data
+      columns_data
+    end
+
+    def ask_column_data(for_removal: false)
+      column_data = { meta: {} }
+      column_name = prompt.ask("Specify name of column:", required: true) { |q| q.modify :remove }
+
+      column_type_choices = %w(boolean string text integer decimal float binary date time datetime primary_key digest token)
+      column_type_choices << 'references' unless @action == 'modify_table'
+      column_type = prompt.select("Choose type of column:", column_type_choices)
+
+      if column_type == 'references'
+        column_data[:meta][:foreign_key] = true if prompt.select("Foreign_key to be #{for_removal ? 'removed' : 'added'}?", boolean_choices)
+        column_data[:meta][:polymorphic] = true if prompt.select("Polymorphic association?", boolean_choices)
+      end
+      unless for_removal
+        if %w(integer string text binary).include?(column_type)
+          if prompt.select("Set limit?", boolean_choices)
+            limit = prompt.ask("Specify limit:", required: true) do |q|
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            column_data[:meta][:limit] = limit
+          end
+        end
+        if column_type == 'decimal'
+          if prompt.select("Set precision & scale?", boolean_choices)
+            precision = prompt.ask("Specify precision:", required: true) do |q|
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            column_data[:meta][:precision] = precision
+            scale = prompt.ask("Specify scale:", required: true) do |q|
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            column_data[:meta][:scale] = scale
+          end
+        end
+
+        if %w(references primary_key digest token).exclude?(column_type) && prompt.select("Add default value?", boolean_choices)
+          acceptable_value_type = { 'text' => :string }[column_type] || column_type.to_sym
+          column_data[:meta][:default] = prompt.ask("Specify default value:", required: true) do |q|
+            q.modify :remove
+            q.convert(acceptable_value_type, "Invalid input! Please provide %{type} value.")
+          end
+        end
+
+        if prompt.select("Add index?", boolean_choices)
+          column_data[:meta][:index] = prompt.select("Unique index?", boolean_choices) ? :unique : true
+        end
+      end
+
+      column_data.merge!(name: column_name, type: column_type)
+      column_data
+    end
+
+    def ask_reference_data(for_removal: false)
+      column_data = { meta: {} }
+      column_data[:name] = prompt.ask("Specify name of reference:", required: true) { |q| q.modify :remove }
+      column_data[:meta][:foreign_key] = true if prompt.select("Foreign_key to be #{for_removal ? 'removed' : 'added'}?", boolean_choices)
+      column_data[:meta][:polymorphic] = true if prompt.select("Polymorphic association?", boolean_choices)
+      column_data
+    end
+
+    def ask_index_data(for_removal: false)
+      column_data = { meta: {} }
+      names = []
+      names << prompt.ask("Specify name of column:", required: true) { |q| q.modify :remove }
+      while prompt.select("Add more columns for Composite index?", boolean_choices)
+        names << prompt.ask("Specify name of another column:", required: true) { |q| q.modify :remove }
+      end
+      column_data[:name] = names
+      unless for_removal
+        column_data[:meta][:unique] = true if prompt.select("Unique index?", boolean_choices)
+      end
+      custom_name = prompt.ask("Specify custom name for index (optional):") { |q| q.modify :remove }
+      column_data[:meta][:name] = custom_name if custom_name.present?
+      column_data
+    end
+
+    def ask_timestamps_data
+      if prompt.select("Add timestamps?", boolean_choices)
+        { type: 'timestamps' }
+      end
+    end
+
+    def format_statement_for_modify_table(modify_table_action, table_name, column_data)
+      statement_data = ["#{modify_table_action} :#{table_name}"]
+      statement_data << if column_data[:name].is_a?(Array)
+        col_name = column_data[:name].size > 1 ? "[#{column_data[:name].map { |n| ":#{n}" }.join(', ')}]" : ":#{column_data[:name].first}"
+        "column: #{col_name}" if modify_table_action == 'remove_index'
+      else
+        ":#{column_data[:name]}"
+      end
+      statement_data << ":#{column_data[:type]}" if column_data[:type]
+      column_data[:meta].each { |key, value| statement_data << "#{key}: #{value.inspect}" }
+      statement_data = statement_data.join(', ')
+    end
+
+    def format_statement_for_create_table(columns_data)
+      columns_data.map do |c|
+        column_row = if c[:name].is_a?(Array)
+          ["t.#{c[:type]} [#{c[:name].map { |n| ":#{n}" }.join(', ')}]"]
+        elsif c[:name].nil?
+          ["t.#{c[:type]}"]
+        else
+          ["t.#{c[:type]} :#{c[:name]}"]
+        end
+        c[:meta].each { |key, value| column_row << "#{key}: #{value.inspect}" } if c[:meta]
+        column_row.join(', ')
+      end.join("\n      ")
+    end
+
+    def content_for_create_table(table_name, columns_data)
+      columns_data_content = format_statement_for_create_table(columns_data)
+      <<-CONTENT
+  def change
+    create_table :#{table_name}#{primary_key_type} do |t|
+      #{columns_data_content}
+    end
+  end
+      CONTENT
+    end
+
+    def content_for_create_join_table(table1_name, table2_name, table_name, columns_data)
+      columns_data_content = format_statement_for_create_table(columns_data)
+      <<-CONTENT
+  def change
+    create_join_table :#{table1_name}, :#{table2_name}, table_name: :#{table_name} do |t|
+      #{columns_data_content}
+    end
+  end
+      CONTENT
+    end
+
+    def content_for_drop_table(table_name)
+      <<-CONTENT
+  def change
+    drop_table :#{table_name}
+  end
+      CONTENT
+    end
+
+    def content_for_modify_table(statements)
+      <<-CONTENT
+  def change
+    #{statements}
+  end
+      CONTENT
+    end
+
+  end
+end

data/lib/generators/steroid/migration/templates/migration.rb.tt

@@ -0,0 +1,3 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+<%= @content -%>
+end

data/lib/rails_steroids/cli.rb

@@ -25,6 +25,7 @@ module RailsSteroids
       puts "| Functionality | Command |"
       puts "|---|---|"
       steroid_names = [
+        'migration',
         'model',
         'controller',
         'new_project',

data/lib/rails_steroids/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSteroids
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_steroids
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Anand Bait
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,6 +106,9 @@ files:
 - bin/setup
 - lib/generators/steroid/controller/USAGE
 - lib/generators/steroid/controller/controller_generator.rb
+- lib/generators/steroid/migration/USAGE
+- lib/generators/steroid/migration/migration_generator.rb
+- lib/generators/steroid/migration/templates/migration.rb.tt
 - lib/generators/steroid/model/USAGE
 - lib/generators/steroid/model/model_generator.rb
 - lib/generators/steroid/new_project/USAGE