soulless 0.4.3 → 0.5.0.rc1

data/.travis.yml

@@ -2,14 +2,17 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - ruby-head
   - jruby-19mode
   - jruby-head
-  - rbx-19mode
+  - rbx
 env:
   - "RAILS_VERSION=3.2.0"
   - "RAILS_VERSION=4.0.0"
   - "RAILS_VERSION=master"
 matrix:
   allow_failures:
-    - env: "RAILS_VERSION=master"
+    - env: "RAILS_VERSION=master"
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -22,6 +22,13 @@ platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"
 end
 
+platforms :rbx do
+  gem 'psych'
+  gem 'racc'
+  gem 'rubysl'
+  gem 'rubinius-coverage'
+end
+
 group :development do
   gem 'coveralls', require: false
 end

data/README.md

@@ -253,6 +253,82 @@ person.spouse.name_change # => ["Mary Jane Watson", "Gwen Stacy"]
 person.changed? # => false
 ```
 
+### Inheritance
+
+One of the biggest pitfalls of the form object pattern is duplication of code. It's not uncommon for a form object to define attributes and validations that are identical to the model it represets.
+
+To get rid of this annoying issue Soulless implements the ```#inherit_from(klass, options = {})``` method. This method will allow a Soulless model to inherit attributes and validations from any Rails model, Soulless model or Virtus object.
+
+```ruby
+class User < ActiveRecord::Base
+  validates :name, presence: true
+  
+  validates :email, presence: true,
+                    uniqueness: { case_insensitive: true }
+end
+```
+
+```ruby
+class UserSignupForm
+  include Soulless.model
+  
+  inherit_from(User)
+end
+```
+
+The ```UserSignupForm``` has automatically been defined with the ```name``` and ```email``` attributes and validations.
+
+```ruby
+UserSignupForm.attributes # => name and email attributes
+form = UserSignupForm.new
+form.valid? # => false
+form.errors.messages # => { name: ["can't be blank"], email: ["can't be blank"] }
+```
+
+If your model is using the uniqueness validator it will automatically convert it to the [uniqueness validator provided by Soulless](https://github.com/anthonator/soulless#uniqueness-validations).
+
+The ```#inherit_from(klass, options = {})``` method also allows you to provide options for managing inherited attributes.
+
+If you don't want to inherit the ```email``` attribute define it using the ```exclude``` option.
+
+```ruby
+class UserSignupForm
+  include Soulless.model
+  
+  inherit_from(User, exclude: :email)
+end
+
+UserSignupForm.attributes # => email will not be inherited
+form = UserSignupForm.new
+form.valid? # => false
+form.errors.messages # => { name: ["can't be blank"] }
+```
+
+You can also flip it around if you only want the ```name``` attribute by using the ```only``` option.
+
+```ruby
+class UserSignupForm
+  include Soulless.model
+  
+  inherit_from(User, only: :name)
+end
+
+UserSignupForm.attributes # => email will not be inherited
+form = UserSignupForm.new
+form.valid? # => false
+form.errors.messages # => { name: ["can't be blank"] }
+```
+
+#### Available Options
+
+```only``` - Only inherit the attributes and validations for the provided attributes. Any attributes not specified will be ignored. Accepts strings, symbols and an array of strings or symbols.
+
+```exclude``` - Don't inherit the attributes and validations for the provided attributes. Accepts strings, symbols and an array of strings or symbols.
+
+```skip_validators``` - Only inherit attributes. Don't inherit any validators. Accepts a boolean.
+
+```use_database_default``` - Use the value of the ```default``` migration option as the default value for an attribute. Accepts either a boolean (for all attributes), a string or symbol for a single attribute or an array of strings and symbols for multiple attributes.
+
 ### I18n
 
 Define locales similar to how you would define them in Rails.

data/lib/soulless/inheritance.rb

@@ -0,0 +1,111 @@
+module Soulless
+  module Inheritance
+    def self.included(base)
+     base.instance_eval do
+       def inherit_from(klass, options = {})
+         attributes = get_attributes(klass, options)
+         
+         attributes.each do |attribute|
+           self.attribute(attribute[:name], attribute[:primitive], attribute[:options])
+           if Object.const_defined?('ActiveModel'.to_sym) && klass.ancestors.include?(ActiveModel::Validations)
+             setup_validators(attribute[:name], klass, options)
+           end
+         end
+       end
+       
+       private
+       def get_attributes(klass, options)
+         if klass.ancestors.include?(Virtus::Model::Core)
+           get_virtus_attributes(klass, options)
+         elsif Object.const_defined?('ActiveRecord'.to_sym) && klass.ancestors.include?(ActiveRecord::Base)
+           get_active_record_attributes(klass, options)
+         end
+       end
+       
+       def get_virtus_attributes(klass, options)
+         attributes = []
+         attribute_set = klass.attribute_set
+         attribute_set.each do |attribute|
+           attribute_name = attribute.options[:name].to_s
+           if include_attribute?(attribute_name, options)
+             attributes << {
+               name: attribute_name,
+               primitive: attribute.primitive,
+               options: {
+                 default: attribute.default_value
+               }
+             }
+           end
+         end
+         attributes
+       end
+       
+       def get_active_record_attributes(klass, options)
+         attributes = []
+         columns = klass.columns
+         columns.each do |column|
+           if include_attribute?(column.name, options)
+             attribute = {
+               name: column.name,
+               primitive: translate_primitive(column.type),
+               options: {}
+             }
+             attribute[:options] = { default: column.default } if options[:use_database_default] == true ||
+                                                                  options[:use_database_default] == column.name ||
+                                                                  (options[:use_database_default].kind_of?(Array) &&
+                                                                   options[:use_database_default].collect { |v| v.to_s }.include?(column.name))
+             attributes << attribute
+           end
+         end
+         attributes
+       end
+       
+       def setup_validators(attribute_name, klass, options)
+         return if options[:skip_validators] || !include_attribute?(attribute_name, options)
+         klass.validators.each do |validator|
+           if validator.attributes.include?(attribute_name.to_sym)
+             validator_class = validator.class
+             validator_options = {}
+             validator_options.merge!(validator.options)
+             if validator_class == ActiveRecord::Validations::UniquenessValidator
+               validator_class = Validations::UniquenessValidator
+               validator_options.merge!(model: klass)
+             else
+               # Validators from models are ActiveRecord
+               # objects which aren't useable in an
+               # environment without a database. It's
+               # necessary to convert to an ActiveModel
+               # validation.
+               validator_class = "ActiveModel::Validations::#{validator_class.name.split('::').last}".constantize
+             end
+             validates_with(validator_class, { attributes: attribute_name }.merge(validator_options))
+           end
+         end
+       end
+       
+       def translate_primitive(primitive)
+         translated_primitive = primitive.to_s.capitalize
+         translated_primitive = Virtus::Attribute::Boolean.name if translated_primitive == 'Boolean'
+         translated_primitive = DateTime.name if translated_primitive == 'Datetime'
+         translated_primitive.constantize
+       end
+       
+       def include_attribute?(attribute_name, options)
+         # Attributes we don't want to inherit
+         exclude_attributes = ['id']
+         exclude_attributes << ['created_at', 'updated_at'] unless options[:include_timestamps]
+         exclude_attributes << options[:exclude] if options[:exclude]
+         exclude_attributes.flatten!
+         exclude_attributes.collect!{ |v| v.to_s }
+         # Attributes we only want to inherit
+         only_attributes = []
+         only_attributes << options[:only] if options[:only]
+         only_attributes.flatten!
+         only_attributes.collect!{ |v| v.to_s }
+         
+         !exclude_attributes.include?(attribute_name) && (only_attributes.empty? || only_attributes.include?(attribute_name))
+       end
+     end
+    end
+  end
+end

data/lib/soulless/version.rb

@@ -1,3 +1,3 @@
 module Soulless
-  VERSION = "0.4.3"
+  VERSION = "0.5.0.rc1"
 end

data/lib/soulless.rb

@@ -6,6 +6,7 @@ require 'active_model'
 require 'soulless/accessors'
 require 'soulless/associations'
 require 'soulless/dirty'
+require 'soulless/inheritance'
 require 'soulless/model'
 require 'soulless/validations'
 require 'soulless/version'
@@ -22,6 +23,7 @@ module Soulless
       object.send(:include, Validations)
       object.send(:include, Dirty)
       object.send(:include, Accessors)
+      object.send(:include, Inheritance)
     end
     mod
   end

data/spec/dummy/app/models/dummy_model.rb

@@ -1,3 +1,6 @@
 class DummyModel < ActiveRecord::Base
-  validates :name, uniqueness: true
-end
+  validates :name, presence: true,
+                   uniqueness: true
+
+  validates :email, length: { minimum: 3, allow_blank: true }
+end

data/spec/dummy/db/migrate/20131106221200_create_dummy_models.rb

@@ -1,7 +1,9 @@
 class CreateDummyModels < ActiveRecord::Migration
   def change
     create_table :dummy_models do |t|
-      t.string :name
+      t.string  :name, default: 'Anthony'
+      t.string  :email
+      t.boolean :saved, default: false
 
       t.timestamps
     end

data/spec/dummy/db/schema.rb

@@ -14,7 +14,9 @@
 ActiveRecord::Schema.define(version: 20131106221200) do
 
   create_table "dummy_models", force: true do |t|
-    t.string   "name"
+    t.string   "name",       default: "Anthony"
+    t.string   "email"
+    t.boolean  "saved",      default: false
     t.datetime "created_at"
     t.datetime "updated_at"
   end

data/spec/inheritance_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Soulless::Inheritance do
+  describe DummyModelInheritance do
+    before(:each) do
+      @dummy_inheritance = DummyModelInheritance.new
+    end
+  
+    it 'should inherit the name attribute' do
+      @dummy_inheritance.attributes.keys.should include(:name)
+    end
+  
+    it 'should inherit the default value for the name attribute' do
+      @dummy_inheritance.attributes[:name].should == 'Anthony'
+    end
+    
+    it 'should not inhert the email attribute when added as exclude option' do
+      @dummy_inheritance.attributes.keys.should_not include(:email)
+    end
+    
+    it 'should validate presence of name' do
+      @dummy_inheritance.name = nil
+      @dummy_inheritance.valid?
+      @dummy_inheritance.errors[:name].should include("can't be blank")
+    end
+    
+    it 'should not validate email' do
+      @dummy_inheritance.class.validators.each do |validator|
+        validator.attributes.should_not include(:email)
+      end
+    end
+  end
+  
+  describe DummySoullessInheritance do
+    before(:each) do
+      @dummy_inheritance = DummySoullessInheritance.new
+    end
+  
+    it 'should inherit the name attribute' do
+      @dummy_inheritance.attributes.keys.should include(:name)
+    end
+  
+    it 'should inherit the default value for the name attribute' do
+      @dummy_inheritance.attributes[:name].should == 'Anthony'
+    end
+    
+    it 'should not inhert the email attribute when added as exclude option' do
+      @dummy_inheritance.attributes.keys.should_not include(:email)
+    end
+  end
+end

data/spec/support/dummy_model_inheritance.rb

@@ -0,0 +1,10 @@
+class DummyModelInheritance
+  include Soulless.model
+  
+  inherit_from(DummyModel, { use_database_default: [:name], exclude: :email, include_timestamps: true })
+  
+  private
+  def persist!
+    self.saved = true
+  end
+end

data/spec/support/dummy_soulless_inheritance.rb

@@ -0,0 +1,10 @@
+class DummySoullessInheritance
+  include Soulless.model
+  
+  inherit_from(::DummyClass, { exclude: :email })
+  
+  private
+  def persist!
+    self.saved = true
+  end
+end

metadata

@@ -1,111 +1,126 @@
 --- !ruby/object:Gem::Specification
 name: soulless
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Anthony Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Rails models without a database (and Rails).
@@ -125,6 +140,7 @@ files:
 - lib/soulless/accessors.rb
 - lib/soulless/associations.rb
 - lib/soulless/dirty.rb
+- lib/soulless/inheritance.rb
 - lib/soulless/locale/en.yml
 - lib/soulless/model.rb
 - lib/soulless/validations.rb
@@ -184,35 +200,39 @@ files:
 - spec/dummy/public/robots.txt
 - spec/dummy/vendor/assets/javascripts/.keep
 - spec/dummy/vendor/assets/stylesheets/.keep
+- spec/inheritance_spec.rb
 - spec/soulless_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_association.rb
 - spec/support/dummy_class.rb
+- spec/support/dummy_model_inheritance.rb
+- spec/support/dummy_soulless_inheritance.rb
 - spec/support/en.yml
 - spec/uniqueness_validator_spec.rb
 homepage: ''
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Create Rails style models without the database.
 test_files:
 - spec/associated_validator_spec.rb
@@ -267,9 +287,12 @@ test_files:
 - spec/dummy/public/robots.txt
 - spec/dummy/vendor/assets/javascripts/.keep
 - spec/dummy/vendor/assets/stylesheets/.keep
+- spec/inheritance_spec.rb
 - spec/soulless_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_association.rb
 - spec/support/dummy_class.rb
+- spec/support/dummy_model_inheritance.rb
+- spec/support/dummy_soulless_inheritance.rb
 - spec/support/en.yml
 - spec/uniqueness_validator_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: bb87770d995077463f68f4e6b80da470b5897368
-  data.tar.gz: 8c5b6ff12f1f3cd329fc1ecaa12af79f567a53e3
-SHA512:
-  metadata.gz: 432822f228e7c4c5111e21c4c3fd6d89de3cd134f598c055054d0198d0856553a85bec2febd324a19715756dad5b7710facdd7694ddb4bd6be2cc71efbd7a821
-  data.tar.gz: 747fd977b5017cf8761fe866b6178d558fa297bb56ef36056d6c04b89c6fea81af3fa5e54d7ddca80274a147fe2b207804c122f6df88fd0e56cc6682884be5d2