rails_app_generator 0.1.10 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec3cdb2cbf9342e0d11d2564095d01beec1cdf4578c2b935463f1d1948d05c6
-  data.tar.gz: 2070fd5c3e20f44048a8866de460369f151b4426c3623c28fd4aae87e3438823
+  metadata.gz: 1505eaa23b41f69afe5f4060221b479ae01209f1a76df69577ef715b17c9455f
+  data.tar.gz: f33d5a7001365a84503d2640053604e3e6fe52632f54f0c03c17fe36ff83c869
 SHA512:
-  metadata.gz: 2881fdb69ec894026ecd7c0fb4bfffbb70c00fa1388d74f8ae8f913d560f878d6a54b9f1d8d987c4b30a1883c16cee35ce822e0b8505759301ee2f6458a30951
-  data.tar.gz: c9b77351ad707f91a9d214e33f9fad4691aba37e6f1e66846c627521f7e92bb7bd27eb66b5f5772c4fa470dfb31fc8773ef3338b9cd41940a63595fd84af4fa6
+  metadata.gz: 00b2d94306f636e25800d4d6ed09d8536535f47c630662ee6beda2939dbf871e01721d2978e19dc6bb5c0e281f47913d73535bfb2ef8ecaee427726e9308be7f
+  data.tar.gz: 3dde1c772e2d56ad34d9b190742c25725e744145e4754630425613ced8525e026d935a671f8335b3fb60a56122547b0bc589845bb9f1de61689c94a74b5e0070

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.1.12](https://github.com/klueless-io/rails_app_generator/compare/v0.1.11...v0.1.12) (2022-08-02)
+
+
+### Bug Fixes
+
+* update rails-html-sanitizer example ([7f3a2d8](https://github.com/klueless-io/rails_app_generator/commit/7f3a2d810a968748baf4f8a4a147b086a26781c0))
+
+## [0.1.11](https://github.com/klueless-io/rails_app_generator/compare/v0.1.10...v0.1.11) (2022-08-02)
+
+
+### Bug Fixes
+
+* add thor task to create profiles ([0ec4ae0](https://github.com/klueless-io/rails_app_generator/commit/0ec4ae01a2879fc627422cb79e4cbc685e78dcb8))
+
+## [0.1.10](https://github.com/klueless-io/rails_app_generator/compare/v0.1.9...v0.1.10) (2022-08-02)
+
+
+### Bug Fixes
+
+* refactor GemInfo ([9294d5f](https://github.com/klueless-io/rails_app_generator/commit/9294d5faff71e69f6812868c976a26171a12d4c5))
+
 ## [0.1.9](https://github.com/klueless-io/rails_app_generator/compare/v0.1.8...v0.1.9) (2022-08-02)
 
 

data/after_templates/addons/honeybadger/_.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# require 'pry'
+
+# Make managing application errors a more pleasant experience.
+#
+# exe/rag addons/honeybadger
+# see: https://honeybadger.wistia.com/medias/l3cmyucx8f
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+add_controller('home', 'index')
+route("root 'home#index'")
+
+force_copy
+
+copy_file 'app/views/home/index.html.erb', 'app/views/home/index.html.erb'
+copy_file 'app/controllers/application_controller.rb', 'app/controllers/application_controller.rb'
+copy_file 'app/controllers/errors_controller.rb', 'app/controllers/errors_controller.rb'
+
+# Test if this is really needed
+insert_into_file 'config/application.rb', after: 'class Application < Rails::Application' do
+  <<-RUBY
+    config.generators.system_tests = nil
+  RUBY
+end
+
+copy_file 'public/404.html', 'public/404.html'
+copy_file 'public/500.html', 'public/500.html'
+
+copy_file 'config/locales/en.yml', 'config/locales/en.yml'
+
+move_file('config/honeybadger.sample.yml', 'config/honeybadger.yml')
+
+after_bundle do
+  setup_db
+end
+
+def setup_db
+  add_scaffold('product', 'name', 'price:integer')
+  copy_file 'app/controllers/products_controller.rb', 'app/controllers/products_controller.rb'
+
+  db_migrate
+end

data/after_templates/addons/honeybadger/app/controllers/application_controller.rb

@@ -0,0 +1,9 @@
+class ApplicationController < ActionController::Base
+  before_action do |_|
+    Honeybadger.context(
+      user_email: 'klueless-io@example.com',
+      name: 'David',
+      company: 'AppyDave'
+    )
+  end
+end

data/after_templates/addons/honeybadger/app/controllers/errors_controller.rb

@@ -0,0 +1,17 @@
+class ErrorsController < ApplicationController
+  def not_found
+    render status: 404
+  end
+
+  def internal_server
+    render status: 500
+  end
+
+  def unprocessable
+    render status: 422
+  end
+
+  def unacceptable
+    render status: 406
+  end
+end

data/after_templates/addons/honeybadger/app/controllers/products_controller.rb

@@ -0,0 +1,72 @@
+class ProductsController < ApplicationController
+  before_action :set_product, only: %i[ show edit update destroy ]
+
+  # GET /products or /products.json
+  def index
+    @products = Product.all
+  end
+
+  # GET /products/1 or /products/1.json
+  def show
+  end
+
+  # GET /products/new
+  def new
+    # remove this comment to see error in Honeybadger
+    raise 'Oh No!'
+    @product = Product.new
+  end
+
+  # GET /products/1/edit
+  def edit
+  end
+
+  # POST /products or /products.json
+  def create
+    @product = Product.new(product_params)
+
+    respond_to do |format|
+      if @product.save
+        format.html { redirect_to product_url(@product), notice: "Product was successfully created." }
+        format.json { render :show, status: :created, location: @product }
+      else
+        format.html { render :new, status: :unprocessable_entity }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /products/1 or /products/1.json
+  def update
+    respond_to do |format|
+      if @product.update(product_params)
+        format.html { redirect_to product_url(@product), notice: "Product was successfully updated." }
+        format.json { render :show, status: :ok, location: @product }
+      else
+        format.html { render :edit, status: :unprocessable_entity }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /products/1 or /products/1.json
+  def destroy
+    @product.destroy
+
+    respond_to do |format|
+      format.html { redirect_to products_url, notice: "Product was successfully destroyed." }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_product
+      @product = Product.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def product_params
+      params.require(:product).permit(:name, :price)
+    end
+end

data/after_templates/addons/honeybadger/app/views/home/index.html.erb

@@ -0,0 +1,49 @@
+<h1>Honeybadger</h1>
+
+<h2>Make managing application errors a more pleasant experience.</h2>
+
+<p>Follow the instructions below and then click on products -> new</p>
+
+<%= link_to 'Products', products_path %>
+
+<h2>Instructions</h2>
+
+<p>If you want to see 404/500 HTML inplace of the debug routing error when in development then alter the following file</p>
+
+<b>config/environments/development.rb</b>
+<pre>
+  
+# config.consider_all_requests_local = true
+config.consider_all_requests_local = false
+  
+</pre>
+
+<p>If you want to see the exception message in Honeybadger then make sure then remove the comment<p>
+
+<b>config/honeybadger.yml</b>
+
+<pre>
+# report_data: true
+report_data: true
+</pre>
+
+<p>If you want to send the exception message to Honeybadger then make sure your remove development from the list<p>
+
+<pre>
+# development_environments:
+- test
+- development
+- cucumber
+</pre>
+
+<p>Test frrom the command line using</p>
+
+<pre>
+bundle exec honeybadger test
+</pre>
+
+<p>More information can be found at 
+  <a href="http://honeybadger.io/">http://honeybadger.io/</a> and
+  <a hreg="https://honeybadger.wistia.com/medias/l3cmyucx8f">https://honeybadger.wistia.com/medias/l3cmyucx8f</a>
+
+</p>

data/after_templates/addons/honeybadger/public/404.html

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+  <!-- HONEYBADGER FEEDBACK -->
+  <!-- HONEYBADGER ERROR -->
+  </body>
+</html>

data/after_templates/addons/honeybadger/public/500.html

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <!-- HONEYBADGER FEEDBACK -->
+  <!-- HONEYBADGER ERROR -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/after_templates/addons/rails_html_sanitizer/_.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# HTML sanitization for Rails applications
+require 'pry'
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+add_controller('home', 'index')
+route("root 'home#index'")
+
+force_copy
+
+copy_file 'home/index.html.erb', 'app/views/home/index.html.erb'

data/after_templates/addons/rails_html_sanitizer/home/index.html.erb

@@ -0,0 +1,31 @@
+<h1>Rails HTML Sanitizer</h1>
+
+<p>Read more here <a href="https://github.com/rails/rails-html-sanitizer">rails-html-sanitizer</a></p>
+
+<textarea rows="4" cols="200">
+full_sanitizer = Rails::Html::FullSanitizer.new
+full_sanitizer.sanitize("<b>Bold</b> no more!  <a href='more.html'>See more here</a>...")
+</textarea>
+
+<hr>
+<%=
+  Rails::Html::FullSanitizer
+    .new
+    .sanitize("<b>Bold</b> no more!  <a href='more.html'>See more here</a>...")
+%>
+
+<br/><br/><br/>
+
+<hr>
+
+<textarea rows="4" cols="200">
+link_sanitizer = Rails::Html::LinkSanitizer.new
+link_sanitizer.sanitize('<a href="example.com">Only the link text will be kept.</a>')
+# => Only the link text will be kept.
+</textarea>
+
+<%=
+  Rails::Html::LinkSanitizer
+    .new
+    .sanitize('<a href="example.com">Only the link text will be kept.</a>')
+%>

data/lib/rails_app_generator/add_on.rb

@@ -21,6 +21,7 @@ module RailsAppGenerator
     def apply; end
 
     # list any methods that you want access to, but not to be exposed as a thor command
+    # rubocop:disable Metrics/BlockLength
     no_commands do
       def source_paths
         [
@@ -43,7 +44,42 @@ module RailsAppGenerator
         klass = addon_name.nil? ? self.class : self.class.get(addon_name)
         Dependencies.new(klass, context).satisfied?
       end
+
+      def read_template(template_file)
+        path = find_in_source_paths(template_file)
+
+        File.read(path)
+      end
+
+      # Moves a file at given location, to another location. Both files are relative to the destination_root
+      #
+      # ==== Parameters
+      # path<String>:: source_path of the file to be moved (relative to destination_root)
+      # path<String>:: target_path of the file moving to (relative to destination_root)
+      # config<Hash>:: give :verbose => false to not log the status.
+      #
+      # ==== Example
+      #
+      #   move_file 'README', 'readme.md'
+      #   move_file 'config/xmen.sample.yml', 'config/xmen.yml
+      #
+      # rubocop:disable Metrics/AbcSize
+      def move_file(source_path, target_path, config = {})
+        source = File.expand_path(source_path, destination_root)
+        target = File.expand_path(target_path, destination_root)
+        config.merge!({ verbose: true })
+
+        say_status :move_file_source, relative_to_original_destination_root(source), config.fetch(:verbose, true)
+        say_status :move_file_source, relative_to_original_destination_root(target), config.fetch(:verbose, true)
+
+        return unless !options[:pretend] && File.exist?(source)
+
+        require 'fileutils'
+        ::FileUtils.mv(source, target)
+      end
+      # rubocop:enable Metrics/AbcSize
     end
+    # rubocop:enable Metrics/BlockLength
 
     class << self
       def apply(context = Context.new({}))

data/lib/rails_app_generator/addons/honeybadger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Honeybadger to rails application
+    class Honeybadger < AddOn
+      required_gem gem.version('honeybadger', '4.12.1', 'Make managing application errors a more pleasant experience.')
+
+      def apply
+        run('bundle exec honeybadger install 1111')
+        say 'Update the honeybadger.yml file with your API key.'
+
+        copy_file('honeybadger.sample.yml', 'config/honeybadger.sample.yml')
+        append_to_file('config/locales/en.yml', read_template('en.yml'))
+      end
+    end
+  end
+end

data/lib/rails_app_generator/app_generator.rb

@@ -149,6 +149,7 @@ module RailsAppGenerator
     # gem "net-sftp", "3.0.0"
     # gem "prawn", "2.4.0"
     # gem "prawn-table", "0.2.2"
+    # gem "appraisal"
 
     class_option :add_irbrc                   , type: :boolean, default: false
     class_option :add_foreman                 , type: :boolean, default: false
@@ -173,6 +174,7 @@ module RailsAppGenerator
 
     # NEW GEM ADDONS
     class_option :add_rails_html_sanitizer    , type: :boolean, default: false
+    class_option :add_honeybadger             , type: :boolean, default: false
 
     class << self
       # points to the original rails templates
@@ -300,6 +302,7 @@ module RailsAppGenerator
     #   # add(:rspec) if options[:testing_framework] == 'rspec'
     # end
 
+    # rubocop:disable Metrics/AbcSize
     def finish_template
       puts 'finish template'
 
@@ -315,34 +318,18 @@ module RailsAppGenerator
       add(:views, :errors, :scaffold) if options[:add_views]
       add_if(:factory_bot)
       add_if(:shoulda)
+      add_if(:rails_app_generator)
+      add_if(:honeybadger)
 
       # invoke :rails_customization
       super
     end
+    # rubocop:enable Metrics/AbcSize
 
     no_commands do
-      # Template command examples
-      # gac 'base rails 7 image created'
-      # force_copy
-      # add_controller('home', 'index')
-      # add_scaffold('people', 'first_name', 'last_name', 'age:integer', 'address:text')
-      # route("root 'home#index'")
-      # css_install('tailwind')
-      # rails_command('db:migrate')
-      # db_migrate
-      # bundle_add('hotwire-rails')
-      # rails_command('hotwire:install')
-      # run('bin/importmap pin sortablejs')
-      # run('npm install daisyui')
-      # create_file       'app/assets/stylesheets/custom-bootstrap-import.scss' , read_template('custom-bootstrap-import.scss')
-      # append_to_file    'app/assets/config/manifest.js'                       , read_template('manifest.js')
-      # insert_into_file  'app/views/layouts/application.html.erb', read_template('application.html.erb')
-      # insert_into_file  'app/views/layouts/application.html.erb', read_template('application.html.erb'),
-      #     before: %(    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>)
-
-      # gsub_file         'app/views/layouts/application.html.erb', %(container mx-auto mt-28 px-5 flex), 'container mx-auto px-5'
-      # template 'home.css', 'app/assets/stylesheets/home.css'
+      # https://codingpackets.com/blog/rails-generators-cheat-sheet/
 
+      # OLD style will be removed soon
       def local_template_base(xxx)
         File.join(File.dirname(xxx), File.basename(xxx, '.*'))
       end
@@ -395,6 +382,10 @@ module RailsAppGenerator
         run("bundle add #{name}")
       end
 
+      def bundle_exec(name, *args)
+        run("bundle exec #{name} #{args.join(' ')}")
+      end
+
       # If you need to manually install tailwind (instead of using the --template option)
       # you can use css_install('tailwind')
       def css_install(name)
@@ -434,6 +425,34 @@ module RailsAppGenerator
         template_files.map { |template_file| read_template(template_file) }.join(join)
       end
 
+      # Moves a file at given location, to another location. Both files are relative to the destination_root
+      #
+      # ==== Parameters
+      # path<String>:: source_path of the file to be moved (relative to destination_root)
+      # path<String>:: target_path of the file moving to (relative to destination_root)
+      # config<Hash>:: give :verbose => false to not log the status.
+      #
+      # ==== Example
+      #
+      #   move_file 'README', 'readme.md'
+      #   move_file 'config/xmen.sample.yml', 'config/xmen.yml
+      #
+      # rubocop:disable Metrics/AbcSize
+      def move_file(source_path, target_path, config = {})
+        source = File.expand_path(source_path, destination_root)
+        target = File.expand_path(target_path, destination_root)
+        config.merge!({ verbose: true })
+
+        say_status :move_file_source, relative_to_original_destination_root(source), config.fetch(:verbose, true)
+        say_status :move_file_source, relative_to_original_destination_root(target), config.fetch(:verbose, true)
+
+        return unless !options[:pretend] && File.exist?(source)
+
+        require 'fileutils'
+        ::FileUtils.mv(source, target)
+      end
+      # rubocop:enable Metrics/AbcSize
+
       # Local template path is handy when you want template files used when working with the --template flag
       attr_accessor :local_template_path
 
@@ -465,17 +484,16 @@ module RailsAppGenerator
       end
 
       def add_if(addon)
-        option_name = "add_#{addon}".to_sym
-        add(addon) if options[option_name]
+        add(addon) if active?(addon)
       end
 
-      def skip_flag?(option_name)
-        value = options["skip_#{option_name}".to_sym]
+      # def skip_flag?(option_name)
+      #   value = options["skip_#{option_name}".to_sym]
 
-        return false if value.nil?
+      #   return true if value.nil?
 
-        value == true
-      end
+      #   value == true
+      # end
 
       def add_flag?(option_name)
         value = options["add_#{option_name}".to_sym]
@@ -486,7 +504,7 @@ module RailsAppGenerator
       end
 
       def active?(option_name)
-        add_flag?(option_name) || !skip_flag?(option_name)
+        add_flag?(option_name) # || !skip_flag?(option_name)
       end
 
       def uses?(addon)
@@ -504,10 +522,18 @@ module RailsAppGenerator
         end
       end
 
-      def addon_gemfile_entries
+      def addon_classes
         AddOns.constants
-              .select { |klass| AddOns.const_get(klass).is_a?(Class) }
-              .flat_map { |klass| AddOns.const_get(klass).gem_entries }
+              .map { |addon_klass_name| AddOns.const_get(addon_klass_name) }
+              .select { |klass| klass.is_a?(Class) && klass.respond_to?(:addon_name) }
+      end
+
+      def active_addon_classes
+        addon_classes.select { |klass| active?(klass.addon_name) }
+      end
+
+      def addon_gemfile_entries
+        active_addon_classes.flat_map(&:gem_entries)
       end
     end
 

data/lib/rails_app_generator/options/rails_options.rb

@@ -60,6 +60,7 @@ module RailsAppGenerator
 
     # NEW GEM ADDONS
     register_option :add_rails_html_sanitizer   , type: :boolean, default: false
+    register_option :add_honeybadger            , type: :boolean, default: false
 
     # if options[:minimal]
     #   self.options = options.merge(

data/lib/rails_app_generator/version.rb

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