quantum_fields 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cc27f3dfbb9f1839c4181a91ad750a8ba0f7a255409a5a0574116df423a4a4f
-  data.tar.gz: 6e22264a1fd7d81ac75befda172afab1e2a6891594a29a692cfdf7b008f74259
+  metadata.gz: 225219c6eb2031eac5edd7900a35e3f7c5ce6025175901a7fae160bbf4dc1661
+  data.tar.gz: b02f1f72ee6fefa63d2a0264fd1d04cc27b07c9fffe7c6561799f0667cd06aea
 SHA512:
-  metadata.gz: 61c95851553049b511fd1afffe1ab3f723f83ab852714843d5abfa876789fd3e9ea1f6cfa0cf35c87183ab37b5c6a6b754a5b328fb697455faf91db5234f029d
-  data.tar.gz: a92e736b89cd46bc23bdeeb1c538a33cb5f643d2dba17465ff2bc7be512d09bdd9473cb720e38d5720122c6df3f9f58a2ffd146f1b0e58710aa247cff13c2af8
+  metadata.gz: 34cafe75d21a630b2c3e647c92b4e623eaa8ec6ea3b363325a1fdcfc5f7ed9afa54f2451dc5bdffba6bf4de64c0ef3f2cf81cbb5283051d5454087ab339c6b98
+  data.tar.gz: dccc02766d88453f2006a85426a364a1165db38352e0af5e84be6b98b3e508ad1b4306b4082de485dc514134d9ff5a4b3afbc2b9d7256988fc1cf35139f14aee

data/lib/quantum_fields.rb

@@ -16,6 +16,19 @@ module QuantumFields
   # This module contains the methods called within the Model to initialize
   # and to manage how the other methods should behave on the given context.
   module ClassMethods
+    # Method called in the model context to initialize behavior and pass
+    # configuration options into quantum_fields. You can use a custom column
+    # for your fields and a custom column for your injected validation rules.
+    # Initializing the gem behavior on default 'quantum_fields' and
+    # 'quantum_rules' columns:
+    # => no_sqlize
+    # Initializing the gem behavior on default 'quantum_rules' column and a
+    # custom fields_column 'my_json_field'
+    # => no_sqlize fields_column: :my_json_field
+    # Initializing the gem behavior on default 'quantum_fields' column and a
+    # custom rules_column 'my_json_field', affecting from where to pull
+    # injected validations:
+    # => no_sqlize rules_column: :my_json_field
     def no_sqlize(args = {})
       class_eval <<-RUBY, __FILE__, __LINE__+1
         def self.fields_column

data/lib/quantum_fields/active_record_patch.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 ActiveRecord::PredicateBuilder.class_eval do
+  # Builds an binded Arel operation, injecting json operator if necessary
   def build(attribute, value)
     if table.type(attribute.name).force_equality?(value)
       bind = build_bind_attribute(attribute.name, value)
@@ -16,7 +17,10 @@ ActiveRecord::PredicateBuilder.class_eval do
   end
 end
 ActiveRecord::Relation.class_eval do
-  def arel_attribute(name) # :nodoc:
+  # Returns an Arel::Node that is used to query a field.
+  # In case that attribute is a column or if current model
+  # hasn't initialized 'no_sqlize' keeps Rails' behavior.
+  def arel_attribute(name)
     if klass.column_names.include?(name.to_s) || !klass.respond_to?(:fields_column)
       klass.arel_attribute(name, table)
     else

data/lib/quantum_fields/exceptions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module QuantumFields
+  class NoSqlizedFieldsColumnMissing < RuntimeError
+    def initialize(msg="Missing a JSON field to build QuantumFields")
+      super
+    end
+  end
+end

data/lib/quantum_fields/no_sqlize.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'quantum_fields/exceptions'
 module QuantumFields
   # Module to enable virtual methods in moduls, it creates necessary
   # methods to simulate the behavior that any field can exist, getting
@@ -10,12 +11,10 @@ module QuantumFields
     # into `.parameters` JSON as a key-value pair, or recovering it's value if
     # exists.
     def method_missing(meth, *args, &block)
-      if can_no_sqlize?
-        no_sqlize!(meth, *args, &block)
-      else
-        raise NotImplementedError,
-              "#{model.table_name} should have a `#{fields_column}` JSON column"
-      end
+      method_name = meth.to_s
+      super if method_name.ends_with?('!')
+      bad_config! unless can_no_sqlize?
+      no_sqlize!(method_name, *args, &block)
     rescue StandardError
       super
     end
@@ -24,10 +23,10 @@ module QuantumFields
     # the premisse that you can always assign a value to any field and recover
     # only existing fields or the ones that are in the `.parameters` JSON.
     def respond_to_missing?(method_name, include_private = false)
+      bad_config! unless can_no_sqlize?
       meth = method_name.to_s
-      can_no_sqlize? && meth.ends_with?('=') || meth.ends_with?('changed?') ||
-        try(fields_column).try(:[], meth).present? ||
-        super
+      meth.ends_with?('=') || meth.ends_with?('?') ||
+        try(fields_column).try(:[], meth).present? || super
     end
 
     # Overriding a ActiveRecord method that is used in `.create` and `.update`
@@ -58,15 +57,21 @@ module QuantumFields
     # The behavior that a noSQL method should have. It either assigns a value into
     # an attribute or retrieves it's value, depending in the method called.
     def no_sqlize!(meth, *args, &_block)
-      method_name = meth.to_s
       initialize_fields
-      if method_name.ends_with?('=')
-        assing_to(method_name.chomp('='), args.first)
+      if meth.ends_with?('=')
+        assing_to(meth.chomp('='), args.first)
+      elsif meth.ends_with?('?')
+        read_nosqlized(meth.chomp('?')).present?
       else
-        try(fields_column).try(:[], method_name)
+        read_nosqlized(meth)
       end
     end
 
+    # Read the value of a `meth` key in :fields_column
+    def read_nosqlized(meth)
+      try(fields_column).try(:[], meth)
+    end
+
     # Assings a value to a key in :fields_column which allows saving any virtual
     # attribute
     def assing_to(param, value)
@@ -76,12 +81,18 @@ module QuantumFields
     # Checks if requirements are met for the feature
     def can_no_sqlize?
       model.column_names.include?(fields_column.to_s) &&
-        %i[json jsonb].include?(no_sqlize_column.type)
+        %i[hstore json jsonb].include?(no_sqlize_column.type)
     end
 
     # Retrieve which column is being used to sqlize
     def no_sqlize_column
       model.columns.find { |col| col.name == fields_column.to_s }
     end
+
+    # Raises an exception indicating bad configuration of the gem
+    def bad_config!
+      raise QuantumFields::NoSqlizedFieldsColumnMissing,
+            "#{model.table_name} should have a `#{fields_column}` JSON column"
+    end
   end
 end

data/lib/quantum_fields/support.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'quantum_fields/support/postgresql'
-require 'quantum_fields/support/mysql'
+require 'quantum_fields/support/mysql2'
 require 'quantum_fields/support/sqlite3'
 
 module QuantumFields

data/lib/quantum_fields/support/{mysql.rb → mysql2.rb}

@@ -3,7 +3,7 @@
 module QuantumFields
   module Support
     # Abstracts MySQL support for quantum_fields operations
-    module Mysql
+    module Mysql2
       class << self
         # Returns an Arel node in the context of given field and JSON key,
         # which in this context constructs as "json_extract("my_models"."my_json_field", '$.key')"

data/lib/quantum_fields/validation_injector.rb

@@ -7,6 +7,7 @@ module QuantumFields
     extend ActiveSupport::Concern
     included do
       before_validation :map_injected_validations
+      # Maps your rules_column for defined validations
       def map_injected_validations
         send(self.class.rules_column).try(:deep_symbolize_keys)&.each do |field, rules|
           validations = rules[:validates]
@@ -14,6 +15,9 @@ module QuantumFields
         end
       end
 
+      private
+
+      # Injects validations on a given field
       def inject_validations(field, validations)
         validations.each do |method, value|
           singleton_class.validates field, method => value

data/lib/quantum_fields/version.rb

@@ -1,3 +1,3 @@
 module QuantumFields
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quantum_fields
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fernando Bellincanta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: mysql2
+  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: QuantumFields is a gem to extend your Rails model's making them able
   to use virtual fields from a JSON column or a Text column serialized as a Hash.
   This means that you can use fields that were not explicitly declared in your schema
@@ -67,10 +95,11 @@ files:
 - Rakefile
 - lib/quantum_fields.rb
 - lib/quantum_fields/active_record_patch.rb
+- lib/quantum_fields/exceptions.rb
 - lib/quantum_fields/no_sqlize.rb
 - lib/quantum_fields/railtie.rb
 - lib/quantum_fields/support.rb
-- lib/quantum_fields/support/mysql.rb
+- lib/quantum_fields/support/mysql2.rb
 - lib/quantum_fields/support/postgresql.rb
 - lib/quantum_fields/support/sqlite3.rb
 - lib/quantum_fields/validation_injector.rb