ao_crudify 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. data/.gitignore +7 -0
  2. data/Gemfile +8 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +93 -0
  5. data/Rakefile +11 -0
  6. data/ao_crudify.gemspec +26 -0
  7. data/config/locales/en.yml +8 -0
  8. data/config/locales/zh-cn.yml +8 -0
  9. data/lib/ao_crudify.rb +20 -0
  10. data/lib/ao_crudify/base.rb +43 -0
  11. data/lib/ao_crudify/class_methods.rb +137 -0
  12. data/lib/ao_crudify/hook_methods.rb +117 -0
  13. data/lib/ao_crudify/version.rb +3 -0
  14. data/spec/controllers/controller_hooks_spec.rb +1 -0
  15. data/spec/controllers/jellies_controller_spec.rb +156 -0
  16. data/spec/dummy-2-3-12/README +243 -0
  17. data/spec/dummy-2-3-12/Rakefile +10 -0
  18. data/spec/dummy-2-3-12/app/controllers/application_controller.rb +10 -0
  19. data/spec/dummy-2-3-12/app/controllers/jellies_controller.rb +6 -0
  20. data/spec/dummy-2-3-12/app/helpers/application_helper.rb +3 -0
  21. data/spec/dummy-2-3-12/app/models/jelly.rb +13 -0
  22. data/spec/dummy-2-3-12/config/boot.rb +114 -0
  23. data/spec/dummy-2-3-12/config/database.yml +22 -0
  24. data/spec/dummy-2-3-12/config/environment.rb +50 -0
  25. data/spec/dummy-2-3-12/config/environments/development.rb +17 -0
  26. data/spec/dummy-2-3-12/config/environments/production.rb +28 -0
  27. data/spec/dummy-2-3-12/config/environments/test.rb +28 -0
  28. data/spec/dummy-2-3-12/config/initializers/backtrace_silencers.rb +7 -0
  29. data/spec/dummy-2-3-12/config/initializers/cookie_verification_secret.rb +7 -0
  30. data/spec/dummy-2-3-12/config/initializers/inflections.rb +10 -0
  31. data/spec/dummy-2-3-12/config/initializers/mime_types.rb +5 -0
  32. data/spec/dummy-2-3-12/config/initializers/new_rails_defaults.rb +21 -0
  33. data/spec/dummy-2-3-12/config/initializers/session_store.rb +15 -0
  34. data/spec/dummy-2-3-12/config/locales/en.yml +5 -0
  35. data/spec/dummy-2-3-12/config/routes.rb +43 -0
  36. data/spec/dummy-2-3-12/db/seeds.rb +7 -0
  37. data/spec/dummy-2-3-12/public/404.html +30 -0
  38. data/spec/dummy-2-3-12/public/422.html +30 -0
  39. data/spec/dummy-2-3-12/public/500.html +30 -0
  40. data/spec/dummy-2-3-12/public/favicon.ico +0 -0
  41. data/spec/dummy-2-3-12/public/images/rails.png +0 -0
  42. data/spec/dummy-2-3-12/public/index.html +275 -0
  43. data/spec/dummy-2-3-12/public/javascripts/application.js +2 -0
  44. data/spec/dummy-2-3-12/public/javascripts/controls.js +963 -0
  45. data/spec/dummy-2-3-12/public/javascripts/dragdrop.js +973 -0
  46. data/spec/dummy-2-3-12/public/javascripts/effects.js +1128 -0
  47. data/spec/dummy-2-3-12/public/javascripts/prototype.js +4320 -0
  48. data/spec/dummy-2-3-12/public/robots.txt +5 -0
  49. data/spec/dummy-2-3-12/script/about +4 -0
  50. data/spec/dummy-2-3-12/script/console +3 -0
  51. data/spec/dummy-2-3-12/script/dbconsole +3 -0
  52. data/spec/dummy-2-3-12/script/destroy +3 -0
  53. data/spec/dummy-2-3-12/script/generate +3 -0
  54. data/spec/dummy-2-3-12/script/performance/benchmarker +3 -0
  55. data/spec/dummy-2-3-12/script/performance/profiler +3 -0
  56. data/spec/dummy-2-3-12/script/plugin +3 -0
  57. data/spec/dummy-2-3-12/script/runner +3 -0
  58. data/spec/dummy-2-3-12/script/server +3 -0
  59. data/spec/helper.rb +47 -0
  60. data/spec/models/ao_crudify_spec.rb +62 -0
  61. data/spec/spec.opts +5 -0
  62. data/spec/spec_helper.rb +31 -0
  63. metadata +193 -0
@@ -0,0 +1,3 @@
1
+ module AoCrudify
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,156 @@
1
+ require File.expand_path('../../spec_helper', __FILE__)
2
+
3
+ def should_assign_instance
4
+ assigns[:jelly].should_not be_nil
5
+ assigns[:crud_options].should_not be_nil
6
+ end
7
+
8
+ describe JelliesController do
9
+ describe "get new" do
10
+ it "should assign @jelly, @crud_options" do
11
+ get :new
12
+ should_assign_instance
13
+ end
14
+ end
15
+
16
+ describe "get index" do
17
+ it "should call paginate_all_* methods and assign @jellies and @collection" do
18
+ get :index
19
+ assigns[:jellies].should_not be_nil
20
+ assigns[:collection].should_not be_nil
21
+ end
22
+ end
23
+
24
+ describe "get show" do
25
+ before do
26
+ Jelly.stub(:find).and_return mock_model(Jelly)
27
+ end
28
+ it "should assign instance" do
29
+ get :show
30
+ should_assign_instance
31
+ end
32
+ end
33
+
34
+ describe "post create" do
35
+ before do
36
+ @jelly = mock_model(Jelly)
37
+ Jelly.stub(:new).and_return @jelly
38
+ end
39
+ it "with before_create return false" do
40
+ controller.stub!(:before_create).and_return false
41
+ @jelly.should_not_receive(:save)
42
+ post :create, :name => 'foo', :title => 'bar'
43
+ controller.stub!(:before_create).and_return true
44
+ end
45
+ context "create success" do
46
+ before do
47
+ @jelly.stub(:save).and_return true
48
+ end
49
+ it "with http redirect param" do
50
+ post :create, :name => 'foo', :title => 'bar', :redirect => "/jellies"
51
+ response.should redirect_to("/jellies")
52
+ end
53
+ it "with @redirect_to_url instance" do
54
+ controller.instance_variable_set("@redirect_to_url", '/jellies/tmp')
55
+ post :create, :name => 'foo', :title => 'bar'
56
+ response.should redirect_to("/jellies/tmp")
57
+ controller.instance_variable_set("@redirect_to_url", nil)
58
+ end
59
+ it "with @crud_options[:redirect_to_url]" do
60
+ post :create, :name => 'foo', :title => 'bar'
61
+ response.should redirect_to("/jellies_url")
62
+ end
63
+ it "with xhr for html format" do
64
+ xhr :post, :create, :name => 'foo', :title => 'bar'
65
+ response.should render_template("create")
66
+ end
67
+ it "post for json format" do
68
+ post :create, :name => 'foo', :title => 'bar', :format => 'json'
69
+ response.body.should include('code')
70
+ end
71
+ end
72
+ context "create failed" do
73
+ before do
74
+ @jelly.stub(:save).and_return false
75
+ end
76
+ it "with http" do
77
+ post :create, :name => 'foo', :title => 'bar'
78
+ response.should render_template("new")
79
+ end
80
+ it "with ajax" do
81
+ xhr :post, :create, :name => 'foo', :title => 'bar'
82
+ response.body.should == 'error'
83
+ end
84
+ end
85
+ end
86
+
87
+ describe "put update" do
88
+ before do
89
+ @jelly = mock_model(Jelly)
90
+ Jelly.stub(:find).and_return @jelly
91
+ end
92
+ it "with before_update return false" do
93
+ controller.stub!(:before_update).and_return false
94
+ @jelly.should_not_receive(:update_attributes)
95
+ put :update, :id => @jelly.id, :jelly => {:name => 'update name', :title => 'update title'}
96
+ controller.stub!(:before_update).and_return true
97
+ end
98
+ context "update successful" do
99
+ before do
100
+ @jelly.stub!(:update_attributes).and_return true
101
+ end
102
+ it "with http redirect param" do
103
+ put :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}, :redirect => "/jellies"
104
+ response.should redirect_to("/jellies")
105
+ end
106
+ it "with @redirect_to_url instance" do
107
+ controller.instance_variable_set("@redirect_to_url", '/jellies/tmp')
108
+ put :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
109
+ response.should redirect_to("/jellies/tmp")
110
+ controller.instance_variable_set("@redirect_to_url", nil)
111
+ end
112
+ it "with @crud_options[:redirect_to_url]" do
113
+ put :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
114
+ response.should redirect_to("/jellies_url")
115
+ end
116
+ it "with xhr for html format" do
117
+ xhr :put, :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
118
+ response.should render_template("update")
119
+ end
120
+ it "put for json format" do
121
+ put :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}, :format => 'json'
122
+ response.body.should include('code')
123
+ end
124
+ end
125
+ context "update failed" do
126
+ before do
127
+ @jelly.stub(:update_attributes).and_return false
128
+ end
129
+ it "with http" do
130
+ put :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
131
+ response.should render_template("edit")
132
+ end
133
+ it "with ajax" do
134
+ xhr :put, :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
135
+ response.body.should == 'error'
136
+ end
137
+ it "flash[:error] should exist" do
138
+ xhr :put, :update, :id => @jelly.id, :jelly => {:name => 'foo', :title => 'bar'}
139
+ flash[:error].should == I18n.t("ao_crudify.failed_update", :what => 'jelly')
140
+ end
141
+ end
142
+ end
143
+
144
+ describe "delete destroy" do
145
+ before do
146
+ @jelly = mock_model(Jelly)
147
+ Jelly.stub(:find).and_return @jelly
148
+ end
149
+ it "with before_destory return false" do
150
+ controller.stub!(:before_destroy).and_return false
151
+ @jelly.should_not_receive :destroy
152
+ delete :destroy, :id => @jelly.id
153
+ controller.stub!(:before_destroy).and_return true
154
+ end
155
+ end
156
+ end
@@ -0,0 +1,243 @@
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" templates
7
+ that are primarily responsible for inserting pre-built data in between HTML tags.
8
+ The model contains the "smart" domain objects (such as Account, Product, Person,
9
+ Post) that holds all the business logic and knows how to persist themselves to
10
+ a database. The controller handles the incoming requests (such as Save New Account,
11
+ Update Product, Show Post) by manipulating the model and directing data to the view.
12
+
13
+ In Rails, the model is handled by what's called an object-relational mapping
14
+ layer entitled Active Record. This layer allows you to present the data from
15
+ database rows as objects and embellish these data objects with business logic
16
+ methods. You can read more about Active Record in
17
+ link:files/vendor/rails/activerecord/README.html.
18
+
19
+ The controller and view are handled by the Action Pack, which handles both
20
+ layers by its two parts: Action View and Action Controller. These two layers
21
+ are bundled in a single package due to their heavy interdependence. This is
22
+ unlike the relationship between the Active Record and Action Pack that is much
23
+ more separate. Each of these packages can be used independently outside of
24
+ Rails. You can read more about Action Pack in
25
+ link:files/vendor/rails/actionpack/README.html.
26
+
27
+
28
+ == Getting Started
29
+
30
+ 1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
31
+ and your application name. Ex: rails myapp
32
+ 2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
33
+ 3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
34
+ 4. Follow the guidelines to start developing your application
35
+
36
+
37
+ == Web Servers
38
+
39
+ By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
40
+ with a variety of other web servers.
41
+
42
+ Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
43
+ suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
44
+ getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
45
+ More info at: http://mongrel.rubyforge.org
46
+
47
+ Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
48
+ Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
49
+ FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
50
+
51
+ == Apache .htaccess example for FCGI/CGI
52
+
53
+ # General Apache options
54
+ AddHandler fastcgi-script .fcgi
55
+ AddHandler cgi-script .cgi
56
+ Options +FollowSymLinks +ExecCGI
57
+
58
+ # If you don't want Rails to look in certain directories,
59
+ # use the following rewrite rules so that Apache won't rewrite certain requests
60
+ #
61
+ # Example:
62
+ # RewriteCond %{REQUEST_URI} ^/notrails.*
63
+ # RewriteRule .* - [L]
64
+
65
+ # Redirect all requests not available on the filesystem to Rails
66
+ # By default the cgi dispatcher is used which is very slow
67
+ #
68
+ # For better performance replace the dispatcher with the fastcgi one
69
+ #
70
+ # Example:
71
+ # RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
72
+ RewriteEngine On
73
+
74
+ # If your Rails application is accessed via an Alias directive,
75
+ # then you MUST also set the RewriteBase in this htaccess file.
76
+ #
77
+ # Example:
78
+ # Alias /myrailsapp /path/to/myrailsapp/public
79
+ # RewriteBase /myrailsapp
80
+
81
+ RewriteRule ^$ index.html [QSA]
82
+ RewriteRule ^([^.]+)$ $1.html [QSA]
83
+ RewriteCond %{REQUEST_FILENAME} !-f
84
+ RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
85
+
86
+ # In case Rails experiences terminal errors
87
+ # Instead of displaying this message you can supply a file here which will be rendered instead
88
+ #
89
+ # Example:
90
+ # ErrorDocument 500 /500.html
91
+
92
+ ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
93
+
94
+
95
+ == Debugging Rails
96
+
97
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
98
+ will help you debug it and get it back on the rails.
99
+
100
+ First area to check is the application log files. Have "tail -f" commands running
101
+ on the server.log and development.log. Rails will automatically display debugging
102
+ and runtime information to these files. Debugging info will also be shown in the
103
+ browser on requests from 127.0.0.1.
104
+
105
+ You can also log your own messages directly into the log file from your code using
106
+ the Ruby logger class from inside your controllers. Example:
107
+
108
+ class WeblogController < ActionController::Base
109
+ def destroy
110
+ @weblog = Weblog.find(params[:id])
111
+ @weblog.destroy
112
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
113
+ end
114
+ end
115
+
116
+ The result will be a message in your log file along the lines of:
117
+
118
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
119
+
120
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
121
+
122
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
123
+
124
+ * The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
125
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
126
+
127
+ These two online (and free) books will bring you up to speed on the Ruby language
128
+ and also on programming in general.
129
+
130
+
131
+ == Debugger
132
+
133
+ Debugger support is available through the debugger command when you start your Mongrel or
134
+ Webrick server with --debugger. This means that you can break out of execution at any point
135
+ in the code, investigate and change the model, AND then resume execution!
136
+ You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
137
+ Example:
138
+
139
+ class WeblogController < ActionController::Base
140
+ def index
141
+ @posts = Post.find(:all)
142
+ debugger
143
+ end
144
+ end
145
+
146
+ So the controller will accept the action, run the first line, then present you
147
+ with a IRB prompt in the server window. Here you can do things like:
148
+
149
+ >> @posts.inspect
150
+ => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
151
+ #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
152
+ >> @posts.first.title = "hello from a debugger"
153
+ => "hello from a debugger"
154
+
155
+ ...and even better is that you can examine how your runtime objects actually work:
156
+
157
+ >> f = @posts.first
158
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
159
+ >> f.
160
+ Display all 152 possibilities? (y or n)
161
+
162
+ Finally, when you're ready to resume execution, you enter "cont"
163
+
164
+
165
+ == Console
166
+
167
+ You can interact with the domain model by starting the console through <tt>script/console</tt>.
168
+ Here you'll have all parts of the application configured, just like it is when the
169
+ application is running. You can inspect domain models, change values, and save to the
170
+ database. Starting the script without arguments will launch it in the development environment.
171
+ Passing an argument will specify a different environment, like <tt>script/console production</tt>.
172
+
173
+ To reload your controllers and models after launching the console run <tt>reload!</tt>
174
+
175
+ == dbconsole
176
+
177
+ You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
178
+ You would be connected to the database with the credentials defined in database.yml.
179
+ Starting the script without arguments will connect you to the development database. Passing an
180
+ argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
181
+ Currently works for mysql, postgresql and sqlite.
182
+
183
+ == Description of Contents
184
+
185
+ app
186
+ Holds all the code that's specific to this particular application.
187
+
188
+ app/controllers
189
+ Holds controllers that should be named like weblogs_controller.rb for
190
+ automated URL mapping. All controllers should descend from ApplicationController
191
+ which itself descends from ActionController::Base.
192
+
193
+ app/models
194
+ Holds models that should be named like post.rb.
195
+ Most models will descend from ActiveRecord::Base.
196
+
197
+ app/views
198
+ Holds the template files for the view that should be named like
199
+ weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
200
+ syntax.
201
+
202
+ app/views/layouts
203
+ Holds the template files for layouts to be used with views. This models the common
204
+ header/footer method of wrapping views. In your views, define a layout using the
205
+ <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
206
+ call <% yield %> to render the view using this layout.
207
+
208
+ app/helpers
209
+ Holds view helpers that should be named like weblogs_helper.rb. These are generated
210
+ for you automatically when using script/generate for controllers. Helpers can be used to
211
+ wrap functionality for your views into methods.
212
+
213
+ config
214
+ Configuration files for the Rails environment, the routing map, the database, and other dependencies.
215
+
216
+ db
217
+ Contains the database schema in schema.rb. db/migrate contains all
218
+ the sequence of Migrations for your schema.
219
+
220
+ doc
221
+ This directory is where your application documentation will be stored when generated
222
+ using <tt>rake doc:app</tt>
223
+
224
+ lib
225
+ Application specific libraries. Basically, any kind of custom code that doesn't
226
+ belong under controllers, models, or helpers. This directory is in the load path.
227
+
228
+ public
229
+ The directory available for the web server. Contains subdirectories for images, stylesheets,
230
+ and javascripts. Also contains the dispatchers and the default HTML files. This should be
231
+ set as the DOCUMENT_ROOT of your web server.
232
+
233
+ script
234
+ Helper scripts for automation and generation.
235
+
236
+ test
237
+ Unit and functional tests along with fixtures. When using the script/generate scripts, template
238
+ test files will be generated for you and placed in this directory.
239
+
240
+ vendor
241
+ External libraries that the application depends on. Also includes the plugins subdirectory.
242
+ If the app has frozen rails, those gems also go here, under vendor/rails/.
243
+ This directory is in the load path.
@@ -0,0 +1,10 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require(File.join(File.dirname(__FILE__), 'config', 'boot'))
5
+
6
+ require 'rake'
7
+ require 'rake/testtask'
8
+ require 'rake/rdoctask'
9
+
10
+ require 'tasks/rails'
@@ -0,0 +1,10 @@
1
+ # Filters added to this controller apply to all controllers in the application.
2
+ # Likewise, all the methods added will be available for all controllers.
3
+
4
+ class ApplicationController < ActionController::Base
5
+ helper :all # include all helpers, all the time
6
+ protect_from_forgery # See ActionController::RequestForgeryProtection for details
7
+
8
+ # Scrub sensitive parameters from your log
9
+ # filter_parameter_logging :password
10
+ end
@@ -0,0 +1,6 @@
1
+ class JelliesController < ApplicationController
2
+
3
+ crudify :jelly,
4
+ :redirect_to_url => "/jellies_url"
5
+
6
+ end
@@ -0,0 +1,3 @@
1
+ # Methods added to this helper will be available to all templates in the application.
2
+ module ApplicationHelper
3
+ end
@@ -0,0 +1,13 @@
1
+ class Jelly < ActiveObject::Base
2
+ establish_connection(:tokyo_cabinet_table, :path => File.expand_path("../../../db/Jelly.tct", __FILE__))
3
+ attribute :title => :string,
4
+ :name => :string
5
+
6
+ validates_presence_of :title
7
+ validates_presence_of :name
8
+
9
+ def self.per_page
10
+ 3
11
+ end
12
+
13
+ end