siphon 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fda2150f53756f1efb9c4b7799ef8b455058da6
-  data.tar.gz: bf50ec379b961877f30111e9a692f9acb3725fc4
+  metadata.gz: ff59f1ee65f4df1a1dcd5a81d58f720516661b04
+  data.tar.gz: b8de584c9cc38381f08ff3728010465aab98ad61
 SHA512:
-  metadata.gz: cf69ad74e5e7e24674f8c79b085cd8d44099dbf22f4ad6d096f714d6295d7fa49a3b95f277d04c906b6a4bbf5bb7a62d846bae5ccb75b7ebca0c60449b38fcbc
-  data.tar.gz: 67d175542ffade84c13ce2116730d96f7c2fd6841b32e35938d90953ea79069df248e2743268c2815afc859b0929317f4641c191d2072777d6a91c9b2f72cbc5
+  metadata.gz: 976bb2d950083963335c855b4b7848eb84689094245eafb76c23d0e61fc5ea201ed1ca0b5da71b66f04af1a792ec73938c23ca7c22eef02f707f056a0979338b
+  data.tar.gz: e4b25e4bbe4844db09024f2e61939583f89d6e1daee028162c24740a614972d255703891aacd43a0604f5f5688599362adcaa75e68eb5fe6b4fd93906ccd495d

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.2.3

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
+  - "2.2.3"
   #- jruby-18mode # JRuby in 1.8 mode
   #- jruby-19mode # JRuby in 1.9 mode
   #- rbx

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## Siphon 0.2.0 (Dec 2015)
+
+* The ModelSearch can now respond_to `siphon_attributes`
+* Boilerplate provides all the stuff ModelSearch needs...
+* ...hence the generated ModelSearch is now minimal
+
+## Siphone 0.1.3
+
+* handle time & dates arguments for scope from issue #2

data/lib/generators/templates/search.rb

@@ -1,59 +1,34 @@
 # uncomment `q` lines for combining ransack with your scope search
 class <%= class_name %>Search
 
-  include ActiveModel::Model
-  include Virtus.model
+  include Siphon::Boilerplate
+  siphonize class_name
 
-  TABLE = <%= class_name %>.table_name
+  #
+  # Scope attributes
+  #
+  # attribute :tree_id,   Integer
+  # attribute :is_public, Boolean
 
-  attribute :tree_id,   Integer
-  attribute :is_public, Boolean
+  #
+  # ransack attributes
+  #
+  # ransack :category_id_eq
+  # ransack :title_cont
 
 
-  attr_reader :q        # the nested ransack object
-  attr_reader :order_by # handles your order clause
-
-  def initialize(params = {})
-    @params = params || {}
-    super(params)
-    self.q= @params[:q]
-    self.order_by= @params[:order_by]
-  end
-
-  # Example of conditionally applying search terms.
-  # def done
-  #   return false unless @params[:q]
-  #   @params[:q][:state_eq].blank? ? @done : ""
-  # end
-
-  def result
-    <%= class_name %>.scoped.order(order_by).merge(q.result).merge(siphoned)
-  end
 
   # Exmaple of Search Form handling order stuff (might not be the best place)
   def self.order_by
-    [['newest',"#{TABLE}.created_at DESC"],
-      ["oldest", "#{TABLE}.created_at"],
-      ["category", "#{TABLE}.category_id, #{TABLE}.id"]
+    [['newest',"#{table_name}.created_at DESC"],
+      ["oldest", "#{table_name}.created_at"],
+      ["category", "#{table_name}.category_id, #{table_name}.id"]
       # ["popularity", "sales_num DESC"]]
     ]
   end
 
   # Example of default ordering
   def order_by=( val )
-    @order_by = val.blank? ? "#{TABLE}.created_at DESC" : val
+    @order_by = val.blank? ? "#{table_name}.created_at DESC" : val
   end
-
-
-  def q=(sub_form_hash = {})
-    @q = <%= class_name %>.search( sub_form_hash )
-  end
-
-private
-
-  def siphoned
-    Siphon::Base.new(<%= class_name %>.scoped).scope( self )
-  end
-
-
 end

data/lib/siphon/adapter.rb

@@ -12,8 +12,8 @@ module Siphon
     def initialize(formobj)
       @formobj = formobj
 
-      @scopes_hash = @formobj.attributes
-      @argless = argless_list(formobj)
+      @scopes_hash = assign_scope_hashes @formobj
+      @argless     = argless_list @formobj
     end
 
     def call
@@ -22,9 +22,9 @@ module Siphon
     end
 
   private
-    # 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
+    # Do NOT APPLY SCOPE && reject them from scopes_hash
+    # 1. if scope is present in form but with no value (aka: an empty string)
+    # 2. if present in formobj but not in form  (aka : a nil value)
     def filterout_empty_string_and_nil
       @scopes_hash.delete_if { |scope, arg| ["", nil].include? @formobj[scope] }
     end
@@ -45,5 +45,11 @@ module Siphon
         map(&:name)
     end
 
+    # if the form object has #siphon_attributes favor that one
+    # usefull to seperate ransack attributes from siphon ones
+    def assign_scope_hashes(formobj)
+      formobj.respond_to?(:siphon_attributes) ?
+        formobj.siphon_attributes : formobj.attributes
+    end
   end
 end

data/lib/siphon/boilerplate.rb

@@ -0,0 +1,84 @@
+require "active_support/concern"
+
+module Siphon
+  module Boilerplate
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Model
+      include Virtus.model
+      include InstanceMethods
+
+      cattr_accessor :model
+      cattr_accessor :model_name
+      cattr_accessor :table_name
+
+
+      attr_reader :params_ransack # the ransack object
+      attr_reader :params_siphon # the ransack object
+      attr_reader :order_by # handles your order clause
+
+    end
+
+    module InstanceMethods
+      def initialize( params = {}, relation = nil )
+        @relation||= relation
+        @params = params || {}
+
+        @params_ransack= @params.slice(*self.class.ransack_set)
+        @params_siphon= @params.except(*self.class.ransack_set)
+        self.order_by= @params["order_by"]
+
+        super @params_siphon
+      end
+
+      def table_name
+        self.class.model.table_name
+      end
+
+      def ransack
+        @relation.search( params_ransack )
+      end
+
+      def merge(relation)
+        @relation = @relation.merge(relation)
+        self
+      end
+
+      def siphoned
+        Siphon::Base.new(@relation).scope( self )
+      end
+
+      # memoized or it'll break after attributes reconciled
+      def result
+        @result ||= begin
+          relation = @relation.order(order_by).
+                      merge(ransack.result).
+                      merge(siphoned)
+          # reconcile all params for the search form (?)
+          self.attributes= attributes.merge(params_ransack)
+          relation
+        end
+      end
+    end
+
+    class_methods do
+
+      def siphonize(model, model_name: nil, table_name: nil)
+        name = model_name || "#{model}Search"
+        self.model_name= ActiveModel::Name.new(self, nil, name)
+        self.table_name= Asset.table_name
+      end
+
+      def ransack_set
+        @ransack_set.map(&:to_s)
+      end
+
+      def ransack( attr, type= nil )
+        @ransack_set ||= []
+        attribute attr
+        @ransack_set << attr
+      end
+    end
+  end
+end

data/lib/siphon/version.rb

@@ -1,3 +1,3 @@
 module Siphon
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/siphon.rb

@@ -1,11 +1,13 @@
 require "bundler/setup"
 
+require "active_support"
 require "active_support/core_ext"
 
 require "siphon/version"
 require "siphon/base"
 require "siphon/adapter"
 require "siphon/nil"
+require "siphon/boilerplate"
 
 module Siphon
   # Your code goes here...

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: siphon
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Charles Sistovaris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2015-12-09 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: virtus
   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'
 - !ruby/object:Gem::Dependency
   name: activemodel
   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
@@ -116,11 +116,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .pryrc
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -131,6 +132,7 @@ files:
 - lib/siphon.rb
 - lib/siphon/adapter.rb
 - lib/siphon/base.rb
+- lib/siphon/boilerplate.rb
 - lib/siphon/nil.rb
 - lib/siphon/version.rb
 - siphon.gemspec
@@ -152,17 +154,17 @@ 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.2.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Siphon enables you to easily apply/combine/exclude your ActiveRecord scopes
@@ -176,4 +178,3 @@ test_files:
 - spec/siphon/mapper_spec.rb
 - spec/siphon_spec.rb
 - spec/spec_helper.rb
-has_rdoc: