garden_variety 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505860db6877118744ce3b7f1b4de589c12e0adf8687ab8cadc518fec0a52b37
-  data.tar.gz: a4b18a197a210123c5db5f72c1510e1a4ea75e843c543af98635a842bc04cea3
+  metadata.gz: dd6dd125edefcf640a8a2aa1b629510eb3e5526551abfea71738b661c9fe1d83
+  data.tar.gz: ec5a4e29f8e1937dd74a88d11fdf087394a95cf67c56ceca177e9ce5fb9ae89e
 SHA512:
-  metadata.gz: 1703aa1c557798193c1292c7b6999d18f5962d9bf2ebafc83f13c091342376d3a592f6673c519af285e2baa6228222ad9335ded99687748525c551099b5fe965
-  data.tar.gz: c005e563d798f172a9437423b6921713642442e44061ab350ae8aadbb062486325af39380dcc6f17cbe67e41f7ee24c234282852a1f469d8d30df9467de98a94
+  metadata.gz: bd41cf0735bfabe753a7bb4b5138d76a5e9c572952d5d4fb344f344dfe44926258c1a64ffe67b66875fcae5b09d9640fb8dfb8ce742a812bcbb0cfcad80b0d21
+  data.tar.gz: ba7d049d2952075c9a431dbd76b9ced59abc89918dfdbe589a7e8e183654a769669e6396e6e4546984bddf2057e7164a7f921ee849dacdee59c1f2d1ead39177

data/README.md

@@ -2,7 +2,7 @@
 
 Delightfully boring Rails controllers.  One of the superb advantages of
 Ruby on Rails is convention over configuration.  Opinionated default
-behavior can decrease development time, and increase application
+behavior can decrease development time and increase application
 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.
@@ -139,20 +139,23 @@ end
 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.)
+method definitions 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](
+https://www.rubydoc.info/gems/garden_variety/).  (Note that the
+`authorize`, `policy_scope`, and `permitted_attributes` methods are
+provided by Pundit.)
 
 
 ## Scaffold generator
 
-*garden_variety* includes a scaffold generator similar to the Rails
-scaffold generator:
+*garden_variety* includes a `garden:scaffold` generator similar to the
+Rails `scaffold` generator:
 
 ```
 $ rails generate garden:scaffold post title:string body:text published:boolean
+       exist  config/locales
+      create  config/locales/flash.en.yml
     generate  resource
       invoke  active_record
       create    db/migrate/19991231235959_create_posts.rb
@@ -169,11 +172,6 @@ $ rails generate garden:scaffold post title:string body:text published:boolean
       invoke    helper
       create      app/helpers/posts_helper.rb
       invoke      test_unit
-      invoke    assets
-      invoke      coffee
-      create        app/assets/javascripts/posts.coffee
-      invoke      scss
-      create        app/assets/stylesheets/posts.scss
       invoke  resource_route
        route    resources :posts
     generate  erb:scaffold
@@ -183,6 +181,7 @@ $ rails generate garden:scaffold post title:string body:text published:boolean
       create  app/views/posts/show.html.erb
       create  app/views/posts/new.html.erb
       create  app/views/posts/_form.html.erb
+      create  app/views/posts/_post.html.erb
       insert  app/controllers/posts_controller.rb
     generate  pundit:policy
       create  app/policies/post_policy.rb
@@ -201,10 +200,10 @@ generator in a few small ways:
 
 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.
+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
 
@@ -212,10 +211,10 @@ below.
 ## Flash messages
 
 Flash messages are defined using I18n.  The *garden_variety* installer
-(`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.
+(`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
@@ -231,8 +230,8 @@ Interpolation in flash messages is also supported (as described by
 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
+[Safe HTML Translations]: https://guides.rubyonrails.org/i18n.html#using-safe-html-translations
+[Passing Variables to Translations]: https://guides.rubyonrails.org/i18n.html#passing-variables-to-translations
 
 
 ## Beyond garden variety behavior
@@ -261,7 +260,7 @@ end
 
 ### Pagination
 
-You can integrate your your favorite pagination gem (*may I suggest
+You can integrate your favorite pagination gem (*may I suggest
 [moar](https://rubygems.org/gems/moar)?*) by overriding the
 `find_collection` method:
 
@@ -295,7 +294,7 @@ end
 
 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
+-- no custom code required.  For example, if a `PostSearch` class is
 defined, `PostsController#find_collection` will be equivalent to:
 
 ```ruby
@@ -305,9 +304,11 @@ def find_collection
 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:
+Notice, as a side effect, the `@search` instance 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
@@ -457,10 +458,10 @@ end
 In this example, only the `new` and `create` actions are generated by
 the `garden_variety` macro.  The on-success behavior of `create` is
 overridden to redirect to `root_path`, using the concise syntax
-discussed in the [Integrating with SJR](#integrating-with-sjr) example.
-The *garden_variety* controller helper methods all work as expected
-because `RegistrationForm` responds to `assign_attributes` and `save`,
-and has a default (nullary) constructor.
+discussed in the [Server-generated JavaScript Responses (SJR)](#server-generated-javascript-responses-sjr)
+example.  The *garden_variety* controller helper methods all work as
+expected because `RegistrationForm` responds to `assign_attributes` and
+`save`, and has a default (nullary) constructor.
 
 
 ### Non-REST actions
@@ -510,19 +511,13 @@ from RailsConf which delves deeper into the principle:
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem "garden_variety"
-```
-
-Then execute:
+Add the gem to your Gemfile:
 
 ```bash
-$ bundle install
+$ bundle add garden_variety
 ```
 
-And finally, run the install generator:
+And run the install generator:
 
 ```bash
 $ rails generate garden:install
@@ -533,9 +528,9 @@ This will also run the Pundit install generator, if necessary.
 
 ## Contributing
 
-Run `rake test` to run the tests.
+Run `bin/test` to run the tests.
 
 
 ## License
 
-[MIT License](https://opensource.org/licenses/MIT)
+[MIT License](MIT-LICENSE)

data/Rakefile

@@ -1,22 +1,3 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'yard'
-
-YARD::Rake::YardocTask.new(:doc) do |t|
-end
+require 'bundler/setup'
 
 require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb'].exclude('test/tmp/**/*')
-  t.verbose = false
-end
-
-task default: :test

data/lib/garden_variety/actions.rb

@@ -1,6 +1,6 @@
 module GardenVariety
 
-  REDIRECT_CODES = [301, 302, 303, 307, 308]
+  REDIRECT_CODES = [301, 302, 303, 307, 308].to_set
 
   module IndexAction
     # Garden variety controller +index+ action.
@@ -94,8 +94,8 @@ module GardenVariety
   end
 
   # Map of controller action name to action module.  Used by the
-  # {GardenVariety::Controller::ClassMethods#garden_variety} macro to
-  # include desired controller actions.
+  # {GardenVariety::Controller::ClassMethods#garden_variety
+  # garden_variety} macro to include desired controller actions.
   ACTION_MODULES = {
     index: IndexAction,
     show: ShowAction,

data/lib/garden_variety/controller.rb

@@ -2,7 +2,7 @@ module GardenVariety
   module Controller
     extend ActiveSupport::Concern
 
-    include Pundit
+    include Pundit::Authorization
 
     module ClassMethods
       # Macro to include garden variety implementations of specified
@@ -10,16 +10,15 @@ module GardenVariety
       # typical REST actions (index, show, new, create, edit, update,
       # destroy) are included.
       #
-      # See also:
-      # - {GardenVariety::IndexAction}
-      # - {GardenVariety::ShowAction}
-      # - {GardenVariety::NewAction}
-      # - {GardenVariety::CreateAction}
-      # - {GardenVariety::EditAction}
-      # - {GardenVariety::UpdateAction}
-      # - {GardenVariety::DestroyAction}
+      # @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
@@ -36,7 +35,7 @@ module GardenVariety
       #     include GardenVariety::DestroyAction
       #   end
       #
-      # @example specific usage
+      # @example Specific actions
       #   # This...
       #   class PostsController < ApplicationController
       #     garden_variety :index, :show
@@ -104,7 +103,7 @@ module GardenVariety
 
     # @!visibility public
     # Returns the value of the singular-form instance variable dictated
-    # by {::model_class}.
+    # by {ClassMethods#model_class ::model_class}.
     #
     # @example
     #   class PostsController
@@ -123,7 +122,7 @@ module GardenVariety
 
     # @!visibility public
     # Sets the value of the singular-form instance variable dictated
-    # by {::model_class}.
+    # by {ClassMethods#model_class ::model_class}.
     #
     # @example
     #   class PostsController
@@ -143,7 +142,7 @@ module GardenVariety
 
     # @!visibility public
     # Returns the value of the plural-form instance variable dictated
-    # by {::model_class}.
+    # by {ClassMethods#model_class ::model_class}.
     #
     # @example
     #   class PostsController
@@ -162,7 +161,7 @@ module GardenVariety
 
     # @!visibility public
     # Sets the value of the plural-form instance variable dictated
-    # by {::model_class}.
+    # by {ClassMethods#model_class ::model_class}.
     #
     # @example
     #   class PostsController
@@ -181,9 +180,9 @@ module GardenVariety
     end
 
     # @!visibility public
-    # Returns an ActiveRecord::Relation representing model 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
@@ -198,10 +197,10 @@ module GardenVariety
     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
@@ -211,12 +210,14 @@ module GardenVariety
     #   end
     #
     # @return [ActiveRecord::Base]
+    # @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
@@ -232,9 +233,9 @@ module GardenVariety
     end
 
     # @!visibility public
-    # 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.
+    # 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
@@ -256,23 +257,23 @@ module GardenVariety
     end
 
     # @!visibility public
-    # Returns Hash of values for interpolation in flash messages via
-    # I18n.  By default, returns a +model_name+ key / value pair based
-    # on the controller's {Controller::ClassMethods#model_name}.
+    # 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
       { 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:
     #
@@ -329,7 +330,7 @@ module GardenVariety
         :"flash.#{status}",
         :"flash.#{status}_html",
       ]
-      helpers.translate(keys.shift, { default: keys }.merge!(flash_options))
+      helpers.translate(keys.shift, default: keys, **flash_options)
     end
   end
 end

data/lib/garden_variety/version.rb

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

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

@@ -1,7 +1,11 @@
+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/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,7 +1,11 @@
+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
@@ -12,7 +16,7 @@ module Garden
       class_option :template_engine
 
       class_option :talent_scout, type: :boolean, default: true,
-        description: "Invoke talent_scout:search generator"
+        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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: garden_variety
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jonathan Hefner
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -38,51 +37,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -99,12 +55,14 @@ files:
 - lib/garden_variety/version.rb
 - lib/generators/garden/install/install_generator.rb
 - lib/generators/garden/install/templates/locales/flash.en.yml
+- lib/generators/garden/optimized_generate_action.rb
 - lib/generators/garden/scaffold/scaffold_generator.rb
 homepage: https://github.com/jonathanhefner/garden_variety
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/jonathanhefner/garden_variety
+  changelog_uri: https://github.com/jonathanhefner/garden_variety/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -112,15 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Delightfully boring Rails controllers
 test_files: []