siphon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23f650f06f254a6f1533c012d13cf77dc0e13ea4
+  data.tar.gz: eef214200f43d53ebb467e07dc75dc78de239cec
+SHA512:
+  metadata.gz: 4482b1af30b6d0261082a18ade4d87064f9fea350a59fc3846aabe912538df4daca388e5cf46c426e8df46923a9c5a937c4fd43135189299193c67311e36d62d
+  data.tar.gz: 98f9ca89898cb88cac89e7d418778d055ff3bb1c97d42d0ee95b3b9776fcd667325421cfc0a2e820a785a965b45e974fd4220967db0520f63adfb02eaf8d73a8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.pryrc

@@ -0,0 +1 @@
+require "siphon"

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in siphon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Charles Sistovaris
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Siphon
+
+Siphon's a minimalistic gem which enables you to easily apply/combine/exclude your ActiveRecord scopes with params.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'siphon'
+
+## Usage
+
+Siphon is super simple and can be easily overidden. However for basic usage it has a couple of helpers.
+
+### Basic Usage
+
+    ```ruby
+    #books_controller.rb
+    
+    def collection
+      @books ||= Siphon.new(Book.scoped).with(params[:filters])
+    end
+
+### Advanced Usage
+
+    # books_siphon.rb
+    BookSiphon < Siphon
+    
+      def default
+        relation.paginate(:page => params[:page])
+      end
+    end
+
+## Why Siphon ?
+
+Thanks to Arel & ActiveRelation, Rails has an extraordinary, super powerful API to create scopes. You can chain them, merge them, pass them around, in what ever order you want, they'll just build the SQL you expect and only fire when necessary. 
+
+However once you're in the controller all this beauty is lost if you want to start applying scopes conditionally - e.g : depending on params in the url.
+
+One way of doing it is like that :
+
+    def index
+      @results = Results.scoped
+      @results = @results.gender(params[:gender]) if params[:gender]
+      @results = @results.career(params[:career]) if params[:career]
+    end
+
+It's ugly, it doesn't scale and each time I see an `if` I hear the squeeking sound of a tree falling in the rain forest to build another Mc Donalds.
+
+## Why not Has_Scope ?
+
+So what about has_scope ?
+
+    # books_controller.rb
+    has_scope :gender
+    has_scope :career
+    
+    def index
+      @results = apply_scopes(Results).all
+    end
+
+and yee it was build by the awesome José Valim. But in my taste it suffers from the same problem Paperclip and all gem which rely on configuration with hashes have : Hashitis. 
+
+    # tree_controller.rb
+    has_scope :color, :unless => :show_all_colors?
+    has_scope :only_tall, :type => :boolean, :only => :index, :if => :restrict_to_only_tall_trees?
+    has_scope :shadown_range, :default => 10, :except => [ :index, :show, :new ]
+    has_scope :root_type, :as => :root, :allow_blank => true
+    has_scope :calculate_height, :default => proc {|c| c.session[:height] || 20 }, :only => :new
+
+As soon as you reach a certain level of complexity it looks as bad as if nested ifs were crawling all over your code. That's why most of us go for CarrierWave today : because well if you need behaviour why try to invent another DSL when you already have the best at hands : RUBY !
+
+* You unclutter your controllers - which I like anorexic.
+* You're not limited by the set of configuration the gem gives you.
+* you can apply as much logic as you whish 
+* It's encapsultated, unit-testable & respects SRP
+
+Actually Siphon shouln't even be a gem but just a set of guidelines. But hey it has a cool name...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/siphon/base.rb

@@ -0,0 +1,61 @@
+#
+#
+#
+module Siphon
+  class Base
+    attr_accessor :relation, :scopes, :scope_datatypes
+
+
+    # Siphon.new(Book.scoped)
+    def initialize(relation)
+      @relation = relation
+    end
+
+    def filter(params)
+      @scopes = map_scope_datatypes(scope_datatypes, params)
+
+      scopes.each do |key, value|
+        self.relation= relation.send(key, *value)
+      end
+
+      relation
+    end
+
+    # Possible Datatype
+    # -----------------
+    # admin: nil
+    # category_name: String
+    # published: Boolean,
+    # age_gt:    Integer
+    # before:    Date
+    #
+    def has_scopes(scope_datatypes = {})
+      @scope_datatypes = scope_datatypes
+      self
+    end
+
+  # private
+    # TODO : for now we're assuming scope_datatypes is a Hash, K ?
+    def map_scope_datatypes(scope_datatypes, params)
+      scope_hash = {}
+
+      scope_datatypes.each do |scope, datatype|
+        scope_hash[scope] = convert_type( params[scope], datatype )
+      end
+
+      return scope_hash
+    end
+
+    def convert_type(value, type)
+      v = case type
+          when :integer
+            Integer(value)
+          when :boolean
+            value != "false"
+          else
+            value
+          end
+    end
+
+  end
+end

data/lib/siphon/version.rb

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

data/lib/siphon.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+require "active_support/core_ext"
+
+
+require "siphon/version"
+require "siphon/base"
+
+module Siphon
+  # Your code goes here...
+
+  # def apply(args)
+  #   Base.new(args)
+  # end
+
+  # module_function :apply
+
+end

data/siphon.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'siphon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "siphon"
+  spec.version       = Siphon::VERSION
+  spec.authors       = ["Charles Sistovaris"]
+  spec.email         = ["charlysisto@gmail.com"]
+  spec.description   = %q{Siphon enables you to easily apply/combine/exclude your ActiveRecord scopes with params}
+  spec.summary       = %q{Siphon enables you to easily apply/combine/exclude your ActiveRecord scopes with params}
+  spec.homepage      = "http://github.com/charly/siphon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  # spec.add_dependency "activesupport"
+
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/class/active_relation.rb

@@ -0,0 +1,10 @@
+#
+class ActiveRelation
+
+
+
+  def self.title_with
+
+  end
+
+end

data/spec/siphon/base_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+class Tree
+end
+
+describe Siphon::Base do
+
+  describe "#initialize" do
+
+    it "must initialize with an ActiveRelation" do
+      expect { Siphon::Base.new }.to raise_error(ArgumentError)
+    end
+
+    it "sets @relation" do
+      relation = double
+      siphon = Siphon::Base.new(relation)
+
+      expect(siphon.relation).to eq(relation)
+    end
+  end
+
+  describe "#has_scopes" do
+
+    it "returns self" do
+      siphon = Siphon::Base.new("")
+
+      expect(siphon.has_scopes(:published)).to  eq(siphon)
+    end
+
+    it "registers scope_datatypes" do
+      siphon = Siphon::Base.new("").has_scopes(published: :integer)
+
+      expect(siphon.scope_datatypes).to eq(published: :integer)
+    end
+  end
+
+  describe "#filter" do
+
+    it "`sends` one params keys to an ActiveRelation" do
+      relation = double
+      expect(relation).to receive(:name).with("jack").and_return(relation)
+      siphon = Siphon::Base.new(relation).has_scopes(name:nil)
+
+      expect(siphon.filter(name: "jack")).to eq relation
+    end
+
+    it "`sends` one params keys to an ActiveRelation" 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
+    end
+
+    it "`sends` one params keys to an ActiveRelation" 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
+    end
+
+    it "`sends` multiple keys to an ActiveRelation" do
+      relation = double
+      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
+    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
+
+    it "maps datatype date" do
+      pending "map datatype date"
+      siphon = Siphon::Base.new("")
+      siphon.map_scope_datatypes({age_gt: :integer}, {age_gt: "18"}).should == {age_gt: 18}
+    end
+  end
+
+end

data/spec/siphon_spec.rb

@@ -0,0 +1,11 @@
+
+
+describe Siphon do
+
+  describe "#new" do
+
+    it "shoot a Siphon::Base instance" do
+      Siphon.apply.should be_an_instance_of(Siphon::Base)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+require "siphon"
+
+
+class ActiveRelation
+  def self.title_with
+  end
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: siphon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Sistovaris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: pry
+  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: Siphon enables you to easily apply/combine/exclude your ActiveRecord
+  scopes with params
+email:
+- charlysisto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/siphon.rb
+- lib/siphon/base.rb
+- lib/siphon/version.rb
+- siphon.gemspec
+- spec/class/active_relation.rb
+- spec/siphon/base_spec.rb
+- spec/siphon_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/charly/siphon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Siphon enables you to easily apply/combine/exclude your ActiveRecord scopes
+  with params
+test_files:
+- spec/class/active_relation.rb
+- spec/siphon/base_spec.rb
+- spec/siphon_spec.rb
+- spec/spec_helper.rb