rails-disco 0.5.0.pre2 → 0.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e670b4fb30869da45455e0459e4eca76f92b2785
-  data.tar.gz: c6d03b51deb31dffe9c2edf34c7616e82887f626
+  metadata.gz: 80898327268b3f4a52c4e86bca134da6f992630e
+  data.tar.gz: 60b545f796e44cb69b7d40f25ab726313e545543
 SHA512:
-  metadata.gz: 1fcbc175aa7f90861314c9596b061e80e76df2e09a1b97984a841cfe4ba781f29dcb5d14e1e82e20f9463e828ab15e73120e4bf5656f6ae428879f121bf15259
-  data.tar.gz: b5d8044b2a84a8b85fa7912157a09dd2b9d90c8513bddc941525bd3d5f2730a266ff88a05745d38a4a41bb4efc8d40d9abf908e24e8905cf591320a20113b184
+  metadata.gz: 05501f12f5e2e2be148dc8a3e52d49c6a2fa76b3c1548b557a4fa08344f4b07a10c2493bf37f2d97e39e161e03cd494888d51cb2510d2c2085a583cd618ab12e
+  data.tar.gz: 7da9f994236ce9c5fcae039c087c41c0abe42d6770eff6d1db6cbe8503efee8c682687a1d1840d6eb07125c7b2668c23f5eef297b715bd7547b0be9702fe17c0

data/README.md

@@ -5,14 +5,14 @@
 
 # Rails Disco - A distributed party with commands, events and projections 
 
-Rails Disco is a framework on top of the rails framework to provide cqrs and simple event sourcing possibilities to rails.
-The framework consists out of three main parts, commands, events and projections.
+Rails Disco is a framework that extends Rails with support for the best parts of event sourcing.
+The framework consists out of three main parts: commands, events and projections.
 
 _Commands_ will be created and executed by actions of your controller, instead of directly manipulating your model. These commands are only the order to do something and after possible validations, the framework executes them by creating an event and finally manipulating the model.
 
 The _events_ will be all stored in a separate database and also published to all projections, where they can be processed to update the projections model/database
 
-Finally _projections_ are your representation of your data, they get the events and process them, to get the needed informations for building up their models.
+Finally _projections_ are your representation of your data, they get the events and process them, to get the needed information for building up their models.
 
 # Requirements
 
@@ -20,59 +20,59 @@ Finally _projections_ are your representation of your data, they get the events
 
 * Because Rails Disco relies on [bunny](https://github.com/ruby-amqp/bunny) for sending the events from the domain to the projection, you need [RabbitMQ](http://www.rabbitmq.com/download.html) on your system.
 
-* Any Server which is capable of streaming, e.g. puma or thin (Standard Rails Server Webrick will **not** work). If you are facing problems installing puma on windows, here is a [tutorial](https://github.com/hicknhack-software/rails-disco/wiki/Installing-puma-on-windows).
+* Any Server which is capable of streaming, e.g. puma or thin (standard Rails server WEBrick will **not** work). If you are facing problems installing puma on Windows, here is a [tutorial](https://github.com/hicknhack-software/rails-disco/wiki/Installing-puma-on-windows).
 
 # Getting Started
 
-1. Rails Disco depends heavily on [RubyOnRails](http://rubyonrails.org/), so you should install that first if you haven't yet.
-
-2. Install Rails Disco at the command prompt 
+1. Install Rails Disco at the command prompt
 
 		gem install rails-disco
 
+1. At the command prompt, create a new Rails Disco application.
 
-3. At the command prompt, create a new Rails Disco application.
-
-		drails new myapp
+		disco new myapp
 
-   where "myapp" is the application name.
+   where `myapp` is the name of you application.
 
-   (Note: You can also add Rails Disco to an existing rails application. Simply omit the application name and run the command inside your application.)
+   (Note: You can also add Rails Disco to an existing Rails application. Simply omit the application name and run the command inside your application.)
 
-4. Change directory to `myapp`, if you haven't yet and migrate the databases:
+1. Change directory to `myapp` and migrate the databases:
 
 		cd myapp
-		rake drails:db:setup
+		rake disco:migrate:setup
+
+   This will operate on the Rails (= projection) and the domain database.
+   You can configure the domain database and more Rails Disco related configurations in `config/disco.yml`.
 
-   This will create the two databases domain and projection (for database details look in config/disco.yml)
+1. If you just want to look a some standard server output, start the disco server (Remember to use a server which is capable of streaming, which means not WEBrick). Else go ahead and skip this point.
 
-5. If you just want to look a some standard server output, start the drails server (Remember to use a server which is capable of streaming, which means not Webrick). Else go ahead and skip this point.
+		disco server
 
-		drails server
+   This will start the domain, the projection and the web server, but you won't see much of the disco yet.
 
-   This will start the domain, the projection and the standard rails server, but you won't see much of the disco yet.
+1. For a humble start, let's create the scaffold for a simple blog system:
 
-6. For a humble begin, scaffolding is the way to go. Lets create a simple blog system:
+		disco generate scaffold Post title:string text:text
 
-		drails generate scaffold Post title:string text:text
+   The syntax is leaned to Rails' generate style and it basically creates a resource Post with a title and a text attribute.
 
-   The syntax is leant to rails' generate style and it basically creates a resource Post with a title and a text attribute.
+1. Now that we have something to rely on, lets migrate and see it in action:
 
-7. Before we can start, we need to tell rails that we have some shiny new db. Open up config/database.yml and edit the config for your environment (propably development) to the projection database. So basically:
+	    rake disco:migrate
+		disco server
 
-	```diff
-	- database: db/development.sqlite3
-	+ database: db/projection_dev.sqlite3
-	```
+1. Go to [http://localhost:3000/posts](http://localhost:3000/posts) and you'll see an empty list of our posts with a link to create a new one. Go ahead and create one.
+   If you watch the console output, you can see that an event is created, published and processed by a projection.
 
-8. Now that we have something to rely on, lets see it in action:
-	
-		drails server
+1. If you look at your databases, you see in both of them a table `posts`, which contains your freshly created post.
+   The domain database also contains a table `domain_events`. There you find an event for your post creation. Lets see this in action.
 
-9. Go to [http://localhost:3000/posts](http://localhost:3000/posts) and you'll see an empty list of our posts with a link to create a new one. Go ahead and create one. If you watch the console output, you can see that an event will be created for the creating of the post and will be published to the projection.
+1. Clear your projection database and restart the server.
 
-10. If you look at your databases, you see in both of them a table `posts`, which contains your freshly created post. The domain database also contains a table `domain_events`. There you find an event for your post creation. Lets see this in action.
+        rake disco:db:drop
+        rake disco:migrate
+        disco server
 
-11. Clear your projection database and restart the server. You will see some console output, where the projection is requesting the missing posts from the domain and there you have your projection database complete again.
+   You will see some console output, the projection requests the missing posts from the domain. Finally the state of your projection database will be restored.
 
-12. Thats it for now, have fun with it. For more informations take a look at the [wiki](https://github.com/hicknhack-software/rails-disco/wiki)
+1. That's it for now, have fun with it. For more information take a look at the [wiki](https://github.com/hicknhack-software/rails-disco/wiki)

metadata

@@ -1,32 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rails-disco
 version: !ruby/object:Gem::Version
-  version: 0.5.0.pre2
+  version: 0.5.0.rc1
 platform: ruby
 authors:
-- Robert Kranz
-- Andreas Reischuck
+- HicknHack Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: drailties
+  name: disco-railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0.pre2
+        version: 0.5.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0.pre2
-description: Rails Disco is a framework on top of the rails framework to provide cqrs
-  and simple event sourcing possibilities to rails.
+        version: 0.5.0.rc1
+description: |2
+      Rails Disco is a framework that extends Rails with support for the best parts of event sourcing.
+
+      Instead of updating models synchronously in Rails, these changes are captured in commands. Commands are validated in a domain and create the only source of truth: events. Later events can be projected into Rails models and other actions.
+
+      Have a look at the documentation on Github for more details.
 email: rails-disco@hicknhack-software.com
 executables: []
 extensions: []