baza_models 0.0.0 → 0.0.1

data/baza_models.gemspec

@@ -0,0 +1,149 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: baza_models 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "baza_models"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["kaspernj"]
+  s.date = "2015-12-30"
+  s.description = "ActiveRecord like models for the Baza database framework"
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rubocop_todo.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "baza_models.gemspec",
+    "config/best_project_practice_rubocop.yml",
+    "config/best_project_practice_rubocop_todo.yml",
+    "lib/baza_models.rb",
+    "lib/baza_models/autoloader.rb",
+    "lib/baza_models/baza_orm_adapter.rb",
+    "lib/baza_models/can_can_adapter.rb",
+    "lib/baza_models/class_translation.rb",
+    "lib/baza_models/errors.rb",
+    "lib/baza_models/model.rb",
+    "lib/baza_models/model/belongs_to_relations.rb",
+    "lib/baza_models/model/custom_validations.rb",
+    "lib/baza_models/model/delegation.rb",
+    "lib/baza_models/model/has_many_relations.rb",
+    "lib/baza_models/model/has_one_relations.rb",
+    "lib/baza_models/model/manipulation.rb",
+    "lib/baza_models/model/queries.rb",
+    "lib/baza_models/model/scopes.rb",
+    "lib/baza_models/model/translation_functionality.rb",
+    "lib/baza_models/model/validations.rb",
+    "lib/baza_models/query.rb",
+    "lib/baza_models/query/inspector.rb",
+    "lib/baza_models/query/not.rb",
+    "lib/baza_models/ransacker.rb",
+    "lib/baza_models/test_database_cleaner.rb",
+    "lib/baza_models/validators/base_validator.rb",
+    "lib/baza_models/validators/confirmation_validator.rb",
+    "lib/baza_models/validators/format_validator.rb",
+    "lib/baza_models/validators/length_validator.rb",
+    "lib/baza_models/validators/presence_validator.rb",
+    "lib/baza_models/validators/uniqueness_validator.rb",
+    "shippable.yml",
+    "spec/baza_models/autoloader_spec.rb",
+    "spec/baza_models/baza_orm_adapter_spec.rb",
+    "spec/baza_models/class_translation_spec.rb",
+    "spec/baza_models/factory_girl_spec.rb",
+    "spec/baza_models/model/belongs_to_relations_spec.rb",
+    "spec/baza_models/model/custom_validations_spec.rb",
+    "spec/baza_models/model/delgation_spec.rb",
+    "spec/baza_models/model/has_many_relations_spec.rb",
+    "spec/baza_models/model/has_one_relations_spec.rb",
+    "spec/baza_models/model/manipulation_spec.rb",
+    "spec/baza_models/model/queries_spec.rb",
+    "spec/baza_models/model/scopes_spec.rb",
+    "spec/baza_models/model/translate_functionality_spec.rb",
+    "spec/baza_models/model/validations_spec.rb",
+    "spec/baza_models/model_spec.rb",
+    "spec/baza_models/query/not_spec.rb",
+    "spec/baza_models/query_spec.rb",
+    "spec/baza_models/ransacker_spec.rb",
+    "spec/baza_models/validators/confirmation_validator_spec.rb",
+    "spec/baza_models/validators/format_validator_spec.rb",
+    "spec/baza_models/validators/length_validator_spec.rb",
+    "spec/baza_models/validators/uniqueness_validator_spec.rb",
+    "spec/baza_models_spec.rb",
+    "spec/factories/organization.rb",
+    "spec/factories/user.rb",
+    "spec/spec_helper.rb",
+    "spec/support/database_helper.rb",
+    "spec/test_classes/organization.rb",
+    "spec/test_classes/person.rb",
+    "spec/test_classes/role.rb",
+    "spec/test_classes/user.rb",
+    "spec/test_classes/user_passport.rb"
+  ]
+  s.homepage = "http://github.com/kaspernj/baza_models"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.0"
+  s.summary = "ActiveRecord like models for the Baza database framework"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<array_enumerator>, [">= 0"])
+      s.add_runtime_dependency(%q<baza>, ["~> 0.0.20"])
+      s.add_runtime_dependency(%q<string-cases>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<jdbc-sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<best_practice_project>, [">= 0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
+      s.add_development_dependency(%q<orm_adapter>, [">= 0"])
+    else
+      s.add_dependency(%q<array_enumerator>, [">= 0"])
+      s.add_dependency(%q<baza>, ["~> 0.0.20"])
+      s.add_dependency(%q<string-cases>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3.3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<jdbc-sqlite3>, [">= 0"])
+      s.add_dependency(%q<best_practice_project>, [">= 0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
+      s.add_dependency(%q<orm_adapter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<array_enumerator>, [">= 0"])
+    s.add_dependency(%q<baza>, ["~> 0.0.20"])
+    s.add_dependency(%q<string-cases>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<jdbc-sqlite3>, [">= 0"])
+    s.add_dependency(%q<best_practice_project>, [">= 0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
+    s.add_dependency(%q<orm_adapter>, [">= 0"])
+  end
+end
+

data/config/best_project_practice_rubocop.yml

@@ -0,0 +1,2 @@
+---
+inherit_from: best_project_practice_rubocop_todo.yml

data/config/best_project_practice_rubocop_todo.yml

@@ -0,0 +1,35 @@
+
+
+
+
+
+
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-20 19:19:55 +0100 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 41
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 400
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 77
+
+# Offense count: 6
+Metrics/PerceivedComplexity:
+  Max: 21

data/lib/baza_models.rb

@@ -1,17 +1,32 @@
 class BazaModels
   path = "#{File.realpath(File.dirname(__FILE__))}/baza_models"
 
+  autoload :Autoloader, "#{path}/autoloader"
+  autoload :BazaOrmAdapter, "#{path}/baza_orm_adapter"
+  autoload :CanCanAdapter, "#{path}/can_can_adapter"
+  autoload :ClassTranslation, "#{path}/class_translation"
   autoload :Errors, "#{path}/errors"
   autoload :Model, "#{path}/model"
+  autoload :Ransacker, "#{path}/ransacker"
+  autoload :Query, "#{path}/query"
+  autoload :TestDatabaseCleaner, "#{path}/test_database_cleaner"
 
   class << self
     attr_accessor :primary_db
+
+    def load_can_can
+      BazaModels::CanCanAdapter # Loading the model will make CanCan aware because of inherited hook CanCan implements
+    end
   end
 
   class Validators
     path = "#{File.realpath(File.dirname(__FILE__))}/baza_models/validators"
 
     autoload :BaseValidator, "#{path}/base_validator"
+    autoload :ConfirmationValidator, "#{path}/confirmation_validator"
+    autoload :FormatValidator, "#{path}/format_validator"
+    autoload :LengthValidator, "#{path}/length_validator"
     autoload :PresenceValidator, "#{path}/presence_validator"
+    autoload :UniquenessValidator, "#{path}/uniqueness_validator"
   end
 end

data/lib/baza_models/autoloader.rb

@@ -0,0 +1,135 @@
+class BazaModels::Autoloader
+  def initialize(args)
+    @models = args.fetch(:models)
+    @model_class = @models.first.class
+    @autoloads = args.fetch(:autoloads)
+    @db = args.fetch(:db)
+    @debug = args[:debug]
+
+    debug "Autoloading #{@autoloads} on #{@model_class.name} with ID's: #{@models.map(&:id)}" if @debug
+  end
+
+  def autoload
+    autoload_argument(@autoloads)
+  end
+
+private
+
+  def debug(msg)
+    print "#{msg}\n" if @debug
+  end
+
+  def model_ids
+    @model_ids ||= @models.map(&:id)
+  end
+
+  def autoload_argument(autoload)
+    if autoload.is_a?(Hash)
+      autoload_hash(autoload)
+    elsif autoload.is_a?(Array)
+      autoload_array(autoload)
+    elsif autoload.is_a?(Symbol)
+      autoload_symbol(autoload)
+    else
+      raise "Didn't know what to do with autoload: #{autoload} (#{autoload.class.name})"
+    end
+  end
+
+  def autoload_array(autoload)
+    autoload.each do |autoload_i|
+      autoload_argument(autoload_i)
+    end
+  end
+
+  def autoload_hash(autoload)
+    autoload.each do |autoload_key, autoload_value|
+      result = autoload_symbol(autoload_key)
+      next if result.fetch(:models).empty?
+
+      autoloader = BazaModels::Autoloader.new(
+        models: result.fetch(:models),
+        autoloads: autoload_value,
+        db: @db,
+        debug: @debug
+      )
+      autoloader.autoload
+    end
+  end
+
+  def autoload_symbol(autoload)
+    relation = @model_class.relationships.fetch(autoload)
+
+    if relation.fetch(:type) == :has_many
+      autoload_has_many(autoload, relation)
+    elsif relation.fetch(:type) == :belongs_to
+      autoload_belongs_to(autoload, relation)
+    elsif relation.fetch(:type) == :has_one
+      autoload_has_one(autoload, relation)
+    else
+      raise "Unknown relation type: #{relation.fetch(:type)}"
+    end
+  end
+
+  def autoload_belongs_to(autoload_name, relation)
+    result = {models: []}
+
+    model_id_mappings = {}
+    model_ids = []
+
+    @models.each do |model|
+      key = model.data.fetch(relation.fetch(:foreign_key))
+      next if model_id_mappings.key?(key)
+
+      model_ids << key
+      model_id_mappings[key] = model.id
+    end
+
+    @db.select(relation.fetch(:table_name), id: model_ids) do |model_data|
+      model = ::Object.const_get(relation.fetch(:class_name)).new(model_data)
+
+      orig_model_id = model_id_mappings.fetch(model_data.fetch(:id))
+      orig_model = @models.detect { |array_model| array_model.id == orig_model_id }
+      orig_model.autoloads[autoload_name] ||= model
+
+      result.fetch(:models) << model
+    end
+
+    result
+  end
+
+  def autoload_has_many(autoload_name, relation)
+    result = {models: []}
+
+    @db.select(relation.fetch(:table_name), relation.fetch(:foreign_key) => model_ids) do |model_data|
+      model = ::Object.const_get(relation.fetch(:class_name)).new(model_data)
+
+      orig_model_id = model_data.fetch(relation.fetch(:foreign_key))
+      orig_model = @models.detect { |array_model| array_model.id == orig_model_id }
+
+      orig_model.autoloads[autoload_name] ||= []
+      orig_model.autoloads[autoload_name] << model
+
+      result.fetch(:models) << model
+    end
+
+    result
+  end
+
+  def autoload_has_one(autoload_name, relation)
+    result = {models: []}
+
+    @db.select(relation.fetch(:table_name), relation.fetch(:foreign_key) => model_ids) do |model_data|
+      model = ::Object.const_get(relation.fetch(:class_name)).new(model_data)
+
+      orig_model_id = model_data.fetch(relation.fetch(:foreign_key))
+      orig_model = @models.detect { |array_model| array_model.id == orig_model_id }
+
+      raise "Already autoloaded?" if orig_model.autoloads.key?(autoload_name)
+      orig_model.autoloads[autoload_name] = model
+
+      result.fetch(:models) << model
+    end
+
+    result
+  end
+end

data/lib/baza_models/baza_orm_adapter.rb

@@ -0,0 +1,39 @@
+require "orm_adapter"
+
+class BazaModels::BazaOrmAdapter < ::OrmAdapter::Base
+  def initialize(args)
+    @klass = args.fetch(:class)
+  end
+
+  def column_names
+    klass.column_names
+  end
+
+  def get!(id)
+    klass.find(wrap_key(id))
+  end
+
+  def get(id)
+    klass.where(id: wrap_key(id)).first
+  end
+
+  def find_first(options)
+    klass.find_first(options)
+  end
+
+  def find_all(options = {})
+    klass.where(options)
+  end
+
+  def create!(attributes = {})
+    klass.create!(attributes)
+  end
+
+  def destroy(object)
+    if valid_object?(object)
+      object.destroy
+    else
+      false
+    end
+  end
+end

data/lib/baza_models/can_can_adapter.rb

@@ -0,0 +1,9 @@
+class BazaModels::CanCanAdapter < CanCan::ModelAdapters::AbstractAdapter
+  def self.for_class?(klass)
+    klass.is_a?(BazaModels::Query)
+  end
+
+  def database_records
+    @model_class.all
+  end
+end

data/lib/baza_models/class_translation.rb

@@ -0,0 +1,44 @@
+class BazaModels::ClassTranslation
+  def initialize(args)
+    @klass = args.fetch(:class)
+  end
+
+  def class_name_snake
+    @class_name_snake ||= StringCases.camel_to_snake(@klass.name)
+  end
+
+  def human(args = {})
+    if args[:count] && args[:count] >= 2
+      count_key = "other"
+    else
+      count_key = "one"
+    end
+
+    keys = [
+      "baza_models.models.#{class_name_snake}.#{count_key}",
+      "activerecord.models.#{class_name_snake}.#{count_key}"
+    ]
+
+    keys.each do |key|
+      return I18n.t(key) if I18n.exists?(key)
+    end
+
+    @klass.name
+  end
+
+  def param_key
+    @param_key ||= class_name_snake
+  end
+
+  def route_key
+    "#{param_key}s"
+  end
+
+  def singular_route_key
+    param_key
+  end
+
+  def i18n_key
+    param_key.to_sym
+  end
+end