siphon 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78d9af7e442c0c0c6d5efc53ef449858d6abb2da
-  data.tar.gz: 9d6ee29efdf72049e898ad1ba25e9eeec96e59bf
+SHA256:
+  metadata.gz: 92365b6395921c463098560d6454e58724e390e16bce4290b2023c3cebded30a
+  data.tar.gz: 6e039cc7825f96ce2d30719216f664534c9a300c8ab48cd4fcdae90cfa27d3f6
 SHA512:
-  metadata.gz: c75a3109e9b143a322bda5fc7a0ed5030e7b9b169282854b4054156bc720fce34b46f18e0974770c69a755acc347bad9c42c559190240b596c1be4ae87cc9047
-  data.tar.gz: 9a3e7f1b04d39f37c317ada78d2161a6733842a2f952d8ff01b74b80cab9a4ba0896b2777f2a2dc52d680e31dcef3e3b4dc17387172d1c8a75f1aa4b956601ae
+  metadata.gz: da28a7c8ff0099c029f7e7133a409f42928521d722d3c4322155829707d07f8ae43bc6458e92145fab8db341a60ee13bbe2a0fa1ad9250a8505a83ae43de6c44
+  data.tar.gz: e32f5534c2f9c620abf63d09caa0da275a2f4bf8ed34ff81e39e0aebddc7c6e09e4434db8b5b5a2fa5959f40c705cbf399cb198ad44a2f6bf04513a0c8c47ecb

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Siphon 0.3.0 (Sep 2018)
+
+* Rails 5 compat: convert StrongParam to regular params
+* Decouple Formobj#attributes from Form#obj#siphon_attributes
+* include Siphon::Scope instead of Boilerplate (use latter for compat)
+* Formobj.ransack takes type as well
+
 ## Siphon 0.2.4 (Mar 2016)
 
 * Fixed scopes with no argument still sending nil !
@@ -18,7 +25,7 @@
 * The ModelSearch can now respond_to `siphon_attributes`
 * Boilerplate provides all the stuff ModelSearch needs...
 * ...hence the generated ModelSearch is now minimal
-* Boilerplate also gives users a `ransack` macro to set ransack attributes 
+* Boilerplate also gives users a `ransack` macro to set ransack attributes
 
 ## Siphon 0.1.3
 

data/lib/generators/templates/search.rb

@@ -1,7 +1,7 @@
 # uncomment `q` lines for combining ransack with your scope search
 class <%= class_name %>Search
 
-  include Siphon::Boilerplate
+  include Siphon::Scope
   siphonize <%= class_mate %>
 
   #
@@ -21,7 +21,7 @@ class <%= class_name %>Search
     @relation = relation
   end
 
-  # Exmaple of Search Form handling order stuff (might not be the best place)
+  # Example of Search Form handling order stuff (might not be the best place)
   def self.order_by
     [['newest',"#{table_name}.created_at DESC"],
       ["oldest", "#{table_name}.created_at"],
@@ -34,4 +34,4 @@ class <%= class_name %>Search
   def order_by=( val )
     @order_by = val.blank? ? "#{table_name}.created_at DESC" : val
   end
-end
+end

data/lib/siphon/adapter.rb

@@ -48,8 +48,7 @@ module Siphon
     # 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
+      formobj.respond_to?(:siphon_attributes) ? formobj.siphon_attributes : formobj.attributes
     end
   end
-end
+end

data/lib/siphon/boilerplate.rb

@@ -78,4 +78,4 @@ module Siphon
       end
     end
   end
-end
+end

data/lib/siphon/nil.rb

@@ -9,4 +9,4 @@ module Siphon
     end
 
   end
-end
+end

data/lib/siphon/scope.rb

@@ -0,0 +1,101 @@
+require "active_support/concern"
+
+module Siphon
+  module Scope
+    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 :ransack_attributes # for the Ransack object
+      attr_reader :siphon_attributes # for the Siphon object
+      attr_reader :order_by # handles your order clause
+    end
+
+    module InstanceMethods
+      def initialize( params = {})
+        @params = convert_to_hash(params)
+        super @params
+
+        @ransack_attributes = attributes.slice(*self.class.ransack_set)
+        @siphon_attributes  = attributes.slice(*self.class.siphon_set)
+
+        self.order_by   = @params["order_by"]
+      end
+
+      def convert_to_hash(params)
+        if params.nil?
+          {}
+        elsif params.respond_to?(:permit!)
+          params.permit!
+        elsif params.respond_to?(:with_indifferent_access)
+          params.with_indifferent_access
+        else
+          params
+        end
+      end
+
+      def table_name
+        self.class.model.table_name
+      end
+
+      def ransack
+        @relation.search(ransack_attributes)
+      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 ||= siphoned.merge(ransack.result)
+      end
+
+      def preformat_date(value = nil)
+        value.is_a?(String) && value.present? ? Date.strptime(value, I18n.t('date.formats.long')) : value
+      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= model.table_name
+        @ransack_set ||= []
+        @siphon_set ||= []
+      end
+
+      def ransack_set
+        @ransack_set
+      end
+
+      def siphon_set
+        @siphon_set
+      end
+
+      def scope(attr, type = nil)
+        type.nil? ? attribute(attr) : attribute(attr, type)
+        @siphon_set << attr
+      end
+
+      def ransack(attr, type = nil)
+        type.nil? ? attribute(attr) : attribute(attr, type)
+        @ransack_set << attr
+      end
+    end
+  end
+end

data/lib/siphon/version.rb

@@ -1,3 +1,3 @@
 module Siphon
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/lib/siphon.rb

@@ -8,6 +8,7 @@ require "siphon/base"
 require "siphon/adapter"
 require "siphon/nil"
 require "siphon/boilerplate"
+require "siphon/scope"
 
 module Siphon
   # Your code goes here...
@@ -20,4 +21,4 @@ end
 
 ActiveSupport.on_load :action_controller do
   include Siphon
-end
+end

data/spec/siphon/base_spec.rb

@@ -66,6 +66,4 @@ describe Siphon::Base do
       Siphon::Base.new(relation).admin(false).after(1).scope(formobj)
     end
   end
-
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siphon
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Charles Sistovaris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2018-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,7 @@ files:
 - lib/siphon/base.rb
 - lib/siphon/boilerplate.rb
 - lib/siphon/nil.rb
+- lib/siphon/scope.rb
 - lib/siphon/version.rb
 - siphon.gemspec
 - spec/class/active_relation.rb
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Siphon enables you to easily apply/combine/exclude your ActiveRecord scopes