orientdb-schema-migrator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1248c231b6e9daabc14adad92504c3c554bf5c99
+  data.tar.gz: 567fdd36e4f5420c8be2c50474870eabffac84d0
+SHA512:
+  metadata.gz: c3fee532d00b7257a074de17c5da9f5802be37f0b1ba3e03e835db913bb5ed6d52a27229ed4e645ad0e7f81c1a21775792ed996f96f381292a0e13ee97d5c86f
+  data.tar.gz: 1599105f1143cab750e070362a4ff5c59101a05a9371fa851015d4473dcd804cba5600fffb1ae1e67bd99faa777d292d84e02427df6f961228962b00e7dd5495

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 CoPromote
+
+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 @@
+# OrientdbSchemaMigrator
+
+Migrate Orientdb schema.
+
+Uses a `schema_versions` class to keep track of migrations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'orientdb-schema-migrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orientdb-schema-migrator
+
+## Usage
+
+### Create Migration
+
+`rake odb:generate_migration migration_name=CreateFoos`
+
+### Migrate
+
+`rake odb:migrate`
+
+### Rollback
+
+Rollback (one migration at a time).
+
+`rake odb:rollback`
+
+## Testing
+
+1. Install OrientDb and run it locally.
+2. Create a database named `schema_test` with an admin user named `test`, password `test` (or provide your own credentials via environment variables).
+You can test that this is correctly setup with `rake db:test_connection`.
+3. `rake spec`
+
+## Contributing
+
+1. Fork it ( https://github.com/Headlinerfm/orientdb-schema-migrator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,58 @@
+require "bundler/gem_tasks"
+
+task :console do
+  require 'pry'
+  require 'orientdb-schema-migrator'
+  ARGV.clear
+  Pry.start
+end
+
+db_namespace = namespace :db do
+  require 'orientdb-schema-migrator'
+  db = ENV['odb_schema_test_db'] || 'schema_test'
+  db_user = ENV['odb_schema_test_user'] || 'test'
+  db_pass = ENV['odb_schema_test_pass'] || 'test'
+  config = {
+    database: db,
+    user: db_user,
+    password: db_pass
+  }
+
+  task :connect do
+    OrientdbSchemaMigrator::ODBClient.connect(:database => db, :user => db_user, :password => db_pass)
+  end
+
+  desc "Verify your orientdb test database setup"
+  task :verify_test_db do
+    if OrientdbSchemaMigrator::ODBClient.database_exists?(config)
+      puts "Test database exists"
+    else
+      raise "Failure: database does not exist"
+    end
+
+    db_namespace['connect'].invoke
+    if OrientdbSchemaMigrator::Migration.class_exists?('schema_versions')
+      puts "`schema_versions` exists"
+    else
+      raise "Failure: `schema_versions` table does not exist"
+    end
+
+    puts "Success"
+  end
+
+  desc "Add the `schema_versions` class to your database"
+  task :add_schema_class => [:connect] do
+    OrientdbSchemaMigrator::Migration.create_class('schema_versions')
+    OrientdbSchemaMigrator::Migration.add_property('schema_versions', 'schema_version', 'string')
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/orientdb-schema-migrator.rb

@@ -0,0 +1,13 @@
+require "orientdb4r"
+
+require "orientdb_schema_migrator/version"
+require "orientdb_schema_migrator/migration"
+require "orientdb_schema_migrator/migration_generator"
+require "orientdb_schema_migrator/migrator"
+require "orientdb_schema_migrator/proxy"
+
+require "orientdb_schema_migrator/railtie" if defined?(Rails)
+
+module OrientdbSchemaMigrator
+  ODBClient = Orientdb4r.client
+end

data/lib/orientdb_schema_migrator/migration.rb

@@ -0,0 +1,111 @@
+module OrientdbSchemaMigrator
+  class MigrationError < StandardError; end
+
+  class Migration
+    def self.create_class class_name, class_options={}
+      # check if class exists first
+      assert_class_not_exists!(class_name)
+      ODBClient.create_class class_name, class_options
+      if block_given?
+        proxy = Proxy.new(self, class_name)
+        yield proxy
+      end
+    end
+
+    def self.drop_class class_name
+      # check if class exists first
+      if class_exists?(class_name)
+        # delete vertices/edges first
+        super_class = ODBClient.get_class(class_name)["superClass"]
+        if super_class == "V"
+          ODBClient.command "delete vertex #{class_name}"
+        elsif super_class == "E"
+          ODBClient.command "delete edge #{class_name}"
+        end
+        # drop class
+        ODBClient.command "drop class #{class_name}"
+        return true
+      else
+        return false
+      end
+    end
+
+    def self.rename_class old_name, new_name
+      assert_class_exists!(old_name)
+      ODBClient.command "alter class #{old_name} name #{new_name}"
+    end
+
+    def self.add_property class_name, property_name, type, property_options={}
+      assert_class_exists!(class_name)
+      assert_property_not_exists!(class_name, property_name)
+      ODBClient.create_property class_name,property_name,type, property_options
+    end
+
+    def self.drop_property class_name, property_name
+      assert_class_exists!(class_name)
+      assert_property_exists!(class_name, property_name)
+      ODBClient.command "drop property #{class_name}.#{property_name}"
+    end
+
+    def self.alter_property class_name, property_name, attribute_name, new_value
+      assert_class_exists!(class_name)
+      assert_property_exists!(class_name, property_name)
+      ODBClient.command "alter property #{class_name}.#{property_name} #{attribute_name} #{new_value}"
+    end
+
+    def self.add_index class_name, property_name, index_name, type
+      assert_class_exists!(class_name)
+      assert_property_exists!(class_name, property_name)
+      assert_index_not_exists!(class_name, index_name)
+      ODBClient.command "create index #{index_name} on #{class_name} (#{property_name}) #{type}"
+    end
+
+    def self.drop_index index_name
+      ODBClient.command "drop index #{index_name}"
+    end
+
+    def self.class_exists? class_name
+      ODBClient.class_exists? class_name
+    end
+
+    def self.index_exists?(class_name, index_name)
+      return false unless class_exists?(class_name)
+      indexes = ODBClient.get_class(class_name)["indexes"]
+      return false unless indexes
+      return indexes.any? { |idx| idx['name'] == index_name }
+    end
+
+    def self.property_exists? class_name, property_name
+      if class_exists? class_name
+        properties = ODBClient.get_class(class_name)["properties"]
+        if properties
+          return properties.collect{|i| i["name"]}.include? property_name
+        else
+          return false
+        end
+      else
+        return false
+      end
+    end
+
+    def self.assert_class_exists!(class_name)
+      fail MigrationError.new("Class #{class_name} does not exist") unless class_exists?(class_name)
+    end
+
+    def self.assert_class_not_exists!(class_name)
+      fail MigrationError.new("Class #{class_name} already exists") unless !class_exists?(class_name)
+    end
+
+    def self.assert_property_exists!(class_name, property)
+      fail MigrationError.new("#{class_name}.#{property} does not exist") unless property_exists?(class_name, property)
+    end
+
+    def self.assert_property_not_exists!(class_name, property)
+      fail MigrationError.new("#{class_name}.#{property} already exists") unless !property_exists?(class_name, property)
+    end
+
+    def self.assert_index_not_exists!(class_name, index)
+      fail MigrationError.new("#{class_name},#{index} already exists") unless !index_exists?(class_name, index)
+    end
+  end
+end

data/lib/orientdb_schema_migrator/migration_generator.rb

@@ -0,0 +1,59 @@
+require 'active_support/inflector'
+require 'erb'
+
+module OrientdbSchemaMigrator
+  class InvalidMigrationName < StandardError; end
+
+  class MigrationGenerator
+
+    class MigrationGeneratorBinding
+      attr_reader :name
+      def initialize(name)
+        @name = name
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+    def self.generate(name, path)
+      create_folder_if_not_exists!(path)
+      mg = new(name, path)
+      mg.write_file
+    end
+
+    def self.create_folder_if_not_exists!(path)
+      return if File.directory?(path)
+      Dir.mkdir(path)
+    end
+
+    def initialize(name, path)
+      @name = name
+      validate_name!
+      time = Time.now.strftime("%Y%m%d%H%M%S")
+      file_name = @name.underscore
+      @file_path = path + "/" + time + "_" + file_name + ".rb"
+    end
+
+    def write_file
+      template_path = File.expand_path("../templates/migration_template.rb", __FILE__)
+      File.open(@file_path, "w", 0644) do |f|
+        f.write ERB.new(File.read(template_path)).result(MigrationGeneratorBinding.new(name).get_binding)
+      end
+    end
+
+    private
+
+    attr_reader :name
+
+    def validate_name!
+      if name.underscore.camelcase != name
+        fail InvalidMigrationName.new("Name must be convertible between CamelCase and snake_case: #{name}")
+      end
+      if name.match(/[^a-zA-Z]+/)
+        fail InvalidMigrationName.new("Name must consist only of alphabetic characters: #{name}")
+      end
+    end
+  end
+end

data/lib/orientdb_schema_migrator/migrator.rb

@@ -0,0 +1,125 @@
+require 'active_support/inflector'
+
+module OrientdbSchemaMigrator
+  class MigratorConflictError < StandardError; end
+
+  class Migrator
+    @migrations_path = nil
+
+    class << self
+      def migrations_path= path
+        @migrations_path = path
+      end
+
+      def migrations_path
+        @migrations_path
+      end
+
+      def connect_to_db db, user, password
+        ODBClient.connect :database => db, :user => user, :password => password
+      end
+
+      def disconnect
+        ODBClient.disconnect
+      end
+
+      def migrate(target_version = nil)
+        run(:up, target_version)
+      end
+
+      def migrations
+        files = Dir[@migrations_path + '/[0-9]*_*.rb']
+        seen = Hash.new false
+        migrations = files.map do |f|
+          version, name = f.scan(/(\d+)_([^\.]+)/).first
+          if seen[version] || seen[name]
+            fail MigratorConflictError.new("Duplicate migration name/version: #{name}, #{version}")
+          else
+            seen[version] = seen[name] = true
+          end
+          {
+            name: name,
+            version: version,
+            path: f
+          }
+        end
+        migrations.sort_by { |m| m[:version] }
+      end
+
+      def run(command, target_version)
+        new(current_version, target_version, command).migrate
+      end
+
+      def rollback(options = {})
+        new(current_version, nil, nil).rollback
+      end
+
+      def current_version
+        response = ODBClient.command "SELECT schema_version FROM schema_versions ORDER BY @rid DESC LIMIT 1"
+        results = response['result']
+        results.any? ? results.first['schema_version'] : nil
+      end
+    end
+
+    def initialize(current_version, target_version, direction)
+      @current_version = current_version
+      @target_version = target_version
+      @direction = direction
+    end
+
+    def migrations
+      return @migrations if defined?(@migrations)
+      if @direction == :down
+        @migrations = self.class.migrations.reverse
+      else
+        @migrations = self.class.migrations
+      end
+    end
+
+    def migrate
+      migrations[start..finish].each do |m|
+        require m[:path]
+        m[:name].camelize.constantize.public_send(@direction)
+        if up?
+          record_migration(m)
+        else
+          drop_migration(m)
+        end
+      end
+    end
+
+    def rollback
+      migrations.find { |m| m[:version] == @current_version }.tap do |m|
+        require m[:path]
+        m[:name].camelize.constantize.down
+        drop_migration(m)
+      end
+    end
+
+    private
+
+    def start
+      @current_version.nil? ? 0 : migrations.find_index { |m| m[:version] == @current_version }
+    end
+
+    def finish
+      @target_version.nil? ? migrations.size - 1 : migrations.find_index { |m| m[:version] == @target_version }
+    end
+
+    def record_migration(migration)
+      ODBClient.command "INSERT INTO schema_versions (schema_version) VALUES (#{migration[:version]})"
+    end
+
+    def drop_migration(migration)
+      ODBClient.command "DELETE FROM schema_versions WHERE schema_version = '#{migration[:version]}'"
+    end
+
+    def up?
+      @direction == :up
+    end
+
+    def down?
+      @direction == :down
+    end
+  end
+end

data/lib/orientdb_schema_migrator/proxy.rb

@@ -0,0 +1,26 @@
+module OrientdbSchemaMigrator
+  class Proxy
+    attr_reader :target, :context
+
+    def initialize(target, context)
+      @target = target
+      @context = context
+    end
+
+    def add_property(property, type, options = {})
+      target.public_send(:add_property, context, property, type, options)
+    end
+
+    def alter_property(property, attribute_name, new_value)
+      target.public_send(:add_property, context, property, attribute_name, new_value)
+    end
+
+    def drop_property(property)
+      target.public_send(:add_property, context, property)
+    end
+
+    def add_index(property, index_name, index_type)
+      target.public_send(:add_property, context, property, index_name, index_type)
+    end
+  end
+end

data/lib/orientdb_schema_migrator/railtie.rb

@@ -0,0 +1,10 @@
+require 'orientdb-schema-migrator'
+require 'rails'
+
+module OrientdbSchemaMigrator
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/orientdb_schema_migrator.rake'
+    end
+  end
+end

data/lib/orientdb_schema_migrator/templates/migration_template.rb

@@ -0,0 +1,7 @@
+class <%= name %> < OrientdbSchemaMigrator::Migration
+  def self.up
+  end
+
+  def self.down
+  end
+end

data/lib/orientdb_schema_migrator/version.rb

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

data/lib/tasks/orientdb_schema_migrator.rake

@@ -0,0 +1,67 @@
+require 'yaml'
+
+namespace :odb do
+  task :config do
+    if !ENV['ODB_TEST']
+      migrations_path =
+        if ENV['odb_migrations_path']
+          migrations_path = ENV['odb_migrations_path']
+        elsif defined?(Rails)
+          Rails.root.to_s + '/db/orientdb/migrate'
+        else
+          raise "No migrations path defined"
+        end
+
+      OrientdbSchemaMigrator::Migrator.migrations_path = migrations_path
+    end
+  end
+
+  def with_connection &block
+    config_file =
+      if defined?(Rails)
+        Rails.root.to_s + '/config/orientdb.yml'
+      elsif ENV['ODB_TEST']
+        File.expand_path('../../../spec/support/config.yml', __FILE__)
+      elsif ENV['odb_config_path']
+        ENV['odb_config_path']
+      else
+        raise "No odb config path defined"
+      end
+
+    env =
+      if defined?(Rails)
+        Rails.env
+      elsif ENV['ODB_TEST']
+        'test'
+      else
+        raise "No environment specified to load database connection config"
+      end
+
+    config = YAML.load_file(config_file)[env]
+    OrientdbSchemaMigrator::Migrator.connect_to_db(config['db'], config['user'], config['password'])
+    begin
+      yield
+    ensure
+      OrientdbSchemaMigrator::Migrator.disconnect
+    end
+  end
+
+  desc "Migrate"
+  task :migrate => [:config] do
+    with_connection do
+      OrientdbSchemaMigrator::Migrator.migrate(ENV['schema_version'])
+    end
+  end
+
+  desc "Rollback one migration"
+  task :rollback => [:config] do
+    with_connection do
+      OrientdbSchemaMigrator::Migrator.rollback(ENV['schema_version'])
+    end
+  end
+
+  desc "Generate a new migration"
+  task :generate_migration => [:config] do
+    OrientdbSchemaMigrator::MigrationGenerator.generate(ENV['migration_name'], OrientdbSchemaMigrator::Migrator.migrations_path)
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: orientdb-schema-migrator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- CoPromote
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: orientdb4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: Migrate OrientDB schema
+email:
+- info@copromote.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/orientdb-schema-migrator.rb
+- lib/orientdb_schema_migrator/migration.rb
+- lib/orientdb_schema_migrator/migration_generator.rb
+- lib/orientdb_schema_migrator/migrator.rb
+- lib/orientdb_schema_migrator/proxy.rb
+- lib/orientdb_schema_migrator/railtie.rb
+- lib/orientdb_schema_migrator/templates/migration_template.rb
+- lib/orientdb_schema_migrator/version.rb
+- lib/tasks/orientdb_schema_migrator.rake
+homepage: https://copromote.com
+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: Migrate OrientDB schema
+test_files: []