automatic_record 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/README.md +53 -0
- data/Rakefile +20 -0
- data/lib/automatic_record.rb +3 -0
- data/lib/automatic_record/auto_create.rb +59 -0
- data/lib/automatic_record/engine.rb +18 -0
- data/lib/automatic_record/error/invalid_association.rb +7 -0
- data/lib/automatic_record/error/missing_association.rb +7 -0
- data/lib/automatic_record/version.rb +3 -0
- data/lib/tasks/automatic_record_tasks.rake +4 -0
- data/spec/dummy/README.rdoc +28 -0
- data/spec/dummy/Rakefile +6 -0
- data/spec/dummy/app/assets/javascripts/application.js +13 -0
- data/spec/dummy/app/assets/stylesheets/application.css +15 -0
- data/spec/dummy/app/controllers/application_controller.rb +5 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/models/preference.rb +13 -0
- data/spec/dummy/app/models/user.rb +13 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/bin/bundle +3 -0
- data/spec/dummy/bin/rails +4 -0
- data/spec/dummy/bin/rake +4 -0
- data/spec/dummy/bin/setup +29 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +26 -0
- data/spec/dummy/config/boot.rb +5 -0
- data/spec/dummy/config/database.yml +13 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +41 -0
- data/spec/dummy/config/environments/production.rb +79 -0
- data/spec/dummy/config/environments/test.rb +42 -0
- data/spec/dummy/config/initializers/assets.rb +11 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
- data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
- data/spec/dummy/config/initializers/inflections.rb +16 -0
- data/spec/dummy/config/initializers/mime_types.rb +4 -0
- data/spec/dummy/config/initializers/session_store.rb +3 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +23 -0
- data/spec/dummy/config/routes.rb +56 -0
- data/spec/dummy/config/secrets.yml +22 -0
- data/spec/dummy/db/migrate/20150416145033_create_users.rb +8 -0
- data/spec/dummy/db/migrate/20150416145236_create_preferences.rb +11 -0
- data/spec/dummy/db/schema.rb +30 -0
- data/spec/dummy/public/404.html +67 -0
- data/spec/dummy/public/422.html +67 -0
- data/spec/dummy/public/500.html +66 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/factories/preferences.rb +6 -0
- data/spec/factories/users.rb +5 -0
- data/spec/models/preference_spec.rb +43 -0
- data/spec/models/user_spec.rb +63 -0
- data/spec/rails_helper.rb +64 -0
- data/spec/spec_helper.rb +85 -0
- metadata +231 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 40acbf709da113d0bf43a47c07d6bec14844f870
|
4
|
+
data.tar.gz: 978030fe910a4f7423496fe0d9a0d012a572e5b2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 984c40283762c8dc41218d30cd9d1f78dff321fa7f09fc3ad9341af505240f3f0e63a3441eb5eef93a5c4882038e829d66a0a023a584c5df22eebb532d01419b
|
7
|
+
data.tar.gz: 0e666081ee81d57227bf47469efb50f5c0b0df5bc228fb33d9da7334313fc8b05cdc2065d1fc35ed9b7df479f9e6d790b01a62b6a59bdb3484f9864164b16be7
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2015 Greg Woods
|
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.md
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
# AutomaticRecord
|
2
|
+
|
3
|
+
This gem allows lazy creation of `:has_one` and `:belongs_to` associations as they are accessed.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add the following line to your Gemfile:
|
8
|
+
|
9
|
+
gem 'automatic_record'
|
10
|
+
|
11
|
+
Then run `bundle install` and restart your application.
|
12
|
+
|
13
|
+
## Example Usage
|
14
|
+
|
15
|
+
The example below illustrates the most basic use case.
|
16
|
+
|
17
|
+
class User < ActiveRecord::Base
|
18
|
+
# The user model has a related Preference object
|
19
|
+
has_one :preference
|
20
|
+
|
21
|
+
# Make sure preference is created when it is first accessed
|
22
|
+
auto_create :preference
|
23
|
+
end
|
24
|
+
|
25
|
+
This would allow us to do something like the following in our code:
|
26
|
+
|
27
|
+
user = User.create() # preference is currently nil
|
28
|
+
pref = user.preference # creates preference object on the fly
|
29
|
+
|
30
|
+
## Advanced Usage
|
31
|
+
|
32
|
+
You can provide a hash of default values to the association. These will be passed in to the `create` method when the new object is created.
|
33
|
+
|
34
|
+
class User < ActiveRecord::Base
|
35
|
+
has_one :preference
|
36
|
+
auto_create :preference, :language => 'en', :notifications => true
|
37
|
+
end
|
38
|
+
|
39
|
+
Or, you can pass a lambda to perform some custom initialization. **NOTE:** The foreign key is not set for you automatically. Take care to create the associated record properly when using this method.
|
40
|
+
|
41
|
+
class User < ActiveRecord::Base
|
42
|
+
has_one :preference
|
43
|
+
auto_create :preference, ->(user){
|
44
|
+
user.create_preference(:language => 'en', :notifications => true)
|
45
|
+
}
|
46
|
+
end
|
47
|
+
|
48
|
+
## Testing
|
49
|
+
|
50
|
+
AutomaticRecord uses rspec for testing.
|
51
|
+
|
52
|
+
RAILS_ENV=test rake db:create db:migrate
|
53
|
+
rspec spec
|
data/Rakefile
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
require 'rdoc/task'
|
8
|
+
|
9
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
10
|
+
rdoc.rdoc_dir = 'rdoc'
|
11
|
+
rdoc.title = 'AutomaticRecord'
|
12
|
+
rdoc.options << '--line-numbers'
|
13
|
+
rdoc.rdoc_files.include('README.md')
|
14
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
18
|
+
load 'rails/tasks/engine.rake'
|
19
|
+
|
20
|
+
Bundler::GemHelper.install_tasks
|
@@ -0,0 +1,59 @@
|
|
1
|
+
module AutomaticRecord
|
2
|
+
module AutoCreate
|
3
|
+
extend ActiveSupport::Concern
|
4
|
+
|
5
|
+
included do
|
6
|
+
|
7
|
+
end
|
8
|
+
|
9
|
+
module ClassMethods
|
10
|
+
|
11
|
+
# Specifies that the given association should be created automaticaly whenever it is accessed, if
|
12
|
+
# it does not already exist. This method should only be used on associations that are defined as
|
13
|
+
# either :belongs_to or :has_one.
|
14
|
+
#
|
15
|
+
# === Example
|
16
|
+
#
|
17
|
+
# class User < ActiveRecord::Base
|
18
|
+
# has_one :preference
|
19
|
+
# auto_create :preference
|
20
|
+
# end
|
21
|
+
#
|
22
|
+
# === Options
|
23
|
+
#
|
24
|
+
# Pass a list of default attributes:
|
25
|
+
# auto_create :preference, :language => 'en', :notifications => true
|
26
|
+
#
|
27
|
+
# Pass a block to be used for object creation:
|
28
|
+
# auto_create :preference, ->(user){ user.create_preference(:language => 'en', :notifications => true) }
|
29
|
+
#
|
30
|
+
def auto_create(assoc, default_attrs_or_block={})
|
31
|
+
reflection = reflect_on_association(assoc)
|
32
|
+
if reflection.nil?
|
33
|
+
raise AutomaticRecord::Error::MissingAssociation.new(assoc)
|
34
|
+
elsif !(reflection.has_one? || reflection.belongs_to?)
|
35
|
+
raise AutomaticRecord::Error::InvalidAssociation.new(assoc)
|
36
|
+
else
|
37
|
+
define_method(assoc) do |force_reload=false|
|
38
|
+
return get_or_auto_create_assoc(assoc, force_reload, default_attrs_or_block)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def get_or_auto_create_assoc(assoc, force_reload=false, default_attrs_or_block={}) # :nodoc:
|
47
|
+
result = method(assoc).super_method.call(force_reload)
|
48
|
+
if result.blank?
|
49
|
+
if default_attrs_or_block.is_a?(Proc)
|
50
|
+
result = default_attrs_or_block.call(self)
|
51
|
+
else
|
52
|
+
result = send("create_#{assoc}", default_attrs_or_block)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
return result
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module AutomaticRecord
|
2
|
+
class Railtie < Rails::Engine
|
3
|
+
|
4
|
+
config.autoload_paths << "#{root}/lib"
|
5
|
+
|
6
|
+
config.generators do |g|
|
7
|
+
g.test_framework :rspec
|
8
|
+
g.fixture_replacement :factory_girl, :dir => 'spec/factories'
|
9
|
+
end
|
10
|
+
|
11
|
+
initializer 'automatic_record' do
|
12
|
+
ActiveSupport.on_load(:active_record) do
|
13
|
+
ActiveRecord::Base.send :include, AutomaticRecord::AutoCreate
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
== README
|
2
|
+
|
3
|
+
This README would normally document whatever steps are necessary to get the
|
4
|
+
application up and running.
|
5
|
+
|
6
|
+
Things you may want to cover:
|
7
|
+
|
8
|
+
* Ruby version
|
9
|
+
|
10
|
+
* System dependencies
|
11
|
+
|
12
|
+
* Configuration
|
13
|
+
|
14
|
+
* Database creation
|
15
|
+
|
16
|
+
* Database initialization
|
17
|
+
|
18
|
+
* How to run the test suite
|
19
|
+
|
20
|
+
* Services (job queues, cache servers, search engines, etc.)
|
21
|
+
|
22
|
+
* Deployment instructions
|
23
|
+
|
24
|
+
* ...
|
25
|
+
|
26
|
+
|
27
|
+
Please feel free to use a different markup language if you do not plan to run
|
28
|
+
<tt>rake doc:app</tt>.
|
data/spec/dummy/Rakefile
ADDED
@@ -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 any plugin's vendor/assets/javascripts directory 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
|
+
// compiled file.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any styles
|
10
|
+
* defined in the other CSS/SCSS files in this directory. It is generally better to create a new
|
11
|
+
* file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
@@ -0,0 +1,13 @@
|
|
1
|
+
class Preference < ActiveRecord::Base
|
2
|
+
|
3
|
+
belongs_to :user
|
4
|
+
belongs_to :user_with_default_attrs, :class_name => 'User', :foreign_key => 'user_id'
|
5
|
+
belongs_to :user_with_block, :class_name => 'User', :foreign_key => 'user_id'
|
6
|
+
|
7
|
+
auto_create :user
|
8
|
+
auto_create :user_with_default_attrs, {:username => 'defaulted'}
|
9
|
+
auto_create :user_with_block, ->(instance){
|
10
|
+
instance.create_user(:username => 'blocked')
|
11
|
+
}
|
12
|
+
|
13
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
class User < ActiveRecord::Base
|
2
|
+
|
3
|
+
has_one :preference
|
4
|
+
has_one :preference_with_default_attrs, :class_name => 'Preference'
|
5
|
+
has_one :preference_with_block, :class_name => 'Preference'
|
6
|
+
|
7
|
+
auto_create :preference
|
8
|
+
auto_create :preference_with_default_attrs, {:language => 'en', :notifications => true}
|
9
|
+
auto_create :preference_with_block, ->(instance){
|
10
|
+
instance.create_preference(:language => 'fr', :notifications => true)
|
11
|
+
}
|
12
|
+
|
13
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>Dummy</title>
|
5
|
+
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
|
6
|
+
<%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
data/spec/dummy/bin/rake
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'pathname'
|
3
|
+
|
4
|
+
# path to your application root.
|
5
|
+
APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
|
6
|
+
|
7
|
+
Dir.chdir APP_ROOT do
|
8
|
+
# This script is a starting point to setup your application.
|
9
|
+
# Add necessary setup steps to this file:
|
10
|
+
|
11
|
+
puts "== Installing dependencies =="
|
12
|
+
system "gem install bundler --conservative"
|
13
|
+
system "bundle check || bundle install"
|
14
|
+
|
15
|
+
# puts "\n== Copying sample files =="
|
16
|
+
# unless File.exist?("config/database.yml")
|
17
|
+
# system "cp config/database.yml.sample config/database.yml"
|
18
|
+
# end
|
19
|
+
|
20
|
+
puts "\n== Preparing database =="
|
21
|
+
system "bin/rake db:setup"
|
22
|
+
|
23
|
+
puts "\n== Removing old logs and tempfiles =="
|
24
|
+
system "rm -f log/*"
|
25
|
+
system "rm -rf tmp/cache"
|
26
|
+
|
27
|
+
puts "\n== Restarting application server =="
|
28
|
+
system "touch tmp/restart.txt"
|
29
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require File.expand_path('../boot', __FILE__)
|
2
|
+
|
3
|
+
require 'rails/all'
|
4
|
+
|
5
|
+
Bundler.require(*Rails.groups)
|
6
|
+
require "automatic_record"
|
7
|
+
|
8
|
+
module Dummy
|
9
|
+
class Application < Rails::Application
|
10
|
+
# Settings in config/environments/* take precedence over those specified here.
|
11
|
+
# Application configuration should go into files in config/initializers
|
12
|
+
# -- all .rb files in that directory are automatically loaded.
|
13
|
+
|
14
|
+
# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
|
15
|
+
# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
|
16
|
+
# config.time_zone = 'Central Time (US & Canada)'
|
17
|
+
|
18
|
+
# The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
|
19
|
+
# config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
|
20
|
+
# config.i18n.default_locale = :de
|
21
|
+
|
22
|
+
# Do not swallow errors in after_commit/after_rollback callbacks.
|
23
|
+
config.active_record.raise_in_transactional_callbacks = true
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|