sequel-string_nilifier 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonathan Tron
+
+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,35 @@
+# Sequel::StringNilifier
+
+Sequel plugin to convert empty string to nil
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-string_nilifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-string_nilifier
+
+## Usage
+
+```ruby
+# Make all model subclass instances nilify strings (called before loading subclasses)
+Sequel::Model.plugin :string_nilifier
+
+# Make the Album class nilify strings
+Album.plugin :string_nilifier
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sequel/plugins/string_nilifier.rb

@@ -0,0 +1,60 @@
+module Sequel
+  module Plugins
+    module StringNilifier
+      # Set blob columns as skipping nilifying when plugin is loaded.
+      def self.configure(model)
+        model.instance_variable_set(:@skipped_string_nilifier_columns, [])
+        model.send(:set_skipped_string_nilifying_columns)
+      end
+
+      module ClassMethods
+        # Copy skipped nilifying columns from superclass into subclass.
+        def inherited(subclass)
+          subclass.instance_variable_set(:@skipped_string_nilifier_columns, @skipped_string_nilifier_columns.dup)
+          super
+        end
+
+        # Set blob columns as skipping stripping when plugin is loaded.
+        def set_dataset(*)
+          super
+          set_skipped_string_nilifying_columns
+        end
+
+        # Skip nilifying for the given columns.
+        def skip_string_nilifying(*columns)
+          @skipped_string_nilifier_columns.concat(columns).uniq!
+        end
+
+        # Return true if the column should not have values stripped.
+        def skip_string_nilifying?(column)
+          @skipped_string_nilifier_columns.include?(column)
+        end
+
+        private
+
+        # Automatically skip stripping of blob columns
+        def set_skipped_string_nilifying_columns
+          if @db_schema
+            blob_columns = @db_schema.map{|k,v| k if v[:type] == :blob}.compact
+            skip_string_nilifying(*blob_columns)
+          end
+        end
+      end
+
+      module InstanceMethods
+        # Strip value if it is a non-blob string and the model hasn't been set
+        # to skip stripping for the column, before attempting to assign
+        # it to the model's values.
+        def nil_string?(k,str)
+          str.is_a?(String) && !str.is_a?(SQL::Blob) && str.strip.empty? && !model.skip_string_nilifying?(k)
+        end
+
+        def []=(k, v)
+          v = nil if nil_string? k, v
+          super(k, v)
+        end
+      end
+    end
+  end
+end
+

data/lib/sequel/plugins/string_nilifier/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module StringNilifier
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/sequel/string_nilifier.rb

@@ -0,0 +1,2 @@
+require "sequel/plugins/string_nilifier/version"
+require "sequel/plugins/string_nilifier"

data/sequel-string_nilifier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/plugins/string_nilifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-string_nilifier"
+  spec.version       = Sequel::Plugins::StringNilifier::VERSION
+  spec.authors       = ["Jonathan Tron", "Joseph Halter"]
+  spec.email         = ["jonathan.tron@metrilio.com", "joseph.halter@metrilio.com"]
+  spec.description   = %q{Sequel plugin to store empty string as nil}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "sequel"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/sequel/plugins/string_nilifier_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe Sequel::Plugins::StringNilifier do
+  before do
+    @db = Sequel::Database.new
+    @c = Class.new(Sequel::Model(@db[:test]))
+    @c.columns :name, :b
+    @c.db_schema[:b][:type] = :blob
+    @c.plugin :string_nilifier
+    @o = @c.new
+  end
+
+  it "should convert empty string to nil for all input strings" do
+    @o.name = " \n"
+    @o.name.should be_nil
+  end
+
+  it "should not convert non-empty string" do
+    @o.name = "a \n"
+    @o.name.should == "a \n"
+  end
+
+  it "should not affect other types" do
+    @o.name = 1
+    @o.name.should == 1
+    @o.name = Date.today
+    @o.name.should == Date.today
+  end
+
+  it "should not nilify strings for blob arguments" do
+    v = Sequel.blob(" \n")
+    @o.name = v
+    @o.name.should equal(v)
+  end
+
+  it "should not nilify strings for blob columns" do
+    @o.b = " \n"
+    @o.b.should be_a_kind_of(Sequel::SQL::Blob)
+    @o.b.should == Sequel.blob(" \n")
+  end
+
+  it "should allow skipping of columns using Model.skip_string_nilifying" do
+    @c.skip_string_nilifying :name
+    v = " \n"
+    @o.name = v
+    @o.name.should equal(v)
+  end
+
+  it "should work correctly in subclasses" do
+    o = Class.new(@c).new
+    o.name = " \n"
+    o.name.should be_nil
+    o.b = " \n"
+    o.b.should be_a_kind_of(Sequel::SQL::Blob)
+    o.b.should == Sequel.blob(" \n")
+  end
+
+  it "should work correctly for dataset changes" do
+    c = Class.new(Sequel::Model(@db[:test]))
+    c.plugin :string_nilifier
+    def @db.schema(*) [[:name, {}], [:b, {:type=>:blob}]] end
+    c.set_dataset(@db[:test2])
+    o = c.new
+    o.name = " \n"
+    o.name.should be_nil
+    o.b = " \n"
+    o.b.should be_a_kind_of(Sequel::SQL::Blob)
+    o.b.should == Sequel.blob(" \n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require "sequel"
+require "sequel/string_nilifier"
+
+class << Sequel::Model
+  attr_writer :db_schema
+  alias orig_columns columns
+  def columns(*cols)
+    return super if cols.empty?
+    define_method(:columns){cols}
+    @dataset.instance_variable_set(:@columns, cols) if @dataset
+    def_column_accessor(*cols)
+    @columns = cols
+    @db_schema = {}
+    cols.each{|c| @db_schema[c] = {}}
+  end
+end
+
+Sequel::Model.use_transactions = false
+Sequel::Model.cache_anonymous_models = false
+
+db = Sequel.mock(:fetch=>{:id => 1, :x => 1}, :numrows=>1, :autoid=>proc{|sql| 10})
+def db.schema(*) [[:id, {:primary_key=>true}]] end
+def db.reset() sqls end
+Sequel::Model.db = MODEL_DB = db

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sequel-string_nilifier
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Tron
+- Joseph Halter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Sequel plugin to store empty string as nil
+email:
+- jonathan.tron@metrilio.com
+- joseph.halter@metrilio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel/plugins/string_nilifier.rb
+- lib/sequel/plugins/string_nilifier/version.rb
+- lib/sequel/string_nilifier.rb
+- sequel-string_nilifier.gemspec
+- spec/sequel/plugins/string_nilifier_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 289012220966116596
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 289012220966116596
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Sequel plugin to store empty string as nil
+test_files:
+- spec/sequel/plugins/string_nilifier_spec.rb
+- spec/spec_helper.rb