rietveld 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f831ee5bab34effe5e45935530fa692b5148d03
-  data.tar.gz: 7249be7df3e42e3a8cc62872ea36c3ec8dfad061
+  metadata.gz: ac3e2eb52b3a53b32027a8eab25b6307737d5eb2
+  data.tar.gz: c8ccea1342c286f00a12fc65a77f41a61d35d5b7
 SHA512:
-  metadata.gz: 5bb4ddb9985c21de6e899c26f6f2e4f6f2dbeb383bf73a65bd9490612a04292c5eaed5fe36c555ca267d7621877dee9a2443f53055eebc13fdf49895666f86f7
-  data.tar.gz: fa16fccfea98bc912b3601b6862ab6edec15369d15b72bb04fdc3060c5944bbb31b1d36311df7ad86b9307f30dac6ac726eacd53a6bf145ab97aaab62ecbef53
+  metadata.gz: b60efac74b799d93b86244d220ab46099e67698496714570a245ec5dd90c39a438932748eef08ad8aa5cbe6bb88f1412401c56743c7844fd9805a058987fe5a3
+  data.tar.gz: 3382f09d51a3ae6b71fae879b0212d862343b34e520b04fd64a8a59bddc2a1512779aaf8b5f2b601b3d1f7264b28e75632b38b8e5fdef6648eade4c382dbf473

data/README.md

@@ -11,3 +11,35 @@ And then execute:
 Or install it yourself as:
 
     $ gem install rietveld
+
+
+## Example
+
+``` ruby
+class MoneyTransferContext < Rietveld::Context
+  role :source_account do
+    def withdraw(amount)
+      if balance >= amount
+        decrease_balance(amount)
+        amount
+      else
+        raise 'Insufficient funds'
+      end
+    end
+
+    def transfer(amount)
+      destination_account.deposit(withdraw(amount))
+    end
+  end
+
+  role :destination_account do
+    def deposit(amount)
+      increase_balance(amount)
+    end
+  end
+
+  def transfer(amount)
+    source_account.transfer(amount)
+  end
+end
+```

data/lib/rietveld/context.rb

@@ -1,4 +1,38 @@
-module Rietveld
+module Rietveld # :nodoc:
+
+  ##
+  # The Context class supplies a simple DSL for creating roles and interaction
+  # between those roles
+  #
+  # An example:
+  #
+  #   class MoneyTransferContext < Rietveld::Context
+  #     role :source_account do
+  #       def withdraw(amount)
+  #         if balance >= amount
+  #           decrease_balance(amount)
+  #           amount
+  #         else
+  #           raise 'Insufficient funds'
+  #         end
+  #       end
+  #
+  #       def transfer(amount)
+  #         destination_account.deposit(withdraw(amount))
+  #       end
+  #     end
+  #
+  #     role :destination_account do
+  #       def deposit(amount)
+  #         increase_balance(amount)
+  #       end
+  #     end
+  #
+  #     def transfer(amount)
+  #       source_account.transfer(amount)
+  #     end
+  #   end
+  #
   class Context
     class << self
       def roles

data/lib/rietveld/version.rb

@@ -1,3 +1,3 @@
 module Rietveld
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rietveld
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Marten Schilstra