schema_plus_db_default 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 525d6394f0435e926ad137289e0db842f1123065
+  data.tar.gz: 827c001859e4830a2b5e4ced64c7b46a09158d43
+SHA512:
+  metadata.gz: 8d9291e76286079dfae4f3c54670074ad12bb4573aa78b91bc8ca4d6e064f56ce94bb89be3fc4906e7081fd370d21a4f0b763cd5c15420780ccfd9457ccc2746
+  data.tar.gz: 3190632951e3737f7ff38881c7819d177177197550468d72a9e3b6bf6faf8fd54236ce3302e35dbc87da40ae871b885599a408b3619fa2c1bd7e00488f2b297f

data/.gitignore

@@ -0,0 +1,9 @@
+/coverage
+/tmp
+/pkg
+/Gemfile.local
+
+*.lock
+*.log
+*.sqlite3
+!gemfiles/**/*.sqlite3

data/.travis.yml

@@ -0,0 +1,17 @@
+# This file was auto-generated by the schema_dev tool, based on the data in
+#                 ./schema_dev.yml
+# Please do not edit this file; any changes will be overwritten next time
+# schema_dev gets run.
+---
+sudo: false
+rvm:
+- 2.1.5
+gemfile:
+- gemfiles/activerecord-4.2/Gemfile.mysql2
+- gemfiles/activerecord-4.2/Gemfile.postgresql
+env: POSTGRESQL_DB_USER=postgres MYSQL_DB_USER=travis
+addons:
+  postgresql: '9.3'
+before_script: bundle exec rake create_databases
+after_script: bundle exec rake drop_databases
+script: bundle exec rake travis

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ronen barzel 
+
+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,100 @@
+[![Gem Version](https://badge.fury.io/rb/schema_plus_db_default.svg)](http://badge.fury.io/rb/schema_plus_db_default)
+[![Build Status](https://secure.travis-ci.org/SchemaPlus/schema_plus_db_default.svg)](http://travis-ci.org/SchemaPlus/schema_plus_db_default)
+[![Coverage Status](https://img.shields.io/coveralls/SchemaPlus/schema_plus_db_default.svg)](https://coveralls.io/r/SchemaPlus/schema_plus_db_default)
+[![Dependency Status](https://gemnasium.com/lomba/schema_plus_db_default.svg)](https://gemnasium.com/SchemaPlus/schema_plus_db_default)
+
+# SchemaPlus::DbDefault
+
+ShemaPlus::DbDefault provides a constant `ActiveRecord::DB_DEFAULT` that you can use to set an attribute's database column to the default value or expression specified in the database schema. 
+
+(Without `ActiveRecord::DB_DEFAULT` you can update a column to `NULL` but not to its default value.)
+
+SchemaPlus::DbDefault is part of the [SchemaPlus](https://github.com/SchemaPlus/) family of Ruby on Rails ActiveRecord extension gems.
+
+## Usage
+
+Use `ActiveRecord::DB_DEFAULT` as a "magic value" for attributes; when saved it will cause SQL to use the DB default value.
+
+```ruby
+record.update_attributes(category: ActiveRecord::DB_DEFAULT) # SQL: UPDATE tablename SET category = DEFAULT
+record.reload
+```
+
+After the save, you'll need to reload the record to replace `ActiveRecord::DB_DEFAULT` with the value assigned by the database.
+
+## Installation
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+As usual:
+
+```ruby
+gem "schema_plus_db_default"                # in a Gemfile
+gem.add_dependency "schema_plus_db_default" # in a .gemspec
+```
+
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION - end -->
+
+## Compatibility
+
+SchemaPlus::DbDefault is tested on:
+
+<!-- SCHEMA_DEV: MATRIX - begin -->
+<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->
+* ruby **2.1.5** with activerecord **4.2**, using **mysql2** and **postgresql**
+
+<!-- SCHEMA_DEV: MATRIX - end -->
+
+Sqlite3 does not support setting a column to its default value.  Attempting to use `ActiveRecord::DB_DEFAULT`will raise `ActiveRecord::StatementInvalid`
+
+## History
+
+* 0.1.0 - Initial release extracted from schema_plus 1.x
+
+## Development & Testing
+
+Are you interested in contributing to SchemaPlus::DbDefault?  Thanks!  Please follow
+the standard protocol: fork, feature branch, develop, push, and issue pull
+request.
+
+Some things to know about to help you develop and test:
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_DEV - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_dev**:  SchemaPlus::DbDefault uses [schema_dev](https://github.com/SchemaPlus/schema_dev) to
+  facilitate running rspec tests on the matrix of ruby, activerecord, and database
+  versions that the gem supports, both locally and on
+  [travis-ci](http://travis-ci.org/SchemaPlus/schema_plus_db_default)
+
+  To to run rspec locally on the full matrix, do:
+
+        $ schema_dev bundle install
+        $ schema_dev rspec
+
+  You can also run on just one configuration at a time;  For info, see `schema_dev --help` or the [schema_dev](https://github.com/SchemaPlus/schema_dev) README.
+
+  The matrix of configurations is specified in `schema_dev.yml` in
+  the project root.
+
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_DEV - end -->
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_PLUS_CORE - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_plus_core**: SchemaPlus::DbDefault uses the SchemaPlus::Core API that
+  provides middleware callback stacks to make it easy to extend
+  ActiveRecord's behavior.  If that API is missing something you need for
+  your contribution, please head over to
+  [schema_plus_core](https://github.com/SchemaPlus/schema_plus_core) and open
+  an issue or pull request.
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_PLUS_CORE - end -->
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - begin -->
+<!-- These lines are auto-inserted from a schema_dev template -->
+* **schema_monkey**: SchemaPlus::DbDefault is implemented as a
+  [schema_monkey](https://github.com/SchemaPlus/schema_monkey) client,
+  using [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s
+  convention-based protocols for extending ActiveRecord and using middleware stacks.
+
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_MONKEY - end -->

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'schema_dev/tasks'
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/gemfiles/Gemfile.base

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec :path => File.expand_path('..', __FILE__)
+
+File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

data/gemfiles/activerecord-4.2/Gemfile.base

@@ -0,0 +1,3 @@
+eval File.read File.expand_path('../../Gemfile.base', __FILE__)
+
+gem "activerecord", "~> 4.2.0"

data/gemfiles/activerecord-4.2/Gemfile.mysql2

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "mysql2"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+end

data/gemfiles/activerecord-4.2/Gemfile.postgresql

@@ -0,0 +1,10 @@
+require "pathname"
+eval(Pathname.new(__FILE__).dirname.join("Gemfile.base").read, binding)
+
+platform :ruby do
+  gem "pg"
+end
+
+platform :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter'
+end

data/lib/schema_plus/db_default/active_record/attribute.rb

@@ -0,0 +1,16 @@
+module SchemaPlus::DbDefault
+  module ActiveRecord
+    module Attribute
+
+      def original_value
+        # prevent attempts to cast DB_DEFAULT to the attributes type.
+        # We want to keep it as DB_DEFAULT so that we can handle it when
+        # generating the sql.
+        return DB_DEFAULT if value_before_type_cast.equal? DB_DEFAULT
+        super
+      end
+
+    end
+  end
+end
+

data/lib/schema_plus/db_default/db_default.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+
+module SchemaPlus::DbDefault
+  class DbDefault
+    include Singleton
+    def to_s
+      'DEFAULT'
+    end
+    def quoted_id
+      self
+    end
+  end
+  DB_DEFAULT = DbDefault.instance
+end
+
+::ActiveRecord.const_set :DB_DEFAULT, SchemaPlus::DbDefault::DB_DEFAULT

data/lib/schema_plus/db_default/middleware.rb

@@ -0,0 +1,30 @@
+module SchemaPlus::DbDefault
+  module Middleware
+
+    module Query
+      module Exec
+
+        module Postgresql
+
+          # Middleware to replace each ActiveRecord::DB_DEFAULT with a literal
+          # DEFAULT in the sql string, for postgresql.  The underlying pg gem provides no
+          # way to bind a value that will replace $n with DEFAULT.
+          def before(env)
+            if env.binds.any?{ |col, val| val.equal? ::ActiveRecord::DB_DEFAULT}
+              j = 0
+              env.binds.each_with_index do |(col, val), i|
+                if val.equal? ::ActiveRecord::DB_DEFAULT
+                  env.sql = env.sql.sub(/\$#{i+1}/, 'DEFAULT')
+                else
+                  env.sql = env.sql.sub(/\$#{i+1}\b/, "$#{j+1}") if i != j
+                  j += 1
+                end
+              end
+              env.binds = env.binds.reject{|col, val| val.equal? ::ActiveRecord::DB_DEFAULT}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/schema_plus/db_default/version.rb

@@ -0,0 +1,5 @@
+module SchemaPlus
+  module DbDefault
+    VERSION = "0.1.0"
+  end
+end

data/lib/schema_plus/db_default.rb

@@ -0,0 +1,8 @@
+require 'schema_plus/core'
+
+require_relative 'db_default/version'
+require_relative 'db_default/active_record/attribute'
+require_relative 'db_default/db_default'
+require_relative 'db_default/middleware'
+
+SchemaMonkey.register SchemaPlus::DbDefault

data/lib/schema_plus_db_default.rb

@@ -0,0 +1 @@
+require_relative 'schema_plus/db_default'

data/schema_dev.yml

@@ -0,0 +1,7 @@
+ruby:
+    - 2.1.5
+activerecord:
+    - 4.2
+db:
+    - mysql2
+    - postgresql

data/schema_plus_db_default.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schema_plus/db_default/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "schema_plus_db_default"
+  gem.version       = SchemaPlus::DbDefault::VERSION
+  gem.authors       = ["ronen barzel"]
+  gem.email         = ["ronen@barzel.org"]
+  gem.summary       = %q{Lets you set an ActiveRecord attribute to the db column's default value}
+  gem.description   = %q{Defines constant ActiveRecord::DB_DEFAULT which, when saved as an attribute's value, causes the db to set the column to its default value.}
+  gem.homepage      = "https://github.com/SchemaPlus/schema_plus_db_default"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activerecord", "~> 4.2"
+  gem.add_dependency "schema_plus_core", "~> 0.2", ">= 0.2.1"
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "schema_dev", "~> 3.4"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-gem-profile"
+end

data/spec/column_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe SchemaPlus::DbDefault do
+
+  let(:default_value) { "This is the default value" }
+
+  let(:migration) { ::ActiveRecord::Migration }
+
+  before(:each) do
+    class User < ::ActiveRecord::Base ; end
+    create_table(User, :alpha => { :default => default_value }, :beta => {})
+  end
+
+  context "uses db default value" do
+
+    it "when creating a record with DB_DEFAULT" do
+      User.create!(:alpha => ActiveRecord::DB_DEFAULT, :beta => "hello")
+      expect(User.last.alpha).to eq(default_value)
+      expect(User.last.beta).to eq("hello")
+    end
+
+    it "when updating a record with DB_DEFAULT" do
+      u = User.create!(:alpha => "hey", :beta => "hello")
+      u.reload
+      expect(u.alpha).to eq("hey")
+      expect(u.beta).to eq("hello")
+      u.update_attributes(:alpha => ActiveRecord::DB_DEFAULT, :beta => "goodbye")
+      u.reload
+      expect(u.alpha).to eq(default_value)
+      expect(u.beta).to eq("goodbye")
+    end
+
+  end
+
+  protected
+
+  def create_table(model, columns_with_options)
+    migration.suppress_messages do
+      migration.create_table model.table_name, :force => :cascade do |t|
+        columns_with_options.each_pair do |column, options|
+          t.send :string, column, options
+        end
+      end
+      model.reset_column_information
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+require 'simplecov-gem-profile'
+SimpleCov.start "gem"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'active_record'
+require 'schema_plus_db_default'
+require 'schema_dev/rspec'
+
+SchemaDev::Rspec.setup
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.warnings = true
+end
+
+SimpleCov.command_name "[ruby#{RUBY_VERSION}-activerecord#{::ActiveRecord.version}-#{ActiveRecord::Base.connection.adapter_name}]"

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: schema_plus_db_default
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: schema_plus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: schema_dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-gem-profile
+  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: Defines constant ActiveRecord::DB_DEFAULT which, when saved as an attribute's
+  value, causes the db to set the column to its default value.
+email:
+- ronen@barzel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.base
+- gemfiles/activerecord-4.2/Gemfile.base
+- gemfiles/activerecord-4.2/Gemfile.mysql2
+- gemfiles/activerecord-4.2/Gemfile.postgresql
+- lib/schema_plus/db_default.rb
+- lib/schema_plus/db_default/active_record/attribute.rb
+- lib/schema_plus/db_default/db_default.rb
+- lib/schema_plus/db_default/middleware.rb
+- lib/schema_plus/db_default/version.rb
+- lib/schema_plus_db_default.rb
+- schema_dev.yml
+- schema_plus_db_default.gemspec
+- spec/column_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SchemaPlus/schema_plus_db_default
+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: Lets you set an ActiveRecord attribute to the db column's default value
+test_files:
+- spec/column_spec.rb
+- spec/spec_helper.rb