acts_as_relation 0.1 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (59) hide show
  1. data/.gitignore +1 -0
  2. data/Gemfile +1 -1
  3. data/MIT-LICENSE +20 -0
  4. data/README.rdoc +3 -3
  5. data/acts_as_relation.gemspec +3 -1
  6. data/init.rb +1 -0
  7. data/lib/active_record/acts_as_relation.rb +15 -11
  8. data/lib/version.rb +1 -1
  9. data/spec/{acts_as_relation/acts_as_relation_spec.rb → acts_as_relation_spec.rb} +19 -4
  10. data/spec/acts_as_superclass_spec.rb +14 -0
  11. data/spec/dummy/.rspec +1 -0
  12. data/spec/dummy/README.rdoc +261 -0
  13. data/spec/dummy/Rakefile +7 -0
  14. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  15. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  16. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  17. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  18. data/spec/dummy/app/mailers/.gitkeep +0 -0
  19. data/spec/dummy/app/models/.gitkeep +0 -0
  20. data/spec/dummy/app/models/pen.rb +6 -0
  21. data/spec/dummy/app/models/pencil.rb +3 -0
  22. data/spec/dummy/app/models/product.rb +11 -0
  23. data/spec/dummy/app/models/store.rb +2 -0
  24. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  25. data/spec/dummy/config.ru +4 -0
  26. data/spec/dummy/config/application.rb +64 -0
  27. data/spec/dummy/config/boot.rb +10 -0
  28. data/spec/dummy/config/database.yml +25 -0
  29. data/spec/dummy/config/environment.rb +5 -0
  30. data/spec/dummy/config/environments/development.rb +37 -0
  31. data/spec/dummy/config/environments/production.rb +67 -0
  32. data/spec/dummy/config/environments/test.rb +37 -0
  33. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  34. data/spec/dummy/config/initializers/inflections.rb +15 -0
  35. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  36. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  37. data/spec/dummy/config/initializers/session_store.rb +8 -0
  38. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  39. data/spec/dummy/config/locales/en.yml +5 -0
  40. data/spec/dummy/config/routes.rb +58 -0
  41. data/spec/dummy/db/migrate/001_create_stores.rb +9 -0
  42. data/spec/dummy/db/migrate/002_create_products.rb +10 -0
  43. data/spec/dummy/db/migrate/003_create_pens.rb +9 -0
  44. data/spec/dummy/db/migrate/004_create_pencils.rb +8 -0
  45. data/spec/dummy/db/schema.rb +44 -0
  46. data/spec/dummy/lib/assets/.gitkeep +0 -0
  47. data/spec/dummy/log/.gitkeep +0 -0
  48. data/spec/dummy/public/404.html +26 -0
  49. data/spec/dummy/public/422.html +26 -0
  50. data/spec/dummy/public/500.html +25 -0
  51. data/spec/dummy/public/favicon.ico +0 -0
  52. data/spec/dummy/script/rails +6 -0
  53. data/spec/spec_helper.rb +9 -6
  54. metadata +161 -26
  55. data/spec/acts_as_migration/acts_as_migratoin_spec.rb +0 -24
  56. data/spec/acts_as_migration/models.rb +0 -7
  57. data/spec/acts_as_migration/schema.rb +0 -33
  58. data/spec/acts_as_relation/models.rb +0 -25
  59. data/spec/acts_as_relation/schema.rb +0 -28
data/.gitignore CHANGED
@@ -7,3 +7,4 @@ tmp/*
7
7
  doc/*
8
8
  *.sqlite3
9
9
  *.log
10
+ spec/dummy/tmp/*
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source "http://rubygems.org"
1
+ source "https://rubygems.org"
2
2
 
3
3
  # Specify your gem's dependencies in acts_as_list-rails3.gemspec
4
4
  gemspec
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 Hassan Zamani
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc CHANGED
@@ -80,14 +80,14 @@ On the other hand you can always access a specific object from its parent by cal
80
80
  The +acts_as+ relation support these options:
81
81
 
82
82
  * +:as+
83
- * +:auto_join+
83
+ * +:auto_include+
84
84
  * +:class_name+
85
85
  * +:conditions+
86
86
  * +:dependent+
87
87
  * +:include+
88
88
 
89
- when +:auto_join+ option set to +true+ (wich is by default), every query on child
90
- will automatically joins with paren. For example:
89
+ when +:auto_join+ option set to +true+ (which is by default), every query on child
90
+ will automatically includes the parent. For example:
91
91
 
92
92
  Pen.where("name = ?", "somename")
93
93
 
@@ -26,6 +26,8 @@ Gem::Specification.new do |s|
26
26
  s.add_development_dependency "rake"
27
27
  s.add_development_dependency "bundler"
28
28
  s.add_development_dependency "sqlite3"
29
- s.add_development_dependency "rspec"
29
+ s.add_development_dependency "rspec-rails"
30
+ s.add_development_dependency "rails"
31
+ s.add_development_dependency "database_cleaner"
30
32
  s.add_dependency "activerecord"
31
33
  end
data/init.rb ADDED
@@ -0,0 +1 @@
1
+ require 'acts_as_relation'
@@ -9,7 +9,7 @@ module ActiveRecord
9
9
  protected
10
10
  def define_acts_as_accessors(attribs, model_name)
11
11
  attribs.each do |attrib|
12
- class_eval <<-EndEval
12
+ code = <<-EndCode
13
13
  def #{attrib}
14
14
  #{model_name}.#{attrib}
15
15
  end
@@ -21,7 +21,8 @@ module ActiveRecord
21
21
  def #{attrib}?
22
22
  #{model_name}.#{attrib}?
23
23
  end
24
- EndEval
24
+ EndCode
25
+ class_eval code, __FILE__, __LINE__
25
26
  end
26
27
  end
27
28
  end
@@ -48,7 +49,7 @@ module ActiveRecord
48
49
  :conditions => options[:conditions]
49
50
  }
50
51
 
51
- acts_as_model.module_eval <<-EndEval
52
+ code = <<-EndCode
52
53
  def self.included(base)
53
54
  base.has_one :#{name}, #{has_one_options}
54
55
  base.validate :#{name}_must_be_valid
@@ -87,7 +88,8 @@ module ActiveRecord
87
88
  end
88
89
  end
89
90
  end
90
- EndEval
91
+ EndCode
92
+ acts_as_model.module_eval code, __FILE__, __LINE__
91
93
  end
92
94
 
93
95
  class_eval do
@@ -95,10 +97,10 @@ module ActiveRecord
95
97
  end
96
98
 
97
99
  if options.fetch :auto_join, true
98
- class_eval "default_scope joins(:#{name})"
100
+ class_eval "default_scope joins(:#{name}).readonly(false)"
99
101
  end
100
102
 
101
- instance_eval <<-EndEval
103
+ code = <<-EndCode
102
104
  def acts_as_other_model?
103
105
  true
104
106
  end
@@ -106,21 +108,23 @@ module ActiveRecord
106
108
  def acts_as_model_name
107
109
  :#{name}
108
110
  end
109
- EndEval
111
+ EndCode
112
+ instance_eval code, __FILE__, __LINE__
110
113
  end
111
114
  alias :is_a :acts_as
112
115
 
113
- def acts_as_superclass
114
- association_name = acts_as_association_name
116
+ def acts_as_superclass options={}
117
+ association_name = options[:as] || acts_as_association_name
115
118
 
116
- class_eval <<-EndEval
119
+ code = <<-EndCode
117
120
  belongs_to :#{association_name}, :polymorphic => true
118
121
 
119
122
  def specific
120
123
  self.#{association_name}
121
124
  end
122
125
  alias :specific_class :specific
123
- EndEval
126
+ EndCode
127
+ class_eval code, __FILE__, __LINE__
124
128
  end
125
129
  alias :is_a_superclass :acts_as_superclass
126
130
 
data/lib/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module ActiveRecord
2
2
  module ActsAsRelation
3
- VERSION = "0.1"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
@@ -1,10 +1,6 @@
1
1
  require 'spec_helper'
2
2
 
3
3
  describe "Submodel" do
4
- before :all do
5
- ActsAsRelationSchema.migrate
6
- end
7
-
8
4
  it "inherits Supermodel attributes" do
9
5
  pen = Pen.new
10
6
  ['name', 'name=', 'name_changed?', 'name_was',
@@ -43,6 +39,13 @@ describe "Submodel" do
43
39
  pen.parent_method.should == "RedPen - 0.8"
44
40
  end
45
41
 
42
+ # it "inherits Supermodel dynamic finders" do
43
+ # pending
44
+ # pen = Pen.create :name => 'RedPen'
45
+ # product = Product.create :name => 'SomeProduct'
46
+ # Product.find_by_name('SomeProduct').should == product
47
+ # end
48
+
46
49
  it "should raise NoMethodEror on unexisting method calls" do
47
50
  pen = Pen.create :name => 'RedPen', :price => 0.8, :color => 'red'
48
51
  lambda { pen.unexisted_method }.should raise_error(NoMethodError)
@@ -67,6 +70,18 @@ describe "Submodel" do
67
70
  end
68
71
  end
69
72
 
73
+ it "should be findable" do
74
+ pen = Pen.create :name => 'RedPen', :price => 0.8, :color => 'red'
75
+ pen = Pen.find(pen.id)
76
+ pen.should be_valid
77
+ end
78
+
79
+ it "should be saveable" do
80
+ pen = Pen.create :name => 'RedPen', :price => 0.8, :color => 'red'
81
+ pen = Pen.find(pen.id)
82
+ lambda { pen.save }.should_not raise_error
83
+ end
84
+
70
85
  describe "Query Interface" do
71
86
  describe "auto_join" do
72
87
  it "automaticaly joins Supermodel on Submodel queries" do
@@ -0,0 +1,14 @@
1
+ require 'spec_helper'
2
+
3
+ describe "create_table acts_as_superclass" do
4
+ it "creates foreign key and type columns" do
5
+ name = Pen.acts_as_association_name
6
+ Pen.attribute_names.should include("#{name}_id")
7
+ Pen.attribute_names.should include("#{name}_type")
8
+ end
9
+
10
+ it "when name passed creates foreign key and type columns with given name" do
11
+ Product.attribute_names.should include("producible_id")
12
+ Product.attribute_names.should include("producible_type")
13
+ end
14
+ end
data/spec/dummy/.rspec ADDED
@@ -0,0 +1 @@
1
+ --colour
@@ -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.