better_batch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cc3b9f2cc9e37f55a2c78f05c4c6e5b97a9d08030b0fc791d68286c76301a3a
+  data.tar.gz: e29d0257f1656ff93375ddbd6b3928256a90f9a5dc3d499fd7360acc626eac24
+SHA512:
+  metadata.gz: a1dfea45b6940be0add55d6f4f7567dbc3c57f30e8db76d22032b12190050a26aab7b59dc1b18e91f0455ed1300850079a3fd249af3857d269366f774848f749
+  data.tar.gz: cefa7b0d4d121ed2c7bfcc74dcaa0dd77313076a3667ad07cade336c8a9bf10af53b868995112b8b9c9148bc6f4708571b97085106eaa97442269f531acc3b67

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+RSpec/ContextWording:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-04
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Tyler Hartland
+
+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,62 @@
+# BetterBatch
+
+BetterBatch is a SQL query builder that allows upserting batches of data to a database and always getting ids in the result in the order the data was given. Using a BetterBatch query makes working with your data easier and less error prone.
+
+The gem requires lots of information about your database to build queries. I may create `better_batch-active_record` for a more streamlined interface, but you may still find this more direct example useful.
+
+For now, only Postgres is supported.
+
+## Installation
+
+In your Gemfile:
+```ruby
+source 'https://rubygems.org'
+gem 'lazier_data'
+```
+Then:
+`bundle`
+
+## Usage
+
+```ruby
+table_name = :the_table
+primary_key = :the_primary_key
+columns = %i[column_a column_b column_c]
+column_types = {
+  column_a: 'character varying(200)',
+  column_b: 'bigint',
+  column_c: 'text'
+}
+unique_columns = %i[column_b column_c]
+
+query = BetterBatch::Query.new(
+  table_name:,
+  primary_key:,
+  columns:,
+  column_types:,
+  unique_columns:
+)
+
+data = [
+  { column_a: 'column_a data 1', column_b: 1, column_c: 'column_c data 1'},
+  { column_a: 'column_a data 2', column_b: 2, column_c: 'column_c data 2'},
+]
+json_data = JSON.generate(data)
+conn = PG.connect(dbname: 'mydb')
+p conn.exec_params(query.select, [json_data]).values
+p conn.exec_params(query.upsert, [json_data]).values
+p conn.exec_params(query.select, [json_data]).values
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/th7/better_batch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/th7/better_batch/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BetterBatch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/th7/better_batch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/better_batch/query.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module BetterBatch
+  class Query # rubocop:disable Metrics/ClassLength
+    SELECT_TEMPLATE = <<~SQL
+      select id from (%<selected_inner>s)
+      order by ordinal
+    SQL
+
+    UPSERT_TEMPLATE = <<~SQL
+      with selected as (
+        %<selected_inner>s
+      )
+      ,inserted as (
+        %<inserted_inner>s
+      )
+      %<updated_clause>s
+      select coalesce(selected.id, inserted.id) as id
+      from selected left join inserted using(%<query_columns_text>s)
+      order by selected.ordinal
+    SQL
+
+    SELECTED_INNER_TEMPLATE = <<~SQL
+      select %<table_name>s.%<primary_key>s as id, %<input_columns_text>s, ordinal
+       from rows from (
+         jsonb_to_recordset($1)
+         as (%<typed_columns_text>s)
+       ) with ordinality as input(%<columns_text>s, ordinal)
+       left join %<table_name>s
+       using(%<query_columns_text>s)
+    SQL
+
+    INSERTED_INNER_TEMPLATE = <<~SQL
+      insert into %<table_name>s (%<columns_text>s, created_at, updated_at)
+        select distinct on (%<query_columns_text>s)
+          %<columns_text>s, now() as created_at, now() as updated_at
+        from selected
+        where id is null
+        returning id, %<query_columns_text>s
+    SQL
+
+    UPDATED_INNER_TEMPLATE = <<~SQL
+      update %<table_name>s
+      set %<update_columns_text>s, updated_at = now()
+      from selected where %<table_name>s.id = selected.id
+    SQL
+
+    def initialize(table_name:, primary_key:, columns:, column_types:, unique_columns:)
+      @table_name = table_name
+      @primary_key = primary_key
+      @columns = columns
+      @column_types = column_types
+      @unique_columns = unique_columns
+    end
+
+    def select
+      format(SELECT_TEMPLATE, selected_inner:)
+    end
+
+    def upsert
+      params = { selected_inner:, inserted_inner:, updated_clause:, query_columns_text: }
+      format(UPSERT_TEMPLATE, **params)
+    end
+
+    private
+
+    attr_reader :table_name, :columns, :column_types, :unique_columns, :primary_key
+
+    def selected_inner
+      @selected_inner ||= build_selected_inner
+    end
+
+    def build_selected_inner
+      params = { table_name:, primary_key:, input_columns_text:, typed_columns_text:, columns_text:,
+                 query_columns_text: }
+      format(SELECTED_INNER_TEMPLATE, **params)
+    end
+
+    def inserted_inner
+      @inserted_inner ||= build_inserted_inner
+    end
+
+    def build_inserted_inner
+      format(INSERTED_INNER_TEMPLATE, table_name:, columns_text:, query_columns_text:)
+    end
+
+    def updated_clause
+      @updated_clause ||= build_updated_clause
+    end
+
+    def build_updated_clause
+      if update_columns.empty?
+        "\n"
+      else
+        updated_clause_template = <<~SQL
+          ,updated as (
+            %<updated_inner>s
+          )
+        SQL
+        format(updated_clause_template, updated_inner:)
+      end
+    end
+
+    def updated_inner
+      @updated_inner ||= build_updated_inner
+    end
+
+    def build_updated_inner
+      format(UPDATED_INNER_TEMPLATE, table_name:, update_columns_text:)
+    end
+
+    def input_columns_text
+      @input_columns_text ||= columns.map { |c| "input.#{c}" }.join(', ')
+    end
+
+    def typed_columns_text
+      @typed_columns_text ||= column_types.map { |pair| pair.join(' ') }.join(', ')
+    end
+
+    def columns_text
+      @columns_text ||= columns.join(', ')
+    end
+
+    def query_columns_text
+      @query_columns_text ||= unique_columns.join(', ')
+    end
+
+    def update_columns
+      @update_columns ||= columns - unique_columns
+    end
+
+    def update_columns_text
+      @update_columns_text ||= update_columns.map { |c| "#{c} = selected.#{c}" }.join(', ')
+    end
+  end
+end

data/lib/better_batch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BetterBatch
+  VERSION = '0.1.0'
+end

data/lib/better_batch.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'better_batch/version'
+
+module BetterBatch
+  class Error < StandardError; end
+end

data/sig/better_batch.rbs

@@ -0,0 +1,4 @@
+module BetterBatch
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: better_batch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Hartland
+bindir: exe
+cert_chain: []
+date: 2025-04-12 00:00:00.000000000 Z
+dependencies: []
+email:
+- tylerhartland7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/better_batch.rb
+- lib/better_batch/query.rb
+- lib/better_batch/version.rb
+- sig/better_batch.rbs
+homepage: https://github.com/th7/better_batch
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/th7/better_batch
+  source_code_uri: https://github.com/th7/better_batch
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A simple SQL query builder for better batch operations.
+test_files: []