temporal_object 0.0.3 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    temporal_object (0.0.2)
+    temporal_object (0.1.0)
       time_span
 
 GEM

data/README.md

@@ -1,6 +1,16 @@
 Temporal Object
 ===============
 
+This gem is implemented as a mixin, so that you can do the following:
+
+```ruby
+require 'temporal_object'
+include TemporalObject
+```
+
+Will add instance methods to manipulate TimeLines (and thereby TimeSpans and RelativeTimes) to the including object.
+
+
 Most of the temporal aspects for Temporal Object are delegated to TimeSpan.  The Temporal Object just has any number of
 TimeSpan statuses.
 
@@ -9,3 +19,6 @@ TimeSpan statuses.
 * [rdoc] (http://rubydoc.info/gems/time_span/0.0.3/frames)
 * [github] (https://github.com/coyote/time_span)
 * [rubygems] (https://rubygems.org/gems/time_span)
+
+
+Note, that this implementation is quite changed from gem version 0.0.3, where TemporalObjects needed to be created, which pointed to your actual object.  Code has been simplified thereby, and is much cleaner.

data/lib/temporal_object.rb

@@ -1,57 +1,39 @@
  require 'temporal_object/version'
  require 'time_span'
 
+
 # @author Craig A. Cook
 module TemporalObject
 
-  # @author Craig A. Cook
-  class TemporalObject
-
-    # [Array]  of TimeSpan::TimeLine statuses for temporal attributes
-    attr_accessor :statuses
-    # [String] object human readable identifier
-    attr_accessor :name
-    # [Object]  associated Ruby Object of any kind
-    attr_accessor :reference_object   # arbitrary Ruby object associated.
-
-
-    ## must be able to:
-    #===============================
-    #  -- add, remove a timeline
-    #  -- erase all timelines, all statuses from a timeline
-    #  -- remove all timelines
-
-    # @param [String] nom is the TemporalObject's name
-    # @param [Object] reference_obj is the object associated with this TemporalObject
-    def initialize(nom="", reference_obj=Object.new)
-      @statuses = []         # Array of TimeSpan::TimeLine
-      @name     = ""
-      @reference_object = reference_obj
-    end
-
-    #  add a timeline to the TemporalObject
-    # @param [TimeSpan::TimeLine] timeline added to the object
-    # @return [Array] adjusted list of timelines if no exception raised.
-    def add_timeline(timeline)
-      raise ArgumentError, "Can only add a TimeSpan::TimeLine to a TemporalObject's statuses" unless timeline.kind_of? TimeSpan::TimeLine
-      @statuses << timeline
-    end
-
-    # remove all TimeLine s from the TemporalObject
-    # @return [Array] the associated timelines
-    def remove_timelines
-      @statuses = []
-    end
-
-    # delete the cited   timeline
-    # @param timeline [TimeSpan::TimeLine] timeline to delete
-    # @raise ArgumentError if called with a non-TimeLine object
-    # @return [TimeSpan::TimeLine, nil] TimeLIne deleted if successful or nil if not
-    def remove_timeline(timeline)
-      raise ArgumentError, "Can only remove a TimeLine with this call."  unless timeline.kind_of? TimeSpan::TimeLine
-      @statuses.delete(timeline)
-    end
+  # [Array]  of TimeSpan::TimeLine statuses for temporal attributes
+  attr_accessor :temporal_statuses
+
+  def initialize
+    super
+    @temporal_statuses = []         # Array of TimeSpan::TimeLine
+  end
+
+  #  add a timeline to the TemporalObject
+  # @param [TimeSpan::TimeLine] timeline added to the object
+  # @return [Array] adjusted list of timelines if no exception raised.
+  def add_timeline(timeline)
+    raise ArgumentError, "Can only add a TimeSpan::TimeLine to a TemporalObject's statuses" unless timeline.kind_of? TimeSpan::TimeLine
+    @temporal_statuses << timeline
+  end
+
+  # remove all TimeLine s from the TemporalObject
+  # @return [Array] the associated timelines
+  def remove_timelines
+    @temporal_statuses = []
+  end
 
+  # delete the cited   timeline
+  # @param timeline [TimeSpan::TimeLine] timeline to delete
+  # @raise ArgumentError if called with a non-TimeLine object
+  # @return [TimeSpan::TimeLine, nil] TimeLIne deleted if successful or nil if not
+  def remove_timeline(timeline)
+    raise ArgumentError, "Can only remove a TimeLine with this call."  unless timeline.kind_of? TimeSpan::TimeLine
+    @temporal_statuses.delete(timeline)
   end
 
 end

data/lib/temporal_object/version.rb

@@ -1,4 +1,3 @@
 module TemporalObject
-  VERSION = "0.0.3"
-
+  VERSION = "0.1.0"
 end

data/spec/temporal_object/temporal_object_spec.rb

@@ -1,9 +1,16 @@
   require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 
+  # functionality is defined as a mixin, not an Object, so
+  #  here we create a mock class for testing the temporal_object mixin gem
+  class TemporalObjectTester  < Object
+    require 'temporal_object'
+    include TemporalObject
+  end
+
   describe "TemporalObject"  do
 
     let (:temporal_object) do
-      TemporalObject::TemporalObject.new "Temporal Test Object"
+      TemporalObjectTester.new
     end
 
     let (:timeline) do
@@ -14,17 +21,35 @@
       TimeSpan::TimeLine.new "second test TimeLine"
     end
 
+    context  "TemporalObject" do
 
-    context  "TemporalObject::TemporalObject" do
+      context "added #instance methods" do
 
-      context "#instance methods" do
+        context "initial state" do
 
-        context "Initial state" do
           it "should have no timelines" do
-            temporal_object.statuses.should be_empty
+            temporal_object.temporal_statuses.should be_empty
+          end
+
+        end
+
+        context "methods defined" do
+
+          it "should respond_to? remove_timelines" do
+            temporal_object.should respond_to :remove_timelines
+          end
+
+          it "should respond_to? add_timeline (some_timeline)" do
+            temporal_object.should respond_to(:add_timeline)
           end
+
+          it "should respond_to? remove_time"  do
+            temporal_object.should respond_to(:remove_timeline)
+          end
+
         end
 
+
         context "TimeSpan::TimeLine manipulations" do
 
           before (:each) do
@@ -32,23 +57,32 @@
           end
 
           it "can add a TimeLine to the TemporalObject" do
-            temporal_object.statuses.should_not be_empty, "TemporalObject::TimeLine not present."
+            temporal_object.temporal_statuses.should_not be_empty, "TemporalObject::TimeLine not present."
           end
 
+          it "should not allow adding a non-timeline object to the temporal statuses" do
+            lambda { temporal_object.add_timeline "foo"}.should raise_error ArgumentError
+          end
+
+
           it "can remove a given timeline from the temporal object" do
             temporal_object.add_timeline timeline2
             temporal_object.remove_timeline timeline
-            temporal_object.statuses.should_not be_empty #, "TemporalObject::TimeLine does not have 1 status when it should."
+            temporal_object.temporal_statuses.should_not be_empty #, "TemporalObject::TimeLine does not have 1 status when it should."
+          end
+
+          it "should not accept a non-timeline for removal from temporal statuses" do
+            lambda { temporal_object.remove_timeline "foo" }.should raise_error, ArgumentError
           end
 
           it "can remove a given timeline from the temporal object" do
             temporal_object.remove_timeline timeline
-            temporal_object.statuses.should be_empty #, "TemporalObject::TimeLine does not have 1 status when it should."
+            temporal_object.temporal_statuses.should be_empty #, "TemporalObject::TimeLine does not have 1 status when it should."
           end
 
           it "can remove all timelines from the TemporalObject" do
             temporal_object.remove_timelines
-            temporal_object.statuses.should be_empty
+            temporal_object.temporal_statuses.should be_empty
           end
 
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporal_object
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &72897120 !ruby/object:Gem::Requirement
+  requirement: &85683880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72897120
+  version_requirements: *85683880
 - !ruby/object:Gem::Dependency
   name: time_span
-  requirement: &72896910 !ruby/object:Gem::Requirement
+  requirement: &85683570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72896910
+  version_requirements: *85683570
 description: Martin Fowler\'s Temporal Object Pattern.  Use time_span gem for the
   times.
 email: