rails_steroids 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2d152b0dac80d9a18dd7bbb082304395d3a26072b2acbcb9666e3550e6e755
-  data.tar.gz: 0755766a977aceb72eba7bf389f56ea3b13952d68ca8e8c89f0c1727ddcf509d
+  metadata.gz: 656c3847e194bf888f0b4c12482d3d7ba06200ab1af54d433bada03401d84398
+  data.tar.gz: 7bd0c50707fb1e44a256f09c5645cc1e8410bc0f7f131c20ea8f4cf70f22431b
 SHA512:
-  metadata.gz: 0c4fbaa6605cae87bc92f95b7c5db9728efbacba6631a62e588d8648b9301e048b9aa1a283ef87917320d2865db8e5bc94c17e0e039e67d667c355ed8a1224c2
-  data.tar.gz: d2f1b6282b7918ac5fbc549d15468c37ba3442444b7a2a45399e0bf13ec6733ba5846a7a5f7792277b3790cae002f772250c77007db5424bb4b94944e2818f2f
+  metadata.gz: cce4f6c5f46464d33fb3c9e8721a5d6db48595be7369bba3487882ee3c98c77fa98b57f653d6490254ad0815fed235f0b8c37534e4d4415b0d69d8bb7423bc73
+  data.tar.gz: 98e2c27907407481adf9c168116b2cc5e46c992d9c5c12d2f5892f30e41cfe38c9eba051b4208bdef7ba9c8fed0b8e19b5d82f6435335f62fb2497a36f18d19d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.6.0] - 2024-02-07
+
+- New steroid recipe: migration (Create new migration interactively)
+
+## [0.5.0] - 2024-02-06
+
+- New steroid recipe: model (Create new model interactively)
+
 ## [0.4.0] - 2024-02-06
 
 - New steroid recipe: controller (Create new controller interactively)

data/README.md

@@ -49,6 +49,8 @@ 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/controller/controller_generator.rb

@@ -24,7 +24,7 @@ module Steroid
 
       custom_actions = []
       while prompt.select("Would you like to add more actions?", boolean_choices)
-        custom_actions << prompt.ask("specify name of action:") do |q|
+        custom_actions << prompt.ask("Specify name of action:") do |q|
           q.required true
           q.modify :remove
         end

data/lib/generators/steroid/migration/USAGE

@@ -0,0 +1,21 @@
+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

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

@@ -0,0 +1,178 @@
+# 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"]
+      prompt = TTY::Prompt.new
+      boolean_choices = [{name: "yes", value: true}, {name: "no", value: false}]
+
+      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'},
+        # {name: 'Add column', value: 'add_column'},
+        # {name: 'Remove column', value: 'remove_column'},
+        # {name: 'Add index', value: 'add_index'},
+        # {name: 'Remove index', value: 'remove_index'},
+      ]
+      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, need_timestamps?)
+        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), need_timestamps?)
+        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?", required: true) { |q| q.modify :remove }
+      #   columns_to_be_added = collect_columns_data
+      #   columns_to_be_removed
+      #   migration_template "migration.rb", "#{db_migrate_path}/drop_#{table_name}.rb"
+      # when 'add_column'
+      # when 'remove_column'
+      # when 'add_index'
+      # when 'remove_index'
+      end
+    end
+
+    private
+
+    def collect_columns_data
+      prompt = TTY::Prompt.new
+      boolean_choices = [{name: "yes", value: true}, {name: "no", value: false}]
+      columns = []
+      while prompt.select("Would you like to add model attributes(columns)?", boolean_choices)
+        columns_data = { meta: {} }
+        column_name = prompt.ask("Specify name of column:", required: true) { |q| q.modify :remove }
+
+        column_type = prompt.select("Choose type of column:", %w(references boolean string text integer decimal float binary date time datetime primary_key digest token))
+
+        if column_type == 'references'
+          columns_data[:meta][:polymorphic] = true if prompt.select("Polymorphic association?", boolean_choices)
+        end
+        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
+            columns_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
+            columns_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
+            columns_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
+          columns_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)
+          columns_data[:meta][:index] = prompt.select("Unique index?", boolean_choices) ? :unique : true
+        end
+
+        columns_data.merge!(name: column_name, type: column_type)
+        columns << columns_data
+      end
+      columns
+    end
+
+    def need_timestamps?
+      prompt = TTY::Prompt.new
+      boolean_choices = [{name: "yes", value: true}, {name: "no", value: false}]
+      prompt.select("Add timestamps?", boolean_choices)
+    end
+
+    def content_for_create_table(table_name, columns_data, need_timestamps)
+      columns_data_content = columns_data.map do |c|
+        column_row = ["t.#{c[:type]} :#{c[:name]}"]
+        c[:meta].each { |key, value| column_row << "#{key}: #{value.inspect}" }
+        column_row.join(', ')
+      end
+      columns_data_content << "t.timestamps" if need_timestamps
+      <<-CONTENT
+  def change
+    create_table :#{table_name}#{primary_key_type} do |t|
+      #{columns_data_content.join("\n      ")}
+    end
+  end
+      CONTENT
+    end
+
+    def content_for_create_join_table(table1_name, table2_name, table_name, columns_data, need_timestamps)
+      columns_data_content = columns_data.map do |c|
+        column_row = ["t.#{c[:type]} :#{c[:name]}"]
+        c[:meta]&.each { |key, value| column_row << "#{key}: #{value.inspect}" }
+        column_row.join(', ')
+      end
+      columns_data_content << "t.timestamps" if need_timestamps
+      <<-CONTENT
+  def change
+    create_join_table :#{table1_name}, :#{table2_name}, table_name: :#{table_name} do |t|
+      #{columns_data_content.join("\n      ")}
+    end
+  end
+      CONTENT
+    end
+
+    def content_for_drop_table(table_name)
+      <<-CONTENT
+  def change
+    drop_table :#{table_name}
+  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/generators/steroid/model/USAGE

@@ -0,0 +1,22 @@
+Description:
+    `steroid:model` will create Model interactively.
+
+Usage Example:
+    # with installed gem
+    rails_steroids inject steroid:model
+    # with bundler
+    bin/rails g steroid:model
+
+What will this do?:
+    Create new Rails model with configurations selected interactively.
+    Current options available to customize are:
+        * Model name
+        * 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
+        * Skip creating migration?
+        * Skip created_at, updated_at timestamps?
+        * Skip indexes?

data/lib/generators/steroid/model/model_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'tty/prompt'
+
+module Steroid
+  class ModelGenerator < Rails::Generators::Base
+    desc "Adds Model to the application"
+    source_root File.expand_path("templates", __dir__)
+
+    def add_model
+      say "Injecting steroid: Model", :green
+      cmd = ["rails generate model"]
+      prompt = TTY::Prompt.new
+      model_name = prompt.ask("What is the great name of your model?") do |q|
+        q.required true
+        q.modify :remove
+      end
+      cmd << model_name
+
+      boolean_choices = [{name: "yes", value: true}, {name: "no", value: false}]
+
+      columns = []
+      while prompt.select("Would you like to add model attributes(columns)?", boolean_choices)
+
+        column_name = prompt.ask("Specify name of column:") do |q|
+          q.required true
+          q.modify :remove
+        end
+
+        column_type = prompt.select("Choose type of column:", %w(references integer decimal float boolean binary string text date time datetime primary_key digest token))
+
+        if column_type == 'references'
+          column_type = "#{column_type}{polymorphic}" if prompt.select("Polymorphic association?", boolean_choices)
+        end
+        if %w(integer string text binary).include?(column_type)
+          if prompt.select("Set limit?", boolean_choices)
+            limit = prompt.ask("Specify limit:") do |q|
+              q.required true
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            column_type = "#{column_type}{#{limit}}"
+          end
+        end
+        if column_type == 'decimal'
+          if prompt.select("Set precision & scale?", boolean_choices)
+            precision = prompt.ask("Specify precision:") do |q|
+              q.required true
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            scale = prompt.ask("Specify scale:") do |q|
+              q.required true
+              q.modify :remove
+              q.convert(:int, "Invalid input! Please provide integer value.")
+            end
+            column_type = "'#{column_type}{#{precision},#{scale}}'"
+          end
+        end
+
+        index_option = nil
+        if prompt.select("Add index?", boolean_choices)
+          index_option = prompt.select("Unique index?", boolean_choices) ? 'uniq' : 'index'
+        end
+
+        columns << [column_name, column_type, index_option].compact.join(':')
+      end
+      cmd += columns
+
+      cmd << "--no-migration" if prompt.select("Skip migration?", boolean_choices)
+      cmd << "--no-timestamps" if prompt.select("Skip created_at, updated_at timestamps?", boolean_choices)
+      cmd << "--no-indexes" if prompt.select("Skip indexes?", boolean_choices)
+
+      run cmd.join(" ")
+    end
+  end
+end

data/lib/generators/steroid/steroid_generator.rb

@@ -36,7 +36,7 @@ class SteroidGenerator < Rails::Generators::NamedBase
           # with bundler
           bin/rails g steroid:#{name}
 
-      This will create:
+      What will this do?:
           what/will/it/create
     RUBY
   end

data/lib/rails_steroids/cli.rb

@@ -25,6 +25,8 @@ 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.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_steroids
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Anand Bait
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,6 +106,11 @@ 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
 - lib/generators/steroid/new_project/new_project_generator.rb
 - lib/generators/steroid/steroid_generator.rb