active_data 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78fecd490979a5391a3de607a19c5e4605198af0
-  data.tar.gz: ebd1d4111fafc03aeb982bdb2965768920f728fd
+SHA256:
+  metadata.gz: df62766321d027161f359a1101e7e8a94842386b72188a02d7a3686f679f466e
+  data.tar.gz: 0331643a7e25c573a79269df28096971189efc52730c41b58e3922a1ab0c50af
 SHA512:
-  metadata.gz: 4d1583b8f09bf37a44343301be1bb802a62f414a8888f323dd13a1b56537986bf140cf5b238c91441ef298b6c0999883930539a3366303e8e4386863e97e357a
-  data.tar.gz: 3b0d862750cb159de0ab0911a515e80d8a8b30160918d0ab413095932da6f37a44d43c6133bf37943003f44a49977a24c99e09f5561334d07174fbfab9f8491e
+  metadata.gz: de160dbcd218f15a9203e29bf6e1fdde66b028fb97cee58b8f2816e6191202909c173da2d8db6ea8fd2db02e91314510b501c358852d3e2fe9b13876d093794c
+  data.tar.gz: 20b7783fc647ce010928847da8e5d8c4bd9cfeb0fcb0618114b72186cbcd76e6efa723f79f0f2856f41cd7cb766a5cfa3e6eddd3c34d02b5ce949754a5e83b0b

data/.codeclimate.yml

@@ -0,0 +1,13 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths: 

data/.rubocop.yml

@@ -0,0 +1,56 @@
+inherit_from: .rubocop_todo.yml
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+    - '**/*_examples.rb'
+    - '**/*.rake'
+
+Metrics/ModuleLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DoubleNegation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,53 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-14 10:15:31 +0700 using RuboCop version 0.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 19
+Metrics/AbcSize:
+  Max: 54
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 26
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 128
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 904
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 187
+
+# Offense count: 21
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 43
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 114
+
+# Offense count: 2
+Metrics/BlockLength:
+  Max: 27
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 75
+Style/Documentation:
+  Enabled: false

data/.rvmrc

@@ -1 +1 @@
-rvm use --create 2.3@active_data
+rvm use --create 2.4@active_data

data/.travis.yml

@@ -1,8 +1,8 @@
 sudo: false
 
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.2.8
+  - 2.3.5
   - rbx
 
 gemfile:
@@ -10,7 +10,20 @@ gemfile:
   - gemfiles/rails.4.1.gemfile
   - gemfiles/rails.4.2.gemfile
   - gemfiles/rails.5.0.gemfile
+  - gemfiles/rails.5.1.gemfile
 
 matrix:
   allow_failures:
     - rvm: rbx
+  include:
+    - rvm: 2.4.2
+      gemfile: gemfiles/rails.5.0.gemfile
+    - rvm: 2.4.2
+      gemfile: gemfiles/rails.5.1.gemfile
+
+before_install:
+  - gem update --system --no-doc
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Appraisals

@@ -1,4 +1,4 @@
-%w(4.0 4.1 4.2 5.0).each do |version|
+%w[4.0 4.1 4.2 5.0 5.1].each do |version|
   appraise "rails.#{version}" do
     gem 'activesupport', "~> #{version}.0"
     gem 'activemodel', "~> #{version}.0"

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# master
+
+# Version 1.1.0
+
+## Incompatible changes
+
+* Represented attributes are not provided by default, to add them, `include ActiveData::Model::Representation` (#46)
+
+* `include ActiveData::Model::Associations::Validations` is not included by default anymore, to get `validate_ancestry!`, `valid_ancestry?` and `invalid_ancestry?` methods back you need to include this module manually
+
+## Changes
+
+* Introduce persistence adapters for associations (#24, #51)
+
+* `ActionController::Parameters` support (#43)
+
+* Nested attributes simple method overriding (#41)
+
+* Persistence for `references` associations (#28, #32)
+
+* Support `update_only` option on collection nested attributes (#30)
+
+* `embedder` accessor for embedded associations
+
+* Dynamic scopes for `references` associations (#27)
+
+## Bugfixes
+
+* Fixed multiple validations on represented attributes and associations (#44)
+
+* Proper boolean attributes defaults (#31, #33)

data/Guardfile

@@ -32,8 +32,8 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements
@@ -49,15 +49,15 @@ guard :rspec, cmd: "bundle exec rspec" do
   dsl.watch_spec_files_for(ruby.lib_files)
 
   # Rails files
-  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
   dsl.watch_spec_files_for(rails.app_files)
   dsl.watch_spec_files_for(rails.views)
 
   watch(rails.controllers) do |m|
     [
-      rspec.spec.("routing/#{m[1]}_routing"),
-      rspec.spec.("controllers/#{m[1]}_controller"),
-      rspec.spec.("acceptance/#{m[1]}")
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
     ]
   end
 
@@ -67,11 +67,11 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
 
   # Capybara features specs
-  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.view_dirs) { |m| rspec.spec.call("features/#{m[1]}") }
 
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
   end
 end

data/README.md

@@ -134,22 +134,278 @@ ActiveData has modular architecture, so it is required to include modules to obt
 
 ### Attributes
 
+ActiveData provides several types of attributes and typecasts each attribute to its defined type upon initialization.
 
+```ruby
+class Book
+  include ActiveData::Model
+
+  attribute :title, String
+  collection :author_ids, Integer
+end
+```
 
 #### Attribute
+
+```ruby
+attribute :full_name, String, default: 'John Talbot'
+```
+
+By default, if type for attribute is not set, it is defined with `Object` type, so it would be a great idea to specify type for every attribute explicitly.
+
+Type is necessary for attribute typecasting. Here is the list of pre-defined basic typecasters:
+
+```irb
+[1] pry(main)> ActiveData._typecasters.keys
+=> ["Object", "String", "Array", "Hash", "Date", "DateTime", "Time", "ActiveSupport::TimeZone", "BigDecimal", "Float", "Integer", "Boolean", "ActiveData::UUID"]
+```
+
+In addition, you can provide any class type when defining the attribute, but in that case you will be able to only assign instances of that specific class or value nil:
+
+```ruby
+attribute :template, MyCustomTemplateType
+```
+
+##### Defaults
+
+It is possible to provide default values for attributes and they will act in the same way as AR or Mongoid default values:
+
+```ruby
+attribute :check, Boolean, default: false # Simply false by default
+attribute :today, Date, default: ->{ Time.zone.now.to_date } # Dynamic default value
+attribute :today_wday, Integer, default: ->{ today.wday } # Default is evaluated in instance context
+attribute :today_wday, Integer, default: ->(instance) { instance.today.wday } # The same as previous, but instance provided explicitly
+```
+
+##### Enums
+
+Enums restrict the scope of possible values for attribute. If assigned value is not included in provided list - then it turns to nil:
+
+```ruby
+attribute :direction, String, enum: %w[north south east west]
+```
+
+##### Normalizers
+
+Normalizers are applied last, modifying typecast value. It is possible to provide a list of normalizers, they will be applied in the order. It is possible to pre-define normalizers to DRY code:
+
+```ruby
+ActiveData.normalizer(:trim) do |value, options, _attribute|
+  value.first(options[:length] || 2)
+end
+
+attribute :title, String, normalizers: [->(value) { value.strip }, trim: {length: 80}]
+```
+
+##### Readonly
+
+```ruby
+attribute :name, String, readonly: true # Readonly forever
+attribute :name, String, readonly: ->{ true } # Conditionally readonly
+attribute :name, String, readonly: ->(instance) { instance.subject.present? } # Explicit instance
+```
+
 #### Collection
+
+Collection is simply an array of equally-typed values:
+
+```ruby
+class Panda
+  include ActiveData::Model
+
+  collection :ids, Integer
+end
+```
+
+Collection typecasts each value to specified type and also no matter what are you going to pass - it will be an array.
+
+```irb
+[1] pry(main)> Panda.new
+=> #<Panda ids: []>
+[2] pry(main)> Panda.new(ids: 42)
+=> #<Panda ids: [42]>
+[3] pry(main)> Panda.new(ids: [42, '33'])
+=> #<Panda ids: [42, 33]>
+```
+
+Default and enum modifiers are applied to every value, normalizer will be applied to the whole array.
+
 #### Dictionary
+
+Dictionary field is a hash of specified type values with string keys:
+
+```ruby
+class Foo
+  include ActiveData::Model
+
+  dictionary :ordering, String
+end
+```
+
+```irb
+[1] pry(main)> Foo.new
+=> #<Foo ordering: {}>
+[2] pry(main)> Foo.new(ordering: {name: :desc})
+=> #<Foo ordering: {"name"=>"desc"}>
+```
+
+Keys list might be restricted with `:keys` option, defaults and enums are applied to every value, normalizers are applied to the whole hash.
+
 #### Localized
+
+Localized is similar to how Globalize 3 attributes work.
+
+```ruby
+localized :title, String
+```
+
 #### Represents
 
+Represents provides an easy way to expose model attributes through an interface.
+It will automatically set passed value to the represented object **before validation**.
+You can use any ActiveRecord, ActiveModel or ActiveData object as a target of representation.
+A type of an attribute will be taken from it.
+If there is no type, it will be `Object` by default. You can set the type explicitly by passing the `type: TypeClass` option.
+Represents will also add automatic validation of the target object.
+
+```ruby
+class Person
+  include ActiveData::Model
+
+  attribute :name, String
+end
+
+class Doctor
+  include ActiveData::Model
+  include ActiveData::Model::Representation
+
+  attribute :person, Object
+  represents :name, of: :person
+end
+
+person = Person.new(name: 'Walter Bishop')
+# => #<Person name: "Walter Bishop">
+Doctor.new(person: person).name
+# => "Walter Bishop"
+Doctor.new(person: person, name: 'Dr. Walter Bishop').name
+# => "Dr. Walter Bishop"
+person.name
+# => "Dr. Walter Bishop"
+```
+
 ### Associations
 
+ActiveData provides a set of associations. There are two types of them: referenced and embedded. The closest example of referenced association is AR `belongs_to` and as for embedded ones - Mongoid's embedded. Also these associations support `accepts_nested_attributes` call.
+
 #### EmbedsOne
+
+```ruby
+embeds_one :profile
+```
+
+Defines singular embedded object. Might be defined inline:
+
+```ruby
+embeds_one :profile do
+  attribute :first_name, String
+  attribute :last_name, String
+end
+```
+
+Possible options:
+
+* `:class_name` - association class name
+* `:validate` - true or false
+* `:default` - default value for association: attributes hash or instance of defined class
+
 #### EmbedsMany
+
+```ruby
+embeds_many :tags
+```
+
+Defines collection of embedded objects. Might be defined inline:
+
+```ruby
+embeds_many :tags do
+  attribute :identifier, String
+end
+```
+
+* `:class_name` - association class name
+* `:validate` - true or false
+* `:default` - default value for association: attributes hash collection or instances of defined class
+
 #### ReferencesOne
+
+```ruby
+references_one :user
+```
+
+This will provide several methods to the object: `#user`, `#user=`, `#user_id` and `#user_id=`, just as would occur with an ActiveRecord association.
+
+Possible options:
+
+* `:class_name` - association class name
+* `:primary_key` - associated object primary key (`:id` by default):
+
+  ```ruby
+  references_one :user, primary_key: :name
+  ```
+
+  This will create the following methods: `#user`, `#user=`, `#user_name` and `#user_name=`
+
+* `:reference_key` - redefines `#user_id` and `#user_id=` method names completely.
+* `:validate` - true or false
+* `:default` - default value for association: reference or object itself
+
 #### ReferencesMany
+
+```ruby
+references_many :users
+```
+
+This will provide several methods to the object: `#users`, `#users=`, `#user_ids` and `#user_ids=` just as an ActiveRecord relation does.
+
+Possible options:
+
+* `:class_name` - association class name
+* `:primary_key` - associated object primary key (`:id` by default):
+
+  ```ruby
+  references_many :users, primary_key: :name
+  ```
+
+  This will create the following methods: `#users`, `#users=`, `#user_names` and `#user_names=`
+
+* `:reference_key` - redefines `#user_ids` and `#user_ids=` method names completely.
+* `:validate` - true or false
+* `:default` - default value for association: reference collection or objects themselves
+
 #### Interacting with ActiveRecord
 
+### Persistence Adapters
+
+Adapter definition syntax:
+```ruby
+class Mongoid::Document
+  # anything that have similar interface to
+  # ActiveData::Model::Associations::PersistenceAdapters::Base
+  def self.active_data_persistence_adapter
+    MongoidAdapter
+  end
+end
+```
+Where
+`ClassName` - name of model class or one of ancestors
+`data_source` - name of data source class
+`primary_key` - key to search data
+`scope_proc` - additional proc for filtering
+
+All required interface for adapters described in `ActiveData::Model::Associations::PersistenceAdapters::Base`.
+
+Adapter for ActiveRecord is `ActiveData::Model::Associations::PersistenceAdapters::ActiveRecord`. So, all AR models will use `PersistenceAdapters::ActiveRecord` by default.
+
 ### Primary
 
 ### Persistence

data/Rakefile

@@ -1,8 +1,6 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/active_data.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/active_data/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -8,23 +7,25 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Working with hashes in AR style'
   gem.homepage      = ''
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'active_data'
   gem.require_paths = ['lib']
   gem.version       = ActiveData::VERSION
 
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'activerecord', '>= 4.0'
   gem.add_development_dependency 'appraisal'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubysl', '~> 2.0' if RUBY_ENGINE == 'rbx'
   gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'database_cleaner'
-  gem.add_development_dependency 'activerecord', '>= 4.0'
   gem.add_development_dependency 'uuidtools'
-  gem.add_runtime_dependency 'activesupport', '>= 4.0'
+
   gem.add_runtime_dependency 'activemodel', '>= 4.0'
+  gem.add_runtime_dependency 'activesupport', '>= 4.0'
   gem.add_runtime_dependency 'tzinfo'
 end

data/gemfiles/rails.4.0.gemfile

@@ -11,4 +11,4 @@ group :test do
   gem "guard-rspec"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails.4.1.gemfile

@@ -11,4 +11,4 @@ group :test do
   gem "guard-rspec"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails.4.2.gemfile

@@ -11,4 +11,4 @@ group :test do
   gem "guard-rspec"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails.5.0.gemfile

@@ -11,4 +11,4 @@ group :test do
   gem "guard-rspec"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails.5.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+gem "activemodel", "~> 5.1.0"
+gem "activerecord", "~> 5.1.0"
+
+group :test do
+  gem "guard"
+  gem "guard-rspec"
+end
+
+gemspec path: "../"

data/lib/active_data/active_record/associations.rb

@@ -1,15 +1,26 @@
 module ActiveData
   module ActiveRecord
     module Associations
+      READER = lambda do |ref, object|
+        value = object.read_attribute(ref.name)
+        if value.present?
+          value.is_a?(String) ? JSON.parse(value) : value
+        end
+      end
+
+      WRITER = lambda do |ref, object, value|
+        object.send(:write_attribute, ref.name, value ? value.to_json : nil)
+      end
+
       module Reflections
         class EmbedsOne < ActiveData::Model::Associations::Reflections::EmbedsOne
-          def is_a? klass
+          def is_a?(klass)
             super || klass == ::ActiveRecord::Reflection::AssociationReflection
           end
         end
 
         class EmbedsMany < ActiveData::Model::Associations::Reflections::EmbedsMany
-          def is_a? klass
+          def is_a?(klass)
             super || klass == ::ActiveRecord::Reflection::AssociationReflection
           end
         end
@@ -18,17 +29,11 @@ module ActiveData
       extend ActiveSupport::Concern
 
       included do
-        { embeds_many: Reflections::EmbedsMany, embeds_one: Reflections::EmbedsOne }.each do |(name, reflection_class)|
-          define_singleton_method name do |name, options = {}, &block|
-            reflection = reflection_class.build(self, self, name, options.reverse_merge(
-              read: ->(reflection, object) {
-                value = object.read_attribute(reflection.name)
-                JSON.parse(value) if value.present?
-              },
-              write: ->(reflection, object, value) {
-                object.send(:write_attribute, reflection.name, value ? value.to_json : nil)
-              }
-            ), &block)
+        {embeds_many: Reflections::EmbedsMany, embeds_one: Reflections::EmbedsOne}.each do |(method, reflection_class)|
+          define_singleton_method method do |name, options = {}, &block|
+            reflection = reflection_class.build(self, self, name,
+              options.reverse_merge(read: READER, write: WRITER),
+              &block)
             if ::ActiveRecord::Reflection.respond_to? :add_reflection
               ::ActiveRecord::Reflection.add_reflection self, reflection.name, reflection
             else