siphon 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c84b3698256472408c03116d1771e9e2fab1116
-  data.tar.gz: 64a28eb362a0291a0e90193d82d8bd42f44b992e
+  metadata.gz: cade992dddbcf4aaed6af0409efc20205c03e48e
+  data.tar.gz: 3ac950dbd0d3ac66a9681193733cc9f363c6da20
 SHA512:
-  metadata.gz: a34ec016cd428fdbdb066ad44278a0c41ce034a31df9adaf6f36fa0d932b6ee30e58fd7765bc2397003fa2ecff891f2287f926138f827ed8c71465f2c82c42d0
-  data.tar.gz: be17415132d6c8afa333988ccb97a5177403d2fa1fd085216bbb7b7ee81fbca4ce4b70fe2f1de22a9ac534ce6555332073becba7c51fd85bfd4e97778e06a888
+  metadata.gz: d6d8a170387014c505b1c1f31dd42d7dc5e4b49455f9d8851c80da5a911e74ac8c0a2aeb4b294dff56c2d7d989fd1efdba8f9b1cc045d3fe00c0ce307776bdba
+  data.tar.gz: ce48cab6fc0e4174fe8f20479daa7f23b118c2574281f3e0881799cbf98b3485f02c6859d98221fdb9f82ded4d6b3e6ba0cd0d19c88303a654dd9c7b03bafb16

data/README.md

@@ -17,43 +17,52 @@ Here's how it works :
 
 ### The Scopes :
 
-    # order.rb
-    class Order < ActiveRecord::Base
-      scope :stale, ->(duration) { where(["state='onhold' OR (state != 'done' AND updated_at < ?)", duration.ago]) }
-      scope :unpaid -> { where(paid: false) }
-    end
+```ruby
+# order.rb
+class Order < ActiveRecord::Base
+  scope :stale, ->(duration) { where(["state='onhold' OR (state != 'done' AND updated_at < ?)", duration.ago]) }
+  scope :unpaid -> { where(paid: false) }
+end
+```
 
 ### The Form :
 
-    = form_for @order_form do |f|
-      = f.label :stale, "Stale since more than"
-      = f.select :stale, [["1 week", 1.week], ["3 weeks", 3.weeks], ["3 months", 3.months]], include_blank: true
-      = f.label :unpaid
-      = f.check_box :unpaid
+```ruby
+= form_for @order_form do |f|
+  = f.label :stale, "Stale since more than"
+  = f.select :stale, [["1 week", 1.week], ["3 weeks", 3.weeks], ["3 months", 3.months]], include_blank: true
+  = f.label :unpaid
+  = f.check_box :unpaid
+```
+
 
 ### The Form Object:
 
-    # order_form.rb
-    class OrderForm
-      include Virtus.model
-      include ActiveModel::Model
-      #
-      # attribute are the named scopes and their value are : 
-      # - either the value you pass a scope which takes arguments
-      # - either a Siphon::Nil value to apply (or not) a scope which has no argument
-      #
-      attribute :stale, Integer
-      attribute :unpaid, Siphon::Nil
-    end
+```ruby
+# order_form.rb
+class OrderForm
+  include Virtus.model
+  include ActiveModel::Model
+  #
+  # attribute are the named scopes and their value are :
+  # - either the value you pass a scope which takes arguments
+  # - either a Siphon::Nil value to apply (or not) a scope which has no argument
+  #
+  attribute :stale, Integer
+  attribute :unpaid, Siphon::Nil
+end
+```
 
 
 ### Aaaaand... TADA siphon :
 
-    # orders_controller.rb
-    def search 
-      @order_form = OrderForm.new(params[:order_form])
-      @orders = siphon(Order.all).scope(@order_form)
-    end
+```ruby
+# orders_controller.rb
+def search
+  @order_form = OrderForm.new(params[:order_form])
+  @orders = siphon(Order.all).scope(@order_form)
+end
+```
 
 Here's how it works : it takes an initial ActiveRelation (Order.all) and then from a FormObject (@order_form) it will apply or not a set of scopes with typecasted arguments.
 
@@ -76,9 +85,11 @@ So the values have two distinctive roles .
 
 In the case of `stale` which takes a duration :
 
-    = form_for @order_form do |f|
-      = f.label :stale, "Stale since more than"
-      = f.select :stale, [["1 week", 1], ["3 weeks", 3], ["9 weeks", 9]], include_blank: true
+```ruby
+= form_for @order_form do |f|
+  = f.label :stale, "Stale since more than"
+  = f.select :stale, [["1 week", 1], ["3 weeks", 3], include_blank: true
+```
 
 If you select a duration the scope will be called and the argument will be turned into an integer and passed as an arg.
 But if you select the blank option the value of params[:stale] will be an empty string. Siphon knows it should be an integer thanks to the formobject and concludes this means no values are passed to the scope and therefore shouldn't be called.
@@ -96,4 +107,4 @@ That's all!
 5. Create new Pull Request
 
 [1]: https://github.com/solnic/virtus
-[2]: http:://www.coderwall.com/charly
+[2]: https://coderwall.com/p/4zz6ca

data/lib/siphon/adapter.rb

@@ -3,8 +3,8 @@ module Siphon
   #   Adapter
   # ==========
   #
-  # use : determine which scope will be called &
-  #       set relevant args to nil for
+  # use : determine which scope will not be called &
+  #       set args to nil for 'argless' scopes
   #
   #
   class Adapter
@@ -12,7 +12,7 @@ module Siphon
     def initialize(formobj)
       @formobj = formobj
 
-      @scopes_hash = @formobj.scopes
+      @scopes_hash = @formobj.attributes
       @argless = argless_list(formobj)
     end
 
@@ -22,9 +22,9 @@ module Siphon
     end
 
   private
-    # if scope is present in form but with no value (aka 'empty string')
-    # or if present in formobj but not in form  (aka : value is nil)
-    # don't apply the scope && reject from scopes_hash
+    # if scope is present in form but with no value (aka: an empty string)
+    # or if present in formobj but not in form  (aka : a nil value)
+    # don't apply the scope && reject them from scopes_hash
     def filterout_empty_string_and_nil
       @scopes_hash.delete_if { |scope, arg| ["", nil].include? @formobj[scope] }
     end

data/lib/siphon/version.rb

@@ -1,3 +1,3 @@
 module Siphon
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/class/formobj.rb

@@ -23,7 +23,7 @@ class Formobj
   #   super()
   # end
 
-  def scopes
+  def _scopes
     attributes
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siphon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Charles Sistovaris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport