activerecord-define_nils 0.0.3 → 1.0.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjM4MjhjMmRiODg1MzViMmU0ZmJhZTNkNDM0Njk1OTdkN2U2YzY3Mg==
-  data.tar.gz: !binary |-
-    MTY1OGFjNzhjNjUwNGY5Yzk5ZGJiMmE2NGM0ZDVkZGM2MGRjNGVkNw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MTVmMTk4MTFmY2NhMzk1OWRkMjY4OWI3ZDFmNmNhODRiOTI5Mjk1OGE2YzYx
-    NmUzYTgzZDM1YjcxOWJhOTE1MTM0MDYzZjRiZWEyZmU3OWJlY2RhNzAxZjVj
-    NGNhNmExMjZjZmIyODljNzRkZmI5YjJmZjUxNGI4YzIyOTE1NTU=
-  data.tar.gz: !binary |-
-    MWMyNThlNzMxOWE5NWViYmU4OWJhYjBlZTNkNTQ1OTFkNmU5MWEyMGE2NDIy
-    OGRlNTQxNjMwODE3OTlmZDRiZjllZDNkMmM2YTM2MDg0MmYzODcwNDhiZGEw
-    ZjE3NDJmZDIwYTlmMGE3MjgwYjFkMjE0MjJjMGM2MDI0MmNmNGY=
+SHA1:
+  metadata.gz: 9d412a0dfa95d7673ea71b6b2282993c5bc8ff32
+  data.tar.gz: 43bb8fc329da8e22b8208bdd5f9c14ee5073df43
+SHA512:
+  metadata.gz: 64cfaeeba84005015e95bc5ba0682806070f5a5076cc43fadd921872ed5331a00edc8cad47495cb094aabdc0d7e8364b91ee4510a562c0781bbba81bef93ab71
+  data.tar.gz: 112ecc75ce20d42b67d7df337612948028786f4d7e2cfb3cc27a945ccbcfad862ef0a9f220df294f604e9f04ea1d5e397640599b632a092e85ffad0344c45a7d

data/README.md

@@ -1,5 +1,6 @@
-Define Nils for ActiveRecord 3.x/4.x and Rails 3.x/4.x
-=====
+## Define Nils
+
+Tested with Rails/ActiveRecord 3.1, 3.2, 4.0, 4.1, and 4.2.
 
 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.
 
@@ -31,10 +32,6 @@ 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
@@ -45,8 +42,13 @@ If you are on Rails, the concern `ActiveRecordDefineNils::Model` is included aut
 
 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.
 
+### Authors
+
+This was written by [FineLine Prototyping, Inc.](http://www.finelineprototyping.com) by the following contributors:
+* Gary Weaver (https://github.com/garysweaver)
+
 ### License
 
-Copyright (c) 2013 Gary S. Weaver, released under the [MIT license][lic].
+Copyright (c) 2013 FineLine Prototyping, Inc., released under the [MIT license][lic].
 
-[lic]: http://github.com/garysweaver/activerecord-define_nils/blob/master/LICENSE
+[lic]: http://github.com/FineLinePrototyping/activerecord-define_nils/blob/master/LICENSE

data/Rakefile

@@ -1,10 +1,16 @@
-require 'rake/testtask'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
+# Override the default task
+task :default => [] # Just in case it hasn't already been set
+Rake::Task[:default].clear
+task :default => :appraise
 
-desc "Run tests"
-task :default => :test
+task :appraise do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    load 'test/define_nils_test.rb'
+  else
+    exec 'appraisal install && rake appraisal'
+  end
+end

data/lib/activerecord-define_nils.rb

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

data/lib/activerecord-define_nils/early_rails4_model.rb

@@ -0,0 +1,82 @@
+module ActiveRecordDefineNils
+  module EarlyRails3Model
+    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.key?(:saving_as) ? 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 takes a hash with :as and :for keys, 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)
+      (@define_nils_no_read_mod ||= false) ? value : (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_record
+      @define_nils_no_read_mod = true
+      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
+    ensure
+      @define_nils_no_read_mod = false
+    end
+
+    def create_record(*args)
+      @define_nils_no_read_mod = true
+      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
+    ensure
+      @define_nils_no_read_mod = false
+    end
+  end
+end

data/lib/activerecord-define_nils/model.rb

@@ -18,7 +18,7 @@ module ActiveRecordDefineNils
           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_saved_as[attr_sym] = options.key?(:saving_as) ? 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
@@ -49,7 +49,7 @@ module ActiveRecordDefineNils
 
     private
 
-    def create
+    def _create_record
       @define_nils_no_read_mod = true
       if self.nil_saved_as
         self.nil_saved_as.each do |column, translated_nil|
@@ -64,9 +64,9 @@ module ActiveRecordDefineNils
       @define_nils_no_read_mod = false
     end
 
-    def update(*args)
+    def _update_record(*args, touch: true, **options)
       @define_nils_no_read_mod = true
-      if self.nil_saved_as
+      if touch && 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)
@@ -74,7 +74,7 @@ module ActiveRecordDefineNils
         end
       end
       
-      super
+      super(*args, touch, **options)
     ensure
       @define_nils_no_read_mod = false
     end

data/lib/activerecord-define_nils/rails3_model.rb

@@ -0,0 +1,82 @@
+module ActiveRecordDefineNils
+  module Rails3Model
+    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.key?(:saving_as) ? 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 takes a hash with :as and :for keys, 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)
+      (@define_nils_no_read_mod ||= false) ? value : (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
+      @define_nils_no_read_mod = true
+      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
+    ensure
+      @define_nils_no_read_mod = false
+    end
+
+    def update(*args)
+      @define_nils_no_read_mod = true
+      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
+    ensure
+      @define_nils_no_read_mod = false
+    end
+  end
+end

data/lib/activerecord-define_nils/railtie.rb

@@ -4,7 +4,15 @@ module ActiveRecordDefineNils
   class Railtie < Rails::Railtie
     initializer "define_nils.active_record" do
       ActiveSupport.on_load(:active_record) do
-        include ActiveRecordDefineNils::Model
+        if Rails::VERSION::MAJOR == 4
+          if Rails::VERSION::MINOR < 2
+            include ::ActiveRecordDefineNils::EarlyRails4Model
+          else
+            include ::ActiveRecordDefineNils::Model
+          end
+        elsif Rails::VERSION::MAJOR == 3 
+          include ::ActiveRecordDefineNils::Rails3Model
+        end
       end
     end
   end

data/lib/activerecord-define_nils/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordDefineNils
-  VERSION = '0.0.3'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-define_nils
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Gary S. Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Allows you to redefine what is translated to nil on read and what is
@@ -32,13 +32,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
+- lib/activerecord-define_nils.rb
+- lib/activerecord-define_nils/early_rails4_model.rb
 - lib/activerecord-define_nils/model.rb
+- lib/activerecord-define_nils/rails3_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
+homepage: https://github.com/FineLinePrototyping/activerecord-define_nils
 licenses:
 - MIT
 metadata: {}
@@ -48,17 +50,17 @@ 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.0.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Define nils for ActiveRecord 3.x/4.x.