activerecord-traits 1.0.0

data/lib/traits/concerns/association/macro.rb

@@ -0,0 +1,43 @@
+module Traits
+  class Association
+    module Macro
+      delegate :macro, to: :reflection
+
+      def short_macro
+        habtm? ? :habtm : macro
+      end
+
+      def has_and_belongs_to_many?
+        macro == :has_and_belongs_to_many
+      end
+
+      alias habtm? has_and_belongs_to_many?
+
+      def has_many?
+        macro == :has_many
+      end
+
+      def has_one?
+        macro == :has_one
+      end
+
+      def belongs_to?
+        macro == :belongs_to
+      end
+
+      def to_many?
+        has_and_belongs_to_many? || has_many?
+      end
+
+      alias collection? to_many?
+
+      def to_one?
+        belongs_to? || has_one?
+      end
+
+      def to_hash
+        super.merge!(macro: macro, collection: collection?)
+      end
+    end
+  end
+end

data/lib/traits/concerns/association/members.rb

@@ -0,0 +1,35 @@
+module Traits
+  class Association
+    module Members
+      def from
+        @from_class.traits
+      end
+
+      # Returns the actual association establisher class
+      def from_class
+        @from_class
+      end
+
+      # Returns the actual associated class
+      def to
+        reflection.klass.traits unless polymorphic?
+      end
+
+      def to_class
+        reflection.klass unless polymorphic?
+      end
+
+      def self_to_self?
+        from_class == to_class
+      end
+
+      def to_hash
+        super.merge!(
+          from:         from.name,
+          to:           to.try(:name),
+          self_to_self: self_to_self?
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/association/naming.rb

@@ -0,0 +1,15 @@
+module Traits
+  class Association
+    module Naming
+      delegate :name, to: :reflection
+
+      def plural_name
+        reflection.plural_name.to_sym
+      end
+
+      def to_hash
+        super.merge!(name: name, plural_name: plural_name)
+      end
+    end
+  end
+end

data/lib/traits/concerns/association/polymorphism.rb

@@ -0,0 +1,118 @@
+module Traits
+  class Association
+    module Polymorphism
+      # class Picture
+      #   belongs_to :imageable, polymorphic: true
+      #
+      # class Toy
+      #   has_one :picture, as: :imageable
+      #
+      # picture_traits.associations[:imageable].polymorphic?  => true
+      # toy_traits.associations[:picture].polymorphic?        => false
+      #
+      def polymorphic?
+        belongs_to? && reflection.options[:polymorphic] == true
+      end
+
+      alias accepts_various_classes? polymorphic?
+
+      # Example 1:
+      #   class Picture
+      #     belongs_to :imageable, polymorphic: true
+      #
+      #   class Toy
+      #     has_one :picture, as: :imageable
+      #
+      #   picture_traits.associations[:imageable].accepted_classes_through_polymorphism
+      #     => [Toy]
+      #
+      #   toy_traits.associations[:picture].accepted_classes_through_polymorphism
+      #     => nil
+      #
+      # Example 2:
+      #   class Picture
+      #     belongs_to :imageable, polymorphic: true
+      #
+      #   class Present
+      #     has_one :picture, as: :imageable
+      #
+      #   class Toy < Present
+      #   class VideoGame < Present
+      #   class Car < Present
+      #
+      #   picture_traits.associations[:imageable].accepted_classes_through_polymorphism
+      #     => [Car, Present, Toy, VideoGame]
+      #
+      # Note that items in list are sorted by class name
+      #
+      def accepted_classes_through_polymorphism
+        if polymorphic?
+          classes     = []
+          attr_name   = attribute_name_for_polymorphic_type
+          this_class  = from_class
+
+          Traits.active_record_descendants.each do |model_class|
+            # Skip current model and models which are STI derived
+            next if model_class <= this_class # Means is or derived from current model
+
+            model_class.traits.associations.each do |assoc|
+              if assoc.attribute_name_for_polymorphic_type == attr_name
+                classes << assoc.from_class
+              end
+            end
+          end
+          classes.uniq.sort! { |l, r| l.to_s <=> r.to_s  }
+        end
+      end
+
+      # class Picture
+      #   belongs_to :imageable, polymorphic: true
+      #
+      # class Toy
+      #   has_one :picture, as: :imageable
+      #
+      # picture_traits.associations[:imageable].paired_through_polymorphism?  => false
+      # toy_traits.associations[:picture].paired_through_polymorphism?        => true
+      #
+      def paired_through_polymorphism?
+        reflection.type.present?
+      end
+
+      # class Picture
+      #   belongs_to :imageable, polymorphic: true
+      #
+      # class Toy
+      #   has_one :picture, as: :imageable
+      #
+      # picture_traits.associations[:imageable].polymorphic_type_attribute_name => :imageable_type
+      # toy_traits.associations[:picture].polymorphic_type_attribute_name       => :imageable_type
+      #
+      def attribute_name_for_polymorphic_type
+        if polymorphic?
+          reflection.foreign_type.to_sym
+        elsif paired_through_polymorphism?
+          reflection.type.to_sym
+        end
+      end
+
+      def attribute_for_polymorphic_type
+        if polymorphic?
+          from.attributes[attribute_for_polymorphic_type]
+        elsif paired_through_polymorphism?
+          to.attributes[reflection.foreign_type]
+        end
+      end
+
+      def to_hash
+        accepted_classes = accepted_classes_through_polymorphism
+        super.merge!(
+          polymorphic:                  polymorphic?,
+          paired_through_polymorphism:  paired_through_polymorphism?,
+
+          attribute_name_for_polymorphic_type:   attribute_name_for_polymorphic_type,
+          accepted_classes_through_polymorphism: accepted_classes.try(:map) { |el| el.traits.name }
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/association/read_only.rb

@@ -0,0 +1,17 @@
+module Traits
+  class Association
+    module ReadOnly
+      def mutable?
+        !through? || source_association.macro == :belongs_to
+      end
+
+      def readonly?
+        not mutable?
+      end
+
+      def to_hash
+        super.merge!(mutable: mutable?)
+      end
+    end
+  end
+end

data/lib/traits/concerns/association/through.rb

@@ -0,0 +1,72 @@
+module Traits
+  class Association
+    module Through
+      def through?
+        reflection.through_reflection.present?
+      end
+
+      def through
+        if through?
+          reflection.through_reflection.klass.traits
+        end
+      end
+
+      def through_class
+        if through?
+          through.active_record
+        end
+      end
+
+      def through_association
+        if through?
+          from.associations[reflection.through_reflection.name]
+        end
+      end
+
+      def source_association
+        if through?
+          through.associations[reflection.source_reflection.name]
+        end
+      end
+
+      def source_association_name
+        source_association.try(:name)
+      end
+
+      def through_association_name
+        if through?
+          through_association.name
+        end
+      end
+
+      def through_table_name
+        if through?
+          through_association.to_table_name
+        end
+      end
+
+      def through_to_key_name
+        if through?
+          through_association.to_key_name
+        end
+      end
+
+      def through_from_key_name
+        if through?
+          source_association.from_key_name
+        end
+      end
+
+      def to_hash
+        super.merge!(
+          through:               through.try(:name),
+          through_association:   through_association_name,
+          source_association:    source_association_name,
+          through_table_name:    through_table_name,
+          through_to_key_name:   through_to_key_name,
+          through_from_key_name: through_from_key_name
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/essay_shortcuts.rb

@@ -0,0 +1,9 @@
+module Traits
+  class Attribute
+    module EssayShortcuts
+      def features
+        model_class.attribute_features[name]
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/key.rb

@@ -0,0 +1,38 @@
+module Traits
+  class Attribute
+    module Key
+      def primary_key?
+        column_definition.try(:primary) ||
+          model_class.primary_key == column_definition.name ||
+          type == :primary_key
+      end
+
+      def foreign_key?
+        attr_name       = name
+        attr_translates = model_class.attribute_features[attr_name].translates_with_globalize?
+
+        model.associations.any? do |assoc|
+          if assoc.belongs_to?
+            if attr_translates && assoc.features.translates_with_globalize?
+              assoc.features.globalize_translatable.translation_from_key_name == attr_name
+            else
+              assoc.from_key_name == attr_name
+            end
+          end
+        end
+      end
+
+      def key?
+        primary_key? || foreign_key? || polymorphic_key?
+      end
+
+      def to_hash
+        super.merge!(
+          key:         key?,
+          primary_key: primary_key?,
+          foreign_key: foreign_key?
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/naming.rb

@@ -0,0 +1,20 @@
+module Traits
+  class Attribute
+    module Naming
+      def name
+        column_definition.name.to_sym
+      end
+
+      def quoted_name
+        model_class.connection.quote_column_name(name)
+      end
+
+      def to_hash
+        super.merge!(
+          name:        name,
+          quoted_name: quoted_name
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/polymorphism.rb

@@ -0,0 +1,28 @@
+module Traits
+  class Attribute
+    module Polymorphism
+      def polymorphic_key?
+        model.associations
+          .first_where(
+            polymorphic?:  true,
+            from_key_name: name
+          ).present?
+      end
+
+      def polymorphic_type?
+        model.associations
+          .first_where(
+            polymorphic?:                        true,
+            attribute_name_for_polymorphic_type: name
+          ).present?
+      end
+
+      def to_hash
+        super.merge!(
+          polymorphic_key:  polymorphic_key?,
+          polymorphic_type: polymorphic_type?
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/querying.rb

@@ -0,0 +1,14 @@
+module Traits
+  class Attribute
+    module Querying
+      def arel
+        table = if features.translates_with_globalize?
+          model_class.features.globalize.translation_model_class.arel_table
+        else
+          model.arel
+        end
+        table[name]
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/sti.rb

@@ -0,0 +1,15 @@
+module Traits
+  class Attribute
+    module STI
+      def sti_type?
+        (model.sti_base? || model.sti_derived?) and name == model.sti_attribute_name
+      end
+
+      def to_hash
+        super.merge!(
+          sti_type: sti_type?
+        )
+      end
+    end
+  end
+end

data/lib/traits/concerns/attribute/type.rb

@@ -0,0 +1,59 @@
+module Traits
+  class Attribute
+    module Type
+      def type
+        column_definition.type.to_sym
+      end
+
+      def string?
+        type == :string
+      end
+
+      def text?
+        type == :text
+      end
+
+      def binary?
+        type == :binary
+      end
+
+      def big?
+        text? || binary?
+      end
+
+      def integer?
+        type == :integer
+      end
+
+      def float?
+        type == :float
+      end
+
+      def decimal?
+        type == :decimal
+      end
+
+      def real?
+        float? || decimal?
+      end
+
+      def number?
+        integer? || float? || decimal?
+      end
+
+      def datetime?
+        type == :datetime
+      end
+
+      def active_record_timestamp?
+        datetime? && (name == :created_at || name == :updated_at || name == :deleted_at)
+      end
+
+      def to_hash
+        super.merge!(
+          type: type
+        )
+      end
+    end
+  end
+end