acts_as_nosql 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6557e20a7d3813b7250a1a6b4e346d07e3b8f89b9ad984d66c6632e8e172bf9e
-  data.tar.gz: 8ddacccc9e46e5102dc4056fd4a139e6dde8302e15bd108f66ab7b15214880e7
+  metadata.gz: 00fb5f260f1d2ff40dc4adcb5d2dc868c45fc909753f229b60fcf878164fb933
+  data.tar.gz: a597101125686d651b810ba3da7a84ba1cb743eeba42e3019c6bde573999adc7
 SHA512:
-  metadata.gz: cf9a0fdfba234f852ffd8fc97fe18b709eaff996037da995bccb672696f03d749ac52e4dc2a82306c87f8bb12efd4f7d9f942a43718bb86d309d6b169fd868dd
-  data.tar.gz: 39662c4f73d0d4f1468a1e02d95ddb6624a907079a9ae4984b449356e51bc5ebf631c162508946f330035747591131f469249e8c72b5484ef0fc6c569aca3e5f
+  metadata.gz: b66ae32d0e756a14bf54c22d755281660cba0c907ab4435447cff643eed28b10bdfec2fb260ec19d896b9425f6c0acac1059c8efa1f85ee9720a577293d1fce5
+  data.tar.gz: 443123f7c7026ff6678d40650be1246cc47623f3c534ca2c679f84d6d6dbbc9bb245cc26677111c18c68a1081570c342f2bad0068d902c6780b37ae79237c36d

data/lib/acts_as_nosql/attribute.rb

@@ -3,11 +3,15 @@ module ActsAsNosql
   class Attribute
     attr_reader :name, :type, :default, :path, :type_caster
 
+    # @param [String, Symbol] name
+    # @param [String, Symbol, nil] type
+    # @param [Object, nil] default
+    # @param [Array<String, Symbol>, nil] path
     def initialize(name, type: nil, default: nil, path: nil)
       @name = name.to_s
       @type = type
       @default = default
-      @path = path&.map { |p| p.to_s }
+      @path = path&.map(&:to_s)
       @type_caster = type ? "ActiveRecord::Type::#{type}".safe_constantize : nil
     end
 

data/lib/acts_as_nosql/attributes.rb

@@ -4,10 +4,10 @@ module ActsAsNosql
     extend ActiveSupport::Concern
 
     included do
-      after_initialize :_acts_as_nosql_init
+      after_initialize :_acts_as_nosql_init_defaults
     end
 
-    def _acts_as_nosql_init
+    def _acts_as_nosql_init_defaults
       self.class.nosql_attributes.each do |name, attribute|
         public_send("#{name}=", attribute.default.dup) if public_send(name).nil? && !attribute.default.nil?
       end
@@ -22,23 +22,52 @@ module ActsAsNosql
         attribute = self._acts_as_nosql_options[:field_name]
 
         names.each do |name|
-          raise "Attribute #{name} already defined" if instance_methods.include?(name.to_sym) || name.to_sym == attribute.to_sym
+          raise "Attribute #{name} already defined" if _acts_as_nosql_attribute_defined?(name)
 
           nosql_attributes[name] = ActsAsNosql::Attribute.new(name, type: type, default: default, path: path)
           _acts_as_nosql_define_attribute(nosql_attributes[name])
         end
       end
 
+      def inherited(subclass)
+        subclass._acts_as_nosql_options = self._acts_as_nosql_options.deep_dup
+        super
+      end
+
       def nosql_attributes
         self._acts_as_nosql_options[:attributes] ||= {}
       end
 
+      def connection
+        unless acts_as_nosql_conflicts_checked?
+          @acts_as_nosql_conflicts_checked = true
+          acts_as_nosql_check_conflicts!
+        end
+        super
+      end
+
+      def acts_as_nosql_conflicts_checked?
+        @acts_as_nosql_conflicts_checked ||= false
+      end
+
+      def acts_as_nosql_check_conflicts!
+        columns_map = columns.index_by(&:name)
+        nosql_attributes.each do |name, attribute|
+          raise "Attribute #{name} already defined" if columns_map[name.to_s]
+        end
+      end
+
       private
 
       def nosql_data_attribute
         @nosql_data_attribute ||= self._acts_as_nosql_options[:field_name]
       end
 
+      def _acts_as_nosql_attribute_defined?(name)
+        instance_methods.include?(name.to_sym) ||
+          name.to_sym == nosql_data_attribute.to_sym
+      end
+
       def _acts_as_nosql_define_attribute(nosql_attribute)
         attribute = nosql_data_attribute
 

data/lib/acts_as_nosql/querying.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActsAsNosql
   module Querying
@@ -78,7 +79,7 @@ module ActsAsNosql
     end
 
     def quote_full_column(field_name)
-      connection.quote_table_name(arel_table.table_alias || arel_table.table_name) +
+      connection.quote_table_name(arel_table.table_alias || arel_table.name) +
         '.' +
         connection.quote_column_name(field_name)
     end

data/lib/acts_as_nosql/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsNosql
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.3'
 end

data/lib/acts_as_nosql.rb

@@ -1,12 +1,20 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
+# ActsAsNosql
+#
+# This gem allows to handle JSON and JSONB fields as if they are proper
+# database columns, handling default values, type casting and simplifying
+# validation.
+# This module is the main entry point for the gem.
 module ActsAsNosql
   extend ActiveSupport::Concern
   extend ActiveSupport::Autoload
 
   class_methods do
     attr_accessor :_acts_as_nosql_options
-    # cattr_accessor :_acts_as_nosql_options
+
     def acts_as_nosql(field_name: nil)
       @_acts_as_nosql_options = { field_name: field_name }
 

data/spec/acts_as_nosql/inheritance_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Inheritance' do
+  subject { InheritedSetting.new }
+  it 'inherits all methods from Settings' do
+    expect(subject).to respond_to(:user_auth_token)
+    expect(subject).to respond_to(:user_auth_token=)
+
+    subject.user_auth_token = '3'
+    expect(subject.user_auth_token).to eq('3')
+    subject.save!
+    expect do
+      expect(InheritedSetting.where(user_auth_token: '3')).to eq([subject])
+    end.to_not raise_error
+  end
+
+  it 'can be estended without affecting the parent' do
+    InheritedSetting.nosql_attrs :hello, type: :String
+    expect(subject).to respond_to(:hello)
+    expect(Setting.new).not_to respond_to(:hello)
+  end
+end

data/spec/acts_as_nosql/model_spec.rb

@@ -34,11 +34,45 @@ describe 'Fields declaration' do
     expect { Article.nosql_attr :data }.to raise_error("Attribute data already defined")
   end
 
+  it 'raises error if there\'s a name conflict an actual column' do
+    expect { Article.nosql_attr :title }.to raise_error("Attribute title already defined")
+  end
+
+  it 'raises error if there\'s a name conflict an existing nosql attribute' do
+    expect { Article.nosql_attr :body }.to raise_error("Attribute body already defined")
+  end
+
   it 'raises error if there\'s a name conflict' do
     expect { Article.nosql_attr :some_column }.to raise_error("Attribute some_column already defined")
   end
 
-  it 'fileds are saved as string' do
+  it 'raises error if there\'s a name conflict when calling #acts_as_nosql_check_conflicts!' do
+    expect do
+      class ConflictingArticle < ActiveRecord::Base
+        self.table_name = 'articles'
+        acts_as_nosql field_name: :data
+
+        nosql_attrs :title, :editor, type: String
+      end
+    end.not_to raise_error("Attribute title already defined")
+
+    expect { ConflictingArticle.acts_as_nosql_check_conflicts! }.to raise_error("Attribute title already defined")
+  end
+
+  it 'raises error if there\'s a name conflict when the model columns are loaded' do
+    expect do
+      class ConflictingArticle2 < ActiveRecord::Base
+        self.table_name = 'articles'
+        acts_as_nosql field_name: :data
+
+        nosql_attrs :title, :editor, type: String
+      end
+    end.not_to raise_error("Attribute title already defined")
+
+    expect { ConflictingArticle2.new }.to raise_error("Attribute title already defined")
+  end
+
+  it 'fields are saved as string' do
     subject.editor = 'John Doe'
     subject.save!
     subject.reload

data/spec/acts_as_nosql/querying_spec.rb

@@ -16,9 +16,16 @@ describe 'Querying' do
 
     it 'can be queried' do
       query = Article.where(body: 'body')
-      # expect(query.to_sql).to eq(
-      #   "SELECT \"articles\".* FROM \"articles\" WHERE (\"articles\".\"data\"->>\"body\" = 'body')"
-      # )
+      expect(query.to_sql).to include(
+        case ENV['ACTIVE_RECORD_ADAPTER']
+        when 'postgresql'
+          "SELECT \"articles\".* FROM \"articles\" WHERE (\"articles\".\"data\"->>'body' = 'body')"
+        when 'mysql'
+          "SELECT `articles`.* FROM `articles` WHERE (`articles`.`data`->>'$.body' = 'body')"
+        else
+          "SELECT \"articles\".* FROM \"articles\" WHERE (\"articles\".\"data\"->>'$.body' = 'body')"
+        end
+      )
       expect(query.to_a).to contain_exactly(article)
     end
   end
@@ -36,9 +43,16 @@ describe 'Querying' do
 
     it 'can query nested attributes' do
       query = Setting.where(user_auth_token: '123123')
-      # expect(query.to_sql).to eq(
-      #   "SELECT \"settings\".* FROM \"settings\" WHERE (\"settings\".\"config\"->>\"user\"->>\"auth\"->>\"token\" = '123123')"
-      # )
+      expect(query.to_sql).to eq(
+        case ENV['ACTIVE_RECORD_ADAPTER']
+        when 'postgresql'
+          "SELECT \"settings\".* FROM \"settings\" WHERE (\"settings\".\"config\"->'user'->'auth'->>'token' = '123123')"
+        when 'mysql'
+          "SELECT `settings`.* FROM `settings` WHERE (`settings`.`config`->>'$.user.auth.token' = '123123')"
+        else
+          "SELECT \"settings\".* FROM \"settings\" WHERE (\"settings\".\"config\"->>'$.user.auth.token' = '123123')"
+        end
+      )
       expect(query.to_a).to contain_exactly(setting)
     end
   end

data/spec/support/schema.rb

@@ -4,6 +4,7 @@ if ENV['ACTIVE_RECORD_ADAPTER'] == 'mysql'
   puts 'Running on MySQL...'
   ActiveRecord::Base.establish_connection(
     adapter: 'mysql2',
+    host: ENV['DB_HOST'] || '127.0.0.1',
     username: ENV['DB_USERNAME'] || 'root',
     password: ENV['DB_PASSWORD'],
     database: 'acts_as_nosql'
@@ -14,8 +15,8 @@ elsif ENV['ACTIVE_RECORD_ADAPTER'] == 'postgresql'
     adapter: 'postgresql',
     database: 'acts_as_nosql',
     host: ENV['DB_HOST'] || '127.0.0.1',
-    username: ENV['DB_USERNAME'] || 'postgres',
-    password: ENV['DB_PASSWORD']
+    username: ENV['DB_USERNAME'] || ENV['POSTGRES_USER'] || 'postgres',
+    password: ENV['DB_PASSWORD'] || ENV['POSTGRES_PASSWORD']
   )
 else
   puts 'Running on SQLite...'
@@ -43,6 +44,9 @@ class Setting < ActiveRecord::Base
   nosql_attrs :user_auth_providers, type: Array, default: [], path: [:user, :auth, :providers]
 end
 
+class InheritedSetting < Setting
+end
+
 module Schema
   def self.create
     ActiveRecord::Migration.verbose = false
@@ -59,6 +63,12 @@ module Schema
         t.json     :config
         t.timestamps null: false
       end
+
+      create_table :inherited_settings, force: true do |t|
+        t.string   :title
+        t.json     :config
+        t.timestamps null: false
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_nosql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Mònade
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,7 +51,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,6 +110,7 @@ files:
 - lib/acts_as_nosql/attributes.rb
 - lib/acts_as_nosql/querying.rb
 - lib/acts_as_nosql/version.rb
+- spec/acts_as_nosql/inheritance_spec.rb
 - spec/acts_as_nosql/model_spec.rb
 - spec/acts_as_nosql/nested_spec.rb
 - spec/acts_as_nosql/querying_spec.rb
@@ -134,11 +135,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Use JSON columns as real activerecord attributes
 test_files:
+- spec/acts_as_nosql/inheritance_spec.rb
 - spec/acts_as_nosql/model_spec.rb
 - spec/acts_as_nosql/nested_spec.rb
 - spec/acts_as_nosql/querying_spec.rb