cero 0.0.0 → 0.0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf7b0ab42440cec12df54c647510bdfe07934a81
-  data.tar.gz: 694de73764dba04bd1c15ef606e6a69d27130de9
+  metadata.gz: fba2db9ef800adb7a1f86e22f79fccf23cbab49c
+  data.tar.gz: 88882a312bb253395ea0992ab41cce3ac8439ee4
 SHA512:
-  metadata.gz: bb52c2f45c1bb29a0d9e5df1feb783d4df50e818b0f94ec2b795fe87e22f9e50542714485feb407f23af50efea488e3dfed4c80da7329b995053e1a19065124b
-  data.tar.gz: 162eb4ae53464c4bd247beef4a744c76856d115da73095b137e7585278d7995ba9756ac6558bf7cb8ebe1f3f69007abd2654652f158e56065e10bd4e442d91fe
+  metadata.gz: eda3731336d6b809fa7a0dde439a3dbdfa00aa3423dd27eeaf9087ea421ea2ab4d78f15eddd5f95c46feb03096235ab820f146a8b4fb9bb9c222dcf7f8576dac
+  data.tar.gz: 5936cf5ecf51cf3a9f674d9601bb790cb7f65aed502de4b444ab9ce46e7f2baed982fc06fe7cf0ff852b31b0e03130c4a78d0cd0b0df4358cec3cbbb1ce3a96e

data/README.md

@@ -1,24 +1,93 @@
 # Cero
 
-TODO: Write a gem description
+Cero contains building blocks for constructing ruby applications.
 
-## Installation
+## Architecture
 
-Add this line to your application's Gemfile:
+An *Entitiy* is little more than a dumb data structure. The only thing unique about it
+is that an Entity must have an identity field - usually an :id attribute. This is used
+for comparisons and persistance.
 
-    gem 'cero'
+A *Repo* is a class that can be used to mapulate collections of Entities.
+It knows nothing about persistance.
+Its interface contains the following methods:
 
-And then execute:
+* create(entity)
+* find(id)
+* update(entity)
+* delete(entity)
+* save(entity)
+* all
+* first
+* last
+* count
+* query(&block)
+* clear
 
-    $ bundle
+A *RepoQuery* is an interface for constucting complex queries against data in a Repo.
+
+An *Collection* is a structural mapping that hooks all parts of the System together.
+It assigns an Adapter to an Entity and a Repo, and sets up fields for type coercians and the peristance layer. For instance
+
+```ruby
+Cero::Collections.setup do
+  collection :users do
+    entity User
+    adapter :sql
+    repo UserRepo
+    fields do
+      identity :uuid, String
+      attribute :username, String
+      attribute :email, String
+    end
+  end
+
+  collection :user_stats do
+    entity UserStat
+    adapter :redis
+    repo UserStatRepo
+    fields do
+      identity :id, Integer
+      attribute :user_id, Integer
+      attribute :last_login_at, DateTime
+      attribute :site_visits_count, Integer
+      attribute :karma, Float
+    end
+  end
+end
+```
 
-Or install it yourself as:
 
-    $ gem install cero
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class User
+  include Cero::Entity
+  attribute :username, String
+  attribute :email, String
+  attribute :confirmed, Boolean
+end
+
+class UserRepo
+  include Cero::Repo
+
+  def self.find_all_confirmed
+    query do
+      where(confirmed: true)
+    end
+  end
+end
+
+user = User.new(email: "bob@bob.com", username: "bob")
+UserRepo.create(user)
+puts user.id # => 1
+
+UserRepo.find(1) # => returns <User @email="bob@bob.com" @username="bob">
+UserRepo.find_all_having_confirmed_of(true)
+
+end
+```
 
 ## Contributing
 

data/lib/cero/adapters/abstract_adapter.rb

@@ -52,6 +52,11 @@ module Cero
         raise Errors::AbstractMethodError
       end
 
+      private
+        def setup
+          # setup hook inside initialize for adapters
+        end
+
     end
   end
 end

data/lib/cero/adapters/memory_adapter.rb

@@ -6,6 +6,7 @@ module Cero
         super
         @lock = Monitor.new
         @collection[collection] = {}
+        setup
       end
 
       def create(collection, entity)
@@ -60,7 +61,9 @@ module Cero
       
       private
         def next_id_for(hash)
-          hash.empty? ? 1 : hash.keys.count + 1
+          @lock.synchronize do
+            hash.empty? ? 1 : hash.keys.count + 1
+          end
         end
     end
   end

data/lib/cero/version.rb

@@ -7,7 +7,7 @@ module Cero
     MAJOR = 0
     MINOR = 0
     PATCH = 0
-    PRE   = nil
+    PRE   = 1
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cero
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.0.1
 platform: ruby
 authors:
 - John Faucett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,4 +115,3 @@ signing_key:
 specification_version: 4
 summary: Application Building Blocks
 test_files: []
-has_rdoc: