activerecord-duckdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97d9df88d9ae4959d62c3013357973776dc52924ef38a0fadfd40fc402adb24f
+  data.tar.gz: c4606b422388e260c70522896dc14773d01c963e3cbdb77dc1fbb03e3676904a
+SHA512:
+  metadata.gz: 0ec798db2626955dc20f0f5b531d669bb9352669f8fc3f25975da97f3ec8a083fd110c266dcd58e3167a4e0a4a6b516ee7ad128b17537a530508ffba25fd1bd9
+  data.tar.gz: 48674bbaaf8518907bfaec87833c0547706d2c5d05d117972f045496977a4edf32a8ee2c0d9c4ffa96c3eee11c2e8236eb374728e7fbb3656afdd4081d71f8e5

data/.fasterer.yml

@@ -0,0 +1,31 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: false
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
+exclude_paths:
+  - ".yardoc/"
+  - "bin/"
+  - "coverage/"
+  - "docs/"
+  - "log/"
+  - "sorbet/"
+  - "tmp/**/**"
+  - "vendor/**/**"
+  - "**.yml"
+  - "**.md"

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,105 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-thread_safety
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  UseCache: true
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/DuplicateBranch:
+  Exclude:
+    - lib/active_record/connection_adapters/duckdb_adapter.rb
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/activerecord-duckdb.rb
+    - spec/activerecord-duckdb_spec.rb
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicatePrefix:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RedundantAssignment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+##### RSpec specific
+RSpec/DescribeClass:
+  Exclude:
+    - spec/activerecord-duckdb_spec.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Exclude:
+    - spec/activerecord-duckdb_spec.rb
+
+RSpec/UnspecifiedException:
+  Exclude:
+    - spec/support/shared_examples.rb
+
+ThreadSafety/NewThread:
+  Exclude:
+    - spec/**/*
+
+ThreadSafety/ClassAndModuleAttributes:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'simplecov' unless defined?(SimpleCov)
+require 'simplecov-tailwindcss' unless defined?(SimpleCov::Formatter::TailwindFormatter)
+
+SimpleCov.start do
+  add_filter('/bin/')
+  add_filter('/docs/')
+  add_filter('/lib/activerecord/duckdb/version.rb')
+  add_filter('/spec')
+  add_filter('/spec/support/')
+end
+SimpleCov.minimum_coverage(70)
+SimpleCov.use_merging(false)
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+                                                                  SimpleCov::Formatter::HTMLFormatter,
+                                                                  SimpleCov::Formatter::TailwindFormatter
+                                                                ])

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.2

data/.yardopts

@@ -0,0 +1,2 @@
+--title 'ActiveRecord-DuckDB'
+--exclude /lib/activerecord/duckdb/version.rb

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# 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 e-mail 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 by the project maintainers.
+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 Brandon Hicks
+
+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,168 @@
+# Activerecord::Duckdb
+
+This gem is a DuckDB database adapter for ActiveRecord.
+
+## Description
+
+Activerecord::Duckdb providers DuckDB database access for Ruby on Rails applications.
+
+~ **NOTE:** This gem is still a work in progress, so it might not work exactly as expected just yet. Some ActiveRecord features haven’t been added and/or fully tested.
+
+## Requirements
+
+This gem relies on the [ruby-duckdb](https://github.com/suketa/ruby-duckdb) ruby gem as its database adapter. Thus it provides a seamless integration with the DuckDB database.
+
+Both gems requires that you have [duckdb](https://duckdb.org). DuckDB has many installation options available that can be found on their [installation page](https://duckdb.org/docs/installation/).
+
+```ruby
+# OSx
+brew install duckdb
+
+# Most Linux distributions
+curl https://install.duckdb.org | sh
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add "activerecord-duckdb"
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install activerecord-duckdb
+```
+
+## Usage
+
+### Configuration
+
+Adjust your `database.yml` file to use the duckdb adapter.
+
+```yaml
+development:
+  adapter: duckdb
+  database: db/development.duckdb
+
+test:
+  adapter: duckdb
+  database: db/test.duckdb
+
+production:
+  adapter: duckdb
+  database: db/production.duckdb
+```
+
+Run some migrations to ensure the database is ready.
+
+```bash
+rails g model Notice name:string email:string content:string
+```
+
+```ruby
+Notice.create(name: 'John Doe', email: 'john@example.com', content: 'Something happened at work today!')
+Notice.find_by(email: 'john@example.com')
+Notice.all
+Notice.last.delete
+```
+
+~ At the moment using an in-memory database is very limited and still in development.
+**NOTE:** When using a memory database, any transactional operations will be lost when the process exits.
+The only reason I can think of is that you might want to use an in-memory database for testing purposes, data analysis, or some sort of quick calculations where the data is not critical.
+
+```yaml
+temporary_database:
+  adapter: duckdb
+  database: :memory
+```
+
+```ruby
+class User < ApplicationRecord
+  establish_connection(:temporary_database)
+end
+```
+
+Of you can set your own database configuration in the `config/database.yml` file.
+When using temporary databases you'll also have to generate your own schema on the fly rather than migrations creating them automatically.
+
+```yml
+test:
+  adapter: duckdb
+  database: :memory
+
+production:
+  adapter: duckdb
+  database: :memory
+```
+
+### Sample App setup
+
+The following steps are required to setup a sample application using the `activerecord-duckdb` gem:
+
+1. Create a new Rails application:
+
+```bash
+rails new sample_app --database=sqlite3
+```
+
+2. Add the `activerecord-duckdb` gem to your Gemfile:
+
+```ruby
+gem 'activerecord-duckdb'
+```
+
+3. Run `bundle install` to install the gem.
+
+4. Update the `config/database.yml` file to use the `duckdb` adapter:
+
+```yaml
+development:
+  adapter: duckdb
+  database: db/development.db
+
+test:
+  adapter: duckdb
+  database: :memory
+
+production:
+  adapter: duckdb
+  database: :memory
+```
+
+5. Generate a model for the sample application:
+
+```bash
+rails g model User name:string email:string
+```
+
+5. Run some migrations to ensure the database is ready:
+
+```bash
+rails db:create; rails db:migrate
+```
+
+6. Create some sample data:
+
+```ruby
+User.create(name: 'John Doe', email: 'john@example.com')
+User.create(name: 'Jane Doe', email: 'jane@example.com')
+```
+
+7. Run some queries:
+
+```ruby
+User.all
+User.find_by(email: 'john@example.com')
+User.last.delete
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tarellel/activerecord-duckdb.
+
+## 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,19 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir.glob('spec/**/*_spec.rb')
+    t.rspec_opts = '--format documentation'
+  end
+rescue LoadError
+  # If RSpec is not available, handle appropriately
+  puts 'RSpec gem not found. Please add it to your Gemfile.'
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/TODO.md

@@ -0,0 +1,16 @@
+# TODO:
+
+- Implement support DuckDB's UUID type for primary keys
+  - At the moment we use nextval because we always assume it will be a sequence Integer ID
+  - https://duckdb.org/docs/stable/sql/functions/utility#gen_random_uuid
+- Add support for additional Data Types
+  - Blob
+    - https://duckdb.org/docs/stable/sql/data_types/blob
+  - Enum
+    - https://duckdb.org/docs/stable/sql/data_types/enum
+  - List
+    - https://duckdb.org/docs/stable/sql/data_types/list
+  - Map
+    - https://duckdb.org/docs/stable/sql/data_types/map
+  - Struct
+    - https://duckdb.org/docs/stable/sql/data_types/struct