active_record_inline_schema 0.6.0 → 0.6.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.6.1 / 2013-03-15
+
+* Enhancements
+
+  * :dry_run option that just prints info to your log
+  * if AR::Base#primary_key is false-y (e.g. you set Pet.primary_key = false), don't automatically create a primary key column
+
 0.6.0 / 2012-11-29
 
 * Breaking changes
@@ -123,4 +130,4 @@ After I made this list, I decided to diverge from mini_record v0.2.1 instead of
 * automagically generate fields from associations
 * revised difference checking code
 
-Pity the forker (me)!
+Pity the forker (me)!

data/README.md

@@ -4,6 +4,8 @@ Define table structure (columns and indexes) inside your ActiveRecord models lik
 
 Specify columns like you would with ActiveRecord migrations and then run .auto_upgrade! Based on the mini_record gem from Davide D'Agostino, it adds fewer aliases, doesn't create timestamps and relationship columns automatically.
 
+You don't have to be connected to the database when you run the DSL methods.
+
 ## Production use
 
 Over 2 years in [Brighter Planet's environmental impact API](http://impact.brighterplanet.com) and [reference data service](http://data.brighterplanet.com).
@@ -40,6 +42,12 @@ Lots and lots of use in the [`earth` library](https://github.com/brighterplanet/
     end
     ApiResponse.auto_upgrade!
 
+    # you can also do this
+    ApiResponse.auto_upgrade! :dry_run => true
+
+    # this won't delete columns that it doesn't know about
+    ApiResponse.auto_upgrade! :gentle => true
+
 ## Credits
 
 Massive thanks to DAddYE, who you follow on twitter [@daddye](http://twitter.com/daddye) and look at his site at [daddye.it](http://www.daddye.it)
@@ -55,7 +63,7 @@ Forked from [`mini_record` version v0.2.1](https://github.com/DAddYE/mini_record
 
 ## Copyright
 
-Copyright 2012 Seamus Abshere
+Copyright 2013 Seamus Abshere
 
 Adapted from [mini_record](https://github.com/DAddYE/mini_record), which is copyright 2011 Davide D'Agostino
 

data/lib/active_record_inline_schema/config.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'logger'
 
 class ActiveRecordInlineSchema::Config
   attr_reader :model
@@ -19,18 +20,28 @@ class ActiveRecordInlineSchema::Config
     ideal_indexes.add Index.new(self, column_name, options)
   end
 
+  def log_dry(msg)
+    (ActiveRecord::Base.logger || (@logger ||= Logger.new($stderr))).info "[ActiveRecordInlineSchema DRY RUN] #{msg}"
+  end
+
   def apply(options)
-    non_standard_primary_key = if (primary_key_column = find_ideal_column(model.primary_key))
-      primary_key_column.type != :primary_key
+    dry_run = options.fetch(:dry_run, false)
+    has_primary_key = true
+    non_standard_primary_key = false
+
+    if !model.primary_key
+      has_primary_key = false
+    elsif (primary_key_column = find_ideal_column(model.primary_key))
+      non_standard_primary_key = (primary_key_column.type != :primary_key)
     elsif model.primary_key != 'id'
-      true
+      non_standard_primary_key = true
     end
     
     if non_standard_primary_key
       if primary_key_column and (postgresql? or sqlite?)
         primary_key_column.options[:null] = false
       end
-    else
+    elsif has_primary_key
       add_ideal_column :id, :type => :primary_key
     end
 
@@ -54,7 +65,11 @@ class ActiveRecordInlineSchema::Config
       end
 
       statements.each do |sql|
-        connection.execute sql
+        if dry_run
+          log_dry sql
+        else
+          connection.execute sql
+        end
       end
       safe_reset_column_information
     end
@@ -69,7 +84,11 @@ class ActiveRecordInlineSchema::Config
       existing_column_names.reject do |existing_column_name|
         find_ideal_column existing_column_name
       end.each do |existing_column_name|
-        connection.remove_column model.table_name, existing_column_name
+        if dry_run
+          log_dry "remove column #{model.table_name}.#{existing_column_name}"
+        else
+          connection.remove_column model.table_name, existing_column_name
+        end
       end
     end
 
@@ -77,7 +96,11 @@ class ActiveRecordInlineSchema::Config
     ideal_columns.reject do |ideal_column|
       find_existing_column ideal_column.name
     end.each do |ideal_column|
-      connection.add_column model.table_name, ideal_column.name, ideal_column.type, ideal_column.options
+      if dry_run
+        log_dry "add column #{model.table_name}.#{ideal_column.name} #{ideal_column.type} #{ideal_column.options.inspect}"
+      else
+        connection.add_column model.table_name, ideal_column.name, ideal_column.type, ideal_column.options
+      end
     end
 
     # Change attributes of existent columns
@@ -101,7 +124,11 @@ class ActiveRecordInlineSchema::Config
 
       # Change the column if applicable
       if type_changed or option_changes.any?
-        connection.change_column model.table_name, existing_column_name, ideal_column.type, option_changes
+        if dry_run
+          log_dry "change column #{model.table_name}.#{existing_column_name} #{ideal_column.type} #{option_changes.inspect}"
+        else
+          connection.change_column model.table_name, existing_column_name, ideal_column.type, option_changes
+        end
       end
     end
 
@@ -110,7 +137,11 @@ class ActiveRecordInlineSchema::Config
       existing_index_names.reject do |existing_index_name|
         find_ideal_index existing_index_name
       end.each do |existing_index_name|
-        connection.remove_index model.table_name, :name => existing_index_name
+        if dry_run
+          log_dry "remove index #{model.table_name} #{existing_index_name}"
+        else
+          connection.remove_index model.table_name, :name => existing_index_name
+        end
       end
     end
 
@@ -118,7 +149,11 @@ class ActiveRecordInlineSchema::Config
     ideal_indexes.reject do |ideal_index|
       find_existing_index ideal_index.name
     end.each do |ideal_index|
-      connection.add_index model.table_name, ideal_index.column_name, ideal_index.options
+      if dry_run
+        log_dry "add index #{model.table_name}.#{ideal_index.column_name} #{ideal_index.options.inspect}"
+      else
+        connection.add_index model.table_name, ideal_index.column_name, ideal_index.options
+      end
     end
 
     safe_reset_column_information
@@ -190,6 +225,6 @@ class ActiveRecordInlineSchema::Config
   end
 
   def postgresql?
-    connection.adapter_name =~ /postgresql/i
+    connection.adapter_name =~ /postgres/i
   end
 end

data/lib/active_record_inline_schema/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordInlineSchema
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spec/models.rb

@@ -109,6 +109,12 @@ class Pet6 < ActiveRecord::Base
   col :yesno, :type => :boolean
 end
 
+class Pet7 < ActiveRecord::Base
+  include SpecHelper
+  self.primary_key = false
+  col :name
+end
+
 case ENV['DB_ADAPTER']
 when 'mysql'
   class CustomMysql < ActiveRecord::Base
@@ -122,4 +128,4 @@ when 'postgresql'
     col :inet, :type => 'inet'
     col :bytea, :type => 'bytea'
   end
-end
+end

data/spec/shared_examples.rb

@@ -6,12 +6,7 @@ describe ActiveRecordInlineSchema do
   end
 
   describe :regressions do
-    def assert_unique(model, column_name, v)
-      e = if sqlite?
-        ActiveRecord::StatementInvalid
-      else
-        ActiveRecord::RecordNotUnique
-      end
+    def assert_unique(model, column_name, v, e = ActiveRecord::RecordNotUnique)
       lambda do
         2.times do
           p = model.new
@@ -22,8 +17,13 @@ describe ActiveRecordInlineSchema do
     end
 
     it "properly creates tables with only one column, an auto-increment primary key" do
+      e = if sqlite?
+        ActiveRecord::StatementInvalid
+      else
+        ActiveRecord::RecordNotUnique
+      end
       Pet3.auto_upgrade!
-      assert_unique Pet3, :id, 1
+      assert_unique Pet3, :id, 1, e
     end
 
     it "properly creates with only one column, a string primary key" do
@@ -47,6 +47,13 @@ describe ActiveRecordInlineSchema do
     Pet6.columns_hash['yesno'].type.must_equal :boolean
   end
 
+  it "doesn't force you to have a primary key" do
+    Pet7.auto_upgrade!
+    Pet7.primary_key.must_equal false
+    Pet7.columns_hash['id'].must_equal nil
+    Pet7.columns_hash['name'].type.must_equal :string
+  end
+
   it "deletes unrecognized columns by default" do
     Pet6.auto_upgrade!
     ActiveRecord::Base.connection.add_column Pet6.table_name, 'foo', :string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_inline_schema
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Define table structure (columns and indexes) inside your ActiveRecord models