definite 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+tmp/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p0@dbscript

data/Gemfile

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

data/README.md

@@ -0,0 +1,46 @@
+# Definitive
+
+Definitive takes a textual description of database tables and updates your database to match.
+
+## Motivation
+
+When maintaining a large Rails project, with new features being added on multiple branches, standard ActiveRecord migrations can get in the way; switching branches with uncommitted migrations can leave you in a state where you can't run rake db:migrate or rake db:rollback or any similar commands.
+
+Definitive overcomes this limitation by taking a different approach.  Now you only need to define what your database should look like; focus on the end-goal, rather than the migration.  When you run Definitive, it will compare your database with your description of the database, and do the migrations automatically for you.
+
+## Is it safe?
+
+Until we reach v1.0.0 you should consider this as experimental, and should understand that using this Gem might cause data-loss.  It might drop tables, and do other destructive work.  Please be careful.
+
+Once we reach v1.0.0, it's hoped that it will be safe
+
+## User guide
+
+### Description files
+
+Within a standard Rails project, the description files should be placed in a `db/tables` folder, within `RAILS_ROOT`.
+
+You can arrange your files as you like, but the best approach is to have one file per database table, named `table_name.table`
+
+An example table definition looks like this:
+
+    TableDefinition.define :users do
+
+      column :username, :string, :default => nil
+      column :password, :string
+
+      columns :timestamps
+
+    end
+
+The call to `TableDefinition.define` starts the definition.  The single argument is the name of the table, which can be a string or a symbol.  The block passed in should consist of `column` statements, which are broadly similar to an `add_column` call within an ActiveRecord migration.
+
+### Running Definitive
+
+The `definitive` executable takes a number of arguments:
+
+- *definitive read filename* - Reads the filename table definition to check that it is a valid file.  This operation does not change your database at all.
+
+- *definitive read filepath* - Reads the all the `.table` files in the filepath, recursively.  Directory structure does not imply a namespace.  Files are checked for validity.  This operation does not change your database at all.
+
+

data/Rakefile

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

data/bin/definite

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'definite/cli'
+Definite::CLI.start

data/definite.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "definite/version"
+
+Gem::Specification.new do |s|
+  s.name        = "definite"
+  s.version     = Definite::VERSION
+  s.authors     = ["Graham S Savage"]
+  s.email       = ["grahamsavage@gmail.com"]
+  s.homepage    = "https://github.com/gsavage/definitive"
+  s.summary     = %q{Database manipulation without migrations}
+  s.description = %q{Create the definitive description of your DB and let Definitive modify your schema safely for you}
+
+  s.rubyforge_project = "definite"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+
+  s.add_dependency "activerecord"
+  s.add_dependency "thor"
+end

data/features/read_definitions.feature

@@ -0,0 +1,17 @@
+Feature: Read definitions
+  In order to know what the database should look like
+  As a CLI
+  I want to read definition files
+
+  Scenario: Reading a file
+    Given a file named "users.table" with:
+      """
+        TableDefinition.define :users do
+          column :username, :string
+        end
+      """
+    When I run `definite read users.table`
+    Then the output should contain "users"
+    And the output should contain "username"
+
+

data/features/step_definitions/table_steps.rb

@@ -0,0 +1,7 @@
+Then /^I should have a table definition for "([^"]*)"$/ do |table_name|
+  TableDefinition.definition(table_name).should_not be_nil
+end
+
+Then /^the "([^"]*)" table definition should include a "([^"]*)" column$/ do |table_name, column|
+  TableDefinition[table_name].column_names.should include(column_name)
+end

data/features/support/setup.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'definite'

data/lib/definite/cli.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require 'definite'
+module Definite
+  class CLI < Thor
+
+    desc "read FILE or DIRECTORY", "Reads one or more definition files, to check syntax"
+    def read file_or_directories
+      Definite::Reader.read file_or_directories
+    end
+
+  end
+end

data/lib/definite/model/table_definition.rb

@@ -0,0 +1,32 @@
+class TableDefinition
+
+  def self.definition(table_name)
+    tables[table_name]
+  end
+
+  def self.tables
+    @@tables ||= {}
+  end
+
+  def self.define(table_name, options={}, &block)
+    puts "Found definition for table #{table_name}"
+
+    @table = TableDefinition.new(table_name.to_s)
+    @table.instance_eval(&block)
+
+    tables[table_name.to_s] = @table
+  end
+
+  def all
+    tables.values
+  end
+
+  def column column_name, datatype, options={}
+    puts "column #{column_name}"
+  end
+
+  def columns column_names
+    puts "columns #{column_names}"
+  end
+
+end

data/lib/definite/reader.rb

@@ -0,0 +1,7 @@
+module Definite
+  class Reader
+    def self.read files_or_directories
+      load files_or_directories
+    end
+  end
+end

data/lib/definite/version.rb

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

data/lib/definite.rb

@@ -0,0 +1,15 @@
+require "definite/version"
+require "definite/reader"
+require "definite/model/table_definition"
+
+module Definite
+  # Your code goes here...
+
+  def update
+    target_schema = Definite::Reader.read
+    current_schema = Definite::Dumper.read
+    changes = Definite::Changes.difference :new_schema => new_schema, :current_schema => current_schema
+    Definite::Writer.write changes
+  end
+
+end

data/notes.txt

@@ -0,0 +1 @@
+Schema dump uses ActiveRecord::SchemaDumper

data/spec/definite_spec.rb

@@ -0,0 +1,7 @@
+require 'definite'
+
+describe Definite do
+  it "should do something" do
+    Definite
+  end
+end

data/spec/table_definition_spec.rb

@@ -0,0 +1,10 @@
+require 'definite'
+
+describe TableDefinition do
+
+  context "the model class" do
+    subject { TableDefinition }
+
+    it { should respond_to(:define) }
+  end
+end

data/spec/test_data/tables/users.table

@@ -0,0 +1,8 @@
+TableDefinition.define :users do
+
+  column :username, :string, :default => nil
+  column :password, :string
+
+  columns :timestamps
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: definite
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Graham S Savage
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Create the definitive description of your DB and let Definitive modify your schema safely for you
+email: 
+- grahamsavage@gmail.com
+executables: 
+- definite
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- bin/definite
+- definite.gemspec
+- features/read_definitions.feature
+- features/step_definitions/table_steps.rb
+- features/support/setup.rb
+- lib/definite.rb
+- lib/definite/cli.rb
+- lib/definite/model/table_definition.rb
+- lib/definite/reader.rb
+- lib/definite/version.rb
+- notes.txt
+- spec/definite_spec.rb
+- spec/table_definition_spec.rb
+- spec/test_data/tables/users.table
+has_rdoc: true
+homepage: https://github.com/gsavage/definitive
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: definite
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Database manipulation without migrations
+test_files: 
+- features/read_definitions.feature
+- features/step_definitions/table_steps.rb
+- features/support/setup.rb
+- spec/definite_spec.rb
+- spec/table_definition_spec.rb
+- spec/test_data/tables/users.table