ar-uuid 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 335852436c46e3b7e54a96159f2a9d917418395d
-  data.tar.gz: 01ca25d3c78af83d0a92309f9b7ac709ba524bfa
+SHA256:
+  metadata.gz: 750147d7697999f1d3509ff6ecc6285b18d34e321794fc3ac57978c93887803a
+  data.tar.gz: 596c88e367384dd1a57d6ea57f9bfc0911da47beb26250ec60b16128655e97dc
 SHA512:
-  metadata.gz: 032d498919aaf76791ab41881cd99f55bf352649ca9136d1a9250ef72f52d05c8b5071f50e891527f0b596626efa4e9c7f8078444eaddf34740611856962a1eb
-  data.tar.gz: 3f2fa600d1cc5d4f977d7d6f54e875eea5c48d76529a7e3955a4c2dcf88ebaf5b6ee60827ac325dcf875576ab385f3731c6e5956a0a727ca6df39a665d6571ec
+  metadata.gz: 07df5b242c40693b4a324f9486c30419af3d87674e51f0353fb0d266f60b0e743780f539b3a4a0327f0861d7067609c52e0ed9d9c079c21676349907918969da
+  data.tar.gz: d2a5c5077dbaffc6e05ac725f37bf63f27d2e2ec59a045ca1b715cec025954acbc5b587745df973f75106e204b01065fa7de057ff9199b61b5d66f645b7d23ec

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [fnando]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of ar-uuid
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,70 @@
+---
+name: ruby-tests
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1"]
+        gemfile:
+          - Gemfile
+          - gemfiles/7_0.gemfile
+          - gemfiles/6_1.gemfile
+          - gemfiles/6_0.gemfile
+    services:
+      postgres:
+        image: postgres:11.5
+        ports: ["5432:5432"]
+        options:
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v3.0.2
+
+      - uses: actions/cache@v3.0.5
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Install PostgreSQL 11 client
+        run: |
+          sudo apt -y install libpq-dev
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          PGHOST: localhost
+          PGUSER: postgres
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          psql -U postgres -c "create database test"
+          bundle exec rake

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+Naming/FileName:
+  Exclude:
+    - lib/ar-uuid.rb

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## Unreleased
+
+- [Changed] Change namespace from `ActiveRecord::UUID` to `AR::UUID`.
+- [Removed] Dropped support for Rails 4.2.
+
+## v0.2.1 - 2019-11-26
+
+- No significant changes.
+
+## v0.2.0 - 2017-06-23
+
+- [Fixed] Use the first available extension for UUID generation (`pgcrypto` or
+  `uuid-ossp`).
+- [Fixed] Handle `belongs_to_required_by_default`.
+
+## v0.1.2 - 2015-05-23
+
+- [Fixed] Make sure we always override schema statements's create_table method.
+
+## v0.1.1 - 2015-04-27
+
+- Initial release.
+
+## v0.1.0 - 2015-04-27
+
+- Yanked release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@fnando.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to ar-uuid
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct](https://github.com/fnando/ar-uuid/blob/main/CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## Contributing with code
+
+Before making any radicals changes, please make sure you discuss your intention
+by [opening an issue on Github](https://github.com/fnando/ar-uuid/issues).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) ar-uuid
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+7. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `rake`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+### JavaScript code
+
+- This project uses [ESLint](https://eslint.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `yarn test:ci`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.

data/Gemfile

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
+
 gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2020 Nando Vieira
+
+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

@@ -1,37 +1,29 @@
-# ActiveRecord::UUID
+# ar-uuid
 
-[![Travis-CI](https://travis-ci.org/fnando/ar-uuid.png)](https://travis-ci.org/fnando/ar-uuid)
-[![Code Climate](https://codeclimate.com/github/fnando/ar-uuid/badges/gpa.svg)](https://codeclimate.com/github/fnando/ar-uuid)
-[![Test Coverage](https://codeclimate.com/github/fnando/ar-uuid/badges/coverage.svg)](https://codeclimate.com/github/fnando/ar-uuid/coverage)
+[![Tests](https://github.com/fnando/ar-uuid/workflows/ruby-tests/badge.svg)](https://github.com/fnando/ar-uuid)
 [![Gem](https://img.shields.io/gem/v/ar-uuid.svg)](https://rubygems.org/gems/ar-uuid)
 [![Gem](https://img.shields.io/gem/dt/ar-uuid.svg)](https://rubygems.org/gems/ar-uuid)
 
-Override migration methods to support UUID columns without having to be explicit about it.
-
-What this gem will do for you:
-
-- When creating new tables, will set the `id` column as `uuid`.
-- When creating associations with `t.belongs_to`, `t.references` or `add_reference`, will set the column type as `uuid`.
+Override migration methods to support UUID columns without having to be explicit
+about it.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+gem install ar-uuid
+```
+
+Or add the following line to your project's Gemfile:
 
 ```ruby
 gem "ar-uuid"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ar-uuid
-
 ## Usage
 
-There's no setup. Just adding the gem to your Gemfile is enough. When you create a new table, the `id` column will be defined as `uuid`. This is also true for references.
+There's no setup. Just adding the gem to your Gemfile is enough. When you create
+a new table, the `id` column will be defined as `uuid`. This is also true for
+references.
 
 ```ruby
 create_table :users
@@ -44,7 +36,8 @@ create_table :posts do |t|
 end
 ```
 
-If you need a serial column, AR's PostgreSQL supports the `bigserial` column type.
+If you need a serial column, AR's PostgreSQL supports the `bigserial` column
+type.
 
 ```ruby
 create_table :users do |t|
@@ -52,24 +45,88 @@ create_table :users do |t|
 end
 ```
 
-### Disadvantages
+### Sorting
+
+#### Rails 6.0 or newer
 
-There is one big disadvantage on using uuid identifiers: you can't use  methods like `ActiveRecord::FinderMethods::InstanceMethods#first` and `ActiveRecord::FinderMethods::InstanceMethods#last`, since they are scoped to the sequential id.
+If you're using Rails 6.0 or newer, you can set a default sorting with
+[ActiveRecord::ModelSchema.implicit_order_column](https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema.html#method-c-implicit_order_column),
+so methods like `ActiveRecord::FinderMethods::InstanceMethods#first` and
+`ActiveRecord::FinderMethods::InstanceMethods#last` will work transparently, as
+long as you define another column for sorting, such as `created_at` (you may
+need to add an index).
+
+The following example sets a default behavior to always sort using `created_at`
+(when available). On your abstract model, add the following lines:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  def self.inherited(child_class)
+    super
+
+    return unless child_class.columns.any? {|col| col.name == "created_at" }
+
+    child_class.implicit_order_column ||= "created_at"
+  end
+end
+```
 
-Instead of `.first`, you can use [ActiveRecord::FinderMethods::InstanceMethods#take](https://github.com/rails/rails/blob/f52354ad1d15120dcc5284714bee7ee3f052986c/activerecord/lib/active_record/relation/finder_methods.rb#L104), which will use the order implemented by the database.
+#### Older Rails versions
+
+For older Rails versions, you can't use methods like
+`ActiveRecord::FinderMethods::InstanceMethods#first` and
+`ActiveRecord::FinderMethods::InstanceMethods#last`, since they are scoped to
+the sequential id.
+
+The easiest alternative is ordering results and calling `first`/`last`. You can
+either create a sequence, or use the `created_at`/`updated_at` columns:
+
+```ruby
+# Get first record
+User.order(created_at: :asc).first
+
+# Get last record
+User.order(created_at: :desc).first
+
+# Use scopes
+class User < ApplicationRecord
+  scope :newer, -> { order(created_at: :desc) }
+  scope :older, -> { order(created_at: :asc) }
+end
+
+User.older.first
+User.newer.first
+```
+
+You can also replace `.first` with
+[ActiveRecord::FinderMethods::InstanceMethods#take](https://github.com/rails/rails/blob/f52354ad1d15120dcc5284714bee7ee3f052986c/activerecord/lib/active_record/relation/finder_methods.rb#L104),
+which will use the order implemented by the database.
 
 There's no alternative to `.last`.
 
-## Development
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-4
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- https://github.com/fnando/ar-uuid/contributors
 
 ## Contributing
 
-1. Fork it ( https://github.com/fnando/ar-uuid/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+For more details about how to contribute, please read
+https://github.com/fnando/ar-uuid/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/ar-uuid/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the ar-uuid project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/ar-uuid/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
+  t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
-  t.warning = false
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/ar-uuid.gemspec

@@ -1,26 +1,36 @@
-require "./lib/active_record/uuid/version"
+# frozen_string_literal: true
+
+require "./lib/ar/uuid/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ar-uuid"
-  spec.version       = ActiveRecord::UUID::VERSION
+  spec.version       = AR::UUID::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["fnando.vieira@gmail.com"]
-  spec.summary       = %[Add UUID support for ActiveRecord. It enforces uuid primary keys, fixes ActiveRecord"s first/last methods and more.]
+  spec.summary       = "Override migration methods to support UUID columns " \
+                       "without having to be explicit about it."
   spec.description   = spec.summary
   spec.homepage      = "http://rubygems.org/gems/ar-uuid"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord"
+
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest-utils"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "pry-meta"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
 end