automatic_record 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40acbf709da113d0bf43a47c07d6bec14844f870
+  data.tar.gz: 978030fe910a4f7423496fe0d9a0d012a572e5b2
+SHA512:
+  metadata.gz: 984c40283762c8dc41218d30cd9d1f78dff321fa7f09fc3ad9341af505240f3f0e63a3441eb5eef93a5c4882038e829d66a0a023a584c5df22eebb532d01419b
+  data.tar.gz: 0e666081ee81d57227bf47469efb50f5c0b0df5bc228fb33d9da7334313fc8b05cdc2065d1fc35ed9b7df479f9e6d790b01a62b6a59bdb3484f9864164b16be7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Greg Woods
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# AutomaticRecord
+
+This gem allows lazy creation of `:has_one` and `:belongs_to` associations as they are accessed.
+
+## Installation
+
+Add the following line to your Gemfile:
+
+    gem 'automatic_record'
+
+Then run `bundle install` and restart your application.
+
+## Example Usage
+
+The example below illustrates the most basic use case.
+
+    class User < ActiveRecord::Base
+      # The user model has a related Preference object
+      has_one :preference
+
+      # Make sure preference is created when it is first accessed
+      auto_create :preference
+    end
+
+This would allow us to do something like the following in our code:
+
+    user = User.create() # preference is currently nil
+    pref = user.preference # creates preference object on the fly
+
+## Advanced Usage
+
+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.
+
+    class User < ActiveRecord::Base
+      has_one :preference
+      auto_create :preference, :language => 'en', :notifications => true
+    end
+
+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.
+
+    class User < ActiveRecord::Base
+      has_one :preference
+      auto_create :preference, ->(user){
+        user.create_preference(:language => 'en', :notifications => true)
+      }
+    end
+
+## Testing
+
+AutomaticRecord uses rspec for testing.
+
+    RAILS_ENV=test rake db:create db:migrate
+    rspec spec

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutomaticRecord'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/lib/automatic_record.rb

@@ -0,0 +1,3 @@
+module AutomaticRecord
+  require 'automatic_record/engine'
+end

data/lib/automatic_record/auto_create.rb

@@ -0,0 +1,59 @@
+module AutomaticRecord
+  module AutoCreate
+    extend ActiveSupport::Concern
+
+    included do
+
+    end
+
+    module ClassMethods
+
+      # Specifies that the given association should be created automaticaly whenever it is accessed, if
+      # it does not already exist. This method should only be used on associations that are defined as
+      # either :belongs_to or :has_one.
+      #
+      # === Example
+      #
+      #  class User < ActiveRecord::Base
+      #    has_one :preference
+      #    auto_create :preference
+      #  end
+      #
+      # === Options
+      #
+      # Pass a list of default attributes:
+      #  auto_create :preference, :language => 'en', :notifications => true
+      #
+      # Pass a block to be used for object creation:
+      #  auto_create :preference, ->(user){ user.create_preference(:language => 'en', :notifications => true) }
+      #
+      def auto_create(assoc, default_attrs_or_block={})        
+        reflection = reflect_on_association(assoc)
+        if reflection.nil?
+          raise AutomaticRecord::Error::MissingAssociation.new(assoc)
+        elsif !(reflection.has_one? || reflection.belongs_to?)
+          raise AutomaticRecord::Error::InvalidAssociation.new(assoc)
+        else
+          define_method(assoc) do |force_reload=false|
+            return get_or_auto_create_assoc(assoc, force_reload, default_attrs_or_block)
+          end
+        end
+      end
+    end
+
+private
+
+    def get_or_auto_create_assoc(assoc, force_reload=false, default_attrs_or_block={}) # :nodoc:
+      result = method(assoc).super_method.call(force_reload)
+      if result.blank?
+        if default_attrs_or_block.is_a?(Proc)
+          result = default_attrs_or_block.call(self)
+        else
+          result = send("create_#{assoc}", default_attrs_or_block)
+        end
+      end
+      return result
+    end
+
+  end
+end

data/lib/automatic_record/engine.rb

@@ -0,0 +1,18 @@
+module AutomaticRecord
+  class Railtie < Rails::Engine
+
+    config.autoload_paths << "#{root}/lib"
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+
+    initializer 'automatic_record' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, AutomaticRecord::AutoCreate
+      end
+    end
+
+  end
+end

data/lib/automatic_record/error/invalid_association.rb

@@ -0,0 +1,7 @@
+module AutomaticRecord
+  class Error::InvalidAssociation < StandardError
+    def initialize(assoc_name)
+      super("Cannot auto-create :#{assoc_name} because it is not a :has_one or :belongs_to association")
+    end
+  end
+end

data/lib/automatic_record/error/missing_association.rb

@@ -0,0 +1,7 @@
+module AutomaticRecord
+  class Error::MissingAssociation < StandardError
+    def initialize(assoc_name)
+      super("Attempted to auto_create non-existent :#{assoc_name} association")
+    end
+  end
+end

data/lib/automatic_record/version.rb

@@ -0,0 +1,3 @@
+module AutomaticRecord
+  VERSION = "0.0.2"
+end

data/lib/tasks/automatic_record_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :automatic_record do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/preference.rb

@@ -0,0 +1,13 @@
+class Preference < ActiveRecord::Base
+
+  belongs_to :user
+  belongs_to :user_with_default_attrs, :class_name => 'User', :foreign_key => 'user_id'
+  belongs_to :user_with_block, :class_name => 'User', :foreign_key => 'user_id'
+
+  auto_create :user
+  auto_create :user_with_default_attrs, {:username => 'defaulted'}
+  auto_create :user_with_block, ->(instance){
+    instance.create_user(:username => 'blocked')
+  }
+
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,13 @@
+class User < ActiveRecord::Base
+
+  has_one :preference
+  has_one :preference_with_default_attrs, :class_name => 'Preference'
+  has_one :preference_with_block, :class_name => 'Preference'
+
+  auto_create :preference
+  auto_create :preference_with_default_attrs, {:language => 'en', :notifications => true}
+  auto_create :preference_with_block, ->(instance){
+    instance.create_preference(:language => 'fr', :notifications => true)
+  }
+
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "automatic_record"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,13 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: mysql2
+  username: root
+
+test:
+  <<: *default
+  database: automatic_record_test