boring_generators 0.1.0 → 0.6.0

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Boring
+  module Ci
+    module Travisci
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds Github Action to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        DEFAULT_RUBY_VERSION = "2.7.1"
+
+        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_github_actions_configuration
+          @ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+
+          template(".travis.yml", ".travis.yml")
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/ci/travisci/install/templates/.travis.yml.tt

@@ -0,0 +1,35 @@
+language: ruby
+
+rvm:
+  - <%= @ruby_version %>
+
+services:
+  - postgresql
+
+cache:
+  bundler: true
+  directories:
+    - node_modules
+  yarn: true
+
+env:
+  global:
+    - RAILS_ENV=test
+    - NODE_ENV=test
+
+before_install:
+  - nvm install --lts
+
+install:
+  - node -v
+  - yarn
+  - bundle
+
+before_script:
+  - bundle install --jobs=3 --retry=3
+  - bundle exec rails db:create
+  - bundle exec rails db:schema:load
+
+script:
+  - bundle exec rails db:schema:load
+  - bundle exec rails test

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Boring
+  module Devise
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds devise to the application"
+
+      DEFAULT_DEVISE_MODEL_NAME = "User"
+
+      class_option :model_name, type: :string, aliases: "-m",
+                   desc: "Tell us the user model name which will be used for authentication. Defaults to #{DEFAULT_DEVISE_MODEL_NAME}"
+      class_option :skip_devise_view, type: :boolean, aliases: "-sv",
+                   desc: "Skip generating devise views"
+      class_option :skip_devise_model, type: :boolean, aliases: "-sm",
+                   desc: "Skip generating devise model"
+
+      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"
+        end
+      end
+
+      def generating_devise_defaults
+        say "Generating devise defaults", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:install"
+        end
+      end
+
+      def add_devise_action_mailer_development_config
+        say "Adding devise Action Mailer development configuration", :green
+        insert_into_file "config/environments/development.rb", <<~RUBY, after: /Rails.application.configure do/
+          \n
+          \tconfig.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+        RUBY
+      end
+
+      def add_devise_user_model
+        return if options[:skip_devise_model]
+
+        say "Adding devise user model", :green
+        model_name = options[:model_name] || DEFAULT_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
+        insert_into_file "app/controllers/application_controller.rb", <<~RUBY, after: /class ApplicationController < ActionController::Base/
+          \n
+          \tbefore_action :authenticate_user!
+        RUBY
+      end
+
+      def add_devise_views
+        return if options[:skip_devise_view]
+
+        say "Adding devise views", :green
+        model_name = options[:model_name] || DEFAULT_DEVISE_MODEL_NAME
+
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:views #{model_name.pluralize}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Boring
+  module FontAwesome
+    module RubyGem
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds fontawesome via yarn to the application"
+
+        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"
+        end
+
+        def import_font_awesome_stylesheet
+          say "Adding font awesome stylesheets", :green
+          stylesheet_font_awesome_imports = <<~RUBY
+            \n
+            @import "font-awesome-sprockets";
+            @import "font-awesome";
+          RUBY
+
+          if File.exist?("app/assets/stylesheets/application.css.scss")
+            append_to_file "app/assets/stylesheets/application.css.scss", stylesheet_font_awesome_imports
+          elsif File.exist?("app/assets/stylesheets/application.scss")
+            append_to_file "app/assets/stylesheets/application.scss", stylesheet_font_awesome_imports
+          else
+            say <<~WARNING, :red
+              ERROR: Looks like the application.css.scss is missing. Please rename the file and re-run the generator.
+            WARNING
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Boring
+  module FontAwesome
+    module Yarn
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+        desc "Adds fontawesome via rubygems to the application"
+
+        def add_font_awesome_package
+          say "Adding fontawesome packages", :green
+          run "yarn add @fortawesome/fontawesome-free"
+        end
+
+        def import_font_awesome_stylesheet
+          say "Adding font awesome stylesheets", :green
+          if File.exist?("app/javascript/stylesheets/application.scss")
+            stylesheet_font_awesome_imports = <<~RUBY
+              \n
+              @import '@fortawesome/fontawesome-free';
+            RUBY
+
+            append_to_file "app/javascript/stylesheets/application.scss", stylesheet_font_awesome_imports
+          else
+            say "Copying application.scss with FontAwesome imports", :green
+            template("application.scss", "app/javascript/stylesheets/application.scss")
+          end
+        end
+
+        def import_font_awesome_javascript
+          if File.exist?("app/javascript/packs/application.js")
+            javascript_font_awesome_imports = <<~RUBY
+              \n
+              import "@fortawesome/fontawesome-free/js/all"
+            RUBY
+
+            append_to_file "app/javascript/packs/application.js", javascript_font_awesome_imports
+          else
+            say <<~WARNING, :red
+              ERROR: Looks like the webpacker installation is incomplete. Could not find application.js in app/javascript/packs.
+            WARNING
+          end
+        end
+
+        def insert_stylesheet_packs_tag
+          insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /stylesheet_link_tag.*\n/
+            \t\t<%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/font_awesome/yarn/install/templates/application.scss

@@ -0,0 +1 @@
+@import '@fortawesome/fontawesome-free';

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