active_type 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e159c5c5648aa7f407cd38c73d3e05fa630aa2a4
-  data.tar.gz: 2bcb2536092006f2b519596e5f7b5c0655308920
+  metadata.gz: bf3e434ef181d6b90bc9254d3d00824e02abc575
+  data.tar.gz: 83883dad267701774625763bde13c919fb89f4f7
 SHA512:
-  metadata.gz: 6d1f0bac7db1d6382c1ab3f62c6e1f72bd82ac02a848b516340871bfeec9302fc95b09588ee7c040b6f0e35d8014640aa683238a8b9e909df7deff18a39f5c44
-  data.tar.gz: 3d1a06ab7508e69fea48fdcb5e9fa6aeed6ee3c42778d168fa23576ba0c2dbd67c09d4c04bd3b8cfda77131d250997b1f1016763b3b626e2f368eefe319b69bc
+  metadata.gz: 749cf455d62f3463b339b3964fb2acad5375cc9357939f2c93fa780045bc233c8e6db7457fb83ba5061f0f9ea78d975ae49b5eeef99135a2571ffa293ebfa9d8
+  data.tar.gz: f4f5718c15b260464619ed1e0cb9c33b6fed16aed6f1503bc7ef8282219cafb852f8d5d6d5d08b17f4c8ae67f057963b482ef0c9409c12600408411fcdd4e608

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 tags
 *.gem
 .idea
+tmp

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - "1.8.7"
   - "1.9.3"
   - "2.0.0"
-  - "2.1.0"
+  - "2.1.2"
 gemfile:
   - gemfiles/Gemfile.3.2
   - gemfiles/Gemfile.4.0

data/README.md

@@ -63,6 +63,7 @@ class SignIn < ActiveType::Object
   attribute :email, :string
   attribute :date_of_birth, :date
   attribute :accepted_terms, :boolean
+  attribute :account_type
   
 end
 ```
@@ -70,11 +71,13 @@ end
 These attributes can be assigned via constructor, mass-assignment, and are automatically typecast:
 
 ```ruby
-sign_in = SignIn.new(date_of_birth: "1980-01-01", accepted_terms: "1")
+sign_in = SignIn.new(date_of_birth: "1980-01-01", accepted_terms: "1", account_type: AccountType::Trial.new)
 sign_in.date_of_birth.class # Date
 sign_in.accepted_terms? # true
 ```
 
+ActiveType knows all the types that are allowed in migrations (i.e. `:string`, `:integer`, `:float`, `:decimal`, `:datetime`, `:time`, `:date`, `:boolean`). You can also skip the type to have a virtual attribute without typecasting. 
+
 **`ActiveType::Object` actually inherits from `ActiveRecord::Base`, but simply skips all database access, inspired by [ActiveRecord Tableless](https://github.com/softace/activerecord-tableless).**
 
 This means your object has all usual `ActiveRecord::Base` methods. Some of those might not work properly, however. What does work:
@@ -87,7 +90,9 @@ This means your object has all usual `ActiveRecord::Base` methods. Some of those
 
 ### ActiveType::Record
 
-`ActiveType::Record` is simply `ActiveRecord::Base` plus the (virtual) attributes from `ActiveType::Object`. You can declare, assign, validate etc those attributes, but they will not be persisted.
+If you have a database backed record (that inherits from `ActiveRecord::Base`), but also want to declare virtual attributes, simply inherit from `ActiveType::Record`.
+
+Virtual attributes will not be persisted.
 
 
 ### ActiveType::Record[BaseClass]
@@ -102,6 +107,168 @@ class SignUp < ActiveType::Record[User]
 end
 ```
 
+### Inheriting from ActiveType:: objects
+
+If you want to inherit from an ActiveType class, simply do
+
+```ruby
+  class SignUp < ActiveType::Record[User]
+    # ...
+  end
+
+  class SpecialSignUp < SignUp
+    # ...
+  end
+```
+
+### Defaults ####
+
+Attributes can have defaults. Those are lazily evaluated on the first read, if no value has been set.
+
+```ruby
+class SignIn < ActiveType::Object
+
+  attribute :created_at, :datetime, default: proc { Time.now }
+
+end
+```
+
+The proc is evaluated in the context of the object, so you can do
+
+```ruby
+class SignIn < ActiveType::Object
+
+  attribute :email, :string
+  attribute :nickname, :string, default: proc { email.split('@').first }
+
+end
+
+SignIn.new(email: "tobias@example.org").nickname # "tobias"
+SignIn.new(email: "tobias@example.org", :nickname => "kratob").nickname # "kratob"
+```
+
+### Nested attributes
+
+ActiveType supports its own variant of nested attributes via the `nests_one` /
+`nests_many` macros. The intention is to be mostly compatible with
+`ActiveRecord`'s `accepts_nested_attributes` functionality.
+
+Assume you have a list of records, say representing holidays, and you want to support bulk
+editing. Then you could do something like:
+
+```ruby
+class Holiday < ActiveRecord::Base
+  validates :date, presence: true
+end
+
+class HolidaysForm < ActiveType::Object
+  nests_many :holidays, reject_if: :all_blank, default: proc { Holiday.all }
+end
+
+class HolidaysController < ApplicationController
+  def edit
+    @holidays_form = HolidaysForm.new
+  end
+
+  def update
+    @holidays_form = HolidaysForm.new(params[:holidays_form])
+    if @holidays_form.save
+      redirect_to root_url, notice: "Success!"
+    else
+      render :edit
+    end
+  end
+
+end
+
+# and in the view
+<%= form_for @holidays_form, url: '/holidays', method: :put do |form| %>
+  <ul>
+    <%= form.fields_for :holidays do |holiday_form| %>
+      <li><%= holiday_form.text_field :date %></li>
+    <% end %>
+  </ul>
+<% end %>
+```
+
+- You have to say `nests_many :records`
+- `records` will be validated and saved automatically
+- The generated `.records_attributes =` expects parameters like `ActiveRecord`'s nested attributes, and words together with the `fields_for` helper:
+
+  - either as a hash (where the keys are meaningless)
+
+    ```ruby
+    {
+      '1' => { date: "new record's date" },
+      '2' => { id: '3', date: "existing record's date" }
+    }
+    ```
+
+  - or as an array
+
+    ```ruby
+    {
+      [ date: "new record's date" ],
+      [ id: '3', date: "existing record's date" ]
+    }
+    ```
+
+To use it with single records, use `nests_one`. It works like `accept_nested_attributes` does for `has_one`.
+
+Supported options for `nests_many` / `nests_one` are:
+- `build_scope`
+
+  Used to build new records, for example:
+
+  ```ruby
+  nests_many :documents, build_scope: proc { Document.where(:state => "fresh") }
+  ```
+
+- `find_scope`
+
+  Used to find existing records (in order to update them).
+
+- `scope`
+
+  Sets `find_scope` and `build_scope` together.
+
+  If you don't supply a scope, `ActiveType` will guess from the association name, i.e. saying
+
+  ```ruby
+  nests_many :documents
+  ```
+
+  is the same as saying
+
+  ```ruby
+  nests_many :documents, scope: proc { Document }
+  ```
+
+  which is identical to
+
+  ```ruby
+  nests_many :documents, build_scope: proc { Document }, find_scope: proc { Document }
+  ```
+
+  All `...scope` options are evaled in the context of the record on first use, and cached. 
+
+- `allow_destroy`
+
+  Allow to destroy records if the attributes contain `_destroy => '1'`
+
+- `reject_if`
+
+  Pass either a proc of the form `proc { |attributes| ... }`, or a symbol indicating a method, or `:all_blank`.
+
+  Will reject attributes for which the proc or the method returns true, or with only blank values (for `:all_blank`).
+
+- `default`
+
+  Initializes the association on first access with the given proc:
+
+  ```ruby
+  nests_many :documents, default: proc { Documents.all }
+  ```
 
 
 Supported Rails versions
@@ -109,7 +276,12 @@ Supported Rails versions
 
 ActiveType is tested against ActiveRecord 3.2, 4.0 and 4.1.
 
-Later versions might work, earlier version will not.
+Later versions might work, earlier will not.
+
+Supported Ruby versions
+------------------------
+
+ActiveType is tested against MRI 1.8.7 (for 3.2 only), 1.9.3, 2.0.0, 2.1.2.
 
 
 Installation

data/Rakefile

@@ -11,8 +11,7 @@ namespace :all do
   task :spec do
     success = true
     for_each_gemfile do
-      env = "SPEC=../../#{ENV['SPEC']} " if ENV['SPEC']
-      success &= system("#{env} bundle exec rspec spec")
+      success &= system("bundle exec rspec spec")
     end
     fail "Tests failed" unless success
   end

data/gemfiles/Gemfile.3.2

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~>3.2.0'
-gem 'rspec'
+gem 'rspec', '<2.99'
 gem 'sqlite3'
 
 gem 'active_type', :path => '..'

data/gemfiles/Gemfile.3.2.lock

@@ -1,28 +1,28 @@
 PATH
   remote: ..
   specs:
-    active_type (0.1.2)
+    active_type (0.2.0)
       activerecord (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.17)
-      activesupport (= 3.2.17)
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
       builder (~> 3.0.0)
-    activerecord (3.2.17)
-      activemodel (= 3.2.17)
-      activesupport (= 3.2.17)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.17)
+    activesupport (3.2.19)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     arel (3.0.3)
     builder (3.0.4)
     diff-lcs (1.2.5)
-    i18n (0.6.9)
-    multi_json (1.9.2)
+    i18n (0.6.11)
+    multi_json (1.10.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -32,7 +32,7 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
     sqlite3 (1.3.9)
-    tzinfo (0.3.39)
+    tzinfo (0.3.40)
 
 PLATFORMS
   ruby
@@ -40,5 +40,5 @@ PLATFORMS
 DEPENDENCIES
   active_type!
   activerecord (~> 3.2.0)
-  rspec
+  rspec (< 2.99)
   sqlite3

data/gemfiles/Gemfile.4.0

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~>4.0.0'
-gem 'rspec'
+gem 'rspec', '<2.99'
 gem 'sqlite3'
 
 gem 'active_type', :path => '..'

data/gemfiles/Gemfile.4.0.lock

@@ -1,34 +1,33 @@
 PATH
   remote: ..
   specs:
-    active_type (0.1.2)
+    active_type (0.2.0)
       activerecord (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.0.4)
-      activesupport (= 4.0.4)
+    activemodel (4.0.8)
+      activesupport (= 4.0.8)
       builder (~> 3.1.0)
-    activerecord (4.0.4)
-      activemodel (= 4.0.4)
+    activerecord (4.0.8)
+      activemodel (= 4.0.8)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.4)
+      activesupport (= 4.0.8)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.4)
+    activesupport (4.0.8)
       i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     arel (4.0.2)
-    atomic (1.1.16)
     builder (3.1.4)
     diff-lcs (1.2.5)
-    i18n (0.6.9)
+    i18n (0.6.11)
     minitest (4.7.5)
-    multi_json (1.9.2)
+    multi_json (1.10.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -38,9 +37,8 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
     sqlite3 (1.3.9)
-    thread_safe (0.3.1)
-      atomic (>= 1.1.7, < 2)
-    tzinfo (0.3.39)
+    thread_safe (0.3.4)
+    tzinfo (0.3.40)
 
 PLATFORMS
   ruby
@@ -48,5 +46,5 @@ PLATFORMS
 DEPENDENCIES
   active_type!
   activerecord (~> 4.0.0)
-  rspec
+  rspec (< 2.99)
   sqlite3

data/gemfiles/Gemfile.4.1

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~>4.1.0.rc2'
-gem 'rspec'
+gem 'activerecord', '~>4.1.0'
+gem 'rspec', '<2.99'
 gem 'sqlite3'
 
 gem 'active_type', :path => '..'

data/gemfiles/Gemfile.4.1.lock

@@ -1,32 +1,31 @@
 PATH
   remote: ..
   specs:
-    active_type (0.1.2)
+    active_type (0.2.0)
       activerecord (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.1.0.rc2)
-      activesupport (= 4.1.0.rc2)
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
       builder (~> 3.1)
-    activerecord (4.1.0.rc2)
-      activemodel (= 4.1.0.rc2)
-      activesupport (= 4.1.0.rc2)
+    activerecord (4.1.4)
+      activemodel (= 4.1.4)
+      activesupport (= 4.1.4)
       arel (~> 5.0.0)
-    activesupport (4.1.0.rc2)
+    activesupport (4.1.4)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    arel (5.0.0)
-    atomic (1.1.16)
+    arel (5.0.1.20140414130214)
     builder (3.2.2)
     diff-lcs (1.2.5)
-    i18n (0.6.9)
+    i18n (0.6.11)
     json (1.8.1)
-    minitest (5.3.1)
+    minitest (5.4.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -36,9 +35,8 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
     sqlite3 (1.3.9)
-    thread_safe (0.3.1)
-      atomic (>= 1.1.7, < 2)
-    tzinfo (1.1.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -46,6 +44,6 @@ PLATFORMS
 
 DEPENDENCIES
   active_type!
-  activerecord (~> 4.1.0.rc2)
-  rspec
+  activerecord (~> 4.1.0)
+  rspec (< 2.99)
   sqlite3

data/lib/active_type/nested_attributes/association.rb

@@ -0,0 +1,128 @@
+require 'active_record/errors'
+
+module ActiveType
+
+  module NestedAttributes
+
+    class RecordNotFound < ActiveRecord::RecordNotFound; end
+
+    class Association
+
+      def initialize(owner, target_name, options = {})
+        options.assert_valid_keys(:build_scope, :find_scope, :scope, :allow_destroy, :reject_if)
+
+        @owner = owner
+        @target_name = target_name.to_sym
+        @allow_destroy = options.fetch(:allow_destroy, false)
+        @reject_if = options.delete(:reject_if)
+        @options = options.dup
+      end
+
+      def assign_attributes(parent, attributes)
+        raise NotImplementedError
+      end
+
+      def save(parent)
+        keep = assigned_children(parent)
+        changed_children(parent).each do |child|
+          if child.marked_for_destruction?
+            child.destroy if child.persisted?
+            keep.delete(child)
+          else
+            child.save(:validate => false) or raise ActiveRecord::Rollback
+          end
+        end
+        assign_children(parent, keep)
+      end
+
+      def validate(parent)
+        changed_children(parent).each do |child|
+          unless child.valid?
+            child.errors.each do |attribute, message|
+              attribute = "#{@target_name}.#{attribute}"
+              parent.errors[attribute] << message
+              parent.errors[attribute].uniq!
+            end
+          end
+        end
+      end
+
+      private
+
+      def add_child(parent, child_or_children)
+        raise NotImplementedError
+      end
+
+      def assigned_children(parent)
+        Array.wrap(parent[@target_name])
+      end
+
+      def assign_children(parent, children)
+        raise NotImplementedError
+      end
+
+      def changed_children(parent)
+        assigned_children(parent).select(&:changed_for_autosave?)
+      end
+
+      def build_child(parent, attributes)
+        build_scope(parent).new(attributes)
+      end
+
+      def scope(parent)
+        scope_for(parent, :scope) || derive_class_name.constantize
+      end
+
+      def build_scope(parent)
+        scope_for(parent, :build_scope) || scope(parent)
+      end
+
+      def find_scope(parent)
+        scope_for(parent, :find_scope) || scope(parent)
+      end
+
+      def scope_for(parent, key)
+        parent._nested_attribute_scopes ||= {}
+        parent._nested_attribute_scopes[[self, key]] ||= begin
+          scope = @options[key]
+          scope.respond_to?(:call) ? parent.instance_eval(&scope) : scope
+        end
+      end
+
+      def derive_class_name
+        raise NotImplementedError
+      end
+
+      def fetch_child(parent, id)
+        assigned = assigned_children(parent).detect { |r| r.id == id }
+        return assigned if assigned
+
+        if child = find_scope(parent).find_by_id(id)
+          add_child(parent, child)
+          child
+        else
+          raise RecordNotFound, "could not find a child record with id '#{id}' for '#{@target_name}'"
+        end
+      end
+
+      def truthy?(value)
+        ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
+      end
+
+      def reject?(parent, attributes)
+        result = case @reject_if
+        when :all_blank
+          attributes.all? { |key, value| key == '_destroy' || value.blank? }
+        when Proc
+          @reject_if.call(attributes)
+        when Symbol
+          parent.method(@reject_if).arity == 0 ? parent.send(@reject_if) : parent.send(@reject_if, attributes)
+        end
+        result
+      end
+
+    end
+
+  end
+
+end

data/lib/active_type/nested_attributes/builder.rb

@@ -0,0 +1,67 @@
+require 'active_type/nested_attributes/nests_one_association'
+require 'active_type/nested_attributes/nests_many_association'
+
+module ActiveType
+
+  module NestedAttributes
+
+    class Builder
+
+      def initialize(owner, mod)
+        @owner = owner
+        @module = mod
+      end
+
+      def build(name, one_or_many, options)
+        add_attribute(name, options.slice(:default))
+        association = build_association(name, one_or_many == :one, options.except(:default))
+        add_writer_method(name, association)
+        add_autosave(name, association)
+        add_validation(name, association)
+      end
+
+
+      private
+
+      def build_association(name, singular, options)
+        (singular ? NestsOneAssociation : NestsManyAssociation).new(@owner, name, options)
+      end
+
+      def add_attribute(name, options)
+        @owner.attribute(name, options)
+      end
+
+      def add_writer_method(name, association)
+        write_method = "#{name}_attributes="
+        @module.module_eval do
+          define_method write_method do |attributes|
+            association.assign_attributes(self, attributes)
+          end
+        end
+      end
+
+      def add_autosave(name, association)
+        save_method = "save_associated_records_for_#{name}"
+        @module.module_eval do
+          define_method save_method do
+            association.save(self)
+          end
+        end
+        @owner.after_save save_method
+      end
+
+      def add_validation(name, association)
+        validate_method = "validate_associated_records_for_#{name}"
+        @module.module_eval do
+          define_method validate_method do
+            association.validate(self)
+          end
+        end
+        @owner.validate validate_method
+      end
+
+    end
+
+  end
+
+end