codefly 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf8a7ed23f0e857dcd2c7cf51460b2ecb4ec80d
-  data.tar.gz: 7101eef0854af60b7496ce6553eb8ebc695c8181
+  metadata.gz: c570cc226d705a39be495be7555ea1882fe36b64
+  data.tar.gz: e4b747f462ace7008fe64603b8f8d692faa3d339
 SHA512:
-  metadata.gz: 0999928e52779c0bca027a1de8f432c1f39b12c2f67a8c9a806b49e4ab9f17728fe9e55d3e8a7f69d3e88c1c3ecdcc145f95afd9f53bb473d0365f032f26aa0d
-  data.tar.gz: a0373f0823745f21759b5fa1b7b8bb0054e7803cf6104aabe30beca9d7a1932e80b98ea27b1a6a0477536ac6ef1a9a4ad762518d4cc9f97e0e79f8cb5ad46b83
+  metadata.gz: 825671fa3341dbcb592ea57fe2db1950fa5a08b767a2c71c0cb855c60290c579aeb9c1cee24f1d3db26f330c1502def20bd342a0add639dc1e25aa0865e7cb3a
+  data.tar.gz: 1d8f7f4a8b21f4ffa8e67d2069e368092b67f01476c8c3c0600e991153f828ae7486598eb7f8c4d8c7fa4595746cd87ad166aa801fce4630b8c97b599c26589f

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/README.md

@@ -1,23 +1,51 @@
-CodeFly is a gem that allows you to execute parallel / asynchronous code in Rails, in a easy way.
+With CodeFly you can execute parallel / asynchronous code in Rails, in a easy way.
 
-This is how a classic code looks like:
+## This is how a classic code looks like:
 ```ruby
-blue_cars = Vehicle.where(type: "car", color: "blue") # 1 sec
-accessories = Accessory.where(type: "car") # 1 sec
-some_code(blue_cars, accessories) # 0.5 sec
+@blue_cars = Vehicle.where(type: "car", color: "blue") # 0.1 sec
+@accessories = Accessory.where(type: "car") # 0.1 sec
+# some code
+# some code using @blue_cars and @accessories
 ```
 
-This is how a flied code looks like:
+## This is how a flied code looks like:
 ```ruby
-fly(:A) { blue_cars = Vehicle.where(type: "car", color: "blue") } # 1 sec
-fly(:B) { accessories = Accessory.where(type: "car") } # 1 sec
+fly(:A) { @blue_cars = Vehicle.where(type: "car", color: "blue") } # 0.1 sec
+fly(:B) { @accessories = Accessory.where(type: "car") } # 0.1 sec
+# some code
 wait_fly(:A, :B)
-some_code(blue_cars, accessories) # 0.5 sec
+# some code using @blue_cars and @accessories
 ```
 
-The first code will take 2.5 sec, but the second will take only 1.5, almost the twice of speed. On the second code, the A and B queries will be executed at the same time (I will assume that your DB have more than 1 core), and the Ruby will be free to execute your own code while these 2 queries are being processed.
+The first code will take 0.2 sec, but the second will take only 0.1 sec, the twice of speed. On the second code, the A and B queries will be executed at the same time (I will assume that your DB have more than 1 core), and the Ruby will be freed to execute another code while these 2 queries are being processed.
 
-The CodeFly methods are:
 
-fly(id) { async code }
-wait_fly(id_1[, id_2, …]): block until the async codes terminate
+## The CodeFly methods are:
+
+- *fly(id)* { async code }
+- *wait_fly(id_1[, id_2, …])*: block until the async codes terminate
+
+
+## Advanced techniques
+
+You can use CodeFly to make prediction algorithms:
+```ruby
+fly(:ans_a) { @blue_cars = Vehicle.where(type: "car", color: "blue") }
+fly(:ans_b) { @yellow_cars = Vehicle.where(type: "car", color: "yellow") }
+fly(:ans_c) { @other_cars = Vehicle.where(type: "car") }
+
+wait_fly(:ans_a)
+if @blue_cars.present?
+  # ...
+else
+  wait_fly(:ans_b)
+  if @yellow_cars.present?
+    #...
+  else
+    wait_fly(:ans_c)
+    #...
+  end
+end
+```
+
+In this sample, you are triggering the all queries before you know what you need. So at the time that we get the first answer, the db probally provide us the others answers, saving time.

data/codefly.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Daniel Loureiro"]
   spec.email         = ["loureirorg@gmail.com"]
   spec.summary       = %q{Parallel / async code in Rails}
-  spec.description   = %q{CodeFly is a gem that allows you to execute parallel / asynchronous code in Rails, in a easy way.}
+  spec.description   = %q{Execute parallel / asynchronous code in Rails, in a easy way}
   spec.homepage      = "https://github.com/loureirorg/codefly"
   spec.license       = "MIT"
 

data/lib/codefly/version.rb

@@ -1,3 +1,3 @@
 module Codefly
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codefly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Loureiro
@@ -38,8 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: CodeFly is a gem that allows you to execute parallel / asynchronous code
-  in Rails, in a easy way.
+description: Execute parallel / asynchronous code in Rails, in a easy way
 email:
 - loureirorg@gmail.com
 executables: []
@@ -51,6 +50,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- codefly-0.0.1.gem
 - codefly.gemspec
 - lib/codefly.rb
 - lib/codefly/version.rb