dicer 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/.pryrc +2 -0
- data/.rbenv-version +1 -0
- data/.rspec +2 -0
- data/Gemfile +12 -0
- data/LICENSE.txt +22 -0
- data/README.md +81 -0
- data/Rakefile +1 -0
- data/bench/call_only.rb +77 -0
- data/bench/method_call.rb +76 -0
- data/bench/send.rb +30 -0
- data/dicer.gemspec +23 -0
- data/examples/rails-3.2/.gitignore +15 -0
- data/examples/rails-3.2/.rspec +2 -0
- data/examples/rails-3.2/Gemfile +24 -0
- data/examples/rails-3.2/README.rdoc +261 -0
- data/examples/rails-3.2/Rakefile +7 -0
- data/examples/rails-3.2/app/assets/images/rails.png +0 -0
- data/examples/rails-3.2/app/assets/javascripts/application.js +13 -0
- data/examples/rails-3.2/app/assets/stylesheets/application.css +13 -0
- data/examples/rails-3.2/app/behaviors/book_store_customer.rb +14 -0
- data/examples/rails-3.2/app/behaviors/testable.rb +7 -0
- data/examples/rails-3.2/app/contexts/application_context.rb +5 -0
- data/examples/rails-3.2/app/contexts/book_store_purchase_context.rb +5 -0
- data/examples/rails-3.2/app/controllers/application_controller.rb +3 -0
- data/examples/rails-3.2/app/controllers/book_store_controller.rb +24 -0
- data/examples/rails-3.2/app/helpers/application_helper.rb +2 -0
- data/examples/rails-3.2/app/mailers/.gitkeep +0 -0
- data/examples/rails-3.2/app/models/.gitkeep +0 -0
- data/examples/rails-3.2/app/models/book.rb +6 -0
- data/examples/rails-3.2/app/models/book_purchase.rb +6 -0
- data/examples/rails-3.2/app/models/user.rb +6 -0
- data/examples/rails-3.2/app/views/layouts/application.html.erb +14 -0
- data/examples/rails-3.2/config/application.rb +70 -0
- data/examples/rails-3.2/config/boot.rb +6 -0
- data/examples/rails-3.2/config/database.yml +25 -0
- data/examples/rails-3.2/config/environment.rb +5 -0
- data/examples/rails-3.2/config/environments/development.rb +37 -0
- data/examples/rails-3.2/config/environments/production.rb +67 -0
- data/examples/rails-3.2/config/environments/test.rb +37 -0
- data/examples/rails-3.2/config/initializers/backtrace_silencers.rb +7 -0
- data/examples/rails-3.2/config/initializers/inflections.rb +15 -0
- data/examples/rails-3.2/config/initializers/mime_types.rb +5 -0
- data/examples/rails-3.2/config/initializers/secret_token.rb +7 -0
- data/examples/rails-3.2/config/initializers/session_store.rb +8 -0
- data/examples/rails-3.2/config/initializers/wrap_parameters.rb +14 -0
- data/examples/rails-3.2/config/locales/en.yml +5 -0
- data/examples/rails-3.2/config/routes.rb +7 -0
- data/examples/rails-3.2/config.ru +4 -0
- data/examples/rails-3.2/db/migrate/20130104095330_create_users.rb +10 -0
- data/examples/rails-3.2/db/migrate/20130104171610_create_books.rb +9 -0
- data/examples/rails-3.2/db/migrate/20130104172409_create_book_purchases.rb +10 -0
- data/examples/rails-3.2/db/schema.rb +36 -0
- data/examples/rails-3.2/db/seeds.rb +7 -0
- data/examples/rails-3.2/lib/assets/.gitkeep +0 -0
- data/examples/rails-3.2/lib/tasks/.gitkeep +0 -0
- data/examples/rails-3.2/log/.gitkeep +0 -0
- data/examples/rails-3.2/public/404.html +26 -0
- data/examples/rails-3.2/public/422.html +26 -0
- data/examples/rails-3.2/public/500.html +25 -0
- data/examples/rails-3.2/public/favicon.ico +0 -0
- data/examples/rails-3.2/public/index.html +241 -0
- data/examples/rails-3.2/public/robots.txt +5 -0
- data/examples/rails-3.2/script/rails +6 -0
- data/examples/rails-3.2/spec/controllers/book_store_controller_spec.rb +37 -0
- data/examples/rails-3.2/spec/factories/book_purchases.rb +8 -0
- data/examples/rails-3.2/spec/factories/books.rb +7 -0
- data/examples/rails-3.2/spec/factories/users.rb +8 -0
- data/examples/rails-3.2/spec/generators/behavior_generator_spec.rb +26 -0
- data/examples/rails-3.2/spec/generators/context_generator_spec.rb +25 -0
- data/examples/rails-3.2/spec/models/book_purchase_spec.rb +17 -0
- data/examples/rails-3.2/spec/models/book_spec.rb +15 -0
- data/examples/rails-3.2/spec/models/user_spec.rb +15 -0
- data/examples/rails-3.2/spec/spec_helper.rb +26 -0
- data/examples/rails-3.2/vendor/assets/javascripts/.gitkeep +0 -0
- data/examples/rails-3.2/vendor/assets/stylesheets/.gitkeep +0 -0
- data/examples/rails-3.2/vendor/plugins/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/.gitignore +15 -0
- data/examples/rails-3.2-with-mongoid/.rspec +2 -0
- data/examples/rails-3.2-with-mongoid/Gemfile +24 -0
- data/examples/rails-3.2-with-mongoid/README.rdoc +261 -0
- data/examples/rails-3.2-with-mongoid/Rakefile +7 -0
- data/examples/rails-3.2-with-mongoid/app/assets/images/rails.png +0 -0
- data/examples/rails-3.2-with-mongoid/app/assets/javascripts/application.js +13 -0
- data/examples/rails-3.2-with-mongoid/app/assets/stylesheets/application.css +13 -0
- data/examples/rails-3.2-with-mongoid/app/helpers/application_helper.rb +2 -0
- data/examples/rails-3.2-with-mongoid/app/mailers/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/app/models/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/app/models/book.rb +7 -0
- data/examples/rails-3.2-with-mongoid/app/models/book_purchase.rb +6 -0
- data/examples/rails-3.2-with-mongoid/app/models/user.rb +8 -0
- data/examples/rails-3.2-with-mongoid/app/views/layouts/application.html.erb +14 -0
- data/examples/rails-3.2-with-mongoid/config/application.rb +70 -0
- data/examples/rails-3.2-with-mongoid/config/boot.rb +6 -0
- data/examples/rails-3.2-with-mongoid/config/environment.rb +5 -0
- data/examples/rails-3.2-with-mongoid/config/environments/development.rb +31 -0
- data/examples/rails-3.2-with-mongoid/config/environments/production.rb +64 -0
- data/examples/rails-3.2-with-mongoid/config/environments/test.rb +35 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/backtrace_silencers.rb +7 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/inflections.rb +15 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/mime_types.rb +5 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/secret_token.rb +7 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/session_store.rb +8 -0
- data/examples/rails-3.2-with-mongoid/config/initializers/wrap_parameters.rb +10 -0
- data/examples/rails-3.2-with-mongoid/config/locales/en.yml +5 -0
- data/examples/rails-3.2-with-mongoid/config/mongoid.yml +80 -0
- data/examples/rails-3.2-with-mongoid/config/routes.rb +7 -0
- data/examples/rails-3.2-with-mongoid/config.ru +4 -0
- data/examples/rails-3.2-with-mongoid/db/seeds.rb +7 -0
- data/examples/rails-3.2-with-mongoid/lib/assets/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/lib/tasks/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/log/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/public/404.html +26 -0
- data/examples/rails-3.2-with-mongoid/public/422.html +26 -0
- data/examples/rails-3.2-with-mongoid/public/500.html +25 -0
- data/examples/rails-3.2-with-mongoid/public/favicon.ico +0 -0
- data/examples/rails-3.2-with-mongoid/public/index.html +241 -0
- data/examples/rails-3.2-with-mongoid/public/robots.txt +5 -0
- data/examples/rails-3.2-with-mongoid/script/rails +6 -0
- data/examples/rails-3.2-with-mongoid/vendor/assets/javascripts/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/vendor/assets/stylesheets/.gitkeep +0 -0
- data/examples/rails-3.2-with-mongoid/vendor/plugins/.gitkeep +0 -0
- data/lib/dicer/behavior.rb +17 -0
- data/lib/dicer/config.rb +15 -0
- data/lib/dicer/context/description.rb +27 -0
- data/lib/dicer/context.rb +30 -0
- data/lib/dicer/contextable.rb +19 -0
- data/lib/dicer/delegator.rb +80 -0
- data/lib/dicer/middleware.rb +20 -0
- data/lib/dicer/railtie/action_controller.rb +48 -0
- data/lib/dicer/railtie/active_record.rb +29 -0
- data/lib/dicer/railtie/context.rb +30 -0
- data/lib/dicer/railtie/contextable.rb +10 -0
- data/lib/dicer/railtie.rb +65 -0
- data/lib/dicer/version.rb +3 -0
- data/lib/dicer.rb +6 -0
- data/lib/generators/behavior/behavior_generator.rb +20 -0
- data/lib/generators/behavior/template/behavior.rb +3 -0
- data/lib/generators/context/context_generator.rb +32 -0
- data/lib/generators/context/template/context.rb +2 -0
- data/resource/dice.png +0 -0
- data/resource/dicer_logo.png +0 -0
- data/spec/dicer/behavior_spec.rb +18 -0
- data/spec/dicer/context/description_spec.rb +41 -0
- data/spec/dicer/context_spec.rb +54 -0
- data/spec/dicer/contextable_spec.rb +35 -0
- data/spec/dicer/delegator_spec.rb +34 -0
- data/spec/dicer/railtie/context_spec.rb +106 -0
- data/spec/dicer/railtie/contextable_spec.rb +18 -0
- data/spec/spec_helper.rb +27 -0
- data/spec/support/cleaner.rb +5 -0
- data/spec/support/cleaning_context.rb +8 -0
- data/spec/support/entity.rb +31 -0
- data/spec/support/value.rb +22 -0
- metadata +250 -0
data/.gitignore
ADDED
data/.pryrc
ADDED
data/.rbenv-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.9.3-p362
|
data/.rspec
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
source 'https://rubygems.org'
|
2
|
+
|
3
|
+
# Specify your gem's dependencies in dicer.gemspec
|
4
|
+
gemspec
|
5
|
+
|
6
|
+
group :development, :test do
|
7
|
+
gem 'benchmark-ips', '~> 1.2.0'
|
8
|
+
gem 'pry'
|
9
|
+
gem 'tapp'
|
10
|
+
gem 'rails', :require => false
|
11
|
+
gem 'simplecov', :require => false
|
12
|
+
end
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Sho Kusano
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,81 @@
|
|
1
|
+
# Dicer
|
2
|
+
|
3
|
+
useful DCI for Rails.
|
4
|
+
|
5
|
+
for example:
|
6
|
+
|
7
|
+
```ruby
|
8
|
+
class User < ActiveRecord::Base
|
9
|
+
has_many :purchases
|
10
|
+
end
|
11
|
+
|
12
|
+
module Customer
|
13
|
+
include Dicer::Behavior
|
14
|
+
|
15
|
+
def purchase(book)
|
16
|
+
self.purchases.create(book: book)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
class PurchaseContext < Dicer::Context
|
21
|
+
describe User do
|
22
|
+
it_behaves_like Customer
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
--
|
27
|
+
|
28
|
+
context(PurchaseContext.new)
|
29
|
+
user = User.where(id: session[:user_id]).first
|
30
|
+
book = Book.where(id: params[:id]).first
|
31
|
+
|
32
|
+
user.purchase(book)
|
33
|
+
```
|
34
|
+
|
35
|
+
Dicer is faster than `#extend` and `SimpleDelegator`
|
36
|
+
|
37
|
+
```
|
38
|
+
$ ruby bench/method_call.rb
|
39
|
+
Calculating -------------------------------------
|
40
|
+
instance method 32012 i/100ms
|
41
|
+
with Delegate 18413 i/100ms
|
42
|
+
with Forwardable 21709 i/100ms
|
43
|
+
with #extend 11696 i/100ms
|
44
|
+
with specific method 11706 i/100ms
|
45
|
+
with Dicer 20267 i/100ms
|
46
|
+
-------------------------------------------------
|
47
|
+
instance method 890341.4 (±11.2%) i/s - 4417656 in 5.026077s
|
48
|
+
with Delegate 342923.5 (±6.8%) i/s - 1712409 in 5.017309s
|
49
|
+
with Forwardable 448447.5 (±6.5%) i/s - 2236027 in 5.009544s
|
50
|
+
with #extend 210582.5 (±14.2%) i/s - 1040944 in 5.044065s
|
51
|
+
with specific method 183500.3 (±15.2%) i/s - 901362 in 4.999332s
|
52
|
+
with Dicer 397806.9 (±5.4%) i/s - 1986166 in 5.008770s
|
53
|
+
```
|
54
|
+
|
55
|
+
see: [bench/method\_call.rb](https://github.com/rosylilly/dicer/blob/master/bench/method_call.rb)
|
56
|
+
|
57
|
+
## Installation
|
58
|
+
|
59
|
+
Add this line to your application's Gemfile:
|
60
|
+
|
61
|
+
gem 'dicer'
|
62
|
+
|
63
|
+
And then execute:
|
64
|
+
|
65
|
+
$ bundle
|
66
|
+
|
67
|
+
Or install it yourself as:
|
68
|
+
|
69
|
+
$ gem install dicer
|
70
|
+
|
71
|
+
## Usage
|
72
|
+
|
73
|
+
TODO: Write usage instructions here
|
74
|
+
|
75
|
+
## Contributing
|
76
|
+
|
77
|
+
1. Fork it
|
78
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
79
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
80
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
81
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
data/bench/call_only.rb
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
require 'bundler'
|
2
|
+
Bundler.require(:default, :development)
|
3
|
+
require 'delegate'
|
4
|
+
require 'forwardable'
|
5
|
+
|
6
|
+
class Example
|
7
|
+
def hi; 1; end
|
8
|
+
def hello; '1'; end
|
9
|
+
end
|
10
|
+
|
11
|
+
class ExampleDelegator < SimpleDelegator
|
12
|
+
def hi; 2; end
|
13
|
+
end
|
14
|
+
|
15
|
+
class ExampleForwardable
|
16
|
+
extend Forwardable
|
17
|
+
|
18
|
+
def_delegator :@example, :hello
|
19
|
+
|
20
|
+
def initialize(example)
|
21
|
+
@example = example
|
22
|
+
end
|
23
|
+
|
24
|
+
def hi; 3; end
|
25
|
+
end
|
26
|
+
|
27
|
+
module ExampleMixin
|
28
|
+
include Dicer::Behavior
|
29
|
+
|
30
|
+
def hi; 3; end
|
31
|
+
end
|
32
|
+
|
33
|
+
example_description = Dicer::Context::Description.new(Example) do
|
34
|
+
it_behaves_like ExampleMixin
|
35
|
+
end
|
36
|
+
example_delegator = example_description.delegator
|
37
|
+
|
38
|
+
Benchmark.ips do |bench|
|
39
|
+
example = Example.new
|
40
|
+
|
41
|
+
bench.report('instance method') do
|
42
|
+
example.hi
|
43
|
+
example.hello
|
44
|
+
end
|
45
|
+
|
46
|
+
delegated = ExampleDelegator.new(Example.new)
|
47
|
+
bench.report('with Delegate') do
|
48
|
+
delegated.hi
|
49
|
+
delegated.hello
|
50
|
+
end
|
51
|
+
|
52
|
+
forwardabled = ExampleForwardable.new(Example.new)
|
53
|
+
bench.report('with Forwardable') do
|
54
|
+
forwardabled.hi
|
55
|
+
forwardabled.hello
|
56
|
+
end
|
57
|
+
|
58
|
+
extended = Example.new.extend(ExampleMixin)
|
59
|
+
bench.report('with #extend') do
|
60
|
+
extended.hi
|
61
|
+
extended.hello
|
62
|
+
end
|
63
|
+
|
64
|
+
specific = Example.new
|
65
|
+
class << specific; def hi; 1; end; end
|
66
|
+
bench.report('with singleton') do
|
67
|
+
specific.hi
|
68
|
+
specific.hello
|
69
|
+
end
|
70
|
+
|
71
|
+
dicer = example_description.delegator.new(Example.new)
|
72
|
+
bench.report('with Dicer') do
|
73
|
+
dicer.hi
|
74
|
+
dicer.hello
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
@@ -0,0 +1,76 @@
|
|
1
|
+
require 'bundler'
|
2
|
+
Bundler.require(:default, :development)
|
3
|
+
require 'delegate'
|
4
|
+
require 'forwardable'
|
5
|
+
|
6
|
+
class Example
|
7
|
+
def hi; 1; end
|
8
|
+
def hello; '1'; end
|
9
|
+
end
|
10
|
+
|
11
|
+
class ExampleDelegator < SimpleDelegator
|
12
|
+
def hi; 2; end
|
13
|
+
end
|
14
|
+
|
15
|
+
class ExampleForwardable
|
16
|
+
extend Forwardable
|
17
|
+
|
18
|
+
def_delegator :@example, :hello
|
19
|
+
|
20
|
+
def initialize(example)
|
21
|
+
@example = example
|
22
|
+
end
|
23
|
+
|
24
|
+
def hi; 3; end
|
25
|
+
end
|
26
|
+
|
27
|
+
module ExampleMixin
|
28
|
+
include Dicer::Behavior
|
29
|
+
|
30
|
+
def hi; 3; end
|
31
|
+
end
|
32
|
+
|
33
|
+
example_description = Dicer::Context::Description.new(Example) do
|
34
|
+
it_behaves_like ExampleMixin
|
35
|
+
end
|
36
|
+
example_delegator = example_description.delegator
|
37
|
+
|
38
|
+
Benchmark.ips do |bench|
|
39
|
+
bench.report('instance method') do
|
40
|
+
example = Example.new
|
41
|
+
example.hi
|
42
|
+
example.hello
|
43
|
+
end
|
44
|
+
|
45
|
+
bench.report('with Delegate') do
|
46
|
+
example = ExampleDelegator.new(Example.new)
|
47
|
+
example.hi
|
48
|
+
example.hello
|
49
|
+
end
|
50
|
+
|
51
|
+
bench.report('with Forwardable') do
|
52
|
+
example = ExampleForwardable.new(Example.new)
|
53
|
+
example.hi
|
54
|
+
example.hello
|
55
|
+
end
|
56
|
+
|
57
|
+
bench.report('with #extend') do
|
58
|
+
example = Example.new
|
59
|
+
example.extend(ExampleMixin)
|
60
|
+
example.hi
|
61
|
+
example.hello
|
62
|
+
end
|
63
|
+
|
64
|
+
bench.report('with singleton') do
|
65
|
+
example = Example.new
|
66
|
+
class << example; def hello; 1; end; end
|
67
|
+
example.hi
|
68
|
+
example.hello
|
69
|
+
end
|
70
|
+
|
71
|
+
bench.report('with Dicer') do
|
72
|
+
example = example_description.delegator.new(Example.new)
|
73
|
+
example.hi
|
74
|
+
example.hello
|
75
|
+
end
|
76
|
+
end
|
data/bench/send.rb
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
require 'bundler'
|
2
|
+
Bundler.require(:default, :development)
|
3
|
+
|
4
|
+
class Example
|
5
|
+
def hello; 1; end
|
6
|
+
end
|
7
|
+
|
8
|
+
example = Example.new
|
9
|
+
|
10
|
+
Benchmark.ips do |bench|
|
11
|
+
bench.report('#hello') do
|
12
|
+
example.hello
|
13
|
+
end
|
14
|
+
|
15
|
+
bench.report('#send(:hello)') do
|
16
|
+
example.send(:hello)
|
17
|
+
end
|
18
|
+
|
19
|
+
bench.report('#__send__(:hello)') do
|
20
|
+
example.__send__(:hello)
|
21
|
+
end
|
22
|
+
|
23
|
+
bench.report('with begin') do
|
24
|
+
begin
|
25
|
+
example.send(:hello)
|
26
|
+
rescue Exception
|
27
|
+
raise
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
data/dicer.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'dicer/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = 'dicer'
|
8
|
+
gem.version = Dicer::VERSION
|
9
|
+
gem.authors = ['Sho Kusano']
|
10
|
+
gem.email = ['rosylilly@aduca.org']
|
11
|
+
gem.description = %q{useful DCI for Rails}
|
12
|
+
gem.summary = %q{useful DCI for Rails}
|
13
|
+
gem.homepage = ''
|
14
|
+
gem.license = 'MIT'
|
15
|
+
|
16
|
+
gem.files = `git ls-files`.split($/)
|
17
|
+
gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
19
|
+
gem.require_paths = ['lib']
|
20
|
+
|
21
|
+
gem.add_development_dependency 'rake'
|
22
|
+
gem.add_development_dependency 'rspec', '~> 2.12.0'
|
23
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# See http://help.github.com/ignore-files/ for more about ignoring files.
|
2
|
+
#
|
3
|
+
# If you find yourself ignoring temporary files generated by your text editor
|
4
|
+
# or operating system, you probably want to add a global ignore instead:
|
5
|
+
# git config --global core.excludesfile ~/.gitignore_global
|
6
|
+
|
7
|
+
# Ignore bundler config
|
8
|
+
/.bundle
|
9
|
+
|
10
|
+
# Ignore the default SQLite database.
|
11
|
+
/db/*.sqlite3
|
12
|
+
|
13
|
+
# Ignore all logfiles and tempfiles.
|
14
|
+
/log/*.log
|
15
|
+
/tmp
|
@@ -0,0 +1,24 @@
|
|
1
|
+
source 'https://rubygems.org'
|
2
|
+
|
3
|
+
gem 'rails', '3.2.10'
|
4
|
+
gem 'dicer', path: '../..'
|
5
|
+
|
6
|
+
gem 'sqlite3'
|
7
|
+
|
8
|
+
group :assets do
|
9
|
+
gem 'sass-rails', '~> 3.2.3'
|
10
|
+
gem 'coffee-rails', '~> 3.2.1'
|
11
|
+
|
12
|
+
gem 'uglifier', '>= 1.0.3'
|
13
|
+
end
|
14
|
+
|
15
|
+
group :development, :test do
|
16
|
+
gem 'rspec'
|
17
|
+
gem 'rspec-rails'
|
18
|
+
gem 'generator_spec'
|
19
|
+
gem 'response_code_matchers'
|
20
|
+
|
21
|
+
gem 'factory_girl_rails'
|
22
|
+
gem 'database_cleaner'
|
23
|
+
gem 'pry-rails'
|
24
|
+
end
|
@@ -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.
|
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Example::Application.load_tasks
|
Binary file
|
@@ -0,0 +1,13 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// the compiled file.
|
9
|
+
//
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
12
|
+
//
|
13
|
+
//= require_tree .
|