superstore 2.4.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bff1f7868f9525ae36d1a003c33422d12fea5e8e
-  data.tar.gz: eb8cfbe4048d28e3b7097bad7f51d36e8fde1aa5
+SHA256:
+  metadata.gz: 4b50e7d651ea05c7214a0407aca4c530eee09f8ba6e8d867d636400f1a22bb42
+  data.tar.gz: 00d665bc855ad9cfcdf77ceaaefb6d674a5964611eb082ea0e0e0d0da880ac84
 SHA512:
-  metadata.gz: 41d1fc61dcad51d35ac4feb6d46ff3cad2dd423ea39b1070b275f1cfd0a0a5f51279e10866e823a8ea4925f1d57fc42157b9bb3c10ad401acd8c688d300a5dcf
-  data.tar.gz: fb7104cda38cc586278b0ac28ee1330ab1d97705e11bff14379d01f255d1fc12fadcded56b41d5b00cd236e630ad41f961dae7b35d1ff4adf73d5dcfc45ead6c
+  metadata.gz: d819bb08f1c070d18bdccd76caf941718947ea0c85191813f8896bc86d6c61d49f4306e3cea816514e05e635299d28bd663bc4515bb1ca90ae01bd7454db49bc
+  data.tar.gz: 014e964e51adb9c2791af3598435e6f7764b9e6bc80edab030f804c84944213eb68e423d7e9daf527f42c92ed98fa7da4421be5f55e4f1a315fb13904dfe3921

data/.github/workflows/ruby.yml

@@ -0,0 +1,40 @@
+name: Ruby
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: ['3.1']
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    services:
+      postgres:
+        image: postgres:12.8
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: runner
+          POSTGRES_HOST_AUTH_METHOD: trust
+    steps:
+    - name: Checkout the repo
+      uses: actions/checkout@v2
+    - name: Install Ruby, bundler and the bundle
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+    - name: Publish code coverage
+      if: ${{ github.actor != 'dependabot[bot]' }}
+      uses: paambaati/codeclimate-action@v3.0.0

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle
 Gemfile*.lock
 *.gem
+coverage

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start 'test_frameworks' do
+  enable_coverage :branch
+end

data/Gemfile

@@ -1,11 +1,10 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
 
 group :test do
-  gem 'rails'
   gem 'pg'
-  gem 'activerecord', '~> 5.0.0'
   gem 'mocha', require: false
+  gem 'simplecov'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Koziarski Software Ltd
+Copyright (c) 2009 Koziarski Software Ltd, 2022 Data Axle Inc
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 [Michael Koziarski]
+Copyright (c) 2011 [Michael Koziarski], 2022 [Data Axle Inc]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,5 @@
 # Superstore
-[![Build Status](https://secure.travis-ci.org/data-axle/superstore.png?rvm=2.0.0)](http://travis-ci.org/data-axle/superstore)
+[![Ruby](https://github.com/data-axle/superstore/actions/workflows/ruby.yml/badge.svg)](https://github.com/data-axle/superstore/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/data-axle/superstore/badges/gpa.svg)](https://codeclimate.com/github/data-axle/superstore)
 [![Gem](https://img.shields.io/gem/v/superstore.svg?maxAge=2592000)](https://rubygems.org/gems/superstore)
 
@@ -15,27 +15,18 @@ Superstore requires PostgreSQL 9.5 or above.
 Add the following to the `Gemfile`:
 
 ```ruby
-gem 'pg'
 gem 'superstore'
 ```
 
-Add a `config/superstore.yml`:
-
-```yaml
-development:
-  adapter: jsonb
-```
-
 Superstore will share the existing ActiveRecord database connection.
 
 ## Defining Models
 
 ```ruby
 class Widget < Superstore::Base
-  string :name
-  string :description
-  integer :price
-  array :colors, unique: true
+  attribute :name, type: :string
+  attribute :price, type: :integer
+  attribute :colors, type: :array
 
   validates :name, presence: :true
 
@@ -69,24 +60,3 @@ widget.price_was
 widget.save
 widget.save!
 ```
-
-## Finding records
-
-```ruby
-widget = Widget.find(uuid)
-widget = Widget.first
-widgets = Widget.all
-Widget.find_each do |widget|
-  # Codez
-end
-```
-
-## Scoping
-
-Some lightweight scoping features are available:
-
-```ruby
-Widget.where('color' => 'red')
-Widget.select(['name', 'color'])
-Widget.limit(10)
-```

data/lib/superstore/adapters/abstract_adapter.rb

@@ -1,10 +1,7 @@
 module Superstore
   module Adapters
     class AbstractAdapter
-      attr_reader :config
-      def initialize(config)
-        @config = config
-        @batch_statements = nil
+      def initialize
       end
 
       # Read records from a instance of Superstore::Scope
@@ -22,29 +19,6 @@ module Superstore
       # Delete rows by an array of ids
       def delete(table, ids) # abstract
       end
-
-      def execute_batch(statements) # abstract
-      end
-
-      def batching?
-        !@batch_statements.nil?
-      end
-
-      def batch
-        @batch_statements = []
-        yield
-        execute_batch(@batch_statements) if @batch_statements.any?
-      ensure
-        @batch_statements = nil
-      end
-
-      def execute_batchable(statement)
-        if @batch_statements
-          @batch_statements << statement
-        else
-          execute statement
-        end
-      end
     end
   end
 end

data/lib/superstore/adapters/jsonb_adapter.rb

@@ -4,86 +4,6 @@ require 'pg'
 module Superstore
   module Adapters
     class JsonbAdapter < AbstractAdapter
-      class QueryBuilder
-        def initialize(adapter, scope)
-          @adapter  = adapter
-          @scope    = scope
-        end
-
-        def to_query
-          [
-            "SELECT #{select_string}",
-            from_string,
-            where_string,
-            order_string,
-            limit_string
-          ].delete_if(&:blank?) * ' '
-        end
-
-        def from_string
-          "FROM #{@scope.klass.table_name}"
-        end
-
-        def select_string
-          if @scope.select_values.empty?
-            '*'
-          elsif @scope.select_values == [@adapter.primary_key_column]
-            @adapter.primary_key_column
-          else
-            selects = @scope.select_values.map { |key| "#{@adapter.quote(key)},document->>#{@adapter.quote(key)}" }
-            "#{@adapter.primary_key_column}, json_build_object(#{selects * ','}) as document"
-          end
-        end
-
-        def where_string
-          wheres = where_values_as_strings
-
-          if @scope.id_values.any?
-            wheres << @adapter.create_ids_where_clause(@scope.id_values)
-          end
-
-          if wheres.any?
-            "WHERE #{wheres * ' AND '}"
-          end
-        end
-
-        def order_string
-          if @scope.order_values.any?
-            orders = @scope.order_values.join(', ')
-            "ORDER BY #{orders}"
-          elsif @scope.id_values.many?
-            id_orders = @scope.id_values.map { |id| "ID=#{@adapter.quote(id)} DESC" }.join(',')
-            "ORDER BY #{id_orders}"
-          end
-        end
-
-        def limit_string
-          if @scope.limit_value
-            "LIMIT #{@scope.limit_value}"
-          end
-        end
-
-        def where_values_as_strings
-          @scope.where_values.map do |where_value|
-            if where_value.is_a?(Hash)
-              key = where_value.keys.first
-              value = where_value.values.first
-
-              if value.nil?
-                "(document->>'#{key}') IS NULL"
-              elsif value.is_a?(Array)
-                typecasted_values = value.map { |v| "'#{v}'" }.join(',')
-                "document->>'#{key}' IN (#{typecasted_values})"
-              else
-                "document->>'#{key}' = '#{value}'"
-              end
-            else
-              where_value
-            end
-          end
-        end
-      end
-
       PRIMARY_KEY_COLUMN = 'id'.freeze
       def primary_key_column
         PRIMARY_KEY_COLUMN
@@ -105,39 +25,10 @@ module Superstore
         connection.execute statement
       end
 
-      def to_ids(scope)
-        statement = QueryBuilder.new(self, scope.select(primary_key_column)).to_query
-        connection.select_values(statement)
-      end
-
-      def select(scope)
-        statement = QueryBuilder.new(self, scope).to_query
-
-        connection.execute(statement).each do |result|
-          yield result[primary_key_column], Oj.compat_load(result['document'])
-        end
-      end
-
-      def scroll(scope, batch_size)
-        statement   = QueryBuilder.new(self, scope).to_query
-        cursor_name = "cursor_#{SecureRandom.hex(6)}"
-        fetch_sql   = "FETCH FORWARD #{batch_size} FROM #{cursor_name}"
-
-        connection.transaction do
-          connection.execute "DECLARE #{cursor_name} NO SCROLL CURSOR FOR (#{statement})"
-
-          while (batch = connection.execute(fetch_sql)).any?
-            batch.each do |result|
-              yield result[primary_key_column], Oj.compat_load(result['document'])
-            end
-          end
-        end
-      end
-
       def insert(table, id, attributes)
         not_nil_attributes = attributes.reject { |key, value| value.nil? }
         statement = "INSERT INTO #{table} (#{primary_key_column}, document) VALUES (#{quote(id)}, #{to_quoted_jsonb(not_nil_attributes)})"
-        execute_batchable statement
+        execute statement
       end
 
       def update(table, id, attributes)
@@ -157,31 +48,13 @@ module Superstore
 
         statement = "UPDATE #{table} SET document = #{value_update} WHERE #{primary_key_column} = #{quote(id)}"
 
-        execute_batchable statement
+        execute statement
       end
 
       def delete(table, ids)
         statement = "DELETE FROM #{table} WHERE #{create_ids_where_clause(ids)}"
 
-        execute_batchable statement
-      end
-
-      def execute_batch(statements)
-        connection.transaction do
-          execute(statements * ";\n")
-        end
-      end
-
-      def create_table(table_name, options = {})
-        ActiveRecord::Migration.create_table table_name, id: false do |t|
-          t.string :id, null: false
-          t.jsonb :document, null: false
-        end
-        connection.execute "ALTER TABLE \"#{table_name}\" ADD CONSTRAINT #{table_name}_pkey PRIMARY KEY (id)"
-      end
-
-      def drop_table(table_name)
-        ActiveRecord::Migration.drop_table table_name
+        execute statement
       end
 
       def create_ids_where_clause(ids)
@@ -204,9 +77,8 @@ module Superstore
         "ARRAY[#{quoted_fields}]"
       end
 
-      OJ_OPTIONS = {mode: :compat}
       def to_quoted_jsonb(data)
-        "#{quote(Oj.dump(data, OJ_OPTIONS))}::JSONB"
+        "#{quote(JSON.generate(data))}::JSONB"
       end
     end
   end

data/lib/superstore/associations/association.rb

@@ -7,6 +7,7 @@ module Superstore
       def initialize(owner, reflection)
         @owner = owner
         @reflection = reflection
+        reset
       end
 
       def association_class
@@ -33,6 +34,11 @@ module Superstore
       def loaded!
         @loaded = true
       end
+
+      def reset
+        @loaded = false
+        @target = nil
+      end
     end
   end
 end

data/lib/superstore/associations/association_scope.rb

@@ -0,0 +1,20 @@
+module Superstore
+  module Associations
+    class AssociationScope < ActiveRecord::Relation
+      def initialize(klass, association)
+        super(klass)
+        @association = association
+      end
+
+      def exec_queries
+        super.each { |r| @association.set_inverse_instance r }
+      end
+
+      def <<(*records)
+        if loaded?
+          @records = @records + records
+        end
+      end
+    end
+  end
+end

data/lib/superstore/associations/belongs_to.rb

@@ -17,6 +17,8 @@ module Superstore
         end
       end
 
+      def belongs_to?; true; end
+
       private
 
         def get_record
@@ -32,4 +34,4 @@ module Superstore
 
     end
   end
-end
+end

data/lib/superstore/associations/builder/association.rb

@@ -35,4 +35,4 @@ module Superstore::Associations::Builder
       end
     end
   end
-end
+end

data/lib/superstore/associations/has_many.rb

@@ -19,12 +19,25 @@ module Superstore
         self.target = relation
       end
 
+      def set_inverse_instance(record)
+        return unless reflection.inverse_name
+
+        inverse = record.association(reflection.inverse_name)
+        inverse.target = owner
+      end
+
       private
 
+        def inverse_of
+          return unless reflection.inverse_name
+
+          @inverse_of ||= association_class.reflect_on_association reflection.inverse_name
+        end
+
         def load_collection
-          association_class.where(reflection.foreign_key => owner.try(reflection.primary_key))
+          AssociationScope.new(association_class, self).where("document ->> '#{reflection.foreign_key}' = '#{owner.try(reflection.primary_key)}'")
         end
 
     end
   end
-end
+end

data/lib/superstore/associations/reflection.rb

@@ -18,7 +18,7 @@ module Superstore
         when :has_one
           Superstore::Associations::HasOne
         end
-        
+
       end
 
       def instance_variable_name
@@ -45,12 +45,18 @@ module Superstore
         options[:polymorphic]
       end
 
+      def belongs_to?; false; end
+
       def class_name
         @class_name ||= (options[:class_name] || name.to_s.classify)
       end
 
+      def inverse_name
+        options[:inverse_of]
+      end
+
       private
-      
+
       def derive_foreign_key
         case macro
         when :has_many, :has_one

data/lib/superstore/associations.rb

@@ -2,7 +2,12 @@ module Superstore
   module Associations
     extend ActiveSupport::Concern
 
-    module ClassMethods
+    included do
+      include ActiveRecord::Associations
+      extend ClassOverrides
+    end
+
+    module ClassOverrides
       # === Options
       # [:class_name]
       #   Use if the class cannot be inferred from the association
@@ -13,7 +18,7 @@ module Superstore
       #   end
       #   class Truck < Superstore::Base
       #   end
-      def belongs_to(name, options = {})
+      def belongs_to(name, **options)
         if options.delete(:superstore)
           Superstore::Associations::Builder::BelongsTo.build(self, name, options)
         else
@@ -21,7 +26,7 @@ module Superstore
         end
       end
 
-      def has_many(name, options = {})
+      def has_many(name, **options)
         if options.delete(:superstore)
           Superstore::Associations::Builder::HasMany.build(self, name, options)
         else
@@ -29,7 +34,7 @@ module Superstore
         end
       end
 
-      def has_one(name, options = {})
+      def has_one(name, **options)
         if options.delete(:superstore)
           Superstore::Associations::Builder::HasOne.build(self, name, options)
         else

data/lib/superstore/attribute_assignment.rb

@@ -0,0 +1,7 @@
+module Superstore
+  module AttributeAssignment
+    def _assign_attribute(k, v)
+      public_send("#{k}=", v) if respond_to?("#{k}=")
+    end
+  end
+end

data/lib/superstore/attribute_methods/primary_key.rb

@@ -1,25 +1,34 @@
+# frozen_string_literal: true
+
 module Superstore
   module AttributeMethods
     module PrimaryKey
       extend ActiveSupport::Concern
 
+      included do
+        attribute :id, type: :string
+        include AttributeOverrides
+      end
+
       module ClassMethods
-        PRIMARY_KEY = 'id'
         def primary_key
-          PRIMARY_KEY
+          'id'
         end
       end
 
-      def id
-        @id ||= self.class._generate_key(self)
-      end
-
-      def id=(id)
-        @id = id
-      end
+      module AttributeOverrides
+        def id
+          value = super
+          if value.nil?
+            value = self.class._generate_key(self)
+            @attributes.write_from_user(self.class.primary_key, value)
+          end
+          value
+        end
 
-      def attributes
-        super.update(self.class.primary_key => id)
+        def attributes
+          super.update(self.class.primary_key => id)
+        end
       end
     end
   end