brant 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Denwen, Inc.
+
+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.textile

@@ -0,0 +1,89 @@
+h1. brant
+
+Simple package migration management inspired from rails database migration management.
+
+h2. Installation
+
+<pre>
+gem install brant
+</pre>
+
+In config/environment.rb add -
+
+<pre>
+gem.config('brant')
+</pre>
+
+In the Rakefile add - 
+
+<pre>
+require 'brant'
+require 'brant/tasks'
+</pre>
+
+h2. Usage
+
+h3. Create a new migration
+
+<pre>
+script/generate brant_migration install_xml_package
+</pre>
+
+h3. Setup a new migration
+
+<pre>
+class InstallXmlPackage < Brant::Migration
+  def self.up
+    system("sudo apt-get install xml2")
+  end
+
+  def self.down
+    system("sudo apt-get remove xml2")
+  end
+end
+</pre>
+
+h3. Load rails environment for custom tasks (optional)
+
+<pre>
+require 'config/environment'
+
+class ProcessImages < Brant::Migration
+  def self.up
+    Image.last.process
+  end
+
+  def self.down
+    Image.last.mark_as_unprocessed
+  end
+end
+</pre>
+
+h3. Run pending migrations
+
+<pre>
+rake brant:migrate
+</pre>
+
+
+h3. Rollback last migration
+
+<pre>
+rake brant:rollback
+</pre>
+
+h2. Contributing to brant
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+h2. Copyright
+
+Copyright (c) 2012 Denwen, Inc. See LICENSE.txt for
+further details.
+

data/generators/brant_migration/brant_migration_generator.rb

@@ -0,0 +1,53 @@
+class BrantMigrationGenerator < Rails::Generator::Base
+
+  # Perform validations on input 
+  #
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    unless @args.present?
+      raise IOError, "Please include name of migration"
+    end
+
+    @name = @args.first 
+
+    unless is_migration_unique?
+      raise IOError, "A migration titled #{@name} already exists"
+    end
+  end
+
+  # Test if a migration with the given name already exists
+  #
+  def is_migration_unique?
+    !File.exists?(Brant.migrationsPath) ||
+        !Dir.entries(Brant.migrationsPath).
+        map{|f| f.split('_')[0..-2].join('_')}.
+        include?(@name)
+  end
+
+  # Name of the migration file
+  #
+  def file_name
+    @file ||= @name + '_' + 
+                Time.now.strftime("%Y%m%M%S") + ("%04d" % rand(1000)) +
+                '.rb'
+  end
+
+  # Name of the migration class within the new migration file
+  #
+  def class_name
+    @name.camelize
+  end
+
+
+  # Generate various files & directories
+  #
+  def manifest
+    record do |m|
+      m.directory Brant.rootPath
+      m.directory Brant.migrationsPath
+      m.template 'migration.rb',File.join(Brant.migrationsPath,file_name)
+    end
+  end
+
+end

data/generators/brant_migration/templates/migration.rb

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

data/lib/brant/migration.rb

@@ -0,0 +1,18 @@
+module Brant
+
+  # Base class for all package migrations
+  #
+  class Migration
+
+    # Stub method for running a migration
+    #
+    def self.up
+    end
+
+    # Stud method for rolling back a migration
+    #
+    def self.down
+    end
+  end
+
+end

data/lib/brant/migration_file.rb

@@ -0,0 +1,68 @@
+module Brant
+  
+  # Representation of the actual file that stores a migration
+  #
+  class MigrationFile
+    
+    attr_accessor :filename, :klass, :timestamp
+
+    # Returns hash of migration file objects of all defnied migrations
+    # with their timestamps as the keys
+    #
+    def self.all
+      migrations = {}
+
+      if File.exists? Brant.migrationsPath
+        Dir.entries(Brant.migrationsPath).each do |file|
+          next if file.length < 3 || file.match(/^\./)
+          migration = new(file)
+          migrations[migration.timestamp] = migration
+        end
+      end
+
+      migrations
+    end
+
+    # Returns a hash of migration timestamps that 
+    # have been performed
+    #
+    def self.existing
+      migrations = {}
+      
+      if File.exists? Brant.migrationsConfigPath
+        File.open(Brant.migrationsConfigPath,'r') do |file|
+          while(line = file.gets)
+            migrations[line.chomp] = true
+          end
+        end
+      end
+
+      migrations
+    end
+
+    # Update migrations config to show all finished migrations
+    #
+    def self.update(migrations)
+      File.open(Brant.migrationsConfigPath,'w') do |file|
+        file.write migrations.join("\n")
+      end
+    end
+
+
+    # Compare objects based on timestamp
+    #
+    def <=>(other)
+      self.timestamp <=> other.timestamp
+    end
+
+    # Constructor logic
+    #
+    def initialize(filename)
+      self.filename   = filename
+
+      parts           = self.filename.split('_')
+      self.timestamp  = parts.last.split('.').first
+      self.klass      = parts[0..-2].join('_').camelize
+    end
+  end
+end

data/lib/brant/tasks.rb

@@ -0,0 +1,46 @@
+
+namespace :brant do
+
+desc "Run all pending migrations"
+task :migrate do
+  existing_migrations = Brant::MigrationFile.existing
+
+  puts ""
+
+  Brant::MigrationFile.all.values.sort.each do |migration|
+
+    unless existing_migrations[migration.timestamp]
+      puts "Running migration " + migration.klass
+
+      require File.join(Brant.migrationsPath,migration.filename)
+      Object.const_get(migration.klass).send(:up) 
+
+      existing_migrations[migration.timestamp] = true
+    end
+  end
+
+  Brant::MigrationFile.update(existing_migrations.keys.sort)
+end
+
+desc "Undo the last migration"
+task :rollback do
+  existing_migrations = Brant::MigrationFile.existing
+  all_migrations      = Brant::MigrationFile.all
+      
+  puts ""
+
+  if existing_migrations.length > 0
+    migration = all_migrations[existing_migrations.keys.sort.last]
+
+    puts "Rolling back migration " + migration.klass
+
+    require File.join(Brant.migrationsPath,migration.filename)
+    Object.const_get(migration.klass).send(:down) 
+
+    existing_migrations.delete(migration.timestamp)
+  end
+
+  Brant::MigrationFile.update(existing_migrations.keys.sort)
+end
+
+end

data/lib/brant.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/string/inflections.rb'
+require 'fileutils'
+
+require 'brant/migration'
+require 'brant/migration_file'
+
+
+module Brant
+
+    # Relative path of the root dir for packages
+    #
+    def self.rootPath
+      'pkg'  
+    end
+
+    # Relative path of the dir that contains the migration files
+    #
+    def self.migrationsPath
+      File.join(rootPath,'migrate')
+    end
+
+    # Relative path of the hidden file that contains the current migration
+    #
+    def self.migrationsConfigPath
+      File.join(rootPath,'.migrations')
+    end
+
+end

data/lib/pkg/migrate/create_temp_file_20120206020466.rb

@@ -0,0 +1,9 @@
+class CreateTempFile < Brant::Migration
+  def self.up
+    system("touch a.txt")
+  end
+
+  def self.down
+    system("rm a.txt")
+  end
+end

data/lib/pkg/migrate/edit_temp_file_20120213120974.rb

@@ -0,0 +1,9 @@
+class EditTempFile < Brant::Migration
+  def self.up
+    File.open('a.txt','w'){|f| f.write 'replaced'}
+  end
+
+  def self.down
+    File.open('a.txt','w'){|f| f.write 'this is cool'}
+  end
+end

data/lib/pkg/migrate/maintain_temp_file_20120212430871.rb

@@ -0,0 +1,9 @@
+class MaintainTempFile < Brant::Migration
+  def self.up
+    File.open('a.txt','w'){|f| f.write 'this is cool'}
+  end
+
+  def self.down
+    File.open('a.txt','w'){|f| }
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: brant
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Siddharth Batra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-13 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 1
+        - 0
+        - 22
+        version: 1.0.22
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
+        version: 1.8.3
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id005
+description: Simple package migration management inspired from rails database migration management
+email: siddharthabatra@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- generators/brant_migration/brant_migration_generator.rb
+- generators/brant_migration/templates/migration.rb
+- lib/brant.rb
+- lib/brant/migration.rb
+- lib/brant/migration_file.rb
+- lib/brant/tasks.rb
+- lib/pkg/migrate/create_temp_file_20120206020466.rb
+- lib/pkg/migrate/edit_temp_file_20120213120974.rb
+- lib/pkg/migrate/maintain_temp_file_20120212430871.rb
+- LICENSE.txt
+- README.textile
+has_rdoc: true
+homepage: http://github.com/denwen/brant
+licenses: 
+- MIT
+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.5.2
+signing_key: 
+specification_version: 3
+summary: Simple package migrations by brant
+test_files: []
+