soulless 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d038cfbf26cbc9feeae03cbd119375fdf31454
-  data.tar.gz: 983e7052834515c4f6b11365e1009526bd1ad60d
+  metadata.gz: afcfdbb737a946c2f08e73de14f36121acf79300
+  data.tar.gz: 32c52dad7be7cd46dc5bc63176e24131b06f1909
 SHA512:
-  metadata.gz: 1990e836f0368dbd64ce0ad0d725c3595ecd7d154e76543bba3a2f463e1165880fb9631a85dace9e6a4ff7d0447e1b4906156b24dae515c41f34dbe8909320bd
-  data.tar.gz: cbf63551bd3c48a725f7fd788acc2cff6efac2f64d6024d74a905002d87344363d6452609935a56035e17ce1804cb3e84fa9cd806e7ae99ee16fc4246977bce2
+  metadata.gz: 711338a9d4b320d44cf6aff3f5bc340da6b520b31dafd049c1c7749d76df2053b543fd334e1ec95a964fa9e81460e5c41e1397a2a1286916ce3613b68c2bc5c3
+  data.tar.gz: 82d067106ed7b91d224ee12e0b89ddbd4b24fc020938e55e2bfd0c2c129089590cbe37d4c21bf8cc320105a4fcb42f5266f7057f4131789981990a079cb8dd90

data/.gitignore

@@ -1,20 +1,14 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby*
 .rbenv*
 .rvmrc
-.DS_Store
+.DS_Store
+*.sqlite3

data/.rspec

@@ -1,2 +1,2 @@
+--format documentation
 --color
---require spec_helper

data/.travis.yml

@@ -1,21 +1,16 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.2.2
+  - 2.3.0
   - ruby-head
-  - jruby-19mode
   - jruby-head
-  - rbx-2
 env:
-  - "RAILS_VERSION=3.2.0"
-  - "RAILS_VERSION=4.0.0"
-  - "RAILS_VERSION=master"
-script:
-  - cd spec/dummy; bundle exec rake db:migrate
-  - cd ../../; bundle exec rake spec
+  - "ACTIVE_RECORD_VERSION=4.2.0"
+  - "ACTIVE_RECORD_VERSION=~5.0.0"
+  - "ACTIVE_RECORD_VERSION=master"
 matrix:
   allow_failures:
-    - env: "RAILS_VERSION=master"
+    - env: "ACTIVE_RECORD_VERSION=master"
     - rvm: ruby-head
     - rvm: jruby-head
+sudo: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,27 +1,31 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ar_book_finder.gemspec
+# Specify your gem's dependencies in soulless.gemspec
 gemspec
 
-rails_version = case ENV['RAILS_VERSION'] || 'default'
+active_record_version = case ENV['ACTIVE_RECORD_VERSION'] || 'default'
+
 when 'master'
   { git: 'https://github.com/rails/rails.git' }
 when 'default'
-  '~> 4.0'
+  '~> 4.2'
 else
-  "~> #{ENV['RAILS_VERSION']}"
-end
-
-gem 'rails', rails_version
-
-platforms :ruby do
-  gem 'sqlite3'
+  "~> #{ENV['ACTIVE_RECORD_VERSION']}"
 end
 
-platforms :jruby do
-  gem "activerecord-jdbcsqlite3-adapter"
+group :test do
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
 end
 
 group :development do
-  gem 'coveralls', require: false
+  gem 'activerecord', '>= 4.2.0', '< 5.1'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+
+  platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+  end
 end

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 Anthony Smith
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2016 TODO: Write your name
 
-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:
+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 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.
+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

@@ -21,12 +21,10 @@ Or install it yourself as:
 
 ## Usage
 
-Just define a plain-old-ruby-object, include Soulless and get crackin'!
+Just define a plain-old-ruby-object, inherit from `Soulless::Model` and get crackin'!
 
 ```ruby
-class UserSignupForm
-  include Soulless.model
-
+class UserSignupForm < Soulless::Model
   attribute :name, String
   attribute :email, String
   attribute :password, String
@@ -38,40 +36,6 @@ class UserSignupForm
 
   validates :password, presence: true,
                        lenght: { is_at_least: 8 }
-
-  private
-  def persist!
-    # Define what to do when this form is ready to be saved.
-  end
-end
-```
-
-### Processing an Object
-
-Soulless let's _you_ define what happens when your object is ready to be processed.
-
-```ruby
-class UserSignupForm
-
-  ...
-
-  private
-  def persist!
-    user = User.create!(name: name, email: email, password: password)
-    UserMailer.send_activation_code(user).deliver
-    user.charge_card!
-  end
-end
-```
-
-Process your Soulless object by calling ```save```. Just like a Rails model!
-
-```ruby
-form = UserSignupForm.new(name: name, email: email, password: passord)
-if form.save
-  # Called persist! and all is good!
-else
-  # Looks like a validation failed. Try again.
 end
 ```
 
@@ -133,106 +97,13 @@ Just let the validator know what ActiveRecord model to use when performing the v
 
 If your Soulless object attribute doesn't match up to the ActiveRecord model attribute just map it using the ```attribute``` option.
 
-### ```has_one``` and ```has_many``` Associations
-
-When you need associations use ```has_one``` and ```has_many```. Look familiar?
-
-```ruby
-class Person
-  include Soulless.model
-
-  attribute :name, String
-
-  validates :name, presence: true
-
-  has_one :spouse do
-    attribute :name, String
-  end
-
-  has_many :friends do
-    attribute :name, String
-  end
-end
-```
-
-You can set ```has_one``` and ```has_many``` attributes by setting their values hashes and hash arrays.
-
-```ruby
-person = Person.new(name: 'Anthony')
-person.spouse = { name: 'Megan' }
-person.friends = [{ name: 'Yaw' }, { name: 'Biff' }]
-```
-
-It's also possible for an association to inherit from a parent class and then extend functionality.
-
-```ruby
-class Person
-  include Soulless.model
-
-  attribute :name, String
-
-  validates :name, presence: true
-
-  has_one :spouse, Person do # inherits 'name' and validation from Person
-    attribute :anniversary, DateTime
-
-    validates :anniversary, presence: true
-  end
-
-  has_many :friends, Person # just inherit from Person, don't extend
-end
-```
-
-Your association has access to it's ```parent``` object as well.
-
-```ruby
-class Person
-  include Soulless.model
-
-  attribute :name, String
-
-  validates :name, presence: true
-
-  has_one :children do
-    attribute :name, String, default: lambda { "#{parent.name} Jr." }
-  end
-end
-```
-
-When you need to make sure an association is valid before processing the object use ```validates_associated```.
-
-```ruby
-class Person
-
-  ...
-
-  has_one :spouse do
-    attribute :name, String
-
-    validates :name, presence: true
-  end
-
-  validates_associated :spouse
-
-  ...
-
-end
-
-person = Person.new(name: 'Anthony')
-person.spouse = { name: nil }
-person.valid? # => false
-person.errors[:spouse] # => ["is invalid"]
-person.spouse.errors[:name] # => ["can't be blank"]
-```
-
 ### Callbacks
 
-Soulless supports the validation and save callbacks. You can use these callbacks
-as you would on a Rails model.
+Soulless supports the validation callback. You can use this callback as you
+would on a Rails model.
 
 ```ruby
-class Person
-  include Soulless.model
+class Person < Soulless::Model
 
   attribute :name, String
 
@@ -240,27 +111,15 @@ class Person
 
   before_validation :change_name_to_bart_simpson
 
-  before_save :change_name_to_mickey_mouse
-
-  has_one :children do
-    attribute :name, String, default: lambda { "#{parent.name} Jr." }
-  end
-
   private
   def change_name_to_bart_simpson
     self.name = 'Bart Simpson'
   end
-
-  def change_name_to_mickey_mouse
-    self.name = 'Mickey Mouse'
-  end
 end
 
 person = Person.new(name: 'Anthony')
 person.valid?
 person.name # => "Bart Simpson"
-person.save
-person.name # => "Mickey Mouse"
 ```
 
 ### Dirty Attributes
@@ -278,19 +137,6 @@ person.name_was # => "Anthony"
 person.name_change # => ["Anthony", "Peter Parker"]
 ```
 
-Works on ```has_one``` and ```has_many``` too.
-
-```ruby
-person.spouse.name = 'Gwen Stacy'
-person.spouse.changed? # => true
-person.spouse.changed # => ["name"]
-person.spouse.changes # => { name: ["Mary Jane Watson", "Gwen Stacy"] }
-person.spouse.name_changed? # => true
-person.spouse.name_was # => "Mary Jane Watson"
-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.
@@ -307,9 +153,7 @@ end
 ```
 
 ```ruby
-class UserSignupForm
-  include Soulless.model
-
+class UserSignupForm < Soulless::Model
   inherit_from(User)
 end
 ```
@@ -330,9 +174,7 @@ The ```#inherit_from(klass, options = {})``` method also allows you to provide o
 If you don't want to inherit the ```email``` attribute define it using the ```exclude``` option.
 
 ```ruby
-class UserSignupForm
-  include Soulless.model
-
+class UserSignupForm < Soulless::Model
   inherit_from(User, exclude: :email)
 end
 
@@ -345,9 +187,7 @@ 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
-
+class UserSignupForm < Soulless::Model
   inherit_from(User, only: :name)
 end
 
@@ -387,19 +227,6 @@ en:
               blank: "there's nothing here"
 ```
 
-For attributes defined as ```has_one``` and ```has_many``` associations use the enclosing class as the locale key's namespace.
-
-```yaml
-en:
-  soulless:
-    errors:
-      models:
-        person/spouse:
-          attributes:
-            name:
-              blank: "there's nothing here"
-```
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,10 +1,6 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task default: :spec
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soulless"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2'
+services:
+  lib:
+    image: sticksnleaves/ruby-project:2.3
+    command: rspec
+    volumes:
+      - .:/usr/src/app
+      - lib.volume:/usr/local/bundle
+volumes:
+  lib.volume:
+    driver: local

data/lib/soulless/attributes.rb

@@ -0,0 +1,33 @@
+module Soulless
+  module Attributes
+    module ClassMethods
+      def attribute(name, type = nil, options = {})
+        super(name, type, options) if super
+
+        define_attribute_methods(name)
+
+        define_reader(name)
+        define_writer(name)
+      end
+
+      def define_reader(attribute)
+        define_method(attribute.to_sym) do
+          attribute_set[attribute.to_sym].get(self)
+        end
+      end
+
+      def define_writer(attribute)
+        define_method("#{attribute}=".to_sym) do |value|
+          send("#{attribute}_will_change!") unless value == attribute_set[attribute.to_sym].get(self)
+          super(value)
+        end
+      end
+    end
+
+    def self.prepended(base)
+      class << base
+        prepend ClassMethods
+      end
+    end
+  end
+end

data/lib/soulless/callbacks.rb

@@ -0,0 +1,13 @@
+module Soulless
+  module Callbacks
+    def self.prepended(base)
+      base.define_model_callbacks :validation
+    end
+
+    def valid?(context = nil)
+      run_callbacks :validation do
+        super(context)
+      end
+    end
+  end
+end

data/lib/soulless/dirty.rb

@@ -1,13 +1,15 @@
 module Soulless
   module Dirty
-    private
-    def init_dirty
-      @changed_attributes = {}
+    def apply_changes
+      changes_applied
     end
-      
-    def changes_applied
-      @previously_changed = changed
-      @changed_attributes = {}
+
+    def reload_changes!
+      clear_changes_information
+    end
+
+    def rollback_changes!(attributes = changed)
+      restore_attributes(attributes)
     end
   end
-end
+end