epiphy 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 031cd67e497923d5caaf27aa09b8c4113bb882ff
-  data.tar.gz: 62cf9f376f77269b533802800ee4873b4cf05175
+  metadata.gz: 11a0712dc7095310eabf03b49c9e0ab1319eaa17
+  data.tar.gz: bb888733602a4e9df89ec5595e30ef636a5b8d80
 SHA512:
-  metadata.gz: 61846e7c5efebf9f4a56447be36d5890bbb65371f09abfabdb6b1e283b4878cae0f485d9a42a11907d767c695aff18a1aa5bf48cb1596eddadf232960f56ef55
-  data.tar.gz: ea66cb62accc2725adbd903c410d16fb5a51a106dee5852e2a0feb030c1be75645a263f6f99fbaa563c40bc9606d35b9b5b21451ca8eb335c5a63335630f8062
+  metadata.gz: ef5d6dac3a225bd420e0f9c058d110f5a2234b087d1252b46b93bb5292a8e007a9488bc748b8fe272b3830c87a8f095ad2d26b676e9cb26d26cbbcd797acb04b
+  data.tar.gz: c57cd612e243ddbaabf6546168b6fdb3dc04e0aaf03da46c8d09c03adb1a860de297314e618f88fa20c297d784c4c3bcc66a43b83c5b87179cc746e5ae999836

data/README.md

@@ -1,13 +1,16 @@
-# Epiphy [![wercker status](https://app.wercker.com/status/63dd458158948712a03a00d69a96f67b/m "wercker status")](https://app.wercker.com/project/bykey/63dd458158948712a03a00d69a96f67b)
+# Epiphy 
 
-## [Simply RethinkDB](http://leanpub.com/simplyrethink)
+A persistence framework for [RethinkDB](http://rethinkdb.com). The library is used on [phim365.today](http://phim365.today). Its API is based on Lotus::Model.
+
+# Status
+
+[![wercker status](https://app.wercker.com/status/63dd458158948712a03a00d69a96f67b/m "wercker status")](https://app.wercker.com/project/bykey/63dd458158948712a03a00d69a96f67b)
+
+# Book [Simply RethinkDB](http://leanpub.com/simplyrethink)
 
 I also write this book to practice RethinkDB. Please consider buying a
 copy if you want to support the author.
 
-# Introduction
-
-A persistence framework for [RethinkDB](http://rethinkdb.com). The library is used on [phim365.today](http://phim365.today). Its API is based on Lotus::Model.
 
 I love Lotus::Model so much because it's lightweight, does the job, no
 magic. I also should fork Lotus and add RethinkDB adapter. However, I want
@@ -59,7 +62,19 @@ A testing database will be created during the testing. The testing data
 will hit your RethinkDB. Depend on your storge system, test can fast or
 slow.
 
-# Example
+# Usage
+
+Entities
+
+An object that is defined by its identity.
+
+An entity is the core of an application, where the part of the domain logic is implemented. It's a small, cohesive object that expresses coherent and meaningful behaviors.
+
+It deals with one and only one responsibility that is pertinent to the domain of the application, without caring about details such as persistence or validations.
+
+This simplicity of design allows developers to focus on behaviors, or message passing if you will, which is the quintessence of Object Oriented Programming.
+
+# Usage
 
 ```ruby
 connection = Epiphy::Connection.create
@@ -88,9 +103,6 @@ movie = Movie.new
 movie.title = "A movie"
 MovieRepository.create movie
 MovieRepository.update movie
-
-
-
 ```
 
 # Contributing to epiphy

data/lib/epiphy/adapter/rethinkdb.rb

@@ -320,24 +320,6 @@ module Epiphy
  
       end
 
-      private
-      def _find(collection, id)
-        identity = _identity(collection)
-        query(collection).where(identity => _id(collection, identity, id))
-      end
-
-      def _first(query)
-        query.limit(1).first
-      end
-
-      def _identity(collection)
-        _mapped_collection(collection).identity
-      end
-
-      def _id(collection, column, value)
-        _mapped_collection(collection).deserialize_attribute(column, value)
-      end
-
       protected
 
       # Return a ReQL wrapper of a table to start query chaining.

data/lib/epiphy/entity/timestamp.rb

@@ -6,7 +6,7 @@ module Epiphy
     #
     module Timestamp
       def self.included(base)
-        base.send :attr_accessor, :_ts
+        base.send :attr_accessor, :created_at
       end
     end
 

data/lib/epiphy/model.rb

@@ -5,11 +5,12 @@ require 'epiphy/adapter/rethinkdb'
 require 'epiphy/repository'
 
 module Epiphy
+
+  
   # Model
   #
   # @since 0.1.0
   module Model
-
     class RuntimeError < RethinkDB::RqlRuntimeError
 
     end

data/lib/epiphy/repository.rb

@@ -66,11 +66,9 @@ module Epiphy
   #
   #   * Isolates the persistence logic at a low level
   #
-  # Epiphy::Model is shipped with two adapters:
-  #
-  #   * SqlAdapter
-  #   * MemoryAdapter
+  # Epiphy::Model is shipped with adapter:
   #
+  #   * RethinkDB
   #
   #
   # All the queries and commands are private.
@@ -161,8 +159,24 @@ module Epiphy
       end
 
       def get_config
+        if @config.nil?
+          auto_config
+        end
         @config
       end
+      
+      # Auto configure with default RethinkDB setting. 127.0.0.1, 28015, plain
+      # auth key.
+      #
+      # With this design, people can just drop in and start using it without
+      # worry about setting up and configure.
+      # @since 0.3.0
+      # @api private 
+      private def auto_config
+        Epiphy::Repository.configure do |config|
+          config.adapter = Epiphy::Adapter::Rethinkdb.new connection, database: 'test'
+        end
+      end
     end
 
     # Inject the public API into the hosting class.
@@ -203,8 +217,11 @@ module Epiphy
     #   FilmRepository.collection = 'Movie'
     #
     def self.included(base)
-      #config = self.get_config
       config = Epiphy::Repository.get_config
+      
+      raise Epiphy::Repository::NotConfigureError if config.nil?
+      raise Epiphy::Repository::MissingAdapterError if config.adapter.nil?
+
       base.class_eval do
         extend ClassMethods
         include Lotus::Utils::ClassAttribute
@@ -475,6 +492,10 @@ module Epiphy
       #   ArticleRepository.find(9) # => raises Epiphy::Model::EntityNotFound
       def find(id)
         entity_id = id
+        if id.is_a? Epiphy::Entity
+          raise TypeError, "Expecting an string, primitve value"
+        end
+
         if !id.is_a? String
           raise Epiphy::Model::EntityIdNotFound, "Missing entity id" if !id.respond_to?(:to_s)
           entity_id = id.to_s
@@ -687,41 +708,6 @@ module Epiphy
       end
       
 
-      # Negates the filtering conditions of a given query with the logical
-      # opposite operator.
-      #
-      # This is only supported by the SqlAdapter.
-      #
-      # @param query [Object] a query
-      #
-      # @return a negated query, the type depends on the current adapter
-      #
-      # @api public
-      # @since 0.1.0
-      #
-      # @see Epiphy::Model::Adapters::Sql::Query#negate!
-      #
-      # @example
-      #   require 'epiphy/model'
-      #
-      #   class ProjectRepository
-      #     include Epiphy::Repository
-      #
-      #     def self.cool
-      #       query do
-      #         where(language: 'ruby')
-      #       end
-      #     end
-      #
-      #     def self.not_cool
-      #       exclude cool
-      #     end
-      #   end
-      def exclude(query)
-        query.negate!
-        query
-      end
-
       # Determine colleciton/table name of this repository. Note that the
       # repository name has to be the model name, appending Repository
       #

data/lib/epiphy/repository/error.rb

@@ -0,0 +1,16 @@
+module Epiphy
+  module Repository
+    # Not configure exception
+    #
+    # This error will be raised when the repository didn't get configured yet.
+    # @since 0.2.0
+    # @api public
+    class NotConfigureError < ::StandardError
+
+    end
+    class MissingAdapterError < ::StandardError
+
+    end
+
+  end
+end

data/lib/epiphy/repository/helper.rb

@@ -1,5 +1,9 @@
 module Epiphy
   module Repository
+    # Give repository useful helper class to query data.
+    # Only support `find_by` at this moment.
+    #
+    #
     module Helper
 
       # Find the first record matching the 
@@ -21,7 +25,6 @@ module Epiphy
         end
       end
       
-      #private :where, :desc#, :exlude
     end
   end
 end

data/lib/epiphy/version.rb

@@ -2,5 +2,5 @@ module Epiphy
   # Defines the version
   #
   # @since 0.0.1
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epiphy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vinh
@@ -71,10 +71,11 @@ files:
 - lib/epiphy/repository.rb
 - lib/epiphy/repository/configuration.rb
 - lib/epiphy/repository/cursor.rb
+- lib/epiphy/repository/error.rb
 - lib/epiphy/repository/helper.rb
 - lib/epiphy/scheme.rb
 - lib/epiphy/version.rb
-homepage: http://rubygems.org/gems/hola
+homepage: http://rubygems.org/gems/epiphy
 licenses:
 - MIT
 metadata: {}