garden_variety 2.0 → 4.0.0

data/lib/garden_variety/controller.rb

@@ -1,11 +1,8 @@
-require "pundit"
-require "garden_variety/actions"
-
 module GardenVariety
   module Controller
     extend ActiveSupport::Concern
 
-    include Pundit
+    include Pundit::Authorization
 
     module ClassMethods
       # Macro to include garden variety implementations of specified
@@ -13,17 +10,15 @@ 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 GardenVariety::IndexAction
+      # @see GardenVariety::ShowAction
+      # @see GardenVariety::NewAction
+      # @see GardenVariety::CreateAction
+      # @see GardenVariety::EditAction
+      # @see GardenVariety::UpdateAction
+      # @see GardenVariety::DestroyAction
       #
-      # @example default usage
+      # @example Default actions
       #   # This...
       #   class PostsController < ApplicationController
       #     garden_variety
@@ -38,92 +33,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 actions
       #   # 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,84 +64,183 @@ 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 {ClassMethods#model_class ::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 {ClassMethods#model_class ::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 {ClassMethods#model_class ::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 {ClassMethods#model_class ::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
-    # corresponding to the controller.  Designed for use in generic
-    # +index+ action methods.
+    # Returns an ActiveRecord::Relation representing instances of
+    # {ClassMethods#model_class ::model_class}.  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
-    # Returns a model instance corresponding to the controller and the
-    # id parameter of the current request (i.e. +params[:id]+).
-    # Designed for use in generic +show+, +edit+, +update+, and
-    # +destroy+ action methods.
+    # Returns an instance of {ClassMethods#model_class ::model_class}
+    # matching the +:id+ parameter of the current request (i.e.
+    # +params[:id]+).  Designed for use in generic +show+, +edit+,
+    # +update+, and +destroy+ action methods.
     #
     # @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])
+    # @raise [ActiveRecord::RecordNotFound]
+    #   if a model instance with matching +:id+ cannot be found
+    def find_model
+      self.class.model_class.find(params[:id])
     end
 
     # @!visibility public
-    # Returns a new model instance corresponding to the controller.
+    # Returns a new instance of {ClassMethods#model_class ::model_class}.
     # Designed for use in generic +new+ and +create+ action methods.
     #
     # @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
-    # model modified but not persisted.
+    # Populates the given +model+'s attributes with the current request
+    # params permitted by the corresponding 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,31 +251,29 @@ 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.
+    # Returns a Hash of values for interpolation in flash messages via
+    # I18n.  By default, returns a +:model_name+ key / value pair with
+    # the humanized name of {ClassMethods#model_class ::model_class}.
     # 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
-    # {https://www.rubydoc.info/gems/i18n I18n documentation} for more
-    # information.
+    # certain option names, such as +:default+ and +:scope+, are
+    # reserved by the I18n gem, and can not be used for interpolation.
+    # See the {https://www.rubydoc.info/gems/i18n I18n documentation}
+    # for more information.
     #
-    # @return [Hash]
+    # @return [Hash{Symbol => #to_s}]
     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
     # Returns a flash message appropriate to the controller, the current
-    # action, and a given status.  The flash message is looked up via
+    # action, and a given +status+.  The flash message is looked up via
     # I18n using a prioritized list of possible keys.  The key priority
     # is as follows:
     #
@@ -265,12 +295,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 +315,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,12 +323,12 @@ 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)
     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 = "4.0.0"
 end

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/generators/garden/install/install_generator.rb

@@ -1,9 +1,11 @@
-require "rails/generators/base"
+require "generators/garden/optimized_generate_action"
 
 # @!visibility private
 module Garden
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      include OptimizedGenerateAction
+
       source_root File.join(__dir__, "templates")
 
       def copy_locales

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/optimized_generate_action.rb

@@ -0,0 +1,14 @@
+# @!visibility private
+module Garden
+  module OptimizedGenerateAction
+    def generate(what, *args)
+      log :generate, what
+
+      in_root do
+        silence_warnings do
+          ::Rails::Command.invoke("generate", [what, *args])
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,11 @@
-require "rails/generators/base"
+require "generators/garden/optimized_generate_action"
 
 # @!visibility private
 module Garden
   module Generators
     class ScaffoldGenerator < Rails::Generators::Base
+      include OptimizedGenerateAction
+
       source_root File.join(__dir__, "templates")
 
       argument :resource, type: :string
@@ -13,6 +15,9 @@ module Garden
       # inherited from Rails::Generators::Base
       class_option :template_engine
 
+      class_option :talent_scout, type: :boolean, default: true,
+        desc: "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 +45,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