epiphy 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d721972826203c0d1e7b48dc91080577f618b23
-  data.tar.gz: 8cf70ff2df82d436b8a6c627bfea8bdbd9a8937d
+  metadata.gz: ebef4094fb32036a44c51f7bcb2ba81ca4ce5fee
+  data.tar.gz: 66714f2f59108768bd92ab0f40e9a945a53b0cb3
 SHA512:
-  metadata.gz: 7f38fcba30856b3f81571f274c3c9d2e66fb0a3cc4c262d3e4477772c0c78c9c54ece547fda7ab7d5ab7648c6f61719b5fc097e593a07b3da6f3d1b6aba2afc0
-  data.tar.gz: 84f0d361f41e10404de7c8c96ce751a6314fcbab7a70a9b2338e5cc5d336efb5e65b5ffd0ec14ce58b1edb4845341e6cbbc1f2ea1c4217222673f9688bf5ba95
+  metadata.gz: 07371cbf80b7c37a5011502b09aad72ca0b638fdf8c9159f9b12f08e2ec87ae95787c8f4363249f9f176e5bb10d6bee7b0ed3f99ed4b2e008d6e1c6da7e6317d
+  data.tar.gz: 1ea6865c035fb28c652e2ff622b156db0ba41203acef3f5465deef1d384e9449c6d5e87c40317bced46c8c138bda3f975b68f748a7bd3e7d803842cb35310dcf

data/README.md

@@ -1,12 +1,14 @@
 # Epiphy 
 
-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.
+A persistence framework for [RethinkDB](http://rethinkdb.com). The library is used on [phim365.today](http://phim365.today). Its API is inspired by Lotus::Model.
+
+`Epiphy` is name after `Epiphyllum`, my wife's name.
 
 # 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)
+# Book [Simply RethinkDB](http://leanpub.com/simplyrethinkdb)
 
 I also write this book to practice RethinkDB. Please consider buying a
 copy if you want to support the author.
@@ -18,8 +20,21 @@ to learn more Ruby and reinvent the wheel because I didn't know how the
 wheel was created. More than that, my bad code will not be able to make
 it to Lotus::Model.
 
-It delivers a convenient public API to execute queries and commands against a database.
-The architecture eases keeping the business logic (entities) separated from details such as persistence or validations.
+# Philosophy
+
+Does basic thing well and leave complex query to RethinkDB.
+
+RethinkDB query is very good. By wrapping an ORM around it, we can
+destroy the joy of using ReQL. I only want to do basic thing with
+RethinkDB, the complex query should be done use ReQL. The result of
+query is converted back to an entity of an array of entity when
+possible.
+
+# API 
+
+RethinkDB  delivers a convenient public API to execute queries and commands
+against a database. The architecture eases keeping the business logic 
+(entities) separated from details such as persistence or validations.
 
 It implements the following concepts:
 
@@ -28,8 +43,6 @@ It implements the following concepts:
   * [Adapter](#adapter) – A database adapter.
   * [Query](#query) - An object that represents a database query.
 
-`Epiphy` is name after `Epiphyllum`, my spouse's name.
-
 # Install
 
 ```
@@ -59,12 +72,15 @@ $ rake test
 ```
 
 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
+will hit your RethinkDB. Depend on your storge system, test can be fast or
 slow.
 
 # Usage
 
-Entities
+Checkout [Examples.md](blob/master/EXAMPLE.md) for detail guide and [examples](tree/master/examples) folder for real
+code.
+
+## Entities
 
 An object that is defined by its identity.
 
@@ -74,7 +90,8 @@ It deals with one and only one responsibility that is pertinent to the domain of
 
 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
+
+## Setup
 
 ```ruby
 connection = Epiphy::Connection.create
@@ -82,27 +99,63 @@ adapter    = Epiphy::Adapter::RethinkDB.new connection
 RethinkDB::Repository.configure do |r|
   r.adapter = adapter 
 end
+```
 
+## Define your entity
+
+```ruby
 class Movie
   include Epiphy::Entity
-  include Epiphy::Entity::Timestamp
 
-  attributes :title, :url
+  self.attributes= :title, :url, :type
 end
+```
+
+## Define your repository
 
+```ruby
 class MovieRepository
   include Epiphy::Repository  
 end
+```
+
+## Query 
+
+```ruby
 
 movie = MovieRepository.find id # Find by id
 
-movie = MovieRepository.first
-movie = MovieRepository.last
+movie = MovieRepository.first :created_at # Find first entity, order by field :date
+movie = MovieRepository.last :created_at  # Find first entity, order by field :date
 
 movie = Movie.new
 movie.title = "A movie"
 MovieRepository.create movie
+puts movie.id # return the ID of inserted movie
+
+movie.title = "A new title"
 MovieRepository.update movie
+
+movie = Movie.new title: 'Another one', url: "http://youtube.com/foo", type: 'anime'
+movie.id = Time.now.to_i #Manually assign an id
+MovieRepository.create movie
+
+```
+
+## Custom query
+
+From inside a Repository, we can call `query` method and pass in a
+block. The method expose two object
+  
+  * Current ReQL command to play
+  * Global top name space `r`
+
+```ruby
+class MovieRepository
+  
+  def lop
+  end
+end
 ```
 
 # Contributing to epiphy

data/lib/epiphy/adapter/rethinkdb.rb

@@ -231,9 +231,9 @@ module Epiphy
       # @since 0.1.0
       def find(collection, id)
         #begin
-          result = query table: collection do |r|
-            r.get(id)
-          end
+        result = query table: collection do |r|
+          r.get(id)
+        end
         #rescue
         #end
         result

data/lib/epiphy/entity.rb

@@ -107,10 +107,12 @@ module Epiphy
 
         class_eval %{
           def initialize(attributes = {})
-        #{ @attributes.map {|a| "@#{a}" }.join(', ') }, = *attributes.values_at(#{ @attributes.map {|a| ":#{a}"}.join(', ') })
+            attributes.keys.each do |key|
+              attributes[(key.to_sym rescue key) || key] = attributes.delete(key)
+            end
+            #{ @attributes.map {|a| "@#{a}" }.join(', ') }, = *attributes.values_at(#{ @attributes.map {|a| ":#{a}"}.join(', ') })
           end
         }
-
         attr_accessor *@attributes
       end
 
@@ -132,7 +134,12 @@ module Epiphy
     # @see .attributes
     def initialize(attributes = {})
       attributes.each do |k, v|
-        public_send("#{ k }=", v)
+        case k
+          when Symbol
+            public_send("#{ k }=", v)
+          when String
+            public_send("#{ k.to_sym }=", v)
+        end
       end
     end
 

data/lib/epiphy/repository.rb

@@ -491,18 +491,18 @@ module Epiphy
       #
       #   ArticleRepository.find(9) # => raises Epiphy::Model::EntityNotFound
       def find(id)
-        entity_id = id
+        entity_id = nil
         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
+        if id.is_a?(String) || id.is_a?(Integer)
+          entity_id = id
+        else
+          entity_id = id.id if id.respond_to? :id
         end
-        #if !id.is_a? String
-          #entity_id = id.to_i
-        #end
+
+        raise Epiphy::Model::EntityIdNotFound, "Missing entity id" if entity_id.nil?
         result = @adapter.find(collection, entity_id).tap do |record|
           raise Epiphy::Model::EntityNotFound.new unless record
         end

data/lib/epiphy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epiphy
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Vinh