active_type 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7a8aaa4de25bb39e76fe2f9d62ee07650ab25c2
+  data.tar.gz: e9f689b6b22a2e253f6c7d191bf6ae9b757c149f
+SHA512:
+  metadata.gz: 5306d05e6793c5656ee6afebd49bc70b3579667f94cee32f23a3f5ac834bc920fd48bc278c730a114493298fc173e0f43a72188681da896cf3b6af92e43991c8
+  data.tar.gz: bd0bfbe15cfe7dc610feaf52e75246ad28ea93419e1fc7e90589b3f9f57736f442a6558d0a8d4752c3d060cd20299bd2ee86cf0cf5841ba48c06b6bf5746bb91

data/.gitignore

@@ -0,0 +1,5 @@
+doc
+pkg
+tags
+*.gem
+.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+gemfile:
+  - gemfiles/Gemfile.3.2
+  - gemfiles/Gemfile.4.0
+  - gemfiles/Gemfile.4.1
+script: bundle exec rspec spec
+notifications:
+  email:
+    - fail@makandra.de
+branches:
+  only:
+    - master

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tobias Kraze
+
+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,149 @@
+ActiveType [![Build Status](https://travis-ci.org/makandra/active_type.svg?branch=master)](https://travis-ci.org/makandra/active_type)
+==========
+
+Make any Ruby object quack like ActiveRecord
+--------------------------------------------
+
+ActiveType is our take on "presenter models" (or "form models") in Rails. We want to have controllers (and forms) talk to models that are either not backed by a database table, or have additional functionality that should not be shared to the rest of the application.
+
+However, we do not want to lose ActiveRecord's amenities, like validations, callbacks, etc.
+
+Examples for use cases are models to support sign in:
+
+```ruby
+class SignIn < ActiveType::Object
+
+  # this is not backed by a db table
+  
+  attribute :username, :string
+  attribute :password, :string
+
+  validates :username, presence: true
+  validates :password, presence: true
+  
+  # ...
+
+end
+```
+
+Or models to support sign up:
+
+```ruby
+class User < ActiveRecord::Base
+  # ...
+end
+
+class SignUp < ActiveType::Record[User]
+
+  # this inherits from User
+
+  validates :password, confirmation: true
+  
+  after_create :send_confirmation_email
+  
+  def send_confirmation_email
+    # this should happen on sign-up, but not when creating a user in tests etc.
+  end
+  
+  # ...
+  
+end
+```
+
+### ActiveType::Object
+
+
+Inherit from `ActiveType::Object` if you want an `ActiveRecord`-kind class that is not backed by a database table.
+
+You can define "columns" by saying `attribute`:
+
+```ruby
+class SignIn < ActiveType::Object
+  
+  attribute :email, :string
+  attribute :date_of_birth, :date
+  attribute :accepted_terms, :boolean
+  
+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.date_of_birth.class # Date
+sign_in.accepted_terms # true
+```
+
+**`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:
+
+- validations
+- callbacks (use `before_save`, `after_save`, not `before_create`, or `before_update`)
+- "saving" (returning `true` or `false`, without actually persisting)
+- belongs_to (after saying `attribute :child_id, :integer`)
+
+
+### 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.
+
+
+### ActiveType::Record[BaseClass]
+
+`ActiveType::Record[BaseClass]` is used to extend a given `BaseClass` (that itself has to be an `ActiveRecord` model) with additional functionality, that is not meant to be shared to the rest of the application.
+
+You class will inherit from `BaseClass`. You can add additional methods, validations, callbacks, as well as use (virtual) attributes like an `ActiveType::Object`:
+
+```ruby
+class SignUp < ActiveType::Record[User]
+  # ...
+end
+```
+
+
+
+Supported Rails versions
+------------------------
+
+ActiveType is tested against ActiveRecord 3.2, 4.0 and 4.1.
+
+Later versions might work, earlier version will not.
+
+
+Installation
+------------
+
+In your `Gemfile` say:
+
+    gem 'active_type'
+
+Now run `bundle install` and restart your server.
+
+
+Development
+-----------
+
+- We run tests against several ActiveRecord versions.
+- You can bundle all versions with `rake all:bundle`.
+- You can run specs against all versions with `rake`.
+- You can run specs against a single version with `VERSION=4.0 rake`.
+
+If you would like to contribute:
+
+- Fork the repository.
+- Push your changes **with passing specs**.
+- Send us a pull request.
+
+I'm very eager to keep this gem leightweight and on topic. If you're unsure whether a change would make it into the gem, [talk to me beforehand](mailto:henning.koch@makandra.de).
+
+
+Credits
+-------
+
+Tobias Kraze from [makandra](http://makandra.com/)
+
+Henning Koch from [makandra](http://makandra.com/)
+
+

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'bundler/gem_tasks'
+
+desc 'Default: Run all specs.'
+task :default => 'all:spec'
+
+
+namespace :all do
+
+  desc "Run specs on all versions"
+  task :spec do
+    success = true
+    for_each_gemfile do
+      env = "SPEC=../../#{ENV['SPEC']} " if ENV['SPEC']
+      success &= system("#{env} bundle exec rspec spec")
+    end
+    fail "Tests failed" unless success
+  end
+
+  desc "Bundle all versions"
+  task :bundle do
+    for_each_gemfile do
+      system('bundle install')
+    end
+  end
+
+end
+
+def for_each_gemfile
+  version = ENV['VERSION'] || '*'
+  Dir["gemfiles/Gemfile.#{version}"].sort.each do |gemfile|
+    next if gemfile =~ /.lock/
+    puts '', "\033[44m#{gemfile}\033[0m", ''
+    ENV['BUNDLE_GEMFILE'] = gemfile
+    yield
+  end
+end

data/active_type.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "active_type/version"
+
+Gem::Specification.new do |s|
+  s.name = 'active_type'
+  s.version = ActiveType::VERSION
+  s.authors = ["Tobias Kraze", "Henning Koch"]
+  s.email = 'tobias.kraze@makandra.de'
+  s.homepage = 'https://github.com/makandra/active_type'
+  s.summary = 'Make any Ruby object quack like ActiveRecord'
+  s.description = s.summary
+  s.license = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake"
+
+  s.add_runtime_dependency('activerecord', '>= 3.2')
+
+end

data/gemfiles/Gemfile.3.2

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

data/gemfiles/Gemfile.3.2.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: ..
+  specs:
+    active_type (0.1.0)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.17)
+      activesupport (= 3.2.17)
+      builder (~> 3.0.0)
+    activerecord (3.2.17)
+      activemodel (= 3.2.17)
+      activesupport (= 3.2.17)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.17)
+      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)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sqlite3 (1.3.9)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_type!
+  activerecord (~> 3.2.0)
+  rspec
+  sqlite3

data/gemfiles/Gemfile.4.0

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

data/gemfiles/Gemfile.4.0.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: ..
+  specs:
+    active_type (0.1.0)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
+      builder (~> 3.1.0)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.4)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.4)
+      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)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_type!
+  activerecord (~> 4.0.0)
+  rspec
+  sqlite3

data/gemfiles/Gemfile.4.1

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

data/gemfiles/Gemfile.4.1.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: ..
+  specs:
+    active_type (0.1.0)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.0.rc2)
+      activesupport (= 4.1.0.rc2)
+      builder (~> 3.1)
+    activerecord (4.1.0.rc2)
+      activemodel (= 4.1.0.rc2)
+      activesupport (= 4.1.0.rc2)
+      arel (~> 5.0.0)
+    activesupport (4.1.0.rc2)
+      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)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      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.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_type!
+  activerecord (~> 4.1.0.rc2)
+  rspec
+  sqlite3

data/lib/active_type/extended_record/inheritance.rb

@@ -0,0 +1,41 @@
+module ActiveType
+
+  module ExtendedRecord
+
+    module Inheritance
+
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :extended_record_base_class
+      end
+
+      module ClassMethods
+
+        def model_name
+          extended_record_base_class.model_name
+        end
+
+        def sti_name
+          extended_record_base_class.sti_name
+        end
+
+
+        private
+
+        def find_sti_class(type_name)
+          sti_class = super
+          if self <= sti_class
+            self
+          else
+            sti_class
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/active_type/extended_record.rb

@@ -0,0 +1,27 @@
+require 'active_type/virtual_attributes'
+require 'active_type/extended_record/inheritance'
+
+module ActiveType
+
+  module ExtendedRecord
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def [](base)
+        Class.new(base) do
+          @abstract_class = true
+
+          include VirtualAttributes
+          include Inheritance
+
+          self.extended_record_base_class = base
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/active_type/no_table.rb

@@ -0,0 +1,65 @@
+module ActiveType
+
+  module NoTable
+
+    extend ActiveSupport::Concern
+
+
+    module ClassMethods
+
+      def columns
+        []
+      end
+
+      def destroy(*)
+        new
+      end
+
+      def destroy_all(*)
+        []
+      end
+
+
+      def find_by_sql(*)
+        []
+      end
+
+    end
+
+    def id
+      nil
+    end
+
+    def transaction(&block)
+      @_current_transaction_records ||= []
+      yield
+    end
+
+    def create(*)
+      true
+    end
+
+    def create_record(*)
+      true
+    end
+
+    def update(*)
+      true
+    end
+
+    def update_record(*)
+      true
+    end
+
+    def destroy
+      @destroyed = true
+      freeze
+    end
+
+    def reload
+      self
+    end
+
+  end
+
+end

data/lib/active_type/object.rb

@@ -0,0 +1,13 @@
+require 'active_type/no_table'
+require 'active_type/virtual_attributes'
+
+module ActiveType
+
+  class Object < ActiveRecord::Base
+
+    include NoTable
+    include VirtualAttributes
+
+  end
+
+end

data/lib/active_type/record.rb

@@ -0,0 +1,15 @@
+require 'active_type/virtual_attributes'
+require 'active_type/extended_record'
+
+module ActiveType
+
+  class Record < ActiveRecord::Base
+
+    @abstract_class = true
+
+    include VirtualAttributes
+    include ExtendedRecord
+
+  end
+
+end

data/lib/active_type/version.rb

@@ -0,0 +1,3 @@
+module ActiveType
+  VERSION = '0.1.0'
+end