dancer 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e269b43ddeb6eefae3fb07baf0d920e6d6420192
-  data.tar.gz: acc613349321fe054ab4d40d8c920958512bcc8b
+  metadata.gz: 5cf70523bc4b8d7dccaf7597e7abc8fc39e1106a
+  data.tar.gz: 401eb016fb3f5a36cf4ff19beecaa84c91161644
 SHA512:
-  metadata.gz: 78a6b1ddda62b4ff57d0cc2e51bef5c8a4d4b06fd19951adb0db89e76bb540a6245468cce8a3d873eeb399b8849cc76acfb857ed008c64f77e1ee856e2a85c86
-  data.tar.gz: 0dbf6789d4adde89e0b552e553ddc6a83f34f7e7c8ae501cd1278888615f27ae6bd19656976688cba1a0dcf81ab8a8310042980fa0a34c3ee96929c292da6a3f
+  metadata.gz: 484d078cfaed881a026ad2652a755a8362e2aa5c9dfe6296bc2acb230e214240e30ef912af75c90f8495009090d0331bfb3cbbcc8545db7c8aed48421dff9e26
+  data.tar.gz: 136d0d1c88c0d1bc728ec5c8e4693209145aadd11e1ec68ca35710def91e4bb9580925320d59bb8b4db26b6a185f85263a1da08a44b109f2ba1c15a0944403f7

data/Gemfile

@@ -1,4 +1,3 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in dancer.gemspec
 gemspec

data/README.md

@@ -1,8 +1,7 @@
 # Dancer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dancer`. To experiment with that code, run `bin/console` for an interactive prompt.
+A small library to move forward or backward through Time in predefined steps.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,9 +19,85 @@ Or install it yourself as:
 
     $ gem install dancer
 
+
 ## Usage
 
-TODO: Write usage instructions here
+### Basic usage
+
+```ruby
+now = Time.now
+
+# takes 4 arguments: `start_at`, `end_at`, `step`, and `exclude_end` (like Range).
+dancer = Dancer.new(now, now+86400, 3600, true)
+
+dancer.each_time do |time|
+  # do something...
+end
+
+dancer.each_range do |range|
+  # do something...
+end
+```
+
+### Usage with a Range
+
+```ruby
+# takes 2 arguments: `range` and `step`.
+dancer = Dancer.range(now..(now+86400), 3600)
+
+dancer.each_time do |time|
+  # do something...
+end
+```
+
+### Usage with an Extent
+
+```ruby
+# takes 4 arguments: `start_at`, `size`, `step` and `exclude_end`.
+dancer = Dancer.extent(now, 24, 3600, true)
+
+dancer.each_time do |time|
+  # do something...
+end
+```
+
+### Usage with an array of times
+
+```ruby
+# takes 3 arguments: `keys`, `step`, and `exclude_end`.
+dancer = Dancer.extent(now, 24, 3600, true)
+
+dancer.each_time do |time|
+  # do something...
+end
+```
+
+### Usage with a predefined step size
+
+```ruby
+TradingPeriod = Dancer::Defined.new(1800)
+
+# accepts the same 4 methods but with `step` omitted from each
+dancer = TradingPeriod.extent(now, 24, true)
+
+dancer.each_time do |time|
+  # do something...
+end
+```
+
+### Other methods
+
+```ruby
+# takes 4 arguments: `start_at`, `end_at`, `step`, and `exclude_end` (like Range).
+dancer = Dancer.new(now, now+86400, 3600, true)
+
+dancer.size
+> 24
+
+dancer.duration
+> 86400
+```
+
 
 ## Development
 
@@ -30,6 +105,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dancer.
@@ -38,4 +114,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/dancer.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Steve Hoeksema"]
   spec.email         = ["steve@kotiri.com"]
 
-  spec.summary       = "Dancer steps through Time"
-  spec.description   = "Dancer steps through Time"
+  spec.summary       = "Dancer steps in Time"
+  spec.description   = "A small library to move forward or backward through Time in predefined steps"
   spec.homepage      = "https://github.com/steveh/dancer"
   spec.license       = "MIT"
 
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry-byebug"
 end

data/lib/dancer.rb

@@ -38,7 +38,7 @@ class Dancer
   def size
     return unless bounded?
 
-    ((end_at.public_send(operator, 1) - start_at) / step).abs
+    ((end_at.public_send(operator, offset) - start_at) / step).abs.to_i
   end
 
   alias count size
@@ -48,7 +48,11 @@ class Dancer
   def range
     return unless bounded?
 
-    start_at..end_at
+    if exclude_end?
+      start_at...end_at
+    else
+      start_at..end_at
+    end
   end
 
   # Enumerator for each start time
@@ -71,9 +75,16 @@ class Dancer
 
     current = start_at
     while current.public_send(comparator, end_at)
-      current_end_at = current.public_send(operator, step) - (0.public_send(operator, 1))
-      current_range = current..current_end_at
+      current_end_at = current.public_send(operator, step) - (0.public_send(operator, offset))
+
+      current_range = if exclude_end?
+        current...current_end_at
+      else
+        current..current_end_at
+      end
+
       yield current_range
+
       current = current.public_send(operator, step)
     end
     self
@@ -83,20 +94,26 @@ class Dancer
   def duration
     return unless bounded?
 
-    (end_at - start_at).abs + 1
+    (end_at - start_at).abs.to_i + offset
   end
 
   alias to_i duration
 
-  def bounded?
-    start_at && end_at
-  end
-
   def to_s
-    "#{start_at.inspect}..#{end_at.inspect} (step: #{step})"
+    "#{start_at.inspect}#{exclude_end? ? "..." : ".."}#{end_at.inspect} (step: #{step})"
   end
 
   def inspect
     "#<Dancer #{to_s}>"
   end
+
+  protected
+
+  def bounded?
+    start_at && end_at
+  end
+
+  def offset
+    exclude_end? ? 0 : 1
+  end
 end

data/lib/dancer/factories.rb

@@ -11,15 +11,24 @@ class Dancer
 
   # Create a timeslice from a start time and a number of a points
   def self.extent(start_at, size, step, exclude_end = false)
-    end_at = start_at + (step * size) - 1
+    offset = exclude_end ? 0 : 1
+
+    end_at = if size.negative?
+      start_at + (step * size) + offset
+    else
+      start_at + (step * size) - offset
+    end
 
     new(start_at, end_at, step, exclude_end)
   end
 
   # Create a timeslice from a list of start times
   def self.keys(keys, step, exclude_end = false)
+    offset = exclude_end ? 0 : 1
+
     start_at = keys.min
-    end_at = keys.max ? (keys.max + step - 1) : nil
+
+    end_at = keys.max ? (keys.max + (step * offset) - offset) : nil
 
     new(start_at, end_at, step, exclude_end)
   end

data/lib/dancer/version.rb

@@ -1,3 +1,3 @@
 class Dancer
-  VERSION = "0.1.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dancer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Steve Hoeksema
@@ -66,7 +66,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Dancer steps through Time
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small library to move forward or backward through Time in predefined
+  steps
 email:
 - steve@kotiri.com
 executables: []
@@ -115,5 +130,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Dancer steps through Time
+summary: Dancer steps in Time
 test_files: []