locomotivecms_models 0.0.1.pre.alpha

data/lib/locomotive/mapping/dereferencer.rb

@@ -0,0 +1,40 @@
+module Locomotive
+  module Mapping
+    class Dereferencer < Struct.new(:entity, :name, :options, :record)
+
+      def deference!
+        case value
+        when Array
+          entity.send(:"#{name}=", Locomotive::Mapping::VirtualProxy.new do
+            entity.send(:"#{name}=", entities_reference(value))
+          end)
+        else
+          entity.send(:"#{name}=", Locomotive::Mapping::VirtualProxy.new do
+            entity.send(:"#{name}=", entity_reference(record[options[:association].fetch(:key)]))
+          end)
+
+          entity.send(:"#{options[:association].fetch(:key)}=", record[options[:association].fetch(:key)])
+        end
+      end
+
+      private
+
+      def value
+        record[name]
+      end
+
+      def entity_reference value
+        Models[options[:association].fetch(:name)].query do
+          where('id.eq' => value)
+        end.all.first
+      end
+
+      def entities_reference value
+        Models[options[:association].fetch(:name)].query do
+          where('id.in' => value)
+        end.all
+      end
+
+    end
+  end
+end

data/lib/locomotive/mapping/referencer.rb

@@ -0,0 +1,66 @@
+module Locomotive
+  module Mapping
+    class Referencer < Struct.new(:collection, :attributes, :name, :options, :value)
+
+      def reference!
+        return unless value
+
+        Array(value).each do |entity| fill_associations! entity end
+
+        case value
+        when Array
+          attributes[name] = value.map(&:id)
+        else
+          attributes[name] = value.id
+        end
+      end
+
+      private
+
+      def assign_parent_reference! entity
+        raise "Please persit parent object first" unless attributes[:id]
+
+        identity_reference_field = options[:association].fetch(:key) # article_id
+        entity.send :"#{identity_reference_field}=", attributes[:id]
+      end
+
+      def assign_child_reference! entity
+        identity_reference_field = options[:association].fetch(:key)
+        attributes[identity_reference_field] = identity(entity)
+      end
+
+      def fill_associations! entity
+        type = options[:association].fetch(:type)
+
+        if type == :has_many
+          assign_parent_reference! entity
+          if persisted? entity
+            Locomotive::Models[options[:association].fetch(:name)].update entity # save reference
+          else
+            Locomotive::Models[options[:association].fetch(:name)].create entity # save reference
+          end
+        else # belongs_to
+          assign_child_reference! entity
+        end
+      end
+
+      def identity entity
+        persist!(entity) if persisted?(entity)
+        entity.id
+      end
+
+      def persisted? entity
+        entity.id
+      end
+
+      def persist! entity
+        Locomotive::Models[options[:association].fetch(:name)].update entity
+      end
+
+      def reference_field
+        collection.name[0..-2] + '_id'
+      end
+
+    end
+  end
+end

data/lib/locomotive/mapping/virtual_proxy.rb

@@ -0,0 +1,30 @@
+module Locomotive
+  module Mapping
+
+    class VirtualProxy < BasicObject
+
+      def initialize(&loader)
+        @loader = loader
+        @object = nil
+      end
+
+      def method_missing(name, *args, &block)
+        __load__
+        @object.public_send(name, *args, &block)
+      end
+
+      def inspect
+        "VirtualProxy(#{@object ? @object.inspect : ''})"
+      end
+
+      def __object__
+        @object
+      end
+
+      def __load__
+        @object ||= @loader.call
+      end
+    end
+
+  end
+end

data/lib/locomotive/models.rb

@@ -0,0 +1,57 @@
+# Force encoding to UTF-8
+Encoding.default_internal = Encoding.default_external = 'UTF-8'
+
+# Remove I18n warnings
+require 'i18n'
+I18n.config.enforce_available_locales = true
+
+require 'active_support'
+require 'active_support/core_ext'
+
+require_relative 'core_ext'
+require_relative 'fields/i18n_field'
+require_relative 'entity'
+require_relative 'mapper'
+require_relative 'mapping'
+require_relative 'repository'
+
+require_relative 'models/configuration'
+
+module Locomotive
+  module Models
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.[] name
+      @mapper[name]
+    end
+
+    def self.mapper mapper = nil
+      if mapper
+        @mapper = mapper
+      else
+        @mapper
+      end
+    end
+  end
+end
+
+# Locomotive::Common.reset
+# Locomotive::Common.configure do |config|
+#   path = File.join(File.expand_path('log/models.log'))
+#   config.notifier = Locomotive::Common::Logger.setup(path)
+# end
+# Locomotive::Common::Logger.info 'Models...'

data/lib/locomotive/models/configuration.rb

@@ -0,0 +1,13 @@
+module Locomotive
+  module Models
+
+    class Configuration
+      # attr_accessor :default_adapter
+
+      def initialize
+        # self.default_adapter = Adapters::MemoryAdapter.new
+      end
+    end
+
+  end
+end

data/lib/locomotive/models/version.rb

@@ -0,0 +1,10 @@
+# http://semver.org/
+# MAJOR.MINOR.PATCH format.
+# 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0
+module Locomotive
+  module Models
+
+    VERSION = '0.0.1-alpha'
+
+  end
+end

data/lib/locomotive/repository.rb

@@ -0,0 +1,51 @@
+module Locomotive
+
+  module Repository
+
+    class RecordNotFound < StandardError; end
+
+    attr_reader :mapper
+
+    def initialize(mapper)
+      @mapper  = mapper
+      @adapter = mapper.adapter
+    end
+
+    def all
+      @adapter.all(collection)
+    end
+
+    def find(id)
+      @adapter.find(collection, id)
+    end
+
+    def query(locale=nil, &block)
+      @adapter.query(collection, locale, &block)
+    end
+
+    def load_association! object, relation, request
+      mapper.load_association! object, relation, request
+      nil
+    end
+
+    def create(entity)
+      entity.id = @adapter.create(collection, entity)
+    end
+
+    def persisted?(entity)
+      !!entity.id && @adapter.persisted?(collection, entity)
+    end
+
+    def update(entity)
+      @adapter.update(collection, entity)
+    end
+
+    def destroy(entity)
+      @adapter.destroy(collection, entity)
+    end
+
+    def collection
+      self.class.name.split("::").last.sub(/Repository\Z/, '').scan(/[A-Z][a-z]*/).join("_").downcase.to_sym
+    end
+  end
+end

data/locomotive_models.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/locomotive/models/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'locomotivecms_models'
+  spec.version     = Locomotive::Models::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Didier Lafforgue', 'Arnaud Sellenet', 'Joel Azemar']
+  spec.email       = ['did@locomotivecms.com', 'arnaud@sellenet.fr', 'joel.azemar@gmail.com']
+  spec.homepage    = 'http://www.locomotivecms.com'
+  spec.summary     = 'LocomotiveCMS Models'
+  spec.description = 'Persistence framework for LocomotiveCMS. Default adapters: YAML'
+
+  spec.required_rubygems_version = '>= 1.3.6'
+  spec.rubyforge_project         = 'locomotivecms_models'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  # spec.executables   = ['models']
+
+  spec.add_dependency 'activesupport',        '~> 4.1.0'
+  spec.add_dependency 'i18n',                 '~> 0.6.9'
+  spec.add_dependency 'locomotivecms_common', '~> 0.0.1'
+
+  spec.add_development_dependency 'rake',     '~> 10.3.1'
+  spec.add_development_dependency 'rspec',    '~> 2.14.1'
+end

data/non_persisted_example.rb

@@ -0,0 +1,70 @@
+# irb -r locomotive/models -I ./lib
+
+require 'pry'
+
+adapter = Locomotive::Adapters::MemoryAdapter
+
+class Article
+  include Locomotive::Entity
+  attributes :title, :author, :comments
+end
+
+class Author
+  include Locomotive::Entity
+  attributes :name
+end
+
+class Comment
+  include Locomotive::Entity
+  attributes :title
+end
+
+class ArticlesRepository
+  include Locomotive::Repository
+end
+
+class AuthorsRepository
+  include Locomotive::Repository
+end
+
+class CommentsRepository
+  include Locomotive::Repository
+end
+
+mapper = Locomotive::Mapper.new(adapter) do
+  collection :articles do
+    entity Article
+    repository ArticlesRepository
+
+    attribute :title, localized: true
+    attribute :author, association: :authors
+    attribute :comments, association: :comments
+  end
+
+  collection :authors do
+    entity Author
+    repository AuthorsRepository
+
+    attribute :name
+  end
+
+  collection :comments do
+    entity Comment
+    repository CommentsRepository
+
+    attribute :title
+  end
+
+end
+
+articles_repository = Locomotive::Models[:articles]
+
+author  = Author.new(name: 'John')
+comment = Comment.new(title: 'New Comment')
+article = Article.new(title: { en: "Title #{rand(100_000)}" }, author: author, comments: [comment])
+
+articles_repository.create article
+
+my_article = articles_repository.find author.id
+my_article.author
+my_article.comments

data/presenter_example.rb

@@ -0,0 +1,49 @@
+# irb -r locomotive/models -I ./lib
+
+require 'pry'
+require_relative 'lib/locomotive/adapters/memory_adapter'
+
+adapter = Locomotive::Adapters::MemoryAdapter
+
+class Article
+  include Locomotive::Entity
+  attributes :title
+end
+
+class ArticlesRepository
+  include Locomotive::Repository
+end
+
+mapper = Locomotive::Mapper.new(adapter) do
+  collection :articles do
+    entity Article
+    repository ArticlesRepository
+
+    attribute :title, localized: true
+  end
+end
+
+articles_repository = Locomotive::Models[:articles]
+
+article = Article.new(title: { en: "Title #{rand(100_000)}" })
+articles_repository.create article
+
+my_article = articles_repository.find article.id
+my_article.title
+
+my_article.title << { fr: "Titre #{rand(100_000)}" }
+articles_repository.update my_article
+
+my_1_article = articles_repository.find my_article.id
+my_1_article.title
+
+my_1_article.title
+# => "Title 97960"
+my_1_article.title.en
+# => "Title 97960"
+my_1_article.title[:en]
+# => "Title 97960"
+my_1_article.title.fr
+# => "Titre 35579"
+my_1_article.title[:fr]
+# => "Titre 35579"

data/relation_example.rb

@@ -0,0 +1,119 @@
+# irb -r locomotive/models -I ./lib
+
+require 'pry'
+require_relative 'lib/locomotive/adapters/memory_adapter'
+
+adapter = Locomotive::Adapters::MemoryAdapter
+
+class Article
+  include Locomotive::Entity
+  # attributes :title, :author, :comments
+  attributes :title, :comments
+end
+
+class Comment
+  include Locomotive::Entity
+  # attributes :title, :published, :article_id
+  attributes :title, :published, :article_id, :article
+end
+
+class ArticlesRepository
+  include Locomotive::Repository
+
+  def with_published_comments id
+    article = find(id)
+    load_association! article, :comments, Locomotive::Models[:comments].published_for_article_id(id)
+    article
+  end
+end
+
+class CommentsRepository
+  include Locomotive::Repository
+
+  def published_for_article_id id
+    article(id).tap do |wrapper|
+      wrapper.query + published.query
+    end
+  end
+
+  def published
+    query do
+      where 'published.eq' => true
+    end
+  end
+
+  def article id
+    query do
+      where 'article_id.eq' => id
+    end
+  end
+end
+
+Locomotive::Mapper.new(adapter) do
+  collection :articles do
+    entity Article
+    repository ArticlesRepository
+
+    attribute :title, localized: true
+    # attribute :comments, association: :comments
+    attribute :comments, association: { type: :has_many, key: :article_id, name: :comments }
+  end
+
+  collection :comments do
+    entity Comment
+    repository CommentsRepository
+
+    attribute :title
+    attribute :published
+    attribute :article_id
+    attribute :article, association: { type: :belongs_to, key: :article_id, name: :articles }
+  end
+end
+
+articles_repository = Locomotive::Models[:articles]
+comments_repository = Locomotive::Models[:comments]
+
+unpublished_comment = Comment.new(title: 'New Comment', published: false)
+published_comment   = Comment.new(title: 'New Comment', published: true)
+another_comment     = Comment.new(title: 'New Comment', published: true)
+
+comments_repository.create unpublished_comment
+comments_repository.create published_comment
+comments_repository.create another_comment
+
+article = Article.new(title: { en: "Title #{rand(100_000)}" }, comments: [])
+articles_repository.create article
+
+article.comments << unpublished_comment
+article.comments << published_comment
+
+articles_repository.update article
+
+my_article = articles_repository.find article.id
+my_article
+my_article.comments
+# => VirtualProxy()
+my_article.comments.first.article
+# => VirtualProxy()
+my_article.comments.first.article.title
+# => Title 60716
+my_article.comments.first.article
+=> #<Article:0x00000101394b10 @title=Title 60716, @comments=VirtualProxy(), @id=1>
+my_article.comments.first.article.comments
+# => VirtualProxy()
+my_article.comments.first.article.comments.first
+# => #<Comment:0x0000010136f978 @title="New Comment", @published=false, @id=1, @article_id=1, @article=VirtualProxy()>
+my_article.comments.first.article.comments.first.title
+# => "New Comment"
+
+my_article = articles_repository.with_published_comments article.id
+my_article.comments.all
+
+Locomotive::Models[:comments].all.size
+
+# comments_repository.article article.id
+
+# articles_repository.load_association! my_article, :comments, comments_repository.published
+#
+# my_article = articles_repository.with_published_comments article.id
+# my_article.comments