rails_app 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534816163e2b9fc2c353d1a2afb4568c8bd9b3355b46fcbe1b132b83cb89acad
-  data.tar.gz: e2e50fd1ebe97b1981da6713e49cc7595c8f11c58bb600b67e7b99088a745252
+  metadata.gz: fa0c7e932155134e3302a6ac298bf0042427dcbf1c43ee9ae91f44b4156718cb
+  data.tar.gz: 2870a89982c68aa08b3a8ee772d88a781174630967097a2dec87dd91cde662b4
 SHA512:
-  metadata.gz: d5242d9c1382772a58599ab08658745d6eac76a12c78ef2b83395af317a777abd022885028c5f664087882a4b6fed1331b831a0cc5dec9bd760746b5268ceb05
-  data.tar.gz: b3dcfc4ecbe21b2c96435606cb44bd7867f1de8d8da66075d50b9852db7d294580639434fdbef7f2fe4e81f72dcad879a5c336eeb5cf5a7ba1ea3b513a8fde16
+  metadata.gz: 2febb710ca10bbadc35bf436bf3aab125068ee2ae3c9b5415d3820217e12163a6ede6648afdfd660a89ca44ffa0a283426244c45b2be0984e12d56e2d595ccb1
+  data.tar.gz: 4abdce09c8d37c63f164c1bf70678852491dd816dd9f90e2acd2666b40271e8c210ec5d48e045ca0e11b06e817c310af474249155f5adfc0ab2ec4738fc0a72e

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [0.8.1](https://github.com/eclectic-coding/rails_app/tree/0.8.1) (2024-04-08)
+
+[Full Changelog](https://github.com/eclectic-coding/rails_app/compare/0.8.0...0.8.1)
+
+**Implemented enhancements:**
+
+- Read users existing .railsrc for preferences [\#1](https://github.com/eclectic-coding/rails_app/issues/1)
+
+**Fixed bugs:**
+
+- CLI Menu should be bypassed when using saved configuration [\#28](https://github.com/eclectic-coding/rails_app/issues/28)
+- CLI menu should be bypassed when using saved configuration [\#29](https://github.com/eclectic-coding/rails_app/pull/29) ([eclectic-coding](https://github.com/eclectic-coding))
+
+## [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)

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,11 +24,11 @@ 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.
 
@@ -35,8 +36,9 @@ The template will then create a new Rails application with the selected options.
 
 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
+rails_app my_app -a propshaft --css bootstrap -d postgresql
 ```
 I few things to note:
 - the `app_name` must be first, just like with `rails new`
@@ -52,15 +54,20 @@ Right not this syntax only supports the following options:
 
 More options will be added in future releases.
 
-## Testing
-The template includes RSpec for testing, which includes pre configured:
-- FactoryBot
-- Faker
-- Webmock
-- VCR
-- Simplecov
+## 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)
+
+
+The CLI menu will then be bypassed and the application with be created with your presets.
 
-### Code Quality Tools
+# Features
+
+## Authentication 
+documentation coming soon
+
+## Code Quality Tools
 The template includes the following code quality tools:
 - Rubocop using the `rubocop-rails-omakase` gem with a few custom settings in a provided `.rubocop.yml`
 - Brakeman for security scanning
@@ -69,10 +76,18 @@ The template includes the following code quality tools:
 All of this tools can be run using the following command, which also will run the test suite: `bin/ci`
 
 In addition, the template includes:
-- the `annotate` gem to annotate models and and factories with schema information
-- the `bullet` gem to help identify and remove N+1 queries
+- the `annotate` gem to annotate models and factories with schema information
+- the `bullet` gem to help identify and diagnose N+1 queries
+
+## Testing
+The template includes RSpec for testing, which includes pre configured:
+- FactoryBot
+- Faker
+- Webmock
+- VCR
+- Simplecov
 
-## Development
+# Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/lib/rails_app/cli.rb

@@ -5,29 +5,50 @@ require "tty-prompt"
 module RailsApp
   class CLI
     def self.start(args)
+      puts "args: #{args}"
       prompt = TTY::Prompt.new
-
       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)
 
-      assets = prompt.select("How would you like to manage assets?", %w[propshaft sprockets], default: options_data.default_assets)
-      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, default: options_data.default_styling)
+      # Read from existing 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}")
+
+        create_app(app_name, config_options) # standard:disable Style/IdenticalConditionalBranches
+      else
+        # not using config display menu to user
+        config_options = menu(app_name, prompt)
+
+        # 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
+
+        puts "config_options: #{config_options}"
+        create_app(app_name, config_options) # standard:disable Style/IdenticalConditionalBranches
+      end
+    end
 
+    def self.menu(app_name, prompt)
+      assets = prompt.select("How would you like to manage assets?", %w[propshaft sprockets])
+      styling = prompt.select("How would you like to manage styling?", %w[bootstrap tailwind bulma postcss sass])
       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)
+        %w[postgresql sqlite3 mysql trilogy oracle sqlserver jdbcmysql jdbcsqlite3 jdbcpostgresql jdbc])
 
-      # save configuration
+      {app_name: app_name, assets: assets, styling: styling, database: database}
+    end
 
-      Command.new(app_name: app_name, assets: assets, styling: styling, database: database).run
+    def self.create_app(app_name, args)
+      Command.new(app_name, args).run
     end
   end
 end

data/lib/rails_app/command.rb

@@ -1,14 +1,13 @@
-# frozen_string_literal: true
-
 module RailsApp
   class Command
     attr_reader :app_name, :assets, :styling, :database
 
-    def initialize(app_name:, assets:, styling:, database:)
+    def initialize(app_name, args)
       @app_name = app_name
-      @assets = assets
-      @styling = styling
-      @database = database
+      @assets = args[:assets]
+      @styling = args[:styling]
+      @database = args[:database]
+      puts "Command: #{@app_name} #{args[:app_name]}"
     end
 
     def template
@@ -17,7 +16,8 @@ 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}"
-      puts command
+      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

@@ -5,7 +5,7 @@ module RailsApp
     attr_reader :options
 
     def initialize(args)
-      @options = args.flat_map { |arg| arg.split(" ") }
+      @options = args
     end
 
     def app_name
@@ -17,15 +17,17 @@ module RailsApp
     end
 
     def default_styling
-      if @options.include?("tailwind")
-        "tailwind"
-      elsif @options.include?("bulma")
-        "bulma"
-      elsif @options.include?("postcss")
-        "postcss"
-      elsif @options.include?("sass")
+      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.include?("bootstrap")
+      elsif @options.any? { |option| option.end_with?("bootstrap") }
+        "bootstrap"
+      else
         "bootstrap"
       end
     end

data/lib/rails_app/template/template.rb

@@ -3,7 +3,7 @@
 require "fileutils"
 require "shellwords"
 
-puts "options: #{options}"
+# puts "options: #{options}"
 
 def add_template_to_source_path
   source_paths.unshift(File.expand_path(File.join(__dir__)))

data/lib/rails_app/version.rb

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

data/lib/rails_app.rb

@@ -7,5 +7,6 @@ module RailsApp
   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.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Chuck Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-08 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,10 +94,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/screenshot_cli.png
+- assets/screenshot_cli_db.png
+- assets/screenshot_cli_readconfig.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
@@ -227,8 +245,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