dbcode 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6921302d6cddedad8cd57765fe94e150adbe26ef
+  data.tar.gz: e7ff40acb9567290c73f33bbede5208e4d4b72c5
+SHA512:
+  metadata.gz: 82c1d1eaf6bbbc9029819010f4d5d9b42609436299777997b6cd29dc2a95946f269c9e7a091a3da2405456afd8f67df580ce66ba7c9eb9159e583ad735cc6d12
+  data.tar.gz: e33e20612fee946d2361b590748b985c1dfd3b7c5b798c0bb1631f9f5560b42cf38c2ff978dc19c7396a2c5695203df638cc1d3c88a43ba8030c0a6042cb477d

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian Dunn
+
+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,50 @@
+# dbcode
+
+## A Database Code Pipeline for ActiveRecord
+
+### Objective
+
+Migrations are fine for mutating table structure. Even a necessary evil given some changes require carefully preserving valuable production data.
+
+Lately I've been taking advantage of more database features like constraints, views, and functions. Iterating on these during development via migrations is intolerable.
+
+dbcode will borrow from a similar out of process dependency synchronization mechanism in rails: the asset pipeline. In development mode any changes to a sql view file ought to be one refresh away. A test ran after a change to a sql view file ought to execute against the latest version. In a production deploy sql views can be bundled into a migration - just like pre-compiling assets.
+
+### Features
+
+Database code files live in a directory structure like this:
+
+    app
+    └── db
+        └── code
+            ├── functions
+            ├── triggers
+            └── views
+
+Interdependency of db/code elements is expressed via magic comments:
+
+    -- require views/foo
+
+Writing drop statements or downward migrations is not necessary.  All of your code is kept in a separate schema that is replaced when your declaration files change. Want to migrate to a previous version? Check out that revision in your SCM and connect. In test and development mode this will just work. Production is a slightly different story: read more below.
+
+#### Test
+
+dbcode ensures that the declarations in your test database are up to date. Any time you change a `db/code` file the changes will be available on your next test run. This happens automatically for tests that boot rails. If you have a test that integrates the database, but doesn't boot rails, call `DBCode.ensure_freshness!` in a before block.
+
+#### Development
+
+A request made after a change to a `db/code` file will see the latest version of that declaration.
+
+#### Production
+
+In production mode the automatic synchronization step is skipped. Connecting to a database that doesn't contain the latest version on the `code` schema will log a warning.
+
+Running migrations on the production database will do the trick. Alternatively run the task `db:code:sync`
+
+### Disclaimer
+
+* This is only intended to be used with postgresql. Your other db is 💩..
+
+* Booting into a raw psql connection will not configure your schema search to place `code` first. Try something like this in the repl: `set search_path to code,public;`
+
+* Can't be used to manage code in schemas intended for name spacing or permission control. You'll need to use migrations to manage code that lives in schemas other than `code`.

data/lib/dbcode/graph.rb

@@ -0,0 +1,42 @@
+require 'tsort'
+module DBCode
+  LoadError = Class.new RuntimeError
+
+  class Graph
+    include TSort
+
+    def initialize(files)
+      @files = (files.map {|f| { f.name => f } }.reduce(:merge) || {}).freeze
+    end
+
+    def digest
+      Digest::MD5.base64digest to_sql
+    end
+
+    def compile
+      tsort.map(&:to_sql).join(";\n")
+    end
+
+    def to_sql
+      @to_sql ||= compile
+    end
+
+    private
+
+    attr_reader :files
+
+    def tsort_each_child(file, &block)
+      file.dependency_names.each do |name|
+        dependency = files.fetch name do
+          raise LoadError, %Q{cannot load file -- #{name}}
+        end
+
+        block.call dependency
+      end
+    end
+
+    def tsort_each_node(&b)
+      files.values.each(&b)
+    end
+  end
+end

data/lib/dbcode/railtie.rb

@@ -0,0 +1,14 @@
+module DBCode
+  class Railtie < Rails::Railtie
+    initializer "dbcode.setup" do |app|
+      DBCode.sql_file_path = app.root.join 'db/code'
+      config.watchable_dirs[DBCode.sql_file_path.to_s] = ['sql']
+    end
+
+    config.to_prepare &DBCode.method(:ensure_freshness!)
+
+    rake_tasks do
+      load 'dbcode/tasks/db_code.rake'
+    end
+  end
+end

data/lib/dbcode/schema.rb

@@ -0,0 +1,77 @@
+module DBCode
+  class SearchPath
+    def initialize(path)
+      @path = path.to_s.split ','
+    end
+
+    def prepend(schema)
+      from_parts [schema] + path
+    end
+
+    def append(schema)
+      from_parts path + [schema]
+    end
+
+    def to_s
+      path.join ','
+    end
+
+    private
+    attr_reader :path
+
+    def from_parts(parts)
+      self.class.new parts.join ','
+    end
+  end
+
+  class Schema
+    attr_reader :name, :connection
+    def initialize(name:, connection:)
+      @name, @connection = name, connection
+    end
+
+    delegate :execute, to: :connection
+
+    def reset!
+      execute <<-SQL
+        drop schema if exists #@name cascade;
+        create schema #@name;
+      SQL
+    end
+
+    def digest=(digest)
+      execute <<-SQL
+        comment on schema #@name is 'dbcode_md5:#{digest}'
+      SQL
+    end
+
+    def digest
+      comment = connection.select_one <<-SQL
+        select pg_catalog.obj_description(n.oid, 'pg_namespace') as md5
+        from pg_catalog.pg_namespace n where n.nspname = '#@name'
+      SQL
+      comment && comment['md5'] =~ /^dbcode_md5:(.+)$/ && $1
+    end
+
+    def within_schema(&block)
+      old_path = search_path
+      connection.schema_search_path = old_path.prepend(name).to_s
+      connection.transaction(&block)
+      connection.schema_search_path = old_path.to_s
+    end
+
+    def append_path!(config)
+      #update all future connections
+      config.merge! schema_search_path: search_path.append(name)
+      #update all active connections
+      connection.pool.connections.each do |connection|
+        connection.schema_search_path = config[:schema_search_path]
+      end
+    end
+
+    private
+    def search_path
+      SearchPath.new(connection.schema_search_path)
+    end
+  end
+end

data/lib/dbcode/sql_file.rb

@@ -0,0 +1,21 @@
+module DBCode
+  class SQLFile
+    attr_reader :path
+
+    def initialize(path)
+      @path = Pathname(path)
+    end
+
+    def name
+      path.basename('.sql').to_s
+    end
+
+    def dependency_names
+      to_sql.scan(/^\s*-- require (\S+)\s*$/).flatten
+    end
+
+    def to_sql
+      @sql ||= path.read
+    end
+  end
+end

data/lib/dbcode/tasks/db_code.rake

@@ -0,0 +1,12 @@
+namespace :db do
+  namespace :code do
+    desc "sync the database code schema with the declaration files"
+    task sync: :environment do
+      DBCode.ensure_freshness!
+    end
+  end
+
+  task :migrate do
+    DBCode.ensure_freshness!
+  end
+end

data/lib/dbcode/version.rb

@@ -0,0 +1,3 @@
+module DBCode
+  VERSION = '0.0.1'
+end

data/lib/dbcode.rb

@@ -0,0 +1,30 @@
+module DBCode
+  autoload :SQLFile, 'dbcode/sql_file'
+  autoload :Schema, 'dbcode/schema'
+  autoload :Graph, 'dbcode/graph'
+  extend self
+  attr_accessor :sql_file_path, :code_schema_name
+  self.code_schema_name ||= 'code'
+
+  def ensure_freshness!
+    code = Schema.new connection: ActiveRecord::Base.connection, name: code_schema_name
+    code.within_schema do
+      unless code.digest == graph.digest
+        code.reset!
+        code.execute graph.to_sql
+        code.digest = graph.digest
+      end
+    end
+    code.append_path!(ActiveRecord::Base.connection_config)
+  end
+
+  def graph
+    Graph.new file_names.sort.map &SQLFile.method(:new)
+  end
+
+  def file_names
+    Dir[sql_file_path.join('**/*.sql').expand_path]
+  end
+end
+
+require 'dbcode/railtie' if defined? Rails

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dbcode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A Database Code Pipeline for ActiveRecord
+email: brian@hashrocket.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/dbcode.rb
+- lib/dbcode/graph.rb
+- lib/dbcode/railtie.rb
+- lib/dbcode/schema.rb
+- lib/dbcode/sql_file.rb
+- lib/dbcode/tasks/db_code.rake
+- lib/dbcode/version.rb
+homepage: http://github.com/briandunn/dbcode
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Database Code Pipeline for ActiveRecord
+test_files: []