rolemodel-rails 0.26.0

data/lib/generators/rolemodel/react/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Sets up React for Rails
+
+Example:
+    rails generate rolemodel:react

data/lib/generators/rolemodel/react/react_generator.rb

@@ -0,0 +1,36 @@
+module Rolemodel
+  class ReactGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def add_npm_packages
+      @add_react = yes?('Would you like to add react?')
+
+      if @add_react
+        run 'yarn add react react-dom'
+      end
+    end
+
+    def add_files
+      if @add_react
+        say 'Copying files'
+
+        template 'app/helpers/react_helper.rb', 'app/helpers/react_helper.rb'
+
+        template 'app/javascript/components/HelloReact.jsx', 'app/javascript/components/HelloReact.jsx'
+        template 'app/javascript/controllers/react_controller.js', 'app/javascript/controllers/react_controller.js'
+      end
+    end
+
+    def import_react_controller
+      if @add_react
+        say 'Importing react_controller.js'
+
+        append_to_file 'app/javascript/controllers/index.js', <<~JS
+
+          import ReactController from './react_controller.js'
+          application.register('react', ReactController)
+        JS
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/react/templates/app/helpers/react_helper.rb

@@ -0,0 +1,11 @@
+module ReactHelper
+  def react_component(component_name, props = {})
+    tag.div(
+      data: {
+        controller: 'react',
+        component: component_name,
+        props: props.to_json
+      }
+    )
+  end
+end

data/lib/generators/rolemodel/react/templates/app/javascript/components/HelloReact.jsx

@@ -0,0 +1,14 @@
+import React from 'react'
+
+// To display React components in your view, import them into the react_controller.js Stimulus
+// controller and then use the react_component view helper to mount them in your Rails view:
+//
+// = react_component 'HelloReact', currentTime: Time.now
+
+export default function HelloReact({ currentTime }) {
+  return (
+    <div>
+      Hello! The current time is {currentTime}
+    </div>
+  )
+}

data/lib/generators/rolemodel/react/templates/app/javascript/controllers/react_controller.js

@@ -0,0 +1,24 @@
+import { Controller } from '@hotwired/stimulus'
+import React from 'react'
+import { createRoot } from 'react-dom/client'
+
+import HelloReact from '../components/HelloReact.jsx'
+
+const registeredComponents = {
+  HelloReact
+}
+
+export default class extends Controller {
+  connect() {
+    const componentName = this.element.dataset.component
+    const component = registeredComponents[componentName]
+
+    if (component) {
+      const root = createRoot(this.element)
+      const props = JSON.parse(this.element.dataset.props)
+      root.render(React.createElement(component, props))
+    } else {
+      throw new Error('Unrecognized React component name!')
+    }
+  }
+}

data/lib/generators/rolemodel/readme/README.md

@@ -0,0 +1,9 @@
+# README Generator
+
+## What you get
+
+### README Template
+
+When you create a project in Github it will use the Markdown file as a [README](./templates/README.md.erb) for the repository.
+
+Make sure to review the README and add other items your team finds necessary.

data/lib/generators/rolemodel/readme/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up our standard README for a project
+
+Example:
+    rails generate rolemodel:readme
+
+    This will create:
+        /README.md

data/lib/generators/rolemodel/readme/readme_generator.rb

@@ -0,0 +1,11 @@
+module Rolemodel
+  class ReadmeGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def install_readme
+      @project_name = Rails.application.class.try(:parent_name) || Rails.application.class.module_parent_name
+      @project = @project_name.underscore
+      template 'README.md.erb', 'README.md'
+    end
+  end
+end

data/lib/generators/rolemodel/readme/templates/README.md.erb

@@ -0,0 +1,116 @@
+# Overview
+## Name and aliases
+The project is named "<%= @project_name %>". Some will refer to it as "<alias1>" or "<alias2>".
+
+## Purpose
+The system is designed to solve the problem of ... Users had the problem, but this system resolves it by ...
+
+## Technologies
+### Chosen
+* Ruby on Rails
+* Postgres
+* nginx
+* puma
+
+### Tried and rejected
+* Node.js - Not enough internal experience.
+* Mongo - Needed to use a relational database for reporting.
+* Websphere - Cost
+* webrick - Application servers are using newer technology now.
+
+## Technology relationships
+<insert image here>
+
+## Supported browsers
+The customer states that only Chrome will be used.
+
+# How to set up the project
+## External tool installation
+\```
+brew update --system
+brew upgrade ruby-build
+git clone http://github.com/RoleModel/<%= @project %>
+cd <%= @project %>
+rbenv install
+gem install bundler
+bundle install
+\```
+
+## How to run locally
+`rails s`
+
+## How to run tests
+`rake`
+
+## Editor plugins
+* Rubocop linter
+
+## Troubleshooting information
+* [App Status Page](http://app.<applicationname>.com/_ping) will give you information about what is running.
+* Alternatively, you can ssh in and check that the application server and web server are both running.
+
+# Testing Strategy
+## Testing approach
+### System tests
+Due to the nature of this application, End User tests are...
+
+### Unit tests
+Due to the nature of this application, unit tests are prominent and handle most of the confidence building and documentation needs of the system below the user interface.
+
+### Other tests
+At this point, no other tests are being employed.
+However, one might consider performance tests or other categories and describe the reasons here
+
+## Testing tools
+Which tools are we using?
+
+## Continuous integration
+No CI has been set up yet (though we recommend Sempahore in most cases).  When you set it up, tell what you need to know here
+
+# Branching strategy
+To begin a new feature run, `git checkout -b <branchname>`.
+When finished with the feature and the code has been reviewed, the commits should be squashed before merging. See [RoleModel Best Practices](https://github.com/RoleModel/BestPractices) for more information.
+
+# List of background processes
+* Nightly database backup and export
+* Monthly invoicing on last business day of the month
+
+# Links to:
+## [Git repo](http://github.com/RoleModel/<%= @project %>)
+## [Task management system](http://trello.com)
+## [Staging](http://staging.<applicationname>.com)
+## [Production](http://app.<applicationname>.com)
+## External services
+* [HoneyBadger](http://honeybadger.io)
+* [Skylight](http://skylight.io)
+* [SendGrid](http://sendgrid.com/RoleModel)
+* [Heroku](http://herokuapp.com)
+
+## [CI](http://semaphoreci.com/RoleModel)
+## [Core project presentation](http://docs.google.com)
+## [List of contributors](http://github.com/RoleModel)
+## [Change log](file://./docs/change_log.md)
+
+# Deployment
+## Strategy/process/commands
+`master` is always deployed to production. The `staging` branch is deployed to staging.
+\```
+git checkout master
+git tag 2016-05-16 # <date> YYYY-MM-DD
+git push --tags
+\```
+Deployment is done with [Ansible](http://ansible.com).
+`ansible <command goes here>`
+
+## Description of host(s), DNS, certificate authority
+The application is deployed to Heroku. They are also hosting the DNS. We certificate was received from [Let's Encrypt](https://letsencrypt.org/).
+
+## ssh information
+`ssh user@hostname.com`
+
+# Customer contacts
+* Joe Johnson - 919-555-1212
+* Larry Anderson - 919-555-1213
+
+# Copyright & licensing
+Copyright (c) 2019 Closed Source @CompanyName

data/lib/generators/rolemodel/replace_content_helper.rb

@@ -0,0 +1,29 @@
+module Rolemodel
+  module ReplaceContentHelper
+    private
+
+    def replace_content(relative_path, &block)
+      source = File.expand_path(relative_path.to_s, destination_root)
+      content = File.exist?(source) ? File.open(source) { it.binmode.read } : ''
+
+      remove_file relative_path
+      create_file relative_path, yield(content)
+    end
+
+    def modify_json_file(relative_path, &block)
+      replace_content(relative_path) do |content|
+        hash = JSON.parse(content.presence || '{}')
+        yield(hash)
+        JSON.pretty_generate(hash) + "\n"
+      end
+    end
+
+    def add_package_json_script(command_name, command)
+      modify_json_file('package.json') do |hash|
+        hash['scripts'] ||= {}
+        hash['scripts'][command_name] = command
+        hash
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/saas/README.md

@@ -0,0 +1,7 @@
+# SaaS Generator
+
+[USAGE](./USAGE)
+
+## What you get
+
+* [Devise](./devise)

data/lib/generators/rolemodel/saas/USAGE

@@ -0,0 +1,5 @@
+Description:
+    runs all the SaaS generators
+
+Example:
+    rails generate rolemodel:saas:all

data/lib/generators/rolemodel/saas/all_generator.rb

@@ -0,0 +1,15 @@
+module Rolemodel
+  module Saas
+    class AllGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def run_all_the_generators
+        # no guaranteed order to this list with Dir.glob
+        Dir.glob(Pathname(File.expand_path('.', __dir__)).join('*', '*generator.rb')).each do |generator|
+          name = File.basename(generator, '_generator.rb')
+          generate "rolemodel:saas:#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/README.md

@@ -0,0 +1,24 @@
+# Devise Generator
+
+Depends on devise and devise_invitable generators
+Depends on [RSpec Generator](../../testing/rspec)
+Depends on slim
+
+## What you get
+
+Installs [devise](https://github.com/heartcombo/devise)
+Installs [devise_invitable](https://github.com/scambra/devise_invitable)
+
+### Models
+* Adds User model
+* Add Organization model (if needed)
+
+### Views
+* Current user
+* Sign up, sign in, sign out
+* Add user profile page
+* Invitation page (if requested)
+
+### Tests
+* Devise test helpers
+* User system test

data/lib/generators/rolemodel/saas/devise/USAGE

@@ -0,0 +1,25 @@
+Description:
+    installs and configures Devise
+
+Example:
+    rails generate rolemodel:saas:devise
+
+    This will create:
+        app/controllers/application_controller.rb
+        app/controllers/users
+        app/models/organization.rb
+        app/models/user.rb
+        app/views/devise
+        config/initializers/devise.rb
+        spec/support/devise.rb
+        spec/system/users_spec.rb
+        spec/factories/organizations.rb
+        spec/factories/users.rb
+        spec/mailers/previews/devise_mailer_preview.rb
+
+    This will modify:
+        config/environments/development.rb
+        config/environments/production.rb
+        config/routes.rb
+        app/models/user.rb
+        db/seeds.rb

data/lib/generators/rolemodel/saas/devise/devise_generator.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Saas
+    class DeviseGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def add_organization
+        generate :model, 'organization name:string' unless File.exist?(Rails.root.join('app/models/organization.rb'))
+        inject_into_file 'app/models/organization.rb', "  has_many :users, inverse_of: :organization\n",
+                         after: "ApplicationRecord\n"
+      end
+
+      def install_devise
+        # Devise tries to install bcrypt, but it fails because the bundle command
+        # is run using the wrong platform causing the native extension to fail.
+        # Using clean env fixes this.
+        bundle_command 'add devise'
+
+        generate 'devise:install'
+        generate :devise, 'user first_name:string last_name:string'
+        generate :migration,
+                 'add_organization_and_role_to_users organization_id:bigint:index role:string super_admin:boolean'
+        file_name = Dir.glob(Rails.root.join('db/migrate', '*_add_organization_and_role_to_users.rb')).last
+        gsub_file file_name, /:role, :string$/, ":role, :string, default: 'user', null: false"
+        gsub_file file_name, /:super_admin, :boolean$/, ':super_admin, :boolean, default: false, null: false'
+      end
+
+      def add_invitable
+        @add_invitations = yes?('Would you like to add user invitations?')
+        return unless @add_invitations
+
+        bundle_command 'add devise_invitable'
+
+        generate 'devise_invitable:install'
+        generate :devise_invitable, 'user'
+      end
+
+      def add_routes
+        route_info = ", controllers: {\n"
+        route_info += "    invitations: 'users/invitations',\n" if @add_invitations
+        route_info += "    registrations: 'users/registrations',\n"
+        route_info += '  }'
+        inject_into_file 'config/routes.rb', route_info, after: /devise_for :users$/
+
+        route_info = "namespace :admin do\n"
+        if @add_invitations
+          route_info += "  resources :users do\n"
+          route_info += "    post :reinvite, on: :member\n"
+          route_info += "  end\n"
+        else
+          route_info += "  resources :users\n"
+        end
+        route_info += 'end'
+        route route_info
+
+        route 'root to: "admin/users#index"' unless File.readlines('config/routes.rb').grep(/root\sto/).any?
+      end
+
+      def add_modified_files
+        copy_file 'app/controllers/application_controller.rb'
+        if @add_invitations
+          copy_file 'app/controllers/users/invitations_controller.rb'
+          directory 'app/views/devise/invitations'
+          copy_file 'app/views/devise/mailer/invitation_instructions.html.slim'
+          copy_file 'app/views/devise/mailer/invitation_instructions.text.slim'
+          copy_file 'config/locales/devise_invitable.en.yml'
+        end
+        template 'app/controllers/admin/users_controller.rb'
+        copy_file 'app/controllers/users/registrations_controller.rb'
+        directory 'app/views/admin'
+        directory 'app/views/devise', exclude_pattern: /invitation/
+        copy_file 'config/locales/devise.en.yml'
+        copy_file 'spec/support/devise.rb'
+        copy_file 'spec/system/users_spec.rb'
+        copy_file 'spec/factories/organizations.rb'
+        copy_file 'spec/factories/users.rb'
+        copy_file 'spec/models/user_spec.rb'
+      end
+
+      def modify_existing_files
+        unless File.exist?(Rails.root.join('config/initializers/premailer_rails.rb'))
+          inject_into_file 'config/environments/development.rb',
+                           after: "config.action_mailer.perform_caching = false\n" do
+            optimize_indentation <<~'RUBY', 2
+
+              # Default mailing host suggested by Devise installation instructions
+              config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+            RUBY
+          end
+        end
+
+        inject_into_file 'config/environments/production.rb', after: "config.action_mailer.perform_caching = false\n" do
+          optimize_indentation <<~'RUBY', 2
+
+            # Tell Devise about your host, so it can send password reset emails
+            if ENV['REVIEW_APP'] == 'true' && ENV['HEROKU_APP_NAME'].present?
+              config.action_mailer.default_url_options = { host: "https://#{ENV['HEROKU_APP_NAME']}.herokuapp.com" }
+            else
+              config.action_mailer.default_url_options = { host: ENV['PRODUCTION_HOST'] }
+            end
+          RUBY
+        end
+
+        # Update Devise email_regexp to something more useful
+        gsub_file 'config/initializers/devise.rb', '/\A[^@\s]+@[^@\s]+\z/',
+                  '/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i'
+        # Turn Devise validate_on_invite on by default
+        if @add_invitations
+          gsub_file 'config/initializers/devise.rb', '# config.validate_on_invite = true',
+                    'config.validate_on_invite = true'
+        end
+
+        inject_into_file 'app/models/user.rb', after: /devise\s+:.*\n.*\n/ do
+          optimize_indentation <<~'RUBY', 2
+
+            enum :role, { user: 'user', admin: 'admin' }
+
+            belongs_to :organization, inverse_of: :users
+            accepts_nested_attributes_for :organization
+
+            validates :first_name, :last_name, :role, presence: true
+            delegate :name, to: :organization, prefix: true
+          RUBY
+        end
+
+        inject_into_file 'db/seeds.rb', after: "Examples:\n" do
+          <<~'RUBY'
+            if Rails.env.development?
+              puts 'Creating the default user environment...'
+
+              organization = Organization.create!(
+                name: 'RoleModel Software'
+              )
+
+              User.create!(
+                first_name: 'Support',
+                last_name: 'Admin',
+                organization: organization,
+                super_admin: true,
+                role: User.roles[:admin],
+                email: 'user@example.com',
+                password: 'password',
+                password_confirmation: 'password'
+              )
+            end
+          RUBY
+        end
+      end
+
+      def define_devise_mailer_layout
+        gsub_file 'config/initializers/devise.rb', "# config.parent_mailer = 'ActionMailer::Base'",
+                  "config.parent_mailer = 'ApplicationMailer'"
+      end
+
+      def add_devise_mailer_preview
+        copy_file 'spec/mailers/previews/devise_mailer_preview.rb'
+      end
+
+      def add_login_styles
+        say 'importing login stylesheet', :green
+        copy_file 'app/assets/stylesheets/login.css'
+
+        return unless File.exist?(File.join(destination_root, 'app/assets/stylesheets/application.scss'))
+
+        append_to_file 'app/assets/stylesheets/application.scss', <<~SCSS
+          @import 'login';
+        SCSS
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/templates/app/assets/stylesheets/login.css

@@ -0,0 +1,30 @@
+.app__login {
+  margin: calc(2 * var(--op-space-4x-large)) auto auto;
+  padding-inline: var(--op-space-large);
+  width: 100%;
+  max-width: calc(116 * var(--op-size-unit));
+}
+
+/* This could also be its own card variant */
+.card--login {
+  .card__header {
+    display: flex;
+    justify-content: center;
+  }
+
+  .card__header img {
+    width: calc(23 * var(--op-size-unit));
+  }
+
+  .card__body {
+    padding-block: 0;
+  }
+
+  .card__footer {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    flex-wrap: wrap;
+    gap: var(--op-space-x-small);
+  }
+}

data/lib/generators/rolemodel/saas/devise/templates/app/controllers/admin/users_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Admin
+  class UsersController < ApplicationController
+    def index
+      @users = User.all
+    end
+
+    def edit
+      @user = User.find(params[:id])
+    end
+
+    def update
+      @user = User.find(params[:id])
+      if @user.update(user_params)
+        redirect_to admin_users_url, notice: 'User was updated successfully'
+      else
+        render :edit
+      end
+    end
+<%- if @add_invitations %>
+    def reinvite
+      @user = User.find(params[:id])
+      @user.invite! current_user
+      redirect_to admin_users_url, notice: 'Invitation email sent'
+    end
+<%- end %>
+    private
+
+    def user_params
+      params.require(:user).permit(:email, :first_name, :last_name)
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/templates/app/controllers/application_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!
+
+  private
+
+  def current_organization
+    current_user.try(:organization)
+  end
+end