has_defaults 0.4.0 → 1.0.0

data/Gemfile.5.2.pg

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'activerecord'
+gem 'activesupport'
+gem 'pg', '~>0.18.4'
+
+# Development dependencies
+gem 'rake'
+gem 'database_cleaner'
+gem 'rspec', '~>3.5'
+gem 'gemika', '>= 0.2.0'
+gem 'pry-byebug'
+
+# Gem under test
+gem 'has_defaults', path: '.'

data/Gemfile.5.2.pg.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    has_defaults (1.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.6)
+      activesupport (= 5.2.6)
+    activerecord (5.2.6)
+      activemodel (= 5.2.6)
+      activesupport (= 5.2.6)
+      arel (>= 9.0)
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.2.5)
+    gemika (0.6.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pg (0.18.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activesupport
+  database_cleaner
+  gemika (>= 0.2.0)
+  has_defaults!
+  pg (~> 0.18.4)
+  pry-byebug
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   2.2.26

data/Gemfile.6.1.pg

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'activerecord', '~>6.1.3'
+gem 'pg', '~>1.1'
+
+# Development dependencies
+gem 'rake'
+gem 'database_cleaner'
+gem 'rspec', '~>3.5'
+gem 'gemika', '>= 0.2.0'
+gem 'pry-byebug'
+
+# Gem under test
+gem 'has_defaults', path: '.'

data/Gemfile.6.1.pg.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    has_defaults (1.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    gemika (0.5.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.1.3)
+  database_cleaner
+  gemika (>= 0.2.0)
+  has_defaults!
+  pg (~> 1.1)
+  pry-byebug
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   2.2.26

data/Gemfile.lock

@@ -0,0 +1 @@
+Gemfile.4.2.mysql2.lock

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Nando Vieira
+Copyright (c) 2008-2016 Nando Vieira, with subsequent changes by makandra GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,70 @@
+# has_defaults [![Build Status](https://travis-ci.org/makandra/has_defaults.svg?branch=master)](https://travis-ci.org/makandra/has_defaults)
+
+Default values for ActiveRecord models.
+
+## Installation
+
+In your `Gemfile`
+
+```
+gem 'has_defaults'
+```
+
+Now run
+
+```
+bundle install
+```
+
+## Usage
+
+Add the method call `has_defaults` to your model.
+
+```
+class Page < ActiveRecord::Base
+  has_defaults :title => "New page", :body => "Put your text here"
+end
+```
+
+Attributes will be set only if it's a new record and the attribute is blank.
+
+Retrieve the default attribute with the `default_for` instance method:
+
+```
+@page.default_for(:title)
+```
+
+You can pass Proc as attribute:
+
+```
+has_defaults :expires_at => proc { Time.now }
+```
+
+You can override the default attributes as follow:
+
+```
+Page.has_defaults_options = {:title => "Here's your new page", :body => "Write your page text"}
+```
+
+## Development
+
+There are tests in `spec`. We only accept PRs with tests. To run tests:
+
+- Install Ruby 2.5.7
+- Create a local test database `has_defaults_test` in both MySQL and PostgreSQL
+- Copy `spec/support/database.sample.yml` to `spec/support/database.yml` and enter your local credentials for the test databases
+- Install development dependencies using `bundle install`
+- Run tests using `bundle exec rspec`
+
+We recommend to test large changes against multiple versions of Ruby and multiple dependency sets. We provide some rake tasks to help with this:
+
+- Install development dependencies using `rake matrix:install`
+- Run tests using `rake matrix:spec`
+
+Note that we have configured Github Actions to automatically run tests in all supported Ruby versions and dependency sets after each push. We will only merge pull requests with successful test runs.
+
+
+## Credits
+
+* Original version by Nando Vieira (<http://simplesideias.com.br>)
+* Patches in this fork by makandra (<http://makandra.com/>)

data/Rakefile

@@ -1,33 +1,9 @@
 require 'rake'
-require 'spec/rake/spectask'
 require 'bundler/gem_tasks'
-
-desc 'Default: Run all specs.'
-task :default => 'all:spec'
-
-namespace :all do
-
-  desc "Run specs on all spec apps"
-  task :spec do
-    for_each_directory_of('spec/**/Rakefile') do |directory|
-      env = "SPEC=../../#{ENV['SPEC']} " if ENV['SPEC']
-      system("cd #{directory} && #{env} bundle exec rake spec")
-    end
-  end
-
-  desc "Bundle all spec apps"
-  task :bundle do
-    for_each_directory_of('spec/**/Gemfile') do |directory|
-      system("cd #{directory} && bundle install")
-    end
-  end
-
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
 end
 
-def for_each_directory_of(path, &block)
-  Dir[path].sort.each do |rakefile|
-    directory = File.dirname(rakefile)
-    puts '', "\033[44m#{directory}\033[0m", ''
-    block.call(directory)
-  end
-end
+task :default => 'matrix:spec'

data/has_defaults.gemspec

@@ -1,19 +1,29 @@
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "has_defaults/version"
 
-Gem::Specification.new do |s|
-  s.name = 'has_defaults'
-  s.version = HasDefaults::VERSION
-  s.authors = ["Henning Koch"]
-  s.email = 'henning.koch@makandra.de'
-  s.homepage = 'https://github.com/makandra/has_defaults'
-  s.summary = 'Default values for ActiveRecord models.'
-  s.description = s.summary
+Gem::Specification.new do |spec|
+  spec.name = 'has_defaults'
+  spec.version = HasDefaults::VERSION
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.authors = ['Henning Koch']
+  spec.email = ['henning.koch@makandra.de']
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.summary = 'Default values for ActiveRecord models'
+  spec.description = 'Default values for ActiveRecord models'
+  spec.homepage = 'https://github.com/makandra/has_defaults'
+  spec.license = 'MIT'
 
-  s.add_dependency('activerecord')
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activerecord')
+
+  # Development dependencies are defined in the Gemfile (therefore no `spec.add_development_dependency` directives)
 end

data/lib/has_defaults/active_record_ext.rb

@@ -1,27 +1,36 @@
 module HasDefaults
+
+  class Error < StandardError; end
+
   module ActiveRecordExt
 
     module ClassMethods
 
       def has_defaults(attrs)
-        raise "Hash expected; #{attrs.class} given." unless attrs.is_a?(Hash)
+        raise Error, "Hash expected; #{attrs.class} given." unless attrs.is_a?(Hash)
 
         include InstanceMethods
 
+        # Check if our parent class had default options, whose accessor we inherited.
+        # In this case we clone the default options as to not modify the options of our parent.
         if respond_to?(:has_defaults_options)
           self.has_defaults_options = has_defaults_options.dup
         else
+          # Rails 3 and 2 have different copy-and-write accessor generators.
           if respond_to?(:class_attribute)
             class_attribute :has_defaults_options
           else
             class_inheritable_hash :has_defaults_options
           end
+          # We only register the callback if we haven't registered it before,
+          # since in this branch we didn't inherit #has_defaults_options
+          after_initialize :set_default_attributes
         end
 
         self.has_defaults_options ||= {}
         self.has_defaults_options.merge!(attrs)
 
-        if Rails.version < '3'
+        if ActiveRecord::VERSION::MAJOR < 3
           # ActiveRecord only calls after_initialize callbacks only if is
           # explicit defined in a class. We should however only define that
           # callback if a default has been set, as it really slow downs Rails.
@@ -30,7 +39,6 @@ module HasDefaults
           end
         end
 
-        after_initialize :set_default_attributes
       end
 
     end
@@ -38,23 +46,36 @@ module HasDefaults
     module InstanceMethods
 
       def default_for(name)
-        self.class.has_defaults_options[name.to_sym]
+        raw_value = self.class.has_defaults_options[name.to_sym]
+        evaluate_raw_default_value(raw_value)
       end
 
       private
 
       def set_default_attributes
         if new_record?
-          self.class.has_defaults_options.each do |name, value|
+          self.class.has_defaults_options.each do |name, raw_value|
             if send(name).nil?
-              value = instance_eval(&value) if value.respond_to?(:call)
+              value = evaluate_raw_default_value(raw_value)
               send("#{name}=", value)
             end
           end
         end
       end
 
+      def evaluate_raw_default_value(raw_value)
+        value = raw_value
+        if value.respond_to?(:call)
+          value = instance_exec(&value)
+        end
+        value
+      end
+
     end
 
   end
 end
+
+ActiveRecord::Base.extend(HasDefaults::ActiveRecordExt::ClassMethods)
+
+

data/lib/has_defaults/version.rb

@@ -1,5 +1,5 @@
 module HasDefaults
 
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 
 end