zen_pro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09bdf662ec106fd06acc6981f1f834c82ea21d8604b5b5cfee72ad3c83de0a50'
+  data.tar.gz: fb856080fad9946ae7d32926226e566f1ae9abdf1617053a5cc3b1b648fc1aba
+SHA512:
+  metadata.gz: e2dc2a15aa6a0ee277a0aa41bd44d24abc9a0abc16f72e4afd0c100dc36d53623b0158ffc13d182dd1a1572ec701d7eb6a7355a8a4f7f4c002eeba6b1189c169
+  data.tar.gz: 66d71ffd60bf5bcd37326e3116d6acc509c7dae1b56a9d843e478831dd8b75cfb4fb334c3b2e808477c4ceae0d11b48b13a42c0457868e587b45df6aaecba074

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-04
+
+- Initial release

data/README.md

@@ -0,0 +1,3 @@
+# Zen
+
+Zen - CLI for [Zero Config Rails](https://zeroconfigrails.com/)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/zen_pro

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/zen_pro/cli"
+
+ZenPro::CLI.start(ARGV)

data/lib/zen_pro/api/project_template.rb

@@ -0,0 +1,28 @@
+require "rest-client"
+
+module ZenPro
+  module Api
+    class ProjectTemplate
+      def fetch_details(id)
+        response = RestClient.get("#{api_url}/#{id}")
+
+        JSON.parse(response)
+      rescue RestClient::ExceptionWithResponse => e
+        raise e.response
+      end
+
+      private
+
+      def api_url
+        base_url =
+          if ENV["DEVELOPMENT"]
+            "http://localhost:3000"
+          else
+            "https://zeroconfigrails.com"
+          end
+
+        "#{base_url}/api/v1/project_templates"
+      end
+    end
+  end
+end

data/lib/zen_pro/cli.rb

@@ -0,0 +1,22 @@
+require "thor"
+
+require_relative "commands/generate"
+require_relative "commands/configure"
+
+module ZenPro
+  class CLI < Thor
+    map "g" => :generate
+    map %w[-v --version] => "version"
+
+    desc "create project and configure gems",
+         "Generate a Rails app and configure gems using Project Template configurations"
+    def generate(project_template_id)
+      Commands::Generate.run(project_template_id, options)
+    end
+
+    desc "version", "Display gem version", hide: true
+    def version
+      say "zen_pro/#{VERSION} #{RUBY_DESCRIPTION}"
+    end
+  end
+end

data/lib/zen_pro/commands/configure.rb

@@ -0,0 +1,87 @@
+require "tty-prompt"
+
+module ZenPro
+  module Commands
+    class Configure
+      def self.run(options)
+        new(options).execute
+      end
+
+      def initialize(options)
+        @app_name = options[:app_name]
+        @gems_configuration_commands =
+          options[:project_configurations]["gems_configuration_commands"]
+      end
+
+      # TODO: CLI doesn't exit when generators are not found, find some way to raise error and exit in this case. Maybe Rails doesn't raise any error at all when generators are not found?
+      def execute
+        return unless Dir.exist?(app_name)
+
+        if gems_configuration_commands.length.zero?
+          return
+        end
+
+        confirm_commands_to_execute
+
+        Dir.chdir(app_name) do
+          gems_configuration_commands.each do |command|
+            system! "bundle exec #{command}"
+            # TODO: save progress in some file inside the user's generated app so we can continue from same point if user leaves in the middle or if app exits due to some error. Also find some way to update configurations in async without stopping any gem configuration operations (not important till MVP)
+          end
+        end
+
+        # TODO: Run generators that have dynamic options here e.g. Github CI requires repository name
+
+        run_pending_migrations
+      end
+
+      def confirm_commands_to_execute
+        commands_to_display =
+          gems_configuration_commands
+            .map
+            .with_index do |command, index|
+              item_number = format("%02d", index + 1)
+
+              "#{item_number}. #{command}"
+            end
+            .join("\n")
+
+        prompt.say <<~BANNER
+        \nRails app is now ready with initial configurations. Next, we will move on to configuring gems you have chosen by executing following commands:
+
+        #{commands_to_display}
+        BANNER
+
+        continue_if? "\nContinue?"
+      end
+
+      def run_pending_migrations
+        Dir.chdir(app_name) { system! "bin/rails db:migrate" }
+      end
+
+      private
+
+      attr_reader :app_name, :gems_configuration_commands
+
+      def prompt
+        return @prompt if defined?(@prompt)
+
+        TTY::Prompt.new
+      end
+
+      def continue_if?(question)
+        return if prompt.yes?(question)
+
+        prompt.error "Cancelled"
+        exit
+      end
+
+      def system!(*args)
+        system(*args)
+      rescue StandardError
+        prompt.error "\n== Command #{args} failed =="
+        exit
+      end
+    end
+  end
+end

data/lib/zen_pro/commands/create.rb

@@ -0,0 +1,121 @@
+require "json"
+require "tty-prompt"
+require "tty-spinner"
+
+module ZenPro
+  module Commands
+    class Create
+      def self.run(options)
+        new(options).execute
+      end
+
+      def initialize(options)
+        @app_name = options[:app_name]
+        @project_configurations = options[:project_configurations]
+      end
+
+      def execute
+        generate_rails_app
+        run_bin_setup
+      rescue StandardError => e
+        system! "rm -rf #{app_name}"
+
+        raise e
+      end
+
+      private
+
+      attr_reader :app_name, :project_configurations
+
+      def generate_rails_app
+        rails_generate_command =
+          "rails new #{app_name} #{rails_generator_options}"
+        commands_to_display = [
+          rails_generate_command,
+          "bundle add boring_generators --group=development",
+          "bin/setup"
+        ]
+
+        if after_rails_generate_commands.length.positive?
+          commands_to_display.insert(2, after_rails_generate_commands)
+        end
+
+        commands_to_display =
+          commands_to_display
+            .map
+            .with_index { |command, index| "#{index + 1}. #{command}" }
+            .join("\n")
+
+        prompt.say <<~BANNER
+          \nWe will generate a new Rails app at ./#{app_name} and execute following commands:
+
+          #{commands_to_display}
+        BANNER
+
+        continue_if? "\nContinue?"
+
+        system! rails_generate_command
+
+        install_boring_generators_gem
+
+        Dir.chdir(app_name) do
+          after_rails_generate_commands.each do |command|
+            system! "bundle exec #{command}"
+          end
+        end
+      end
+
+      def run_bin_setup
+        Dir.chdir(app_name) { system! "bin/setup" }
+      end
+
+      def rails_generator_options
+        project_configurations["rails_generator_options"]
+      end
+
+      def after_rails_generate_commands
+        project_configurations["after_rails_generate_commands"]
+      end
+
+      def install_boring_generators_gem
+        message = <<~BANNER
+          \nZen requires boring_generators gem to install and configure gems you have chosen, adding it to your project's Gemfile so generators for gems are available inside your app during configuration.\n
+        BANNER
+
+        prompt.say message, color: :blue
+
+        Dir.chdir(app_name) do
+          system! "bundle add boring_generators --group=development"
+        end
+      end
+
+      # TODO: Register everything below this as Thor commands so they can be used throughout the app
+      def prompt
+        return @prompt if defined?(@prompt)
+
+        TTY::Prompt.new
+      end
+
+      # TODO: only load spinners if --silent option is enabled else output will be shown in shell so this is not required
+      def spinner
+        return @spinner if defined?(@spinner)
+
+        TTY::Spinner.new(format: :dots)
+      end
+
+      def continue_if?(question)
+        return if prompt.yes?(question)
+
+        prompt.error "Cancelled"
+        exit
+      end
+
+      def system!(*args)
+        system(*args)
+      rescue StandardError
+        prompt.error "\n== Command #{args} failed =="
+        exit
+      end
+    end
+  end
+end

data/lib/zen_pro/commands/generate.rb

@@ -0,0 +1,81 @@
+require "forwardable"
+
+require "thor"
+
+require_relative "create"
+require_relative "configure"
+require_relative "../api/project_template"
+
+module ZenPro
+  module Commands
+    class Generate
+      extend Forwardable
+
+      def self.run(project_template_id, options)
+        instance = new
+
+        instance.welcome_message
+        app_name = instance.ask_app_name
+        project_configurations =
+          instance.fetch_project_template_configurations(project_template_id)
+        all_options = {
+          project_template_id: project_template_id,
+          app_name: app_name,
+          project_configurations: project_configurations,
+          **options
+        }
+
+        ZenPro::Commands::Create.run(all_options)
+        # TODO: call class/method to save progress since rails app is now generated
+        ZenPro::Commands::Configure.run(all_options)
+        # TODO: API call to mark project as configured and store all configurations
+        instance.setup_complete_message(app_name)
+      rescue StandardError => e
+        prompt = TTY::Prompt.new
+
+        prompt.error "\nOops, Zen encountered an error!"
+
+        prompt.say "\n#{e.message}"
+      end
+
+      def welcome_message
+        prompt.say <<~BANNER
+            Welcome to Zero Config Rails!
+
+            We will ask you a few questions while all other options will automatically be added as per application configurations in the Web App.
+          BANNER
+      end
+
+      def ask_app_name
+        name =
+          prompt.ask "\nWhat would you like to name your app? e.g. zero_config_rails or zero-config-rails"
+
+        name.chomp
+      end
+
+      def fetch_project_template_configurations(id)
+        prompt.say "\nFetching your project's configurations from the server ..."
+
+        ZenPro::Api::ProjectTemplate.new.fetch_details(id)
+      end
+
+      def setup_complete_message(app_name)
+        prompt.say "\n🎉🎉🎉"
+        prompt.ok "Congratulations! Your app is fully configured.\n"
+
+        prompt.say <<~BANNER
+        1. Run the rails server with `cd #{app_name} && rails s`
+        2. You can access the app at http://localhost:3000
+      BANNER
+      end
+
+      private
+
+      def prompt
+        return @prompt if defined?(@prompt)
+
+        TTY::Prompt.new
+      end
+    end
+  end
+end

data/lib/zen_pro/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZenPro
+  VERSION = "0.1.0"
+end

data/lib/zen_pro.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "zen_pro/version"
+
+module ZenPro
+  class Error < StandardError
+  end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zen_pro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Prabin Poudel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: CLI for Zero Config Rails. Run the command and relax (zen mode).
+email:
+- probnpoudel@gmail.com
+executables:
+- zen_pro
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/zen_pro
+- lib/zen_pro.rb
+- lib/zen_pro/api/project_template.rb
+- lib/zen_pro/cli.rb
+- lib/zen_pro/commands/configure.rb
+- lib/zen_pro/commands/create.rb
+- lib/zen_pro/commands/generate.rb
+- lib/zen_pro/version.rb
+homepage: https://zeroconfigrails.com
+licenses:
+-
+metadata:
+  source_code_uri: https://github.com/Zero-Config-Rails/zen
+  bug_tracker_uri: https://github.com/Zero-Config-Rails/zen/issues
+  documentation_uri: https://github.com/Zero-Config-Rails/zen/blob/main/README.md
+  homepage_uri: https://zeroconfigrails.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: CLI for https://zeroconfigrails.com
+test_files: []