id_randomizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdf2ea974f11ba68e02da672728f49f023b11a22ccab9b6fa911be068ba7021d
+  data.tar.gz: db21a556f88c4ede271079e82cf27346e03545a13cd93270d71c2ebbc2458eae
+SHA512:
+  metadata.gz: 96e3c9260ae19788dd40f04e59eb3e924f0196db92de74892aca5a3e04da38874d3d311d3b5b9ed6a413a8765bd150736bea1032ebd061f1080c67191b7df55b
+  data.tar.gz: 8e9c22e1a5753c3fe6d66fef2f3d7a326ff81565e05f5f1ac4726ccd22607836e0b6d5aa6f49af2c3f66d9a12062e767db26445ab471b5906141aeb514f2a2bb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.rubyproject
+*.rubyproject.user
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 125
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': "()"
+    '%i': "()"
+Style/StringLiterals:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '2.5.5'
+services:
+  - postgresql
+before_script:
+  - psql -c 'create database test;' -U postgres

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in id_randomizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hugo Parente Lima
+
+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,51 @@
+[![Build Status](https://travis-ci.org/hugopl/id_randomizer.svg?branch=master)](https://travis-ci.org/hugopl/id_randomizer)
+[![codecov](https://codecov.io/gh/hugopl/id_randomizer/branch/master/graph/badge.svg)](https://codecov.io/gh/hugopl/id_randomizer)
+
+# IdRandomizer
+
+Change the table sequence to a pseudo-random value to add entropy to your tests.
+
+If for some reason your tests are checking for ids of models instead of other data, this gem may avoid buggy tests to pass
+due to the fact that models in test environment always have a low id.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'id_randomizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install id_randomizer
+
+## Usage
+
+When setting up your tests:
+
+```
+IdRandomizer.randomize_ids
+```
+
+If for some reason you don't want to randomize the ids of some table, use:
+
+```
+IdRandomizer.randomize_ids(except: %w(foos bars))
+```
+
+Currently only PostgreSQL is supported.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/hugopl/id_randomizer.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "id_randomizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/id_randomizer.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'id_randomizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'id_randomizer'
+  spec.version       = IdRandomizer::VERSION
+  spec.authors       = ['Hugo Parente Lima']
+  spec.email         = ['hugo.pl@gmail.com']
+  spec.license       = 'MIT'
+  spec.summary       = 'Add more entropy to tests by randomizing all initial ids'
+  spec.description   = 'Just a method call to change the sequence_ids of all model tables found by ActiveRecord'
+  spec.homepage      = 'https://github.com/hugopl/id_randomizer'
+
+  # 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_development_dependency 'bundler'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'activerecord', '> 4.2'
+end

data/lib/id_randomizer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'id_randomizer/version'
+require 'id_randomizer/postgresql'
+
+module IdRandomizer
+  # Randomize ids/start sequences from all tables found in a given database
+  # except the blacklisted ones.
+  def self.randomize_ids(except: [])
+    case ActiveRecord::Base.connection
+    when ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+      PostgreSQL.randomize_ids(except)
+    else
+      raise 'Database adapter not supported.'
+    end
+  end
+end

data/lib/id_randomizer/postgresql.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IdRandomizer
+  module PostgreSQL
+    def self.randomize_ids(except)
+      blacklist = %w(schema_migrations ar_internal_metadata)
+      blacklist += except.is_a?(Array) ? except : [except]
+      models = ActiveRecord::Base.descendants.reject do |model|
+        model.table_name.nil? || model.sequence_name.nil? || blacklist.include?(model.table_name)
+      end
+      models.each do |model|
+        val = rand(100..1024)
+        model.connection.execute("SELECT setval('#{model.sequence_name}', #{val});")
+      end
+    end
+  end
+end

data/lib/id_randomizer/version.rb

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: id_randomizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hugo Parente Lima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Just a method call to change the sequence_ids of all model tables found
+  by ActiveRecord
+email:
+- hugo.pl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- id_randomizer.gemspec
+- lib/id_randomizer.rb
+- lib/id_randomizer/postgresql.rb
+- lib/id_randomizer/version.rb
+homepage: https://github.com/hugopl/id_randomizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Add more entropy to tests by randomizing all initial ids
+test_files: []