boring_generators 0.2.0 → 0.7.0

data/lib/generators/boring/favicon/build/build_generator.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Boring
+  module Favicon
+    class BuildGenerator < Rails::Generators::Base
+      desc "Build favicons for all platforms"
+      source_root File.expand_path("templates", __dir__)
+
+      ICO_SIZES = %w(16 32)
+      APPLE_SIZES = %w(57 60 72 76 114 120 129 144 152)
+      APPLE_PRECOMPOSED_SIZES = %w(120 129 152)
+      SMALL_BREAK = 50
+      LARGE_BREAK = 150
+      MS_TILE_SIZES = %w(144)
+      FAVICON_DIR = "favicons"
+      FILE_FAVICO_DIR = "app/assets/images/#{FAVICON_DIR}"
+      DEFAULT_PRIMARY_COLOR = "#082472"
+      DEFAULT_FAVICON_LETTER = "B" # B for boring_generators :)
+      DEFAULT_IMAGE_PATH = "#{FILE_FAVICO_DIR}/template.png"
+
+      class_option :primary_color,        type: :string, aliases: "-color",
+                                          desc: "Tell us the primary color to build favicon. Default to primary: #{DEFAULT_PRIMARY_COLOR}"
+      class_option :favico_letter,        type: :string, aliases: "-letter",
+                                          desc: "Tell us the favicon letter to build favicon. Default to primary: #{DEFAULT_FAVICON_LETTER}"
+      class_option :font_file_path,       type: :string, aliases: "-fp",
+                                          desc: "Tell us the font to be used generate favicon."
+      class_option :application_name,     type: :string, aliases: "-app_name",
+                                          desc: "Tell us the application name to be used in favicon partial."
+
+      def build_favicon
+        @application_name = options[:application_name]
+        @primary_color = options[:primary_color]
+
+        unless /Version/m =~ (`convert -version`)
+          say <<~WARNING, :red
+            ERROR: You do not have ImageMagick installed.
+          WARNING
+        end
+      end
+
+      def create_favicon_directory
+        unless File.exists?(FILE_FAVICO_DIR)
+          Dir.mkdir FILE_FAVICO_DIR
+        end
+      end
+
+      def build_favicon_for_existing_template_image
+        return unless File.exist?(DEFAULT_IMAGE_PATH)
+
+        say "Converting template image to favicons..."
+        template_name = "#{FILE_FAVICO_DIR}/template.png"
+        template_small_name = "#{FILE_FAVICO_DIR}/template-small.png"
+        template_large_name = "#{FILE_FAVICO_DIR}/template-large.png"
+        template_small_name = template_name unless File.file?(template_small_name)
+        template_large_name = template_name unless File.file?(template_large_name)
+        ICO_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/favicon-#{size}x#{size}.ico`)
+        end
+        APPLE_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}.png`)
+        end
+        APPLE_PRECOMPOSED_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}-precomposed.png`)
+        end
+        MS_TILE_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/mstile-#{size}x#{size}.png`)
+        end
+        ico_template = template_name
+        ico_template = template_small_name if 152 <= SMALL_BREAK
+        ico_template = template_small_name if 152 >= LARGE_BREAK
+        (`convert #{ico_template} -resize 152x152 #{FILE_FAVICO_DIR}/apple-touch-icon.png`)
+        (`convert #{ico_template} -resize 152x152 #{FILE_FAVICO_DIR}/apple-touch-icon-precomposed.png`)
+      end
+
+      def generate_new_favicon_using_favico_letter
+        return if File.exist?(DEFAULT_IMAGE_PATH)
+        say "Creating favicons from application...", :green
+
+        favico_letter = options[:favico_letter] || @application_name.try(:first) || DEFAULT_FAVICON_LETTER
+        font_file_path = options[:font_file_path]
+        favicon_color = options[:primary_color] || DEFAULT_PRIMARY_COLOR
+
+        ICO_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/favicon-#{size}x#{size}.ico`)
+        end
+        APPLE_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}.png`)
+        end
+        APPLE_PRECOMPOSED_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}-precomposed.png`)
+        end
+        MS_TILE_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/mstile-#{size}x#{size}.png`)
+        end
+        (`convert -background "#{favicon_color}" -fill white -size 152x152 -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon.png`)
+        (`convert -background "#{favicon_color}" -fill white -size 152x152 -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-precomposed.png`)
+      end
+
+      def add_favicon_partial
+        say "Copying favicon layout partial", :green
+        template("favicon.html.erb", "app/views/layouts/shared/_favicon.html.erb")
+        insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /head.*\n/
+          \t\t<%= render 'layouts/shared/favicon' %>
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/boring/favicon/build/templates/favicon.html.erb.tt

@@ -0,0 +1,19 @@
+<%%= favicon_link_tag "favicons/favicon-16x16.ico", rel: 'shortcut icon', type: 'image/x-icon' %>
+<%%= favicon_link_tag "favicons/favicon-32x32.ico", rel: 'shortcut icon', type: 'image/x-icon' %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-57x57.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "57x57" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-60x60.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "60x60" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-72x72.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "72x72" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-76x76.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "76x76" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-114x114.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "114x114" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-120x120.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "120x120" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-129x129.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "129x129" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-144x144.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "144x144" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-152x152.png", rel: 'apple-touch-icon', type: 'image/png', sizes: "152x152" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon.png", rel: 'apple-touch-icon', type: 'image/png' %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-120x120-precomposed.png", rel: 'apple-touch-icon-precomposed', type: 'image/png', sizes: "120x120" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-129x129-precomposed.png", rel: 'apple-touch-icon-precomposed', type: 'image/png', sizes: "129x129" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-152x152-precomposed.png", rel: 'apple-touch-icon-precomposed', type: 'image/png', sizes: "152x152" %>
+<%%= favicon_link_tag "favicons/apple-touch-icon-precomposed.png", rel: 'apple-touch-icon-precomposed', type: 'image/png' %>
+<meta name="msapplication-TileImage" content="<%%= image_path("favicons/mstile-144x144.png") %>" />
+<meta name="msapplication-TileColor" content="<%= @primary_color %>" />
+<meta name="application-name" content="<%= @application_name %>">

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Boring
+  module Graphql
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds GraphQL to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      OPTIONS = %w(relay batch playground no-graphiql schema)
+
+      class_option :skip_resolver_setup, type: :boolean, aliases: "-s",
+                                         desc: "Skips adding GraphQL resolver setup to the application"
+
+      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"
+      end
+
+      def run_graphql_generator
+        say "Running GraphQL default generator", :green
+        run "bundle exec rails generate graphql:install"
+        run "bundle install"
+
+        graphiql_precompile_assets = <<~RUBY
+          \n
+          if Rails.env.development?
+            Rails.application.config.assets.precompile += %w[graphiql/rails/application.js graphiql/rails/application.css]
+          end
+        RUBY
+        append_to_file "config/initializers/assets.rb", graphiql_precompile_assets
+      end
+
+      def adds_graphql_resolver
+        return if options[:skip_resolver_setup]
+        template("base_resolver.rb", "app/graphql/resolvers/base_resolver.rb")
+        template("hello_world_resolver.rb", "app/graphql/resolvers/hello_world_resolver.rb")
+
+        insert_into_file "app/graphql/types/query_type.rb", <<~RUBY, after: /class QueryType < Types::BaseObject\n/
+          \t\t# TODO: remove me
+          \t\tfield :hello, resolver: Resolvers::HelloWorldResolver
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/boring/graphql/install/templates/base_resolver.rb

@@ -0,0 +1,2 @@
+class Resolvers::BaseResolver < GraphQL::Schema::Resolver
+end

data/lib/generators/boring/graphql/install/templates/hello_world_resolver.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Resolvers::HelloWorldResolver < Resolvers::BaseResolver
+  description "Returns hello world"
+
+  type String, null: false
+
+  def resolve
+    "Hello World"
+  end
+end

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]
+              \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 show_readme
+        readme "README"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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
+          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 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,20 @@
+===============================================================================
+
+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"
+
+===============================================================================

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,42 @@
+# 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
+          github_omniauth_gem = <<~RUBY
+            \n
+            # for omniauth github
+            gem 'omniauth-github', '~> 1.4.0'
+          RUBY
+          append_to_file "Gemfile", github_omniauth_gem
+          Bundler.with_unbundled_env do
+            run "bundle install"
+          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,20 @@
+===============================================================================
+
+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"
+
+===============================================================================

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