sleep2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3145e727d8fcda8a5a3ac2f5ea23fad3b15cf865
-  data.tar.gz: 91cb4041208c854075f3f276b210f89d6b4b602c
+  metadata.gz: cfb0c06a9f091832dcfa13ce7996f27626335442
+  data.tar.gz: 792e923777e1e6f6eb682a02d25d7849c428acf3
 SHA512:
-  metadata.gz: 30fbf6567c42df950d82f9c9eb06e94250faa6e2da8d8f95072e0cde0d8ffcb9993d4aa73362de7520a67ed7136bc758799f3957812ca5c759f97914f49ed9c2
-  data.tar.gz: b64e98e06f5441748be779d1ac179afacec52930606b7a3bed70341c89c2e0b34069f4d8df9bb6fabc7b2dec711029c16be1e778cb948cae7ba24b3dadfa1d88
+  metadata.gz: b740c8560d8b65db38313d8880e9b85f1295cbada30f6ccc1ddf38cb0c27a10cacd4037bab141e8dfeb12c750c679e5bd02834b8c2ae5d728dc9226312c7c7b6
+  data.tar.gz: 02b67b43d475528d2dfbd922d95ffa8b855baea649371746fdcd88e00a4ed6eb1c3933c7c10e49cb12025a2d52ec10db4d525416744ac86eb14ab6462cdbf1c3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+0.2.0 / 2017-04-20
+==================
+
+  * Added new API
+  * Reimplemented sleeping method
+  * Added changelog
+
+0.1.0 / 2017-03-04
+
+  * Initial version

data/README.md

@@ -1,6 +1,8 @@
 # Sleep2
 
-Ruby sleep with extra magical stuff.
+Ruby sleep with extra magical stuff. These extra stuff will be useful when you
+are developing an algorithm with some kind of delay patterns such as in
+animation.
 
 ## Installation
 
@@ -25,29 +27,38 @@ Don't forget to `require 'sleep2'` first.
 ### Do math with sleep.
 
 ```ruby
->> sleep = Sleep2.new(2) # no sleep when instantiating
+>> sleep = Sleep2[2] # no sleep when instantiating
 #=> #<Sleep2:0x2afc2eaef970>
 >> sleep # sleeps for 2 seconds
 #=> #<Sleep2:0x2afc2eaef970>
->> sleep * 2 # sleeps twice longer than it should
-#=> 4
->> sleep / 2 # sleeps half the time
-#=> 1
->> sleep ** 2 # sleeps for 8 seconds
-#=> 8
+>> delay = sleep * 2 # instantiate new sleep object (therefore no sleeping yet)
+#=> #<Sleep2:0x2afc217b09d0>
+>> delay # sleeps twice longer than sleep
+#=> #<Sleep2:0x2afc217b09d0>
 ```
 
 ### Compare sleep with integer (in seconds) or another of its type
 
 ```ruby
->> sleep if sleep > 3 # not sleeping at all
+>> sleep if sleep > 3 # not sleeping at all since sleep duration is 2 seconds
 #=> nil
->> freeze = Sleep2.new(3) # no sleep when instantiating
+>> delay = Sleep2[3] # no sleep when instantiating
 #=> #<Sleep2:0x2afc2eb138c0>
->> freeze > sleep ? freeze : sleep # sleeps for 3 seconds
+>> delay > sleep ? delay : sleep # sleeps for 3 seconds
 #=> #<Sleep2:0x2afc2eb138c0>
 ```
 
+### Change current instance duration
+
+```ruby
+>> freeze = Sleep2[3] # no sleep when instantiating
+#=> #<Sleep2:0x2afc2262c2c0>
+>> freeze[4] # no sleep when changing duration
+#=> 4.0
+>> freeze # sleeps for 4 seconds
+#=> #<Sleep2:0x2afc2262c2c0>
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/styd/sleep2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/sleep2.rb

@@ -3,34 +3,56 @@ require "sleep2/version"
 class Sleep2
   include Comparable
 
-  attr_accessor :time, :time_of_instantiation
+  def self.[] duration
+    new duration
+  end
+
+  attr_accessor :duration, :sleep_proc
+  attr_writer :new
 
-  def initialize time
-    @time_of_instantiation = Time.now
-    @time = time.to_f
+  def initialize duration
+    if duration.class.ancestors.include?(Numeric)
+      @duration = duration.to_f
+    elsif duration.class == self.class
+      @duration = duration.duration.to_f
+    else
+      raise TypeError, "can't convert #{duration.class} into time interval"
+    end
+    @new = true
+  end
+
+  def new?
+    @new
   end
 
   def inspect
-    # Avoid sleeping the first time it is called (the moment of instantiation)
-    unless Time.now - time_of_instantiation <= 0.1
-      sleep time
+    # Avoids sleeping the first time it is called (the moment of instantiation)
+    unless new?
+      self.sleep_proc.call
+    else
+      self.new   = false
+      self.sleep_proc = proc { sleep duration }
     end
   end
 
-  # Make sleep instance can be calculated with integer
+  def [] new_duration
+    self.duration = new_duration
+  end
+
+  # Creates new sleep instance by calculating it with integer
   [:*, :/, :+, :-, :%, :**].each do |m|
     define_method m do |num|
-      num = num.time if num.kind_of? self.class
-      sleep time.public_send(m, num)
+      num = num.duration if num.kind_of? self.class
+      self.class[ duration.public_send(m, num) ]
     end
   end
 
-  # Make sleep instance comparable with another object of its type and integer
+  # Makes sleep instance comparable with another object of its type and integer
   def <=>(other)
     if other.kind_of? self.class
-      self.time <=> other.time
+      self.duration <=> other.duration
     elsif other.kind_of? Integer
-      self.time <=> other
+      self.duration <=> other
     end
   end
 end

data/lib/sleep2/version.rb

@@ -1,3 +1,3 @@
 class Sleep2
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleep2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby sleep with extra magical stuff.