rom-rails 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa950bd64c7498d660f81d2b6f0f6206d88b81249b6c72103a598ccc4abdeb0
-  data.tar.gz: '04184007c2c8ec6f3adf047ccb4ab7856c9fdb0bfcf84ca4f59efc91a2cce625'
+  metadata.gz: 5fce2e9329194bb83964a04c19899efea1d3f61e2c38a62f5587440a431deb7f
+  data.tar.gz: cf7aac16519079bec773b5fa2799199212989c8c8b36c4afd7e2d44eee1032ee
 SHA512:
-  metadata.gz: 19289d877377affe80deede5ec1a195252354a6ab2ade3a2ce80b3c0c543295e57ba409e333c4199b38fdec08bea59b027f2eff47cc55af54e18dc5d7ad26884
-  data.tar.gz: 20199e51ec01cb205650c000bb6f79980c764ce1797634130bf73808e2038cc346aea47d6ef3aadd35ec42a8a9b14103769ac3a558bb084aa2a5f56e95a0388a
+  metadata.gz: 846026a514b5aa386cbba31d68e1b643894fb729ef6ee08b3e72dd9b289609b98ca31fe87f431abbfd3cb950c6e42639e89445d96202705c91ed06be14962f4f
+  data.tar.gz: 0b3d2dbeaa5c848b52f8d143b79a191fb2ec0a1a08783c7100720abbb74a36ae840c55a41f8ddddc0cf323045f81d10fc5baa638a7bd07325c31edc9cf3a2690

data/.github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md

@@ -0,0 +1,10 @@
+---
+name: "⚠️  Please don't ask for support via issues"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/ISSUE_TEMPLATE/---bug-report.md

@@ -0,0 +1,30 @@
+---
+name: "\U0001F41B Bug report"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Before you submit this: WE ONLY ACCEPT BUG REPORTS AND FEATURE REQUESTS**
+
+For more information see [our contribution guidelines](https://github.com/rom-rb/rom/blob/master/CONTRIBUTING.md)
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Provide detailed steps to reproduce, an executable script would be best.
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Your environment**
+
+- Affects my production application: **YES/NO**
+- Ruby version: ...
+- OS: ...

data/.github/ISSUE_TEMPLATE/---feature-request.md

@@ -0,0 +1,18 @@
+---
+name: "\U0001F6E0 Feature request"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+Summary of what the feature is supposed to do.
+
+## Examples
+
+Code examples showing how the feature could be used.
+
+## Resources
+
+Additional information, like a link to the discussion forum thread where the feature was discussed etc.

data/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+---
+name: ci
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/ci.yml"
+      - lib/**
+      - "*.gemspec"
+      - spec/**
+      - db/migrate/**
+      - Rakefile
+      - Gemfile
+      - ".rubocop.yml"
+  pull_request:
+    branches:
+      - master
+  create:
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '2.6'
+          - '2.5'
+          - '2.4'
+          - jruby
+        rails:
+          - "6.1.0"
+          - "6.0.0"
+          - "5.2.0"
+          - "5.1.0"
+          - "5.0.0"
+          - "4.2.0"
+        exclude:
+          - ruby: "2.4"
+            rails: "6.0.0"
+          - ruby: "2.4"
+            rails: "6.1.0"
+          - ruby: "2.7"
+            rails: "4.2.0"
+    env:
+      APT_DEPS: libsqlite3-dev
+      RAILS_VERSION: "${{matrix.rails}}"
+      RAILS_ENV: test
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{matrix.ruby}}"
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+          bundle config set without 'tools benchmarks docs'
+      - name: Bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        run: bundle exec rake app:db:reset app:spec

data/.github/workflows/docsite.yml

@@ -0,0 +1,34 @@
+# this file is managed by rom-rb/devtools project
+
+name: docsite
+
+on:
+  push:
+    paths:
+      - docsite/**
+      - .github/workflows/docsite.yml
+    branches:
+      - master
+      - release-**
+    tags:
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.6.x"
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without benchmarks sql
+      - name: Symlink ossy
+        run: mkdir -p bin && ln -sf "$(bundle show ossy)/bin/ossy" bin/ossy
+      - name: Trigger rom-rb.org deploy
+        env:
+          GITHUB_LOGIN: rom-bot
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: bin/ossy github workflow rom-rb/rom-rb.org ci

data/.github/workflows/sync_configs.yml

@@ -0,0 +1,30 @@
+# this file is managed by rom-rb/devtools project
+
+name: sync_configs
+
+on:
+  repository_dispatch:
+
+jobs:
+  sync-configs:
+    runs-on: ubuntu-latest
+    if: github.event.action == 'sync_configs'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Update configuration files from devtools
+        env:
+          GITHUB_LOGIN: ${{ github.actor }}
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: |
+          git clone https://github.com/rom-rb/devtools.git tmp/devtools
+
+          rsync -av tmp/devtools/shared/ .
+
+          git config --local user.email "rom-bot@rom-rb.org"
+          git config --local user.name "rom-bot"
+          git add -A
+          git commit -m "[devtools] config sync" || echo "nothing changed"
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GH_PAT }}

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v2.3.0 2021-03-20
+
+### Changed
+
+* Updated dependencies to allow Rails 6.1 (alex-lairan)
+
 ## v2.2.0 2019-09-12
 
 ### Changed

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-RAILS_VERSION = ENV.fetch("RAILS_VERSION", '6.0.0').freeze
+RAILS_VERSION = ENV.fetch("RAILS_VERSION", '6.1.1').freeze
 
 %w(railties actionview actionpack activerecord).each do |name|
   gem name, "~> #{RAILS_VERSION}"
@@ -11,13 +11,22 @@ end
 gem 'byebug', platforms: :mri
 gem 'sqlite3', platforms: [:mri, :rbx]
 
-gem 'rom', git: 'https://github.com/rom-rb/rom', branch: 'master' do
-  gem 'rom-core'
-  gem 'rom-mapper'
-  gem 'rom-repository', group: :tools
-end
 
-gem 'rom-sql', github: 'rom-rb/rom-sql', branch: 'master'
+
+if ENV["USE_ROM_MASTER"].eql?("true")
+  gem 'rom', git: 'https://github.com/rom-rb/rom', branch: 'master' do
+    gem 'rom-core'
+    gem 'rom-mapper'
+    gem 'rom-repository', group: :tools
+  end
+
+  gem 'rom-sql', github: 'rom-rb/rom-sql', branch: 'master'
+else
+  gem "rom"
+  gem "rom-sql"
+
+  gem "sequel", "5.31.0"
+end
 
 platforms :jruby do
   gem 'jdbc-sqlite3'
@@ -26,7 +35,7 @@ end
 group :test do
   gem 'capybara'
   gem 'codeclimate-test-reporter', require: nil
-  gem 'database_cleaner'
+  gem 'database_cleaner', "~> 1.8.1"
   gem 'generator_spec'
   gem 'rack-test'
   gem 'rspec-rails', '~> 3.1'

data/README.md

@@ -1,5 +1,5 @@
 [gem]: https://rubygems.org/gems/rom-rails
-[travis]: https://travis-ci.org/rom-rb/rom-rails
+[actions]: https://github.com/rom-rb/rom-rails/actions
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-rails
 [coveralls]: https://coveralls.io/r/rom-rb/rom-rails
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-rails
@@ -7,7 +7,7 @@
 # rom-rails
 
 [![Gem Version](https://badge.fury.io/rb/rom-rails.svg)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom-rails.svg?branch=master)][travis]
+[![CI Status](https://github.com/rom-rb/rom-rails/workflows/ci/badge.svg)][actions]
 [![Code Climate](https://codeclimate.com/github/rom-rb/rom-rails/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/rom-rb/rom-rails/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-rails.svg?branch=master)][inchpages]
@@ -32,7 +32,7 @@ To run tests:
 You can read more about ROM and Rails on the official website:
 
 * [Introduction to ROM](http://rom-rb.org/learn/)
-* [Rails setup](http://rom-rb.org/learn/getting-started/rails-setup/)
+* [Rails setup](http://rom-rb.org/learn/rails/)
 
 
 ## Community

data/docsite/source/index.html.md

@@ -0,0 +1,165 @@
+---
+position: 3
+chapter: Rails
+title: Setup
+---
+
+Rails integration is provided by [rom-rails](https://github.com/rom-rb/rom-rails) project. Simply add it to your Gemfile:
+
+``` ruby
+gem 'rom-rails'
+```
+
+## Configuring Railtie
+
+Create a rom initializer:
+
+``` ruby
+# config/initializers/rom.rb
+ROM::Rails::Railtie.configure do |config|
+  config.gateways[:default] = [:sql, ENV.fetch('DATABASE_URL')]
+end
+```
+
+You can provide additional adapter-specific options, for example you can enable specific sql plugins for postgres:
+
+``` ruby
+# config/initializers/rom.rb
+ROM::Rails::Railtie.configure do |config|
+  config.gateways[:default] = [:sql,
+    ENV.fetch('DATABASE_URL'), extensions: [:pg_hstore]
+  ]
+end
+```
+
+You can also provide a list of relations that should not be inferred from your schema automatically:
+
+``` ruby
+# config/initializers/rom.rb
+ROM::Rails::Railtie.configure do |config|
+  config.gateways[:default] = [:sql,
+    ENV.fetch('DATABASE_URL'), not_inferrable_relations: [:schema_migrations]
+  ]
+end
+```
+
+## Migration Tasks
+
+The railtie provides rake tasks for managing your database schema. You need to enable them in your `Rakefile`:
+
+``` ruby
+require 'rom/sql/rake_task'
+```
+
+After that, you have access to following tasks:
+
+* `rake db:create_migration[migration_name]` - creates a new migration file
+* `rake db:migrate` - runs pending migrations
+* `rake db:clean` - cleans the database
+* `rake db:reset` - drops tables and re-runs migrations
+
+## Accessing Container
+
+In Rails environment ROM container is accessible via `ROM.env`:
+
+``` ruby
+ROM.env # returns the container
+```
+
+In your controllers you can access ROM container by `rom` variable:
+
+``` ruby
+class UsersController < ApplicationController
+  def show
+    @user = rom.relation(:users).by_id(params[:id]).one
+  end
+end
+```
+
+^WARNING
+Accessing the global container directly is considered as a bad practice. The recommended way is to use a DI mechanism to inject specific ROM components as dependencies into your objects.
+
+For example you can use [dry-container](https://github.com/dryrb/dry-container) and [dry-auto_inject](https://github.com/dryrb/dry-auto_inject) to define your own application container and specify dependencies there to have them automatically injected.
+
+See [rom-rails-skeleton](https://github.com/solnic/rom-rails-skeleton) for an example of such setup.
+^
+
+## Defining Relations
+
+Relation class definitions are automatically loaded from `app/relations`. The following code defines a `users` relation for the `:sql` adapter:
+
+``` ruby
+class Users < ROM::Relation[:sql]
+  # some methods
+end
+
+# access registered relation via container
+ROM.env.relations[:users]
+```
+
+## Defining Commands
+
+Command class definitions are automatically loaded from `app/commands`. The following code defines a command which inserts data into `users` relation:
+
+``` ruby
+# app/commands/create_user.rb
+class CreateUser < ROM::Commands::Create[:sql]
+  relation :users
+  register_as :create
+  result :one
+end
+
+# access registered relation via container
+ROM.env.commands[:users][:create]
+```
+
+## Defining Custom Mappers
+
+If you want to use custom mappers you can place them under `app/mappers`:
+
+``` ruby
+# app/mappers/user_mapper.rb
+class UserMapper < ROM::Mapper
+  relation :users
+
+  # some mapping logic
+end
+```
+
+## Running alongside ActiveRecord
+
+There might be some cases where you will want to run ROM alongside ActiveRecord. Since ROM is designed to work independently, you will need to take few additional steps. ROM creates its own connections and Rails above version 5 won't allow you to drop the database since there are active connections on it.
+
+``` ruby
+# lib/tasks/db.rake
+task :remove_rom_connection => [:environment] do
+  ROM.env && ROM.env.disconnect
+end
+
+Rake::Task["db:drop"].clear_prerequisites()
+Rake::Task["db:drop"].enhance [:remove_rom_connection, :load_config, :check_protected_environments]
+
+Rake::Task["db:reset"].clear_prerequisites()
+Rake::Task["db:reset"].enhance [:remove_rom_connection, "db:drop", "db:setup"]
+```
+
+Since migrations (and other) tasks require environment, ROM will be loaded and will throw an exception, because relations will try to load tables before migrations have actually run. We know this is an ugly solution, but we are working hard to solve this case. This monkey patch will give you reasonable information to act upon if the necessity arises.
+
+``` ruby
+# config/initializers/rom_monkey.rb
+module ROM
+  module Rails
+    class Railtie < ::Rails::Railtie
+      alias_method :create_container!, :create_container
+      def create_container
+        begin
+          create_container!
+        rescue => e
+          puts "Container failed to initialize because of #{e.inspect}"
+          puts "This message comes from the monkey patch in #{__FILE__}, if you are using rake, then this is fine"
+        end
+      end
+    end
+  end
+end
+```

data/lib/rom/rails/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Rails
-    VERSION = '2.2.0'.freeze
+    VERSION = '2.3.0'.freeze
   end
 end

data/rom-rails.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'addressable', '~> 2.3'
-  spec.add_runtime_dependency 'dry-core', '~> 0.3'
+  spec.add_runtime_dependency 'dry-core', '~> 0.4'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'railties', '>= 3.0', '< 6.1'
-  spec.add_runtime_dependency 'rom', '~> 5.0'
+  spec.add_runtime_dependency 'railties', '>= 3.0', '< 6.2'
+  spec.add_runtime_dependency 'rom', '~> 5.2'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Chris Flipse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +62,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -72,21 +72,21 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,10 +151,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
+- ".github/ISSUE_TEMPLATE/---bug-report.md"
+- ".github/ISSUE_TEMPLATE/---feature-request.md"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docsite.yml"
+- ".github/workflows/sync_configs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -162,6 +167,7 @@ files:
 - README.md
 - Rakefile
 - db
+- docsite/source/index.html.md
 - lib/generators/rom.rb
 - lib/generators/rom/commands/templates/create.rb.erb
 - lib/generators/rom/commands/templates/delete.rb.erb

data/.travis.yml

@@ -1,27 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-bundler_args: --without yard guard benchmarks
-script: "RAILS_ENV=test bundle exec rake app:db:reset app:spec"
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-  - jruby-9.2.7.0
-env:
-  - RAILS_VERSION=6.0
-  - RAILS_VERSION=5.2
-  - RAILS_VERSION=5.1
-  - RAILS_VERSION=5.0
-  - RAILS_VERSION=4.2
-notifications:
-  webhooks:
-    urls:
-      - https://rom-rb.zulipchat.com/api/v1/external/travis?api_key=S1S2GRkXHlzlaCGyUwm7o4lg50IZrwCH&stream=notifications&topic=ci
-    on_success: change
-    on_failure: always
-    on_start: false
-matrix:
-  exclude:
-    - rvm: 2.4.6
-      env: RAILS_VERSION=6.0