trax_model 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed46643e7e35aa4ab571dac149147ff661f740c
-  data.tar.gz: 7beb964bc0b37e05220191499f043d38be298a64
+  metadata.gz: b684425923dcaa1272ed04a98ab652ecf61c56ca
+  data.tar.gz: 5c66900bde83b806346c7784ed378ed92ff0c50f
 SHA512:
-  metadata.gz: 411e43d1938a872495eb850a65aae17e375ce5dccbb6f8f0dfda5e286893b3d2859d096b1e68e92cec5535f91ba166e6e18ac609d9560708c23a516116901bfe
-  data.tar.gz: 70774f22c946132a1deeda5c510a05591d77aa90fdf6f9956f21b2f42f898e88b2632a572cfa37588f9bb52fe0bffb49d3225e333231eca2a7dba80887a43bd3
+  metadata.gz: ee0a7829a4bfe0098f47a5f2e8e8da1e6dd54abb10fc129f1addef047108a0f359396fe3a27b37bc7155c734667d9bc5ee68265af85adcefd96859108d8eb871
+  data.tar.gz: 0283a5f7de147bd1a5d51c38e925c3935696f2ea00ecc390e3735d249e48b92e7d3628fb6489c3483b7c0fdfe38ed95de64b83a00a28277b0c8b7c68e60c67f4

data/README.md

@@ -163,6 +163,53 @@ The main disadvantages are:
 1. No shared view between child types. I.E. thats what the MTI entity is for. (want to find all blog posts? You cant unless you select a type first, or are using this gem, or a postgres view or something else)
 2. More difficult to setup since each child table needs its own table.
 
+# STI
+
+Trax also has a specialized blend of STI, where you place the union of attributes in the parent table, but for the child specific attributes, you create one separate table per subclass, i.e. given the following pseudo schema
+``` ruby
+#(Note this may make more sense to be a has_one rather than a belongs_to, cant remember why I set it up that way)
+
+Post
+:type => string, :title => String, :attribute_set_id => (integer or uuid, this is required ATM.)
+
+VideoPost
+video_url => string
+video_thumbnail => binary
+
+TextPost
+body => text
+```
+You would have 2 additional models
+
+1. VideoPostAttributeSet
+2. TextPostAttributeSet
+
+Which contain the type specific columns.
+
+Then you just need to include
+
+``` ruby
+class VideoPost < Post
+  include ::Trax::Model::STI::Attributes
+
+  sti_attribute :video_url, :video_thumbnail
+end
+```
+
+STI Attribute will set up the delegation to the attribute_set model, so now you can do
+
+``` ruby
+VideoPost.new(:video_url => "http://whatever.com")
+```
+
+ETC..
+
+AttributeSet model will be built automatically if it does not exist, and delegated to accordingly.
+
+The idea is to hide the complexity of dealing with the attribute_set table, and do as much as possible in the main model, as its really just an extension of itself.
+
+If you need to override one of the attribute_sets methods, try super! as that will delegate to it and call super on the attribute set model.
+
 
 ## Installation
 

data/lib/trax/model/enum.rb

@@ -20,18 +20,10 @@
 module Trax
   module Model
     module Enum
-      extend ::ActiveSupport::Concern
+      include ::Trax::Model::Mixin
 
       module ClassMethods
-        def as_enum(enum_name, args, options = {})
-          options.assert_valid_keys(:prefix, :source, :message)
-          options[:message] ||= "Is not a valid value for #{enum_name}"
-          options[:prefix] ||= true
-          options[:source] ||= enum_name
-          enum_values = args.is_a?(Hash) ? args.keys : args
-          validation_options = { :in => enum_values, :message => options.extract!(:message) }
-
-          self.validates_inclusion_of(enum_name, validation_options)
+        def define_scopes_for_trax_enum(enum_name)
           scope_method_name = :"by_#{enum_name}"
           scope_not_method_name = :"by_#{enum_name}_not"
 
@@ -43,8 +35,28 @@ module Trax
             enum_hash = self.__send__("#{enum_name}".pluralize).hash
             where.not(enum_name => enum_hash.with_indifferent_access.slice(*values.flatten.compact.uniq).values)
           }
+        end
+
+        #todo: ew need to clean this up
+        def as_enum(enum_name, enum_mapping, options = {})
+          enum_values = enum_mapping.is_a?(Hash) ? enum_mapping.keys : enum_mapping
+          options.assert_valid_keys(:prefix, :source, :message, :default, :validate)
+
+          options[:message] ||= "Invalid value selected for #{enum_name}"
+          options[:prefix] ||= true
+          options[:source] ||= enum_name
+          default_value = options.extract!(:default)[:default] if options.key?(:default)
+
+          validation_options = { :in => enum_values, :message => options.extract!(:message)[:message] }
+
+          self.validates_inclusion_of(enum_name, validation_options) unless options.key?(:validate) && !options[:validate]
+          options.delete(:validate) if options.key?(:validate)
+
+          define_scopes_for_trax_enum(enum_name)
+
+          self.default_value_for(enum_name) { default_value } if default_value
 
-          super(enum_name, args, options)
+          super(enum_name, enum_mapping, options)
         end
       end
     end

data/lib/trax/model/errors.rb

@@ -22,6 +22,12 @@ module Trax
           "following prefix was already registered"
         ]
       end
+
+      class STIAttributeNotFound < ::Trax::Model::Errors::Base
+        MESSAGE = [
+          "STI Attribute was not found for attribute"
+        ]
+      end
     end
   end
 end

data/lib/trax/model/freezable.rb

@@ -1,7 +1,7 @@
 module Trax
   module Model
     module Freezable
-      extend ::ActiveSupport::Concern
+      include ::Trax::Model::Mixin
 
       included do
         class_attribute :freezable_fields
@@ -11,7 +11,6 @@ module Trax
       module ClassMethods
         def freezable_by_enum(options = {})
           freezable_fields.merge!(options)
-
           define_frozen_validators_for_enum(options)
         end
 
@@ -26,6 +25,5 @@ module Trax
         end
       end
     end
-
   end
 end

data/lib/trax/model/mixin.rb

@@ -0,0 +1,13 @@
+module Trax
+  module Model
+    module Mixin
+      extend ::ActiveSupport::Concern
+
+      included do
+        self.extend(::ActiveSupport::Concern)
+
+        ::Trax::Model.register_mixin(self)
+      end
+    end
+  end
+end

data/lib/trax/model/mti/abstract.rb

@@ -8,7 +8,9 @@ module Trax
           class_attribute :mti_config
 
           self.abstract_class = true
-          self.mti_config = ::Hashie::Mash.new(:foreign_key => :id)
+          self.mti_config = ::ActiveSupport::HashWithIndifferentAccess.new({
+            :foreign_key => :id
+          })
 
           scope :records, lambda{
             map(&:entity)
@@ -50,6 +52,7 @@ module Trax
 
           def entity_model(options)
             valid_options = options.assert_valid_keys(:class_name, :foreign_key)
+
             mti_config.merge!(valid_options)
 
             self.has_one(:entity, mti_config.symbolize_keys)

data/lib/trax/model/restorable.rb

@@ -0,0 +1,52 @@
+module Trax
+  module Model
+    module Restorable
+      include ::Trax::Model::Mixin
+
+      included do
+        class_attribute :_restorable_config
+
+        alias_method :destroy!, :destroy
+
+        self._restorable_config = {
+          :field => :is_deleted,
+          :timestamp_field => :deleted_at,
+          :hide_deleted => true
+        }
+      end
+
+      module ClassMethods
+        def setup_restorable!
+          self.class_eval do
+            if(self._restorable_config[:hide_deleted])
+              default_scope { by_not_deleted }
+            end
+
+            ### Clear default deleted scope ###
+            scope :by_is_deleted, lambda { |*|
+              unscope(:where => self._restorable_config[:field]).where(self._restorable_config[:field] => true)
+            }
+            scope :by_not_deleted, lambda { |*|
+              where(self._restorable_config[:field] => false)
+            }
+
+            default_value_for(self._restorable_config[:field]) { false }
+          end
+        end
+      end
+
+      def destroy
+        self.update_attributes(self._restorable_config[:field] => true, self._restorable_config[:timestamp_field] => ::DateTime.now)
+      end
+
+      def restore
+        self.update_attributes(self._restorable_config[:field] => false, self._restorable_config[:timestamp_field] => ::DateTime.now)
+      end
+
+      def self.apply_mixin(target, options)
+        target._restorable_config.merge!(options)
+        target.setup_restorable!
+      end
+    end
+  end
+end

data/lib/trax/model/sti/attributes.rb

@@ -0,0 +1,94 @@
+module Trax
+  module Model
+    module STI
+      module Attributes
+        extend ::ActiveSupport::Concern
+
+        #not configurable atm as you can see below
+
+        included do
+          class_attribute :_attribute_set_column,
+                          :_attribute_set_class_name,
+                          :_attribute_set_relation_name,
+                          :_sti_attributes
+
+          self._sti_attributes = []
+
+          self._attribute_set_relation_name = :attribute_set
+          self._attribute_set_column = :attribute_set_id
+          self._attribute_set_class_name = "#{name}AttributeSet"
+
+          self.belongs_to(self._attribute_set_relation_name, :class_name => self._attribute_set_class_name, :validate => true)
+          self.validates(self._attribute_set_relation_name, :presence => true)
+
+          self.before_create(:attribute_set)
+        end
+
+        def attributes
+          super.merge!(sti_attributes)
+        end
+
+        def attribute_set
+          build_attribute_set if super.nil?
+
+          super
+        end
+
+        def sti_attributes
+          sti_attribute_hash = self.class._sti_attributes.inject({}) do |result, attribute|
+            result["#{attribute}"] = __send__(attribute)
+            result
+          end
+
+          sti_attribute_hash
+        end
+
+        def super!(*args)
+          method_caller = caller_locations(1,1)[0].label
+          attribute_set.send(method_caller, *args)
+        end
+
+        module ClassMethods
+          def sti_attribute(*args)
+            options = args.extract_options!
+
+            args.each do |attribute_name|
+              return unless self._attribute_set_class_name.constantize.table_exists?
+              raise ::Trax::Model::Errors::STIAttributeNotFound unless self._attribute_set_class_name.constantize.column_names.include?("#{attribute_name}")
+
+              self._sti_attributes << attribute_name
+
+              self.delegate(attribute_name, :to => :attribute_set)
+              self.delegate("#{attribute_name}=", :to => :attribute_set) unless options.key?(:writer) && options[:writer] == false
+            end
+          end
+
+          def validates_uniqueness_of!(*args)
+            options = args.extract_options!
+
+            args.each do |arg|
+              validation_method_name = :"validate_#{arg.to_s}"
+
+              self.send(:define_method, :"validate_#{arg.to_s}") do |*_args|
+                where_scope_hash = {}
+                field_value = self.__send__(arg)
+                where_scope_hash[arg] = field_value
+
+                where_scope = self._attribute_set_class_name.constantize.where(where_scope_hash).all
+
+                options[:scope].each do |field|
+                  scoped_field_value = self.__send__(field)
+                  where_scope.merge(self.class.where({field => scoped_field_value}))
+                end if options.has_key?(:scope)
+
+                errors.add(arg, "has already been taken") if where_scope.limit(1).any?
+              end
+
+              self.validate(validation_method_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trax/model/sti.rb

@@ -0,0 +1,9 @@
+module Trax
+  module Model
+    module STI
+      extend ::ActiveSupport::Autoload
+
+      autoload :Attributes
+    end
+  end
+end

data/lib/trax/model/unique_id.rb

@@ -1,7 +1,7 @@
 module Trax
   module Model
     module UniqueId
-      extend ::ActiveSupport::Concern
+      include ::Trax::Model::Mixin
 
       included do
         #grab prefix from uuid registry if using that

data/lib/trax/model.rb

@@ -4,6 +4,7 @@ require 'hashie/dash'
 require 'hashie/mash'
 require 'simple_enum'
 require_relative './string'
+# require_relative './enum'
 require_relative './validators/email_validator'
 require_relative './validators/frozen_validator'
 require_relative './validators/future_validator'
@@ -24,12 +25,35 @@ module Trax
     autoload :UUIDPrefix
     autoload :UniqueId
     autoload :Matchable
+    autoload :Mixin
     autoload :MTI
+    autoload :Restorable
+    autoload :STI
     autoload :Validators
 
     include ::Trax::Model::Matchable
     include ::ActiveModel::Dirty
 
+    class << self
+      attr_accessor :mixin_registry
+    end
+
+    @mixin_registry = {}
+
+    def self.register_mixin(mixin_klass)
+      mixin_key = mixin_klass.name.demodulize.underscore.to_sym
+      mixin_registry[mixin_key] = mixin_klass
+    end
+
+    def self.eager_autoload_mixins!
+      ::Trax::Model::Enum
+      ::Trax::Model::Freezable
+      ::Trax::Model::Restorable
+      ::Trax::Model::UniqueId
+    end
+
+    eager_autoload_mixins!
+
     included do
       class_attribute :trax_defaults
 
@@ -48,6 +72,30 @@ module Trax
         end
       end
 
+      def mixin(key, options = {})
+        mixin_klass = ::Trax::Model.mixin_registry[key]
+
+        self.class_eval do
+          include(mixin_klass) unless self.ancestors.include?(mixin_klass)
+
+          if(options.is_a?(Hash) && !options.blank?)
+            mixin_klass.apply_mixin(self, options) if mixin_klass.respond_to?(:apply_mixin)
+          end
+        end
+      end
+
+      def mixins(*args)
+        options = args.extract_options!
+
+        if(!options.blank?)
+          options.each_pair do |key, val|
+            self.mixin(key, val)
+          end
+        else
+          args.map{ |key| mixin(key) }
+        end
+      end
+
       def register_trax_models(*models)
         models.each do |model|
           register_trax_model(model)

data/lib/trax_model/version.rb

@@ -1,3 +1,3 @@
 module TraxModel
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/spec/support/schema.rb

@@ -28,6 +28,8 @@ ActiveRecord::Schema.define(:version => 1) do
     t.text     "body"
     t.integer  "status"
     t.string   "uuid"
+    t.boolean  "deleted"
+    t.datetime "deleted_at"
     t.datetime "deliver_at"
     t.datetime "created_at",        :null => false
     t.datetime "updated_at",        :null => false
@@ -55,6 +57,22 @@ ActiveRecord::Schema.define(:version => 1) do
     t.datetime "created_at",        :null => false
     t.datetime "updated_at",        :null => false
   end
+
+  create_table "staplers", :force => true do |t|
+    t.string "name"
+    t.string "type"
+    t.integer "attribute_set_id"
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
+
+  create_table "swingline_stapler_attribute_sets", :force => true do |t|
+    t.float "speed"
+    t.string "owner"
+
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
 end
 
 class Product < ::ActiveRecord::Base
@@ -76,10 +94,12 @@ end
 
 class Message < ::ActiveRecord::Base
   include ::Trax::Model
-  include ::Trax::Model::Freezable
 
   defaults :uuid_prefix => "3a", :uuid_column => "uuid"
 
+  mixins :freezable => true,
+         :restorable => { :field => :deleted }
+
   enum :status => [:queued, :scheduled, :delivered, :failed_delivery]
 
   default_value_for :status do
@@ -88,7 +108,7 @@ class Message < ::ActiveRecord::Base
 
   validates :deliver_at, :future => true, :allow_nil => true
 
-  freezable_by_enum :status => [:delivered, :failed_delivery]
+  freezable_by_enum :status => [ :delivered, :failed_delivery ]
 end
 
 class Thing < ::ActiveRecord::Base
@@ -102,3 +122,14 @@ class Person < ::ActiveRecord::Base
 
   defaults :uuid_column => "uuid"
 end
+
+class Stapler < ::ActiveRecord::Base
+  include ::Trax::Model
+end
+
+class SwinglineStapler < ::Stapler
+  include ::Trax::Model::STI::Attributes
+end
+
+class SwinglineStaplerAttributeSet < ::ActiveRecord::Base
+end

data/spec/trax/model/restorable_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ::Trax::Model::Restorable do
+  subject{ ::Message.create(:title => "Whatever") }
+
+  its(:deleted) { should be false }
+
+  context "when destroyed" do
+    it "should soft delete" do
+      subject.destroy
+      subject.deleted.should be true
+    end
+
+    it "should be restorable" do
+      subject.destroy
+      subject.restore
+      subject.deleted.should be false
+    end
+  end
+
+  context "scopes" do
+    subject{ ::Message.create(:title => "My Message") }
+
+    context ".default_scope" do
+      it { Message.all.where_values_hash["deleted"].should eq false }
+
+      it do
+        subject
+        Message.all.pluck(:id).should include(subject.id)
+      end
+
+      it do
+        subject.destroy
+        Message.all.pluck(:id).should_not include(subject.id)
+      end
+    end
+
+    it ".by_is_deleted" do
+      subject.destroy
+      binding.pry
+      Message.by_is_deleted.pluck(:id).should include(subject.id)
+    end
+  end
+end

data/spec/trax/model/sti/attributes_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ::Trax::Model::STI::Attributes do
+
+  before do
+    SwinglineStapler.sti_attribute(:owner)
+  end
+
+  context "delegation" do
+    subject{ ::SwinglineStapler.new(:owner => "Milton Waddums") }
+
+    its(:owner) { should eq "Milton Waddums" }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trax_model
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trax_core
@@ -284,11 +284,15 @@ files:
 - lib/trax/model/errors.rb
 - lib/trax/model/freezable.rb
 - lib/trax/model/matchable.rb
+- lib/trax/model/mixin.rb
 - lib/trax/model/mti.rb
 - lib/trax/model/mti/abstract.rb
 - lib/trax/model/mti/entity.rb
 - lib/trax/model/mti/namespace.rb
 - lib/trax/model/registry.rb
+- lib/trax/model/restorable.rb
+- lib/trax/model/sti.rb
+- lib/trax/model/sti/attributes.rb
 - lib/trax/model/unique_id.rb
 - lib/trax/model/uuid.rb
 - lib/trax/model/uuid_prefix.rb
@@ -308,6 +312,8 @@ files:
 - spec/trax/model/freezable_spec.rb
 - spec/trax/model/matchable_spec.rb
 - spec/trax/model/registry_spec.rb
+- spec/trax/model/restorable_spec.rb
+- spec/trax/model/sti/attributes_spec.rb
 - spec/trax/model/unique_id_spec.rb
 - spec/trax/model/uuid_prefix_spec.rb
 - spec/trax/model/uuid_spec.rb
@@ -338,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Higher level ActiveRecord models for rails
@@ -350,6 +356,8 @@ test_files:
 - spec/trax/model/freezable_spec.rb
 - spec/trax/model/matchable_spec.rb
 - spec/trax/model/registry_spec.rb
+- spec/trax/model/restorable_spec.rb
+- spec/trax/model/sti/attributes_spec.rb
 - spec/trax/model/unique_id_spec.rb
 - spec/trax/model/uuid_prefix_spec.rb
 - spec/trax/model/uuid_spec.rb