rails-new-app 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93081e6a5b8f36849c4d4a799966cefd00ca97133cfe35bef967c020fd7eff63
-  data.tar.gz: b629ee3815475d9917eeefedc90d8973a9d7162c5b27ab93c13625646c038df3
+  metadata.gz: a2d108c27dd154b223f683f5cd2fdd6efc5871a5419146de56112fff357de6d3
+  data.tar.gz: d4cfbbb2754df7c54d711e71679c1763e01659594db614f67647150a3bca3f51
 SHA512:
-  metadata.gz: 5a2d9590d597b7ac2abe68b4d27ac09b274ee48fc52dc9bba40cfa28c3c41357bb5594e0be4fef2859df877936b20a98ecb5c1d4bb20366dc8c9d5cf69cd318f
-  data.tar.gz: 56bc800f44e839ae8ba63fb810890365d7963e8100c6e01fafa494a8846cc0d43039fc279bdb22820e2b6ab78e880a27f187882e14580650c4137018f8c026cf
+  metadata.gz: 206bd5da44b2aaca70734ebf6db67900e214774bc3775638af3589c2abf1b085e08fe8b3cf01ee5ae165c4c448c9dd4f616851e86ff03a1401f0b6e5ed415e89
+  data.tar.gz: fd63025c4f3a0ef5f27e1d7a16443c669b67122f22b2132ef7dd8905b628e782664c1cfc8c0f802f103dc07dc84fc5664ff96622a813dd7ff969e0c876374e84

data/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: COVERAGE=true bundle exec rake test

data/.gitignore

@@ -54,3 +54,5 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+defaults.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "minitest"
+gem "rake"
+gem "byebug"
+
+group :development, :test do
+  gem "standard"
+end
+
+group :test do
+  gem "simplecov", require: false
+  gem "simplecov-console", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    docile (1.4.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    standard (1.1.1)
+      rubocop (= 1.14.0)
+      rubocop-performance (= 1.11.2)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  minitest
+  rake
+  simplecov
+  simplecov-console
+  standard
+
+BUNDLED WITH
+   2.2.11

data/README.md

@@ -1,5 +1,5 @@
 # rails-new-app
-Command-line tool to assist in the creation of new Rails 5 and 6 apps
+Command-line tool to assist in the creation of new Rails 6 apps
 
 ## Installation:
 
@@ -9,23 +9,22 @@ Run `gem install "rails-new-app"`
 
 Run `rails-new-app` command and follow the step by step wizard.
 
-### Alternative
-
-If, for any reason, the menu navigation does not work, run `rails-new-app navigation=false`.
+It will use the current default Rails version, so you should install the version you want to use, these generators are currently tested with Rails 6.
 
 ## Current configurations:
-- Rails version (validate and install)
-- Database: none / MySQL / PostgreSQL / SQLite
+- Database: MySQL / PostgreSQL / SQLite
 - Tests:
 - - runner: none / Minitest / RSpec
 - - CodeCoverage: none / Simplecov
 - - Factories: none / FactoryBot
 - - Fake data: none / Faker
 - TemplateEngine: None (just ERB) / Slim / HAML
-- RubyLinter: None / RuboCop / StandardRB
 - FormBuilder: None / Simple Form / Formtastic
-- JS Framework: None / ReactJS / VueJS / Angular / Elm / Stimulus
 - Pagination: None / Pagy / Kaminari / WillPaginate
+- JS Framework: None / ReactJS / VueJS / Angular / Elm / Stimulus
+- Authorization: None / Pundit / CanCanCan
+- Authentication: None / Devise
+- RubyLinter: None / RuboCop / StandardRB
 
 ## TODOs and ideas:
 - improve GUI and UX
@@ -36,29 +35,33 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga
 - add more tools
 - support `rails new` flags configuration
 - research requirements
-- improve validations (check rails version, ruby version, if gems are compatible with rails, etc)
-- show the user the current Ruby version
 - support a `rails-new-app-defaults` file at the HOME dir to set default options if empty answers
 
 #### Ideas for other tools:
-- support other databases like MongoDB that require more config
-- type of app: standard/minimal/api
+- dotenv/figaro
+- resque/sideqik/suckerpunch/other?
+- CSS framework? bootstrap/tailwind/material/spectre/bulma (this affects the form builders processor)
 - CI config? github actions / travis / circleci / bitbucket / gitlab / others
-- js linter? None/ESlint/StandardJS
-- devise?
 - carrierwave/paperclip/dragonfly?
+- js linter? None/ESlint/StandardJS
 - exception_notification / airbreak / other reporting tools
-- dotenv/figaro
 - redis?
 - memcached/dalli/other?
-- resque/sideqik/suckerpunch/other?
-- CSS framework? bootstrap/tailwind/material/spectre/bulma (this affects the form builders processor)
 - add basic docker config?
-- admin gems? ActiveAdmin/RailsAdmin/Trestle/others
 - pre-commit hooks? overcommit
-- cancancan/pundit ?
+- admin gems? ActiveAdmin/RailsAdmin/Trestle/others
+- type of app: standard/minimal/api
+- support other databases like MongoDB that require more config
+
+## For developers
 
-## Adding more configurations and tools:
+### Setup:
+
+- Clone the repo
+- Run `bundle install`
+- You can run the app with `./exe/rails-new-app`
+
+### Adding more configurations and tools:
 
 1. Add a new step at `lib/rails-new-app/steps` (or modify an existing one)
 2. Collect step config in the `config` hash
@@ -70,6 +73,36 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga
 
 * Steps 5 and 6 are split so we can run `bundle install` once.
 
+### Quick scripted execution:
+
+Since the app uses the STDIN to configure the generator, you can pipe a stream of inputs that a user would do to the command to quickly set all the desired options. For example:
+
+```
+# inside any text file, like... defaults.txt
+1
+MyApp
+2
+3
+8
+2
+0
+Y
+```
+
+These inputs set the name (1) to `MyApp`, then goes to database config (2) and sets PostrgreSQL (3), then goes to pagination (8) and sets Pagy (2), finally, it goes to `review and confirm` (0) and confirms it (Y).
+
+With that file you can do a quick setup with:
+
+```sh
+cat defaults.txt | rails-new-app
+```
+
+This can eventually be used to share complete setups or generate defaults.
+
+### Tests:
+
+Run `rake test` or `COVERAGE=true rake test`.
+
 ## Changelogs
 
 ### 0.0.1
@@ -84,3 +117,10 @@ Added navigation between menus.
 - Add a git initial commit
 - Added new tools: Faker, pagination gems
 - Bug fixing
+
+### 0.1
+- Refactor screens (ex steps) handling
+- Refactor user input handling to allow easier testing
+- Added tests for multiple screens
+- Bug fixing (Pagy config, incorrect indexing)
+- Added SimpleCov and easier dev setup

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/rails-new-app.rb

@@ -15,6 +15,6 @@ module RailsNewApp
     end
     ARGV.clear
 
-    Runner.new.run(navigation)
+    Runner.new(navigation: navigation).run
   end
 end

data/lib/rails-new-app/processors/authentication_processor.rb

@@ -0,0 +1,16 @@
+module RailsNewApp
+  class AuthenticationProcessor < Processor
+    def update_gemfile(config)
+      case config[:authentication][:key]
+      when "devise" then apply_template "devise-gemfile"
+      end
+    end
+
+    def configure(config)
+      puts "Processing Authentication config"
+      case config[:authentication][:key]
+      when "devise" then apply_template "devise-config"
+      end
+    end
+  end
+end

data/lib/rails-new-app/processors/authorization_processor.rb

@@ -0,0 +1,18 @@
+module RailsNewApp
+  class AuthorizationProcessor < Processor
+    def update_gemfile(config)
+      case config[:authorization][:key]
+      when "pundit" then apply_template "pundit-gemfile"
+      when "cancancan" then apply_template "cancancan-gemfile"
+      end
+    end
+
+    def configure(config)
+      puts "Processing Authorization config"
+      case config[:authorization][:key]
+      when "pundit" then apply_template "pundit-config"
+      when "cancancan" then apply_template "cancancan-config"
+      end
+    end
+  end
+end

data/lib/rails-new-app/runner.rb

@@ -1,57 +1,55 @@
-require_relative "steps"
+require_relative "screens"
 require_relative "processors"
 require "readline"
+require "byebug"
 
 module RailsNewApp
-  class Runner
-    # use option: nil to hide the screen from the main menu
-    SCREENS = [
-      {option: "1", class: AppNameStep},
-      {option: "2", class: RailsVersionStep},
-      {option: "3", class: DatabaseStep},
-      {option: "4", class: TestRunnerStep},
-      {option: "5", class: JavaScriptFrameworkStep},
-      {option: "6", class: RubyLinterStep},
-      {option: "7", class: TemplateEngineStep},
-      {option: "8", class: FormBuilderStep},
-      {option: "9", class: PaginationStep},
-      {option: nil, class: CodeCoverageStep},
-      {option: nil, class: TestFactoryStep},
-      {option: nil, class: TestFakeDataStep}
-    ].freeze
-
-    def get_screen(option)
-      case option.to_s
-      when /\A\d+\z/
-        SCREENS.find { |x| x[:option] == option.to_s }
-      else
-        SCREENS.find { |x| x[:class].key == option.to_sym }
-      end
-    end
+  # use option: nil to hide the screen from the main menu
+  SCREENS = [
+    {option: "1", page: 1, class: AppNameScreen},
+    {option: "2", page: 1, class: DatabaseScreen},
+    {option: "3", page: 1, class: TestRunnerScreen},
+    {option: "4", page: 1, class: JavaScriptFrameworkScreen},
+    {option: "5", page: 1, class: RubyLinterScreen},
+    {option: "6", page: 1, class: TemplateEngineScreen},
+    {option: "7", page: 1, class: FormBuilderScreen},
+    {option: "8", page: 1, class: PaginationScreen},
+    {option: "1", page: 2, class: AuthScreen},
+    {option: nil, class: CodeCoverageScreen},
+    {option: nil, class: TestFactoryScreen},
+    {option: nil, class: TestFakeDataScreen},
+    {option: nil, class: AuthenticationScreen},
+    {option: nil, class: AuthorizationScreen}
+  ].freeze
 
-    attr_reader :config
+  class Runner
+    attr_accessor :config, :current_page, :current_screen, :menu
 
-    # entry point
-    def run(navigation = true)
-      @config = {navigation: navigation}.tap do |h|
+    def initialize(navigation: true)
+      @menu = MenuScreen.new SCREENS
+      @current_screen = @menu
+      @navigation = navigation
+      @config = {}.tap do |h|
         SCREENS.each do |s|
           kls = s[:class]
           h[kls.key] = kls.default
         end
       end
+    end
 
+    # entry point
+    def run
       intro
 
-      confirmed =
-        if navigation
-          show_menu
+      confirmation =
+        if @navigation
+          start
         else
           steps
           review_and_confirm
         end
 
-      if confirmed
-        install_rails
+      if confirmation == :finish
         rails_new
         process_config
         end_message
@@ -62,132 +60,71 @@ module RailsNewApp
       end
     end
 
-    def clear
-      system("clear")
-    end
-
     def intro
       clear
       puts "Let's create a new Rails app step by step"
     end
 
-    def print_screens
-      SCREENS.each do |s|
-        next if s[:option].nil?
-
-        screen_name = s[:class].clean_name
-        puts "#{s[:option]} : #{screen_name}"
-      end
-      puts "0 : Review and confirm"
-      puts ""
-      puts "Type the number of the menu and press enter:"
+    def show_current_screen
+      puts current_screen.screen_text
     end
 
-    def show_menu
-      print_screens
+    def start
+      next_do = nil
+
       loop do
+        show_current_screen
         option = gets.chomp.strip
-        if option == "0"
-          case review_and_confirm
-          when :yes then return true
-          when :no then return false
-          end
-          clear
-          print_screens
-        else
-          show_screen(option)
-        end
-      end
-    end
 
-    def show_screen(option)
-      if (s = get_screen(option))
-        screen_obj = s[:class].new
-        config[s[:class].key] = screen_obj.run(config)
+        next_do = process_user_input(option)
+        case next_do
+        when :finish, :abort then break
+        end
         clear
-        screen_obj.next_step ? show_screen(screen_obj.next_step) : print_screens
-      else
-        puts "Invalid option, select a category:"
       end
+
+      next_do
     end
 
-    def steps
-      config[:app_name] = AppNameStep.run(config)
-      config[:rails_version] = RailsVersionStep.run(config)
-      config[:database] = DatabaseStep.run(config)
-      config[:test_runner] = TestRunnerStep.run(config)
+    def process_user_input(option)
+      next_step, new_config = @current_screen.process_user_input(option)
 
-      if config[:test_runner][:key] != ""
-        config[:code_coverage] = CodeCoverageStep.run(config)
-        config[:test_factory] = TestFactoryStep.run(config)
-        config[:test_fake_data] = TestFakeDataStep.run(config)
+      if new_config
+        @config[@current_screen.class.key] = new_config
       end
 
-      config[:js_framework] = JavaScriptFrameworkStep.run(config)
-      config[:ruby_linter] = RubyLinterStep.run(config)
-      config[:template_engine] = TemplateEngineStep.run(config)
-      config[:form_builder] = FormBuilderStep.run(config)
-      config[:pagination] = PaginationStep.run(config)
-    end
-
-    def review_and_confirm
-      clear
-      rails_ver = config[:rails_version]
-      rails_ver = "Using latest installed Rails version" if rails_ver == ""
-
-      puts <<~REVIEW
-        ===== New Rails app config =====
-        
-        App name: #{config[:app_name]}
-        Ruby version: #{RUBY_VERSION}
-        Rails version: #{rails_ver}
-        Database: #{config[:database]}
-        Test runner: #{config[:test_runner]}
-        Code coverage: #{config[:code_coverage]}
-        Test factories: #{config[:test_factory]}
-        Test fake data: #{config[:test_fake_data]}
-        JS framework: #{config[:java_script_framework]}
-        Ruby Linter: #{config[:ruby_linter]}
-        Template engine: #{config[:template_engine]}
-        Form builder: #{config[:form_builder]}
-        Pagination: #{config[:pagination]}
-        
-      REVIEW
-
-      message = "Type 'Y(es)' to confirm, 'B(ack) to go back, or 'N(o)' to abort"
-      if config[:app_name] == ""
-        puts <<~WARNING
-          =====================================
-                   App name is required        
-          =====================================
-          
-        WARNING
-        message.gsub!("Type 'Y(es)' to confirm, ", "Type ")
+      case next_step
+      when :menu then @current_screen = @menu
+      when :review_and_confirm then @current_screen = ReviewAndConfirmScreen.new(config)
+      when :finish, :abort, :rerender then next_step
+      else
+        @current_screen = get_screen(next_step).new(config)
       end
+    end
 
-      loop do
-        puts message
-        answer = gets.chomp.strip
-        return :yes if /\A*Y(es)?\z/i.match?(answer)
-        return :back if /\A*B(ack)?\z/i.match?(answer)
-        return :no if /\A*N(o)?\z/i.match?(answer)
+    def steps
+      config[:app_name] = AppNameScreen.run(config)
+      config[:database] = DatabaseScreen.run(config)
+      config[:test_runner] = TestRunnerScreen.run(config)
 
-        puts "Invalid option."
+      if config[:test_runner][:key] != ""
+        config[:code_coverage] = CodeCoverageScreen.run(config)
+        config[:test_factory] = TestFactoryScreen.run(config)
+        config[:test_fake_data] = TestFakeDataScreen.run(config)
       end
-    end
 
-    def install_rails
-      return if config[:rails_version] == ""
-      # install the require rails version if needed
-      puts "Verifying and installing Rails #{config[:rails_ven]}"
-      `gem install rails -v#{config[:rails_version]}`
+      config[:js_framework] = JavaScriptFrameworkScreen.run(config)
+      config[:ruby_linter] = RubyLinterScreen.run(config)
+      config[:template_engine] = TemplateEngineScreen.run(config)
+      config[:form_builder] = FormBuilderScreen.run(config)
+      config[:pagination] = PaginationScreen.run(config)
     end
 
     def rails_new
       puts "Running Rails new"
       command = build_rails_new_command
       puts command
-      system(command)
+      run_cmnd(command)
     end
 
     def process_config
@@ -202,11 +139,13 @@ module RailsNewApp
           TemplateEngineProcessor,
           FormBuilderProcessor,
           RubyLinterProcessor,
-          PaginationProcessor
+          PaginationProcessor,
+          AuthorizationProcessor,
+          AuthenticationProcessor
         ].each { |p| p.update_gemfile(config) }
 
         # install gems
-        system("bundle install")
+        run_cmnd("bundle install")
 
         # configure each gem
         [
@@ -215,7 +154,9 @@ module RailsNewApp
           TestFactoryProcessor,
           FormBuilderProcessor,
           RubyLinterProcessor,
-          PaginationProcessor
+          PaginationProcessor,
+          AuthorizationProcessor,
+          AuthenticationProcessor
         ].each { |p| p.configure(config) }
 
         after_create
@@ -235,19 +176,15 @@ module RailsNewApp
       puts "Aborted"
     end
 
-    private
-
     # final step and creation
     def build_rails_new_command
       ["rails"].tap do |ar|
-        # use specific Rails version
-        ar << "_#{config[:rails_version]}_" if config[:rails_version] != ""
         # new command
         ar << "new"
         # use desired database
-        ar << "--database=#{config[:database][:key]}" if config[:database][:in_rails_new]
+        ar << "--database=#{config[:database][:key]}" if config[:database][:in_rails_new] && !config[:database][:is_default]
         # ignore test if not minitest
-        ar << "--skip_test" if config[:test_runner][:key] != "minitest"
+        ar << "--skip-test" if config[:test_runner][:key] != "minitest"
         # use desired js framework
         ar << "--webpack=#{config[:java_script_framework][:key]}" if config[:java_script_framework][:in_rails_new]
         # ar << "--skip-javascript"
@@ -258,14 +195,28 @@ module RailsNewApp
 
     def fix_code_style
       case config[:ruby_linter][:key]
-      when "rubocop" then system("rubocop -A")
-      when "standardrb" then system("standardrb --fix")
+      when "rubocop" then run_cmnd("rubocop -A")
+      when "standardrb" then run_cmnd("standardrb --fix")
       end
     end
 
     def initial_commit
-      system("git add .")
-      system("git commit -a -m 'Initial commit'")
+      run_cmnd("git add .")
+      run_cmnd("git commit -a -m 'Initial commit'")
+    end
+
+    private
+
+    def clear
+      run_cmnd("clear")
+    end
+
+    def run_cmnd(cmd)
+      system(cmd) unless ENV["env"] == "test"
+    end
+
+    def get_screen(key)
+      SCREENS.find { |x| x[:class].key == key.to_sym }[:class]
     end
   end
 end