siphon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23f650f06f254a6f1533c012d13cf77dc0e13ea4
-  data.tar.gz: eef214200f43d53ebb467e07dc75dc78de239cec
+  metadata.gz: e74e06bdcf94fdf9c64373f47e7e477098ccbbb7
+  data.tar.gz: 953a9d7dbb2adda4570775a3d4cabd488b855ba7
 SHA512:
-  metadata.gz: 4482b1af30b6d0261082a18ade4d87064f9fea350a59fc3846aabe912538df4daca388e5cf46c426e8df46923a9c5a937c4fd43135189299193c67311e36d62d
-  data.tar.gz: 98f9ca89898cb88cac89e7d418778d055ff3bb1c97d42d0ee95b3b9776fcd667325421cfc0a2e820a785a965b45e974fd4220967db0520f63adfb02eaf8d73a8
+  metadata.gz: 23ec3db1cc57a2387396f75933ef705157c3fc48355da20306e8e59f033b45dad2b7566ef6a77149154ad3f0861102716a631da336493c7391ef5577d7aacb2a
+  data.tar.gz: e02a1597243a1a7647e2fde9c2465eece79d789c656e9177ca1565facea45d3f1682ca73cb92d986371663f09deb3f529b68e316729ec2aa6cf2b262f12f6fa8

data/README.md

@@ -18,17 +18,24 @@ Siphon is super simple and can be easily overidden. However for basic usage it h
     #books_controller.rb
     
     def collection
-      @books ||= Siphon.new(Book.scoped).with(params[:filters])
+      @books ||= Siphon.new(Book.includes(:auhtor)).
+        has_scopes({year: integer, author_name: :string}).filter(params)
     end
 
 ### Advanced Usage
+TODO: More examples
 
     # books_siphon.rb
     BookSiphon < Siphon
-    
-      def default
-        relation.paginate(:page => params[:page])
+      
+      def initialize
+        super
+        has_scopes({some: :integer, default: :boolean, scopes: nil})
       end
+    
+      # def default
+      #   relation.paginate(:page => params[:page])
+      # end
     end
 
 ## Why Siphon ?

data/lib/siphon/base.rb

@@ -12,7 +12,7 @@ module Siphon
     end
 
     def filter(params)
-      @scopes = map_scope_datatypes(scope_datatypes, params)
+      @scopes = map_scope_datatypes( params, scope_datatypes )
 
       scopes.each do |key, value|
         self.relation= relation.send(key, *value)
@@ -30,17 +30,18 @@ module Siphon
     # before:    Date
     #
     def has_scopes(scope_datatypes = {})
-      @scope_datatypes = scope_datatypes
+      @scope_datatypes = scope_datatypes.symbolize_keys
       self
     end
 
-  # private
+  private
     # TODO : for now we're assuming scope_datatypes is a Hash, K ?
-    def map_scope_datatypes(scope_datatypes, params)
+    def map_scope_datatypes( params, scope_datatypes )
       scope_hash = {}
 
-      scope_datatypes.each do |scope, datatype|
-        scope_hash[scope] = convert_type( params[scope], datatype )
+      params.symbolize_keys.each do |scope, value|
+        next unless scope_datatypes.has_key?(scope)
+        scope_hash[scope] = convert_type( value, scope_datatypes[scope] )
       end
 
       return scope_hash
@@ -52,8 +53,12 @@ module Siphon
             Integer(value)
           when :boolean
             value != "false"
-          else
+          when :string
             value
+          when :none
+            nil
+          else
+            value == "nil" ? nil : value
           end
     end
 

data/lib/siphon/version.rb

@@ -1,3 +1,3 @@
 module Siphon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/siphon.rb

@@ -9,10 +9,18 @@ require "siphon/base"
 module Siphon
   # Your code goes here...
 
-  # def apply(args)
-  #   Base.new(args)
-  # end
+  def siphon(args)
+    @siphon = Siphon::Base.new(args)
+  end
+
+  def siphon_scopes
+    @siphon and Hash[ @siphon.scopes.map {|k, v| v||= "nil"; [k, v]} ]
+  end
 
-  # module_function :apply
 
 end
+
+ActiveSupport.on_load :action_controller do
+  include Siphon
+  helper_method :siphon_scopes
+end

data/spec/siphon/base_spec.rb

@@ -24,10 +24,10 @@ describe Siphon::Base do
     it "returns self" do
       siphon = Siphon::Base.new("")
 
-      expect(siphon.has_scopes(:published)).to  eq(siphon)
+      expect(siphon.has_scopes({published: nil})).to  eq(siphon)
     end
 
-    it "registers scope_datatypes" do
+    it "sets scope_datatypes" do
       siphon = Siphon::Base.new("").has_scopes(published: :integer)
 
       expect(siphon.scope_datatypes).to eq(published: :integer)
@@ -36,71 +36,61 @@ describe Siphon::Base do
 
   describe "#filter" do
 
-    it "`sends` one params keys to an ActiveRelation" do
+    it "triggers a scope with string arg (default)" do
       relation = double
-      expect(relation).to receive(:name).with("jack").and_return(relation)
-      siphon = Siphon::Base.new(relation).has_scopes(name:nil)
+      siphon = Siphon::Base.new(relation).has_scopes(name: nil)
 
-      expect(siphon.filter(name: "jack")).to eq relation
+      expect(relation).to receive(:name).with("jack")
+
+      siphon.filter(name: "jack")
     end
 
-    it "`sends` one params keys to an ActiveRelation" do
+    it "triggers a scope with an integer arg" do
       relation = double
-      expect(relation).to receive(:age_gt).with(18).and_return(relation)
       siphon = Siphon::Base.new(relation).has_scopes(age_gt: :integer)
 
-      expect(siphon.filter(age_gt: "18")).to eq relation
+      expect(relation).to receive(:age_gt).with(18)
+
+      siphon.filter(age_gt: "18")
     end
 
-    it "`sends` one params keys to an ActiveRelation" do
+    it "triggers a scope with a boolean arg" do
       relation = double
-      expect(relation).to receive(:admin).with(false).and_return(relation)
       siphon = Siphon::Base.new(relation).has_scopes(admin: :boolean)
 
-      expect(siphon.filter(admin: "false")).to eq relation
+      expect(relation).to receive(:admin).with(false)
+
+      siphon.filter(admin: "false")
     end
 
-    it "`sends` multiple keys to an ActiveRelation" do
+    it "chains multiple scopes" do
       relation = double
+      siphon = Siphon::Base.new(relation).has_scopes(age_gt: :integer, admin: :boolean)
+
       expect(relation).to receive(:admin).with(false).and_return(relation)
       expect(relation).to receive(:age_gt).with(18).and_return(relation)
-      siphon = Siphon::Base.new(relation).has_scopes(age_gt: :integer, admin: :boolean)
 
-      expect(siphon.filter(age_gt: "18", admin: "false")).to eq relation
+      siphon.filter(age_gt: "18", admin: "false")
     end
 
+    it "chains **only** scopes defined by has_scopes" do
+      relation = double
+      siphon = Siphon::Base.new(relation).has_scopes(age_gt: :integer)
 
+      expect(relation).to receive(:age_gt)
+      expect(relation).to_not receive(:controller)
 
+      siphon.filter(age_gt: "18", controller: "books_controller")
+    end
   end
 
-
   # TESTING PRIVATE METHOD !
-  describe "#map_scope_datatypes" do
-
-    it "maps no scope value to nil" do
-      siphon = Siphon::Base.new("")
-      siphon.map_scope_datatypes({sorted: nil}, {sorted: nil}) == {sorted: nil}
-    end
-
-    it "maps default datatype string" do
-      siphon = Siphon::Base.new("")
-      siphon.map_scope_datatypes({sorted: nil}, {sorted: "name"}) == {sorted: "name"}
-    end
-
-    it "maps datatype boolean" do
-      siphon = Siphon::Base.new("")
-      siphon.map_scope_datatypes({published: :boolean}, {published: "false"}).should == {published: false}
-    end
-
-    it "maps datatype integer" do
-      siphon = Siphon::Base.new("")
-      siphon.map_scope_datatypes({age_gt: :integer}, {age_gt: "18"}).should == {age_gt: 18}
-    end
+  describe "PRIVATE !! : #map_scope_datatypes" do
 
     it "maps datatype date" do
-      pending "map datatype date"
+      pending "IGNORE & DELETE if not working"
       siphon = Siphon::Base.new("")
-      siphon.map_scope_datatypes({age_gt: :integer}, {age_gt: "18"}).should == {age_gt: 18}
+      siphon.map_scope_datatypes({age_gt: "18"}, {age_gt: :integer}).should == {age_gt: 18}
     end
   end
 

data/spec/siphon_spec.rb

@@ -5,7 +5,7 @@ describe Siphon do
   describe "#new" do
 
     it "shoot a Siphon::Base instance" do
-      Siphon.apply.should be_an_instance_of(Siphon::Base)
+      expect(Siphon.apply_scope).to be_an_instance_of(Siphon::Base)
     end
   end
 end

metadata

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