time_seq 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4a6d9b7c6aa42b4be3fc512c9666e69ada37c70
-  data.tar.gz: 0e107036ca4831c4d3fc65337bc5d0e464806c94
+  metadata.gz: 386ce8c5df4891c9bb704bed44ba5075477edfba
+  data.tar.gz: fbc7491186230799388a4be91704f0a4d5ad2262
 SHA512:
-  metadata.gz: fdc76e2d6d9bb72a29c8b935749556c165884ebb7047807449a8510a53945ca3b96b9aeaeda97eb81aa2dae422e3dc193863a3df5169910130053a0729d8b05d
-  data.tar.gz: 01e779cc198833a4d67ac8b8f8fbbfc15a1b69d14663f9edfeb9926575d20c49ecad33366204d20b046163d3e0cfcc61e1b4b49c5dc686dd6112524ab5d776b0
+  metadata.gz: 7f839939978f366c94bb579b6693a2db753cd6a5ba4db828899e2cbc9748b4125072d4b492a39d29a3b7f567b2fec56222ac9af31ba68c4fc56e1fbdb9d4a377
+  data.tar.gz: 6befff2858d6e004f289426bd7ae6659cf11df82509f89e4442feb7e498cd3514702655fc2323c5a281b5b7630b05186c1d4eb5a7681bcec0d2267c6815c80ed

data/README.md

@@ -1,8 +1,6 @@
 # TimeSeq
 
-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/time_seq`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A well-understood interface to build lazy enumerator for iterating time points
 
 ## Installation
 
@@ -22,15 +20,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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]/time_seq.
-
+```ruby
+require 'time_seq'
+
+seq = TimeSeq.new from: Time.gm(2016, 'nov'), step: 1.hour, to: Time.gm(2016, 'nov', 1, 5)
+=> #<TimeSeq:19952030 @from=2016-11-01 00:00:00 UTC, @step=1 hour, @to=2016-11-01 05:00:00 UTC>
+seq.to_a
+=> [2016-11-01 00:00:00 UTC,
+    2016-11-01 01:00:00 UTC,
+    2016-11-01 02:00:00 UTC,
+    2016-11-01 03:00:00 UTC,
+    2016-11-01 04:00:00 UTC,
+    2016-11-01 05:00:00 UTC]
+
+# Ending is not required. It can do whatever a Enumerator::Lazy can do
+infinite_seq = TimeSeq.new from: Time.gm(2016, 'dec', 1, 7, 30), step: 1.day
+=> #<TimeSeq:19403900 @from=2016-12-01 07:30:00 UTC, @step=1 day>
+infinite_seq.first(10)
+=> [2016-12-01 07:30:00 UTC,
+    2016-12-02 07:30:00 UTC,
+    2016-12-03 07:30:00 UTC,
+    2016-12-04 07:30:00 UTC,
+    2016-12-05 07:30:00 UTC,
+    2016-12-06 07:30:00 UTC,
+    2016-12-07 07:30:00 UTC,
+    2016-12-08 07:30:00 UTC,
+    2016-12-09 07:30:00 UTC,
+    2016-12-10 07:30:00 UTC]
+```

data/lib/time_seq/version.rb

@@ -1,3 +1,3 @@
 class TimeSeq
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/time_seq.rb

@@ -5,11 +5,14 @@ class TimeSeq < DelegateClass(Enumerator::Lazy)
   class << self
 
     alias_method :init, :new
+    private :init
 
     def new(opt={})
-      init(nil).instance_eval do
-	extract opt
-	build_enum
+      init(nil).tap do |time_seq|
+	time_seq.instance_eval do
+          extract opt
+          build_enum
+        end
       end
     end
   end
@@ -39,7 +42,7 @@ class TimeSeq < DelegateClass(Enumerator::Lazy)
       loop do
         yielder << time_point
         time_point = step.since time_point
-	break if to and time_point > to
+        break if to and time_point > to
       end
     end.lazy
     __setobj__ @e

data/time_seq.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["ken"]
   spec.email         = ["block24block@gmail.com"]
 
-  spec.summary       = %q{generate a (infinite) time sequence }
-  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.summary       = %q{generate a time sequence, which may be infinite}
+  spec.description   = %q{a well-understood interface to build lazy enumerator for iterating time points}
   spec.homepage      = "https://github.com/turnon/time_seq"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_seq
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ken
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 
+description: a well-understood interface to build lazy enumerator for iterating time
+  points
 email:
 - block24block@gmail.com
 executables: []
@@ -84,7 +85,8 @@ files:
 - lib/time_seq/version.rb
 - time_seq.gemspec
 homepage: https://github.com/turnon/time_seq
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -105,5 +107,5 @@ rubyforge_project:
 rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: generate a (infinite) time sequence
+summary: generate a time sequence, which may be infinite
 test_files: []