base-branch 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e2264402672cf79639cafc4a71581fe5ed1a064
+  data.tar.gz: cf31201887d4aae2b7603e5256baa513641591b3
+SHA512:
+  metadata.gz: 3b4be4f7bb367833a7f6840ea5791f656b38d2f447eab6d1659f0dd9aa03e6fb842686753c4722d6c4a84a032862adeb1a8b049825a89b5480b6a8ed95842fa8
+  data.tar.gz: 1362ccf87e9fa92f96dd26c019805991023cb2287862830eaec57249d5c46ca4f99d113a7ca4836d4a31f456faf4f3c52d2fcb647782c538ef01aa5f595e991b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+/test/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,68 @@
+# BaseBranch
+
+A simple gem to which automatically manages unique databases across code repository branches for Rails projects.
+
+## Description
+
+This gem is designed for people who actively work across multiple branches for Rails projects. Quite often, each of these branches come with a set of database migrations that are not finalized.
+Base Branch attempts to solve this issue by creating unique databases namespaced by the feature branch names and cloning the data in from the default database.
+ 
+Using BaseBranch, it is assured that
+
+  1. Feature Branches have a clean environment to work from.
+  2. The default database tied to master branch will not suffer from migration artifacts from unmerged feature branches.
+  3. Developers can drop and recreate databases used for feature branches with a peace of mind :) 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base-branch', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install base-branch
+    
+After installation, run:
+
+    $ rails g base_branch:install
+    
+to complete the configuration process.
+
+## Usage
+
+### When creating branches:
+
+Run:
+
+    $ rake base_branch:create_branch
+    
+to create a branch specific database. If branch specific database is not present, the default database will be used when the app loads.
+
+You may have to run a `spring stop` afterwards if you are using the `spring` gem in order to load the correct database.
+
+## To-dos
+
+  1. Create a task to check against merged feature branches and clean up the corresponding databases
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/KernCheh/base-branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/base-branch.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'base_branch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'base-branch'
+  spec.version       = BaseBranch::VERSION
+  spec.authors       = ['Sim Kern Cheh']
+  spec.email         = ['kern.cheh@gmail.com']
+
+  spec.summary       = %q{Create and clone databases easily for your feature branches in Rails projects.}
+  spec.description   = %q{Create and clone databases easily for your feature branches in Rails projects.}
+  spec.homepage      = 'https://github.com/KernCheh/base-branch'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_development_dependency 'rr', '~> 1.1'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'base-branch'
+
+# 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

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/lib/base-branch.rb

@@ -0,0 +1,14 @@
+require 'base_branch/version'
+
+module BaseBranch
+end
+
+require 'base_branch/git_branch'
+require 'base_branch/base_branch_exceptions/default_database_unset'
+require 'base_branch/base_branch_exceptions/uninitialized_repository'
+require 'base_branch/database/active_database'
+require 'base_branch/database/adapter/base'
+require 'base_branch/database/adapter/postgresql'
+
+# Railtie
+require 'base_branch/railtie' if defined?(Rails)

data/lib/base_branch/base_branch_exceptions/default_database_unset.rb

@@ -0,0 +1,4 @@
+module BaseBranch::BaseBranchExceptions
+  class DefaultDatabaseUnset < StandardError
+  end
+end

data/lib/base_branch/base_branch_exceptions/uninitialized_repository.rb

@@ -0,0 +1,4 @@
+module BaseBranch::BaseBranchExceptions
+  class UninitializedRepository < StandardError
+  end
+end

data/lib/base_branch/database/active_database.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+require 'active_support/inflector'
+
+module BaseBranch::Database
+  class ActiveDatabase
+    class << self
+      def database_name
+        branch_specific_db || default_db_name
+      end
+
+      def default_db_name
+        @_default_db_name ||= begin
+          YAML::load_file(File.join(Rails.root, 'config', 'base_branch.yml'))['default_db']
+        rescue Errno::ENOENT => e
+          warn 'Please run `rails g base_branch:install`'
+          nil
+        end
+      end
+
+      def branch_specific_db
+        db_name = branch_specific_db_name
+        branch_db_present?(db_name) ? db_name : nil
+      end
+
+      def branch_specific_db_name
+        current_branch = BaseBranch::GitBranch.current_branch
+
+        unless current_branch == 'master'
+           "#{default_db_name}-#{current_branch.gsub('/', '_')}"
+        end
+      end
+
+      def create_branch_db
+        unless branch_specific_db
+          new_db_name = branch_specific_db_name
+          adapter.clone_db new_db_name, default_db_name, db_user
+        end
+
+        new_db_name
+      end
+
+      def branch_config
+        @_branch_config ||= begin
+          if File.exists?(File.join(Rails.root, '.base_branch.yml'))
+            YAML::load_file(File.join(Rails.root, '.base_branch.yml'))
+          else
+            {
+              'branches' => []
+            }
+          end
+        end
+      end
+
+      def branch_db_present?(db_name)
+        return nil unless db_name
+
+        branch_config['branches'].include?(db_name)
+      end
+
+      def current
+        rails_db_config['development']['database']
+      end
+
+      def adapter
+        "BaseBranch::Database::Adapter::#{rails_db_config['development']['adapter'].classify}"
+          .constantize
+      end
+
+      def db_user
+        rails_db_config['development']['username']
+      end
+
+      def rails_db_config
+        Rails.configuration.database_configuration
+      end
+    end
+
+    private_class_method :branch_db_present?, :current, :adapter, :db_user, :rails_db_config
+  end
+end

data/lib/base_branch/database/adapter/base.rb

@@ -0,0 +1,19 @@
+module BaseBranch::Database
+  module Adapter
+    class Base
+      class << self
+        def orm_execute(stmt)
+          ActiveRecord::Base.connection.execute stmt
+        end
+
+        def orm_sanitize(field)
+          ActiveRecord::Base.sanitize field
+        end
+
+        def orm_successfully_executed?(result)
+          result.result_status == 1
+        end
+      end
+    end
+  end
+end

data/lib/base_branch/database/adapter/postgresql.rb

@@ -0,0 +1,29 @@
+module BaseBranch::Database::Adapter
+  class Postgresql < Base
+    class << self
+      def clone_db(db_name, from_db, db_user)
+        result =  if db_user
+                    orm_execute <<-SQL
+                      CREATE DATABASE "#{db_name}" WITH TEMPLATE "#{from_db}" OWNER #{db_user};
+                    SQL
+                  else
+                    orm_execute <<-SQL
+                      CREATE DATABASE "#{db_name}" WITH TEMPLATE "#{from_db}";
+                    SQL
+                  end
+
+
+        orm_successfully_executed? result
+      end
+
+      def db_present?(db_name)
+        field_name = orm_sanitize db_name
+        result = orm_execute <<-SQL
+          SELECT 1 from pg_database WHERE datname=#{field_name};
+        SQL
+
+        result.count > 0
+      end
+    end
+  end
+end

data/lib/base_branch/git_branch.rb

@@ -0,0 +1,22 @@
+class BaseBranch::GitBranch
+  class << self
+    def current_branch
+      raise(
+        BaseBranch::BaseBranchExceptions::UninitializedRepository,
+        'Please initialize a git repository and have at least one branch.'
+      ) if (branchez = branches).empty?
+
+      (branchez.detect { |br| br[0, 2] == '* ' } || '').gsub('* ', '').chomp
+    end
+
+    def master?
+      current_branch == 'master'
+    end
+
+    def branches
+      `git branch -a`.split("\n")
+    end
+  end
+
+  private_class_method :branches
+end

data/lib/base_branch/railtie.rb

@@ -0,0 +1,19 @@
+module BaseBranch
+  class Railtie < Rails::Railtie
+    railtie_name :base_branch
+
+    rake_tasks do
+      load 'tasks/create_branch.rake'
+    end
+
+    initializer 'Base Branch initializer' do
+      ActiveSupport.on_load(:action_controller) do
+        include BaseBranch
+      end
+    end
+
+    generators do
+      require_relative '../generators/base_branch/install_generator'
+    end
+  end
+end

data/lib/base_branch/version.rb

@@ -0,0 +1,3 @@
+module BaseBranch
+  VERSION = '0.1.1'
+end

data/lib/generators/base_branch/install_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/base'
+
+module BaseBranch
+  class InstallGenerator < Rails::Generators::Base
+    class_option :default_db
+
+    desc 'This generator creates an configuration file at config/base_branch.yml'
+    def create_initializer_file
+      db_name = options[:default_db]
+
+      if !db_name || db_name.empty?
+        say('What is the name of your default development database? (Leave blank if unchanged from database.yml)')
+        db_name = ask('Database Name: ')
+      end
+
+      db_name = Rails.configuration.database_configuration['development']['database'] if db_name.empty?
+
+      create_file 'config/base_branch.yml', <<-YAML
+# This file is automatically generated from `rails g base_branch:initializer`
+
+default_db: '#{db_name}'
+      YAML
+
+      database_yml = File.join(Rails.root, 'config', 'database.yml')
+      database_config = YAML::load_file(database_yml)
+      dev_database_name = database_config['development']['database']
+
+      database_yml_lines = IO.readlines(database_yml)
+      database_yml_lines = database_yml_lines
+                             .map{|s| s.gsub(dev_database_name, "<%= defined?(BaseBranch) ? BaseBranch::Database::ActiveDatabase.database_name : '#{dev_database_name}' %>")}
+
+      File.open(database_yml, 'w') do |file|
+        file.puts database_yml_lines
+        file.close
+      end
+
+      append_to_file '.gitignore', <<-FILE
+
+# Do not check in base-branch files into SCM
+config/base_branch.yml
+.base_branch.yml
+      FILE
+    end
+  end
+end

data/lib/tasks/create_branch.rake

@@ -0,0 +1,17 @@
+namespace :base_branch do
+  desc 'Branch DB'
+  task create_branch: :environment do
+    puts 'Cloning DB for current branch'
+
+    config = BaseBranch::Database::ActiveDatabase.branch_config
+
+    new_branch = BaseBranch::Database::ActiveDatabase.create_branch_db
+    config['branches'] << new_branch
+
+    File.open(File.join(Rails.root, '.base_branch.yml'), 'w') do |f|
+      f.write config.to_yaml
+    end
+
+    puts "New database: #{new_branch}"
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: base-branch
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sim Kern Cheh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Create and clone databases easily for your feature branches in Rails
+  projects.
+email:
+- kern.cheh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- base-branch.gemspec
+- bin/console
+- bin/setup
+- lib/base-branch.rb
+- lib/base_branch/base_branch_exceptions/default_database_unset.rb
+- lib/base_branch/base_branch_exceptions/uninitialized_repository.rb
+- lib/base_branch/database/active_database.rb
+- lib/base_branch/database/adapter/base.rb
+- lib/base_branch/database/adapter/postgresql.rb
+- lib/base_branch/git_branch.rb
+- lib/base_branch/railtie.rb
+- lib/base_branch/version.rb
+- lib/generators/base_branch/install_generator.rb
+- lib/tasks/create_branch.rake
+homepage: https://github.com/KernCheh/base-branch
+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.1
+signing_key: 
+specification_version: 4
+summary: Create and clone databases easily for your feature branches in Rails projects.
+test_files: []