automigration 0.2.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. data/.rspec +1 -0
  2. data/.travis.yml +1 -3
  3. data/CHANGELOG.md +13 -0
  4. data/README.md +44 -23
  5. data/Rakefile +10 -12
  6. data/automigration.gemspec +4 -0
  7. data/lib/automigration.rb +5 -38
  8. data/lib/automigration/active_record_ext.rb +17 -0
  9. data/lib/automigration/db_column.rb +32 -0
  10. data/lib/automigration/dsl.rb +29 -0
  11. data/lib/automigration/engine.rb +23 -0
  12. data/lib/automigration/field.rb +75 -0
  13. data/lib/automigration/fields_keeper.rb +85 -0
  14. data/lib/automigration/migrator.rb +38 -77
  15. data/lib/automigration/version.rb +1 -1
  16. data/spec/dummy/.gitignore +2 -0
  17. data/spec/dummy/README.rdoc +261 -0
  18. data/spec/dummy/Rakefile +7 -0
  19. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  20. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  21. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  22. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  23. data/{log → spec/dummy/app/mailers}/.gitkeep +0 -0
  24. data/spec/dummy/app/models/.gitkeep +0 -0
  25. data/spec/dummy/app/models/accessible_model.rb +6 -0
  26. data/spec/dummy/app/models/auto_migration1.rb +14 -0
  27. data/{test → spec/dummy/app}/models/auto_migration1a.rb +2 -2
  28. data/{test → spec/dummy/app}/models/auto_migration2.rb +2 -2
  29. data/spec/dummy/app/models/auto_migration3.rb +5 -0
  30. data/{test → spec/dummy/app}/models/belongs_to_model.rb +0 -0
  31. data/{test → spec/dummy/app}/models/boolean_model.rb +0 -0
  32. data/{test → spec/dummy/app}/models/form_field.rb +0 -0
  33. data/{test → spec/dummy/app}/models/form_field2.rb +1 -1
  34. data/{test → spec/dummy/app}/models/local_name.rb +0 -0
  35. data/{test → spec/dummy/app}/models/local_name2.rb +0 -0
  36. data/{test → spec/dummy/app}/models/not_automigrable.rb +0 -0
  37. data/{test → spec/dummy/app}/models/searchable.rb +0 -0
  38. data/{test → spec/dummy/app}/models/simple.rb +0 -0
  39. data/{test → spec/dummy/app}/models/user1.rb +0 -0
  40. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  41. data/spec/dummy/config.ru +4 -0
  42. data/spec/dummy/config/application.rb +56 -0
  43. data/spec/dummy/config/boot.rb +10 -0
  44. data/spec/dummy/config/database.yml +14 -0
  45. data/spec/dummy/config/environment.rb +5 -0
  46. data/spec/dummy/config/environments/development.rb +37 -0
  47. data/spec/dummy/config/environments/production.rb +67 -0
  48. data/spec/dummy/config/environments/test.rb +37 -0
  49. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  50. data/spec/dummy/config/initializers/inflections.rb +15 -0
  51. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  52. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  53. data/spec/dummy/config/initializers/session_store.rb +8 -0
  54. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  55. data/spec/dummy/config/locales/en.yml +5 -0
  56. data/spec/dummy/config/routes.rb +58 -0
  57. data/spec/dummy/db/.gitkeep +0 -0
  58. data/spec/dummy/lib/assets/.gitkeep +0 -0
  59. data/spec/dummy/log/.gitkeep +0 -0
  60. data/spec/dummy/public/404.html +26 -0
  61. data/spec/dummy/public/422.html +26 -0
  62. data/spec/dummy/public/500.html +25 -0
  63. data/spec/dummy/public/favicon.ico +0 -0
  64. data/spec/dummy/script/rails +6 -0
  65. data/spec/lib/accessible_spec.rb +13 -0
  66. data/spec/lib/auto_migration_spec.rb +155 -0
  67. data/spec/lib/belongs_to_spec.rb +38 -0
  68. data/spec/lib/db_column_spec.rb +21 -0
  69. data/spec/lib/fields_spec.rb +22 -0
  70. data/spec/spec_helper.rb +24 -0
  71. metadata +106 -47
  72. data/lib/automigration/base_extention.rb +0 -15
  73. data/lib/automigration/fields/belongs_to.rb +0 -29
  74. data/lib/automigration/fields/boolean.rb +0 -9
  75. data/lib/automigration/fields/date.rb +0 -9
  76. data/lib/automigration/fields/datetime.rb +0 -9
  77. data/lib/automigration/fields/float.rb +0 -9
  78. data/lib/automigration/fields/integer.rb +0 -9
  79. data/lib/automigration/fields/password.rb +0 -9
  80. data/lib/automigration/fields/string.rb +0 -9
  81. data/lib/automigration/fields/sys/base.rb +0 -95
  82. data/lib/automigration/fields/sys/db_column.rb +0 -36
  83. data/lib/automigration/fields/sys/keeper.rb +0 -113
  84. data/lib/automigration/fields/sys/slice_creater.rb +0 -32
  85. data/lib/automigration/fields/text.rb +0 -9
  86. data/lib/automigration/fields/time.rb +0 -9
  87. data/test/auto_migration_test.rb +0 -186
  88. data/test/belongs_to_test.rb +0 -51
  89. data/test/db_column_test.rb +0 -23
  90. data/test/fields/accessible_test.rb +0 -13
  91. data/test/fields_test.rb +0 -34
  92. data/test/models/accessible_model.rb +0 -6
  93. data/test/models/auto_migration1.rb +0 -14
  94. data/test/models/auto_migration3.rb +0 -5
  95. data/test/test_helper.rb +0 -35
@@ -1,54 +1,34 @@
1
1
  module Automigration
2
2
  class Migrator
3
3
  mattr_reader :system_tables
4
- mattr_reader :migrations_path
5
- mattr_reader :models_load_path
6
- mattr_reader :models_to_ignore
4
+ mattr_reader :migration_paths
5
+ mattr_reader :model_paths
7
6
  @@system_tables = []
8
- @@migrations_path = nil
9
- @@models_load_path = []
10
- @@models_to_ignore = []
7
+ @@migration_paths = []
8
+ @@model_paths = []
11
9
 
12
10
  def self.set_system_tables(tables)
13
11
  @@system_tables = tables
14
12
  end
15
13
 
16
- def self.set_migrations_path(path)
17
- @@migrations_path = path
14
+ def self.set_migration_paths(paths)
15
+ @@migration_paths = paths
18
16
  end
19
17
 
20
- def self.set_models_load_path(paths)
21
- @@models_load_path = paths
22
- end
23
-
24
- def self.set_models_to_ignore(models)
25
- @@models_to_ignore = models
26
- end
27
-
28
- def self.all_tables
29
- sql = "SELECT tablename FROM pg_tables WHERE schemaname = 'public';"
30
- ActiveRecord::Base.connection.execute(sql).map do |row|
31
- row["tablename"]
32
- end
33
- end
34
-
35
- def self.get_models
36
- @@models_load_path.map do |path|
37
- Dir[File.expand_path("**/*.rb", path)].map do |model_file|
38
- model_name = model_file.sub(path.to_s + '/', '').sub(/.rb$/, '')
39
- next if @@models_to_ignore.include?(model_name)
40
- model = model_name.camelize.constantize
41
- if model && model.is_a?(Class) && model.superclass == ActiveRecord::Base
42
- model
43
- end
44
- end
45
- end.flatten.compact
18
+ def self.set_model_paths(paths)
19
+ @@model_paths = paths
46
20
  end
47
21
 
48
22
  def initialize(options = {})
49
23
  options.assert_valid_keys(:skip_output, :models)
50
24
 
51
- @models = options[:models] || self.class.get_models
25
+ @@model_paths.each do |path|
26
+ Dir[File.expand_path("**/*.rb", path)].each do |file|
27
+ require file
28
+ end
29
+ end
30
+
31
+ @models = options[:models] || ActiveRecord::Base.descendants
52
32
  @options = options
53
33
  end
54
34
 
@@ -60,86 +40,67 @@ module Automigration
60
40
  @models.each do |model|
61
41
  update_model_schema(model)
62
42
  tables << model.table_name
63
-
64
- # update globalize2 tables
65
- if model.respond_to?(:translated_attribute_names)
66
- translated_model = translated_model(model)
67
- update_model_schema(translated_model)
68
- tables << translated_model.table_name
69
- end
70
43
  end
71
44
 
72
45
  #remove unused tables
73
- (self.class.all_tables - tables - @@system_tables).each do |table|
74
- con.drop_table(table)
46
+ (connection.tables - tables - @@system_tables).each do |table|
47
+ connection.drop_table(table)
75
48
  log "Remove table '#{table}'", :red
76
49
  end
77
50
 
78
51
  # clean migration table
79
- if con.table_exists?('schema_migrations') and @@migrations_path
52
+ if connection.table_exists?('schema_migrations') && !@@migration_paths.empty?
80
53
  sql = "SELECT version FROM schema_migrations;"
81
54
 
82
- migrations_in_db = con.execute(sql).map{|row| row['version']}
83
- current_migrations = Dir[File.expand_path("*.rb", @@migrations_path)].map do |m_file|
84
- File.basename(m_file) =~ /(\d{14})/
85
- $1
55
+ migrations_in_db = connection.execute(sql).map{|row| row['version']}
56
+ current_migrations = []
57
+ @@migration_paths.each do |path|
58
+ Dir[File.expand_path("*.rb", path)].each do |m_file|
59
+ File.basename(m_file) =~ /(\d{14})/
60
+ current_migrations << $1
61
+ end
86
62
  end
87
63
 
88
64
  (migrations_in_db - current_migrations).each do |m|
89
65
  log "Clean migration '#{m}'", :red
90
66
  sql = "DELETE FROM schema_migrations WHERE version = '#{m}';"
91
- con.execute(sql)
67
+ connection.execute(sql)
92
68
  end
93
69
  end
94
70
  end
95
71
 
96
72
  private
97
- def translated_model(model)
98
- Class.new(ActiveRecord::Base).tap do |out|
99
- out.set_table_name((model.model_name.underscore + '_translation').pluralize)
100
-
101
- out.has_fields do |f|
102
- f.integer "#{model.table_name.singularize}_id"
103
- f.string :locale
104
- model.translated_attribute_names.each do |attr_name|
105
- model.fields_keeper.db_columns_for_field(attr_name).each do |column|
106
- f.send column.type, column.name
107
- end
108
- end
109
- end
110
- end
111
- end
112
73
 
113
74
  def update_model_schema(model)
114
75
  # 0. Create table if need
115
- unless con.table_exists?(model.table_name)
116
- con.create_table(model.table_name) {}
76
+ unless connection.table_exists?(model.table_name)
77
+ connection.create_table(model.table_name) {}
117
78
  log "Create table #{model.table_name}", :green
118
79
  model.reset_column_information
119
80
  end
120
81
 
121
- unless model.fields_keeper.auto_migrable?
82
+ unless model.auto_migrable?
122
83
  log "#{model.to_s} skipped", :yellow
123
84
  else
124
85
  log "process #{model.to_s} ..."
125
- auto_columns = model.fields_keeper.db_columns
86
+ auto_columns = model.field_db_columns
126
87
  auto_columns_names = auto_columns.map{|c| c.name.to_s}
127
88
  auto_columns_hash = Hash[auto_columns.map{|c| [c.name.to_s, c]}]
128
89
 
129
90
  # 1. update columns
130
91
  (model.column_names & auto_columns_names).each do |name|
131
- model_column = Fields::Sys::DbColumn.from_activerecord_column(model.columns_hash[name])
92
+ model_column = Automigration::DbColumn.from_activerecord_column(model.columns_hash[name])
132
93
  auto_column = auto_columns_hash[name]
133
94
 
134
95
  unless model_column.the_same?(auto_column)
135
96
  begin
136
- con.change_column(model.table_name, name, auto_column.type, auto_column.to_options)
97
+ connection.change_column(model.table_name, name, auto_column.type, auto_column.to_options)
137
98
 
138
99
  log "Update column #{name} of #{model.table_name} " +
139
100
  "to :#{auto_column.type} type and options #{auto_column.to_options.inspect}", :yellow
140
101
  rescue
141
- con.remove_column(model.table_name, name)
142
- con.add_column(model.table_name, name, auto_column.type, auto_column.to_options)
102
+ connection.remove_column(model.table_name, name)
103
+ connection.add_column(model.table_name, name, auto_column.type, auto_column.to_options)
143
104
  log "recreate column #{name} in #{model.table_name}", :yellow
144
105
  end
145
106
  end
@@ -148,7 +109,7 @@ module Automigration
148
109
  # 2. add new columns
149
110
  (auto_columns_names - model.column_names).each do |name|
150
111
  auto_column = auto_columns_hash[name]
151
- con.add_column(model.table_name, name, auto_column.type, auto_column.to_options)
112
+ connection.add_column(model.table_name, name, auto_column.type, auto_column.to_options)
152
113
  log "Add column #{name} to #{model.table_name}", :green
153
114
 
154
115
  model.reset_column_information
@@ -160,9 +121,9 @@ module Automigration
160
121
  end
161
122
 
162
123
  # 3. remove obsoleted columns
163
- not_to_del = ['id'] + model.fields_keeper.migration_attrs
124
+ not_to_del = ['id'] + model.migration_attrs
164
125
  (model.column_names - auto_columns_names - not_to_del).each do |name|
165
- con.remove_column(model.table_name, name)
126
+ connection.remove_column(model.table_name, name)
166
127
  log "Remove column #{name} from #{model.table_name}", :red
167
128
  end
168
129
 
@@ -170,7 +131,7 @@ module Automigration
170
131
  end
171
132
  end
172
133
 
173
- def con
134
+ def connection
174
135
  ActiveRecord::Base.connection
175
136
  end
176
137
 
@@ -1,3 +1,3 @@
1
1
  module Automigration
2
- VERSION = "0.2.2"
2
+ VERSION = "1.0.0"
3
3
  end
@@ -0,0 +1,2 @@
1
+ /log/*.log
2
+ /db/schema.rb
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | |-- images
161
+ | |-- javascripts
162
+ | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | `-- tasks
177
+ |-- log
178
+ |-- public
179
+ |-- script
180
+ |-- test
181
+ | |-- fixtures
182
+ | |-- functional
183
+ | |-- integration
184
+ | |-- performance
185
+ | `-- unit
186
+ |-- tmp
187
+ | |-- cache
188
+ | |-- pids
189
+ | |-- sessions
190
+ | `-- sockets
191
+ `-- vendor
192
+ |-- assets
193
+ `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.