squint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fec97dc85dd083e4a957f2f4096b0ea02292582b
+  data.tar.gz: 53764ef0ad978f8cc7f9e8c85703166abda7d262
+SHA512:
+  metadata.gz: 332e6d79f31fc3e799e012cf6cf828156bc0c292aff29a306677c719a97699f64a113531c8a844ed96efefaa2294916ada5dfc0812748b51dad72fe388e4d7b1
+  data.tar.gz: 81c2aedc39702bbe42bdbb9f106331c13420dbb157a2f84f44189df35d6fbe7022ca651a29bbcdd4083ac508a431048f71d74a29acb832ea20b750281e8a2070

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 David H. Wilkins
+
+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/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Squint'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/squint.rb

@@ -0,0 +1,209 @@
+require 'active_support/concern'
+
+# Squint json, jsonb, hstore queries
+module Squint
+  extend ActiveSupport::Concern
+  include ::ActiveRecord::QueryMethods
+
+  module WhereMethods
+    # Args may be passed to build_where like:
+    #  build_where(jsonb_column: {key1: value1})
+    #  build_where(jsonb_column: {key1: value1}, jsonb_column: {key2: value2})
+    #  build_where(jsonb_column: {key1: value1}, regular_column: value)
+    #  build_where(jsonb_column: {key1: value1}, association: {column: value))
+    def build_where(*args)
+      args.inject([]) do |memo, arg|
+        if arg.is_a?(Hash)
+          arg.keys.each do |key|
+            if arg[key].is_a?(Hash) && HASH_DATA_COLUMNS[key]
+              memo << hash_field_reln(key => arg[key])
+            else
+              memo += super(key => arg[key])
+            end
+          end
+        elsif arg.present?
+          memo += super(arg)
+        end
+        memo
+      end
+    end
+
+    # hash_field_reln
+    # return an Arel object with the appropriate query
+    # Strings want to be a SQL Literal, other things can be
+    # passed in bare to the eq or in operator
+    def hash_field_reln(*args)
+      temp_attr = args[0]
+      contains_nil = false
+      column_type = HASH_DATA_COLUMNS[args[0].keys.first]
+      column_name_segments = []
+      quote_char = '"'.freeze
+      while  temp_attr.is_a?(Hash)
+        attribute_sym = temp_attr.keys.first.to_sym
+        column_name_segments << (quote_char + temp_attr.keys.first.to_s + quote_char)
+        quote_char = '\''.freeze
+        temp_attr = temp_attr[temp_attr.keys.first]
+      end
+
+      check_attr_missing = squint_storext_default?(temp_attr, attribute_sym)
+
+      # Check for nil in array
+      if temp_attr.is_a? Array
+        contains_nil = temp_attr.include?(nil)
+        # remove the nil from the array - we'll handle that later
+        temp_attr.compact!
+        # if the Array is now just 1 element, it doesn't need to be
+        # an Array any longer
+        temp_attr = temp_attr[0] if temp_attr.size == 1
+      end
+
+      if temp_attr.is_a? Array
+        temp_attr = temp_attr.map(&:to_s)
+      elsif ![FalseClass, TrueClass, NilClass].include?(temp_attr.class)
+        temp_attr = temp_attr.to_s
+      end
+
+      query_value = if [Array, NilClass].include?(temp_attr.class)
+                      temp_attr
+                    else  # strings or string-like things
+                      Arel::Nodes::Quoted.new(temp_attr.to_s)
+                    end
+      # column_name_segments[0] = column_name_segments[0]
+      attribute_selector = column_name_segments.join('->'.freeze)
+
+      # JSON(B) data needs to have the last accessor be ->> instead of
+      # -> .   The ->> returns the data as text instead of jsonb.
+      # hstore columns generally don't have nested keys / hashes
+      # Possibly need to raise an error if the hash for an hstore
+      # column references nested arrays?
+      unless column_type == 'hstore'.freeze
+        attribute_selector[attribute_selector.rindex('>'.freeze)] = '>>'.freeze
+      end
+
+      reln = if query_value.is_a?(Array)
+               arel_table[Arel::Nodes::SqlLiteral.new(attribute_selector)].in(query_value)
+             else
+               arel_table[Arel::Nodes::SqlLiteral.new(attribute_selector)].eq(query_value)
+             end
+
+      # If a nil is present in an Array, need add a specific IS NULL comparison
+      if contains_nil
+        reln = Arel::Nodes::Grouping.new(
+          reln.or(arel_table[Arel::Nodes::SqlLiteral.new(attribute_selector)].eq(nil))
+        )
+      end
+
+      # check_attr_missing for StoreXT attributes where the default is
+      # specified as a query value
+      if check_attr_missing
+        reln = if column_type == 'hstore'.freeze
+                 hstore_element_missing(column_name_segments, reln)
+               else
+                 jsonb_element_missing(column_name_segments, reln)
+               end
+      end
+      reln
+    end
+  end
+
+  included do |base|
+    ar_reln_module = base::ActiveRecord_Relation
+    ar_association_module = base::ActiveRecord_AssociationRelation
+
+    # put together a list of columns in this model
+    # that are hstore, json, or jsonb and will benefit from
+    # searchability
+    HASH_DATA_COLUMNS = base.columns_hash.keys.map do |col_name|
+      if %w[hstore json jsonb].include?(base.columns_hash[col_name].sql_type)
+        [col_name.to_sym, base.columns_hash[col_name].sql_type]
+      end
+    end.compact.to_h
+
+    ar_reln_module.class_eval do
+      prepend WhereMethods
+    end
+
+    ar_association_module.class_eval do
+      prepend WhereMethods
+    end
+
+    def self.jsonb_element_missing(column_name_segments, reln)
+      element = column_name_segments.pop
+      attribute_hash_column = column_name_segments.join('->'.freeze)
+      # Query generated is equals default or attribute present is null or equals false
+      #    * Is null happens when the the whole column is null
+      #    * equals false is when the column has jsonb data, but the key doesn't exist
+      # ("posts"."storext_attributes"->>'is_awesome' = 'false' OR
+      #   (("posts"."storext_attributes" ? 'is_awesome') IS NULL OR
+      #    ("posts"."storext_attributes" ? 'is_awesome') = FALSE)
+      # )
+      Arel::Nodes::Grouping.new(
+        reln.or(
+          Arel::Nodes::Grouping.new(
+            Arel::Nodes::Equality.new(
+              Arel::Nodes::Grouping.new(
+                Arel::Nodes::InfixOperation.new(
+                  Arel::Nodes::SqlLiteral.new('?'),
+                  arel_table[Arel::Nodes::SqlLiteral.new(attribute_hash_column)],
+                  Arel::Nodes::SqlLiteral.new(element)
+                )
+              ), nil
+            ).or(
+              Arel::Nodes::Equality.new(
+                Arel::Nodes::Grouping.new(
+                  Arel::Nodes::InfixOperation.new(
+                    Arel::Nodes::SqlLiteral.new('?'),
+                    arel_table[Arel::Nodes::SqlLiteral.new(attribute_hash_column)],
+                    Arel::Nodes::SqlLiteral.new(element)
+                  )
+                ), Arel::Nodes::False.new
+              )
+            )
+          )
+        )
+      )
+    end
+
+    def self.squint_storext_default?(temp_attr, attribute_sym)
+      return false unless respond_to?(:storext_definitions)
+      if storext_definitions.keys.include?(attribute_sym) &&
+         !storext_definitions[attribute_sym].dig(:opts, :default).nil? &&
+         [temp_attr].compact.map(&:to_s).
+           flatten.
+           include?(storext_definitions[attribute_sym][:opts][:default].to_s)
+        true
+      end
+    end
+
+    def self.hstore_element_missing(column_name_segments, reln)
+      element = column_name_segments.pop
+      attribute_hash_column = column_name_segments.join('->'.freeze)
+      # Query generated is equals default or attribute present is null or equals false
+      #    * Is null happens the the column is null
+      #    * equals false is when the column has jsonb data, but the key doesn't exist
+      # ("posts"."storext_attributes"->>'is_awesome' = 'false' OR
+      #   (exists("posts"."storext_attributes", 'is_awesome') IS NULL OR
+      #    exists("posts"."storext_attributes", 'is_awesome') = FALSE)
+      # )
+      Arel::Nodes::Grouping.new(
+        reln.or(
+          Arel::Nodes::Grouping.new(
+            Arel::Nodes::NamedFunction.new(
+              "exist",
+              [arel_table[Arel::Nodes::SqlLiteral.new(attribute_hash_column)],
+               Arel::Nodes::SqlLiteral.new(element)]
+            ).eq(Arel::Nodes::False.new)
+          ).or(
+            Arel::Nodes::Equality.new(
+              Arel::Nodes::NamedFunction.new(
+                "exist",
+                [arel_table[Arel::Nodes::SqlLiteral.new(attribute_hash_column)],
+                 Arel::Nodes::SqlLiteral.new(element)]
+              ), nil
+            )
+          )
+        )
+      )
+    end
+  end
+end

data/lib/squint/version.rb

@@ -0,0 +1,3 @@
+module Squint
+  VERSION = "0.0.1".freeze
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/models/post.rb

@@ -0,0 +1,14 @@
+class Post < ActiveRecord::Base
+  include Storext.model
+  include Squint
+
+  store_attribute :storext_jsonb_attributes, :jsonb_zip_code, String, default: '90210'
+  store_attribute :storext_jsonb_attributes, :jsonb_friend_count, Integer, default: 0
+  store_attribute :storext_jsonb_attributes, :jsonb_is_awesome, Integer, default: false
+  store_attribute :storext_jsonb_attributes, :jsonb_is_present, Integer, default: nil
+
+  store_attribute :storext_hstore_attributes, :hstore_zip_code, String, default: '90210'
+  store_attribute :storext_hstore_attributes, :hstore_friend_count, Integer, default: 0
+  store_attribute :storext_hstore_attributes, :hstore_is_awesome, Integer, default: false
+  store_attribute :storext_hstore_attributes, :hstore_is_present, Integer, default: nil
+end

data/test/dummy/app/models/post.rb~

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "squint"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,14 @@
+# local
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+development:
+  <<: *default
+  database: squint_development
+
+test:
+  <<: *default
+  database: squint_test
+

data/test/dummy/config/database.yml~

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/db/migrate/20170512185941_create_posts.rb

@@ -0,0 +1,19 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    enable_extension "hstore"
+    create_table :posts do |t|
+      t.string :title
+      t.string :body
+      t.jsonb :request_info
+      t.hstore :properties
+      t.jsonb :storext_jsonb_attributes
+      t.hstore :storext_hstore_attributes
+
+      t.timestamps null: false
+      t.index :request_info, using: 'GIN'
+      t.index :properties, using: 'GIN'
+      t.index :storext_jsonb_attributes, using: 'GIN'
+      t.index :storext_hstore_attributes, using: 'GIN'
+    end
+  end
+end