Merge pull request #49 from gobuffalo/fixing-could-not-find-desired-block

fixing could not find desired block (fixes #48)

Author: sio4

README.md

@@ -8,8 +8,6 @@ Buffalo-goth is a plugin for [buffalo cli](https://github.com/gobuffalo/cli)
 that makes it easy to integrate [goth](https://github.com/markbates/goth)
 into your Buffalo application.
 
-In Buffalo `v0.9.4` the built in generator for [github.com/markbates/goth](https://github.com/markbates/goth) was removed in favor of this plugin.
-
 ## Installation
 
 ```console

SHOULDERS.md

@@ -29,7 +29,6 @@ Thank you to the following **GIANTS**:
 * [github.com/kr/text](https://godoc.org/github.com/kr/text)
 * [github.com/microcosm-cc/bluemonday](https://godoc.org/github.com/microcosm-cc/bluemonday)
 * [github.com/pkg/diff](https://godoc.org/github.com/pkg/diff)
-* [github.com/pkg/errors](https://godoc.org/github.com/pkg/errors)
 * [github.com/pmezard/go-difflib](https://godoc.org/github.com/pmezard/go-difflib)
 * [github.com/rogpeppe/go-internal](https://godoc.org/github.com/rogpeppe/go-internal)
 * [github.com/russross/blackfriday/v2](https://godoc.org/github.com/russross/blackfriday/v2)
@@ -52,6 +51,5 @@ Thank you to the following **GIANTS**:
 * [golang.org/x/tools](https://godoc.org/golang.org/x/tools)
 * [golang.org/x/xerrors](https://godoc.org/golang.org/x/xerrors)
 * [gopkg.in/check.v1](https://godoc.org/gopkg.in/check.v1)
-* [gopkg.in/errgo.v2](https://godoc.org/gopkg.in/errgo.v2)
 * [gopkg.in/yaml.v2](https://godoc.org/gopkg.in/yaml.v2)
 * [gopkg.in/yaml.v3](https://godoc.org/gopkg.in/yaml.v3)

cmd/auth.go

@@ -2,12 +2,12 @@ package cmd
 
 import (
 	"context"
+	"fmt"
 	"os/exec"
 
 	"github.com/gobuffalo/buffalo-goth/genny/auth"
 	"github.com/gobuffalo/genny/v2"
 	"github.com/gobuffalo/genny/v2/gogen"
-	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
 
@@ -33,13 +33,13 @@ var authCmd = &cobra.Command{
 		opts.Providers = args
 		gg, err := auth.New(opts)
 		if err != nil {
-			return errors.WithStack(err)
+			return err
 		}
 		gg.With(r)
 
 		g, err := gogen.Fmt(r.Root)
 		if err != nil {
-			return errors.WithStack(err)
+			return fmt.Errorf("formatting error: %w", err)
 		}
 		r.With(g)
 

cmd/generate.go

@@ -2,12 +2,12 @@ package cmd
 
 import (
 	"context"
+	"fmt"
 	"os/exec"
 
 	"github.com/gobuffalo/buffalo-goth/genny/goth"
 	"github.com/gobuffalo/genny/v2"
 	"github.com/gobuffalo/genny/v2/gogen"
-	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
 
@@ -34,13 +34,13 @@ var generateCmd = &cobra.Command{
 		opts.Providers = args
 		g, err := goth.New(opts)
 		if err != nil {
-			return errors.WithStack(err)
+			return err
 		}
 		r.With(g)
 
 		g, err = gogen.Fmt(r.Root)
 		if err != nil {
-			return errors.WithStack(err)
+			return fmt.Errorf("formatting error: %w", err)
 		}
 		r.With(g)
 

cmd/version.go

@@ -11,9 +11,9 @@ import (
 // versionCmd represents the version command
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "current version of goth",
+	Short: "current version of buffalo-goth",
 	RunE: func(cmd *cobra.Command, args []string) error {
-		fmt.Println("goth", goth.Version)
+		fmt.Println("buffalo-goth", goth.Version)
 		return nil
 	},
 }

genny/auth/auth.go

@@ -3,6 +3,7 @@ package auth
 import (
 	"bytes"
 	"embed"
+	"fmt"
 	"io/fs"
 	"os/exec"
 	"strings"
@@ -11,7 +12,6 @@ import (
 	"github.com/gobuffalo/genny/v2"
 	"github.com/gobuffalo/genny/v2/gogen"
 	"github.com/gobuffalo/meta"
-	"github.com/pkg/errors"
 
 	"github.com/gobuffalo/buffalo-goth/genny/goth"
 )
@@ -25,19 +25,19 @@ func New(opts *Options) (*genny.Group, error) {
 		Providers: opts.Providers,
 	})
 	if err != nil {
-		return gg, errors.WithStack(err)
+		return gg, err
 	}
 	gg.Add(g)
 
 	sub, err := fs.Sub(templates, "templates")
 	if err != nil {
-		return gg, errors.WithStack(err)
+		return gg, fmt.Errorf("failed to get subtree of templates: %w", err)
 	}
 
 	g = genny.New()
 
 	if err := g.FS(sub); err != nil {
-		return gg, errors.WithStack(err)
+		return gg, fmt.Errorf("failed to add subtree: %w", err)
 	}
 
 	h := template.FuncMap{
@@ -59,7 +59,7 @@ func New(opts *Options) (*genny.Group, error) {
 
 		f, err := r.FindFile(path)
 		if err != nil {
-			return errors.WithStack(err)
+			return fmt.Errorf("setup goth: %w", err)
 		}
 
 		bb := &bytes.Buffer{}

genny/auth/auth_test.go

@@ -68,6 +68,9 @@ var app *buffalo.App
 func App() *buffalo.App {
 	if app == nil {
 		app = buffalo.New(buffalo.Options{})
+		
+		// NOTE: this block should go before any resources
+		// that need to be protected by buffalo-goth!
 		auth := app.Group("/auth")
 		app.Use(SetCurrentUser)
 		app.Use(Authorize)
@@ -77,6 +80,7 @@ func App() *buffalo.App {
 		auth.DELETE("", AuthDestroy)
 		auth.Middleware.Skip(Authorize, bah, AuthCallback)
 		auth.GET("/{provider}/callback", AuthCallback)
+		
 	}
 
 	return app

genny/auth/templates/actions/auth.go.tmpl

@@ -2,18 +2,20 @@ package actions
 
 import (
 	"fmt"
+	"net/http"
 	"os"
 
+	"{{.app.ModelsPkg}}"
+
 	"github.com/gobuffalo/buffalo"
-  "{{.app.ModelsPkg}}"
-	"github.com/markbates/going/defaults"
+	"github.com/gobuffalo/nulls"
+	"github.com/gobuffalo/pop/v6"
+	"github.com/gobuffalo/x/defaults"
 	"github.com/markbates/goth"
 	"github.com/markbates/goth/gothic"
 	{{range .providers -}}
 	"github.com/markbates/goth/providers/{{ downcase . }}"
-  {{end -}}
-	"github.com/gobuffalo/pop/v6"
-	"github.com/gobuffalo/nulls"
+	{{end -}}
 	"github.com/pkg/errors"
 )
 
@@ -30,7 +32,7 @@ func init() {
 func AuthCallback(c buffalo.Context) error {
 	gu, err := gothic.CompleteUserAuth(c.Response(), c.Request())
 	if err != nil {
-		return c.Error(401, err)
+		return c.Error(http.StatusUnauthorized, err)
 	}
 	tx := c.Value("tx").(*pop.Connection)
 	q := tx.Where("provider = ? and provider_id = ?", gu.Provider, gu.UserID)
@@ -58,13 +60,13 @@ func AuthCallback(c buffalo.Context) error {
 	}
 
 	c.Flash().Add("success", "You have been logged in")
-	return c.Redirect(302, "/")
+	return c.Redirect(http.StatusFound, "/")
 }
 
 func AuthDestroy(c buffalo.Context) error {
 	c.Session().Clear()
 	c.Flash().Add("success", "You have been logged out")
-	return c.Redirect(302, "/")
+	return c.Redirect(http.StatusFound, "/")
 }
 
 func SetCurrentUser(next buffalo.Handler) buffalo.Handler {
@@ -85,7 +87,7 @@ func Authorize(next buffalo.Handler) buffalo.Handler {
 	return func(c buffalo.Context) error {
 		if uid := c.Session().Get("current_user_id"); uid == nil {
 			c.Flash().Add("danger", "You must be authorized to see that page")
-			return c.Redirect(302, "/")
+			return c.Redirect(http.StatusFound, "/")
 		}
 		return next(c)
 	}

genny/goth/goth.go

@@ -2,13 +2,13 @@ package goth
 
 import (
 	"embed"
+	"fmt"
 	"io/fs"
 	"strings"
 	"text/template"
 
 	"github.com/gobuffalo/genny/v2"
 	"github.com/gobuffalo/genny/v2/gogen"
-	"github.com/pkg/errors"
 )
 
 //go:embed templates
@@ -18,15 +18,15 @@ func New(opts *Options) (*genny.Generator, error) {
 	g := genny.New()
 
 	if len(opts.Providers) == 0 {
-		return g, errors.New("you must specify at least one provider")
+		return g, fmt.Errorf("you must specify at least one provider")
 	}
 
 	sub, err := fs.Sub(templates, "templates")
 	if err != nil {
-		return g, errors.WithStack(err)
+		return g, fmt.Errorf("failed to get subtree of templates: %w", err)
 	}
 	if err := g.FS(sub); err != nil {
-		return g, errors.WithStack(err)
+		return g, fmt.Errorf("failed to add subtree: %w", err)
 	}
 
 	h := template.FuncMap{
@@ -44,22 +44,41 @@ func New(opts *Options) (*genny.Generator, error) {
 
 		f, err := r.FindFile(path)
 		if err != nil {
-			return errors.WithStack(err)
+			return fmt.Errorf("setup goth: %w", err)
 		}
 
 		f, err = gogen.AddImport(f, "github.com/markbates/goth/gothic")
 		if err != nil {
-			return errors.WithStack(err)
+			return fmt.Errorf("could not add import: %w", err)
 		}
 
 		expressions := []string{
+			"",
+			"// NOTE: this block should go before any resources",
+			"// that need to be protected by buffalo-goth!",
 			"auth := app.Group(\"/auth\")",
 			"auth.GET(\"/{provider}\", buffalo.WrapHandlerFunc(gothic.BeginAuthHandler))",
 			"auth.GET(\"/{provider}/callback\", AuthCallback)",
+			"",
 		}
-		f, err = gogen.AddInsideBlock(f, "if app == nil {", expressions...)
+
+		f, err = gogen.AddInsideBlock(f, "appOnce.Do(func() {", expressions...)
 		if err != nil {
-			return errors.WithStack(err)
+			if strings.Contains(err.Error(), "could not find desired block") {
+				// TODO: remove this block some day soon
+				// add this block for compatibility with the apps built with
+				// the old version of Buffalo CLI (v0.18.8 or older)
+				f, err = gogen.AddInsideBlock(f, "if app == nil {", expressions...)
+				if err != nil {
+					if err != nil {
+						return fmt.Errorf("could not add a code block: %w", err)
+					} else {
+						r.Logger.Warnf("This app was built with CLI v0.18.8 or older. See https://gobuffalo.io/documentation/known-issues/#cli-v0.18.8")
+					}
+				}
+			} else {
+				return fmt.Errorf("could not add a code block: %w", err)
+			}
 		}
 		return r.File(f)
 	})

genny/goth/goth_test.go

@@ -73,9 +73,13 @@ var app *buffalo.App
 func App() *buffalo.App {
 	if app == nil {
 		app = buffalo.New(buffalo.Options{})
+		
+		// NOTE: this block should go before any resources
+		// that need to be protected by buffalo-goth!
 		auth := app.Group("/auth")
 		auth.GET("/{provider}", buffalo.WrapHandlerFunc(gothic.BeginAuthHandler))
 		auth.GET("/{provider}/callback", AuthCallback)
+		
 	}
 
 	return app
@@ -85,14 +89,15 @@ const authAfter = `package actions
 
 import (
 	"fmt"
+	"net/http"
 	"os"
 
 	"github.com/gobuffalo/buffalo"
 	"github.com/markbates/goth"
 	"github.com/markbates/goth/gothic"
 	"github.com/markbates/goth/providers/github"
-  "github.com/markbates/goth/providers/twitter"
-  )
+	"github.com/markbates/goth/providers/twitter"
+	)
 
 func init() {
 	gothic.Store = App().SessionStore
@@ -106,9 +111,9 @@ func init() {
 func AuthCallback(c buffalo.Context) error {
 	user, err := gothic.CompleteUserAuth(c.Response(), c.Request())
 	if err != nil {
-		return c.Error(401, err)
+		return c.Error(http.StatusUnauthorized, err)
 	}
 	// Do something with the user, maybe register them/sign them in
-	return c.Render(200, r.JSON(user))
+	return c.Render(http.StatusOK, r.JSON(user))
 }
 `