boring_generators 0.1.0 → 0.6.0

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Boring
+  module Jquery
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds JQuery to the application"
+
+      def add_jquery_package
+        say "Adding JQuery packages", :green
+        run "yarn add jquery"
+      end
+
+      def add_jquery_plugin_provider_to_webpack_environment
+        say "Initailizing tailwind configuration", :green
+        if File.exist?("config/webpack/environment.js")
+          insert_into_file "config/webpack/environment.js", <<~RUBY, after: /@rails\/webpacker.*\n/
+            const webpack = require("webpack")
+
+            environment.plugins.append("Provide", new webpack.ProvidePlugin({
+              $: 'jquery',
+              jQuery: 'jquery'
+            }))
+          RUBY
+        else
+          say <<~WARNING, :red
+            ERROR: Looks like the webpacker installation is incomplete. Could not find environment.js in config/webpack.
+          WARNING
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Oauth
+    module Facebook
+      class InstallGenerator < Rails::Generators::Base
+        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
+          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"
+          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"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+===============================================================================
+
+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. 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 %>
+
+===============================================================================

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/pry/install/install_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Boring
+  module Pry
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds pry to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_bullet_gem
+        say "Adding Bullet gem", :green
+        pry_gem_content = <<~RUBY
+          \n
+          # for using pry as Rails console
+          gem "pry"
+          gem "pry-rails"
+        RUBY
+        append_to_file "Gemfile", pry_gem_content
+        run "bundle install"
+      end
+
+      def add_pryrc_configuration
+        return if options[:skip_configuration]
+
+        say "Copying pryrc configuration", :green
+        template("pryrc", ".pryrc")
+      end
+    end
+  end
+end

data/lib/generators/boring/pry/install/templates/pryrc

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "json"
+
+if defined?(Rails)
+  # https://wiki.hackzine.org/development/misc/readline-color-prompt.html
+  Pry.config.prompt_name = if Rails.env.production?
+    "\001\e[0m\002PROD"
+  else
+    "\001\e[0m\002dev"
+  end
+end
+Pry.config.pager = false
+
+def define_byebug_aliases!
+  if defined?(PryByebug)
+    Pry.commands.alias_command "c", "continue"
+    Pry.commands.alias_command "s", "step"
+    Pry.commands.alias_command "n", "next"
+    Pry.commands.alias_command "f", "finish"
+  end
+end
+
+extend Rails::ConsoleMethods if defined?(Rails::ConsoleMethods)

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Boring
+  module Pundit
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds pundit to the application"
+
+      class_option :skip_ensuring_policies, type: :boolean, aliases: "-s",
+                   desc: "Skip before_action to ensure user is authorized"
+      class_option :skip_rescue, type: :boolean, aliases: "-sr",
+                   desc: "Skip adding rescue for Pundit::NotAuthorizedError"
+      class_option :skip_generator, type: :boolean, aliases: "-sg",
+                   desc: "Skip running Pundit install generator"
+
+      def add_pundit_gem
+        say "Adding Pundit gem", :green
+        pundit_gem = <<~RUBY
+          \n
+          # for authorization
+          gem 'pundit', '~> 2.1'
+        RUBY
+        append_to_file "Gemfile", pundit_gem
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        end
+      end
+
+      def run_pundit_generator
+        return if options[:skip_generator]
+
+        say "Running Pundit Generator", :green
+        run "DISABLE_SPRING=1 rails generate pundit:install"
+      end
+
+      def inject_pundit_to_controller
+        say "Adding Pundit module into ApplicationController", :green
+        inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do
+          "  include Pundit\n"
+        end
+      end
+
+      def ensure_policies
+        return if options[:skip_ensuring_policies]
+
+        say "Force ensuring policies", :green
+        inject_into_file 'app/controllers/application_controller.rb', after: "include Pundit\n" do
+          "  after_action :verify_authorized\n"
+        end
+      end
+
+      def rescue_from_not_authorized
+        return if options[:skip_rescue]
+
+        say "Adding rescue from Pundit::NotAuthorizedError", :green
+
+        after = if File.read('app/controllers/application_controller.rb') =~ (/:verify_authorized/)
+                  "after_action :verify_authorized\n"
+                else
+                  "include Pundit\n"
+                end
+
+        inject_into_file 'app/controllers/application_controller.rb', after: after do
+          <<~RUBY
+            \trescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+
+            \tprivate
+
+            \tdef user_not_authorized
+            \t  flash[:alert] = "You are not authorized to perform this action."
+            \t  redirect_to(request.referrer || root_path)
+            \tend
+          RUBY
+        end
+      end
+
+      def after_run
+        unless options[:skip_rescue]
+          say "\nPlease check the `application_controller.rb` file and fix any potential issues"
+        end
+
+        say "\nDon't forget, that you can generate policies with \nrails g pundit:policy Model\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Boring
+  module Rubocop
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds rubocop to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      DEFAULT_RUBY_VERSION = "2.7.1"
+
+      class_option :skip_adding_rubocop_rules, type: :boolean, aliases: "-s",
+                                               desc: "Skip adding rubocop rules and add empty file."
+      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}"
+
+      def add_rubocop_gems
+        say "Adding rubocop gems", :green
+        bullet_gem_content = <<~RUBY
+          \n
+          \t# A Ruby static code analyzer, based on the community Ruby style guide
+          \tgem "rubocop",  require: false
+          \tgem "rubocop-rails",  require: false
+          \tgem "rubocop-performance", require: false
+        RUBY
+        insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
+        run "bundle install"
+      end
+
+      def add_rails_prefered_rubocop_rules
+        say "Adding rubocop style guides", :green
+        @skip_adding_rules = options[:skip_adding_rubocop_rules]
+        @target_ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+        template(".rubocop.yml", ".rubocop.yml")
+      end
+    end
+  end
+end

data/lib/generators/boring/rubocop/install/templates/.rubocop.yml.tt

@@ -0,0 +1,262 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
+<%- unless @skip_adding_rules %>
+AllCops:
+  TargetRubyVersion: <%= @target_ruby_version %>
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - bin/*
+    - db/**/*
+    - script/**/*
+    - vendor/**/*
+    - node_modules/**/*
+    - node-server/**/*
+    - tmp/**/*
+    - config/**/*
+    - Gemfile
+
+# Prefer assert_not over assert !
+Rails/AssertNot:
+  Include:
+    - '**/test/**/*'
+
+# Prefer assert_not_x over refute_x
+Rails/RefuteMethods:
+  Include:
+    - '**/test/**/*'
+
+Rails/IndexBy:
+  Enabled: true
+
+Rails/IndexWith:
+  Enabled: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true
+
+Performance/DeletePrefix:
+  Enabled: true
+
+Performance/DeleteSuffix:
+  Enabled: true
+  
+<% end %>