condi 0.0.5 → 0.0.6

data/README.md

@@ -2,7 +2,7 @@
 Condi
 =====
 
-Condi is a gem that you use with Rails to make it easier to cleanly implement conditional elements in a view.
+Condi is a gem that you use with Rails to make it easier to cleanly implement conditional elements in a view and offers a clean and simple approach to separate business logic from your views and models.
 
 Condi allows you to define boolean-valued *predicates* in the controller that are callable in the view without relying on unneeded instance variables or business logic in the views.  Because the predicates are defined dynamically during a controller action, they are easy to find and easy to use without hopping around multiple files.
 
@@ -48,7 +48,7 @@ For example, say you have a User who has various roles and a shopping Cart that
 Predicates with Arguments
 -------------------------
 
-Say you would like to monitor your cart status and highlight items that are shipped but haven't arrived yet.  You would like to hand the collection of items off to a partial, but how can you use
+Say you would like to monitor your cart status and highlight items that are shipped but haven't arrived yet if there are three or more items in the cart.  You would like to hand the collection of items off to a partial, but how can you use
 a predicate in this situation? You need a predicate with an argument!
 
 `app/controllers/store_controller.rb:`
@@ -59,7 +59,9 @@ a predicate in this situation? You need a predicate with an argument!
       def items
         cart = Cart.find(cart_id)
         @items = cart.items
-        predicate(:shipping?) { |item| item.status == :shipped && DeliveryService.status(item.tracking_number) !~ /arrived/ }
+        predicate(:shipping?) { |item| @items.count >= 3 && 
+          item.status == :shipped && 
+          DeliveryService.status(item.tracking_number) !~ /arrived/ }
       end
     end
 
@@ -95,7 +97,7 @@ returns the css class we need for a given item?
         cart = Cart.find(cart_id)
         @items = cart.items
         synonym(:css_for_item_status) do |item| 
-          if item.status == :shipped 
+          if @items.count >= 3 && item.status == :shipped 
             if DeliveryService.status(item.tracking_number) !~ /arrived/
               "shipping"
             else
@@ -201,7 +203,7 @@ Advantages
 
 * Placing predicates in the Controller allows them to orchestrate multiple Models without breaking encapsulation between Models.  The Controller is arguably a better place to define such predicates from an MVC perspective.
 
-* Condi makes it simple to define predicates and synonyms in the Controller and call them from the view without cluttering the helper namespace and creating a maze of unique names for every action.  Condi is more flexible.
+* Condi makes it simple to define predicates and synonyms in the Controller and call them from the view without cluttering the helper namespace and creating a maze of unique helper names that are coupled to some action contexts and not others.  Condi is more flexible.
 
 * Another advantage of the predicate being defined dynamically on the Controller is that the predicate can never be inadvertently called as an action itself.  Condi offers better encapsulation of state.
 
@@ -215,6 +217,8 @@ Disadvantages
 
 * It may be awkward to share predicates across multiple actions.  But if you think about it, it is awkward to share context as well.  Filters are a common solution for both problems.  You can define your predicates in a before_filter method to ensure that both the context and the predicates will be sharable. 
 
+* If you aren't using any context from the action (i.e. you pass all your parameters as arguments and don't take advantage of the closure) then you don't really need Condi... it may be simpler/cleaner to just use helpers.
+
 
 Background
 ----------

data/lib/condi.rb

@@ -7,14 +7,16 @@
 #     end
 module Condi
 
-  # define a method on the controller which is callable from the related view. 
+  # define a method on the controller which is callable from the related view and returns a true or false value. 
   # @example define a predicate that determines whether or not to show a "free shipping" option.
   #     predicate(:show_free_shipping?) { user.new_customer? && cart.amount > 100 }
   # @example define a predicate that takes an element of a collection as an argument.
-  #     predicate(:shipping?) { |item| item.status == :shipped && DeliveryService.status(item.tracking_number) !~ /arrived/ }
+  #     predicate(:shipping?) { |item| @items.count >= 3 && 
+  #        item.status == :shipped && 
+  #        DeliveryService.status(item.tracking_number) !~ /arrived/ }
   # @example define a synonym that returns a css class based on item status
   #     synonym(:css_for_item_status) do |item| 
-  #       if item.status == :shipped 
+  #       if @items.count >= 3 && item.status == :shipped 
   #         if DeliveryService.status(item.tracking_number) !~ /arrived/
   #           "shipping"
   #         else
@@ -26,6 +28,7 @@ module Condi
   #     end
   # @param [Symbol] method_name name of the predicate or synonym method. (e.g. :show_action_button?)
   # @param [Proc] block {} or do...end block.
+  # @note A *synonym* is an alias for defining methods that return values other than true or false.
   # @note You are not required to end a predicate with a question mark, however it is conventional in Ruby to do so.
   # @see the full example in the <a href="index.html">README</a>. 
   def predicate(method_name, &block)
@@ -35,6 +38,6 @@ module Condi
     end
   end
 
-  # a synonym is similar to a predicate but returns values besides true and false.
+  # a synonym can be used to define methods that return values besides true and false. 
   alias_method :synonym, :predicate
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: condi
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,8 @@ bindir: bin
 cert_chain: []
 date: 2011-12-14 00:00:00.000000000 Z
 dependencies: []
-description: Conditional UI predicates for Rails
+description: Conditional UI predicates for Rails - a clean and simple approach to
+  separate business logic from your views and models.
 email: larry.kyrala@gmail.com
 executables: []
 extensions: []