active_null 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e79140a41af436782d71c91c0ddf040381e97da4
+  data.tar.gz: 07bc97f09a1852ed98dfa86b97a0234bb8352f66
+SHA512:
+  metadata.gz: f78e90ca8b8555540005622d099edce35c10a6d0b409daeb7bc0a0b9507ffb62bebca6950ef1ee98ebcfcd781af3d7b8afc7d7c08b043e0ed13f330c602bd035
+  data.tar.gz: 063645859d0cb859e2cf0f71bca659c6744d4117311ea38135680e07b999d0b39cd4bf354e1139d55f1e73fa2ce960ce9d120326014fcc098ec11ddb67fc2aa9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+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,94 @@
+# ActiveNull
+
+Using Null Objects can make life a lot easier and avoid having excessive `nil?` checks.
+Avdi Grimm made an excellent library called [Naught][1] which makes
+working with and building Null Objects easier. Thank you Avdi for making
+this possible!
+
+This library makes ActiveRecord Models aware of Null Objects and act as you
+would hope they would when using null objects in your project.
+
+This is specially useful when combined with a decorator library like [Draper][2].
+By knowing you have an object instead of the dreaded `nil` you can just
+decorate it and your view won't know any different.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_null'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_null
+
+## Usage
+
+For each model you would like to be null aware, `extend ActiveNull`.
+
+```ruby
+class Post < ActiveRecord::Base
+  extend ActiveNull
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  extend ActiveNull
+  belongs_to :post
+end
+```
+
+You can now do things like this:
+
+```ruby
+Post.null              # => <null:Post>
+Post.null.comments     # => []
+Comment.null           # => <null:Comment>
+Comment.null.post      # => <null:Post>
+Comment.new.post       # => <null:Post>
+Post.find_by(id: 1)    # => <null:Post>
+```
+
+## Additional Features
+
+You may find you want your Null Object to respond to certain methods
+in a specific way. These methods might be new or they might be
+overrides of the default Null Object definition.
+You can define this in your model:
+
+```ruby
+class Post < ActiveRecord::Base
+  extend ActiveNull
+
+  null_model do
+    def some_method
+      # special functionality
+    end
+  end
+end
+```
+
+If you have `Draper` included in your project, the Null Object versions of
+your model will respond as expected to `decorate`.
+
+You can then safely do something like:
+
+```ruby
+@post = Post.find_by(id: 1).decorate
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Originate/active_null/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
+
+
+  [1]: https://github.com/avdi/naught
+  [2]: https://github.com/drapergem/draper

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'active_null' # You know what to do.
+  ARGV.clear
+  IRB.start
+end

data/active_null.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_null/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_null'
+  spec.version       = ActiveNull::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@originate.com']
+  spec.summary       = %q{Make ActiveRecord null model aware.}
+  spec.description   = %q{Make ActiveRecord null model aware.}
+  spec.homepage      = 'https://github.com/Originate/active_null'
+  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 'naught', '~> 1.0'
+
+  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 'sqlite3'
+  spec.add_development_dependency 'draper', '~> 1.3'
+end

data/lib/active_null/null_model_builder.rb

@@ -0,0 +1,68 @@
+require 'naught'
+
+module ActiveNull
+  class NullModelBuilder
+    attr_reader :model, :overrides
+
+    def initialize(model, overrides)
+      @model = model
+      @overrides = overrides
+    end
+
+    def build
+      model = self.model
+      return full_name.constantize if Object.const_defined? full_name
+      null = Naught.build do |config|
+        config.impersonate model
+
+        model.reflect_on_all_associations.each do |relation|
+          if relation.collection?
+            define_method(relation.name) { [] }
+          else
+            define_method(relation.name) do
+              return unless relation.klass.respond_to? :null
+              relation.klass.null
+            end
+          end
+        end
+
+        model.column_defaults.each do |field, default|
+          define_method(field.to_sym) { default }
+        end
+
+        def nil?
+          true
+        end
+
+        def present?
+          false
+        end
+
+        def blank?
+          true
+        end
+
+        def to_json
+          '{}'
+        end
+      end
+      null.class_eval { include Draper::Decoratable } if Object.const_defined? 'Draper'
+      null.include(overrides) if overrides
+      set_null_model null
+    end
+
+    def name
+      base_name = model.name.split('::').last
+      "Null#{base_name}"
+    end
+
+    def full_name
+      return name if model.parent == Object
+      "#{model.parent.name}::#{name}"
+    end
+
+    def set_null_model(null)
+      model.parent.const_set name, null
+    end
+  end
+end

data/lib/active_null/version.rb

@@ -0,0 +1,3 @@
+module ActiveNull
+  VERSION = "0.0.1"
+end

data/lib/active_null.rb

@@ -0,0 +1,39 @@
+require 'active_null/version'
+require 'active_null/null_model_builder'
+
+module ActiveNull
+  def null
+    NullModelBuilder.new(self, @null_model_overrides).build.get
+  end
+
+  def null_model(&block)
+    @null_model_overrides = Module.new
+    @null_model_overrides.module_eval(&block)
+  end
+
+  def find_by(*args, &block)
+    super || null
+  end
+
+  def null_associations
+    self.reflect_on_all_associations.each do |relation|
+      unless relation.collection?
+        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
+          end
+        CODE
+      end
+    end
+  end
+
+  def self.extended(klass)
+    klass.class_eval <<-CODE
+      after_initialize do
+        self.class.null_associations
+      end
+    CODE
+  end
+end

data/spec/active_null_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe ActiveNull do
+  describe '.null' do
+    specify { expect(Post.null).to be_instance_of(NullPost) }
+  end
+
+  describe '.null_model' do
+    specify { expect(Post.null.override).to eq 'I am an override.' }
+  end
+
+  describe 'a has many' do
+    specify { expect(Post.null.comments).to eq [] }
+  end
+
+  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) }
+  end
+
+  it 'supports draper' do
+    expect(Post.null.decorate).to be_decorated_with(NullPostDecorator)
+  end
+end

data/spec/models.rb

@@ -0,0 +1,22 @@
+class Post < ActiveRecord::Base
+  extend ActiveNull
+  has_many :comments
+  null_model do
+    def override
+      'I am an override.'
+    end
+  end
+end
+
+class Comment < ActiveRecord::Base
+  extend ActiveNull
+  belongs_to :post
+end
+
+class NullPostDecorator < Draper::Decorator
+  delegate_all
+end
+
+class PostDecorator < Draper::Decorator
+  delegate_all
+end

data/spec/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :comments, force: true do |t|
+    t.string :content
+    t.references :post
+    t.timestamps
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_null'
+require 'active_record'
+require 'draper'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+load File.dirname(__FILE__) + '/schema.rb'
+require File.dirname(__FILE__) + '/models.rb'

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: active_null
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: naught
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Make ActiveRecord null model aware.
+email:
+- alex.peachey@originate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_null.gemspec
+- 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/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Originate/active_null
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Make ActiveRecord null model aware.
+test_files:
+- spec/active_null_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb