virtual-attributes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4254b8bcb72697664cc7d0770e7a7d9ad80cc89
+  data.tar.gz: 2486a778c6ef88d55c635b5f333d4fa6796cee86
+SHA512:
+  metadata.gz: 6f3a8f1bc69509b641619878ce1dc43e976a9b52712cd9e17684633fa6b10b350da3abb84fa932d9f4fed6af9e8349ca1c96ffcf636341fe3b8afe539d0f0595
+  data.tar.gz: f91098c4691b063c1439698b90169234bc244282860f66e4130ec0931ba0b2caa0908055c491db23813d4157bd9bab3a05debdee681d7af788ce510aa388d92f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ihcène Med.
+
+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/lib/virtual-attributes.rb

@@ -0,0 +1,13 @@
+class VirtualAttributes
+end
+
+require 'virtual-attributes/base/attributes'
+require 'virtual-attributes/base/casts'
+require 'virtual-attributes/base/conversions'
+require 'virtual-attributes/base/defaults'
+require 'virtual-attributes/base/validations'
+require 'virtual-attributes/base'
+
+require 'virtual-attributes/serialization'
+
+ActiveRecord::Base.singleton_class.send :include, VirtualAttributes::Serialization::ClassMethods

data/lib/virtual-attributes/base.rb

@@ -0,0 +1,7 @@
+class VirtualAttributes::Base
+  include Attributes
+  include Casts
+  include Defaults
+  include Validations
+  include Conversions
+end

data/lib/virtual-attributes/base/attributes.rb

@@ -0,0 +1,39 @@
+class VirtualAttributes::Base
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :columns
+    end
+
+    def initialize(attrs = {})
+      attrs.each_pair do |k, v|
+        send "#{k}=", v
+      end
+    end
+
+    def read_attribute(column)
+      instance_variable_get("@#{column}")
+    end
+
+    def write_attribute(column, value)
+      instance_variable_set "@#{column}", value
+    end
+
+    module ClassMethods
+      def column(name, options = {})
+        (self.columns ||= {})[name] = {
+          options:  options.with_indifferent_access
+        }
+
+        define_method name do
+          read_attribute(name)
+        end
+
+        define_method :"#{name}=" do |value|
+          write_attribute(name, value)
+        end
+      end
+    end
+  end
+end

data/lib/virtual-attributes/base/casts.rb

@@ -0,0 +1,39 @@
+class VirtualAttributes::Base
+  module Casts
+    extend ActiveSupport::Concern
+
+    TYPES = ActiveRecord::Type::Value.subclasses.map{ |k| k.name.split('::').last.underscore.to_sym }
+
+    def write_attribute(column, value)
+      super column, cast_type(column, value)
+    end
+
+    def cast_type(column, value)
+      self.class.columns[column][:castor].send(:cast_value, value)
+    end
+
+    module ClassMethods
+      def column(name, type, options = {})
+        raise ArgumentError unless type.to_sym.in? TYPES
+
+        super(name, options)
+
+        self.columns[name.to_sym][:type]   = type.to_sym,
+        self.columns[name.to_sym][:castor] =
+          ActiveRecord::Type.const_get(type.to_s.classify)
+                            .new(options.symbolize_keys
+                                        .slice(:precision, :scale, :limit))
+      end
+
+      TYPES.each do |type|
+        define_method type do |*args|
+          options = args.extract_options!
+
+          args.each do |column_name|
+            column column_name, type, options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtual-attributes/base/conversions.rb

@@ -0,0 +1,24 @@
+class VirtualAttributes::Base
+  module Conversions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def wrap(val)
+        case val
+        when Hash
+          new(val)
+        when String
+          val.blank? ? new({}) : raise(ArgumentError('String is not convertible to #{self.name}'))
+        when self
+          val
+        when NilClass
+          new({})
+        when OpenStruct
+          new val.to_h
+        else
+          raise ArgumentError.new("#{val.class.name} is not convertible to #{self.name}")
+        end
+      end
+    end
+  end
+end

data/lib/virtual-attributes/base/defaults.rb

@@ -0,0 +1,21 @@
+class VirtualAttributes::Base
+  module Defaults
+    extend ActiveSupport::Concern
+
+    def read_attribute(column)
+      val = super
+      val.nil? ? default_value(column) : val
+    end
+
+    private
+      def default_value(column)
+        default = self.class.columns[column][:options][:default]
+
+        if default
+          cast_type(
+            column,
+            default.respond_to?(:call) ? default.call(self) : default)
+        end
+      end
+  end
+end

data/lib/virtual-attributes/base/validations.rb

@@ -0,0 +1,9 @@
+class VirtualAttributes::Base
+  module Validations
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Validations
+    end
+  end
+end

data/lib/virtual-attributes/serialization.rb

@@ -0,0 +1,43 @@
+module VirtualAttributes::Serialization
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def serialize(*args, &block)
+      if block_given?
+        attr_name  = args.first.to_s.presence || raise(ArgumentError.new('Attr name is mandatory'))
+        klass_name = "#{attr_name.classify}VirtualAttributes"
+
+        klass = Class.new VirtualAttributes::Base
+        const_set klass_name, klass
+
+        yield const_get klass_name
+
+        super attr_name, const_get(klass_name)
+
+        validates attr_name, virtual_attributes: true
+
+        define_method :"#{attr_name}=" do |val|
+          super self.class.const_get(klass_name).wrap(val)
+        end
+
+        define_method :"#{attr_name}" do
+          val = super()
+          val.is_a?(self.class.const_get(klass_name)) ? val : self.class.const_get(klass_name).wrap(val)
+        end
+      else
+        super(*args)
+      end
+    end
+
+    class ::VirtualAttributesValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return unless value.is_a?(VirtualAttributes::Base::Validations)
+
+        if value.invalid?
+          record.errors[attribute] << value.errors.full_messages.join('. ')
+        end
+      end
+    end
+
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+RSpec.describe VirtualAttributes::Base do
+  describe "Accessors" do
+    it "should define accessors" do
+      klass = Class.new(VirtualAttributes::Base) do
+        string :username
+      end
+
+      instance = klass.new
+      expect(instance).to respond_to :username
+      expect(instance).to respond_to(:'username=').with(1).argument
+
+      instance.username = 'John'
+      expect(instance.username).to eql('John')
+    end
+
+    it "should allow defining several attributes at once" do
+      klass = Class.new(VirtualAttributes::Base) do
+        string :firstname, :lastname
+      end
+      instance = klass.new
+
+      expect(instance).to respond_to :firstname, :lastname
+    end
+  end
+
+  describe "Type casts" do
+    before(:each) do
+      @klass = Class.new(VirtualAttributes::Base) do
+        string    :username
+        date      :birthdate
+        boolean   :rockstar
+        integer   :age
+      end
+      @instance = @klass.new
+    end
+
+    it "should cast dates correctly" do
+      @instance.birthdate = "1963/11/22"
+      expect(@instance.birthdate).to eql Date.new(1963, 11, 22)
+    end
+
+    it "should cast booleans correctly" do
+      @instance.rockstar = 1
+      expect(@instance.rockstar).to eql true
+
+      @instance.rockstar = "1"
+      expect(@instance.rockstar).to eql true
+
+      @instance.rockstar = "t"
+      expect(@instance.rockstar).to eql true
+
+      @instance.rockstar = "true"
+      expect(@instance.rockstar).to eql true
+
+      @instance.rockstar = 0
+      expect(@instance.rockstar).to eql false
+
+      @instance.rockstar = "0"
+      expect(@instance.rockstar).to eql false
+
+      @instance.rockstar = "f"
+      expect(@instance.rockstar).to eql false
+
+      @instance.rockstar = "false"
+      expect(@instance.rockstar).to eql false
+    end
+
+    it "should cast integer correctly" do
+      @instance.age = "23"
+      expect(@instance.age).to eql 23
+
+      @instance.age = "23 apples"
+      expect(@instance.age).to eql 23
+
+      @instance.age = "I have 23 apples"
+      expect(@instance.age).to eql 0
+
+      @instance.age = 42.0
+      expect(@instance.age).to eql 42
+
+      @instance.age = BigDecimal.new('42.67')
+      expect(@instance.age).to eql 42
+    end
+
+    it "should cast strings correctly" do
+      @instance.username = 42
+      expect(@instance.username).to eql "42"
+
+      @instance.username = String
+      expect(@instance.username).to eql "String"
+    end
+  end
+
+  describe "Default values" do
+    before :each do
+      @klass = Class.new(VirtualAttributes::Base) do
+        string    :fullname, default: "John Doe"
+        string    :login, default: ->(e){  e.fullname.reverse }
+        date      :birthdate, default: ->(){ raise ArgumentError }
+        date      :birthdate_to_cast, default: "1963/11/22"
+        boolean   :rockstar
+        integer   :age
+      end
+      @instance = @klass.new
+    end
+
+    it "should return default value when nil" do
+      expect(@instance.fullname).to eql 'John Doe'
+    end
+
+    it "should ignore default value if not nil" do
+      @instance.fullname = 'Stephen King'
+      expect(@instance.fullname).to_not eql 'John Doe'
+      expect(@instance.fullname).to eql 'Stephen King'
+    end
+
+    it "should ignore default value even if blank" do
+      @instance.fullname = ''
+      expect(@instance.fullname).to_not eql 'John Doe'
+    end
+
+    it "should call default value proc" do
+      expect{@instance.birthdate}.to raise_error(ArgumentError)
+    end
+
+    it "should allow passing the model to default value procs" do
+      expect(@instance.login).to eql "eoD nhoJ"
+    end
+
+    it "should cast default value" do
+      expect(@instance.birthdate_to_cast).to eql Date.new(1963, 11, 22)
+    end
+  end
+
+  describe "Validations" do
+    before :each do
+      @klass = ValidationTestClass = Class.new(VirtualAttributes::Base) do
+        string    :fullname, default: ""
+        string    :login, default: ->(e){  e.fullname.reverse }
+        date      :birthdate, default: "1963/11/22"
+        boolean   :rockstar, default: false
+        integer   :age
+
+        validates_presence_of :fullname, :login, :age
+      end
+      @instance = @klass.new
+    end
+
+    it "should validate correctly" do
+      expect(@instance.valid?).to be(false)
+
+      expect(@instance.errors[:fullname].length).to eql 1
+      expect(@instance.errors[:login].length).to eql 1
+      expect(@instance.errors[:age].length).to eql 1
+      expect(@instance.errors[:birthdate].length).to eql 0
+    end
+  end
+end

data/spec/serialization_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+RSpec.describe VirtualAttributes::Serialization do
+  before :each do
+    @klass = ValidationTestSerializeClass = Class.new(ActiveRecord::Base) do
+      concerning :NoNeedDatabase do
+        attr_accessor :contact
+
+        def initialize(*)
+        end
+
+        def save(validate = true)
+          validate ? valid? : true
+        end
+
+        module ClassMethods
+          def columns
+            @columns ||= [];
+          end
+
+          def column(name, sql_type = nil, default = nil, null = true)
+            columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default,
+              sql_type.to_s, null)
+          end
+        end
+      end
+
+      serialize :contact do |t|
+        t.string    :fullname, default: ""
+        t.string    :login, default: ->(e){  e.fullname.reverse }
+        t.date      :birthdate, default: "1963/11/22"
+        t.boolean   :rockstar, default: false
+        t.integer   :age
+      end
+    end
+
+    @instance = @klass.new
+  end
+
+  it "create a namespaced class of the right type" do
+    expect(@klass).to be_const_defined(:'ContactVirtualAttributes')
+    expect(@klass.const_get(:'ContactVirtualAttributes').superclass).to eql(VirtualAttributes::Base)
+  end
+
+  it "should produce instances that return the right type" do
+    expect(@instance.contact).to be_a(VirtualAttributes::Base)
+  end
+
+  it "should accept open structs and hashes" do
+    expect{ @instance.contact = OpenStruct.new(fullname: 'John Doe') }.to_not raise_error
+    expect(@instance.contact.fullname).to eql 'John Doe'
+
+    expect{ @instance.contact = {login: 'John Doe'} }.to_not raise_error
+    expect(@instance.contact.login).to eql 'John Doe'
+  end
+
+  it "should refuses other types" do
+    expect{ @instance.contact = 42 }.to raise_error(/is not convertible/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'virtual-attributes'
+
+RSpec.configure do |config|
+
+end

data/virtual-attributes.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'virtual-attributes'
+  s.version     = '0.1.1'
+  s.date        = '2015-03-19'
+  s.summary     = "Enhance ActiveRecord's Serialize with types attributes"
+  s.description = "This gem allow you to add whenever columns you want to your model through one single serialized attribute"
+  s.authors     = ["ihcene"]
+  s.email       = 'ihcene@aritylabs.com'
+  s.files       = `git ls-files`.split($/)
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 1.9.3'
+  s.homepage    = 'https://github.com/ihcene/virtual-attributes'
+  s.license     = 'MIT'
+  s.add_runtime_dependency 'activerecord', '>= 3.0', '< 5.0'
+  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: virtual-attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ihcene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: This gem allow you to add whenever columns you want to your model through
+  one single serialized attribute
+email: ihcene@aritylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE
+- lib/virtual-attributes.rb
+- lib/virtual-attributes/base.rb
+- lib/virtual-attributes/base/attributes.rb
+- lib/virtual-attributes/base/casts.rb
+- lib/virtual-attributes/base/conversions.rb
+- lib/virtual-attributes/base/defaults.rb
+- lib/virtual-attributes/base/validations.rb
+- lib/virtual-attributes/serialization.rb
+- spec/base_spec.rb
+- spec/serialization_spec.rb
+- spec/spec_helper.rb
+- virtual-attributes.gemspec
+homepage: https://github.com/ihcene/virtual-attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Enhance ActiveRecord's Serialize with types attributes
+test_files: []