acts_as_default 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21e3b7d9b89c9e22291465716fe3ec253d338183
+  data.tar.gz: 3d34ac2a23342c69cd2028911143beee457a142d
+SHA512:
+  metadata.gz: f8edf32e8a2a8a2a4c14e47186e08e23ad12b19d09546bb6dc358025596d6d1e722ce0d99dbec098996739b91a91f835c55d2522737aa07adae2fcb305e6a97e
+  data.tar.gz: aca6cc979cad90f12b09afe959b000b994d07c9c5b6dd93a3d93b4a068f27561fbcdb789b46d09b780f1981f11cad37277480e1788faa0a256ec7bd4bf912a4d

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/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rake test
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+gemfile:
+  - Gemfile

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mirko Mignini
+
+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,111 @@
+[![Build Status](https://travis-ci.org/MirkoMignini/acts_as_default.png?branch=master)](https://travis-ci.org/MirkoMignini/acts_as_default)
+
+# ActsAsDefault
+
+Using acts as default you can set a default row in your activerecord collection, also for has_many relationships
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_default'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_default
+
+## Usage
+
+Include ActsAsDefault in the models when you need a default row
+Call acts_as_default, specifying which field, is present to determine sub-collections
+
+```ruby
+class Parent < ActiveRecord::Base
+  include ActsAsDefault
+  acts_as_default
+  has_many :sons
+end
+
+class Son < ActiveRecord::Base
+  include ActsAsDefault
+  acts_as_default :parent_id
+  belongs_to :parent
+end
+```
+
+Then create a migration to create default column:
+
+```ruby
+add_column :parents, :default, :boolean
+add_column :sons, :default, :boolean
+```
+
+## Using default value in the simple way:
+
+```ruby
+p1 = Parent.new
+p1.save!
+p2 = Parent.new
+p2.save!
+p3 = Parent.new
+p3.save!
+puts p1.default #true, because was the first created
+puts p2.default #false, because a default is already present
+puts p3.default #false, because a default is already present
+
+p3.destroy! #if we destroy a non default object nothing happens
+
+p1.destroy! #but if we destroy the default object...
+p2.reload #don't forget to reload to see changes
+puts p2.default #true, now p2 is default, because was the only one present, in case of more the recent based on created_at will become the default
+```
+
+## Setting the default manually
+
+You can always call:
+```ruby
+p1 = Parent.new
+p2 = Parent.new
+
+puts p1.default #true, because was the first created
+puts p2.default #false, because a default is already present
+
+model.set_as_default!
+```
+To immediately switch the object as default and save.
+
+## Using default value in the complex way:
+
+You can use acts_as_default to manage default for collection in has_many relationships
+```ruby
+p1 = Parent.new
+p2 = Parent.new
+
+s1 = Son.new
+s1.parent = p1
+s1.save!
+
+s2 = Son.new
+s2.parent = p1
+s2.save!
+
+s3 = Son.new
+s3.parent = p2
+s3.save!
+
+puts s1.default #true, because was the first created for p1
+puts s2.default #false, because a default is already present in p1
+puts s3.default #true, because was the first created for p2
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/MirkoMignini/acts_as_default/fork )
+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,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/acts_as_default.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_default/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_default"
+  spec.version       = ActsAsDefault::VERSION
+  spec.authors       = ["Mirko Mignini"]
+  spec.email         = ["mirko.mignini@libero.it"]
+  spec.summary       = %q{Using acts as default you can set a default row in your activerecord collection, also for has_many relationships}
+  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_development_dependency "rake"
+  spec.add_development_dependency "activerecord", "~> 4.0.0"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/acts_as_default/version.rb

@@ -0,0 +1,3 @@
+module ActsAsDefault
+  VERSION = "0.0.1"
+end

data/lib/acts_as_default.rb

@@ -0,0 +1,75 @@
+require_relative 'acts_as_default/version'
+require 'active_support/concern'
+
+module ActsAsDefault
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    attr :field_key
+
+    def acts_as_default(field = nil)
+      @field_key = field
+      include ActsAsDefault::InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :check_before_save
+      after_destroy :check_after_destroy
+    end
+
+    def set_as_default!
+      if default == false
+        get_default_object.toggle!(:default)
+        toggle!(:default)
+      end
+    end
+
+    private
+
+    def check_before_save
+      if self.default
+        obj = get_default_object
+        obj.toggle!(:default) if obj and obj.id != id
+      else
+        self.default = check_if_empty?
+      end
+      return true
+    end
+
+    def check_after_destroy
+      obj = get_default_object
+      if obj.nil?
+        obj = get_collection.order(created_at: :desc).first
+        obj.toggle!(:default) if obj
+      end
+    end
+
+    def check_if_empty?
+      get_collection.size == 0
+    end
+
+    def get_collection
+      if self.class.field_key.nil?
+        self.class.all
+      else
+        self.class.where(self.class.field_key => self[self.class.field_key])
+      end
+    end
+
+    def get_default_object
+      if self.class.field_key.nil?
+        self.class.where("[default] = ?", true).first
+      else
+        self.class.where("[#{self.class.field_key}] = ? AND [default] = ?", self[self.class.field_key], true).first
+      end
+    end
+  end
+end

data/test/test_all.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'active_record'
+require 'minitest/autorun'
+require_relative '../lib/acts_as_default'
+require_relative 'test_objects'
+
+class TestAll < Minitest::Unit::TestCase
+
+  def setup
+    setup_objects
+  end
+
+  def teardown
+  end
+
+  def test_simple
+    Parent.delete_all
+
+    3.times do
+      p = Parent.new
+      p.save!
+    end
+
+    assert_equal true, Parent.first.default
+    assert_equal true, contains_one_default?(Parent.all)
+  end
+
+  def test_standard
+    Son.delete_all
+    Parent.delete_all
+
+    2.times do
+      p = Parent.new
+      p.save!
+      3.times do
+        s = Son.new
+        s.parent = p
+        s.save!
+      end
+    end
+
+    #check default
+    assert_equal true, contains_one_default?(Parent.first.sons)
+    assert_equal true, contains_one_default?(Parent.last.sons)
+
+    #check default change to last
+    Parent.first.sons.last.set_as_default!
+    assert_equal true, Parent.first.sons.last.default
+    assert_equal true, contains_one_default?(Parent.first.sons)
+    assert_equal true, contains_one_default?(Parent.last.sons)
+
+    #check default change back to first
+    Parent.first.sons.first.set_as_default!
+    assert_equal true, Parent.first.sons.first.default
+    assert_equal true, contains_one_default?(Parent.first.sons)
+    assert_equal true, contains_one_default?(Parent.last.sons)
+
+    #check destroy of non default
+    Parent.first.sons.last.destroy!
+    assert_equal true, Parent.first.sons.first.default
+    assert_equal true, contains_one_default?(Parent.first.sons)
+    assert_equal true, contains_one_default?(Parent.last.sons)
+
+    #check destroy of default
+    Parent.first.sons.first.destroy!
+    assert_equal true, Parent.first.sons.first.default
+    assert_equal true, contains_one_default?(Parent.first.sons)
+    assert_equal true, contains_one_default?(Parent.last.sons)
+  end
+
+  def contains_one_default?(collection)
+    collection.where(default: true).size == 1
+  end
+end

data/test/test_objects.rb

@@ -0,0 +1,35 @@
+class Parent < ActiveRecord::Base
+  include ActsAsDefault
+  acts_as_default
+
+  has_many :sons
+end
+
+class Son < ActiveRecord::Base
+  include ActsAsDefault
+  acts_as_default :parent_id
+
+  belongs_to :parent
+end
+
+def setup_objects
+  ActiveRecord::Base.establish_connection(
+      :adapter => 'sqlite3',
+      :database => ':memory:'
+  )
+
+  ActiveRecord::Schema.define do
+    self.verbose = false
+
+    create_table :parents, :force => true do |t|
+      t.timestamps
+      t.boolean :default
+    end
+
+    create_table :sons, :force => true do |t|
+      t.belongs_to :parent
+      t.boolean :default
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_default
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mirko Mignini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: ''
+email:
+- mirko.mignini@libero.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_default.gemspec
+- lib/acts_as_default.rb
+- lib/acts_as_default/version.rb
+- test/test_all.rb
+- test/test_objects.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Using acts as default you can set a default row in your activerecord collection,
+  also for has_many relationships
+test_files:
+- test/test_all.rb
+- test/test_objects.rb