activerecord-traits 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c19a931c6cf49fc903d0a26157fcee1e76c71115
+  data.tar.gz: 572102c9adbf4c8e0a751e9b18cdaac4bfb40620
+SHA512:
+  metadata.gz: ef3f143af6c3ec68b3f6c92102b4a581b2b60dc6b32a7a8e4eed0359c3e53b8e337026c699fc33715aad29f0b61ba9a0fa5bd90bb32d3bf35cd97667c68ad787
+  data.tar.gz: 6e6c4af699dd5e632e07e31c37c1d7f744722ad4f4879f120da471390a6a6a4c6f79ab19e91238f339d2026b60201b4e5750dc96e7c0abe9d1c633fc4b903d12

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in confo.gemspec
+gemspec
+
+gem 'essay', path: '~/Development/essay'
+gem 'essay-globalize', path: '~/Development/essay-globalize'
+gem 'essay-carrierwave', path: '~/Development/essay-carrierwave'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Yaroslav Konoplov
+
+MIT License
+
+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/README.md

@@ -0,0 +1,62 @@
+# ActiveRecord Type Traits
+
+##### This library provides a series of classes to obtain type information of ActiveRecord models, attributes and associations.
+This library is focused only on standard ActiveRecord features and will not provide information for ActiveRecord plugins such as Globalize, CarrierWave, Paranoid and others.
+
+API design is done in good and clear manner for best understanding.
+
+**All base ActiveRecord features are supported.**
+
+**Supported advanced ActiveRecord features:**
+
+ 1. `has_many`, `has_one`, `has_and_belongs_to_many`, `belongs_to` associations
+ 2. Intermediate and through (deep) associations
+ 3. Polymorphic associations
+ 4. Single Table Inheritance
+ 5. SQL Join metadata
+
+## Example of usage
+```ruby
+
+  class Author < ActiveRecord::Base
+    has_many :articles
+    has_one :photo, as: :imageable
+  end
+
+  class Article < ActiveRecord::Base
+    belongs_to :author
+  end
+  
+  class Photo
+    belongs_to :imageable, polymorphic: true
+  end
+
+  Author.traits.associations[:articles].has_many?                    # => true
+  Author.traits.associations[:articles].to_class                     # => Article
+  Author.traits.associations[:articles].paired_through_polymorphism? # => true
+  
+  Photo.traits.associations[:imageable].polymorphic?                          # => true
+  Photo.traits.associations[:imageable].accepted_classes_through_polymorphism # => [Author]
+  Photo.traits.attributes[:imageable_type].polymorphic_type?                  # => true
+  
+  Article.traits.attributes[:author_id].foreign_key?                          # => true 
+  
+  class Present < ActiveRecord::Base
+  end
+  
+  class Toy < Present
+  end
+  
+  class VideoGame < Present
+  end
+  
+  Present.traits.sti_base? # => true
+  Toy.traits.sti_derived?  # => true
+  Toy.traits.sti_chain     # => [Present, Toy]
+  
+```
+
+## Gemfile
+```ruby
+gem 'activerecord-traits', github: 'yivo/activerecord-traits'
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/activerecord-traits.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require File.expand_path('../lib/traits/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name            = 'activerecord-traits'
+  s.version         = Traits::VERSION
+  s.authors         = ['Yaroslav Konoplov']
+  s.email           = ['yaroslav@inbox.com']
+  s.summary         = 'Type information of ActiveRecord models, attributes and associations'
+  s.description     = 'Type information of ActiveRecord models, attributes and associations'
+  s.homepage        = 'http://github.com/yivo/activerecord-traits'
+  s.license         = 'MIT'
+
+  s.executables     = `git ls-files -z -- bin/*`.split("\x0").map{ |f| File.basename(f) }
+  s.files           = `git ls-files -z`.split("\x0")
+  s.test_files      = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
+  s.require_paths   = ['lib']
+
+  s.add_dependency 'activesupport', '>= 3.2.0'
+  s.add_dependency 'activerecord', '>= 3.2.0'
+  s.add_dependency 'essay', '~> 1.0.0'
+  s.add_dependency 'essay-globalize', '~> 1.0.0'
+  s.add_dependency 'essay-carrierwave', '~> 1.0.0'
+end

data/lib/activerecord-traits.rb

@@ -0,0 +1,44 @@
+require 'active_support/all'
+require 'active_record'
+require 'essay'
+require 'essay-globalize'
+require 'essay-carrierwave'
+
+require 'traits/engine'
+require 'traits/utilities'
+require 'traits/descendants_listing'
+require 'traits/base'
+require 'traits/attribute'
+require 'traits/association'
+require 'traits/model'
+require 'traits/list'
+
+class ActiveRecord::Base
+  def self.traits
+    @traits ||= Traits::Model.new(self)
+  end
+end
+
+module Traits
+  extend Enumerable
+
+  def self.for(obj)
+    retrieve_model_class(obj).traits
+  end
+
+  def self.each(&block)
+    active_record_descendants.each { |ar| block.call(ar.traits) }
+  end
+
+  def self.all
+    each_with_object({}) do |traits, memo|
+      memo[traits.name] = traits
+    end
+  end
+
+  def self.to_hash
+    each_with_object({}) do |traits, memo|
+      memo[traits.name] = traits.to_hash
+    end
+  end
+end

data/lib/traits/association.rb

@@ -0,0 +1,39 @@
+module Traits
+  class Association < Base
+  end
+end
+
+require 'traits/concerns/association/intermediate'
+require 'traits/concerns/association/join'
+require 'traits/concerns/association/macro'
+require 'traits/concerns/association/members'
+require 'traits/concerns/association/naming'
+require 'traits/concerns/association/polymorphism'
+require 'traits/concerns/association/read_only'
+require 'traits/concerns/association/through'
+require 'traits/concerns/association/essay_shortcuts'
+
+module Traits
+  class Association
+    include Members
+    include Naming
+    include Macro
+    include Intermediate
+    include Through
+    include Join
+    include ReadOnly
+    include Polymorphism
+    include EssayShortcuts
+
+    attr_reader :reflection
+
+    def initialize(model_class, reflection)
+      @from_class = model_class
+      @reflection = reflection
+    end
+
+    def to_s
+      "#{from.class_name}##{name}"
+    end
+  end
+end

data/lib/traits/attribute.rb

@@ -0,0 +1,52 @@
+module Traits
+  class Attribute < Base
+  end
+end
+
+require 'traits/concerns/attribute/key'
+require 'traits/concerns/attribute/naming'
+require 'traits/concerns/attribute/polymorphism'
+require 'traits/concerns/attribute/querying'
+require 'traits/concerns/attribute/sti'
+require 'traits/concerns/attribute/type'
+require 'traits/concerns/attribute/essay_shortcuts'
+
+module Traits
+  class Attribute
+    include Key
+    include Naming
+    include Type
+    include Polymorphism
+    include Querying
+    include STI
+    include EssayShortcuts
+
+    attr_reader :model_class, :column_definition
+
+    def initialize(model_class, column_definition)
+      @model_class       = model_class
+      @column_definition = column_definition
+    end
+
+    def model
+      model_class.traits
+    end
+
+    # TODO Remove this
+    def regular?
+      !(key? || sti_type? || polymorphic_type? || active_record_timestamp?)
+    end
+
+    def validators
+      model_class.validators_on(name)
+    end
+
+    def value_from(model_instance)
+      model_instance[name]
+    end
+
+    def to_s
+      "#{model}##{name}"
+    end
+  end
+end

data/lib/traits/base.rb

@@ -0,0 +1,7 @@
+module Traits
+  class Base
+    def to_hash
+      {}
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Traits
+  class Association
+    module EssayShortcuts
+      def features
+        from_class.association_features[name]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Traits
+  class Association
+    module Intermediate
+      # class Person
+      #   has_and_belongs_to_many :groups
+      #
+      # person_traits.associations[:groups].intermediate? => true
+      #
+      def intermediate?
+        has_and_belongs_to_many?
+      end
+
+      def intermediate_table
+        if intermediate?
+          Arel::Table.new(reflection.join_table)
+        end
+      end
+
+      def intermediate_table_name
+        if intermediate?
+          reflection.join_table
+        end
+      end
+
+      def intermediate_to_key
+        intermediate_table.try(:[], intermediate_to_key_name)
+      end
+
+      def intermediate_to_key_name
+        if intermediate?
+          reflection.foreign_key.to_sym
+        end
+      end
+
+      def intermediate_from_key
+        intermediate_table.try(:[], intermediate_from_key_name)
+      end
+
+      def intermediate_from_key_name
+        if intermediate?
+          reflection.association_foreign_key.to_sym
+        end
+      end
+
+      def to_hash
+        super.merge!(
+          intermediate:               intermediate?,
+          intermediate_table_name:    intermediate_table_name,
+          intermediate_to_key_name:   intermediate_to_key_name,
+          intermediate_from_key_name: intermediate_from_key_name
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module Traits
+  class Association
+    module Join
+      def from_table
+        from.arel
+      end
+
+      def from_table_name
+        from_table.name.to_sym
+      end
+
+      def from_table_alias
+        from_table.table_alias.try(:to_sym)
+      end
+
+      def from_key
+        from_table[from_key_name]
+      end
+
+      def from_key_name
+        if polymorphic?
+          reflection.foreign_key.to_sym
+
+        elsif through?
+          through_association.from_key_name
+
+        elsif features.translates_with_globalize?
+          nil
+
+        elsif belongs_to?
+          reflection.foreign_key.to_sym
+
+        end || reflection.active_record_primary_key.to_sym
+      end
+
+      def to_table
+        unless polymorphic?
+          table = to.arel.clone
+          if self_to_self?
+            table.table_alias = "#{plural_name}_#{from.table_name}"
+          end
+          table
+        end
+      end
+
+      def to_table_name
+        unless polymorphic?
+          to_table.name.to_sym
+        end
+      end
+
+      def to_table_alias
+        unless polymorphic?
+          to_table.table_alias.try(:to_sym)
+        end
+      end
+
+      def to_key
+        to_table.try(:[], to_key_name)
+      end
+
+      def to_key_name
+        unless polymorphic?
+          if through?
+            source_association.to_key_name
+
+          elsif belongs_to? || has_and_belongs_to_many?
+            reflection.association_primary_key.to_sym
+
+          else
+            reflection.foreign_key.to_sym
+          end
+        end
+      end
+
+      def to_hash
+        super.merge!(
+          from_table_name:  from_table_name,
+          from_table_alias: from_table_alias,
+          from_key_name:    from_key_name,
+
+          to_table_name:    to_table_name,
+          to_table_alias:   to_table_alias,
+          to_key_name:      to_key_name
+        )
+      end
+    end
+  end
+end