rails_steroids 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce6fbe0a8cf0bdac91965f3a73e05a01b415a68358d81899ed9745bc1777115
-  data.tar.gz: 9eefd09397f43fa4d36a6cb50989afdeb1b1902638f097765c8e9d9cb0fa7892
+  metadata.gz: 575fafaef4cda7385ace12ae8c8c6ba3469ca6a8720eb54692240a79739ca6c1
+  data.tar.gz: 764ba190e5246e78820af6bae9598ab498258133b513f0cc26f7767bd90bb2ee
 SHA512:
-  metadata.gz: 624785f5c35d1b51368c5629c94b16ab96b62528f4e003c26ca9f0707a1d9b3ac5c1f540ed4e1995eca01c8782b25653298b24fb459517e7254c164935356572
-  data.tar.gz: 186c3eac0b2e7368ae0b6da42cb67618ead70105f72db44ab0a16adc2c3813277d4a6c08e8cab44310617468b1349b20cf110141c3e1b981eda9b45245d5b815
+  metadata.gz: 73d18703d85c492632f3348941505cd748ff34855f4b293a8127128a5c278b07e7716b1e5f9754d296560846f0ce0304b23e7d0452a71b60b2f119d375a3453b
+  data.tar.gz: c9e6807f7f94a24e956ba7f1e7c8d0348495168c761f149cb8b573a7882f6bbfd823b90dcde840ffc4fa5ea4a8fea2c801f01d398936b60a5a8a9776fcb06492

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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)
+- Documentation improvement
+
 ## [0.3.1] - 2024-02-06
 
 - Improvement in steroid recipe new_project : Code improvement (variable name for boolean_choices)

data/README.md

@@ -11,9 +11,9 @@
 
 Any small idea evolves when it actually starts taking shape. But most of the time, when we think of developing an idea as a POC or hobby project, we end up spending more time in setting up the project and lose the momentum. And you must have realised that many tasks that we do with a new project from scratch are quite repetitive. 
 
-Rails templates and other templating gems are a way of quickly generating an application but when it comes to adding some features in an already generated application then we need some way to do that. We have certain inbuilt generators which can be used for basic components but they need more coding over it.
+Rails templates and other templating gems are a way of quickly generating an application but when it comes to adding some features in an already generated application then we need some way to do that. We have certain inbuilt generators which can be used for basic components but they need more coding over it. Also remembering options is a also a task or you will have to go through documentation to select options to be provided to generators.
 
-So here are steroids for your application, which are actually generators with special powers. This gem contains different steroids which will setup commonly used features very quickly and reduce your coding work so that you can focus on your precious idea.
+So here are steroids for your application, which are actually generators with special powers. This gem contains different steroids which will run generators interactively help you choose options and so you will not have to remember them. Going forward the gem will also contain steroids which will setup commonly used features and functionalities from gems very quickly and reduce your coding work so that you can focus on your precious idea. Using these steroids is also very good for those who are learning Rails newly as you get to use generators interactively
 
 ## Installation
 
@@ -33,20 +33,24 @@ gem install rails_steroids
 ## Usage
 
 You can use the gem from command line using gem's CLI.
-You can inject the steroid into your application using command like:
-```
-rails_steroids inject steroid:STEROID_NAME
-```
 
 You can check the list of available steroids using command:
 ```
 rails_steroids list
 ```
 
+You can inject the steroid into your application using command like:
+```
+rails_steroids inject steroid:STEROID_NAME
+```
+and then enjoy easily entering or selecting options interactively to the questions asked on terminal.
+
 ## Available Steroids
 
 | Functionality | Command |
 |---|---|
+|model|`rails_steroids inject steroid:model`|
+|controller|`rails_steroids inject steroid:controller`|
 |new_project|`rails_steroids inject steroid:new_project`|
 
 ## Development

data/lib/generators/steroid/controller/USAGE

@@ -0,0 +1,17 @@
+Description:
+    `steroid:controller` will create Controller interactively.
+
+Usage Example:
+    # with installed gem
+    rails_steroids inject steroid:controller
+    # with bundler
+    bin/rails g steroid:controller
+
+What will this do?:
+    Create new Rails controller with configurations selected interactively.
+    Current options available to customize are:
+        * Controller name
+        * Choose from actions: index, show, new, edit, create, update, destroy
+        * Specify any custom/additional actions
+        * Skip adding routes
+        * Skip creating helper

data/lib/generators/steroid/controller/controller_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'tty/prompt'
+
+module Steroid
+  class ControllerGenerator < Rails::Generators::Base
+    desc "Adds Controller to the application"
+    source_root File.expand_path("templates", __dir__)
+
+    def add_controller
+      say "Injecting steroid: Controller", :green
+      cmd = ["rails generate controller"]
+      prompt = TTY::Prompt.new
+      controller_name = prompt.ask("What is the great name of your controller?") do |q|
+        q.required true
+        q.modify :remove
+      end
+      cmd << controller_name
+
+      actions = prompt.multi_select("Choose actions:", %w(index show new edit create update destroy))
+      cmd += actions
+
+      boolean_choices = [{name: "yes", value: true}, {name: "no", value: false}]
+
+      custom_actions = []
+      while prompt.select("Would you like to add more actions?", boolean_choices)
+        custom_actions << prompt.ask("Specify name of action:") do |q|
+          q.required true
+          q.modify :remove
+        end
+      end
+      cmd += custom_actions
+
+      cmd << "--skip-routes" if prompt.select("Skip routes?", boolean_choices)
+      cmd << "--no-helper" if prompt.select("Skip helper?", boolean_choices)
+
+      run cmd.join(" ")
+    end
+  end
+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/new_project/USAGE

@@ -1,5 +1,5 @@
 Description:
-    `steroid:new_project` will inject New Project functionality.
+    `steroid:new_project` will create New Project interactively.
 
 Usage Example:
     # with installed gem

data/lib/generators/steroid/steroid_generator.rb

@@ -28,7 +28,7 @@ class SteroidGenerator < Rails::Generators::NamedBase
   def create_usage_file
     create_file "lib/generators/steroid/#{name}/USAGE", <<~RUBY
       Description:
-          `steroid:#{name}` will inject #{name.titlecase} functionality.
+          `steroid:#{name}` will inject #{name.titlecase} functionality interactively.
 
       Usage Example:
           # with installed gem
@@ -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 = [
+        'model',
+        'controller',
         'new_project',
       ]
       steroid_names.each do |steroid|

data/lib/rails_steroids/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_steroids
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Anand Bait
@@ -104,6 +104,10 @@ files:
 - bin/console
 - bin/rails_steroids
 - bin/setup
+- lib/generators/steroid/controller/USAGE
+- lib/generators/steroid/controller/controller_generator.rb
+- 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