activerecord-traits 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84c79ad24f867dd858de441a1d0bef4d74c847d2
-  data.tar.gz: 9d312a4e8fff3e8330010e1745c687a6a072ce58
+  metadata.gz: 0bb790119c0be6db1ea5e9c0337b75db99a15ae3
+  data.tar.gz: ee1ed0dcf813732a24347107fe08ad1f5c1485ac
 SHA512:
-  metadata.gz: 2ec766c0c8f9da4fb1b66e35fdc7e0e02d7b11dc02d71255b3363e8af2843afb6cf0645a60a63fe0cb41ce47ad893fbfe4d1ca18981d946a8078678a7d65edcd
-  data.tar.gz: f3c97ed4ccf20b06b485b8d99b6485bca306b3bba31a6717e2e44e53096695bb3ae47597a3c8f0047ed29c247c132f8fe95ee6aa5f3a022dca217827cb3fb8cf
+  metadata.gz: 3c05ab3551ec4447387a98ffe3dbd2a5832776de6d6b7d8e767301524b8a9a5e3f8ad640401d8496576e56efc515c0380aa31b5f4a0ccb93d31afe0cbf910457
+  data.tar.gz: 0972d63b3d70e44d32d5d3024e9767996bee2d618f43277b6e4f83632cf2def2e98613542450839efd60f880182cef96263d0814d82ba91a0e7d9035bbad17e4

data/README.md

@@ -32,7 +32,7 @@ API design is done in good and clear manner for best understanding.
   end
 
   Author.traits.associations[:articles].has_many?                    # => true
-  Author.traits.associations[:articles].to_class                     # => Article
+  Author.traits.associations[:articles].to.active_record             # => Article
   Author.traits.associations[:articles].paired_through_polymorphism? # => true
   
   Photo.traits.associations[:imageable].polymorphic?                          # => true
@@ -50,9 +50,9 @@ API design is done in good and clear manner for best understanding.
   class VideoGame < Present
   end
   
-  Present.traits.sti_base? # => true
-  Toy.traits.sti_derived?  # => true
-  Toy.traits.sti_chain     # => [Present, Toy]
+  Present.traits.inheritance_base? # => true
+  Toy.traits.inheritance_derived?  # => true
+  Toy.traits.inheritance_chain     # => [Present, Toy]
   
 ```
 

data/lib/activerecord-traits.rb

@@ -18,35 +18,39 @@ require 'traits/model'
 require 'traits/list'
 
 class ActiveRecord::Base
-  def self.traits
-    @traits ||= Traits::Model.new(self)
+  class << self
+    def traits
+      @traits ||= Traits::Model.new(self)
+    end
   end
 end
 
 module Traits
   extend Enumerable
 
-  def self.for(obj)
-    retrieve_model_class(obj).traits
-  end
+  class << self
+    def for(obj)
+      retrieve_active_record!(obj).traits
+    end
 
-  def self.each(&block)
-    active_record_descendants.each { |ar| block.call(ar.traits) }
-  end
+    def each
+      active_record_descendants.each { |ar| yield(ar.traits) }
+    end
 
-  def self.all
-    each_with_object({}) do |traits, memo|
-      memo[traits.name] = traits
+    def all
+      each_with_object({}) do |traits, memo|
+        memo[traits.name] = traits
+      end
     end
-  end
 
-  def self.each_attribute(&block)
-    each { |traits| traits.attributes.each(&block) }
-  end
+    def each_attribute(&block)
+      each { |traits| traits.attributes.each(&block) }
+    end
 
-  def self.to_hash
-    each_with_object({}) do |traits, memo|
-      memo[traits.name] = traits.to_hash
+    def to_hash
+      each_with_object({}) do |traits, memo|
+        memo[traits.name] = traits.to_hash
+      end
     end
   end
 end

data/lib/traits/association/essay_shortcuts.rb

@@ -5,7 +5,7 @@ module Traits
   class Association
     module EssayShortcuts
       def features
-        from_class.association_features[name]
+        from_active_record.association_features[name]
       end
     end
   end

data/lib/traits/association/members.rb

@@ -5,12 +5,12 @@ module Traits
   class Association
     module Members
       def from
-        @from_class.traits
+        @from_active_record.traits
       end
 
       # Returns the actual association establisher class
-      def from_class
-        @from_class
+      def from_active_record
+        @from_active_record
       end
 
       # Returns the actual associated class
@@ -18,12 +18,12 @@ module Traits
         reflection.klass.traits unless polymorphic?
       end
 
-      def to_class
+      def to_active_record
         reflection.klass unless polymorphic?
       end
 
       def self_to_self?
-        from_class == to_class
+        from_active_record == to_active_record
       end
 
       def to_hash

data/lib/traits/association/polymorphism.rb

@@ -52,15 +52,15 @@ module Traits
         if polymorphic?
           classes     = []
           attr_name   = attribute_name_for_polymorphic_type
-          this_class  = from_class
+          this_class  = from_active_record
 
-          Traits.active_record_descendants.each do |model_class|
+          Traits.active_record_descendants.each do |active_record|
             # Skip current model and models which are STI derived
-            next if model_class <= this_class # Means is or derived from current model
+            next if active_record <= this_class # Means is or derived from current model
 
-            model_class.traits.associations.each do |assoc|
+            active_record.traits.associations.each do |assoc|
               if assoc.attribute_name_for_polymorphic_type == attr_name
-                classes << assoc.from_class
+                classes << assoc.from_active_record
               end
             end
           end

data/lib/traits/association.rb

@@ -30,9 +30,9 @@ module Traits
 
     attr_reader :reflection
 
-    def initialize(model_class, reflection)
-      @from_class = model_class
-      @reflection = reflection
+    def initialize(active_record, reflection)
+      @from_active_record = active_record
+      @reflection         = reflection
     end
 
     def inspect
@@ -48,7 +48,7 @@ module Traits
     end
 
     def validators
-      from_class.validators_on(name)
+      from_active_record.validators_on(name)
     end
   end
 end

data/lib/traits/attribute/essay_shortcuts.rb

@@ -5,7 +5,7 @@ module Traits
   class Attribute
     module EssayShortcuts
       def features
-        model_class.attribute_features[name]
+        active_record.attribute_features[name]
       end
     end
   end

data/lib/traits/attribute/inheritance.rb

@@ -7,10 +7,9 @@ module Traits
       def inheritance_type?
         (model.inheritance_base? || model.inheritance_derived?) and name == model.inheritance_attribute.name
       end
-      alias sti_type? inheritance_type?
 
       def to_hash
-        super.merge!(is_sti_type: sti_type?)
+        super.merge!(is_inheritance_type: inheritance_type?)
       end
     end
   end

data/lib/traits/attribute/key.rb

@@ -6,13 +6,13 @@ module Traits
     module Key
       def primary_key?
         column_definition.try(:primary) ||
-          model_class.primary_key == column_definition.name ||
+          active_record.primary_key == column_definition.name ||
           type == :primary_key
       end
 
       def foreign_key?
         attr_name       = name
-        attr_translates = model_class.attribute_features[attr_name].try(:translates_with_globalize?)
+        attr_translates = active_record.attribute_features[attr_name].try(:translates_with_globalize?)
 
         model.associations.any? do |assoc|
           if assoc.belongs_to?

data/lib/traits/attribute/naming.rb

@@ -9,7 +9,7 @@ module Traits
       end
 
       def quoted_name
-        @quoted_name ||= model_class.connection.quote_column_name(name)
+        @quoted_name ||= active_record.connection.quote_column_name(name)
       end
 
       def to_hash

data/lib/traits/attribute/querying.rb

@@ -6,7 +6,7 @@ module Traits
     module Querying
       def arel
         table = if features.try(:translates_with_globalize?)
-          model_class.features.globalize.translation_model_class.arel_table
+          active_record.features.globalize.translation_model_class.arel_table
         else
           model.arel
         end

data/lib/traits/attribute.rb

@@ -24,24 +24,24 @@ module Traits
     include Inheritance
     include EssayShortcuts
 
-    attr_reader :model_class, :column_definition
+    attr_reader :active_record, :column_definition
 
-    def initialize(model_class, column_definition)
-      @model_class       = model_class
+    def initialize(active_record, column_definition)
+      @active_record      = active_record
       @column_definition = column_definition
     end
 
     def model
-      model_class.traits
+      active_record.traits
     end
 
     # TODO Remove this
     def regular?
-      !(key? || sti_type? || polymorphic_type? || active_record_timestamp?)
+      !(key? || inheritance_type? || polymorphic_type? || active_record_timestamp?)
     end
 
     def validators
-      model_class.validators_on(name)
+      active_record.validators_on(name)
     end
 
     def value_from(model_instance)

data/lib/traits/descendants_listing.rb

@@ -4,11 +4,11 @@
 module Traits
   module DescendantsListing
     def active_record_descendants_loaded?
-      !!@ar_descendants_loaded
+      !!@active_record_descendants_loaded
     end
 
     def load_active_record_descendants!
-      @ar_descendants_loaded ||= begin
+      @active_record_descendants_loaded ||= begin
         # Railties are not necessary here
         # Source: http://stackoverflow.com/questions/6497834/differences-between-railties-and-engines-in-ruby-on-rails-3
         Rails::Engine.subclasses.map(&:instance).each { |i| i.eager_load! }
@@ -18,23 +18,22 @@ module Traits
     end
 
     def invalidate_loaded_active_record_descendants!
-      @ar_descendants        = nil
-      @ar_descendants_loaded = false
+      @active_record_descendants_loaded = false
     end
 
-    def active_record_descendants
-      @ar_descendants ||= begin
-        load_active_record_descendants!
-        ActiveRecord::Base.descendants.reject! { |ar| excluded_active_record_descendant?(ar) }
-      end
+    def active_record_descendants(filter = true)
+      load_active_record_descendants!
+      ary = ActiveRecord::Base.descendants
+      ary.reject! { |ar| filter_active_record_descendant(ar) } if filter
+      ary
     end
 
-    def excluded_active_record_descendant?(model_class)
-      rules_for_excluding_active_records.any? do |rule|
-        case rule
-          when Regexp then model_class.name =~ rule
-          when String then model_class.name == rule
-          when Class  then model_class == rule
+    def filter_active_record_descendant(active_record)
+      active_record_filters.any? do |filter|
+        case filter
+          when Regexp then active_record.name =~ filter
+          when String then active_record.name == filter
+          when Class  then active_record == filter
           else false
         end
       end
@@ -43,10 +42,9 @@ module Traits
 
   extend DescendantsListing
 
-  # TODO Give a better name
-  mattr_accessor :rules_for_excluding_active_records
+  mattr_accessor :active_record_filters
 
-  self.rules_for_excluding_active_records = [
+  self.active_record_filters = [
     'Globalize::ActiveRecord::Translation',
     'ActiveRecord::SchemaMigration',
     /\AHABTM/,

data/lib/traits/list.rb

@@ -25,6 +25,12 @@ module Traits
       by_name(arg)
     end
 
+    def fetch(name)
+      el = by_name(name)
+      raise StandardError, "#{name.inspect} not found" unless el
+      el
+    end
+
     def each(&block)
       @list.each(&block)
     end

data/lib/traits/model/essay_shortcuts.rb

@@ -5,7 +5,7 @@ module Traits
   class Model
     module EssayShortcuts
       def features
-        model_class.features
+        active_record.features
       end
     end
   end

data/lib/traits/model/inheritance.rb

@@ -7,29 +7,24 @@ module Traits
       def uses_inheritance?
         inheritance_base? || inheritance_derived?
       end
-      alias uses_sti? uses_inheritance?
 
       def inheritance_base?
-        model_class.descends_from_active_record? &&
-          !model_class.abstract_class? &&
-          model_class.subclasses.any? { |subclass| subclass.superclass == model_class }
+        active_record.descends_from_active_record? &&
+          !active_record.abstract_class? &&
+            active_record.subclasses.any? { |subclass| subclass.superclass == active_record }
       end
-      alias sti_base? inheritance_base?
 
       def inheritance_derived?
-        !model_class.descends_from_active_record?
+        !active_record.descends_from_active_record?
       end
-      alias sti_derived? inheritance_derived?
 
       def inheritance_attribute
-        attributes[model_class.inheritance_column]
+        attributes[active_record.inheritance_column]
       end
-      alias sti_attribute inheritance_attribute
 
       def inheritance_attribute_name
         inheritance_attribute.name if uses_inheritance?
       end
-      alias sti_attribute_name inheritance_attribute_name
 
       # class File < ActiveRecord::Base
       # end
@@ -49,15 +44,14 @@ module Traits
       # Portrait.traits.inheritance_chain => [File, Photo, Portrait]
       def inheritance_chain
         Traits.load_active_record_descendants!
-        model_class = self.model_class
-        chain       = [model_class]
-        until model_class.superclass == ActiveRecord::Base do
-          model_class = model_class.superclass
-          chain.unshift(model_class)
+        active_record = self.active_record
+        chain        = [active_record]
+        until active_record.superclass == ActiveRecord::Base do
+          active_record = active_record.superclass
+          chain.unshift(active_record)
         end
         chain
       end
-      alias sti_chain inheritance_chain
 
       def inheritance_base
         inheritance_chain[0]
@@ -65,10 +59,10 @@ module Traits
 
       def to_hash
         super.merge!(
-          is_sti_base:        sti_base?,
-          is_sti_derived:     sti_derived?,
-          sti_attribute_name: sti_attribute_name,
-          sti_chain:          sti_chain.map { |model_class| model_class.traits.name }
+          is_inheritance_base:        inheritance_base?,
+          is_inheritance_derived:     inheritance_derived?,
+          inheritance_attribute_name: inheritance_attribute.try(:name),
+          inheritance_chain:          inheritance_chain.map { |active_record| active_record.traits.name }
         )
       end
     end

data/lib/traits/model/naming.rb

@@ -34,7 +34,7 @@ module Traits
         #  'CIHelper'                        => 'cihelper'             - good
         #  'Helpers::CIHelper'               => 'helpers/cihelper'     - good
         #
-        @name ||= model_class.name.split('::').map(&:underscore).join('/')
+        @name ||= active_record.name.split('::').map(&:underscore).join('/')
         if namecase == :underscore
           @underscore_name ||= @name.tr('/', '_')
         else
@@ -66,7 +66,7 @@ module Traits
       #   class_name => Assets::Photo
       #
       def class_name
-        @class_name ||= model_class.name
+        @class_name ||= active_record.name
       end
 
       # class User

data/lib/traits/model/polymorphism.rb

@@ -5,13 +5,11 @@ module Traits
   class Model
     module Polymorphism
       def polymorphic_type
-        @polymorphic_type ||= model_class.base_class.name.to_sym
+        @polymorphic_type ||= active_record.base_class.name.to_sym
       end
 
       def to_hash
-        super.merge!(
-          polymorphic_type: polymorphic_type
-        )
+        super.merge!(polymorphic_type: polymorphic_type)
       end
     end
   end

data/lib/traits/model/querying.rb

@@ -8,7 +8,7 @@ module Traits
         # Sometimes table doesn't have primary key.
         # This might be many-to-many tables (HABTM).
         @pk_name ||= begin
-          pk = model_class.primary_key
+          pk = active_record.primary_key
           pk.kind_of?(String) ? pk.to_sym : pk
         end
       end
@@ -18,19 +18,19 @@ module Traits
       end
 
       def arel
-        model_class.arel_table
+        active_record.arel_table
       end
 
       def connection
-        model_class.connection
+        active_record.connection
       end
 
       def table_name
-        @table_name ||= model_class.table_name
+        @table_name ||= active_record.table_name
       end
 
       def quoted_table_name
-        @quote_table_name ||= connection.quote_table_name(model_class.table_name)
+        @quote_table_name ||= connection.quote_table_name(active_record.table_name)
       end
 
       def to_hash

data/lib/traits/model.rb

@@ -22,13 +22,10 @@ module Traits
     include EssayShortcuts
     include I18n
 
-    attr_reader :model_class
+    attr_accessor :active_record
 
-    alias active_record model_class
-    alias klass         model_class
-
-    def initialize(model_class)
-      @model_class = model_class
+    def initialize(active_record)
+      @active_record = active_record
     end
 
     def attributes
@@ -59,10 +56,10 @@ module Traits
 
     # TODO Store, Storage, Virtual attributes
     def inspect_attributes
-      if model_class.abstract_class?
+      if active_record.abstract_class?
         Traits::AttributeList.new([])
       else
-        columns = model_class.columns_hash.values
+        columns = active_record.columns_hash.values
 
         if features.try(:translates_with_globalize?)
           globalize       = features.globalize
@@ -75,7 +72,7 @@ module Traits
         end
 
         list = columns.map do |column|
-          Traits::Attribute.new(model_class, column)
+          Traits::Attribute.new(active_record, column)
         end
 
         Traits::AttributeList.new(list)
@@ -83,11 +80,11 @@ module Traits
     end
 
     def inspect_associations
-      if model_class.abstract_class?
+      if active_record.abstract_class?
         Traits::List.new([])
       else
-        list = model_class.reflections.map do |pair|
-          Traits::Association.new(model_class, pair.last)
+        list = active_record.reflections.map do |pair|
+          Traits::Association.new(active_record, pair.last)
         end
         Traits::List.new(list)
       end

data/lib/traits/utilities.rb

@@ -2,39 +2,54 @@
 # frozen_string_literal: true
 
 module Traits
-  class UnidentifiedModelReference < StandardError
-  end
-
   module Utilities
-    def retrieve_model_class(obj)
+    def retrieve_active_record(obj)
       if active_record_descendant?(obj)
         obj
 
       elsif active_record_instance?(obj)
         obj.class
 
+      elsif active_record_collection?(obj)
+        obj.model
+
       else
         case obj
-          when Symbol then obj.to_s.camelize.constantize
-          when String then obj.camelize.constantize
-          when Model  then obj.model_class
-          else raise UnidentifiedModelReference, obj
+          when String, Symbol
+            s = obj.kind_of?(Symbol) ? obj.to_s : obj
+            s.camelize.safe_constantize || s.tr('_', '/').camelize.safe_constantize
+
+          when Traits::Model, Traits::Attribute
+            obj.active_record
+
+          when Traits::Association
+            obj.from_active_record
         end
       end
     end
 
+    def retrieve_active_record!(obj)
+      retrieve_active_record(obj) || begin
+        raise ActiveRecordRetrieveError, "#{obj.inspect} is not a valid ActiveRecord reference"
+      end
+    end
+
     def active_record_descendant?(obj)
       obj.kind_of?(Class) && obj < ActiveRecord::Base
     end
 
-    def active_record_instance?(obj)
-      obj.kind_of?(ActiveRecord::Base)
+    def active_record_collection?(obj)
+      obj.kind_of?(ActiveRecord::Relation)
     end
 
-    def valid_active_record_identifier?(id)
-      id.kind_of?(String) || id.kind_of?(Numeric)
+    def active_record_instance?(obj)
+      obj.kind_of?(ActiveRecord::Base)
     end
   end
 
   extend Utilities
+
+  # TODO Better name
+  class ActiveRecordRetrieveError < StandardError
+  end
 end

data/lib/traits/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Traits
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-traits
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-22 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport