straitjacket 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kyle Maxwell
+
+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.rdoc

@@ -0,0 +1,17 @@
+= straitjacket
+
+Constraint creation for PostgreSQL.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kyle Maxwell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "straitjacket"
+    gem.summary = %Q{PostgreSQL constraints in Ruby}
+    gem.description = %Q{PostgreSQL constraints in Ruby}
+    gem.email = "kyle@kylemaxwell.com"
+    gem.homepage = "http://github.com/fizx/straitjacket"
+    gem.authors = ["Kyle Maxwell"]
+    gem.add_dependency "pg", ">= 0.8"
+    gem.add_development_dependency "activerecord", ">= 2.3.8"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "straitjacket #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :spec do
+  task :setup do
+    require "rubygems"
+    require "active_record"
+    require "yaml"
+    config = YAML.load(File.read("spec/database.yml"))
+    ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+    ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => @encoding))
+    ActiveRecord::Base.establish_connection(config)
+    
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/straitjacket.rb

@@ -0,0 +1,131 @@
+class Straitjacket
+  class Error < ::RuntimeError
+  end
+  
+  class Proxy
+    
+    def initialize(inner, table)
+      @inner = inner
+      @table = table
+    end
+    
+    def method_missing(method)
+      @name = method
+      self
+    end
+    
+    def deprecated(*names)
+      (names << @name).each do |name|
+        add_constraint DeprecatedConstraint.new(@table, name)
+      end
+    end
+    
+    def check(statement, options = {})
+      add_constraint CheckConstraint.new(@table, statement, named(options))
+    end
+
+    def foreign_key(column, options = {})
+      add_constraint ForeignKeyConstraint.new(@table, nil, named(options).merge(:column => column))
+    end
+    
+  private
+    def add_constraint(constraint)
+      if @inner.constraints.any?{|c| c.name == constraint.name}
+        raise Error, "#{c.name} already exists"
+      else
+        @inner.constraints << constraint
+      end
+    end
+
+    def named(hash)
+      if @name
+        hash = hash.dup
+        hash[:name] = @name
+        @name = nil
+      end
+      hash
+    end
+  end
+  
+  attr_reader :constraints
+  
+  def initialize(&block)
+    @constraints = []
+    @names = {}
+    instance_eval(&block) if block
+  end
+  
+  def apply(conn)
+    constraints.map{|c| c.apply(conn) }
+  end
+    
+  def on(table, &block)
+    proxy = Proxy.new(self, table)
+    proxy.instance_eval(&block) if block
+    proxy
+  end
+    
+  class Constraint
+    attr_accessor :name, :table, :sql, :content, :options, :column
+    
+    def initialize(table, content, options)
+      @column = options[:column]
+      @name = (options[:name] || default_name(table, options[:column])).to_s
+      @table = table
+      @content = content
+      @options = options
+    end
+    
+    def apply(conn)
+      conn.exec(sql)
+    rescue PGError => e
+      if e.message =~ /already exists/
+        conn.exec(%[ALTER TABLE "#{table}" DROP CONSTRAINT "#{name}"])
+        retry
+      else
+        raise
+      end
+    end
+    
+    def sql; raise "abstract"; end
+    
+  private
+    def default_name(table, column)
+      [table, column].compact.join("_")
+    end
+  end
+  
+  class DeprecatedConstraint < Constraint
+    def initialize(table, name)
+      @table = table
+      @name = name
+    end
+    
+    def sql
+      %[ALTER TABLE "#{table}" DROP CONSTRAINT "#{name}"]
+    end
+    
+    def apply(conn)
+      conn.exec(sql)
+    rescue
+      false
+    end
+  end
+  
+  class ForeignKeyConstraint < Constraint
+    def sql
+      more = ""
+      if options[:references]
+        on = options[:on] ? %[("#{options[:on]}")] : ""
+        more = %[REFERENCES "#{options[:references]}"#{on}]
+      end
+      %[ALTER TABLE "#{table}" ADD CONSTRAINT "#{name}" FOREIGN KEY ("#{column}") #{more} MATCH FULL]
+    end
+  end
+  
+  class CheckConstraint < Constraint
+    def sql
+      %[ALTER TABLE "#{table}" ADD CONSTRAINT "#{name}" CHECK (#{@content})]
+    end
+  end
+end

data/spec/database.yml

@@ -0,0 +1,4 @@
+adapter: postgresql
+database: straightjacket_test
+encoding: utf8
+template: template0

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'straitjacket'
+require 'spec'
+require 'spec/autorun'
+require "rubygems"
+require "active_record"
+require "yaml"
+
+Spec::Runner.configure do |config|
+  cfg = YAML.load(File.read("#{File.dirname(__FILE__)}/database.yml"))
+  ActiveRecord::Base.establish_connection(cfg)
+  $conn = ActiveRecord::Base.connection.raw_connection
+  
+  class User < ActiveRecord::Base
+    belongs_to :dog
+  end
+  
+  class Dog < ActiveRecord::Base
+    has_many :users
+  end
+end
+
+def rebuild_sql
+  $conn.exec <<-SQL
+    DROP TABLE IF EXISTS users;
+    DROP TABLE IF EXISTS dogs;
+    CREATE TABLE users (
+      id serial PRIMARY KEY,
+      dog_id INT NOT NULL,
+      name varchar(255)
+    );
+    
+    CREATE TABLE dogs (
+      id serial PRIMARY KEY,
+      name varchar(255)
+    );
+  SQL
+end

data/spec/straitjacket_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# Note these tests are stateful in the db.
+rebuild_sql
+describe "Straitjacket" do
+  context "with a sample" do
+    before do
+      @jacket = Straitjacket.new do
+        on :users do
+          name_gt_1.check "LENGTH(name) > 1"
+          dog1.foreign_key :dog_id, :references => :dogs, :on => :id
+          deprecated :foo 
+          another.deprecated
+        end
+      end
+    end
+    
+    it "should have correct number of constraints" do
+      @jacket.constraints.length.should == 5
+    end
+    
+    it "should have unique names" do
+      proc {
+        @jacket.on(:users).name_gt_1.check("something else")
+      }.should raise_error(Straitjacket::Error)
+    end
+    
+    describe "#apply" do
+      it "should apply all" do
+        conn = mock
+        @jacket.constraints.each do |c|
+          c.should_receive(:apply).with(conn)
+        end
+        @jacket.apply(conn)
+      end
+    end
+    
+    context "deprecated" do
+      it "should remove a key" do
+        conn = mock
+        conn.should_receive(:exec).with(%[ALTER TABLE \"users\" DROP CONSTRAINT \"another\"])
+        @jacket.constraints.last.apply(conn)
+      end
+    end
+    
+    context "foreign key" do
+      before do 
+        @key = @jacket.constraints[1]
+      end
+      
+      it "should generate sql" do
+        @key.sql.should == %[ALTER TABLE "users" ADD CONSTRAINT "dog1" FOREIGN KEY ("dog_id") REFERENCES "dogs"("id") MATCH FULL]
+      end
+        
+      it "should be able to apply sql" do
+        @key.apply($conn)
+      end
+
+      it "should be able to reapply sql" do
+        @key.apply($conn)
+      end
+
+    end
+    
+    context "check constraint" do
+      before do 
+        @first = @jacket.constraints.first
+      end
+      
+      it "should be named" do
+        rebuild_sql
+        @first.name.should == "name_gt_1"
+      end
+      
+      it "should be a check" do
+        @first.should be_a(Straitjacket::CheckConstraint)
+      end
+      
+      it "should generate sql" do
+        @first.sql.should == %[ALTER TABLE "users" ADD CONSTRAINT "name_gt_1" CHECK (LENGTH(name) > 1)]
+      end
+      
+      it "should be able to apply sql" do
+        @first.apply($conn)
+      end
+      
+      it "should be enforced" do
+        User.create! :name => "Joe", :dog_id => 1
+        proc {
+          User.create! :name => "e", :dog_id => 1
+        }.should raise_error(ActiveRecord::StatementInvalid)
+      end
+      
+      it "should not be applyable to an invalid db" do
+        @first.content = "LENGTH(name) > 10"
+        proc {
+          @first.apply($conn)
+        }.should raise_error(PGError)
+      end
+      
+      it "should be reapplyable/adjustable" do
+        User.delete_all
+        @first.content = "LENGTH(name) > 10"
+        @first.apply($conn)
+        proc {
+          User.create! :name => "Johnny", :dog_id => 1
+        }.should raise_error(ActiveRecord::StatementInvalid)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: straitjacket
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Kyle Maxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :development
+  version_requirements: *id002
+description: PostgreSQL constraints in Ruby
+email: kyle@kylemaxwell.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/straitjacket.rb
+- spec/database.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/straitjacket_spec.rb
+has_rdoc: true
+homepage: http://github.com/fizx/straitjacket
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: PostgreSQL constraints in Ruby
+test_files: 
+- spec/spec_helper.rb
+- spec/straitjacket_spec.rb