caster 0.9.0

data/bin/cast

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'caster'
+require 'caster/migrator'
+require 'thor'
+require 'couchrest'
+
+class Cast < Thor
+
+  desc 'version', 'prints the current version of your database'
+  method_option :db, :aliases => '-d', :required => true
+  def version
+    db = CouchRest.database! "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{options[:db]}"
+    begin
+      puts db.get("#{Caster.config[:metadoc_id_prefix]}_#{database}")['version']
+    rescue
+      puts "No version information available."
+    end
+  end
+
+  desc 'up', 'executes migrations defined in cast files in the current directory'
+  method_option :db, :aliases => '-d', :required => true
+  method_option :version, :aliases => '-v'
+  def up path = '.'
+    Migrator.new.migrate_dir options[:db], path, options[:version]
+    puts 'Done.'
+  end
+end
+
+Cast.start

data/lib/caster.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+require 'caster/migration'
+
+include Caster
+
+module Caster
+
+  @config = {
+    :host => '127.0.0.1',
+    :port => '5984',
+    :metadoc_type => 'caster_metadoc',
+    :metadoc_id_prefix => 'caster'
+  }
+
+  @valid_config_keys = @config.keys
+
+  def self.configure opts = {}
+    opts.each do |k, v|
+      @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym
+    end
+  end
+
+  def self.configure_with path_to_yaml_file
+    begin
+      config = YAML.load_file path_to_yaml_file
+    rescue Errno::ENOENT
+      log :warning, "YAML configuration file couldn't be found.. using defaults."
+      return
+    rescue Psych::SyntaxError
+      log :warning, "YAML configuration file contains invalid syntax.. using defaults."
+      return
+    end
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+end

data/lib/caster/execution.rb

@@ -0,0 +1,75 @@
+require 'couchrest'
+require 'caster/operation'
+require 'caster/transform/add'
+require 'caster/transform/remove'
+require 'caster/transform/rename'
+require 'caster/transform/create'
+require 'caster/transform/delete'
+require 'caster/transform/clone'
+require 'caster/ref/reference'
+
+module Caster
+
+  # defines an execution scope which is a set of documents over which migration operations run
+  class Execution
+
+    def initialize db, view, query, &block
+      @db = db
+      @view = view
+      @query = query
+      @block = block
+    end
+
+    def add field, value
+      @operations << Operation.new(@db, Add.new(field, value))
+    end
+    alias_method :update, :add
+
+    def remove field
+      @operations << Operation.new(@db, Remove.new(field))
+    end
+
+    def rename old_name, new_name
+      @operations << Operation.new(@db, Rename.new(old_name, new_name))
+    end
+
+    def create params
+      @operations << Operation.new(@db, Create.new(params))
+    end
+
+    def delete
+      @operations << Operation.new(@db, Delete.new)
+    end
+
+    def create_on db_handle, params
+      @operations << Operation.new(db_handle, Clone.new(params))
+    end
+
+    def from scope, query = {}
+      if scope.scan('/').length == 1
+        return Reference.new @db, scope, query
+      else
+        database_name, view = scope.split('/', 2)
+        db = CouchRest.database "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{database_name}"
+        return Reference.new db, view, query
+      end
+    end
+
+    def execute
+      rdocs = @db.view(@view, @query)['rows']
+      db_docs_map = Hash.new { |k, v| k[v] = [] }
+      rdocs.each do |rdoc|
+        doc = rdoc.has_key?('doc')? rdoc['doc'] : rdoc['value']
+
+        @operations = []
+        instance_exec doc.clone, &@block
+        @operations.each do |op|
+          db_docs_map[op.db_handle] << op.transformation.execute(doc)
+        end
+      end
+      db_docs_map.each do |db, docs|
+        db.bulk_save docs
+      end
+    end
+  end
+end

data/lib/caster/migration.rb

@@ -0,0 +1,39 @@
+require 'caster/execution'
+
+module Caster
+
+  def migrate database_name, &block
+    @db = CouchRest.database "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{database_name}"
+    yield
+    @db = nil
+  end
+
+  def migrate_script database_name, code
+    migrate database_name do
+      self.instance_eval code, __FILE__, __LINE__
+    end
+  end
+
+  def over scope, query = {}, &block
+    database_name, view = split(scope)
+    db = CouchRest.database "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{database_name}" if @db == nil
+    Execution.new(db || @db, view, query, &block).execute
+  end
+
+  def split scope
+    if scope.count('/') == 1
+      return nil, scope
+    elsif scope.count('/') == 2
+      return scope.split('/', 2)
+    end
+  end
+
+  # fall down to couchrest methods
+  def method_missing method_name, *args
+    if @db.respond_to? method_name
+      @db.send method_name, *args
+    else
+      super
+    end
+  end
+end

data/lib/caster/migrator.rb

@@ -0,0 +1,72 @@
+require 'caster/migration'
+require 'couchrest'
+
+module Caster
+
+  class Migrator
+
+    def migrate_dir database, path, max_version = nil
+      db = CouchRest.database! "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{database}"
+
+      current_version = nil
+      begin
+        current_version = db.get("#{Caster.config[:metadoc_id_prefix]}_#{database}")['version']
+      rescue
+        # ignored
+      end
+
+      path = path.sub /(\/)+$/, ''
+
+      migrations = Dir["#{path}/*.cast"].map do |file|
+        version, db_in_filename = File.basename(file, '.cast').split '.'
+        { :version => version , :database => db_in_filename, :filepath => file }
+      end
+
+      db_filtered = migrations.map do |migration|
+        migration if database == migration[:database]
+      end.compact
+
+      min_version_filtered = db_filtered.map do |migration|
+        migration if current_version == nil or migration[:version] > current_version
+      end.compact
+
+      max_version_filtered = min_version_filtered.map do |migration|
+        migration if max_version == nil or migration[:version] <= max_version
+      end.compact
+
+      filtered_and_sorted_files = max_version_filtered.map do |migration|
+        migration[:filepath]
+      end.sort
+
+      filtered_and_sorted_files.each do |file|
+        migrate_file file, db
+      end
+    end
+
+    def migrate_file path, db_handle = nil
+      filename = File.basename path, '.cast'
+      version, database = filename.split '.'
+
+      db = db_handle || (CouchRest.database! "http://#{Caster.config[:host]}:#{Caster.config[:port]}/#{database}")
+      metadoc = nil
+      begin
+        metadoc = db.get "#{Caster.config[:metadoc_id_prefix]}_#{database}"
+      rescue
+        metadoc = {
+            '_id' => "#{Caster.config[:metadoc_id_prefix]}_#{database}",
+            'type' => "#{Caster.config[:metadoc_type]}"
+        }
+      end
+
+      if metadoc['version'] != nil and version <= metadoc['version']
+        raise 'Cannot migrate down!'
+      else
+        metadoc['version'] = version
+      end
+
+      migrate_script database, File.open(path).read
+
+      db.save_doc metadoc
+    end
+  end
+end

data/lib/caster/operation.rb

@@ -0,0 +1,19 @@
+module Caster
+
+  # a migration operation applies a transformation over a document and saves it to a database
+  class Operation
+
+    def initialize db_handle, transformation
+      @db_handle = db_handle
+      @transformation = transformation
+    end
+
+    def db_handle
+      @db_handle
+    end
+
+    def transformation
+      @transformation
+    end
+  end
+end

data/lib/caster/ref/reference.rb

@@ -0,0 +1,45 @@
+module Caster
+  class Reference
+
+    # to enable passing over method calls on the reference through method_missing
+    Object.instance_methods.each do |m|
+      undef_method m unless ['__send__', '__id__', 'object_id', 'is_a?'].include? m.to_s
+    end
+
+    def initialize db_handle, view, query
+      rdocs = db_handle.view(view, query)['rows']
+      @docs = rdocs.map { |rdoc| rdoc['value'] }
+      @post_eval_calls = []
+    end
+
+    def where &predicate
+      @predicate = predicate
+      self
+    end
+
+    def method_missing method_name, *args
+      @post_eval_calls << [method_name, args]
+      self
+    end
+
+    def evaluate target_doc
+      @docs.each do |doc|
+        if @predicate.call doc
+          value = deref(doc, @value_field)
+          @post_eval_calls.each do |args|
+            value = value.send args[0], *args[1]
+          end
+          return value
+        end
+      end
+      nil
+    end
+
+    private
+    def deref doc, accessor
+      return doc if accessor == nil
+      value = eval 'doc' << accessor.split('.').map { |field| "['#{field}']" }.join
+      (value.is_a? Fixnum)? value : value.clone
+    end
+  end
+end

data/lib/caster/transform/add.rb

@@ -0,0 +1,20 @@
+require 'couchrest'
+
+module Caster
+  class Add
+
+    def initialize field, value
+      @field = field
+      @value = value
+    end
+
+    def execute doc
+      doc[@field] = evaluate(@value, doc)
+      doc
+    end
+
+    def evaluate obj, target_doc
+      (obj.is_a? Reference)? obj.evaluate(target_doc) : obj
+    end
+  end
+end

data/lib/caster/transform/clone.rb

@@ -0,0 +1,13 @@
+module Caster
+  class Clone
+
+    def initialize source
+      @source = source
+    end
+
+    def execute doc
+      @source.delete '_rev'
+      @source
+    end
+  end
+end

data/lib/caster/transform/create.rb

@@ -0,0 +1,18 @@
+module Caster
+  class Create
+
+    def initialize params
+      @params_template = params
+    end
+
+    def execute doc
+      params = @params_template.clone
+      params.each do |field, value|
+        if value.is_a? Reference
+          params[field] = value.evaluate doc
+        end
+      end
+      params
+    end
+  end
+end

data/lib/caster/transform/delete.rb

@@ -0,0 +1,8 @@
+module Caster
+  class Delete
+
+    def execute doc
+      doc.merge '_deleted' => true
+    end
+  end
+end

data/lib/caster/transform/remove.rb

@@ -0,0 +1,13 @@
+module Caster
+  class Remove
+
+    def initialize field
+      @field = field
+    end
+
+    def execute doc
+      doc.delete @field
+      doc
+    end
+  end
+end

data/lib/caster/transform/rename.rb

@@ -0,0 +1,15 @@
+module Caster
+  class Rename
+
+    def initialize old_name, new_name
+      @old_name = old_name
+      @new_name = new_name
+    end
+
+    def execute doc
+      doc[@new_name] = doc[@old_name]
+      doc.delete @old_name
+      doc
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: caster
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Manohar Akula
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A migration framework for couchdb databases
+email: manohar.akula@gmail.com
+executables: 
+- cast
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/caster.rb
+- lib/caster/execution.rb
+- lib/caster/migration.rb
+- lib/caster/migrator.rb
+- lib/caster/operation.rb
+- lib/caster/ref/reference.rb
+- lib/caster/transform/add.rb
+- lib/caster/transform/clone.rb
+- lib/caster/transform/create.rb
+- lib/caster/transform/delete.rb
+- lib/caster/transform/remove.rb
+- lib/caster/transform/rename.rb
+- bin/cast
+homepage: http://github.com/akula1001/caster
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Casters for your couch database
+test_files: []
+