boring_generators 0.5.0 → 0.10.0

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Ahoy
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Ahoy to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_twitter_omniauth_gem
+        say "Adding Ahoy gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add ahoy_matey"
+        end
+      end
+
+      def run_ahoy_generator
+        say "Running Ahoy generator", :green
+        Bundler.with_unbundled_env do
+          run "bundle exec rails generate ahoy:install"
+          run "bundle exec rails db:migrate"
+        end
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

data/lib/generators/boring/ahoy/install/templates/README

@@ -0,0 +1,10 @@
+===============================================================================
+
+Some setup you must do manually based on your project requirement:
+
+  1. To prevent Rails actions from tracking visits: `skip_before_action :track_ahoy_visit`
+  2. To associate and add association in the model with ahoy. Add `visitable :ahoy_visit` in the model.
+
+You could find more configuration options on Ahoy documentation: https://github.com/ankane/ahoy
+
+===============================================================================

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

@@ -7,15 +7,18 @@ module Boring
 
       def add_bullet_gem
         say "Adding audit gems", :green
-        audit_gems_content = <<~RUBY
-          \n
-          \t# Patch-level verification for Bundler. https://github.com/rubysec/bundler-audit
-          \tgem "bundler-audit", require: false
-          \t# vulnerabity checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
-          \tgem "ruby_audit", require: false
-        RUBY
-        insert_into_file "Gemfile", audit_gems_content, after: /group :development do/
-        run "bundle install"
+
+        Bundler.with_unbundled_env do
+          audit_gems_content = <<~RUBY
+            \n
+            \t# Patch-level verification for Bundler. https://github.com/rubysec/bundler-audit
+            \tgem "bundler-audit", require: false
+            \t# vulnerabity checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
+            \tgem "ruby_audit", require: false
+          RUBY
+          insert_into_file "Gemfile", audit_gems_content, after: /group :development do/
+          run "bundle install"
+        end
       end
     end
   end

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

@@ -7,12 +7,14 @@ module Boring
         desc "Adds Github Action to the application"
         source_root File.expand_path("templates", __dir__)
 
-        DEFAULT_RUBY_VERSION = "2.7.1"
+        RUBY_VERSION_FILE = ".ruby-version"
+
+        DEFAULT_RUBY_VERSION = ".ruby-version"
         DEFAULT_NODE_VERSION = "10.13.0"
         DEFAULT_REPOSITORY_NAME = "boring_generators"
 
         class_option :ruby_version,     type: :string, aliases: "-v",
-                                                       desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}"
+                                                       desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}, which will cause the action to use the version specified in the #{RUBY_VERSION_FILE} file."
         class_option :node_version,     type: :string, aliases: "-v",
                                                        desc: "Tell us the node version which you use for the application. Default to Node #{DEFAULT_NODE_VERSION}"
         class_option :repository_name,  type: :string, aliases: "-rn",
@@ -24,6 +26,18 @@ module Boring
           @repository_name = options[:repository_name] ? options[:repository_name] : DEFAULT_REPOSITORY_NAME
 
           template("ci.yml", ".github/workflows/ci.yml")
+
+          if @ruby_version == DEFAULT_RUBY_VERSION && !ruby_version_file_exists?
+            say <<~WARNING, :red
+              WARNING: The action was configured to use the ruby version specified in the .ruby-version
+              file, but no such file was present. Either create an appropriate .ruby-version file, or
+              update .github/workflows/ci.yml to use an explicit ruby version.
+            WARNING
+          end
+        end
+
+        def ruby_version_file_exists?
+          Pathname.new(destination_root).join(RUBY_VERSION_FILE).exist?
         end
       end
     end

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

@@ -20,17 +20,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: <%= @ruby_version %>
-      - name: Ruby gem cache
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-      - name: Install gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Setup Node
         uses: actions/setup-node@v1
         with:

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

@@ -16,18 +16,16 @@ 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
-        run "bundle install"
+        Bundler.with_unbundled_env do
+          run "bundle add devise"
+        end
       end
 
       def generating_devise_defaults
         say "Generating devise defaults", :green
-        run "DISABLE_SPRING=1 rails generate devise:install"
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:install"
+        end
       end
 
       def add_devise_action_mailer_development_config
@@ -44,7 +42,9 @@ module Boring
         say "Adding devise user model", :green
         model_name = options[:model_name] || DEFAULT_DEVISE_MODEL_NAME
 
-        run "DISABLE_SPRING=1 rails generate devise #{model_name}"
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise #{model_name}"
+        end
       end
 
       def add_devise_authentication_filter_to_application_controller
@@ -60,7 +60,9 @@ module Boring
         say "Adding devise views", :green
         model_name = options[:model_name] || DEFAULT_DEVISE_MODEL_NAME
 
-        run "rails generate devise:views #{model_name.pluralize}"
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:views #{model_name.pluralize}"
+        end
       end
     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

@@ -0,0 +1,36 @@
+# 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"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_facebook_omniauth_gem
+          say "Adding Facebook OmniAuth gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add omniauth-facebook"
+          end
+        end
+
+        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
+  end
+end

data/lib/generators/boring/oauth/facebook/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 facebook omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://developers.facebook.com/apps/
+     For example:
+
+     config.omniauth :facebook, "APP_ID", "APP_SECRET"
+
+  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/facebook/install/templates/omniauth.rb

@@ -0,0 +1,3 @@
+Devise.setup do |config|
+  config.omniauth :twitter, ENV['TWITTER_KEY'], ENV['TWITTER_SECRET']
+end

data/lib/generators/boring/oauth/facebook/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: :facebook
+
+  def facebook
+    # 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: "Facebook") if is_navigational_format?
+    else
+      session["devise.facebook_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/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.
+
+===============================================================================