acts_as_nosql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6557e20a7d3813b7250a1a6b4e346d07e3b8f89b9ad984d66c6632e8e172bf9e
+  data.tar.gz: 8ddacccc9e46e5102dc4056fd4a139e6dde8302e15bd108f66ab7b15214880e7
+SHA512:
+  metadata.gz: cf9a0fdfba234f852ffd8fc97fe18b709eaff996037da995bccb672696f03d749ac52e4dc2a82306c87f8bb12efd4f7d9f942a43718bb86d309d6b169fd868dd
+  data.tar.gz: 39662c4f73d0d4f1468a1e02d95ddb6624a907079a9ae4984b449356e51bc5ebf631c162508946f330035747591131f469249e8c72b5484ef0fc6c569aca3e5f

data/lib/acts_as_nosql/attribute.rb

@@ -0,0 +1,39 @@
+
+module ActsAsNosql
+  class Attribute
+    attr_reader :name, :type, :default, :path, :type_caster
+
+    def initialize(name, type: nil, default: nil, path: nil)
+      @name = name.to_s
+      @type = type
+      @default = default
+      @path = path&.map { |p| p.to_s }
+      @type_caster = type ? "ActiveRecord::Type::#{type}".safe_constantize : nil
+    end
+
+    def cast(value)
+      type_caster ? type_caster.new.cast(value) : value
+    end
+
+    def read(attr)
+      if path
+        attr&.dig(*path)
+      else
+        attr&.dig(name)
+      end
+    end
+
+    def write(attr, value)
+      if path
+        current = attr
+        path[0...-1].each do |key|
+          current[key] ||= {}
+          current = current[key]
+        end
+        current[path.last] = cast(value)
+      else
+        attr[name] = cast(value)
+      end
+    end
+  end
+end

data/lib/acts_as_nosql/attributes.rb

@@ -0,0 +1,56 @@
+
+module ActsAsNosql
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :_acts_as_nosql_init
+    end
+
+    def _acts_as_nosql_init
+      self.class.nosql_attributes.each do |name, attribute|
+        public_send("#{name}=", attribute.default.dup) if public_send(name).nil? && !attribute.default.nil?
+      end
+    end
+
+    class_methods do
+      def nosql_attrs(*names, type: nil, default: nil, path: nil)
+        nosql_attr(*names, type: type, default: default, path: path)
+      end
+
+      def nosql_attr(*names, type: nil, default: nil, path: nil)
+        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
+
+          nosql_attributes[name] = ActsAsNosql::Attribute.new(name, type: type, default: default, path: path)
+          _acts_as_nosql_define_attribute(nosql_attributes[name])
+        end
+      end
+
+      def nosql_attributes
+        self._acts_as_nosql_options[:attributes] ||= {}
+      end
+
+      private
+
+      def nosql_data_attribute
+        @nosql_data_attribute ||= self._acts_as_nosql_options[:field_name]
+      end
+
+      def _acts_as_nosql_define_attribute(nosql_attribute)
+        attribute = nosql_data_attribute
+
+        define_method(nosql_attribute.name) do
+          nosql_attribute.read(self[attribute])
+        end
+
+        define_method("#{nosql_attribute.name}=") do |value|
+          self[attribute] ||= {}
+          nosql_attribute.write(self[attribute], value)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_nosql/querying.rb

@@ -0,0 +1,86 @@
+
+module ActsAsNosql
+  module Querying
+    def where(*args)
+      args, json_args = *extract_json_args(args)
+
+      if json_args
+        chain = _acts_as_nosql_parse_where(json_args)
+
+        args.first.empty? ? chain : chain.where(*args)
+      else
+        super
+      end
+    end
+
+    private
+
+    def extract_json_args(args)
+      return [args, nil] unless args.first.is_a?(Hash)
+      return [args, nil] unless model._acts_as_nosql_options
+
+      attrs = model._acts_as_nosql_options[:attributes]
+      hash = args.first
+
+      return [args, nil] if hash.keys.none? { |key| attrs.key?(key) }
+
+      json_hash = {}
+      nonjson_hash = {}
+
+      hash.each do |key, value|
+        if attrs.key?(key)
+          json_hash[key] = value
+        else
+          nonjson_hash[key] = value
+        end
+      end
+
+      [
+        [nonjson_hash, args[1..-1]],
+        json_hash
+      ]
+    end
+
+    def _acts_as_nosql_parse_where(hash)
+      hash.inject(self) do |chain, (key, value)|
+        attr = model._acts_as_nosql_options[:attributes][key]
+        chain.where(*build_sql_query(attr, value))
+      end
+    end
+
+    def build_sql_query(attribute, value)
+      field_name = model._acts_as_nosql_options[:field_name]
+      ["#{quote_chain(attribute, field_name)} = ?", value]
+    end
+
+    def quote_chain(attribute, field_name)
+      if connection.adapter_name == 'PostgreSQL'
+        quote_chain_psql(attribute, field_name)
+      else
+        quote_chain_base(attribute, field_name)
+      end
+    end
+
+    def quote_chain_base(attribute, field_name)
+      base = quote_full_column(field_name)
+      path = attribute.path || [attribute.name]
+      "#{base}->>'$.#{path.join('.')}'"
+    end
+
+    def quote_chain_psql(attribute, field_name)
+      base = quote_full_column(field_name)
+      path = attribute.path
+      if attribute.path
+        "#{base}->#{path[0...-1].map { |e| "'#{e}'"}.join('->')}->>'#{path.last}'"
+      else
+        "#{base}->>'#{attribute.name}'"
+      end
+    end
+
+    def quote_full_column(field_name)
+      connection.quote_table_name(arel_table.table_alias || arel_table.table_name) +
+        '.' +
+        connection.quote_column_name(field_name)
+    end
+  end
+end

data/lib/acts_as_nosql/version.rb

@@ -0,0 +1,3 @@
+module ActsAsNosql
+  VERSION = '0.1.0'.freeze
+end

data/lib/acts_as_nosql.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+
+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 }
+
+      include ActsAsNosql::Attributes
+    end
+
+    def _acts_as_nosql_options
+      @_acts_as_nosql_options
+    end
+  end
+
+  autoload :Attribute
+  autoload :Attributes
+  autoload :Querying
+end
+
+ActiveRecord::Base.include ActsAsNosql
+ActiveRecord::Relation.prepend(ActsAsNosql::Querying)

data/spec/acts_as_nosql/model_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'Fields declaration' do
+
+  subject { Article.new }
+
+  it 'has declared fields' do
+    expect(subject).to respond_to(:body)
+    expect(subject).to respond_to(:body=)
+    expect(subject).to respond_to(:comments_count)
+    expect(subject).to respond_to(:comments_count=)
+    expect(subject).to respond_to(:published)
+    expect(subject).to respond_to(:published=)
+  end
+
+  it 'uses default values' do
+    expect(subject.comments_count).to eq(0)
+    expect(subject.published).to eq(false)
+    expect(subject.body).to eq(nil)
+  end
+
+  it 'casts fields' do
+    subject.body = 2
+    expect(subject.body).to eq('2')
+
+    subject.published = '1'
+    expect(subject.published).to eq(true)
+
+    subject.comments_count = '1'
+    expect(subject.comments_count).to eq(1)
+  end
+
+  it 'raises error if there\'s a name conflict with the field_name' do
+    expect { Article.nosql_attr :data }.to raise_error("Attribute data 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
+    subject.editor = 'John Doe'
+    subject.save!
+    subject.reload
+    expect(subject.editor).to eq('John Doe')
+    expect(subject.data['editor']).to eq('John Doe')
+    expect(subject.data[:editor]).to eq(nil)
+    expect(subject.data.keys.first).to be_a(String)
+  end
+end

data/spec/acts_as_nosql/nested_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'Nested fields declaration' do
+
+  subject { Setting.new }
+
+  it 'has declared fields' do
+    expect(subject).to respond_to(:user_auth_token)
+    expect(subject).to respond_to(:user_auth_token=)
+  end
+
+  it 'uses default values' do
+    expect(subject.user_auth_token).to eq('')
+  end
+
+  it 'casts fields' do
+    subject.user_auth_token = 2
+    expect(subject.user_auth_token).to eq('2')
+  end
+
+  it 'writes nested values' do
+    subject.user_auth_token = 2
+    expect(subject.config).to eq({ 'user' => { 'auth' => { 'providers' => [], 'token' => '2' } } })
+  end
+
+  it 'data is persisted' do
+    subject.user_auth_token = 2
+    subject.save!
+    subject.reload
+    expect(subject.user_auth_token).to eq('2')
+    expect(subject.config).to eq({ 'user' => { 'auth' => { 'providers' => [], 'token' => '2' } } })
+  end
+
+  context 'with array type' do
+    it 'handles writes' do
+      expect(subject.user_auth_providers).to eq([])
+      subject.user_auth_providers = ['google']
+      expect(subject.user_auth_providers).to eq(['google'])
+      subject.save!
+      subject.reload
+      expect(subject.config).to eq({ 'user' => { 'auth' => { 'providers' => ['google'], 'token' => '' } } })
+    end
+
+    it 'handles mutation' do
+      expect(subject.user_auth_providers).to eq([])
+      subject.user_auth_providers << 'google'
+      expect(subject.user_auth_providers).to eq(['google'])
+      subject.save!
+      subject.reload
+      expect(subject.config).to eq({ 'user' => { 'auth' => { 'providers' => ['google'], 'token' => '' } } })
+    end
+  end
+end

data/spec/acts_as_nosql/querying_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'Querying' do
+  context 'simple attributes' do
+    let!(:article) do
+      Article.create!(
+        body: 'body',
+        published: true,
+        comments_count: 5,
+      )
+    end
+
+    let!(:article2) do
+      Article.create!
+    end
+
+    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_a).to contain_exactly(article)
+    end
+  end
+
+  context 'nested attributes' do
+    let!(:setting) do
+      Setting.create!(
+        user_auth_token: '123123',
+      )
+    end
+
+    let!(:setting2) do
+      Setting.create!
+    end
+
+    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_a).to contain_exactly(setting)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+require 'rspec'
+require 'acts_as_nosql'
+require 'active_record'
+
+I18n.enforce_available_locales = false
+RSpec::Expectations.configuration.warn_about_potential_false_positives = false
+
+Dir[File.expand_path('support/*.rb', __dir__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Schema.create
+  end
+
+  config.around(:each) do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,64 @@
+require 'active_record'
+
+if ENV['ACTIVE_RECORD_ADAPTER'] == 'mysql'
+  puts 'Running on MySQL...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'mysql2',
+    username: ENV['DB_USERNAME'] || 'root',
+    password: ENV['DB_PASSWORD'],
+    database: 'acts_as_nosql'
+  )
+elsif ENV['ACTIVE_RECORD_ADAPTER'] == 'postgresql'
+  puts 'Running on PostgreSQL...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'postgresql',
+    database: 'acts_as_nosql',
+    host: ENV['DB_HOST'] || '127.0.0.1',
+    username: ENV['DB_USERNAME'] || 'postgres',
+    password: ENV['DB_PASSWORD']
+  )
+else
+  puts 'Running on SQLite...'
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+  )
+end
+
+class Article < ActiveRecord::Base
+  acts_as_nosql field_name: :data
+
+  def some_column
+  end
+
+  nosql_attrs :body, :editor, type: String
+  nosql_attr :comments_count, type: :Integer, default: 0
+  nosql_attr :published, type: :Boolean, default: false
+end
+
+class Setting < ActiveRecord::Base
+  acts_as_nosql field_name: :config
+
+  nosql_attrs :user_auth_token, type: String, default: '', path: [:user, :auth, :token]
+  nosql_attrs :user_auth_providers, type: Array, default: [], path: [:user, :auth, :providers]
+end
+
+module Schema
+  def self.create
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Schema.define do
+      create_table :articles, force: true do |t|
+        t.string   :title
+        t.json     :data
+        t.timestamps null: false
+      end
+
+      create_table :settings, force: true do |t|
+        t.string   :title
+        t.json     :config
+        t.timestamps null: false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_nosql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mònade
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: It allows to handle JSON and JSONB fields as if they are proper database
+  columns, handling default values, type casting and easier validation.
+email: team@monade.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_nosql.rb
+- lib/acts_as_nosql/attribute.rb
+- lib/acts_as_nosql/attributes.rb
+- lib/acts_as_nosql/querying.rb
+- lib/acts_as_nosql/version.rb
+- spec/acts_as_nosql/model_spec.rb
+- spec/acts_as_nosql/nested_spec.rb
+- spec/acts_as_nosql/querying_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+homepage: https://rubygems.org/gems/acts_as_nosql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Use JSON columns as real activerecord attributes
+test_files:
+- spec/acts_as_nosql/model_spec.rb
+- spec/acts_as_nosql/nested_spec.rb
+- spec/acts_as_nosql/querying_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb