activerecord-traits 1.0.0

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

@@ -0,0 +1,9 @@
+module Traits
+  class Model
+    module EssayShortcuts
+      def features
+        model_class.features
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Traits
+  class Model
+    module Naming
+      # class User
+      #   name => user
+      #
+      # class Assets::Photo
+      #   name => assets/photo
+      #
+      def name
+        # Rails 4.1 doesn't support nested acronyms
+        #
+        # Rails 4.1 behaviour:
+        # 'Helpers::ViewHelper'.underscore  => 'helpers/view_helper'  - good
+        # 'CIHelper'.underscore             => 'ci_helper'            - good
+        # 'Helpers::CIHelper'               => 'helpers/ci_helper'    - good
+        #
+        # 'Helpers::ViewHelper'             => 'helpers/view_helper'  - good
+        # 'CIHelper'                        => 'cihelper'             - good
+        # 'Helpers::CIHelper'               => 'helpers/ci_helper'    - bad!
+        #
+        # Newer Rails behaviour:
+        # 'Helpers::ViewHelper'             => 'helpers/view_helper'  - good
+        # 'CIHelper'                        => 'cihelper'             - good
+        # 'Helpers::CIHelper'               => 'helpers/cihelper'     - good
+        #
+        @name ||= model_class.name.split('::').map(&:underscore).join('/')
+      end
+
+      # class User
+      #   plural_name => users
+      #
+      # class Assets::Photo
+      #   plural_name => assets/photos
+      #
+      def plural_name
+        @plural_name ||= name.pluralize
+      end
+
+      # class User
+      #   resource_name => users
+      #
+      # class Assets::Photo
+      #   resource_name => assets/photos
+      #
+      def resource_name
+        @resource_name ||= plural_name
+      end
+
+      # class User
+      #   class_name => User
+      #
+      # class Assets::Photo
+      #   class_name => Assets::Photo
+      #
+      def class_name
+        @class_name ||= model_class.name
+      end
+
+      # class User
+      #   lookup_name => User
+      #   lookup_name(:underscore) => user
+      #
+      # class Assets::Photo
+      #   lookup_name => AssetsPhoto
+      #   lookup_name(:underscore) => assets_photo
+      #
+      def lookup_name(namecase = :class)
+        namecase == :underscore ? name.gsub('/', '_') : class_name.gsub('::', '')
+      end
+
+      def to_hash
+        super.merge!(
+          name:          name,
+          plural_name:   plural_name,
+          class_name:    class_name,
+          lookup_name:   lookup_name,
+          resource_name: resource_name
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Traits
+  class Model
+    module Polymorphism
+      def polymorphic_type
+        model_class.base_class.name.to_sym
+      end
+
+      def to_hash
+        super.merge!(
+          polymorphic_type: polymorphic_type
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Traits
+  class Model
+    module Querying
+      def primary_key_name
+        model_class.primary_key.to_sym
+      end
+
+      def arel
+        model_class.arel_table
+      end
+
+      def connection
+        model_class.connection
+      end
+
+      def table_name
+        model_class.table_name
+      end
+
+      def quoted_table_name
+        connection.quote_table_name(model_class.table_name)
+      end
+
+      def to_hash
+        super.merge!(
+          table_name:        table_name,
+          quoted_table_name: quoted_table_name,
+          polymorphic_type:  polymorphic_type,
+          primary_key_name:  primary_key_name
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Traits
+  class Model
+    module STI
+      def uses_sti?
+        sti_base? || sti_derived?
+      end
+
+      def sti_base?
+        model_class.descends_from_active_record? && model_class.subclasses.any? do |subclass|
+          subclass.superclass == model_class
+        end
+      end
+
+      def sti_derived?
+        !model_class.descends_from_active_record?
+      end
+
+      def sti_attribute_name
+        model_class.inheritance_column.to_sym
+      end
+
+      def sti_chain
+        model_class = self.model_class
+        chain       = [model_class]
+        until model_class.superclass == ActiveRecord::Base do
+          model_class = model_class.superclass
+          chain.unshift(model_class)
+        end
+        chain
+      end
+
+      def to_hash
+        super.merge!(
+          sti_base:           sti_base?,
+          sti_derived:        sti_derived?,
+          sti_attribute_name: sti_attribute_name
+        )
+      end
+    end
+  end
+end

data/lib/traits/descendants_listing.rb

@@ -0,0 +1,51 @@
+module Traits
+  module DescendantsListing
+    def active_record_descendants_loaded?
+      !!@ar_descendants
+    end
+
+    def load_active_record_descendants!
+      # 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! }
+      Rails.application.eager_load!
+    end
+
+    def invalidate_loaded_active_record_descendants!
+      @ar_descendants = nil
+    end
+
+    def active_record_descendants
+      @ar_descendants ||= begin
+        load_active_record_descendants!
+        descendants = ActiveRecord::Base.descendants
+
+        descendants.reject! { |ar| excluded_active_record_descendant?(ar) }
+        descendants
+      end
+    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
+          else false
+        end
+      end
+    end
+  end
+
+  extend DescendantsListing
+
+  # TODO Give a better name
+  mattr_accessor :rules_for_excluding_active_records
+
+  self.rules_for_excluding_active_records = [
+    'Globalize::ActiveRecord::Translation',
+    'ActiveRecord::SchemaMigration',
+    /\AHABTM/,
+    /::Translation\Z/
+  ]
+end

data/lib/traits/engine.rb

@@ -0,0 +1,13 @@
+module Traits
+  class Engine < Rails::Engine
+    isolate_namespace Traits
+
+    config.before_initialize do |app|
+      unless app.config.cache_classes
+        ActionDispatch::Reloader.to_prepare do
+          Traits.invalidate_loaded_active_record_descendants!
+        end
+      end
+    end
+  end
+end

data/lib/traits/list.rb

@@ -0,0 +1,52 @@
+module Traits
+  class List
+    include Enumerable
+
+    def initialize(list = [])
+      @list = list
+    end
+
+    def filter(hash)
+      select do |attr|
+        hash.all? do |method, expected|
+          returned = attr.send(method)
+          if expected.is_a?(Array)
+            expected.include?(returned)
+          else
+            returned == expected
+          end
+        end
+      end
+    end
+
+    def first_where(hash)
+      find do |attr|
+        hash.all? do |method, expected|
+          returned = attr.send(method)
+          if expected.is_a?(Array)
+            expected.include?(returned)
+          else
+            returned == expected
+          end
+        end
+      end
+    end
+
+    def [](arg)
+      by_name(arg)
+    end
+
+    def each(&block)
+      @list.each(&block)
+    end
+
+    def by_name(name)
+      name = name.to_s.to_sym
+      find { |attr| attr.name == name }
+    end
+
+    def to_hash
+      each_with_object({}) { |item, memo| memo[item.name] = item.to_hash }
+    end
+  end
+end

data/lib/traits/model.rb

@@ -0,0 +1,78 @@
+module Traits
+  class Model < Base
+  end
+end
+
+require 'traits/concerns/model/naming'
+require 'traits/concerns/model/polymorphism'
+require 'traits/concerns/model/sti'
+require 'traits/concerns/model/querying'
+require 'traits/concerns/model/essay_shortcuts'
+
+module Traits
+  class Model
+    include Naming
+    include STI
+    include Polymorphism
+    include Querying
+    include EssayShortcuts
+
+    attr_reader :model_class
+
+    alias active_record model_class
+    alias klass         model_class
+
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    def attributes
+      @attributes ||= inspect_attributes
+    end
+
+    def associations
+      @associations ||= inspect_associations
+    end
+
+    def to_s
+      class_name
+    end
+
+    def to_hash
+      super.merge!(
+        attributes:   attributes.to_hash,
+        associations: associations.to_hash
+      )
+    end
+
+  protected
+
+    # TODO Store, Storage, Virtual attributes
+    def inspect_attributes
+      columns = model_class.columns_hash.values
+
+      if features.translates_with_globalize?
+        globalize       = features.globalize
+        tr_class        = globalize.model_class_for_translations
+        tr_columns_hash = tr_class.columns_hash
+
+        columns += globalize.translated_attribute_names.map do |el|
+          tr_columns_hash[el.to_s]
+        end
+      end
+
+      list = columns.map do |column|
+        Traits::Attribute.new(model_class, column)
+      end
+
+      Traits::List.new(list)
+    end
+
+    def inspect_associations
+      list = model_class.reflections.map do |pair|
+        Traits::Association.new(model_class, pair.last)
+      end
+      Traits::List.new(list)
+    end
+  end
+end

data/lib/traits/utilities.rb

@@ -0,0 +1,37 @@
+module Traits
+  class UnidentifiedModelReference < StandardError
+  end
+
+  module Utilities
+    def retrieve_model_class(obj)
+      if active_record_descendant?(obj)
+        obj
+
+      elsif active_record_instance?(obj)
+        obj.class
+
+      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
+        end
+      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)
+    end
+
+    def valid_active_record_identifier?(id)
+      id.kind_of?(String) || id.kind_of?(Numeric)
+    end
+  end
+
+  extend Utilities
+end

data/lib/traits/version.rb

@@ -0,0 +1,3 @@
+module Traits
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-traits
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yaroslav Konoplov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: essay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: essay-globalize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: essay-carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Type information of ActiveRecord models, attributes and associations
+email:
+- yaroslav@inbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-traits.gemspec
+- lib/activerecord-traits.rb
+- lib/traits/association.rb
+- lib/traits/attribute.rb
+- lib/traits/base.rb
+- lib/traits/concerns/association/essay_shortcuts.rb
+- lib/traits/concerns/association/intermediate.rb
+- lib/traits/concerns/association/join.rb
+- lib/traits/concerns/association/macro.rb
+- lib/traits/concerns/association/members.rb
+- lib/traits/concerns/association/naming.rb
+- lib/traits/concerns/association/polymorphism.rb
+- lib/traits/concerns/association/read_only.rb
+- lib/traits/concerns/association/through.rb
+- lib/traits/concerns/attribute/essay_shortcuts.rb
+- lib/traits/concerns/attribute/key.rb
+- lib/traits/concerns/attribute/naming.rb
+- lib/traits/concerns/attribute/polymorphism.rb
+- lib/traits/concerns/attribute/querying.rb
+- lib/traits/concerns/attribute/sti.rb
+- lib/traits/concerns/attribute/type.rb
+- lib/traits/concerns/model/essay_shortcuts.rb
+- lib/traits/concerns/model/naming.rb
+- lib/traits/concerns/model/polymorphism.rb
+- lib/traits/concerns/model/querying.rb
+- lib/traits/concerns/model/sti.rb
+- lib/traits/descendants_listing.rb
+- lib/traits/engine.rb
+- lib/traits/list.rb
+- lib/traits/model.rb
+- lib/traits/utilities.rb
+- lib/traits/version.rb
+homepage: http://github.com/yivo/activerecord-traits
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Type information of ActiveRecord models, attributes and associations
+test_files: []