boring_generators 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b70f624969fe4703d011e6eb9885aec618fa1292ed919610a151257126bbf0
-  data.tar.gz: e34d25d853079666eeb09c4a5c27b306f4a8a835a8d5e3f300ad7a126eb81b23
+  metadata.gz: 66c4c0c7499756d66e0d992e4ec79ad105f310b40384a49d99b1a3f96ebfaeab
+  data.tar.gz: '074778686e124d14e6010e6a886b209484abf2774e0836e48631c900738f3ae8'
 SHA512:
-  metadata.gz: 042b85804c5a7fc75f79596d55ab2ca4ec688268781717dbb2d02755bc5b9d40ffe17b60951f46fb2c2365c8560c466b4161a029f2d3da1e8987f6306d1bd6ee
-  data.tar.gz: a643190096fbd0c4b78e798547219f56d1877e4f91110ff8919448c56a77a7c9a8d4170eadfc70353615e73b886fb6101bfabea290f6b52ad4b815c068096609
+  metadata.gz: 44e5a7cfde50201a16ce39cd6c1e28618efe002229e81f15613278bdfdb5f448a4d02532d974b7fe232742cd5d6b5c55ac9aa851b84cad8bc90c1cb7c9efdb77
+  data.tar.gz: 7ec572ba9730632511e08d4aa6a943a8c97db89ae93c0b5d2db4813b9ece7ac53b586b1690d2f636d1bd7fcff6c46572501ec69752af1008b43c949e1789e456

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: boring_generators
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
 ## master (unreleased)
+
+## 0.6.0 (January 10th, 2021)
+* Updates default ruby version of GitHub Actions install generator. ([@jamesglover][])
+* Simplify generated GitHub Actions install ([@jamesglover][])
+* Adds boring generator CLI ([@luathn][])
+* Adds Devise Facebook Omniauth generator. ([@abhaynikam][])
+
+## 0.5.0 (December 20th, 2020)
 * Adds favicon build generator. ([@abhaynikam][])
 * Adds Pundit install generator. ([@CiTroNaK][])
 * Adds GraphQL generator. ([@abhaynikam][])
@@ -34,3 +42,5 @@
 
 [@abhaynikam]: https://github.com/abhaynikam
 [@CiTroNaK]: https://github.com/CiTroNaK
+[@jamesglover]: https://github.com/JamesGlover
+[@luathn]: https://github.com/luathn

data/Gemfile

@@ -3,6 +3,11 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in boring_generators.gemspec
 gemspec
 
+gem "rails", "~> 6.0.3.4"
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "byebug"
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end

data/Gemfile.lock

@@ -1,12 +1,29 @@
 PATH
   remote: .
   specs:
-    boring_generators (0.4.0)
+    boring_generators (0.5.0)
       railties
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
     actionpack (6.0.3.4)
       actionview (= 6.0.3.4)
       activesupport (= 6.0.3.4)
@@ -14,12 +31,31 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
     actionview (6.0.3.4)
       activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      marcel (~> 0.3.1)
     activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
@@ -30,20 +66,44 @@ GEM
     byebug (11.1.3)
     concurrent-ruby (1.1.7)
     crass (1.0.6)
-    erubi (1.9.0)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.7.0)
+    loofah (2.8.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
     method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
+    nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.4)
+      sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -56,11 +116,22 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (12.3.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -69,7 +140,9 @@ DEPENDENCIES
   boring_generators!
   byebug
   minitest (~> 5.0)
+  rails (~> 6.0.3.4)
   rake (~> 12.0)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -32,6 +32,11 @@ Or install it yourself as:
 
     $ gem install boring_generators
 
+And then you can use it this way:
+
+    $ boring generate boring:simple_form:install --css_framework=<css_framework>
+    $ boring g boring:pry:install
+
 ## Usage
 
 The boring generator introduces following generators:
@@ -55,11 +60,17 @@ The boring generator introduces following generators:
 - Install GraphQL: `rails generate boring:graphql:install`
 - Install SimpleForm: `rails generate boring:simple_form:install --css_framework=<css_framework>`
 - Install Devise: `rails generate boring:devise:install`
+- Install Devise Facebook Omniauth: `rails generate boring:oauth:facebook:install`
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+You can also run specific test cases using following commands:
+```
+bundle exec ruby -w -Itest test/generators/tailwind_install_generator_test.rb
+```
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/boring_generators.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'railties'
+  spec.add_dependency "railties"
 end

data/exe/boring

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/boring_generators/cli"
+
+BoringGenerators::CLI.start(ARGV)

data/lib/boring_generators.rb

@@ -1,4 +1,5 @@
 require "boring_generators/version"
+require 'bundler'
 
 module BoringGenerators
   class Error < StandardError; end

data/lib/boring_generators/cli.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require "rails/generators"
+require_relative "../boring_generators"
+
+module BoringGenerators
+  class CLI < Thor
+    map "g" => :generate
+    map %w(--version -v) => :__print_version
+
+    desc "generate GENERATOR [options]", "Add gem to the application"
+    def generate(generator, *options)
+      Rails::Generators.invoke(generator, options)
+    end
+
+    desc "--version, -v", "Print gem version"
+    def __print_version
+      puts "Boring generators #{BoringGenerators::VERSION}"
+    end
+
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

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

@@ -22,12 +22,16 @@ module Boring
           gem 'devise', '~> 4.7'
         RUBY
         append_to_file "Gemfile", devise_gem
-        run "bundle install"
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        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 +48,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 +66,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/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