rails_app 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82dcc08138eb02ce0aafb95ddd5ac1122f2ed79d4510262c3991bc8c2a5eaeb4
-  data.tar.gz: 47207c80b368ed13984db09d55f437332c9ea97d64d105582f6ef4b95ca27cf7
+  metadata.gz: 58716cd225034bd8c2deecc05e99d82b58d05ffbbdeadc3b721a526d249a4b1e
+  data.tar.gz: 531c6ecd9e5a5910d0170a53a2cf50e31f294037ae2deeb21908eb2de626f45b
 SHA512:
-  metadata.gz: a12f159b7870cc8036d68fa1547de18420292166df000b4e8f72f4d78bff6207020081f264602afe0e9da164dc37d6a25ab0d094b6c577ddcad09c4000a99772
-  data.tar.gz: 8bd93c9bec6c3b2542d58d288b93e57c55f3c87e68d0a3f82fdabf0cc377c83efa3afac28a806b262ee54f245cf7276fe11de122ecfb0adda77e83fb0dcaa26c
+  metadata.gz: 0be667225b33a863c11cd13a0a9f1fa5cf52b70983d6cd3c549c89f3e1012942a0bb44dd1de6f695db48dca5275e23512a5e053541439bfa73480ba73b6ccc68
+  data.tar.gz: 420dc812fc3fb540a55b072c4a4ec18635862efbdb2bdf751de64890dc279b33b76cbbb4840a81cc296bf06d1ba72d068439311e1a5e57d13d361b126e09461f

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.8.0](https://github.com/eclectic-coding/rails_app/tree/0.8.0) (2024-04-05)
+
+[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.7.0...0.8.0)
+
+**Implemented enhancements:**
+
+- setup `tty-config` to save a new config [\#24](https://github.com/eclectic-coding/rails_app/issues/24)
+- Add more tests [\#4](https://github.com/eclectic-coding/rails_app/issues/4)
+- Setup tty config to save a new config [\#25](https://github.com/eclectic-coding/rails_app/pull/25) ([eclectic-coding](https://github.com/eclectic-coding))
+- 4 add more tests [\#23](https://github.com/eclectic-coding/rails_app/pull/23) ([eclectic-coding](https://github.com/eclectic-coding))
+
+## [0.7.0](https://github.com/eclectic-coding/rails_app/tree/0.7.0) (2024-04-04)
+
+[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.6.0...0.7.0)
+
+**Implemented enhancements:**
+
+- handle optional CLI ARGV [\#21](https://github.com/eclectic-coding/rails_app/issues/21)
+- Add user option to select other styling systems [\#2](https://github.com/eclectic-coding/rails_app/issues/2)
+- Handle optional cli argv [\#22](https://github.com/eclectic-coding/rails_app/pull/22) ([eclectic-coding](https://github.com/eclectic-coding))
+
 ## [0.6.0](https://github.com/eclectic-coding/rails_app/tree/0.6.0) (2024-04-04)
 
 [Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.5.0...0.6.0)

data/README.md

@@ -1,5 +1,6 @@
 ![GitHub License](https://img.shields.io/github/license/eclectic-coding/rails_app)
 [![Tests](https://github.com/eclectic-coding/rails_app/actions/workflows/ci.yml/badge.svg)](https://github.com/eclectic-coding/rails_app/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/rails_app.svg)](https://badge.fury.io/rb/rails_app)
 # RailsApp
 
 RailsApp is a gem that provides a simple way to create a new Rails application with a pre-configured set of gems and settings, utilizing the Rails application templates feature.
@@ -23,15 +24,46 @@ To bootstrap a new Rails application: `rails_app`
 
 The user will be prompted to enter the name of the new Rails application, and the select the assets pipeline to use (propshaft or sprockets), and a styling option:
 
-![](./screenshot_cli.png)
+![](assets/screenshot_cli.png)
 
 Also, you can select your database of choice:
 
-![](./screenshot_cli_db.png)
+![](assets/screenshot_cli_db.png)
 
 The template will then create a new Rails application with the selected options.
 
-### Testing
+### Optional CLI Syntax
+
+There is an additional syntax, available starting with release `v. 0.7.0`, which allows you to use `rails_app` very similarly to the `rails new` command:
+
+
+```bash
+rails_app new my_app -a propshaft --css bootstrap -d postgresql
+```
+I few things to note:
+- the `app_name` must be first, just like with `rails new`
+- the following arguments and flags must be separated by a space `-a propshaft`. Since, the parser ignores the flag and checks for the specific keywords only, you technically can use the follow: `rails_app my_app propshaft bootstrap postgresql`. 
+
+If you use this syntax, the template will not prompt you the application name, and subsequent options will be preselected for you.
+
+Right not this syntax only supports the following options:
+- app name
+- assets pipeline
+- styling
+- database
+
+More options will be added in future releases.
+
+## Configuration
+**NEW** Starting with release `v. 0.8.0`, you can save your preferred defaults to you users home directory (`rails_aap-config.yml`).
+If a file has been previously saved, you will be prompted if you want to use:
+![](assets/screenshot_cli_readconfig.png)
+
+
+Then your options will be pre-selected:
+![](assets/screenshot_cli_useconfig.png)
+
+## Testing
 The template includes RSpec for testing, which includes pre configured:
 - FactoryBot
 - Faker

data/bin/rails_app

@@ -2,4 +2,4 @@
 
 require "rails_app"
 
-RailsApp::App.rails_app
+RailsApp::App.rails_app(ARGV)

data/lib/rails_app/cli.rb

@@ -4,22 +4,46 @@ require "tty-prompt"
 
 module RailsApp
   class CLI
-    def self.start
+    def self.start(args)
       prompt = TTY::Prompt.new
 
-      app_name = prompt.ask("What is the name of your application?", required: true)
-      assets = prompt.select("How would you like to manage assets?", %w[propshaft sprockets])
-      styling_choices = [
-        {name: "Bootstrap", value: "bootstrap"},
-        {name: "Tailwind CSS", value: "tailwind"},
-        {name: "Bulma", value: "bulma"},
-        {name: "PostCSS", value: "postcss"},
-        {name: "SASS", value: "sass"}
-      ]
-      styling = prompt.select("How would you like to manage styling?", styling_choices)
-      database = prompt.select("Which database would you like to use?", %w[postgresql sqlite3 mysql trilogy oracle sqlserver jdbcmysql jdbcsqlite3 jdbcpostgresql jdbc])
-
-      Command.new(app_name: app_name, assets: assets, styling: styling, database: database).run
+      options_data = OptionsData.new(args)
+      config_file = ConfigFile.new
+
+      app_name = options_data.app_name || prompt.ask("What is the name of your application?", required: true)
+
+      # Read the configuration and ask the user if they want to use it
+      config_options = config_file.read
+      if config_options && prompt.yes?("Do you want to use this configuration? #{config_options}")
+        options_data = OptionsData.from_config(config_options)
+      end
+
+      assets = prompt.select("How would you like to manage assets?", %w[propshaft sprockets], default: options_data.default_assets)
+      styling = prompt.select("How would you like to manage styling?", %w[bootstrap tailwind bulma postcss sass], default: options_data.default_styling)
+      database = prompt.select("Which database would you like to use?",
+        %w[postgresql sqlite3 mysql trilogy oracle sqlserver jdbcmysql jdbcsqlite3 jdbcpostgresql jdbc],
+        default: options_data.default_database)
+
+      # Collect all configuration options into a hash
+      config_options = {
+        app_name: app_name,
+        assets: assets,
+        styling: styling,
+        database: database
+      }
+
+      # Ask the user if they wish to save their configuration
+      if prompt.yes?("Do you wish to save your configuration?")
+        # Iterate over the hash and set the configuration
+        config_options.each do |key, value|
+          next if key == :app_name
+          config_file.set(key, value)
+        end
+        config_file.write(force: true)
+        puts "Configuration saved successfully @ #{config_file.full_path}"
+      end
+
+      Command.new(config_options).run
     end
   end
 end

data/lib/rails_app/command.rb

@@ -1,14 +1,12 @@
-# frozen_string_literal: true
-
 module RailsApp
   class Command
     attr_reader :app_name, :assets, :styling, :database
 
-    def initialize(app_name:, assets:, styling:, database:)
-      @app_name = app_name
-      @assets = assets
-      @styling = styling
-      @database = database
+    def initialize(args)
+      @app_name = args[:app_name]
+      @assets = args[:assets]
+      @styling = args[:styling]
+      @database = args[:database]
     end
 
     def template
@@ -17,6 +15,7 @@ module RailsApp
 
     def run
       command = "rails new #{@app_name} --no-rc #{skip_spring} #{database_adapter} #{asset_management} #{javascript_bundling} #{styling_framework} #{testing_framework} -m #{template}"
+      command.squeeze!(" ")
       puts command
       system(command)
     end

data/lib/rails_app/config_file.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "tty-config"
+
+module RailsApp
+  class ConfigFile
+    def initialize
+      @config = TTY::Config.new
+      @config.append_path(Dir.home)
+      @config.filename = "rails_app-config"
+      @config.extname = ".yml"
+    end
+
+    def exist?
+      @config.exist?
+    end
+
+    def set(key, value)
+      @config.set(key, value: value)
+    end
+
+    def write(force: false)
+      @config.write(force: force)
+    end
+
+    def full_path
+      File.join(@config.location_paths[0] + "/" + @config.filename + @config.extname)
+    end
+
+    def read
+      @config.read if exist?
+      @config.to_h
+    end
+  end
+end

data/lib/rails_app/options_data.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RailsApp
+  class OptionsData
+    attr_reader :options
+
+    def initialize(args)
+      @options = args
+    end
+
+    def self.from_config(config_hash)
+      new_args = config_hash.map { |key, value| value.to_s }
+      new(new_args)
+    end
+
+    def app_name
+      @options[0]
+    end
+
+    def default_assets
+      @options.include?("sprockets") ? "sprockets" : "propshaft"
+    end
+
+    def default_styling
+      if @options.any? { |option| option.end_with?("tailwind") }
+        "tailwind".strip
+      elsif @options.any? { |option| option.end_with?("bulma") }
+        "bulma".strip
+      elsif @options.any? { |option| option.end_with?("postcss") }
+        "postcss".strip
+      elsif @options.any? { |option| option.end_with?("sass") }
+        "sass"
+      elsif @options.any? { |option| option.end_with?("bootstrap") }
+        "bootstrap"
+      else
+        "bootstrap"
+      end
+    end
+
+    def default_database
+      if @options.include?("postgresql")
+        "postgresql"
+      elsif @options.include?("mysql")
+        "mysql"
+      elsif @options.include?("trilogy")
+        "trilogy"
+      elsif @options.include?("oracle")
+        "oracle"
+      elsif @options.include?("sqlserver")
+        "sqlserver"
+      elsif @options.include?("jdbcmysql")
+        "jdbcmysql"
+      elsif @options.include?("jdbcsqlite3")
+        "jdbcsqlite3"
+      elsif @options.include?("jdbcpostgresql")
+        "jdbcpostgresql"
+      elsif @options.include?("jdbc")
+        "jdbc"
+      else
+        "sqlite3"
+      end
+    end
+  end
+end

data/lib/rails_app/rails_app.rb

@@ -2,8 +2,8 @@
 
 module RailsApp
   class App
-    def self.rails_app
-      RailsApp::CLI.start
+    def self.rails_app(args)
+      RailsApp::CLI.start(args)
     end
   end
 end

data/lib/rails_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsApp
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/rails_app.rb

@@ -6,5 +6,7 @@ module RailsApp
   autoload :App, "rails_app/rails_app"
   autoload :CLI, "rails_app/cli"
   autoload :Command, "rails_app/command"
+  autoload :OptionsData, "rails_app/options_data"
+  autoload :ConfigFile, "rails_app/config_file"
   autoload :Error, "rails_app/error"
 end

data/rails_app.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bootsnap", "~> 1.18", ">= 1.18.3" # used by rails new
   spec.add_dependency "thor", "~> 1.3", ">= 1.3.1"
   spec.add_dependency "tty-prompt", "~> 0.23.1"
+  spec.add_dependency "tty-config", "~> 0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_app
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Chuck Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootsnap
@@ -64,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: tty-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Bootstrap a new customized Rails application with a better development
   experience.
 email:
@@ -80,11 +94,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/screenshot_cli.png
+- assets/screenshot_cli_db.png
+- assets/screenshot_cli_readconfig.png
+- assets/screenshot_cli_useconfig.png
 - bin/rails_app
 - lib/rails_app.rb
 - lib/rails_app/cli.rb
 - lib/rails_app/command.rb
+- lib/rails_app/config_file.rb
 - lib/rails_app/error.rb
+- lib/rails_app/options_data.rb
 - lib/rails_app/rails_app.rb
 - lib/rails_app/template/.rspec
 - lib/rails_app/template/.rubocop.yml
@@ -226,8 +246,6 @@ files:
 - lib/rails_app/template/template.rb
 - lib/rails_app/version.rb
 - rails_app.gemspec
-- screenshot_cli.png
-- screenshot_cli_db.png
 homepage: https://github.com/eclectic-coding/rails_app
 licenses:
 - MIT