lucid_works 0.6.3 → 0.6.4

data/config/locales/en.yml

@@ -92,6 +92,8 @@ en:
             update_server_list: Update server list
         datasource:
           type: Type
+          commitWithin: Commit within
+          deleteAfter: Delete after
           bounds: Constrain to
           max_bytes: Skip files larger than
           history:

data/lib/lucid_works.rb

@@ -4,9 +4,7 @@ module LucidWorks
 end
 
 require 'active_model'
-require 'active_support/core_ext/module/attr_accessor_with_default'
-require 'active_support/core_ext/module/aliasing'
-require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext'
 require 'active_support/inflector'
 begin
   require 'action_view/helpers/number_helper' # Optional formatter support

data/lib/lucid_works/base.rb

@@ -419,7 +419,19 @@ module LucidWorks
     def encode # :nodoc:
       omit_attrs = [ 'id' ]
       omit_attrs += self.class.schema.attrs_to_omit_during_update if persisted?
-      @attributes.reject { |k,v| omit_attrs.include?(k.to_s) }.to_json
+      attrs_as_json = @attributes.inject({}) do |memo, kv|
+        attr, value = kv
+        unless omit_attrs.include?(attr.to_s)
+          case self.class.schema[attr][:type]
+          when :iso8601
+            memo[attr] = value.iso8601
+          else
+            memo[attr] = value
+          end
+        end
+        memo
+      end
+      attrs_as_json.to_json
     end
 
     def load_attributes(attributes_and_values) # :nodoc:

data/lib/lucid_works/datasource.rb

@@ -10,7 +10,7 @@ module LucidWorks
     schema do
       # common
       attributes :name, :type, :crawler
-      attributes :crawl_depth, :max_bytes, :max_docs, :type => :integer
+      attributes :crawl_depth, :max_bytes, :max_docs, :commitWithin, :type => :integer
       #attribute :commitWithin, :integer
       attribute :include_paths
       attribute :exclude_paths
@@ -38,10 +38,12 @@ module LucidWorks
       # external
       attribute :source
       attribute :source_type
+      # lwelogs
+      attribute :deleteAfter, :integer
     end
 
     validates_presence_of :type, :crawler, :name
-    validates_presence_of :crawl_depth, :unless => lambda { |d| %w{external sharepoint}.include?(d.type) }
+    validates_presence_of :crawl_depth, :if => lambda { |d| %w{web file}.include?(d.type) }
     validates_numericality_of :max_bytes, :allow_blank => true
     validates_presence_of :url, :if => lambda { |d| d.type == 'web' }
 

data/lib/lucid_works/datasource/schedule.rb

@@ -11,6 +11,75 @@ module LucidWorks
         attribute :active
         attribute :type
       end
+      
+      def frequency
+        case period
+        when 1.weeks.seconds then 'weekly'
+        when 1.days.seconds then 'daily'
+        when 1.hours.seconds then 'hourly'
+        when 0 then nil
+        else 'custom'
+        end
+      end
+      
+      def time_of_day
+        Time.now
+      end
+      
+      # predict when action will occur next if active at that time
+      def next_start
+        return start_at if reference_time <= start_at 
+        # require 'ruby-debug'; debugger
+        time_since_start = reference_time - start_at
+        last_interval_num = (time_since_start / period).to_i
+        next_interval_num =  if (time_since_start % period) == 0
+          # this is sort of a stupid condition b/c time precision is millisecond or less
+          # for human purposes we wouldn't care if the result were as though the call 
+          # happened a millisecond later. But whatever.
+          last_interval_num # the next interval *is* the last interval if it is exactly now
+        else
+          last_interval_num + 1
+        end
+        start_at + period * next_interval_num
+      end
+      
+      # Ruby Time objects for start_time
+      def start_at
+        Time.iso8601(start_time)
+      end
+      
+      def start_at=(time)
+
+        self.start_time = time.iso8601
+      end
+      
+      # Provide ability to override "now" explicitly for testing purposes
+      def reference_time=(time); @reference_time = time; end
+      def reference_time; @reference_time || Time.now.utc; end
+      
+      # phantom attribute for compiling real start time and frequency from appropriate form data
+      def schedule=(all_attributes)
+        # convert to format accepted by Time.advance
+        all_attributes['start'].to_options!
+        all_attributes['start'].each{|k,v| all_attributes['start'][k]=v.to_i}
+
+        self.start_at = 
+          case all_attributes['frequency']
+          when 'weekly'
+            # require 'ruby-debug'; debugger
+            start = self.reference_time.beginning_of_week.advance(all_attributes['start'])
+            start < self.reference_time ? start.advance(:weeks => 1) : start 
+          when 'daily'                                                       
+            start = self.reference_time.beginning_of_day.advance(all_attributes['start'])
+            start < self.reference_time ? start.advance(:days => 1) : start 
+          when 'hourly'                                                      
+            start = self.reference_time.change(:min => 0).advance(all_attributes['start'])
+            start < self.reference_time ? start.advance(:hours => 1) : start 
+          else
+            puts "*** frequency: <#{all_attributes[:frequency]}>"
+            raise "unexpected frequency encountered"
+          end
+      end
     end
   end
 end

data/lib/lucid_works/schema.rb

@@ -2,7 +2,7 @@ module LucidWorks
 
   # Specify an attributes for a model.
   class Schema < ActiveSupport::HashWithIndifferentAccess
-    ATTRIBUTES_TYPES = [ :string, :integer, :boolean ]
+    ATTRIBUTES_TYPES = [ :string, :integer, :boolean, :iso8601 ]
 
     def initialize
       @primary_key = :id
@@ -93,6 +93,25 @@ module LucidWorks
             @attributes[:#{attribute}] = new_value    #   @attributes[:foo] = new_value
           end                                         # end
         EOF
+      when :integer
+        klass.class_eval <<-EOF, __FILE__, __LINE__+1
+          def #{attribute}=(new_value)
+            new_value = nil if new_value.blank? && self.class.schema[:#{attribute}][:nil_when_blank]
+            @attributes[:#{attribute}] = new_value.to_i
+          end
+        EOF
+      when :iso8601
+        klass.class_eval <<-EOF, __FILE__, __LINE__+1
+          def #{attribute}=(new_value)
+            if new_value.kind_of?(String)
+              @attributes[:#{attribute}] = Time.iso8601(new_value)
+            elsif new_value.kind_of?(Time)
+              @attributes[:#{attribute}] = new_value
+            else
+              raise "iso8601 attribute= only accepts String or Time"
+            end
+          end
+        EOF
       else
         klass.class_eval <<-EOF, __FILE__, __LINE__+1
           def #{attribute}=(new_value)                # def foo=(new_value)

data/lib/lucid_works/version.rb

@@ -1,3 +1,3 @@
 module LucidWorks
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/spec/lib/lucid_works/base_spec.rb

@@ -374,14 +374,14 @@ describe LucidWorks::Base do
 
   describe "instance methods" do
 
-    describe "collection_url" do
+    describe "#collection_url" do
       it "should generate a url from the server and its name" do
         widget = Widget.new(:parent => @server, :id => 1234)
         widget.collection_url.should == "#{@fake_server_uri}/widgets"
       end
     end
 
-    describe "member_url" do
+    describe "#member_url" do
       it "should generate a url from the server, its name and its id" do
         widget = Widget.new(:parent => @server, :id => 1234)
         widget.member_url.should == "#{@fake_server_uri}/widgets/1234"
@@ -597,33 +597,128 @@ describe LucidWorks::Base do
         widget.human_attribute_value(:myattr)
       end
     end
-  end
 
-  describe "for a model with primary key other than 'id'" do
-    before :all do
-      class NamedWidget < LucidWorks::Base
-        schema do
-          primary_key :name
+    context "for a model with primary key other than 'id'" do
+      before :all do
+        class NamedWidget < LucidWorks::Base
+          schema do
+            primary_key :name
+          end
+        end
+        NAMED_WIDGET1_JSON = '{"name":"widget1","size":"small"}'
+        NAMED_WIDGET2_JSON = '{"name":"widget2","size":"medium"}'
+        NAMED_WIDGETS_JSON = "[#{WIDGET1_JSON},#{WIDGET2_JSON}]"
+      end
+
+      describe "#id" do
+        it "should return the primary key's value" do
+          w = NamedWidget.new(:name => 'fake_name', :parent => @server)
+          w.id.should == 'fake_name'
+        end
+      end
+
+      describe "#id=" do
+        it "should set the primary key's value" do
+          w = NamedWidget.new(:name => 'fake_name', :parent => @server)
+          w.id = 'new_name'
+          w.id.should == 'new_name'
+          w.name.should == 'new_name'
         end
       end
-      NAMED_WIDGET1_JSON = '{"name":"widget1","size":"small"}'
-      NAMED_WIDGET2_JSON = '{"name":"widget2","size":"medium"}'
-      NAMED_WIDGETS_JSON = "[#{WIDGET1_JSON},#{WIDGET2_JSON}]"
     end
+  end
+
+  describe "private methods" do
+    describe "#load_attributes" do
+      it "should set id using it's accessor and not set it directly in @attributes" do
+        class ModelToTestId < LucidWorks::Base
+        end
+        model = ModelToTestId.new(:parent => @server)
+        model.should_receive(:id=).with(123)
+        model.send(:load_attributes, {:foo => 'bar', :id => 123})
+      end
 
-    describe "#id" do
-      it "should return the primary key's value" do
-        w = NamedWidget.new(:name => 'fake_name', :parent => @server)
-        w.id.should == 'fake_name'
+      context "for a class that belongs_to another object" do
+        before do
+          class ModelThatHas < LucidWorks::Base
+            has_one :model_that_belongs
+          end
+          class ModelThatBelongs < LucidWorks::Base
+            belongs_to :model_that_has
+          end
+        end
+
+        it "should ignore attempts to set the belongs_to object" do
+          parent = ModelThatHas.new(:parent => @server)
+          model = ModelThatBelongs.new(:parent => parent)
+          model.class.schema.should_not_receive(:add_attribute)
+          model.send(:load_attributes, :model_that_has => "foo")
+        end
+      end
+
+      context "for a class with dynamic_attributes = true" do
+        before do
+          class ModelWithDynamicAttrs < LucidWorks::Base
+            schema do
+              dynamic_attributes true
+            end
+          end
+        end
+
+        it "should add attributes to the schema as it loads them" do
+          model = ModelWithDynamicAttrs.new(:parent => @server)
+          model.class.schema.should_receive(:add_attribute).with(ModelWithDynamicAttrs, :foo, :string)
+          model.stub(:foo=)
+          model.send(:load_attributes, {:foo => 'bar'})
+        end
+      end
+      
+      context "for a class with dynamic_attributes = false" do
+        before do
+          class ModelWithStaticAttrs < LucidWorks::Base
+            schema do
+              dynamic_attributes false
+            end
+          end
+        end
+
+        it "should raise an error for unknown attributes" do
+          model = ModelWithStaticAttrs.new(:parent => @server)
+          lambda {
+            model.send(:load_attributes, {:foo => 'bar'})
+          }.should raise_error
+        end
+      end
+
+      describe "for a model with an attr described as :iso8601" do
+        before do
+          class ModelWithTimeAttr < LucidWorks::Base
+            schema do
+              attribute :time, :iso8601
+            end
+          end
+        end
+
+        it "should convert :iso8601 attributes to a Time object" do
+          model = ModelWithTimeAttr.new(:parent => @server)
+          model.send(:load_attributes, {:time => "2011-05-12T13:33:55-0500"})
+          model.time.should == Time.utc(2011,05,12,18,33,55)
+        end
       end
     end
-    
-    describe "#id=" do
-      it "should set the primary key's value" do
-        w = NamedWidget.new(:name => 'fake_name', :parent => @server)
-        w.id = 'new_name'
-        w.id.should == 'new_name'
-        w.name.should == 'new_name'
+
+    describe "#encode" do
+      before do
+        # reuse ModelWithTimeAttr
+        # Yes this will fail if we start running tests in random order or bottom up
+      end
+
+      describe "for a model with an attr described as :iso8601" do
+        it "should convert :iso8601 attributes to strings" do
+          time = Time.utc(2011,12,13,14,15,16)
+          model = ModelWithTimeAttr.new(:parent => @server, :time => time)
+          model.send(:encode).should == '{"time":"2011-12-13T14:15:16Z"}'
+        end
       end
     end
   end

data/spec/lib/lucid_works/datasource/schedule_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+
+class String
+  def weekday
+    Time.iso8601(self).strftime('%A')
+  end
+end
+
+class Time
+  def weekday
+    self.strftime('%A')
+  end
+end
+
+describe LucidWorks::Datasource::Schedule do
+  before do
+    @server = connect_to_live_server
+    @schedule = LucidWorks::Datasource::Schedule.new(:parent => @server)
+  end
+
+  describe '#frequency' do
+    it "should return 'daily'" do
+      @schedule.period = 86400
+      @schedule.frequency.should == 'daily'
+    end
+
+    it "should return 'hourly'" do
+      @schedule.period = 3600
+      @schedule.frequency.should == 'hourly'
+    end
+
+    it "should return 'custom'" do
+      @schedule.period = 1
+      @schedule.frequency.should == 'custom'
+    end
+
+    it "should return nil" do
+      @schedule.period = 0
+      @schedule.frequency.should == nil
+    end
+  end
+
+  describe '#next_start' do
+    describe 'start_time is in the future' do
+      it 'should return start_time' do
+        @schedule.reference_time = Time.now.utc
+        @schedule.start_time = (@schedule.reference_time + 30.minutes).iso8601
+        @schedule.next_start.should == Time.iso8601(@schedule.start_time)
+      end
+    end
+    
+    #
+    # some of these are a little sketchy b/c comparing time equality is tricky
+    # Time objects are precise to the millisecond
+    # we cheat by converting to string, which is only accurate to the second
+    # but if these test are run on a second boundary, they might wrongly fail
+    # 
+    context 'start_time is in the past' do
+      before do
+        @now = Time.iso8601(Time.now.utc.iso8601)
+      end
+      
+      describe 'and it is an exact multiple of self.periods until now' do
+        it 'should return now' do
+          # get current time after rounding error
+          @schedule.reference_time = @now
+          @schedule.start_time = (@now - 30.minutes).iso8601
+          @schedule.period = 10.minutes
+          @schedule.next_start.should == @now
+        end
+      end
+      
+      context 'Time since self.start_time is not even multiple of self.period' do
+        describe 'one interval has passed' do
+          before do 
+            @schedule.start_time = (@now - 11.minutes).iso8601
+            @schedule.period = 10.minutes
+          end
+
+          it 'should return a time less than one interval in the future' do
+            @schedule.next_start.should < @now + @schedule.period
+          end
+          
+          it 'should return a time one interval from the start_time' do
+            @schedule.next_start.to_s.should == (@now + 9.minutes).to_s
+          end
+        end
+
+        describe 'several (e.g. 4) intervals have passed' do
+          before do
+            @schedule.start_time = (@now - 45.minutes).iso8601
+            @schedule.period = 10.minutes
+          end
+          
+          it 'should return a time between 4 and 6 intervals from start_at' do
+            @schedule.next_start.should > @schedule.start_at + (4 * @schedule.period)
+          end
+          
+          it 'should return a start time within 1 period from now' do
+            @schedule.next_start.should < @now + @schedule.period
+          end
+        end
+      end
+    end
+  end
+
+  describe '#schedule=' do
+    context 'supplied start time has elapsed w/rt current interval' do
+
+      describe 'with hourly frequency' do
+        it "should advance the start time" do
+          half_past_midnight = Time.iso8601("2011-05-09T00:30:00Z")
+          hourly_at_quarter_past = {"frequency"=>"hourly", "start"=>{"minutes"=>"15"}}
+          quarter_past_1_am = '2011-05-09T01:15:00Z'
+          
+          @schedule.reference_time =          half_past_midnight
+          @schedule.start_time.should_not ==  quarter_past_1_am
+          @schedule.schedule =                hourly_at_quarter_past
+          @schedule.start_time.should ==      quarter_past_1_am
+        end
+      end
+      
+      describe 'with daily frequency' do
+        it "should advance the start time" do
+          today_at_noon = Time.iso8601("2011-05-09T12:00:00Z")
+          tomorrow_at_eleven_am = '2011-05-10T11:00:00Z'
+          daily_at_11_am = {"frequency"=>"daily", "start"=>{"hours" => "11", "minutes"=>"00"}}
+          
+          @schedule.reference_time =          today_at_noon
+          @schedule.start_time.should_not ==  tomorrow_at_eleven_am
+          @schedule.schedule =                daily_at_11_am
+          @schedule.start_time.should ==      tomorrow_at_eleven_am
+        end
+      end
+      
+      describe 'with weekly frequency' do
+        it "should advance the start time" do
+          # note: Rails week starts on Monday
+            friday_of_this_week = Time.iso8601("2011-05-13T00:00:00Z")
+            wednesday_of_next_week = '2011-05-18T00:00:00Z'
+            weekly_on_wednesday = {"frequency"=>"weekly", "start"=>{"days" => "2", "hours" => "0", "minutes"=>"00"}}
+          
+          # just make sure I'm not on crack
+            friday_of_this_week.weekday.should ==     'Friday'
+            wednesday_of_next_week.weekday.should ==  'Wednesday'
+          
+          @schedule.reference_time =          friday_of_this_week
+          @schedule.start_time.should_not ==  wednesday_of_next_week
+          @schedule.schedule =                weekly_on_wednesday
+          @schedule.start_time.should ==      wednesday_of_next_week
+        end
+      end
+    end
+  
+    context 'supplied time has not elapsed w/rt current interval' do
+      describe 'with hourly frequency' do
+        it "should not advance the start time" do
+          half_past_midnight =                Time.iso8601("2011-05-09T00:30:00Z")
+          three_quarters_past_midnight =      '2011-05-09T00:45:00Z'
+          hourly_at_three_quarters_past =     {"frequency"=>"hourly", "start"=>{"minutes"=>"45"}}
+          
+          @schedule.reference_time =          half_past_midnight
+          
+          @schedule.start_time.should_not ==  three_quarters_past_midnight
+          @schedule.schedule =                hourly_at_three_quarters_past
+          @schedule.start_time.should ==      three_quarters_past_midnight
+        end
+      end
+      
+      describe 'with daily frequency' do
+        it "should not advance the start time" do
+          today_at_noon =                     Time.iso8601("2011-05-09T12:00:00Z")
+          today_at_1pm =                      '2011-05-09T13:00:00Z'
+          daily_at_1pm =                      {"frequency"=>"daily", "start"=>{"hours" => "13", "minutes"=>"00"}}
+
+          @schedule.reference_time =          today_at_noon
+          @schedule.start_time.should_not ==  today_at_1pm
+          @schedule.schedule =                daily_at_1pm
+          @schedule.start_time.should ==      today_at_1pm
+        end
+      end
+      
+      describe 'with weekly frequency' do
+        it "should not advance the start time" do
+          # note: Rails week starts on Monday
+            wednesday_of_this_week =          Time.iso8601("2011-05-11T00:00:00Z")
+            thursday_of_this_week =           '2011-05-12T00:00:00Z'
+            weekly_on_thursday =              {"frequency"=>"weekly", "start"=>{"days" => "3", "hours" => "0", "minutes"=>"00"}}
+
+          # just make sure I'm not on crack
+            wednesday_of_this_week.weekday.should ==  'Wednesday'
+            thursday_of_this_week.weekday.should ==   'Thursday'
+          
+          @schedule.reference_time =          wednesday_of_this_week
+          @schedule.start_time.should_not ==  thursday_of_this_week
+          @schedule.schedule =                weekly_on_thursday
+          @schedule.start_time.should ==      thursday_of_this_week
+        end
+      end
+    end
+  end
+end

data/spec/lib/lucid_works/patch_time_spec.rb

@@ -9,7 +9,7 @@ describe Time do
 
   describe "#iso8601" do
     it "should generate a time with a 4 digit timezone" do
-      Time.utc(2011, 4, 15, 20, 11, 56).localtime.iso8601.should == "2011-04-15T13:11:56-0700"
+      Time.new(2011, 4, 15, 13, 11, 56, "-07:00").iso8601.should == "2011-04-15T13:11:56-0700"
     end
   end
 end

data/spec/lib/lucid_works/schema_spec.rb

@@ -6,8 +6,9 @@ describe LucidWorks::Schema do
     @schema.instance_eval do
       attribute :astring, :string, :primary_key => true
       attribute :abool, :boolean
-      attributes :bar, :baz, :type => :integer
+      attributes :anint, :baz, :type => :integer
       attribute :nullstring, :string, :nil_when_blank => true
+      attribute :time, :iso8601
     end
   end
 
@@ -29,7 +30,7 @@ describe LucidWorks::Schema do
       end
     end
 
-    [:string, :integer, :boolean].each do |attr_type|
+    [:string, :integer, :boolean, :iso8601].each do |attr_type|
       it "should allow type #{attr_type}" do
         @schema.attribute :foo, attr_type
         @schema[:foo][:type].should == attr_type
@@ -41,10 +42,11 @@ describe LucidWorks::Schema do
     it "should process the block in its context and create an attribute list" do
       @schema.should == {
         'astring'    => {'type' => :string},
-        'bar'        => {'type' => :integer},
+        'anint'      => {'type' => :integer},
         'baz'        => {'type' => :integer},
         'abool'      => {'type' => :boolean},
-        'nullstring' => {'type' => :string, 'nil_when_blank' => true}
+        'nullstring' => {'type' => :string, 'nil_when_blank' => true},
+        'time'       => {'type' => :iso8601}
       }
       @schema.primary_key.should == :astring
     end
@@ -98,7 +100,7 @@ describe LucidWorks::Schema do
 
     it "should add readers and writers for all attributes" do
       ClassWithAddedAccessors.new.should respond_to(:astring, :astring=)
-      ClassWithAddedAccessors.new.should respond_to(:bar, :bar=)
+      ClassWithAddedAccessors.new.should respond_to(:anint, :anint=)
       ClassWithAddedAccessors.new.should respond_to(:abool, :abool=)
     end
 
@@ -121,6 +123,13 @@ describe LucidWorks::Schema do
       end
     end
 
+    context "for an integer attribute" do
+      it "setter should convert strings to integers" do
+        @model.anint = "1234"
+        @model.anint.should == 1234
+      end
+    end
+
     context "for a string attribute" do
       context "without :nil_when_blank => true" do
         it "setter save the empty string" do

metadata

@@ -2,7 +2,7 @@
 name: lucid_works
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors: 
 - Sam Pierson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 -07:00
+date: 2011-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,6 +144,7 @@ files:
 - spec/lib/lucid_works/collection/prime_activities_spec.rb
 - spec/lib/lucid_works/collection_spec.rb
 - spec/lib/lucid_works/datasource/history_spec.rb
+- spec/lib/lucid_works/datasource/schedule_spec.rb
 - spec/lib/lucid_works/datasource/status_spec.rb
 - spec/lib/lucid_works/datasource_spec.rb
 - spec/lib/lucid_works/field_spec.rb
@@ -191,6 +192,7 @@ test_files:
 - spec/lib/lucid_works/collection/prime_activities_spec.rb
 - spec/lib/lucid_works/collection_spec.rb
 - spec/lib/lucid_works/datasource/history_spec.rb
+- spec/lib/lucid_works/datasource/schedule_spec.rb
 - spec/lib/lucid_works/datasource/status_spec.rb
 - spec/lib/lucid_works/datasource_spec.rb
 - spec/lib/lucid_works/field_spec.rb