rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/development/generator_overrides/templates/resource_route_generator.rb.tt

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Rails
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+  class <%= app_const_base %>ResourceRouteGenerator < Rails::Generators::NamedBase # :nodoc:
+    # Properly nests namespaces passed into a generator
+    #
+    #   $ bin/rails generate resource admin/users/products
+    #
+    # should give you
+    #
+    #   namespace :admin do
+    #     namespace :users do
+    #       resources :products, concerns: :paginatable
+    #     end
+    #   end
+    def add_resource_route
+      return if options[:actions].present?
+
+      depth = 0
+      lines = []
+
+      # Create 'namespace' ladder
+      # namespace :foo do
+      #   namespace :bar do
+      regular_class_path.each do |ns|
+        lines << indent("namespace :#{ns} do\n", depth * 2)
+        depth += 1
+      end
+
+      # inserts the primary resource with pagination routes
+      lines << indent("resources :#{file_name.pluralize}, concerns: :paginatable\n", depth * 2)
+
+      # Create `end` ladder
+      #   end
+      # end
+      until depth.zero?
+        depth -= 1
+        lines << indent("end\n", depth * 2)
+      end
+
+      route lines.join
+    end
+
+    def add_paginatable_concern
+      route <<~PAGINATABLE
+        concern :paginatable do
+          get "page/:page", action: :index, on: :collection, as: ""
+        end
+      PAGINATABLE
+    end
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+end

data/lib/generators/rockstart/development/localhost_setup/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds scripts for generating SSL Certificates for localhost development
+
+Example:
+    rails generate rockstart:development:localhost_setup
+
+    This will create:
+        bin/setup-localhost which will generate SSL certificates for localhost

data/lib/generators/rockstart/development/localhost_setup/localhost_setup_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Development
+  class LocalhostSetupGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    def add_certificate_configuration
+      template "localhost_domains.ext.tt", "#{app_name}_localhost.ext"
+    end
+
+    def add_setup_localhost_script
+      script_template "setup-localhost"
+    end
+
+    def create_localhost_certificates
+      append_file ".gitignore" do
+        <<~GITIGNORE
+
+          # localhost certificate authority
+          localhostCA.*
+
+          # Generated SSL Certificates
+          certs/
+
+        GITIGNORE
+      end
+    end
+  end
+end

data/lib/generators/rockstart/{docker → development/localhost_setup}/templates/setup-localhost.tt

@@ -16,12 +16,12 @@ openssl x509 -outform pem -in localhostCA.pem -out localhostCA.crt
 echo "=== Generating Domain Name Certificate ==="
 
 openssl req -new -nodes -newkey rsa:2048 \
-  -keyout docker/certs/web/<%= app_name %>.key \
-  -out docker/certs/web/<%= app_name %>.csr \
+  -keyout certs/localhost/<%= app_name %>.key \
+  -out certs/localhost/<%= app_name %>.csr \
   -subj "/C=US/ST=YourState/L=YourCity/O=Example-Certificates/CN=<%= app_name %>.local"
 
 openssl x509 -req -sha256 -days 1024 \
-  -in docker/certs/web/<%= app_name %>.csr \
+  -in certs/localhost/<%= app_name %>.csr \
   -CA localhostCA.pem -CAkey localhostCA.key \
-  -CAcreateserial -extfile docker/certs/<%= app_name %>_localhost.ext \
-  -out docker/certs/web/<%= app_name %>.crt
+  -CAcreateserial -extfile <%= app_name %>_localhost.ext \
+  -out certs/localhost/<%= app_name %>.crt

data/lib/generators/rockstart/development/readme/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a README for your new Application
+
+Example:
+    rails generate rockstart:development:readme
+
+    This will create:
+        A README.md with all configuration instructions included.

data/lib/generators/rockstart/development/readme/readme_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Development
+  class ReadmeGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    auth0_class_option
+
+    def copy_readme
+      template "README.md"
+    end
+  end
+end

data/lib/generators/rockstart/development/readme/templates/README.md

@@ -0,0 +1,74 @@
+# <%= camelized %>
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+## Configuration
+
+<% if auth0? -%>
+### Auth0 User Roles
+
+In order to configure User Roles, you need to add a custom [Rule](https://auth0.com/docs/rules) into Auth0 to include the User's current permissions when generating a User.
+
+Access the Admin panel for your Auth0 setup (in Heroku run: `heroku addons:open auth0`), and create a Rule with the following code:
+
+```javascript
+function (user, context, callback) {
+  var namespace = 'http://<%= app_name %>/';
+  var roles = (user.app_metadata && user.app_metadata.roles) || [];
+  context.idToken[namespace + 'roles'] = roles;
+  context.accessToken[namespace + 'roles'] = roles;
+  return callback(null, user, context);
+}
+```
+
+Find a profile you wish to make an admin, and `"admin"` to a roles array inside of `app_metadata`. For example:
+
+```javascript
+{
+  "roles": [
+    "admin"
+  ]
+}
+```
+
+You should now be able to sign in, with that profile, with Admin access.
+
+<% end -%>
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+## Deployment Instructions
+
+### Heroku
+
+<%= camelized %> has been pre-configured to deploy to Heroku; either as a Review app, or directly for Production.
+
+For Production applications, you should already have a git remote with the name `heroku` configured for this application. If this is not found, it will be assumed the app is a review application, and a new deployment will be generated.
+
+Deploy both Review and Production applications by running:
+
+```
+bin/deploy-heroku
+```
+
+With each deployments, Heroku will automatically run `bin/hooks-release`. Newly provisioned review apps will run `bin/hooks-postdeploy`; which will setup the database, and verify the initial installation was successful.
+
+For new installs; all required addons will be automatically provisioned. You will have to manually add any required addons for any existing applications, as specified within the `app.json` file.
+
+<% if auth0? -%>
+While every attempt has been made to automate provisioning of apps, you will need to manually configure the User Rule and User Roles within Auth0. Not doing so will disable all Admin functionality.
+
+<% end -%>
+* ...

data/lib/generators/rockstart/development/rebuild/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Builds a quick rockstart rebuild script based off your configuration
+
+Example:
+    rails generate rockstart:development:rebuild
+
+    This will create:
+        A script at bin/rockstart which will re-run the last invokation of rockstart

data/lib/generators/rockstart/development/rebuild/rebuild_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/content_security_options"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Development
+  class RebuildGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::ContentSecurityOptions
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    all_class_options
+
+    def add_rocstart_script
+      script_template "rockstart"
+    end
+  end
+end

data/lib/generators/rockstart/development/rebuild/templates/rockstart.tt

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileutils"
+
+# rockstart rebuild-script script generated by rockstart
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Regenerating previous rockstart build =="
+  system! "bundle exec rails generate rockstart" \
+<%-
+  class_options = all_class_options
+  flags = content_security_flags
+-%>
+ <%- class_options.each_with_index do |class_option, index| -%>
+          " <%= class_option %>"<%- if (index + 1) < class_options.size || flags.any? %> \<%- end %>
+<%- end -%>
+<%- content_security_flags.each_with_index do |(flag, values), index| -%>
+          " <%= flag %> <%= values.join(" ") %>"<%- if (index + 1) < flags.size %> \<%- end %>
+<%- end -%>
+end

data/lib/generators/rockstart/{scaffold_templates → development/scaffolds}/USAGE

@@ -2,7 +2,7 @@ Description:
     Overrides the default rails scaffold templates with pre-configured defaults
 
 Example:
-    rails generate rockstart:scaffold_templates
+    rails generate rockstart:development:scaffolds
 
     This will create:
         Overrides rails scaffold_controller generator templates

data/lib/generators/rockstart/development/scaffolds/scaffolds_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Development
+  class ScaffoldsGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    auth0_class_option
+    pundit_class_option
+
+    def copy_scaffold_templates
+      template "api_controller.rb.tt", "#{scaffold_controller_dir}/api_controller.rb.tt"
+      template "controller.rb.tt", "#{scaffold_controller_dir}/controller.rb.tt"
+    end
+
+    def copy_model_template
+      copy_file "model.rb.tt", "lib/templates/active_record/model/model.rb.tt"
+      copy_file "factory_bot/factories.erb", "lib/templates/factory_bot/model/factories.erb"
+    end
+
+    def copy_rspec_model_templates
+      copy_file "rspec/model_spec.rb.tt",
+                "#{rspec_templates_dir}/model/model_spec.rb"
+    end
+
+    def copy_rspec_scaffold_templates
+      template "rspec/api_request_spec.rb.tt",
+               "#{rspec_templates_dir}/scaffold/api_request_spec.rb"
+      template "rspec/request_spec.rb.tt",
+               "#{rspec_templates_dir}/scaffold/request_spec.rb"
+    end
+
+    private
+
+    def scaffold_controller_dir
+      @scaffold_controller_dir ||= "lib/templates/rails/scaffold_controller"
+    end
+
+    def rspec_templates_dir
+      @rspec_templates_dir ||= "lib/templates/rspec"
+    end
+  end
+end

data/lib/generators/rockstart/{scaffold_templates → development/scaffolds}/templates/api_controller.rb.tt

@@ -4,9 +4,12 @@ require_dependency "<%%= namespaced_path %>/application_controller"
 <%% end -%>
 <%% module_namespacing do -%>
 class <%%= controller_class_name %>Controller < ApplicationController
-<%- if devise? -%>
+<%%-
+  # Generate scaffold with name or title, and a `slug:uniq` field to enable friendly_id
+  using_friendly_id = attributes_names.any? { |name| %w(name title).include?(name) } &&
+    attributes_names.any? { |name| %w(slug).include?(name) }
+-%>
   before_action :authenticate_user!
-<%- end -%>
   before_action :assign_<%%= singular_table_name %>, only: [:show, :update, :destroy]
 <%- if pundit? -%>
   after_action :verify_authorized
@@ -73,11 +76,16 @@ class <%%= controller_class_name %>Controller < ApplicationController
   private
     # Use callbacks to share common setup or constraints between actions.
     def assign_<%%= singular_table_name %>
-<%- if pundit? -%>
-      @<%%= singular_table_name %> = <%%= orm_class.find("policy_scope(#{class_name})", "params[:id]") %>
-<%- else -%>
-      @<%%= singular_table_name %> = <%%= orm_class.find(class_name, "params[:id]") %>
-<%- end -%>
+      <%%-
+        <%- if pundit? -%>
+        finder_class = "policy_scope(#{class_name})"
+        <%- else -%>
+        finder_class = class_name
+        <%- end -%>
+        # Use friendly_id for slug lookup
+        finder_class += ".friendly" if using_friendly_id
+      -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find(finder_class, "params[:id]") %>
     end
 
     # Only allow a trusted parameter "white list" through.

data/lib/generators/rockstart/{scaffold_templates → development/scaffolds}/templates/controller.rb.tt

@@ -4,13 +4,16 @@ require_dependency "<%%= namespaced_path %>/application_controller"
 <%% end -%>
 <%% module_namespacing do -%>
 class <%%= controller_class_name %>Controller < ApplicationController
+<%%-
+  # Generate scaffold with name or title, and a `slug:uniq` field to enable friendly_id
+  using_friendly_id = attributes_names.any? { |name| %w(name title).include?(name) } &&
+    attributes_names.any? { |name| %w(slug).include?(name) }
+-%>
 <%- if pundit? -%>
   include PunditErrorHandling
 
 <%- end -%>
-<%- if devise? -%>
   before_action :authenticate_user!
-<%- end -%>
   before_action :assign_<%%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
 <%- if pundit? -%>
   after_action :verify_authorized
@@ -18,12 +21,13 @@ class <%%= controller_class_name %>Controller < ApplicationController
 <%- end -%>
 
   # GET <%%= route_url %>
+  # GET <%%= route_url %>/page/1
   def index
 <%- if pundit? -%>
     authorize <%%= class_name %>
-    @<%%= plural_table_name %> = policy_scope(<%%= class_name %>)
+    @<%%= plural_table_name %> = policy_scope(<%%= class_name %>).page params[:page]
 <%- else -%>
-    @<%%= plural_table_name %> = <%%= orm_class.all(class_name) %>
+    @<%%= plural_table_name %> = <%%= orm_class.all(class_name) %>.page params[:page]
 <%- end -%>
   end
 
@@ -103,11 +107,16 @@ class <%%= controller_class_name %>Controller < ApplicationController
   private
     # Use callbacks to share common setup or constraints between actions.
     def assign_<%%= singular_table_name %>
-<%- if pundit? -%>
-      @<%%= singular_table_name %> = <%%= orm_class.find("policy_scope(#{class_name})", "params[:id]") %>
-<%- else -%>
-      @<%%= singular_table_name %> = <%%= orm_class.find(class_name, "params[:id]") %>
-<%- end -%>
+      <%%-
+        <%- if pundit? -%>
+        finder_class = "policy_scope(#{class_name})"
+        <%- else -%>
+        finder_class = class_name
+        <%- end -%>
+        # Use friendly_id for slug lookup
+        finder_class += ".friendly" if using_friendly_id
+      -%>
+      @<%%= singular_table_name %> = <%%= orm_class.find(finder_class, "params[:id]") %>
     end
 
     # Only allow a trusted parameter "white list" through.

data/lib/generators/rockstart/development/scaffolds/templates/factory_bot/factories.erb

@@ -0,0 +1,8 @@
+<%-
+filtered_factory_definition = factory_definition.rstrip
+  .gsub(/\"MyString\"/, "Faker::Lorem.sentence") # Randomly generate strings
+  .sub(/slug[^\}]+}$/, "# slug:friendly_id") # ignore friendly_id slug
+-%>
+FactoryBot.define do
+<%= filtered_factory_definition %>
+end