garden_variety 2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b80f333fab73447d743d99ef4cd170a997011a8e
-  data.tar.gz: ab23ee38fd1a658f8fa7a82eeac8708110346bb4
+SHA256:
+  metadata.gz: 505860db6877118744ce3b7f1b4de589c12e0adf8687ab8cadc518fec0a52b37
+  data.tar.gz: a4b18a197a210123c5db5f72c1510e1a4ea75e843c543af98635a842bc04cea3
 SHA512:
-  metadata.gz: 1a36d05543168c2739e1b2677aa4b870c534ca4a5fc340a80ae80f18e920b238c59017179cd16e5824f2bce62ac36db3ca73a4c80f98a5e8f61381de597ef336
-  data.tar.gz: a93377a1e7c252f6ad547febe70bdaedc83a62383819e04766bda20b604f5db055571d17fa7d56b5a4680eccb0d124bf54d5171787a5a1858cdb472b80cbc58f
+  metadata.gz: 1703aa1c557798193c1292c7b6999d18f5962d9bf2ebafc83f13c091342376d3a592f6673c519af285e2baa6228222ad9335ded99687748525c551099b5fe965
+  data.tar.gz: c005e563d798f172a9437423b6921713642442e44061ab350ae8aadbb062486325af39380dcc6f17cbe67e41f7ee24c234282852a1f469d8d30df9467de98a94

data/README.md

@@ -7,11 +7,10 @@ robustness (less custom code == less that can go wrong).  In service of
 this principle, *garden_variety* provides reasonable default controller
 actions, with care to allow easy override.
 
-*garden_variety* also uses the excellent
-[Pundit](https://rubygems.org/gems/pundit) gem to isolate authorization
-concerns.  If you're unfamiliar with Pundit, see its documentation for
-an explanation of policy objects and how they help controller actions
-stay DRY and boring.
+*garden_variety* also relies on the [Pundit](https://rubygems.org/gems/pundit)
+gem to isolate authorization concerns.  If you're unfamiliar with
+Pundit, see its documentation for an explanation of policy objects and
+how they help controller actions stay DRY and boring.
 
 As an example, this controller using `garden_variety`...
 
@@ -27,29 +26,26 @@ end
 class PostsController < ApplicationController
 
   def index
-    authorize(resource_class)
-    self.resources = policy_scope(list_resources)
+    authorize(self.class.model_class)
+    self.collection = policy_scope(find_collection)
   end
 
   def show
-    self.resource = find_resource
-    authorize(resource)
+    self.model = authorize(find_model)
   end
 
   def new
-    if params.key?(resource_class.model_name.param_key)
-      self.resource = vest(new_resource)
-    else
-      self.resource = new_resource
-      authorize(resource)
+    self.model = authorize(new_model)
+    if params.key?(self.class.model_class.model_name.param_key)
+      assign_attributes(model)
     end
   end
 
   def create
-    self.resource = vest(new_resource)
-    if resource.save
+    self.model = assign_attributes(authorize(new_model))
+    if model.save
       flash[:success] = flash_message(:success)
-      redirect_to resource
+      redirect_to model
     else
       flash.now[:error] = flash_message(:error)
       render :new
@@ -57,15 +53,14 @@ class PostsController < ApplicationController
   end
 
   def edit
-    self.resource = find_resource
-    authorize(resource)
+    self.model = authorize(find_model)
   end
 
   def update
-    self.resource = vest(find_resource)
-    if resource.save
+    self.model = assign_attributes(authorize(find_model))
+    if model.save
       flash[:success] = flash_message(:success)
-      redirect_to resource
+      redirect_to model
     else
       flash.now[:error] = flash_message(:error)
       render :edit
@@ -73,9 +68,8 @@ class PostsController < ApplicationController
   end
 
   def destroy
-    self.resource = find_resource
-    authorize(resource)
-    if resource.destroy
+    self.model = authorize(find_model)
+    if model.destroy
       flash[:success] = flash_message(:success)
       redirect_to action: :index
     else
@@ -86,69 +80,68 @@ class PostsController < ApplicationController
 
   private
 
-  def resource_class
+  def self.model_class
     Post
   end
 
-  def resources
+  def collection
     @posts
   end
 
-  def resources=(models)
+  def collection=(models)
     @posts = models
   end
 
-  def resource
+  def model
     @post
   end
 
-  def resource=(model)
+  def model=(model)
     @post = model
   end
 
-  def list_resources
-    resource_class.all
+  def find_collection
+    self.class.model_class.all
   end
 
-  def find_resource
-    resource_class.find(params[:id])
+  def find_model
+    self.class.model_class.find(params[:id])
   end
 
-  def new_resource
-    resource_class.new
+  def new_model
+    self.class.model_class.new
   end
 
-  def vest(model)
-    authorize(model)
+  def assign_attributes(model)
     model.assign_attributes(permitted_attributes(model))
     model
   end
 
   def flash_options
-    { resource_name: "post", resource_capitalized: "Post" }
+    { model_name: "Post" }
   end
 
   def flash_message(status)
     keys = [
-      :"posts.#{action_name}.#{status}",
-      :"posts.#{action_name}.#{status}_html",
-      :"#{action_name}.#{status}",
-      :"#{action_name}.#{status}_html",
-      :"#{status}",
-      :"#{status}_html",
+      :"flash.posts.#{action_name}.#{status}",
+      :"flash.posts.#{action_name}.#{status}_html",
+      :"flash.#{action_name}.#{status}",
+      :"flash.#{action_name}.#{status}_html",
+      :"flash.#{status}",
+      :"flash.#{status}_html",
     ]
-    helpers.translate(keys.first, default: keys.drop(1), **flash_options)
+    helpers.translate(keys.first, { default: keys.drop(1), **flash_options })
   end
 
 end
 ```
 
-The implementations of the `resource_class` and `resource` / `resources`
-accessor methods are generated based on the controller name.  They can
-be altered with an optional argument to the `garden_variety` macro.  The
-rest of the methods can be overridden as normal, a la carte.  For a
-detailed description of method behavior, see the
-[full documentation](http://www.rubydoc.info/gems/garden_variety/).
+The `::model_class` method returns a class corresponding to the
+controller name, by default.  That value can be overridden using the
+matching `::model_class=` setter.  The `model` / `collection` accessor
+methods are dictated by `::model_class`.  The rest of the methods can be
+overridden as normal, a la carte.  For a detailed description of method
+behavior, see the [API documentation](http://www.rubydoc.info/gems/garden_variety/).
 (Note that the `authorize`, `policy_scope`, and `permitted_attributes`
 methods are provided by Pundit.)
 
@@ -206,14 +199,23 @@ generator in a few small ways:
 * No jbuilder templates.  Only HTML templates are generated.
 * `rails generate pundit:policy` is invoked for the specified model.
 
+Additionally, if you are using the [talent_scout] gem, the scaffold
+generator will invoke `rails generate talent_scout:search` for the
+specified model.  This behavior can be disabled with the `--skip-talent-scout`
+option.  For more information about integrating with *talent_scout*, see
+the [Searching with talent_scout](#searching-with-talent_scout) section
+below.
+
+[talent_scout]: https://rubygems.org/gems/talent_scout
+
 
 ## Flash messages
 
 Flash messages are defined using I18n.  The *garden_variety* installer
-(`rails generate garden:install`) will create a
-"config/locales/garden_variety.en.yml" file containing default "success"
-and "error" messages.  You can edit this file to customize those
-messages, or add your own translation files to support other languages.
+(`rails generate garden:install`) will create a "config/locales/flash.en.yml"
+file containing default "success" and "error" messages.  You can edit
+this file to customize those messages, or add your own translation files
+to support other languages.
 
 As seen in the `PostsController#flash_message` method in the example
 above, a prioritized list of keys are tried when retrieving a flash
@@ -226,9 +228,8 @@ Internationalization guide for more information.)
 
 Interpolation in flash messages is also supported (as described by
 [Passing Variables to Translations]), with interpolation values provided
-by the `flash_options` method.  By default, `flash_options` provides
-`resource_name` and `resource_capitalized` values, but you can override
-it to provide your own values.
+by the `flash_options` method.  By default, `flash_options` provides a
+`model_name` value, but you can override it to provide your own values.
 
 [Safe HTML Translations]: http://guides.rubyonrails.org/i18n.html#using-safe-html-translations
 [Passing Variables to Translations]: http://guides.rubyonrails.org/i18n.html#passing-variables-to-translations
@@ -240,46 +241,103 @@ it to provide your own values.
 written, including in situations where custom code is unavoidable.
 
 
-### Integrating with pagination
+### Eliminating N+1 queries
+
+With proper Russian doll caching, [N+1 queries can be a feature](
+https://youtu.be/ktZLpjCanvg?t=4m27s).  But, if you need to eliminate
+an N+1 query by using eager loading, you can override the
+`find_collection` method:
+
+```ruby
+class PostsController < ApplicationController
+  garden_variety
+
+  def find_collection
+    super.includes(:author)
+  end
+end
+```
+
+
+### Pagination
 
 You can integrate your your favorite pagination gem (*may I suggest
-[foliate](https://rubygems.org/gems/foliate)?*) by overriding the
-`list_resources` method:
+[moar](https://rubygems.org/gems/moar)?*) by overriding the
+`find_collection` method:
 
 ```ruby
 class PostsController < ApplicationController
   garden_variety
 
-  def list_resources
-    paginate(super)
+  def find_collection
+    moar(super.order(:created_at))
   end
 end
 ```
 
 
-### Integrating with search
+### Searching
 
-You can also integrate search functionality by overriding the
-`list_resources` method:
+You can provide search functionality by overriding the `find_collection`
+method:
 
 ```ruby
 class PostsController < ApplicationController
   garden_variety
 
-  def list_resources
-    params[:author] ? super.where(author: params[:author]) : super
+  def find_collection
+    params[:title] ? super.where("title LIKE ?", "%#{params[:title]}%") : super
   end
 end
 ```
 
+#### Searching with talent_scout
+
+If you are using the [talent_scout] gem, the default implementation of
+`find_collection` will automatically instantiate your model search class
+-- no override required.  For example, if a `PostSearch` class is
+defined, `PostsController#find_collection` will be equivalent to:
+
+```ruby
+def find_collection
+  @search = PostSearch.new(params[:q])
+  @search.results
+end
+```
+
+Notice, as a side effect, the `@search` variable is set for later use in
+the view.  The model search class will be chosen based on the
+controller's `::model_class`.  For example:
+
+```ruby
+class MyPostsController < ApplicationController
+  garden_variety
+
+  self.model_class = Post # find_collection will use PostSearch instead of MyPostSearch
+end
+```
+
+If a corresponding model search class is not defined, `find_collection`
+will fall back to its original non-search behavior.
+
+Alternatively, you can override the model search class directly:
+
+```ruby
+class MyPostsController < ApplicationController
+  garden_variety
+
+  self.model_class = Post
+  self.model_search_class = MyPostSearch # find_collection will use MyPostSearch
+end
+```
+
 
-### Integrating with SJR
+### Server-generated JavaScript Responses (SJR)
 
-Server-generated JavaScript Response (SJR) controller actions are
-generally the same as conventional controller actions, with one
-difference: non-GET SJR actions render instead of redirect on success.
-*garden_variety* provides a concise syntax for overriding only
-on-success behavior of non-GET actions:
+SJR controller actions are generally the same as conventional controller
+actions, with one difference: non-GET SJR actions render instead of
+redirect on success.  *garden_variety* provides a concise syntax for
+overriding only the on-success behavior of non-GET actions:
 
 ```ruby
 class PostsController < ApplicationController
@@ -323,7 +381,7 @@ messages.  If a redirect is replaced with a render, the flash message
 will be set such that it does not affect the next request.
 
 
-### Integrating with authentication
+### Authentication
 
 The details of integrating authentication will depend on your chosen
 authentication library.  [Devise](https://rubygems.org/gems/devise) is
@@ -359,7 +417,7 @@ this conflict, add the following line to your Clearance initializer:
 ```
 
 
-### Integrating with Form Objects
+### Form Objects
 
 The Form Object pattern is used to mitigate the complexity of handling
 forms which need special processing logic, such as context-dependent
@@ -430,20 +488,21 @@ end
 
 ```ruby
 class PublishedPostsController < ApplicationController
-  garden_variety :index, resources: :posts
+  self.model_class = Post
+  garden_variety :index
 
-  def list_resources
+  def find_collection
     super.where(published: true)
   end
 end
 ```
 
-Note the `resources:` argument to the `garden_variety` macro.  The
-resource class for `PublishedPostsController` will be overridden as
-`Post` instead of derived as `PublishedPost`.  Likewise, the `@posts`
-instance variable will be used instead of `@published_posts`.
+Notice the call to `::model_class=`.  The model class for
+`PublishedPostsController` is overridden as `Post` instead of derived as
+`PublishedPost`.  And because of this override, the `@posts` instance
+variable will be used instead of `@published_posts`.
 
-This example may be somewhat contrived, but there is an excellent talk
+This example may be somewhat contrived, but here is an excellent talk
 from RailsConf which delves deeper into the principle:
 [In Relentless Pursuit of REST](https://www.youtube.com/watch?v=HctYHe-YjnE)
 ([slides](https://speakerdeck.com/derekprior/in-relentless-pursuit-of-rest)).
@@ -463,7 +522,7 @@ Then execute:
 $ bundle install
 ```
 
-And finally, run the *garden_variety* install generator:
+And finally, run the install generator:
 
 ```bash
 $ rails generate garden:install

data/Rakefile

@@ -9,21 +9,14 @@ require 'yard'
 YARD::Rake::YardocTask.new(:doc) do |t|
 end
 
-
-
-
-
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = FileList['test/**/*_test.rb'].exclude('test/tmp/**/*')
   t.verbose = false
 end
 
-
 task default: :test

data/lib/garden_variety.rb

@@ -1,2 +1,15 @@
+require "pundit"
 require "garden_variety/version"
+require "garden_variety/actions"
+require "garden_variety/controller"
+require "garden_variety/current_user_stub"
+
+begin
+  require "talent_scout"
+rescue LoadError
+  # do nothing
+else
+  require "garden_variety/talent_scout"
+end
+
 require "garden_variety/railtie"

data/lib/garden_variety/actions.rb

@@ -6,8 +6,8 @@ module GardenVariety
     # Garden variety controller +index+ action.
     # @return [void]
     def index
-      authorize(resource_class)
-      self.resources = policy_scope(list_resources)
+      authorize(self.class.model_class)
+      self.collection = policy_scope(find_collection)
     end
   end
 
@@ -15,8 +15,7 @@ module GardenVariety
     # Garden variety controller +show+ action.
     # @return [void]
     def show
-      self.resource = find_resource
-      authorize(resource)
+      self.model = authorize(find_model)
     end
   end
 
@@ -24,12 +23,8 @@ module GardenVariety
     # Garden variety controller +new+ action.
     # @return [void]
     def new
-      if params.key?(resource_class.model_name.param_key)
-        self.resource = vest(new_resource)
-      else
-        self.resource = new_resource
-        authorize(resource)
-      end
+      self.model = (model = authorize(new_model))
+      assign_attributes(model) if params.key?(self.class.model_name.param_key)
     end
   end
 
@@ -40,10 +35,10 @@ module GardenVariety
     #   @yield on-success callback, replaces default redirect
     # @return [void]
     def create
-      self.resource = vest(new_resource)
-      if resource.save
+      self.model = (model = assign_attributes(authorize(new_model)))
+      if model.save
         flash[:success] = flash_message(:success)
-        block_given? ? yield : redirect_to(resource)
+        block_given? ? yield : redirect_to(model)
         flash.discard(:success) if REDIRECT_CODES.exclude?(response.status)
       else
         flash.now[:error] = flash_message(:error)
@@ -56,8 +51,7 @@ module GardenVariety
     # Garden variety controller +edit+ action.
     # @return [void]
     def edit
-      self.resource = find_resource
-      authorize(resource)
+      self.model = authorize(find_model)
     end
   end
 
@@ -68,10 +62,10 @@ module GardenVariety
     #   @yield on-success callback, replaces default redirect
     # @return [void]
     def update
-      self.resource = vest(find_resource)
-      if resource.save
+      self.model = (model = assign_attributes(authorize(find_model)))
+      if model.save
         flash[:success] = flash_message(:success)
-        block_given? ? yield : redirect_to(resource)
+        block_given? ? yield : redirect_to(model)
         flash.discard(:success) if REDIRECT_CODES.exclude?(response.status)
       else
         flash.now[:error] = flash_message(:error)
@@ -87,9 +81,8 @@ module GardenVariety
     #   @yield on-success callback, replaces default redirect
     # @return [void]
     def destroy
-      self.resource = find_resource
-      authorize(resource)
-      if resource.destroy
+      self.model = (model = authorize(find_model))
+      if model.destroy
         flash[:success] = flash_message(:success)
         block_given? ? yield : redirect_to(action: :index)
         flash.discard(:success) if REDIRECT_CODES.exclude?(response.status)

data/lib/garden_variety/controller.rb

@@ -1,6 +1,3 @@
-require "pundit"
-require "garden_variety/actions"
-
 module GardenVariety
   module Controller
     extend ActiveSupport::Concern
@@ -13,15 +10,14 @@ module GardenVariety
       # typical REST actions (index, show, new, create, edit, update,
       # destroy) are included.
       #
-      # The optional +resources:+ parameter dictates which model class
-      # and instance variables these actions use.  The parameter's
-      # default value derives from the controller name.  The value must
-      # be a resource name in plural form.
-      #
-      # The macro also defines the following accessor methods for use in
-      # generic action and helper methods: +resources+, +resources=+,
-      # +resource+, and +resource=+.  These accessors get and set the
-      # instance variables dictated by the +resources:+ parameter.
+      # See also:
+      # - {GardenVariety::IndexAction}
+      # - {GardenVariety::ShowAction}
+      # - {GardenVariety::NewAction}
+      # - {GardenVariety::CreateAction}
+      # - {GardenVariety::EditAction}
+      # - {GardenVariety::UpdateAction}
+      # - {GardenVariety::DestroyAction}
       #
       # @example default usage
       #   # This...
@@ -38,92 +34,30 @@ module GardenVariety
       #     include GardenVariety::EditAction
       #     include GardenVariety::UpdateAction
       #     include GardenVariety::DestroyAction
-      #
-      #     private
-      #
-      #     def resource_class
-      #       Post
-      #     end
-      #
-      #     def resources
-      #       @posts
-      #     end
-      #
-      #     def resources=(models)
-      #       @posts = models
-      #     end
-      #
-      #     def resource
-      #       @post
-      #     end
-      #
-      #     def resource=(model)
-      #       @post = model
-      #     end
       #   end
       #
-      # @example custom usage
+      # @example specific usage
       #   # This...
-      #   class CountriesController < ApplicationController
-      #     garden_variety :index, resources: :locations
+      #   class PostsController < ApplicationController
+      #     garden_variety :index, :show
       #   end
       #
       #   # ...is equivalent to:
-      #   class CountriesController < ApplicationController
+      #   class PostsController < ApplicationController
       #     include GardenVariety::IndexAction
-      #
-      #     private
-      #
-      #     def resource_class
-      #       Location
-      #     end
-      #
-      #     def resources
-      #       @locations
-      #     end
-      #
-      #     def resources=(models)
-      #       @locations = models
-      #     end
-      #
-      #     def resource
-      #       @location
-      #     end
-      #
-      #     def resource=(model)
-      #       @location = model
-      #     end
+      #     include GardenVariety::ShowAction
       #   end
       #
       # @param actions [Array<:index, :show, :new, :create, :edit, :update, :destroy>]
-      # @param resources [Symbol, String]
       # @return [void]
-      def garden_variety(*actions, resources: controller_path)
-        resources_attr = resources.to_s.underscore.tr("/", "_")
-
-        class_eval <<-CODE
-          private
-
-          def resource_class # optimized override
-            #{resources.to_s.classify}
+      # @raise [ArgumentError]
+      #   if an invalid action is specified
+      def garden_variety(*actions)
+        actions.each do |action|
+          unless ::GardenVariety::ACTION_MODULES.key?(action)
+            raise ArgumentError, "Invalid action: #{action.inspect}"
           end
-
-          def resources
-            @#{resources_attr}
-          end
-
-          def resources=(models)
-            @#{resources_attr} = models
-          end
-
-          def resource
-            @#{resources_attr.singularize}
-          end
-
-          def resource=(model)
-            @#{resources_attr.singularize} = model
-          end
-        CODE
+        end
 
         action_modules = actions.empty? ?
           ::GardenVariety::ACTION_MODULES.values :
@@ -131,38 +65,136 @@ module GardenVariety
 
         action_modules.each{|m| include m }
       end
-    end
 
+      # Returns the controller model class.  Defaults to a class
+      # corresponding to the singular-form of the controller name.
+      #
+      # @example
+      #   class PostsController < ApplicationController
+      #   end
+      #
+      #   PostsController.model_class  # == Post (class)
+      #
+      # @return [Class]
+      def model_class
+        @model_class ||= controller_path.classify.constantize
+      end
+
+      # Sets the controller model class.
+      #
+      # @example
+      #   class PublishedPostsController < ApplicationController
+      #     self.model_class = Post
+      #   end
+      #
+      # @param klass [Class]
+      # @return [klass]
+      def model_class=(klass)
+        @model_name = nil
+        @model_class = klass
+      end
+
+      # @!visibility private
+      def model_name
+        @model_name ||= model_class.try(:model_name) || ActiveModel::Name.new(model_class)
+      end
+    end
 
     private
 
     # @!visibility public
-    # Returns the class of the resource corresponding to the controller
-    # name.
+    # Returns the value of the singular-form instance variable dictated
+    # by {::model_class}.
     #
     # @example
-    #   PostsController.new.resource_class  # == Post (class)
+    #   class PostsController
+    #     def show
+    #       # This...
+    #       self.model
+    #       # ...is equivalent to:
+    #       @post
+    #     end
+    #   end
+    #
+    # @return [Object]
+    def model
+      instance_variable_get(:"@#{self.class.model_name.singular}")
+    end
+
+    # @!visibility public
+    # Sets the value of the singular-form instance variable dictated
+    # by {::model_class}.
+    #
+    # @example
+    #   class PostsController
+    #     def show
+    #       # This...
+    #       self.model = value
+    #       # ...is equivalent to:
+    #       @post = value
+    #     end
+    #   end
+    #
+    # @param value [Object]
+    # @return [value]
+    def model=(value)
+      instance_variable_set(:"@#{self.class.model_name.singular}", value)
+    end
+
+    # @!visibility public
+    # Returns the value of the plural-form instance variable dictated
+    # by {::model_class}.
+    #
+    # @example
+    #   class PostsController
+    #     def index
+    #       # This...
+    #       self.collection
+    #       # ...is equivalent to:
+    #       @posts
+    #     end
+    #   end
+    #
+    # @return [Object]
+    def collection
+      instance_variable_get(:"@#{self.class.model_name.plural}")
+    end
+
+    # @!visibility public
+    # Sets the value of the plural-form instance variable dictated
+    # by {::model_class}.
     #
-    # @return [Class]
-    def resource_class
-      @resource_class ||= controller_path.classify.constantize
+    # @example
+    #   class PostsController
+    #     def index
+    #       # This...
+    #       self.collection = values
+    #       # ...is equivalent to:
+    #       @posts = values
+    #     end
+    #   end
+    #
+    # @param values [Object]
+    # @return [values]
+    def collection=(values)
+      instance_variable_set(:"@#{self.class.model_name.plural}", values)
     end
 
     # @!visibility public
-    # Returns an ActiveRecord::Relation representing resource instances
+    # Returns an ActiveRecord::Relation representing model instances
     # corresponding to the controller.  Designed for use in generic
     # +index+ action methods.
     #
     # @example
     #   class PostsController < ApplicationController
     #     def index
-    #        @posts = list_resources.where(status: "published")
+    #        @posts = find_collection.where(status: "published")
     #     end
     #   end
     #
     # @return [ActiveRecord::Relation]
-    def list_resources
-      resource_class.all
+    def find_collection
+      self.class.model_class.all
     end
 
     # @!visibility public
@@ -174,13 +206,13 @@ module GardenVariety
     # @example
     #   class PostsController < ApplicationController
     #     def show
-    #        @post = find_resource
+    #        @post = find_model
     #     end
     #   end
     #
     # @return [ActiveRecord::Base]
-    def find_resource
-      resource_class.find(params[:id])
+    def find_model
+      self.class.model_class.find(params[:id])
     end
 
     # @!visibility public
@@ -190,25 +222,24 @@ module GardenVariety
     # @example
     #   class PostsController < ApplicationController
     #     def new
-    #        @post = new_resource
+    #        @post = new_model
     #     end
     #   end
     #
     # @return [ActiveRecord::Base]
-    def new_resource
-      resource_class.new
+    def new_model
+      self.class.model_class.new
     end
 
     # @!visibility public
-    # Authorizes the given model for the current action via the model
-    # Pundit policy, and populates the model attributes with the current
-    # request params permitted by the model policy.  Returns the given
+    # Populates the given model's attributes with the current request
+    # params permitted by the model's Pundit policy.  Returns the given
     # model modified but not persisted.
     #
     # @example
     #   class PostsController < ApplicationController
     #     def create
-    #       @post = vest(Post.new)
+    #       @post = assign_attributes(authorize(Post.new))
     #       if @post.save
     #         redirect_to @post
     #       else
@@ -219,16 +250,15 @@ module GardenVariety
     #
     # @param model [ActiveRecord::Base]
     # @return [ActiveRecord::Base]
-    def vest(model)
-      authorize(model)
+    def assign_attributes(model)
       model.assign_attributes(permitted_attributes(model))
       model
     end
 
     # @!visibility public
     # Returns Hash of values for interpolation in flash messages via
-    # I18n.  By default, returns +resource_name+ and
-    # +resource_capitalized+ values appropriate to the controller.
+    # I18n.  By default, returns a +model_name+ key / value pair based
+    # on the controller's {Controller::ClassMethods#model_name}.
     # Override this method to provide your own values.  Be aware that
     # certain option names, such as +default+ and +scope+, are reserved
     # by the I18n gem, and can not be used for interpolation.  See the
@@ -237,8 +267,7 @@ module GardenVariety
     #
     # @return [Hash]
     def flash_options
-      { resource_name: resource_class.model_name.human.downcase,
-        resource_capitalized: resource_class.model_name.human }
+      { model_name: self.class.model_name.human }
     end
 
     # @!visibility public
@@ -265,12 +294,16 @@ module GardenVariety
     #   # en:
     #   #   success: "Success!"
     #   #   create:
-    #   #     success: "%{resource_capitalized} created."
+    #   #     success: "%{model_name} created."
     #   #   delete:
-    #   #     success: "%{resource_capitalized} deleted."
+    #   #     success: "%{model_name} deleted."
     #   #   posts:
     #   #     create:
     #   #       success: "Congratulations on your new post!"
+    #   #   messages:
+    #   #     drafts:
+    #   #       update:
+    #   #         success: "Draft saved."
     #
     #   # via PostsController#create
     #   flash_message(:success)  # == "Congratulations on your new post!"
@@ -281,21 +314,6 @@ module GardenVariety
     #   # via PostsController#delete
     #   flash_message(:success)  # == "Post deleted."
     #
-    # @example Namespaced controller
-    #   ### config/locales/garden_variety.en.yml
-    #   # en:
-    #   #   create:
-    #   #     success: "Created new %{resource_name}."
-    #   #   update:
-    #   #     success: "Updated %{resource_name}."
-    #   #   messages:
-    #   #     drafts:
-    #   #       update:
-    #   #         success: "Draft saved."
-    #
-    #   # via Messages::DraftsController#create
-    #   flash_message(:success)  # == "Created new draft."
-    #
     #   # via Messages::DraftsController#update
     #   flash_message(:success)  # == "Draft saved."
     #
@@ -304,14 +322,14 @@ module GardenVariety
     def flash_message(status)
       controller_key = controller_path.tr("/", I18n.default_separator)
       keys = [
-        :"#{controller_key}.#{action_name}.#{status}",
-        :"#{controller_key}.#{action_name}.#{status}_html",
-        :"#{action_name}.#{status}",
-        :"#{action_name}.#{status}_html",
-        :"#{status}",
-        :"#{status}_html",
+        :"flash.#{controller_key}.#{action_name}.#{status}",
+        :"flash.#{controller_key}.#{action_name}.#{status}_html",
+        :"flash.#{action_name}.#{status}",
+        :"flash.#{action_name}.#{status}_html",
+        :"flash.#{status}",
+        :"flash.#{status}_html",
       ]
-      helpers.translate(keys.shift, default: keys, **flash_options)
+      helpers.translate(keys.shift, { default: keys }.merge!(flash_options))
     end
   end
 end

data/lib/garden_variety/railtie.rb

@@ -1,10 +1,6 @@
-require "rails/railtie"
-require "garden_variety/controller"
-require "garden_variety/current_user_stub"
-
 module GardenVariety
   # @!visibility private
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
     # Render 404 on Pundit::NotAuthorizedError in production.  (Helpful
     # error pages will still be shown in development.)  Code 404 is used
     # because it is more discreet than 403, because it is explicitly
@@ -12,17 +8,10 @@ module GardenVariety
     # and because Rails includes a default 404 page, but not a 403 page.
     config.action_dispatch.rescue_responses["Pundit::NotAuthorizedError"] ||= :not_found
 
-    initializer "garden_variety.stub_current_user" do |app|
-      ActiveSupport.on_load :action_controller do
-        unless ActionController::Base.instance_methods.include?(:current_user)
-          ActionController::Base.send :include, GardenVariety::CurrentUserStub
-        end
-      end
-    end
-
-    initializer "garden_variety.extend_action_controller" do |app|
+    initializer "garden_variety" do |app|
       ActiveSupport.on_load :action_controller do
-        ActionController::Base.send :include, GardenVariety::Controller
+        include GardenVariety::CurrentUserStub unless instance_methods.include?(:current_user)
+        include GardenVariety::Controller
       end
     end
   end

data/lib/garden_variety/talent_scout.rb

@@ -0,0 +1,28 @@
+module GardenVariety
+  # @!visibility private
+  module TalentScout
+
+    module ModelSearchClassOverride
+      def model_search_class
+        @model_search_class ||= "#{model_class}Search".constantize
+      end
+    end
+
+    ::TalentScout::Controller::ClassMethods.prepend(ModelSearchClassOverride)
+
+    module FindCollectionOverride
+      private
+      def find_collection
+        if self.class.model_search_class?
+          @search = model_search
+          @search.results.all
+        else
+          super
+        end
+      end
+    end
+
+    ::GardenVariety::Controller.prepend(FindCollectionOverride)
+
+  end
+end

data/lib/garden_variety/version.rb

@@ -1,3 +1,3 @@
 module GardenVariety
-  VERSION = "2.0"
+  VERSION = "3.0.0"
 end

data/lib/generators/garden/install/install_generator.rb

@@ -1,5 +1,3 @@
-require "rails/generators/base"
-
 # @!visibility private
 module Garden
   module Generators

data/lib/generators/garden/install/templates/locales/flash.en.yml

@@ -0,0 +1,11 @@
+en:
+  flash:
+    create:
+      success: '%{model_name} was successfully created.'
+      error: '%{model_name} could not be created.'
+    update:
+      success: '%{model_name} was successfully updated.'
+      error: '%{model_name} could not be updated.'
+    destroy:
+      success: '%{model_name} was successfully destroyed.'
+      error: '%{model_name} could not be destroyed.'

data/lib/generators/garden/scaffold/scaffold_generator.rb

@@ -1,5 +1,3 @@
-require "rails/generators/base"
-
 # @!visibility private
 module Garden
   module Generators
@@ -13,6 +11,9 @@ module Garden
       # inherited from Rails::Generators::Base
       class_option :template_engine
 
+      class_option :talent_scout, type: :boolean, default: true,
+        description: "Invoke talent_scout:search generator"
+
       # override +initialize+ because it is the only way to reliably
       # capture the raw input arguments in order to pass them on to
       # `rails generate resource` (Thor neglects to provide an accessor,
@@ -40,6 +41,12 @@ module Garden
       def generate_pundit_policy
         generate("pundit:policy", resource)
       end
+
+      def generate_talent_scout_search
+        if defined?(::TalentScout) && options.talent_scout?
+          generate("talent_scout:search", resource)
+        end
+      end
     end
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: garden_variety
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: 3.0.0
 platform: ruby
 authors:
 - Jonathan Hefner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2019-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: talent_scout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jonathan.hefner@gmail.com
@@ -81,9 +95,10 @@ files:
 - lib/garden_variety/controller.rb
 - lib/garden_variety/current_user_stub.rb
 - lib/garden_variety/railtie.rb
+- lib/garden_variety/talent_scout.rb
 - lib/garden_variety/version.rb
 - lib/generators/garden/install/install_generator.rb
-- lib/generators/garden/install/templates/locales/garden_variety.en.yml
+- lib/generators/garden/install/templates/locales/flash.en.yml
 - lib/generators/garden/scaffold/scaffold_generator.rb
 homepage: https://github.com/jonathanhefner/garden_variety
 licenses:
@@ -104,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Delightfully boring Rails controllers

data/lib/generators/garden/install/templates/locales/garden_variety.en.yml

@@ -1,10 +0,0 @@
-en:
-  create:
-    success: '%{resource_capitalized} was successfully created.'
-    error: 'Could not create %{resource_name}.'
-  update:
-    success: '%{resource_capitalized} was successfully updated.'
-    error: 'Could not update %{resource_name}.'
-  destroy:
-    success: '%{resource_capitalized} was successfully destroyed.'
-    error: 'Could not destroy %{resource_name}.'