rails_app_generator 0.0.6 → 0.0.9

data/exe/rag

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'pry'
+
+source_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../lib")
+$LOAD_PATH << source_path
+
+require 'rails_app_generator'
+
+if ARGV.empty?
+  puts 'Please provide a profile for the new application'
+  puts
+  puts 'See --help for more info'
+  exit 0
+elsif %w[-v --version].include? ARGV[0]
+  puts RailsAppGenerator::VERSION
+  exit 0
+end
+
+profile_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../profiles")
+profile_name = ARGV[0]
+profile_name += '.json' unless profile_name.end_with?('.json')
+profile_file = File.join(profile_path, profile_name)
+
+if File.exist?(profile_file)
+  puts "Using profile #{profile_file}"
+
+  profile = JSON.parse(File.read(profile_file), symbolize_names: true)
+  args = profile[:args]
+  opts = profile[:opts]
+  rails_options = RailsAppGenerator::RailsOptions.new(opts)
+
+  instance = RailsAppGenerator::Starter.new(args)
+  FileUtils.rm_rf(instance.target_path)
+  instance.start(rails_options)
+else
+  puts "Profile #{profile_file} not found"
+  exit 1
+end

data/lib/rails_app_generator/add_on.rb

@@ -66,7 +66,6 @@ module RailsAppGenerator
       protected
 
       def depends_on(*addon)
-        puts addon
         @dependencies = addon.map(&:to_sym)
       end
     end

data/lib/rails_app_generator/app_builder.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
+  # The application builder allows you to override elements of the application
+  # generator without being forced to reverse the operations of the default generator.
   class AppBuilder < Rails::AppBuilder
     # def bin
     #   super
@@ -13,9 +15,9 @@ module RailsAppGenerator
     #   RailsAppGenerator::AddOns::Credentials.apply
     # end
 
-    # def readme
-    #   template 'README.md.erb', 'README.md'
-    # end
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
 
     # def ruby_version
     #   RailsAppGenerator::AddOns::RubyVersion.new(Context.new(options)).apply

data/lib/rails_app_generator/app_generator.rb

@@ -22,8 +22,8 @@ module RailsAppGenerator
     class_option :add_services                , type: :boolean, default: false
     class_option :add_sidekiq                 , type: :boolean, default: false
     class_option :add_views                   , type: :boolean, default: false
-    class_option :add_errors                 , type: :boolean, default: false
-    class_option :add_scaffold               , type: :boolean, default: false
+    class_option :add_errors                  , type: :boolean, default: false
+    class_option :add_scaffold                , type: :boolean, default: false
     class_option :add_factory_bot             , type: :boolean, default: false
     class_option :add_shoulda                 , type: :boolean, default: false
 
@@ -141,15 +141,15 @@ module RailsAppGenerator
       add_if(:rubocop)
     end
 
-    def create_test_files
-      return if options[:skip_test]
+    # def create_test_files
+    #   return if options[:skip_test]
 
-      super if options[:test] == 'minitest'
+    #   super if options[:test] == 'minitest'
 
-      # puts options[:testing_framework]
+    #   # puts options[:testing_framework]
 
-      # add(:rspec) if options[:testing_framework] == 'rspec'
-    end
+    #   # add(:rspec) if options[:testing_framework] == 'rspec'
+    # end
 
     def finish_template
       puts 'finish template'
@@ -169,15 +169,46 @@ module RailsAppGenerator
       # invoke :rails_customization
       super
     end
+
     no_commands do
+      # USED BY AFTER_TEMPLATE
+      def gac(message)
+        return unless active?(:git)
+
+        git add: '.'
+        git commit: " -m '#{message}'"
+      end
+
+      def add_controller(name, *args)
+        generate(:controller, name, *args)
+      end
+
+      def add_scaffold(name, *args)
+        generate(:scaffold, name, *args)
+      end
+
+      def read_template(template_file)
+        path = find_in_source_paths(template_file)
+
+        File.read(path)
+      end
+
+      def join_templates(*template_files, join: "\n\n")
+        template_files.map { |template_file| read_template(template_file) }.join(join)
+      end
+
+      # Local template path is handy when you want template files used when working with the --template flag
+      attr_accessor :local_template_path
+
       def source_paths
-        [
-          context.rails_override_template_path,
-          context.rails_template_path
-        ]
+        paths = local_template_path ? [local_template_path] : []
+        paths << context.rails_override_template_path
+        paths << context.rails_template_path
+        paths
       end
 
       # Context wraps the configured options and can be made available to addons
+      # TODO: should I add local_template_path to the context?
       def context
         @context ||= Context.new(
           self.class.rails_template_path,
@@ -201,12 +232,40 @@ module RailsAppGenerator
         add(addon) if options[option_name]
       end
 
+      def skip_flag?(option_name)
+        value = options["skip_#{option_name}".to_sym]
+
+        return false if value.nil?
+
+        value == true
+      end
+
+      def add_flag?(option_name)
+        value = options["add_#{option_name}".to_sym]
+
+        return false if value.nil?
+
+        value == true
+      end
+
+      def active?(option_name)
+        add_flag?(option_name) || !skip_flag?(option_name)
+      end
+
       def uses?(addon)
-        return false if options["skip_#{addon}".to_sym]
+        return false unless active?(addon)
 
         addon = AddOn.get(addon)
         Dependencies.new(addon, context).satisfied?
       end
     end
+
+    protected
+
+    # rubocop:disable Naming/AccessorMethodName
+    def get_builder_class
+      RailsAppGenerator::AppBuilder
+    end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/rails_app_generator/notes/a2.txt

@@ -7,7 +7,6 @@ create  Gemfile
 create  app
 create  app/assets/config/manifest.js
 create  app/assets/stylesheets/application.css
-create  app/bob/boblike.txt
 create  app/channels/application_cable/channel.rb
 create  app/channels/application_cable/connection.rb
 create  app/controllers/application_controller.rb
@@ -75,6 +74,20 @@ create  tmp/cache
 create  tmp/cache/assets
 create  vendor
 create  vendor/.keep
+create  test/fixtures/files
+create  test/fixtures/files/.keep
+create  test/controllers
+create  test/controllers/.keep
+create  test/mailers
+create  test/mailers/.keep
+create  test/models
+create  test/models/.keep
+create  test/helpers
+create  test/helpers/.keep
+create  test/integration
+create  test/integration/.keep
+create  test/channels/application_cable/connection_test.rb
+create  test/test_helper.rb
 create  test/system
 create  test/system/.keep
 create  test/application_system_test_case.rb

data/lib/rails_app_generator/options/rails_options.rb

@@ -5,7 +5,7 @@ module RailsAppGenerator
     # NOTE: Currently you need to register new options in two places
     #       here and in lib/rails_app_generator/app_generator.rb
 
-    future_option   :template                   , type: :string                               # , desc: "Path to some #{name} template (can be a filesystem path or URL)"
+    register_option :template                   , type: :string                               # , desc: "Path to some #{name} template (can be a filesystem path or URL)"
     future_option   :database                   , type: :string , default: 'sqlite3'          # , desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
     register_option :skip_git                   , type: :boolean, default: false              # , desc: "Skip .gitignore file"
     future_option   :skip_keeps                 , type: :boolean, default: false              # , desc: "Skip source control .keep files"

data/lib/rails_app_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  VERSION = '0.0.6'
+  VERSION = '0.0.9'
 end

data/lib/rails_app_generator.rb

@@ -17,9 +17,9 @@ require 'rails_app_generator/options/map_option_boolean_flag'
 require 'rails_app_generator/options/build_option'
 require 'rails_app_generator/options/options_builder'
 require 'rails_app_generator/options/rails_options'
-require_relative 'rails_app_generator/context'
-require_relative 'rails_app_generator/dependencies'
-require_relative 'rails_app_generator/add_on'
+require 'rails_app_generator/context'
+require 'rails_app_generator/dependencies'
+require 'rails_app_generator/add_on'
 Dir[File.join(__dir__, 'rails_app_generator', 'addons', '*.rb')].sort.each { |file| require file }
 require 'rails_app_generator/app_builder'
 require 'rails_app_generator/app_generator'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.0.6",
+      "version": "0.0.9",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

data/profiles/rag-add-some-pages.json

@@ -0,0 +1,11 @@
+{
+  "args": {
+    "app_path": "add-some-pages",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/rag"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_bundle": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/test.rb"
+  }
+}

data/profiles/rag-bootstrap.json

@@ -0,0 +1,12 @@
+{
+  "args": {
+    "app_path": "bootstrap",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/rag"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_bootstrap.rb",
+    "css": "bootstrap"
+  }
+}

data/profiles/rag-simple.json

@@ -0,0 +1,11 @@
+{
+  "args": {
+    "app_path": "simple",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/rag"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_bundle": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_simple.rb"
+  }
+}

data/profiles/rag-tailwind.json

@@ -0,0 +1,12 @@
+{
+  "args": {
+    "app_path": "tailwind",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/rag"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_tailwind.rb",
+    "css": "tailwind"
+  }
+}

data/templates/README.md.erb

@@ -0,0 +1,43 @@
+# <%= app_name.humanize %>
+
+## Running your App
+
+The simplest way to start this up is by using [docker-compose](https://docs.docker.com/compose/):
+
+```bash
+docker-compose up
+```
+
+```
+rails db:setup
+rails db:migrate
+rails server
+```
+
+Open your browser on [localhost:3000](http://localhost:3000).
+
+## Development
+
+This app was generated using [Schienenzeppelin](https://github.com/hschne/schienenzeppelin) - there are tons of little tweaks to simplify your development workflow.
+
+For more details refer to the [Documentation](https://github.com/hschne/schienenzeppelin)
+
+## Deployment
+
+Deploy this application using Capistrano. Make sure you have a server set up and edit [deploy.rb](./config/deploy.rb) and [config/production.rb](./config/deploy/production.rb).
+
+``` ruby
+# deploy.rb
+set :repo_url, "git@github.com:user/your-project.git"
+
+# production.rb
+server "myserver.com", user: "deploy", roles: %w{app db web}
+```
+
+Then run:
+
+```bash
+cap production deploy
+```
+
+For more information on how to prepare a server for deployment you can follow [this guide](https://gorails.com/deploy/ubuntu/20.04).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_app_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.9
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootsnap
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
@@ -112,13 +126,14 @@ description: "    Create new Rails Application with custom opinions\n"
 email:
 - david@ideasmen.com.au
 executables:
-- rails_app_generator
+- rag
 extensions: []
 extra_rdoc_files: []
 files:
 - ".builders/_.rb"
 - ".builders/boot.rb"
 - ".builders/generators/01-bootstrap.rb"
+- ".builders/generators/project-plan.rb"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -130,9 +145,41 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- after_templates/README.md
+- after_templates/___base_template.rb
+- after_templates/___r7_hotwire.rb
+- after_templates/rag_bootstrap.rb
+- after_templates/rag_bootstrap/application-yield.html.erb
+- after_templates/rag_bootstrap/application.html.erb
+- after_templates/rag_bootstrap/component-cards-fancy.css
+- after_templates/rag_bootstrap/component-cards-fancy.html
+- after_templates/rag_bootstrap/component-cards-staff.css
+- after_templates/rag_bootstrap/component-cards-staff.html
+- after_templates/rag_bootstrap/component-cards-styled.html
+- after_templates/rag_bootstrap/component-footer.html
+- after_templates/rag_bootstrap/component-hero.html
+- after_templates/rag_bootstrap/component-nav.html
+- after_templates/rag_bootstrap/custom-bootstrap-import.scss
+- after_templates/rag_bootstrap/custom-using-css.css
+- after_templates/rag_bootstrap/custom-using-scss.scss
+- after_templates/rag_bootstrap/manifest.js
+- after_templates/rag_simple.rb
+- after_templates/rag_tailwind.rb
+- after_templates/rag_tailwind/component-cta.html
+- after_templates/rag_tailwind/component-faq.html
+- after_templates/rag_tailwind/component-footer.html
+- after_templates/rag_tailwind/component-hero.html
+- after_templates/rag_tailwind/component-nav.html
+- after_templates/rag_tailwind/component-section-begin.html
+- after_templates/rag_tailwind/component-section-end.html
 - bin/console
 - bin/setup
-- exe/rails_app_generator
+- docs/project-plan.md
+- docs/project-plan/project.drawio
+- docs/project-plan/project_done.svg
+- docs/project-plan/project_in_progress.svg
+- docs/project-plan/project_todo.svg
+- exe/rag
 - lib/rails_app_generator.rb
 - lib/rails_app_generator/add_on.rb
 - lib/rails_app_generator/addons/annotate.rb
@@ -187,7 +234,12 @@ files:
 - lib/rails_app_generator/version.rb
 - package-lock.json
 - package.json
+- profiles/rag-add-some-pages.json
+- profiles/rag-bootstrap.json
+- profiles/rag-simple.json
+- profiles/rag-tailwind.json
 - sig/rails_app_generator.rbs
+- templates/README.md.erb
 - templates/addons/annotate/auto_annotate_models.rake
 - templates/addons/continuous_integration/.github/workflows/build.yml.erb
 - templates/addons/devise/app/views/devise/confirmations/new.html.erb

data/exe/rails_app_generator

@@ -1,51 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'pathname'
-
-source_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../lib")
-$LOAD_PATH << source_path
-
-require 'rails_app_generator'
-
-# if ARGV.empty?
-#   puts 'Please provide a path for the new application'
-#   puts
-#   puts 'See --help for more info'
-#   exit 0
-# elsif %w[-v --version].include? ARGV[0]
-#   puts RailsAppGenerator::VERSION
-#   exit 0
-# end
-
-# templates_root = File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
-# RailsAppGenerator::AppGenerator.source_root templates_root
-# RailsAppGenerator::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
-
-# RailsAppGenerator::AppGenerator.start
-require 'pry'
-
-args = {
-  app_path: 'kw01_bootstrap',
-  destination_root: '/Users/davidcruwys/dev/kweb'
-}
-opts = {
-  skip_git: true,
-  skip_bundle: false
-  # css: 'bootstrap'
-}
-
-# RailsAppGenerator::AppGenerator.override_template_path = '/Users/davidcruwys/dev/kgems/rails_app_generator/templates'
-# RailsAppGenerator::AppGenerator.addon_template_path = '/Users/davidcruwys/dev/kgems/rails_app_generator/templates/addons/%<addon>'
-
-instance = RailsAppGenerator::Starter.new(args)
-FileUtils.rm_rf(instance.target_path)
-
-rails_options = RailsAppGenerator::RailsOptions.new(opts)
-instance.start(rails_options)
-
-# system 'gem env'
-
-# console_output_file = File.expand_path('../../../lib/rails_app_generator/notes/kw01.txt', File.join(File.dirname(__FILE__)))
-
-# File.write(console_output_file, instance.console_output.split("\n").compact.collect(&:strip).join("\n"))