boring_generators 0.6.0 → 0.11.0

data/lib/generators/boring/bullet/install/install_generator.rb

@@ -10,14 +10,10 @@ module Boring
                                         desc: "Skips adding bullet development configuration"
 
       def add_bullet_gem
-        say "Adding Bullet gem", :green
-        bullet_gem_content = <<~RUBY
-          \n
-          \t# reports N+1 queries
-          \tgem "bullet"
-        RUBY
-        insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
-        run "bundle install"
+        say "Adding bullet gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add bullet --group development"
+        end
       end
 
       def add_bullet_gem_configuration

data/lib/generators/boring/ci/github_action/install/install_generator.rb

@@ -10,7 +10,7 @@ module Boring
         RUBY_VERSION_FILE = ".ruby-version"
 
         DEFAULT_RUBY_VERSION = ".ruby-version"
-        DEFAULT_NODE_VERSION = "10.13.0"
+        DEFAULT_NODE_VERSION = "14"
         DEFAULT_REPOSITORY_NAME = "boring_generators"
 
         class_option :ruby_version,     type: :string, aliases: "-v",

data/lib/generators/boring/ci/github_action/install/templates/ci.yml.tt

@@ -1,5 +1,9 @@
 name: CI
-on: [push]
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 jobs:
   test:
     name: Tests
@@ -10,8 +14,9 @@ jobs:
         env:
           POSTGRES_USER: <%= @repository_name %>
           POSTGRES_DB: <%= "#{@repository_name}_test" %>
-          POSTGRES_PASSWORD: ""
+          POSTGRES_PASSWORD: postgres
         ports: ["5432:5432"]
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
     steps:
       - name: Checkout code
@@ -25,6 +30,8 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: <%= @node_version %>
+      - name: Install library for postgres
+        run: sudo apt-get install libpq-dev
       - name: Find yarn cache location
         id: yarn-cache
         run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -43,7 +50,13 @@ jobs:
           RAILS_ENV: test
           PGHOST: localhost
           PGUSER: <%= @repository_name %>
+          PGPASSWORD: postgres
         run: |
           bin/rails db:setup
       - name: Run tests
+        env:
+          RAILS_ENV: test
+          PGHOST: localhost
+          PGUSER: <%= @repository_name %>
+          PGPASSWORD: postgres
         run: bundle exec rails test # TODO: Update the test runner command as per your requirement.

data/lib/generators/boring/devise/install/install_generator.rb

@@ -16,14 +16,8 @@ module Boring
 
       def add_devise_gem
         say "Adding devise gem", :green
-        devise_gem = <<~RUBY
-          \n
-          # for authentication
-          gem 'devise', '~> 4.7'
-        RUBY
-        append_to_file "Gemfile", devise_gem
         Bundler.with_unbundled_env do
-          run "bundle install"
+          run "bundle add devise"
         end
       end
 

data/lib/generators/boring/font_awesome/ruby_gem/install/install_generator.rb

@@ -8,14 +8,9 @@ module Boring
 
         def add_font_awesome_sass_gem
           say "Adding font_awesome_sass gem", :green
-
-          font_awesome_sass_gem = <<~RUBY
-            \n
-            # for adding font-awesome icons
-            gem 'font-awesome-sass', '~> 5.13'
-          RUBY
-          append_to_file "Gemfile", font_awesome_sass_gem
-          run "bundle install"
+          Bundler.with_unbundled_env do
+            run "bundle add font-awesome-sass"
+          end
         end
 
         def import_font_awesome_stylesheet

data/lib/generators/boring/graphql/install/install_generator.rb

@@ -13,13 +13,9 @@ module Boring
 
       def add_graphql_gem
         say "Adding graphql gem", :green
-        graphql_gem = <<~RUBY
-          \n
-          # for building APIs
-          gem 'graphql', '~> 1.11'
-        RUBY
-        append_to_file "Gemfile", graphql_gem
-        run "bundle install"
+        Bundler.with_unbundled_env do
+          run "bundle add graphql"
+        end
       end
 
       def run_graphql_generator

data/lib/generators/boring/oauth/base_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Oauth
+    module BaseGenerator
+      def add_provider_and_uuid_user_details
+        say "Adding migration to add provider and uuid columns to users", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate migration AddOmniauthToUsers provider:string uid:string"
+        end
+      end
+
+      def configure_devise_omniauth
+        say "Adding omniauth devise configuration", :green
+        if File.exist?("config/initializers/devise.rb")
+          insert_into_file "config/initializers/devise.rb", <<~RUBY, after: /Devise.setup do \|config\|/
+            \n
+            \tconfig.omniauth :#{@oauth_name}, "APP_ID", "APP_SECRET"
+          RUBY
+        else
+          raise MissingDeviseConfigurationError, <<~ERROR
+            Looks like the devise installation is incomplete. Could not find devise.rb in config/initializers.
+          ERROR
+        end
+      end
+
+      def add_omniauth_callback_routes
+        devise_route = '# devise_for :users, controllers: { omniauth_callbacks: "users/omniauth_callbacks" }'.dup
+        route devise_route
+      end
+
+      def add_omniauth_callback_controller
+        say "Copying omniauth_callbacks_controller.rb", :green
+        template("omniauth_callbacks_controller.rb", "app/controllers/users/omniauth_callbacks_controller.rb")
+      end
+
+      def configure_and_add_devise_setting_in_user_model
+        say "Configuring #{@oauth_name.to_s} omniauth for user model", :green
+        insert_into_file "app/models/user.rb", <<~RUBY, after: /class User < ApplicationRecord/
+          \n\tdevise :omniauthable, omniauth_providers: %i[#{@oauth_name}]
+
+          \tdef self.from_omniauth(auth)
+            \twhere(provider: auth.provider, uid: auth.uid).first_or_create do |user|
+              \tuser.email = auth.info.email
+              \tuser.password = Devise.friendly_token[0, 20]
+              \t# user.name = auth.info.name   # assuming the user model has a name
+              \t# user.image = auth.info.image # assuming the user model has an image
+              \t# If you are using confirmable and the provider(s) you use validate emails,
+              \t# uncomment the line below to skip the confirmation emails.
+              \t# user.skip_confirmation!
+            \tend
+          \tend
+        RUBY
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

data/lib/generators/boring/oauth/facebook/install/install_generator.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require 'bundler'
+require 'generators/boring/oauth/base_generator'
 
 module Boring
   module Oauth
     module Facebook
       class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
         class MissingDeviseConfigurationError < StandardError; end
 
         desc "Adds facebook OmniAuth to the application"
@@ -13,77 +16,19 @@ module Boring
 
         def add_facebook_omniauth_gem
           say "Adding Facebook OmniAuth gem", :green
-          facebook_omniauth_gem = <<~RUBY
-            \n
-            # for omniauth facebook
-            gem 'omniauth-facebook', '~> 8.0'
-          RUBY
-          append_to_file "Gemfile", facebook_omniauth_gem
-          Bundler.with_unbundled_env do
-            run "bundle install"
-          end
-        end
-
-        def add_provider_and_uuid_user_details
-          say "Adding migration to add provider and uuid columns to users", :green
           Bundler.with_unbundled_env do
-            run "DISABLE_SPRING=1 bundle exec rails generate migration AddOmniauthToUsers provider:string uid:string"
+            run "bundle add omniauth-facebook"
           end
         end
 
-        def configure_devise_omniauth_facebook
-          say "Adding omniauth devise configuration", :green
-          if File.exist?("config/initializers/devise.rb")
-            insert_into_file "config/initializers/devise.rb", <<~RUBY, after: /Devise.setup do \|config\|/
-              \n
-              \tconfig.omniauth :facebook, "APP_ID", "APP_SECRET"
-            RUBY
-          else
-            raise MissingDeviseConfigurationError, <<~ERROR
-              Looks like the devise installation is incomplete. Could not find devise.rb in config/initializers.
-            ERROR
-          end
-        end
-
-        def add_omniauth_callback_routes
-          devise_route = '# devise_for :users, controllers: { omniauth_callbacks: "users/omniauth_callbacks" }'.dup
-          route devise_route
-        end
-
-        def add_omniauth_callback_controller
-          say "Copying omniauth_callbacks_controller.rb", :green
-          template("omniauth_callbacks_controller.rb", "app/controllers/users/omniauth_callbacks_controller.rb")
-        end
-
-        def configure_and_add_devise_setting_in_user_model
-          say "Configuring facebook omniauth for user model", :green
-          insert_into_file "app/models/user.rb", <<~RUBY, after: /class User < ApplicationRecord/
-
-              \tdevise :omniauthable, omniauth_providers: %i[facebook]
-
-              \tdef self.from_omniauth(auth)
-                \twhere(provider: auth.provider, uid: auth.uid).first_or_create do |user|
-                  \tuser.email = auth.info.email
-                  \tuser.password = Devise.friendly_token[0, 20]
-                  \tuser.name = auth.info.name   # assuming the user model has a name
-                  \t# user.image = auth.info.image # assuming the user model has an image
-                  \t# If you are using confirmable and the provider(s) you use validate emails,
-                  \t# uncomment the line below to skip the confirmation emails.
-                  \t# user.skip_confirmation!
-                \tend
-              \tend
-          RUBY
-        end
-
-        def add_the_facebook_devise_omniauth_view
-          insert_into_file "app/views/users/sessions/new.html.erb", <<~RUBY, after: /<%= render "users\/shared\/links" %>/
-
-            <%= link_to "Sign in with Facebook", user_facebook_omniauth_authorize_path %>
-          RUBY
-        end
-
-        def show_readme
-          readme "README"
+        def invoke_common_generator_methods
+          @oauth_name = :facebook
+          add_provider_and_uuid_user_details
+          configure_devise_omniauth
+          add_omniauth_callback_routes
+          add_omniauth_callback_controller
+          configure_and_add_devise_setting_in_user_model
+          show_readme
         end
       end
     end

data/lib/generators/boring/oauth/facebook/install/templates/README

@@ -16,9 +16,8 @@ Some setup you must do manually if you haven't yet:
      For example:
 
      config.omniauth :facebook, "APP_ID", "APP_SECRET"
-  3. Ensure you have added the facebook omniauth route in the devise session view:
-     For example:
 
-     <%= link_to "Sign in with Facebook", user_facebook_omniauth_authorize_path %>
+  3. Your omniauth callback URL will be: `<host>/users/auth/facebook/callback`. Please update
+     callback URL in Facebook after registering your omniauth application.
 
 ===============================================================================

data/lib/generators/boring/oauth/github/install/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'generators/boring/oauth/base_generator'
+
+module Boring
+  module Oauth
+    module Github
+      class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
+        class MissingDeviseConfigurationError < StandardError; end
+
+        desc "Adds GitHub OmniAuth to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_github_omniauth_gem
+          say "Adding GitHub OmniAuth gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add omniauth-github"
+          end
+        end
+
+        def invoke_common_generator_methods
+          @oauth_name = :github
+          add_provider_and_uuid_user_details
+          configure_devise_omniauth
+          add_omniauth_callback_routes
+          add_omniauth_callback_controller
+          configure_and_add_devise_setting_in_user_model
+          show_readme
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/oauth/github/install/templates/README

@@ -0,0 +1,23 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have overridden or uncommented the routes for generated omniauth callback controllers in your routes.rb.
+     For example:
+
+     Rails.application.routes.draw do
+       devise_for :users, controllers: {
+         omniauth_callbacks: "users/omniauth_callbacks"
+       }
+     end
+
+  2. Update the devise github omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://github.com/settings/applications/new
+     For example:
+
+     config.omniauth :github, "APP_ID", "APP_SECRET"
+
+  3. Your omniauth callback URL will be: `<host>/users/auth/github/callback`. Please update
+     callback URL in Github after registering your omniauth application.
+
+===============================================================================

data/lib/generators/boring/oauth/github/install/templates/omniauth_callbacks_controller.rb

@@ -0,0 +1,21 @@
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  # See https://github.com/omniauth/omniauth/wiki/FAQ#rails-session-is-clobbered-after-callback-on-developer-strategy
+  skip_before_action :verify_authenticity_token, only: :github
+
+  def github
+    # You need to implement the method below in your model (e.g. app/models/user.rb)
+    @user = User.from_omniauth(request.env["omniauth.auth"])
+
+    if @user.persisted?
+      sign_in_and_redirect @user, event: :authentication #this will throw if @user is not activated
+      set_flash_message(:notice, :success, kind: "GitHub") if is_navigational_format?
+    else
+      session["devise.github_data"] = request.env["omniauth.auth"].except(:extra) # Removing extra as it can overflow some session stores
+      redirect_to new_user_registration_url
+    end
+  end
+
+  def failure
+    redirect_to root_path
+  end
+end

data/lib/generators/boring/oauth/google/install/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'generators/boring/oauth/base_generator'
+
+module Boring
+  module Oauth
+    module Google
+      class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
+        class MissingDeviseConfigurationError < StandardError; end
+
+        desc "Adds Google OmniAuth to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_github_omniauth_gem
+          say "Adding GitHub OmniAuth gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add omniauth-google-oauth2"
+          end
+        end
+
+        def invoke_common_generator_methods
+          @oauth_name = :google_oauth2
+          add_provider_and_uuid_user_details
+          configure_devise_omniauth
+          add_omniauth_callback_routes
+          add_omniauth_callback_controller
+          configure_and_add_devise_setting_in_user_model
+          show_readme
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/oauth/google/install/templates/README

@@ -0,0 +1,23 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have overridden or uncommented the routes for generated omniauth callback controllers in your routes.rb.
+     For example:
+
+     Rails.application.routes.draw do
+       devise_for :users, controllers: {
+         omniauth_callbacks: "users/omniauth_callbacks"
+       }
+     end
+
+  2. Update the devise google omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://code.google.com/apis/console/
+     For example:
+
+     config.omniauth :google_auth, "APP_ID", "APP_SECRET"
+
+  3. Your omniauth callback URL will be: `<host>/users/auth/google_oauth2/callback`. Please update
+     callback URL in Google after registering your omniauth application.
+
+===============================================================================