activerecord-safe_initialize 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDY2MmRmY2VlOWNiOGNiMmMxYWNiOTE1MTAxZjk5MGM3MzVlNWE3MA==
+  data.tar.gz: !binary |-
+    NTkyOWU3OWJiZTk5ZDk4NzcxYmM2MjM4ZjA3YzAyMDRmZjk3MzdmYg==
+SHA512:
+  metadata.gz: !binary |-
+    MGU5ZDZmM2E3MWNmMDhlZWI2Yzg1MWRlMTYzNWI5ODNhZDI1YmVhNjM5NzUz
+    YjYwMzllYzk0MGQwNDA2NjRkMmYzMTUwOGM5YWVhYjAxMjFkNjJiNmQ1YjM1
+    M2I3ODNhY2ZjN2QxNDkzNDJkMzA0MTVkMTNkNmQwNDg4NTdiODU=
+  data.tar.gz: !binary |-
+    NTllYmQzNmU5MmU3MGJmYzU1N2I2ODAzNmJlNWEwNTJiYmJjMjdiYTIwYjU0
+    Y2JkZWRiNzc2ZmFjNzhlMjI5YjhkMjM0YTc5ZjZjYmIxNDM2YWM5OTM5OWE0
+    OWY1MjIyNTM3ZDFhMGE3Yjk2MGVkY2QxODk2NTViYWU2ZGQ2ZDE=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-safe_initialize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lyconic
+
+MIT License
+
+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,78 @@
+# ActiveRecord::SafeInitialize
+[![Build Status](https://travis-ci.org/lyconic/activerecord-safe_initialize.svg)](https://travis-ci.org/lyconic/activerecord-safe_initialize)
+
+Safely initialize an ActiveRecord attribute with respect to missing columns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-safe_initialize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-safe_initialize
+
+## Usage
+
+If you want to select subsets of SQL tables, you have to use `after_initialize` with care:
+
+```ruby
+class Post < ActiveRecord::Base
+  after_initialize { self.category ||= 'Default' }
+end
+
+Post.select([:title, :body, :published_at]).first # => ActiveModel::MissingAttributeError
+```
+
+To do this safely you must write:
+
+```ruby
+class Post < ActiveRecord::Base
+  after_initialize { self.category ||= 'Default' if has_attribute?(:category) }
+end
+```
+
+With `safe_initialize` you can write:
+
+```ruby
+class Post < ActiveRecord::Base
+  safe_initialize :category, with: 'Default'
+end
+```
+
+If `with` is a Symbol, `safe_initialize` will send it to `self` to get the value:
+
+```ruby
+class Post < ActiveRecord::Base
+  safe_initialize :uuid, with: :generate_uuid
+
+private
+
+  def generate_uuid
+    SecureRandom.uuid
+  end
+end
+```
+
+If `with` is callable, it will `instance_exec` it to get the value:
+
+```ruby
+class Post < ActiveRecord::Base
+  safe_initialize :uuid, with: ->{ SecureRandom.uuid }
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/lyconic/activerecord-safe_initialize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+
+task :default => :spec

data/activerecord-safe_initialize.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/safe_initialize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-safe_initialize"
+  spec.version       = ActiveRecord::SafeInitialize::VERSION
+  spec.authors       = ["Adam Lassek"]
+  spec.email         = ["alassek@lyconic.com"]
+  spec.summary       = %q{Safely initialize an ActiveRecord attribute with respect to missing columns}
+  spec.homepage      = "https://github.com/lyconic/activerecord-safe_initialize"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/active_record/safe_initialize.rb

@@ -0,0 +1,22 @@
+require "active_record"
+require "active_record/safe_initialize/version"
+
+module ActiveRecord
+  module SafeInitialize
+    def safe_initialize(attribute, options = {})
+      raise ArgumentError, "Missing initialization value" unless options[:with]
+
+      after_initialize do
+        if has_attribute?(attribute) && read_attribute(attribute).nil?
+          value = options[:with]
+          value = instance_exec(&value) if value.respond_to?(:call)
+          value = self.send(value) if value.is_a?(Symbol)
+
+          self.send "#{attribute}=", value
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend ActiveRecord::SafeInitialize

data/lib/active_record/safe_initialize/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module SafeInitialize
+    VERSION = '0.0.1'
+  end
+end

data/lib/activerecord-safe_initialize.rb

@@ -0,0 +1 @@
+require 'active_record/safe_initialize'

data/spec/active_record/safe_initialize_spec.rb

@@ -0,0 +1,52 @@
+describe ActiveRecord::SafeInitialize do
+  before(:all) { Post.create(title: "Test Post", body: "This is a test.", uuid: nil) }
+  after(:all)  { Post.first.destroy }
+
+  context "with: missing" do
+    it "raises ArgumentError" do
+      expect{ Post.safe_initialize(:uuid) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "with: String" do
+    it "uses the value as the default" do
+      klass = Class.new(Post)
+      klass.safe_initialize :uuid, with: 'foo'
+
+      expect( klass.first.uuid ).to eq 'foo'
+    end
+  end
+
+  context "with: Symbol" do
+    it "sends the symbol to self to get value" do
+      klass = Class.new(Post)
+      klass.class_eval { def init_uuid; 'bar'; end }
+      klass.safe_initialize :uuid, :with => :init_uuid
+
+      expect( klass.first.uuid ).to eq 'bar'
+    end
+  end
+
+  context "with: callable" do
+    it "instance execs the callable to get the value" do
+      klass = Class.new(Post)
+      klass.class_eval { def init_uuid; 'baz'; end }
+      klass.safe_initialize :uuid, with: ->{ self.init_uuid }
+
+      expect( klass.first.uuid ).to eq 'baz'
+    end
+  end
+
+  context "existing value" do
+    let(:uuid) { SecureRandom.uuid }
+
+    before(:each) { Post.first.update_attribute :uuid, uuid }
+
+    it "does nothing" do
+      klass = Class.new(Post)
+      klass.safe_initialize :uuid, with: 'foo'
+
+      expect( klass.first.uuid ).to eq uuid
+    end
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1,32 @@
+describe Post do
+  before(:all) { Post.create(title: "Test Post", body: "This is a test.", uuid: SecureRandom.uuid) }
+  after(:all)  { Post.first.destroy }
+
+  context "with standard after_initialize" do
+    let(:klass) do
+      Class.new(Post).tap do |k|
+        k.after_initialize { self.uuid ||= SecureRandom.uuid }
+      end
+    end
+
+    it "works fine when all columns are selected" do
+      expect{ klass.first }.to_not raise_error
+    end
+
+    it "raises ActiveModel::MissingAttributeError when uuid is not selected" do
+      expect{ klass.select(:title).first }.to raise_error(ActiveModel::MissingAttributeError)
+    end
+  end
+
+  context "with safe_initialize" do
+    let(:klass) do
+      Class.new(Post).tap do |k|
+        k.safe_initialize :uuid, with: ->{ SecureRandom.uuid }
+      end
+    end
+
+    it "does not raise an error when uuid is missing" do
+      expect{ klass.select(:title).first }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'active_record/safe_initialize'
+require 'securerandom'
+
+ActiveRecord::Base.configurations = {
+  'test' => {
+    'adapter'   => 'sqlite3',
+    'database'  => ':memory:',
+    'verbosity' => 'quiet'
+  }
+}
+
+ActiveRecord::Base.establish_connection :test
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define(version: 20150830080017) do
+
+  create_table "posts", force: true do |t|
+    t.string "title"
+    t.text   "body"
+    t.string "uuid"
+  end
+
+end
+
+class Post < ActiveRecord::Base; end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-safe_initialize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Lassek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alassek@lyconic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-safe_initialize.gemspec
+- lib/active_record/safe_initialize.rb
+- lib/active_record/safe_initialize/version.rb
+- lib/activerecord-safe_initialize.rb
+- spec/active_record/safe_initialize_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lyconic/activerecord-safe_initialize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Safely initialize an ActiveRecord attribute with respect to missing columns
+test_files:
+- spec/active_record/safe_initialize_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb