activerecord-define_nils 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+Define Nils for ActiveRecord 3.x/4.x and Rails 3.x/4.x
+=====
+
+If working with a legacy database used by another application that uses a non-null value to mean null, you may need to translate certain values to nil to make them more normal to work with in Ruby/Rails and then save nil as a specific value.
+
+For example, if nil is stored as 0 in `my_id`:
+
+    define_nils as: 0, for: :my_id
+
+If nil is stored as 0 in `my_id` and `your_id`:
+
+    define_nils as: 0, for: [:my_id, :your_id]
+
+If you want to accept 0 or '' as nil for `my_id` but save nil as 0:
+
+    define_nils as: [0, ''], for: :my_id, saving_as: 0
+
+It will choose the only/first element in the as if you don't specify `saving_as`, so a less clear way to define that is:
+
+    define_nils as: [0, ''], for: :my_id
+
+If you want to accept 0 or '' as nil for `my_id` and `your_id` but save nil as nil/null:
+
+    define_nils as: [0, ''], for: [:my_id, :your_id], saving_as: nil
+
+It handles `read_attribute` calls, calls to the attribute name, and all `belongs_to` associations defined after the `define_nils` that use the specified attribute as a foreign_key. It also will show the value as nil in calls to inspect/returned values in rails console. So, for the most part it should look as if the value is nil within Ruby but on the database-side, nil is stored as whatever value you want to represent nil.
+
+### Setup
+
+In your ActiveRecord/Rails 3.1+ project, add this to your Gemfile:
+
+    gem 'activerecord-define_nils'
+
+For the development version:
+
+    gem 'activerecord-define_nils', :git => 'git://github.com/garysweaver/activerecord-define_nils.git'
+
+Then run:
+
+    bundle install
+
+### Usage
+
+If you are on Rails, the concern `ActiveRecordDefineNils::Model` is included automatically in `ActiveRecord::Base` via railtie.
+
+Be sure to place `define_nils` above your `belongs_to` associations in the model class or those associations will query on unaltered foreign key values, which is probably not what you want.
+
+### License
+
+Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/activerecord-define_nils/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/activerecord-define_nils/model.rb

@@ -0,0 +1,76 @@
+module ActiveRecordDefineNils
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :nil_definitions, instance_writer: false
+      class_attribute :nil_saved_as, instance_writer: false
+    end
+
+    module ClassMethods
+
+      def define_nils(options)
+        raise ArgumentError.new("define_nils takes a hash, but got #{options.inspect}") unless options.is_a?(Hash)
+        if options.has_key?(:as) && options.has_key?(:for)
+          self.nil_saved_as ||= {}
+          self.nil_definitions ||= {}
+          as_vals = Array.wrap(options[:as])
+          raise ArgumentError.new("define_nils must supply at least one value for :as, but got #{options.inspect}") if as_vals.size == 0
+          Array.wrap(options[:for]).each do |attr_name|
+            attr_sym = attr_name.to_sym
+            self.nil_saved_as[attr_sym] = options[:saving_as] || as_vals[0]
+            self.nil_definitions[attr_sym] = as_vals
+            class_eval "def #{attr_name}; value = super(); self.nil_definitions && self.nil_definitions[#{attr_sym.inspect}] && self.nil_definitions[#{attr_sym.inspect}].include?(value) ? nil : value; end"
+          end
+        else
+          raise ArgumentError.new("define_nils must at least supply :as and :for, but got #{options.inspect}")
+        end
+      end
+
+      def belongs_to(*args)
+        super(*args)
+        return unless self.nil_definitions
+        # after belongs_to is finished, we wrap it
+        self.nil_definitions.keys.each do |attr_sym|
+          self.reflections.collect {|association_name, reflection|
+            if reflection.macro == :belongs_to && reflection.foreign_key.to_sym == attr_sym
+              class_eval "def #{association_name}; return nil if send(#{attr_sym.inspect}).nil?; super(); end"
+            end
+          }
+        end
+      end
+
+    end
+
+    def read_attribute(attr_name)
+      value = super(attr_name)
+      self.nil_definitions && self.nil_definitions[attr_name.to_sym] && self.nil_definitions[attr_name.to_sym].include?(value) ? nil : value
+    end
+
+    private
+
+    def create
+      if self.nil_saved_as
+        self.nil_saved_as.each do |column, translated_nil|
+          if respond_to?(column) && respond_to?("#{column}=") && self.send(column).nil?
+            write_attribute(column.to_s, translated_nil)
+          end
+        end
+      end
+
+      super
+    end
+
+    def update(*args)
+      if self.nil_saved_as
+        self.nil_saved_as.each do |column, translated_nil|
+          if respond_to?(column) && respond_to?("#{column}=") && self.send(column).nil?
+            write_attribute(column.to_s, translated_nil)
+          end
+        end
+      end
+      
+      super
+    end
+  end
+end

data/lib/activerecord-define_nils/railtie.rb

@@ -0,0 +1,11 @@
+require 'activerecord-define_nils'
+
+module ActiveRecordDefineNils
+  class Railtie < Rails::Railtie
+    initializer "define_nils.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include ActiveRecordDefineNils::Model
+      end
+    end
+  end
+end

data/lib/activerecord-define_nils/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordDefineNils
+  VERSION = '0.0.1'
+end

data/lib/activerecord-define_nils.rb

@@ -0,0 +1,3 @@
+require 'activerecord-define_nils/version'
+require 'activerecord-define_nils/model'
+require 'activerecord-define_nils/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-define_nils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows you to redefine what is translated to nil on read and what is
+  stored instead of nil for specified attributes.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activerecord-define_nils/model.rb
+- lib/activerecord-define_nils/railtie.rb
+- lib/activerecord-define_nils/version.rb
+- lib/activerecord-define_nils.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/activerecord-define_nils
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Define nils for ActiveRecord 3.x/4.x.
+test_files: []