algebra_db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b18d933ff5328a62f8a8489d851d3fcc82eb09f9ecf16dc889f9ddbda491681
+  data.tar.gz: b570df4ed63f8c95472e623ebc7cb99dc909e194288c69050533754e3ac0f5b4
+SHA512:
+  metadata.gz: 67d8b4389f4e94abe3bd3914e59d39e538e746edc8832586e787cd5b987e150e5a5cc8e5c1ad51b210e7a253c711610b4dafd4388284210a8a4d3e513ca6dbac
+  data.tar.gz: fa491f1effcebf4ce0117efb55f8e2d0ecaf0d2f1349678078c05a97dbfe9f50c9a23079930b631e5ae6dc97dbc7f40e55864ecf10f8212f98f39704ff49e1d3

data/.github/workflows/ruby.yml

@@ -0,0 +1,64 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '2.5' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version:  ${{ matrix.ruby }}
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-${{ matrix.ruby }}-gem-deps-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.ruby }}-gem-deps-
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install
+    - name: Run tests
+      run: COVERAGE=1 bundle exec rake
+    - name: Upload Coverage
+      uses: actions/upload-artifact@master
+      if: always()
+      with:
+        name: coverage-report
+        path: coverage
+    - uses: actions/cache@v2
+      with:
+        path: example/vendor/bundle
+        key: ${{ runner.os }}-${{ matrix.ruby }}-example-deps-${{ hashFiles('example/**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.ruby }}-example-deps-
+    - name: Install example dependencies for example
+      working-directory: example
+      run: |
+        bundle config path vendor/bundle
+        bundle install
+    - name: Run specs for example
+      working-directory: example
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# CHANGELOG
+
+This gem is not yet even close to any kind of release, and thus has no changelog.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in algebra_db.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rspec-its'
+gem 'simplecov', require: false

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    algebra_db (0.1.0)
+      pg (~> 1.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    io-console (0.5.6)
+    irb (1.2.3)
+      reline (>= 0.0.1)
+    method_source (1.0.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    reline (0.1.4)
+      io-console (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  algebra_db!
+  irb
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-its
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Anthony Super
+
+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/README.md

@@ -0,0 +1,195 @@
+# AlgebraDB
+
+This is a database library for Ruby based on *relational expressions*.
+Most other database libraries, like the excellent [sequel](https://github.com/jeremyevans/sequel) or [activerecord](https://github.com/rails/rails/tree/master/activerecord) are based on some idea of a *scoped dataset*, which is essentially an object that you can chain methods on to do further filtering, ordering, or what have you.
+AlgebraDB is instead based on a sort of *typed query builder*.
+Your queries return arrays of structs, custom-made for whatever query you're doing.
+This encourages us to use the full functionality of our database, resulting in faster and more correct queries.
+
+An example is probably illustrative...
+
+## Example
+
+Let's say I have two tables.
+One is a `users` table, defined like this:
+
+```sql
+CREATE TABLE users(
+  id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+  first_name TEXT NOT NULL,
+  last_name TEXT NOT NULL
+);
+
+-- Probably some sort of "What did the user do" thing.
+CREATE TABLE user_audits(
+  id BIGINT GENERATED ALWAYS AS IDENTITY PRIAMRY KEY,
+  user_id BIGINT REFERENCES users(id) NOT NULL,
+  scoped_granted TEXT[] NOT NULL,
+  values_changes JSONB DEFAULT '{}'::jsonb
+);
+```
+
+Now, these two tables are relatively nice to work with.
+But, what if I wanted to run a query that gave me all the audit logs performed under similar scopes, and what users performed those?
+This is already a bit of an annoying query, but it gets worse if I want to include the users' full names as well.
+
+With AlgebraDB, we would define some classes like this:
+
+```ruby
+##
+# Basic user table
+class User < AlgebraDB::Table
+  self.table_name = :users
+
+  column :id, :Integer
+  column :first_name, :Text
+  column :last_name, :Text
+
+end
+
+##
+# Audit log for users
+class UserAudit < AlgebraDB::Table
+  self.table_name = :user_audits
+
+  column :id, :Integer
+  column :user_id, :Integer
+  column :scopes_granted, AlgebraDB::Value::Array::Text
+  column :changes, AlgebraDB::Value::JSONB
+end
+```
+
+We could then run a query like this:
+
+```ruby
+query = AlgebraDB::Statement::Select.run_syntax do
+  parent_audits = all(UserAudit)
+  parent_audit_users = joins(User) do |user|
+    user.id.eq(parent_audits.user_id)
+  end
+  child_audits = joins(UserAudit) do |other_audit|
+    other_audit.scopes_granted.overlaps(parent_audits.scopes_granted).and(
+      other_audits.id.neq(parent_audits.id)
+    )
+  end
+  child_audit_users = joins(User) do |user|
+    user.id.eq(child_audits.user_id)
+  end
+  select(
+    parent_audit_id: parent_audits.id,
+    parent_audit_user: parent_audit_users.first_name.append(raw_param(' ')).append(parent_audit_users.last_name),
+    child_audit_id: child_audits.id,
+    child_audit_user: child_audit_users.first_name.append(raw_param(' ')).append(child_audit_users.last_name)
+  )
+end
+```
+
+This, of course, is not the best code. 
+We're doing a lot of repetition.
+However, since AlgebraDB operates on *tables* instead of *records*, we can define some cleanup easily:
+
+
+```ruby
+##
+# Basic user table
+class User < AlgebraDB::Table
+  self.table_name = :users
+
+  column :id, :Integer
+  column :first_name, :Text
+  column :last_name, :Text
+
+  ##
+  # Instances are a *table in a query*, so this works!
+  def full_name
+    first_name.concat(AlgebraDB::Build.param(' ')).concat(last_name)
+  end
+end
+
+##
+# Audit log for users
+class UserAudit < AlgebraDB::Table
+  self.table_name = :user_audits
+
+  column :id, :Integer
+  column :user_id, :Integer
+  column :scopes_granted, AlgebraDB::Value::Array::Text
+  column :changes, AlgebraDB::Value::JSONB
+
+  relationship :user, User do |user|
+    user.id.eq(user_id)
+  end
+
+  relationship :similar_audits, UserAudit do |other_audit|
+    other_audit.scopes_granted.overlaps(scopes_granted).and(
+      other_audit.id.neq(id)
+    )
+  end
+end
+```
+
+Now we only need to write:
+
+```ruby
+AlgebraDB::Statement::Select.run_syntax do
+  parent_audits = all(UserAudit)
+  parent_audit_users = join_relationship(parent_audits.user)
+  child_audits = join_relationship(parent_audits.similar_audits)
+  child_audit_users = join_relationship(child_audits.user)
+  select(
+    parent_audit_id: parent_audits.id,
+    parent_audit_user: parent_audit_users.full_name,
+    child_audit_id: child_audits.id,
+    child_audit_user: child_audit_users.full_name
+  )
+end
+```
+
+Notice a few things we did here that make this moderately magic:
+
+1. We joined in the same table multiple times very, very easily.
+   These tables have different aliases in the query, so if we wanted only child audits by a user with a name like "bob", we could have just added a `where(child_audit_users.full_name.ilike(raw_param('Bob')))`
+2. All of the user-supplied data happens via postgres parameters.
+   We're not putting raw SQL strings *anywhere*: even the space in the `full_name` method is parameterized!
+3. We wrote an ad-hoc aliased select list, which will be converted at runtime to ruby `Struct` instances with the right keys.
+   That means we can sort those records, use them as keys in a hash, or do whatever we want, easily.
+
+In the future this will make way for powerful aggregation functionality.
+Postgres already has `ARRAY_AGG` and `JSONB_AGG`.
+Instead of making multiple queries to do eager-loading, or making one big query and then performing reassociation yourself, you'll be able to let the database (which is a hell of a lot faster than Ruby) do it for you!
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'algebra_db'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install algebra_db
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/algebra_db.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/algebra_db.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/algebra_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'algebra_db'
+  spec.version       = AlgebraDB::VERSION
+  spec.authors       = ['Anthony Super']
+  spec.email         = ['anthony@noided.media']
+
+  spec.summary       = 'Use algebra to talk to your DB'
+  spec.description   = 'A typed query builder for ruby, basically'
+  spec.homepage      = 'https://github.com/AnthonySuper/algebra_db'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/AnthonySuper/algebra_db/CHANGELOG.md'
+  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pg', '~> 1.2.3'
+
+  spec.add_development_dependency 'irb'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+end