simple_migrator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2efb61e7bb9748832cfeee309365c8ee003ef756
+  data.tar.gz: f34e0c895d10ccebef93ed296755013edeab2b7a
+SHA512:
+  metadata.gz: 12e88647bced81100e2cc47113228f38ee60330b7255d92b3e8628af3cf61242cde89fcf3c7d3d8be829e563241e8f89ffc94af52572f3c05235fc31ef0a924c
+  data.tar.gz: 7bac0c4b19cc76546549ab740844cccc6ac755fb7d8d79bb7fc74b3f4b8bda4ec15abcbef17660e0f605fb2d93476f31b4af1d97924bed61b379d9dd33d06a93

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_migrator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jesper Josefsson
+
+MIT License
+
+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,62 @@
+# SimpleMigrator
+
+`SimpleMigrator` serves a simple purpose:
+
+- Use the [Sequel gem](https://github.com/jeremyevans/sequel) to access database
+- Keep track of database schema migrations
+- Do so without having to put migration files in a specific folders
+- Run migrations in order, sorted by migration name
+
+It has some important caveats:
+
+- The programmer is responsible for choosing a unique name for migrations
+- There's no way of controlling order other than using migration names
+
+`SimpleMigrator` contains a module `Migratable` which can be used to define migrations using a simple DSL.
+
+## Usage
+
+### Just migrate stuff
+
+    db = Sequel.sqlite
+    migrator = SimpleMigrator.migrator(db)
+    migrator.migrate("my_migration") do |connection|
+      # do stuff
+    end
+    # Your stuff has been done
+    migrator.migrate("my_migration") do
+      # This time the migrator won't execute the block
+    end
+
+### Using Migratable
+
+    class Foo
+      include SimpleMigrator::Migratable
+
+      migration "20150303-1" do |db|
+        create_my_table(db)
+        create_my_other_table(db)
+      end
+
+      migration "20150303-2" do |db|
+        add_column(db)
+      end
+
+      def create_my_table(db)
+      end
+
+      def create_my_other_table(db)
+      end
+
+      def add_column(db)
+      end
+    end
+
+    db = Sequel.sqlite
+    
+    migrator = SimpleMigrator.migrator(db)
+
+    foo = Foo.new
+
+    foo.migrate(migrator)
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/simple_migrator.rb

@@ -0,0 +1,14 @@
+require "sequel"
+
+require "simple_migrator/version"
+require "simple_migrator/migration"
+require "simple_migrator/migrator"
+require "simple_migrator/migratable"
+
+module SimpleMigrator
+  class << self
+    def migrator(*args, &block)
+      Migrator.new(*args, &block)
+    end
+  end
+end

data/lib/simple_migrator/migratable.rb

@@ -0,0 +1,45 @@
+module SimpleMigrator
+  module Migratable
+    def migrate!(migrator = migrator)
+      self.class.migrations.each do |migration|
+        rebound_proc = rebind_proc(migration.proc)
+        name = prefixed_migration_name(migration.name)
+        migrator.migrate(name, &rebound_proc)
+      end
+    end
+
+    def prefixed_migration_name(name)
+      if migration_prefix
+        [migration_prefix, name].join("_")
+      else
+        name
+      end
+    end
+
+    def migration_prefix; end
+
+    def migrator
+      raise NoMigratorError, "`migrate!` called without a migrator.\nEither provide a migrator or define a `migrator` method"
+    end
+
+    def rebind_proc(proc)5
+      Proc.new do |db|
+        instance_exec(db, &proc)
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def migration(name, &block)
+        migrations.add(Migration.new(name, block))
+      end
+
+      def migrations
+        @migrations ||= SortedSet.new
+      end
+    end
+  end
+end

data/lib/simple_migrator/migration.rb

@@ -0,0 +1,14 @@
+module SimpleMigrator
+  class Migration
+    attr_reader :proc, :name
+
+    def initialize(name, proc)
+      @name = name
+      @proc = proc
+    end
+
+    def <=>(other)
+      self.name <=> other.name
+    end
+  end
+end

data/lib/simple_migrator/migrator.rb

@@ -0,0 +1,54 @@
+module SimpleMigrator
+  class Migrator
+    def initialize(connection)
+      @connection = connection
+      ensure_migration_table!
+    end
+
+    def migrate(name, &block)
+      connection.transaction do
+        unless migrated?(name)
+          execute(block)
+          was_migrated(name)
+        end
+      end
+    end
+
+    def migrated? migration_name
+      migrations_table.where(migration_name: migration_name).any?
+    end
+
+    def migrations_table
+      connection[table_name]
+    end
+
+    def self.table_name
+      :schema_migrations
+    end
+
+    def table_name
+      self.class.table_name
+    end
+
+    private
+
+    def execute(migration)
+      migration.call(connection)
+    end
+
+    attr_reader :connection
+
+    def ensure_migration_table!
+      connection.create_table?(table_name) do
+        primary_key :id
+        String :migration_name, null: false
+        index [:migration_name], unique: true
+        DateTime :timestamp, null: false
+      end
+    end
+
+    def was_migrated(migration_name)
+      migrations_table.insert(timestamp: Time.now.utc, migration_name: migration_name)
+    end
+  end
+end

data/lib/simple_migrator/version.rb

@@ -0,0 +1,3 @@
+module SimpleMigrator
+  VERSION = "0.0.1"
+end

data/simple_migrator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_migrator"
+  spec.version       = SimpleMigrator::VERSION
+  spec.authors       = ["Jesper Josefsson"]
+  spec.email         = ["jesper.josefsson@gmail.com"]
+  spec.summary       = %q{SimpleMigrator provides basic programmatic migrations for Sequel}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sequel"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "simplecov"
+end

data/spec/migratable_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+module SimpleMigrator
+  class FakeMigrator
+
+    attr_accessor :driver
+
+    def migrate(_, &proc)
+      proc.call(driver)
+    end
+
+  end
+
+  describe Migratable do
+
+    let(:klass) do
+      Class.new do
+        include Migratable
+
+        migration("20140923-1") do |db|
+          db.do_stuff(my_instance_method)
+        end
+
+        migration("20140923-2") do |db|
+          db.do_stuff(my_instance_other_method)
+        end
+
+        def my_instance_method
+          "foo"
+        end
+
+        def my_instance_other_method
+          "bar"
+        end
+
+        def migrator
+          @migrator ||= FakeMigrator.new
+        end
+      end
+    end
+
+    describe "::migration" do
+      it "adds the migration to the class variable" do
+        klass.migration("apa") { "foo" }
+        expect(klass.migrations.map(&:name)).to include("apa")
+      end
+    end
+
+    describe "::migrations" do
+      it "returns a sorted collection" do
+        migration_names = klass.migrations.map(&:name)
+        expect(migration_names).to be_sorted
+      end
+    end
+
+    describe "#migrate!" do
+      it "calls the instance methods" do
+        instance = klass.new
+        driver = double
+        expect(driver).to receive(:do_stuff).twice
+        instance.migrator.driver = driver
+        expect(instance).to receive(:my_instance_method)
+        expect(instance).to receive(:my_instance_other_method)
+        instance.migrate!
+      end
+    end
+
+    describe "#prefixed_migration_name" do
+      let(:subject) { klass.new }
+      context "when there is a migration_prefixed defined" do
+        it "prefixes the input" do
+          def subject.migration_prefix
+            "foo"
+          end
+          expect(subject.prefixed_migration_name("bar")).to eq("foo_bar")
+        end
+      end
+
+      context "when there is no migration prefix" do
+        it "returns the input" do
+          def subject.migration_prefix
+            nil
+          end
+          expect(subject.prefixed_migration_name("bar")).to eq("bar")
+        end
+      end
+    end
+  end
+end

data/spec/migrator_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module SimpleMigrator
+  describe Migrator do
+    let(:connection) { Sequel.sqlite }
+    let(:migrator) { Migrator.new(connection) }
+
+    describe "#initialize" do
+      context "when no prior migration table exists" do
+        before do
+          Migrator.new(connection)
+        end
+        it "creates one" do
+          expect(connection.tables).to include(Migrator.table_name)
+        end
+      end
+    end
+
+    describe "#migrated?" do
+      context "when a migration of that name has been migrated" do
+        it "returns true" do
+          migrator.migrate("foo", & -> (_db) {})
+          expect(migrator.migrated?("foo")).to be_truthy
+        end
+      end
+
+      context "when the migration has not been run" do
+        it "returns true" do
+          expect(migrator.migrated?("foo")).to be_falsey
+        end
+      end
+    end
+
+    describe "#migrate" do
+      context "when the migration has not been run previously" do
+        it "runs the migration" do
+          expect { |b| migrator.migrate("foo", &b) }.to yield_control
+        end
+
+        it "writes the migration name to the migrations table" do
+          migration = -> (_) {}
+          migrator.migrate("foo", &migration)
+          migrations = migrator.migrations_table.select_map(:migration_name)
+          expect(migrations).to include("foo")
+        end
+      end
+
+      context "when the migration has already run" do
+        it "does not re run it" do
+          migrator.migrate("foo", & ->(_) {})
+          expect { |b| migrator.migrate("foo", &b) }.to_not yield_control
+        end
+      end
+    end
+  end
+end

data/spec/simple_migrator_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe SimpleMigrator do
+  describe "::migrator" do
+    let(:db) { Sequel.sqlite }
+    it "returns a migrator" do
+      expect(SimpleMigrator.migrator(db)).to be_a(SimpleMigrator::Migrator)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'simple_migrator'
+require 'sqlite3'
+
+RSpec::Matchers.define(:be_sorted) do
+  match do |actual|
+    actual == actual.sort
+  end
+end
+
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: simple_migrator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jesper Josefsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: simplecov
+  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'
+description: 
+email:
+- jesper.josefsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_migrator.rb
+- lib/simple_migrator/migratable.rb
+- lib/simple_migrator/migration.rb
+- lib/simple_migrator/migrator.rb
+- lib/simple_migrator/version.rb
+- simple_migrator.gemspec
+- spec/migratable_spec.rb
+- spec/migrator_spec.rb
+- spec/simple_migrator_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: SimpleMigrator provides basic programmatic migrations for Sequel
+test_files:
+- spec/migratable_spec.rb
+- spec/migrator_spec.rb
+- spec/simple_migrator_spec.rb
+- spec/spec_helper.rb