ocarina_of_time 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c76b5c32fdda58e5ba617450ad0f9acee53b290a
-  data.tar.gz: caddfbedba3fe902dce0c19604a71388cd2633d5
+  metadata.gz: 9b8f6353a6d7086e4b1f5ee75636393fa92fab8e
+  data.tar.gz: ff95bfcd93e4446b745bce5fc75711005ce7f159
 SHA512:
-  metadata.gz: 297211847d7ab989b49df4ccdaa6fcf8955ea1abef018dcded9b0b0255a9706d8573e399fcadfd1bf332839b3f6e6bdfb725968db9d5c2210a8e86b4c89f7185
-  data.tar.gz: 581dd32dc21fa8bad047554d9dcdeed68207a0f6f2c072c108797014ba7cc62256e44545b3b724c4b7ffdc2ec9d2147e286461acf5ab48c7f0fec099668af44b
+  metadata.gz: 8e0f8f63b34f62f7674354382002f98d6f452408e994f94441da35a6f3156b23ef34c668ca5de382c7bd4c43ff39021be2e77b0185968cb27aa5f06b987a29e8
+  data.tar.gz: aab1b27442879ce34c190ccca4a001b52accda26e8666897878246af4da327e709338a0ca8d0151fa7db94a386ece6a53553e8198a7fc9829b911be3e8672dc2

data/README.md

@@ -16,6 +16,8 @@ Play this song near a blue Time Block.
 
 ## Usage
 
+I'm still sort of fleshing out some things. So, I'll update thing as they change.
+
 ```ruby
 require 'ocarina_of_time'
 
@@ -24,30 +26,31 @@ timeline = OcarinaOfTime::Timeline.new
 # beginning of time
 timeline.beginning
 # => 2017-02-21 10:10:16 -0500
-
 # check for beginning of time
 timeline.beginning?
 
-# end of time
 timeline.ending
 # => false
-
-# check for end of time
 timeline.ending?
 # => false
-
-# set beginning of end of time
-timeline.ending = Time.now
-
+# set end of time
+timeline.ending(Time.now)
 timeline.ending?
 # => true
-
 timeline.ending
 # => 2017-02-21 10:15:45 -0500
+
+# or, just make it flexible
+timeline.flex!
+
 ```
 
 ## Timeline
-A timeline is a way of displaying a list of events in chronological order, sometimes described as a project artifact. Timelines can use any time scale, depending on the subject and data. Most timelines use a linear scale, where a unit of distance is equal to a set amount of time.
+A timeline is a way of displaying a list of events in chronological order, sometimes described as a project artifact ( an event ). Timelines can use any time scale, depending on the subject and data. Most timelines use a linear scale, where a unit of distance is equal to a set amount of time. Or, well, at least that is what Wikipedia says.
+
+### The Short and Simple
+
+A timeline has a beginning ( sometimes ) and an ending ( sometimes ). You can have a flexible timeline where, as events are added, the beginning and ending points in time will be determined by the actual events themselve.
  
 ```ruby
 # will return a unique id number for the timeline event

data/examples/timeline.rb

@@ -0,0 +1,62 @@
+$: << File.expand_path("../../lib", __FILE__)
+require "ocarina_of_time"
+require "pry"
+
+# create timeline
+timeline = OcarinaOfTime::Timeline.new
+
+# flexible timeline
+timeline.flex!
+
+# add events ( roughly =~ 2 seconds from eachother )
+["Example 1", "Example 2", "Example 3"].each do |example|
+  sleep 2
+  timeline.events.add(label: example, time: Time.now)
+end
+
+# check flexbility
+timeline.flex?
+# => true
+
+# Some quick examples ( not everything )
+
+timeline.events.times
+# => [2017-02-21 20:43:11 -0500, 2017-02-21 20:43:13 -0500, 2017-02-21 20:43:15 -0500]
+
+timeline.events.ids
+# => ["69ba109e-15cb-44cc-b541-042cc1cdaf82", "5e4dc4ff-c263-4365-ab3a-c37b2c11af66", "11801833-ba11-47c8-aef1-b1d621e461dd"]
+
+timeline.events.dates
+# => [#<Date: 2017-02-21 ((2457806j,0s,0n),+0s,2299161j)>]
+
+timeline.events
+# => #<OcarinaOfTime::Events:0x007f8fe847d590
+# @all=
+#  [#<OcarinaOfTime::Event:0x007f8fe847d428
+#    @data=
+#     #<struct Struct::EventData
+#      id="69ba109e-15cb-44cc-b541-042cc1cdaf82",
+#      label="Example 1",
+#      tags=#<Set: {}>,
+#      time=2017-02-21 20:43:11 -0500,
+#      created=2017-02-21 20:43:11 -0500,
+#      value=false>>,
+#   #<OcarinaOfTime::Event:0x007f8fe847d040
+#    @data=
+#     #<struct Struct::EventData
+#      id="5e4dc4ff-c263-4365-ab3a-c37b2c11af66",
+#      label="Example 2",
+#      tags=#<Set: {}>,
+#      time=2017-02-21 20:43:13 -0500,
+#      created=2017-02-21 20:43:13 -0500,
+#      value=false>>,
+#   #<OcarinaOfTime::Event:0x007f8fe847cd98
+#    @data=
+#     #<struct Struct::EventData
+#      id="11801833-ba11-47c8-aef1-b1d621e461dd",
+#      label="Example 3",
+#      tags=#<Set: {}>,
+#      time=2017-02-21 20:43:15 -0500,
+#      created=2017-02-21 20:43:15 -0500,
+#      value=false>>]>
+

data/lib/ocarina_of_time/timeline.rb

@@ -3,9 +3,7 @@ module OcarinaOfTime
   # Respresent the logic of a Timeline. 
   # @author Kent 'picat' Gruber 
   class Timeline
-
-    attr_accessor :beginning
-    attr_accessor :ending
+    # Access events.
     attr_accessor :events
 
     # Create a new **Timeline** object.
@@ -15,12 +13,42 @@ module OcarinaOfTime
     # @option args [Time] :end ending point in time (default: false)
     # @return [void]
     def initialize(args={})
-      @beginning = args[:begin] || Time.now
-      @ending    = args[:end]   || false
-      @flex      = false # have a rigid timeline
+      if args[:flex]
+        @flex      = true
+      else
+        @flex      = false # have a rigid timeline
+        @beginning = args[:begin] || Time.now
+        @ending    = args[:end]   || false
+      end
       @events    = Events.new
     end
 
+    # Either get the beinning of the timline or set it.
+    def beginning(set=false)
+      if set
+        @beginning = set unless @flex
+      else
+        if @flex
+          @events.by(newest: true).first
+        else
+          @beginning
+        end
+      end
+    end
+
+    # Either get the ending of the timline or set it.
+    def ending(set=false)
+      if set
+        @ending = set unless @flex
+      else
+        if @flex
+          @events.by(oldest: true).first
+        else
+          @ending
+        end
+      end
+    end
+
     # Turn on a flexible timeline, where events will change the potential
     # range of the timeline. If a beginning is set, an unflexible timeline
     # will not allow any new events to be set before that time. A flexible timeline
@@ -31,6 +59,13 @@ module OcarinaOfTime
       on ? @flex = true : @flex = false
     end
 
+    # Yolo swag, lets just turn the flex on.
+    #
+    # @return[void] 
+    def flex!
+      @flex = true
+    end
+
     # Check if the Timeline is flexible or not.
     #
     # @return[Boolean] 
@@ -43,7 +78,15 @@ module OcarinaOfTime
     # 
     # @return[Boolean] 
     def ending?
-      @ending ? true : false
+      if @flex
+        if @events.data.all.empty?
+          false
+        else
+          true
+        end 
+      else
+        @ending ? true : false
+      end
     end
 
     # Check if there's currently a beginning of time
@@ -51,7 +94,15 @@ module OcarinaOfTime
     # 
     # @return[Boolean] 
     def beginning?
-      @beginning ? true : false
+      if @flex 
+        if @events.data.all.empty?
+          false
+        else
+          true
+        end
+      else
+        @beginning ? true : false
+      end
     end
 
     # Get the difference in time between +two+ points in +time+.

data/lib/ocarina_of_time/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocarina_of_time
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kent Gruber
@@ -72,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - examples/debug.rb
+- examples/timeline.rb
 - lib/ocarina_of_time.rb
 - lib/ocarina_of_time/event.rb
 - lib/ocarina_of_time/events.rb