irie 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70d0c4b896c361b3118094166c14bae9a734a530
-  data.tar.gz: ea3ff0813dabc51ba793191d92797f8c9f2b6704
+  metadata.gz: 83d55681746b7b5b2d5ecc207a41000e69bf299c
+  data.tar.gz: 3bba10948d23a3c1676b0c4513cbcb6e37e01314
 SHA512:
-  metadata.gz: 9733f3a4277253428161f1c4b735832fbd5f53bf958b48236a90ec2a5249d143fe476d15814536126d3a690e47ef9fc5c53e6271af89dca314069837072acb62
-  data.tar.gz: c4b1a88c2571906e7378ee09a76409f2669dcd41e5402da6b55927881dfd33a9baf4e9bb248e6cbedd9dea7de921e05cceac16a6e0f56b17e8ac0ce9e4cdf7ba
+  metadata.gz: 9d25b2cf8efe484b2e074bcf8832b3cfb508b24bf3d3106ffba5bba1a0dbe88695e02a92a142962ce3cb056ca63c134a3e5c6af915efa1edd14e86f7e6da2f2f
+  data.tar.gz: c5e2b0844fb810cbbf51beb00d68ebaca098f6612a96bd20054731674c9c9f5a0ef97206e41a8fc493724a34c06adc7ba667671b168d921262be5b01dcb93e11

data/README.md

@@ -4,7 +4,7 @@
 
 Inherited Resources including extensions. Tested with Rails 4/edge, Inherited Resources 1.4/edge in Ruby 1.9.3, 2.0.0, and jruby-19mode.
 
-Extend [Inherited Resources][inherited_resources] actions with the `extensions` method which provides symbolic references to do module includes as well as automatic inclusion of modules based on what actions are in-use. The included extensions provide more of a DSL-like way to define your controllers, and instead of model-heavy development via `scope` in models and `has_scope` in the controller, you can just define request parameter-based filters and their defaults in the controller. Also, ordering, parameter conversion, param value split delimiters, pagination, and more are supported.
+Extend [Inherited Resources][inherited_resources] actions with the `extensions` method which provides symbolic references to do module includes as well as automatic inclusion of modules based on what `actions` are defined. The included extensions provide more of a DSL-like way to define your controllers. And, instead of model-heavy development via `scope` in models and `has_scope` in the controller, you can just define request parameter-based filters and their defaults in the controller. Ordering, parameter value conversion, pagination, and more are supported without additional dependencies.
 
 ```ruby
 class PostsController < ApplicationController
@@ -246,45 +246,7 @@ The return value of the lambda becomes the new query, so you could really change
 
 ##### Customizing Request Parameter Value Conversion
 
-Implement the `convert_param(param_name, param_values)` in your controller or an included module, e.g.
-
-```ruby
-# example of custom parameter value converter
-module Example
-  module BooleanParams
-    extend ::ActiveSupport::Concern
-
-    TRUE_VALUE = 'true'.freeze
-    FALSE_VALUE = 'false'.freeze
-
-    protected
-
-    # Converts request param value(s) 'true' to true and 'false' to false
-    def convert_param(param_name, param_value_or_values)
-      logger.debug("Example::BooleanParams.convert_param(#{param_name.inspect}, #{param_value_or_values.inspect})") if ::Irie.debug?
-      param_value_or_values = super if defined?(super)
-      if param_value_or_values.is_a? Array
-        param_value_or_values.map {|v| convert_boolean(v)}
-      else
-        convert_boolean(param_value_or_values)
-      end
-    end
-
-    private
-
-    def convert_boolean(value)
-      case value
-      when TRUE_VALUE
-        true
-      when FALSE_VALUE
-        false
-      else
-        value
-      end
-    end
-  end
-end
-```
+Implement the `convert_param(param_name, param_values)` in your controller or an included module. See [Writing Your Own Extensions](#writing-your-own-extensions) for an example.
 
 #### Default Filters
 
@@ -488,79 +450,78 @@ The following concerns, which you can include via `extensions ...` or via includ
 
 Extensions are just modules. There is no magic.
 
-The somewhat special thing about Irie extensions if that you can `@action_result = ...; throw(:action_break)` in any method that is called by an Irie action and it will break the execution of the action and return `@action_result`. This allows the ease of control that you'd have typically in a single long action method, but lets you use modules to easily share action method functionality. To those unfamiliar, `throw` in Ruby is a normal flow control mechanism, unlike `raise` which is for exceptions.
+Some hopefully good examples of how to extend modules are in this project in `lib/irie/extensions/`.
 
-Some hopefully good examples of how to extend modules are in lib/irie/extensions/* and the actions themselves are in lib/irie/actions/*. Get familiar with the code even if you don't plan on customizing, if for no other reason than to have another set of eyes on the code.
-
-Here's another example:
+Here's a quick example:
 
 ```ruby
-# Converts all 'true' and 'false' param values to true and false
-module BooleanParams
-  extend ::ActiveSupport::Concern
-
-  protected
-
-  def convert_param(param_name, param_values)
-    case param_values
-    when 'true'
-      true
-    when 'false'
-      false
-    else
-      super if defined?(super)
-    end
-  end
-
-end
-```
-
-If you are just doing regular `include`'s in your controllers, that's all you need. If you'd like to use `extensions`, you get autoincludes and can use symbols, e.g. in `app/controllers/concerns/service_controller.rb`:
+module Example
+  module BooleanParams
+    extend ::ActiveSupport::Concern
 
-```ruby
-module ServiceController
-  extend ::ActiveSupport::Concern
+    TRUE_VALUE = 'true'.freeze
+    FALSE_VALUE = 'false'.freeze
 
-  included do
-    inherit_resources
-    respond_to :json
+    protected
 
-    # reference as string so we don't load the concern before it is used.
-    ::Irie.register_extension :boolean_params, '::Example::BooleanParams'
+    # Converts request param value(s) 'true' to true and 'false' to false
+    def convert_param(param_name, param_value_or_values)
+      logger.debug("Example::BooleanParams.convert_param(#{param_name.inspect}, #{param_value_or_values.inspect})") if ::Irie.debug?
+      param_value_or_values = super if defined?(super)
+      if param_value_or_values.is_a? Array
+        param_value_or_values.map {|v| convert_boolean(v)}
+      else
+        convert_boolean(param_value_or_values)
+      end
+    end
 
-    # register_extension also can define the order of inclusion, e.g.:
-    #   ::Irie.register_extension :boolean_params, '::Example::BooleanParams', include: :last #default
-    #   ::Irie.register_extension :boolean_params, '::Example::BooleanParams', include: :first
-    #   ::Irie.register_extension :boolean_params, '::Example::BooleanParams', after: :nil_params
-    #   ::Irie.register_extension :boolean_params, '::Example::BooleanParams', before: :nil_params
+    private
 
+    def convert_boolean(value)
+      case value
+      when TRUE_VALUE
+        true
+      when FALSE_VALUE
+        false
+      else
+        value
+      end
+    end
   end
-
 end
 ```
 
-Now you could use this in your controller:
+If you are just doing regular `include`'s in your controllers, that's all you need, and you can include when you need to.
 
-```ruby
-include ServiceController
+If you'd like to use your modules via the `extensions` method, just register the extension in an initializer, e.g. in `config/initializers/irie.rb`:
 
-actions :index
-extensions :boolean_params
+```ruby
+# note: Referencing as string so we don't load the concern before it is used.
+::Irie.register_extension :boolean_params, '::Example::BooleanParams'
 ```
 
-Doing that doesn't make as much sense when you just have modules in the root namespace, but it might if you have longer namespaces for organization and to avoid class/module name conflicts.
+Now, you could do this in your controller:
 
-#### Primary Keys
+```ruby
+  respond_to :json
+  inherit_resources
 
-Supports composite primary keys. If `resource_class.primary_key.is_a?(Array)`, show/edit/update/destroy will use your two or more request params for the ids that make up the composite.
+  actions :index
+  extensions :boolean_params
+```
 
-#### Exception Handling
+Irie includes a way to specify order of module inclusion independent of the class/module it is included in, and you can specify that at registration, e.g. in an initializer like `config/initializers/irie.rb`, you might do one of the following:
 
-Rails 4 has basic exception handling in the [public_exceptions][public_exceptions] and [show_exceptions][show_exceptions] Rack middleware.
+```ruby
+::Irie.register_extension :boolean_params, '::Example::BooleanParams', include: :last # last is the default, so don't need to specify this option
+::Irie.register_extension :boolean_params, '::Example::BooleanParams', include: :first
+::Irie.register_extension :boolean_params, '::Example::BooleanParams', after: :nil_params
+::Irie.register_extension :boolean_params, '::Example::BooleanParams', before: :nil_params
+```
 
-If you want to customize Rails 4's Rack exception handling, search the web for customizing `config.exceptions_app`, although the default behavior should work for most.
+Note: an extension must be registered before you can use `after:` or `before:` to place your extension include after or before it. Use `require` and declare dependencies if possible to ensure registration of other extensions, and nothing is stopping you from registering something else. The extension class constant isn't going to be referenced by Irie until `extensions` is called with it.
 
-You can also use `rescue_from` or `around_action` in Rails to have more control over error rendering.
+The `extensions` method is just a companion to `actions` if you want to use it. You can still use [include/extend/prepend](http://ruby-doc.org/core-2.0.0/Module.html), if you'd rather.
 
 ### Troubleshooting
 

data/lib/irie/extensions/query_includes.rb

@@ -73,6 +73,11 @@ module Irie
       end
 
       def resource
+        cached = get_resource_ivar
+        if cached
+          logger.debug("Irie::Extensions::QueryIncludes.resource returning cached resource") if ::Irie.debug?
+          return cached
+        end
         logger.debug("Irie::Extensions::QueryIncludes.resource") if ::Irie.debug?
         this_includes = self.action_to_query_includes[params[:action].to_sym] || self.all_action_query_includes
         if this_includes && this_includes.size > 0
@@ -88,6 +93,11 @@ module Irie
       end
 
       def build_resource
+        cached = get_resource_ivar
+        if cached
+          logger.debug("Irie::Extensions::QueryIncludes.resource returning cached resource") if ::Irie.debug?
+          return cached
+        end
         logger.debug("Irie::Extensions::QueryIncludes.build_resource") if ::Irie.debug?
         this_includes = self.action_to_query_includes[params[:action].to_sym] || self.all_action_query_includes
         if this_includes && this_includes.size > 0

data/lib/irie/version.rb

@@ -1,3 +1,3 @@
 module Irie
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gary S. Weaver
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inherited_resources