phobos_db_checkpoint 1.1.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b492fa71a95e8304f837094421494f8a441a1a
-  data.tar.gz: 6470c1c13a9ab979cac8f228a725d5782e50f027
+  metadata.gz: 8926e279eed934a82a9fd0b397186d725897f71e
+  data.tar.gz: f280f58a398f03e792e4dd9a3a87772a054414f2
 SHA512:
-  metadata.gz: f2327f3693b35fb330f9af48a878dd7e825e24eadb7f43627ad348c0c48f0f9df2c72c10933bf95298faf99e02a18220348647126073db1add6e3f8705b0b1cb
-  data.tar.gz: 5cf8e5153d09340f01aab345b55ad07891ea055a8946648f503b382dd8b67adaed0ad8ff6a626ee32d8056ab5047bf55909fbcb154a4982702741bcf20924651
+  metadata.gz: 904386e41f5ae1c9273e027748b12cd56712c63dfbcfaa349b827f4101b1cff19931d73b0787665ba97158c9aebaa808b83c49e14cc1782a924d1e26b03a7781
+  data.tar.gz: 8d414cd8c50562519b2419878e880de52e1a3c2590adceced3e9a62fdc993ac126eb64d0cae5e95e891006660feb9c0b1963e6c49e8edd1770b428d952ee9bfe

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.0.0.rc1 (2017-02-28)
+
+- [enhancement] Rename tables
+
 ## 1.1.0 (2017-02-28)
 
 - [feature] Add end point for fetching individual failures

data/README.md

@@ -18,6 +18,7 @@ Phobos DB Checkpoint is a plugin to [Phobos](https://github.com/klarna/phobos) a
   1. [Accessing the events](#accessing-the-events)
   1. [Events API](#events-api)
   1. [Instrumentation](#instrumentation)
+1. [Upgrading](#upgrading)
 1. [Development](#development)
 
 ## <a name="installation"></a> Installation
@@ -295,6 +296,30 @@ The following payload is included for all notifications:
   * retry_count
   * checksum
 
+## <a name="upgrading"></a> Upgrading
+
+#### From <2.0 to 2.x
+
+##### Rename database tables
+
+The database table names for Event and Failure has been changed to be namespaced under `phobos_db_checkpoint_` to avoid potential collisions with projects that already have these names.
+
+This means that when upgrading one would have to add a new migration to rename from old name to new:
+
+```ruby
+def up
+  rename_table :events, :phobos_db_checkpoint_events
+  rename_table :failures, :phobos_db_checkpoint_failures
+end
+```
+
+Alternatively, one could potentially configure the tables to use the old names, as such:
+
+```ruby
+PhobosDBCheckpoint::Event.table_name = :events
+PhobosDBCheckpoint::Failure.table_name = :failures
+```
+
 ## <a name="development"></a> Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests.

data/lib/phobos_db_checkpoint.rb

@@ -22,6 +22,10 @@ module PhobosDBCheckpoint
     attr_reader :db_config
     attr_accessor :db_config_path, :db_dir, :migration_path
 
+    def table_name_prefix
+      :phobos_db_checkpoint_
+    end
+
     def configure(pool_size: nil)
       load_db_config(pool_size: pool_size)
       at_exit { PhobosDBCheckpoint.close_db_connection }

data/lib/phobos_db_checkpoint/version.rb

@@ -1,3 +1,3 @@
 module PhobosDBCheckpoint
-  VERSION = '1.1.0'
+  VERSION = '2.0.0.rc1'
 end

data/templates/migrate/phobos_01_create_events.rb.erb

@@ -1,6 +1,6 @@
 class Phobos01CreateEvents < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def up
-    create_table :events do |t|
+    create_table :phobos_db_checkpoint_events do |t|
       t.string    :topic,         index: true
       t.string    :group_id,      index: true
       t.string    :entity_id,     index: true
@@ -11,10 +11,10 @@ class Phobos01CreateEvents < ActiveRecord::Migration[<%= ActiveRecord::Migration
       t.json      :payload
     end
 
-    add_index :events, [:topic, :group_id, :checksum]
+    add_index :phobos_db_checkpoint_events, [:topic, :group_id, :checksum], name: :index_phobos_db_checkpoint_events_on_topic_group_id_checksum
   end
 
   def down
-    drop_table :events
+    drop_table :phobos_db_checkpoint_events
   end
 end

data/templates/migrate/phobos_02_create_failures.rb.erb

@@ -1,6 +1,6 @@
 class Phobos02CreateFailures < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def up
-    create_table :failures do |t|
+    create_table :phobos_db_checkpoint_failures do |t|
       t.timestamp :created_at,     index: false
       t.string    :topic,          index: true
       t.string    :group_id,       index: true
@@ -18,6 +18,6 @@ class Phobos02CreateFailures < ActiveRecord::Migration[<%= ActiveRecord::Migrati
   end
 
   def down
-    drop_table :failures
+    drop_table :phobos_db_checkpoint_failures
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos_db_checkpoint
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -287,9 +287,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8