pg_index_where 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWEzMzNmMGFhZjg4ZDkzNjdmODhmNjk1ZGM4NDNkZmU2NzJjNjdmOA==
+  data.tar.gz: !binary |-
+    YjJkMzFkZDhiYzAyZjYxOTQ0YTk2Nzc1YWEyZDNjMzc2ODBmZjdkMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YThkNzVhZTQxMWNiMTM2NTVkOWI0OGQwZGVhY2RlZmUyM2YyODYxZDdmMGM5
+    ZTcwN2QyNWY3M2I4Y2U4YzdiNzAzNDc3YWU1YmVjNzk4M2Y5MjQ3YmU0MTk1
+    NTEzYzRhY2U5MDQzYWVmYjQwOGM4OGYyMjNhZTQzNDc1NGJhOTY=
+  data.tar.gz: !binary |-
+    MDIwOWFmY2E4NGYxMzg5NzA3MjVkMzY4MmE1NmY2NTllYTAyNGMzZDE3Njcw
+    ZjdkZGJkMDEyZDc3ZjdlNjA1YmRiZjA1NDNmNTk5NTVhOGQyYzhjNTMxMmM4
+    MTJmNzk2MDMyNGI2ODY2OGQyMDM5ZGFlMDMwZDJhODBjZjY1MjE=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+log/
+spec/db/schema.rb

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yamamoto Kazuhisa
+
+MIT License
+
+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,46 @@
+# PgIndexWhere
+
+When create unique index on PostgreSQL, you can speficy WHERE statement as you know.
+
+pg_index_where will provide this function with migrate the database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_index_where'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_index_where
+
+## Usage
+
+Add this option your migrate files.
+
+    :where => 'deleted_at is null'
+   
+Examples.
+
+    class AddIndex < ActiveRecord::Migration
+      def up
+        add_index "customers", ["code"], :name => "customers_idx01", :unique => true, :where => 'deleted_at is null'
+      end
+      
+      def down
+        remove_index "customers", :name => "customers_idx01"
+      end
+    end
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/pg_index_where.rb

@@ -0,0 +1,3 @@
+require 'pg_index_where/version'
+require 'pg_index_where/schema_statements'
+require 'pg_index_where/schema_dumper'

data/lib/pg_index_where/schema_dumper.rb

@@ -0,0 +1,41 @@
+module ActiveRecord
+  class SchemaDumper
+    private
+    def indexes(table, stream)
+      if (indexes = @connection.indexes(table)).any?
+        add_index_statements = indexes.map do |index|
+          statement_parts = [
+            ('add_index ' + remove_prefix_and_suffix(index.table).inspect),
+            index.columns.inspect,
+            (':name => ' + index.name.inspect),
+          ]
+          statement_parts << ':unique => true' if index.unique
+
+          index_lengths = (index.lengths || []).compact
+          statement_parts << (':length => ' + Hash[index.columns.zip(index.lengths)].inspect) unless index_lengths.empty?
+
+          index_orders = (index.orders || {})
+          statement_parts << (':order => ' + index.orders.inspect) unless index_orders.empty?
+
+          index_where = index_with_where(index.name)
+          statement_parts << (':where => ' + index_where.inspect) unless index_where.nil?
+
+          '  ' + statement_parts.join(', ')
+        end
+
+        stream.puts add_index_statements.sort.join("\n")
+        stream.puts
+      end
+    end
+
+    def index_with_where(name)
+      sql = <<-EOS
+        select pg_get_expr(i.indpred, i.indrelid) from pg_class c
+        inner join pg_index i on c.oid = i.indexrelid
+        where c.relname = '#{name}';
+      EOS
+      query_result = @connection.exec_query(sql).first
+      query_result ? query_result['pg_get_expr'] : nil
+    end
+  end
+end

data/lib/pg_index_where/schema_statements.rb

@@ -0,0 +1,11 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module SchemaStatements
+      def add_index(table_name, column_name, options = {})
+        where = options[:where] ? "where #{options[:where]}" : ''
+        index_name, index_type, index_columns = add_index_options(table_name, column_name, options)
+        execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{index_columns}) #{where}"
+      end
+    end
+  end
+end

data/lib/pg_index_where/version.rb

@@ -0,0 +1,3 @@
+module PgIndexWhere
+  VERSION = '0.1.0'
+end

data/pg_index_where.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_index_where/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_index_where'
+  spec.version       = PgIndexWhere::VERSION
+  spec.authors       = ['Yamamoto Kazuhisa']
+  spec.email         = ['ak.hisashi@gmail.com']
+  spec.description   = %q{pg_index_where will provide unique index with WHERE statement on PostgreSQL with migrate the database on Rails.}
+  spec.summary       = %q{When create unique index on PostgreSQL, you can speficy WHERE statement as you know. pg_index_where will provide this function with migrate the database.}
+  spec.homepage      = 'https://github.com/kazuhisa/pg_index_where'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'rails', '>= 3.0.7'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'acts_as_paranoid'
+  spec.add_dependency 'pg', '~> 0.15'
+  spec.add_dependency 'activerecord', '>= 3.0.7'
+end

data/spec/db/migrate/20130518094839_create_customers.rb

@@ -0,0 +1,11 @@
+class CreateCustomers < ActiveRecord::Migration
+  def change
+    create_table :customers do |t|
+      t.string :name
+      t.string :code
+
+      t.datetime :deleted_at
+      t.timestamps
+    end
+  end
+end

data/spec/db/migrate/20130518101149_add_index.rb

@@ -0,0 +1,9 @@
+class AddIndex < ActiveRecord::Migration
+  def up
+    add_index :customers, :code, :name => 'customers_idx01', :unique => true, :where => 'deleted_at IS NULL'
+  end
+
+  def down
+    remove_index :customers, :name => 'customers_idx01'
+  end
+end

data/spec/fake_app.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+require 'active_record'
+require 'action_controller'
+require 'pg_index_where'
+require 'acts_as_paranoid'
+
+# database
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'postgresql', :database => 'test_pg_index_where',
+                                                :min_messages => 'WARNING'}}
+ActiveRecord::Base.establish_connection('test')
+
+# models
+class Customer < ActiveRecord::Base
+  acts_as_paranoid
+  attr_accessible :name, :code
+end

data/spec/pg_index_where_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'ActiveRecord::ConnectionAdapters::SchemaStatements.add_index' do
+  before do
+    ActiveRecord::Migrator.migrate(%w(spec/db/migrate), nil)
+  end
+  context 'migration is performed.' do
+    subject do
+      sql = "select pg_get_indexdef(relfilenode) from pg_class where relname = 'customers_idx01'"
+      ActiveRecord::Base.connection.execute(sql)[0]
+    end
+    its(['pg_get_indexdef']){should =~ /where.+deleted_at IS NULL/i}
+  end
+
+  describe 'Tests for acts_as_paranoid' do
+    context 'Insertion on a table' do
+      it do
+        expect do
+          Customer.create(:code => '001', :name => 'Yukari Tamura')
+          Customer.create(:code => '002', :name => 'Nana Mizuki')
+        end.to change{Customer.scoped.size}.from(0).to(2)
+      end
+    end
+    context 'When a deleted code is inserted.' do
+      before do
+        Customer.destroy_all(:code => '001')
+      end
+      it do
+        expect do
+          Customer.create(:code => '001', :name => 'Yui Horie')
+        end.to change{Customer.scoped.size}.from(1).to(2)
+      end
+
+      context 'When the duplicate code is inserted.' do
+        before do
+          Customer.create(:code => '001', :name => 'Yui Horie')
+        end
+        it do
+          expect do
+            Customer.create!(:code => '001', :name => 'Yukari Tamura')
+          end.to raise_error(ActiveRecord::RecordNotUnique)
+        end
+      end
+    end
+  end
+
+  describe 'ActiveRecord::SchemaDumper.dump' do
+    before do
+      filename = 'spec/db/schema.rb'
+      File.open(filename, 'w:utf-8') do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+    subject{open('spec/db/schema.rb','r').read}
+    it{should =~ /:where => "\(deleted_at IS NULL\)"/}
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rails'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+require File.join(File.dirname(__FILE__), 'fake_app')
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.before :all do
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Migrator.rollback(%w(spec/db/migrate), 2)
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: pg_index_where
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yamamoto Kazuhisa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: acts_as_paranoid
+  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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+description: pg_index_where will provide unique index with WHERE statement on PostgreSQL
+  with migrate the database on Rails.
+email:
+- ak.hisashi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_index_where.rb
+- lib/pg_index_where/schema_dumper.rb
+- lib/pg_index_where/schema_statements.rb
+- lib/pg_index_where/version.rb
+- pg_index_where.gemspec
+- spec/db/migrate/20130518094839_create_customers.rb
+- spec/db/migrate/20130518101149_add_index.rb
+- spec/fake_app.rb
+- spec/pg_index_where_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kazuhisa/pg_index_where
+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.0.3
+signing_key: 
+specification_version: 4
+summary: When create unique index on PostgreSQL, you can speficy WHERE statement as
+  you know. pg_index_where will provide this function with migrate the database.
+test_files:
+- spec/db/migrate/20130518094839_create_customers.rb
+- spec/db/migrate/20130518101149_add_index.rb
+- spec/fake_app.rb
+- spec/pg_index_where_spec.rb
+- spec/spec_helper.rb