active_null 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd467d1bb5d62ddde65883fa1c81aa8a55d8747c
-  data.tar.gz: c092e04b7d8c27ad222097cd619b6d425d41e8b9
+  metadata.gz: 34802b6bb45c168b836473546d630a125fe6b116
+  data.tar.gz: db5beef0d960320f86938d4a04cc38b22d9be4bd
 SHA512:
-  metadata.gz: 0839b2c1846c5f1caf4aec78851177b3db1024e810b77524bd2c12a3a32fe9e3862a99d761cfeae9ba0b35630fbd72bcfecea731835d1cf24155fffed0c0db29
-  data.tar.gz: 30379d39ba04426101921d1c72d19b1dc2371c9573f5dedda4af23c8c3bd624e394ca3b8f1107710edbf3b4c12bbd6f1c8ae2c7265e6db4154f846c7806e44e9
+  metadata.gz: 53077a09ae14ecb32e5ef97df52b7178580fabde3cb0f9e5136219e9e6fdabae7eefa200986d95c899a76c76ec682d237a222ebcac9f978422979d82377c6d9d
+  data.tar.gz: d9a9dbf632553cf2eaa5ec794b17a1fd83b3f510cd77d81eeaa94d47c1cd5960fb3c2ca2b88f641f83279b48ada6168af5fbf1d28c1b1fbd52d0218c317e0011

data/README.md

@@ -1,3 +1,7 @@
+[![Circle CI](https://circleci.com/gh/Originate/active_null.svg?style=shield)](https://circleci.com/gh/Originate/active_null)
+[![Coverage Status](https://coveralls.io/repos/Originate/active_null/badge.svg?branch=master&service=github)](https://coveralls.io/github/Originate/active_null?branch=master)
+[![Code Climate](https://codeclimate.com/github/Originate/active_null/badges/gpa.svg)](https://codeclimate.com/github/Originate/active_null)
+
 # ActiveNull
 
 Using Null Objects can make life a lot easier and avoid having excessive `nil?` checks.
@@ -34,13 +38,11 @@ For each model you would like to be null aware, `extend ActiveNull`.
 class Post < ActiveRecord::Base
   extend ActiveNull
   has_many :comments
-  null_model
 end
 
 class Comment < ActiveRecord::Base
   extend ActiveNull
   belongs_to :post
-  null_model
 end
 ```
 
@@ -74,6 +76,17 @@ class Post < ActiveRecord::Base
 end
 ```
 
+When using polymorphic relationships, ActiveNull must be told a default
+model to use for the Null Object representation.
+
+```ruby
+class Post < ActiveRecord::Base
+  extend ActiveNull
+  belongs_to :author, polymorphic: true
+  null_defaults_for_polymorphic author: 'User'
+end
+```
+
 If you have `Draper` included in your project, the Null Object versions of
 your model will respond as expected to `decorate`.
 

data/active_null.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'activerecord', '~> 4.1'
+  spec.add_development_dependency 'activerecord', '~> 4.2'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'draper', '~> 1.3'
+  spec.add_development_dependency 'draper', '~> 2.1'
+  spec.add_development_dependency 'coveralls'
 end

data/circle.yml

@@ -0,0 +1,3 @@
+database:
+  override:
+    - echo skip database setup

data/lib/active_null/null_model_builder.rb

@@ -15,12 +15,22 @@ module ActiveNull
         config.impersonate model
 
         model.reflect_on_all_associations.each do |relation|
+          klass = begin
+            if relation.options[:polymorphic]
+              model.polymorphic_null_defaults[relation.name].constantize
+            else
+              relation.klass
+            end
+          rescue
+            nil
+          end
+          next unless klass
           if relation.collection?
-            define_method(relation.name) { relation.klass.none }
+            define_method(relation.name) { klass.none }
           else
             define_method(relation.name) do
-              return unless relation.klass.respond_to? :null
-              relation.klass.null
+              return unless klass.respond_to? :null
+              klass.null
             end
           end
         end

data/lib/active_null/version.rb

@@ -1,3 +1,3 @@
 module ActiveNull
-  VERSION = '0.0.6'
+  VERSION = '1.0.0'
 end

data/lib/active_null.rb

@@ -6,6 +6,14 @@ module ActiveNull
     null_class.get
   end
 
+  def null_defaults_for_polymorphic mappings
+    @polymorphic_null_defaults = mappings
+  end
+
+  def polymorphic_null_defaults
+    @polymorphic_null_defaults || {}
+  end
+
   def null_model(&block)
     @null_model_overrides = if block_given?
       Module.new.tap { |m| m.module_eval(&block) }
@@ -19,11 +27,21 @@ module ActiveNull
   def null_associations
     self.reflect_on_all_associations.each do |relation|
       unless relation.collection?
+        klass = begin
+          if relation.options[:polymorphic]
+            polymorphic_null_defaults[relation.name]
+          elsif relation.klass
+            relation.klass.name
+          end
+        rescue
+          nil
+        end
+        next unless klass
         class_eval <<-CODE
           def #{relation.name}(*args)
             result = association(:#{relation.name}).reader(*args)
-            return result if result || !#{relation.klass.name}.respond_to?(:null)
-            #{relation.klass.name}.null
+            return result if result || !#{klass}.respond_to?(:null)
+            #{klass}.null
           end
         CODE
       end

data/spec/active_null_spec.rb

@@ -4,10 +4,11 @@ describe ActiveNull do
   it 'defines the null class only when accessing it for the first time (ie: with a .null or .null_class call)' do
     expect(Object.const_defined? 'NullPost').to be_falsey
     expect(Object.const_defined? 'NullMicroPost').to be_falsey
-    expect(Post.null).to be_instance_of(NullPost)
+    expect(Post.null).to be_instance_of NullPost
     expect(MicroPost.null_class).to eq NullMicroPost
     expect(Object.const_defined? 'NullPost').to be_truthy
     expect(Object.const_defined? 'NullMicroPost').to be_truthy
+    expect(Test::TestModel.null).to be_instance_of Test::NullTestModel
   end
 
   describe '.null_class' do
@@ -24,6 +25,10 @@ describe ActiveNull do
     specify { expect(Post.null.override).to eq 'I am an override.' }
   end
 
+  describe '.find_by' do
+    specify { expect(Test::TestModel.find_by(id: 42)).to be_instance_of(Test::NullTestModel) }
+  end
+
   describe 'a has many' do
     specify { expect(Post.null.comments).to eq [] }
     specify { expect(Post.null.comments).to be_instance_of(Comment::ActiveRecord_Relation) }
@@ -34,6 +39,8 @@ describe ActiveNull do
   describe 'a belongs to' do
     specify { expect(Comment.null.post).to be_instance_of(NullPost) }
     specify { expect(Comment.new.post).to be_instance_of(NullPost) }
+    specify { expect(Comment.null.author).to be_instance_of(NullUser) }
+    specify { expect(Comment.new.author).to be_instance_of(NullUser) }
   end
 
   it 'supports draper' do

data/spec/models.rb

@@ -10,13 +10,18 @@ end
 
 class MicroPost < Post
   extend ActiveNull
-  null_model
+end
+
+class User < ActiveRecord::Base
+  extend ActiveNull
+  has_many :comments, as: :author
 end
 
 class Comment < ActiveRecord::Base
   extend ActiveNull
   belongs_to :post
-  null_model
+  belongs_to :author, polymorphic: true
+  null_defaults_for_polymorphic author: 'User'
 end
 
 class NullPostDecorator < Draper::Decorator
@@ -30,6 +35,5 @@ end
 module Test
   class TestModel < ActiveRecord::Base
     extend ActiveNull
-    null_model
   end
 end

data/spec/null_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'Null Models' do
+  subject(:null_model) { Test::TestModel.null }
+
+  describe '#nil?' do
+    specify { expect(null_model.nil?).to be_truthy }
+  end
+
+  describe '#present?' do
+    specify { expect(null_model.present?).to be_falsey }
+  end
+
+  describe '#blank?' do
+    specify { expect(null_model.blank?).to be_truthy }
+  end
+
+  describe '#to_json' do
+    specify { expect(null_model.to_json).to eq '{}' }
+  end
+
+  context 'Decoratable Null Models' do
+    subject(:null_model) { Post.null }
+
+    describe '#decorate' do
+      specify { expect(null_model.decorate).to be_decorated_with(null_model.decorator_class) }
+    end
+
+    describe '#decorator_class?' do
+      specify { expect(null_model.decorator_class?).to eq NullPostDecorator }
+    end
+
+    describe '#decorator_class' do
+      specify { expect(null_model.decorator_class).to eq NullPostDecorator }
+    end
+
+    context 'when not yet decorated' do
+      describe '#decorated?' do
+        specify { expect(null_model.decorated?).to be_falsey }
+      end
+
+      describe '#decorated_with?' do
+        specify { expect(null_model.decorated_with?(null_model.decorator_class)).to be_falsey }
+      end
+
+      describe '#applied_decorators' do
+        specify { expect(null_model.applied_decorators).to eq [] }
+      end
+    end
+
+    context 'when decorated' do
+      subject(:null_model) { Post.null.decorate }
+
+      describe '#decorated?' do
+        specify { expect(null_model.decorated?).to be_truthy }
+      end
+
+      describe '#decorated_with?' do
+        specify { expect(null_model.decorated_with?(null_model.decorator_class)).to be_truthy }
+      end
+
+      describe '#applied_decorators' do
+        specify { expect(null_model.applied_decorators).to eq [NullPostDecorator] }
+      end
+    end
+  end
+end

data/spec/schema.rb

@@ -4,16 +4,22 @@ ActiveRecord::Schema.define do
   create_table :posts, force: true do |t|
     t.string :title
     t.string :_type
-    t.timestamps
+    t.timestamps null: true
+  end
+
+  create_table :users, force: true do |t|
+    t.string :name
+    t.timestamps null: true
   end
 
   create_table :comments, force: true do |t|
     t.string :content
     t.references :post
-    t.timestamps
+    t.references :author, polymorphic: true
+    t.timestamps null: true
   end
 
   create_table :test_models, force: true do |t|
-    t.timestamps
+    t.timestamps null: true
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'active_null'
 require 'active_record'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_null
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: naught
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Make ActiveRecord null model aware.
 email:
 - alex.peachey@originate.com
@@ -117,17 +131,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_null.gemspec
+- circle.yml
 - lib/active_null.rb
 - lib/active_null/null_model_builder.rb
 - lib/active_null/version.rb
 - spec/active_null_spec.rb
 - spec/models.rb
+- spec/null_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Originate/active_null
@@ -150,12 +165,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Make ActiveRecord null model aware.
 test_files:
 - spec/active_null_spec.rb
 - spec/models.rb
+- spec/null_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.2