lucid_works 0.6.4 → 0.6.5

data/README.rdoc

@@ -261,7 +261,7 @@ A class may have a schema defined as follows:
   end
 
 Classes with a schema may have validations applied to its attributes.
-The default attribute type is :string.
+The default attribute type is :string.  See LucidWorks::Schema for more details.
 
 == Rationale
 

data/config/locales/en.yml

@@ -93,7 +93,7 @@ en:
         datasource:
           type: Type
           commitWithin: Commit within
-          deleteAfter: Delete after
+          deleteAfter: Delete logs after
           bounds: Constrain to
           max_bytes: Skip files larger than
           history:

data/lib/lucid_works/base.rb

@@ -265,11 +265,10 @@ module LucidWorks
       end
 
       # For attributes listed in the schema as having :values, this will create an array-of-arrays
-      # suitable for use as options_for_select.  The
+      # suitable for use as options_for_select.
 
       def to_select(attribute)
         raise "Can't to_select for #{attribute} as it has no values" unless schema[attribute][:values]
-        l10n_scope = %w{activemodel models} + self.name.underscore.split('/') + [attribute]
         schema[attribute][:values].map do |value|
           [human_attribute_value(attribute, value), value]
         end
@@ -421,10 +420,11 @@ module LucidWorks
       omit_attrs += self.class.schema.attrs_to_omit_during_update if persisted?
       attrs_as_json = @attributes.inject({}) do |memo, kv|
         attr, value = kv
-        unless omit_attrs.include?(attr.to_s)
+        unless (value.blank? && self.class.schema[attr][:omit_when_blank]) ||
+               omit_attrs.include?(attr.to_s)
           case self.class.schema[attr][:type]
-          when :iso8601
-            memo[attr] = value.iso8601
+            when :iso8601
+              memo[attr] = value.iso8601 rescue value
           else
             memo[attr] = value
           end

data/lib/lucid_works/datasource/schedule.rb

@@ -7,7 +7,7 @@ module LucidWorks
 
       schema do
         attribute :period
-        attribute :start_time
+        attribute :start_time, :iso8601
         attribute :active
         attribute :type
       end
@@ -22,15 +22,24 @@ module LucidWorks
         end
       end
       
+      def frequency=(frequency)
+        self.period = case frequency
+        when 'hourly' then 1.hours.seconds
+        when 'daily' then 1.days.seconds
+        when 'weekly' then 1.weeks.seconds
+        else raise "unknown frequency"
+        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 
+        return start_time if reference_time <= start_time 
         # require 'ruby-debug'; debugger
-        time_since_start = reference_time - start_at
+        time_since_start = reference_time - start_time
         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
@@ -40,19 +49,9 @@ module LucidWorks
         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)
+        start_time + period * next_interval_num
       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
@@ -63,7 +62,8 @@ module LucidWorks
         all_attributes['start'].to_options!
         all_attributes['start'].each{|k,v| all_attributes['start'][k]=v.to_i}
 
-        self.start_at = 
+        self.frequency = all_attributes['frequency']
+        self.start_time = 
           case all_attributes['frequency']
           when 'weekly'
             # require 'ruby-debug'; debugger

data/lib/lucid_works/datasource.rb

@@ -10,8 +10,9 @@ module LucidWorks
     schema do
       # common
       attributes :name, :type, :crawler
-      attributes :crawl_depth, :max_bytes, :max_docs, :commitWithin, :type => :integer
-      #attribute :commitWithin, :integer
+      attributes :crawl_depth, :max_docs,     :type => :integer
+      attributes :max_bytes,   :commitWithin, :type => :integer, :omit_when_blank => true
+      attribute :commit_within_min, :custom
       attribute :include_paths
       attribute :exclude_paths
       attribute :mapping # Hash
@@ -39,7 +40,8 @@ module LucidWorks
       attribute :source
       attribute :source_type
       # lwelogs
-      attribute :deleteAfter, :integer
+      attribute :deleteAfter, :integer, :omit_when_blank => true
+      attribute :delete_after_days, :custom
     end
 
     validates_presence_of :type, :crawler, :name
@@ -47,8 +49,6 @@ module LucidWorks
     validates_numericality_of :max_bytes, :allow_blank => true
     validates_presence_of :url, :if => lambda { |d| d.type == 'web' }
 
-    before_save :remove_blank_max_bytes
-
     TYPES = %w{ external file lwelogs web solrxml jdbc sharepoint }
     BOUNDS = %w{ tree none }
     CRAWLERS = {
@@ -64,6 +64,20 @@ module LucidWorks
     }.with_indifferent_access
 
 
+    # Fake attributes to ease UI implementation
+    def commit_within_min
+      commitWithin.blank? ? nil : commitWithin / 1.second.milliseconds / 1.minute.seconds
+    end
+    def commit_within_min=(mins)
+      self.commitWithin = mins.blank? ? nil : mins.to_i.minutes.milliseconds
+    end
+    def delete_after_days
+      deleteAfter.blank? ? nil : deleteAfter / 1.second.milliseconds / 1.day.seconds
+    end
+    def delete_after_days=(days)
+      self.deleteAfter = days.blank? ? nil : days.to_i.days.milliseconds
+    end
+
     def empty!
       build_index.destroy
     end
@@ -94,12 +108,5 @@ module LucidWorks
     def t_type
       I18n.t(type, :scope => 'activemodel.models.lucid_works.datasource.type')
     end
-
-    private
-
-    def remove_blank_max_bytes # :nodoc:
-      # API can't handle a blank max_bytes.  Send nothing to select 'unlimited'
-      @attributes.delete :max_bytes if self.max_bytes.blank?
-    end
   end
 end

data/lib/lucid_works/patch_time.rb

@@ -12,8 +12,20 @@ class Time #:nodoc:
   end
 
   def iso8601_with_support_for_timezones_without_colons
-      self.iso8601_without_support_for_timezones_without_colons.gsub /([+-])(\d\d):(\d\d)$/, '\1\2\3'
+      unfixed_string = self.iso8601_without_support_for_timezones_without_colons
+      if unfixed_string =~ /Z$/
+        unfixed_string.gsub /Z$/, '+0000'
+      else
+        unfixed_string.gsub /([+-])(\d\d):(\d\d)$/, '\1\2\3'
+      end
   end
 
   alias_method_chain :iso8601, :support_for_timezones_without_colons
 end
+
+class Fixnum
+  def milliseconds
+    # so we can say 1.second.milliseconds
+    self * 1000
+  end
+end

data/lib/lucid_works/schema.rb

@@ -1,9 +1,27 @@
 module LucidWorks
 
-  # Specify an attributes for a model.
+  # Schema is used to delare attributes for a model.
+
   class Schema < ActiveSupport::HashWithIndifferentAccess
-    ATTRIBUTES_TYPES = [ :string, :integer, :boolean, :iso8601 ]
+    ATTRIBUTES_TYPES = [ :string, :integer, :boolean, :iso8601, :custom ]
 
+    # Initializes the schema, taking a block of schema declarations.
+    # Typically it is called from LucidWorks::Base, e.g.:
+    #
+    #   class MyModel < LucidWorks::Base
+    #     schema do
+    #       attribute :string1,  :string
+    #       attribute :bool1,    :boolean
+    #       attribute :integer1, :integer
+    #       attributes :string2, :string3, :string4
+    #       attributes :bool2,   :bool3, :type => :boolean
+    #       attributes :int2,    :int3,  :type => :integer
+    #       attribute :string_with_values, :values => ['one', 'two']
+    #       attribute :dontsendme, :omit_during_update => true
+    #       attribute :sendnull,   :string, :nil_when_blank => true
+    #     end
+    #   end
+    #
     def initialize
       @primary_key = :id
       @dynamic_attributes = true
@@ -14,16 +32,39 @@ module LucidWorks
       @primary_key
     end
 
-    # Specify whether attributes unrecognized during retrieval should raise an error (false)
-    # or cause a new attribute to be added to the schema (true) [default].
-    #
+    # If called with _true_ (the default), attributes will be added to the schema
+    # when the model is first retrieved from the server.  If set to _false_
+    # only the attributes defined in the schema will be allowed and anything
+    # else will raise an exception.
+
     def dynamic_attributes(on=nil)
       @dynamic_attributes = !!on unless on.nil?
       @dynamic_attributes
     end
     
     alias :dynamic_attributes? :dynamic_attributes
-    
+
+    # Declare a single attribute.
+    #
+    # Attributes may be of the following types:
+    #
+    # [:string ] The default type, incurrs no special processing.
+    # [:integer] Setter will attempt cast to_i.  Will be sent to server as integer.
+    # [:boolean] Besides true/false, the setter will accept 0, 1 and strings true, false, t, f, 0, 1, yes and no.
+    # [:iso8601] An ISO 8601 formatted datetime. Automatically converts to/from strings when sent / received.
+    # [:custom]  Developer will write their own setter/getter.
+    #
+    # Attributes behavior may also be modified using the following options:
+    #
+    # [:type => _type_]             Use to set the type of a group of attributes when using \#attributes.
+    # [:values => \[array\]]        Provides a set of values that to_select will use to generate options_for_select.
+    # [:omit_during_update => true] Some resources have attributes that may be set during creation,
+    #                               but will cause an error if sent during an update.
+    #                               Setting the <em>option</em> to true will skip the attribute when saving
+    #                               the model during update.
+    # [:nil_when_blank => true]     When this attribute is blank?, send nil (actually JSON null) during save.
+    # [:omit_when_blank => true]    When this attribute is blank?, don't send it to the server during save.
+
     def attribute(name, type=:string, options={})
       raise "Unknown attribute type: #{type.inspect}" unless ATTRIBUTES_TYPES.include?(type)
       primary_key name if options.delete(:primary_key)
@@ -37,10 +78,11 @@ module LucidWorks
     #   end
     #
     def attributes(*attributes_and_options)
-      options = attributes_and_options.last.is_a?(Hash) ? attributes_and_options.pop : {}
+      options    = attributes_and_options.last.is_a?(Hash) ? attributes_and_options.pop : {}
       attributes = attributes_and_options
+      type       = options.delete(:type) || :string
       attributes.each do |name|
-        self[name] = { :type => options[:type] || :string }
+        attribute name, type, options
       end
     end
 
@@ -96,8 +138,13 @@ module LucidWorks
       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
+            if new_value.blank? && (self.class.schema[:#{attribute}][:nil_when_blank] ||
+                                    self.class.schema[:#{attribute}][:omit_when_blank])
+              new_value = nil
+            else
+              new_value = new_value.to_i
+            end
+            @attributes[:#{attribute}] = new_value
           end
         EOF
       when :iso8601
@@ -105,13 +152,13 @@ module LucidWorks
           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"
+              @attributes[:#{attribute}] = new_value
             end
           end
         EOF
+      when :custom
+        # Do nothing.  Developer will provide own accessors.
       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.4"
+  VERSION = "0.6.5"
 end

data/spec/lib/lucid_works/base_spec.rb

@@ -709,15 +709,26 @@ describe LucidWorks::Base do
 
     describe "#encode" do
       before do
-        # reuse ModelWithTimeAttr
-        # Yes this will fail if we start running tests in random order or bottom up
+        class ModelToBeEncoded < LucidWorks::Base
+          schema do
+            attribute :time, :iso8601
+            attribute :blanktime, :iso8601, :omit_when_blank => true
+          end
+        end
       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"}'
+          time = Time.local(2011,12,13,14,15,16)
+          model = ModelToBeEncoded.new(:parent => @server, :time => time)
+          model.send(:encode).should =~ /"time":"2011-12-13T14:15:16-\d\d\d\d"/
+        end
+      end
+
+      describe "for a model with an attr with option :omit_when_blank" do
+        it "should not encode the attribute" do
+          model = ModelToBeEncoded.new(:parent => @server, :time => 123, :blanktime => nil)
+          model.send(:encode).should == '{"time":123}'
         end
       end
     end

data/spec/lib/lucid_works/collection_spec.rb

@@ -89,7 +89,7 @@ describe LucidWorks::Collection do
 
   describe "#activities" do
     before do
-      @collection = LucidWorks::Collection.first(:parent => @server)
+      @collection = @server.collection('collection1')
     end
 
     context "for a collection with some activities" do
@@ -179,7 +179,7 @@ describe LucidWorks::Collection do
       # Schedule a crawl to create some history
       @schedule = @ds1.build_schedule
       @schedule.period = '0'
-      @schedule.start_time = '0'
+      @schedule.start_time = 0
       @schedule.active = true
       @schedule.type = 'index'
       @schedule.save

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

@@ -44,8 +44,8 @@ describe LucidWorks::Datasource::Schedule 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)
+        @schedule.start_time = @schedule.reference_time + 30.minutes
+        @schedule.next_start.should == @schedule.start_time
       end
     end
     
@@ -64,7 +64,7 @@ describe LucidWorks::Datasource::Schedule do
         it 'should return now' do
           # get current time after rounding error
           @schedule.reference_time = @now
-          @schedule.start_time = (@now - 30.minutes).iso8601
+          @schedule.start_time = @now - 30.minutes
           @schedule.period = 10.minutes
           @schedule.next_start.should == @now
         end
@@ -73,7 +73,7 @@ describe LucidWorks::Datasource::Schedule do
       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.start_time = @now - 11.minutes
             @schedule.period = 10.minutes
           end
 
@@ -88,12 +88,12 @@ describe LucidWorks::Datasource::Schedule do
 
         describe 'several (e.g. 4) intervals have passed' do
           before do
-            @schedule.start_time = (@now - 45.minutes).iso8601
+            @schedule.start_time = @now - 45.minutes
             @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)
+          it 'should return a time between 4 and 6 intervals from start_time' do
+            @schedule.next_start.should > @schedule.start_time + (4 * @schedule.period)
           end
           
           it 'should return a start time within 1 period from now' do
@@ -111,7 +111,7 @@ describe LucidWorks::Datasource::Schedule 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'
+          quarter_past_1_am = Time.iso8601('2011-05-09T01:15:00Z')
           
           @schedule.reference_time =          half_past_midnight
           @schedule.start_time.should_not ==  quarter_past_1_am
@@ -123,7 +123,7 @@ describe LucidWorks::Datasource::Schedule do
       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'
+          tomorrow_at_eleven_am = Time.iso8601('2011-05-10T11:00:00Z')
           daily_at_11_am = {"frequency"=>"daily", "start"=>{"hours" => "11", "minutes"=>"00"}}
           
           @schedule.reference_time =          today_at_noon
@@ -137,7 +137,7 @@ describe LucidWorks::Datasource::Schedule 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'
+            wednesday_of_next_week = Time.iso8601('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
@@ -156,27 +156,33 @@ describe LucidWorks::Datasource::Schedule 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'
+          three_quarters_past_midnight =      Time.iso8601('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.frequency.should_not == 'hourly'
+          
           @schedule.schedule =                hourly_at_three_quarters_past
           @schedule.start_time.should ==      three_quarters_past_midnight
+          @schedule.frequency.should == 'hourly'
         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'
+          today_at_1pm =                      Time.iso8601('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.frequency.should_not == 'daily'
+
           @schedule.schedule =                daily_at_1pm
           @schedule.start_time.should ==      today_at_1pm
+          @schedule.frequency.should == 'daily'
         end
       end
       
@@ -184,7 +190,7 @@ describe LucidWorks::Datasource::Schedule 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'
+            thursday_of_this_week =           Time.iso8601('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
@@ -193,8 +199,11 @@ describe LucidWorks::Datasource::Schedule do
           
           @schedule.reference_time =          wednesday_of_this_week
           @schedule.start_time.should_not ==  thursday_of_this_week
+          @schedule.frequency.should_not == 'weekly'
+
           @schedule.schedule =                weekly_on_thursday
           @schedule.start_time.should ==      thursday_of_this_week
+          @schedule.frequency.should == 'weekly'
         end
       end
     end

data/spec/lib/lucid_works/datasource_spec.rb

@@ -4,7 +4,7 @@ describe LucidWorks::Datasource do
   before :all do
     @server = connect_to_live_server
     @server.reset_collections!
-    @collection = @server.collections!.first
+    @collection = @server.collection('collection1')
   end
 
   describe "CRUD" do
@@ -60,7 +60,7 @@ describe LucidWorks::Datasource do
             :crawler => LucidWorks::Datasource::CRAWLERS['web'],
             :type => 'web',
             :url => "invalid url",
-            :crawl_depth => "invalid crawl depth"
+            :crawl_depth => 1
           }
         end
 
@@ -70,7 +70,6 @@ describe LucidWorks::Datasource do
             d = LucidWorks::Datasource.create(@parameters)
           }.should_not change(self, :datasource_count)
           d.errors[:url].should_not be_empty
-          d.errors[:crawl_depth].should_not be_empty
           d.errors[:base].should be_blank
         end
       end

data/spec/lib/lucid_works/patch_time_spec.rb

@@ -8,8 +8,16 @@ describe Time do
   end
 
   describe "#iso8601" do
-    it "should generate a time with a 4 digit timezone" do
-      Time.new(2011, 4, 15, 13, 11, 56, "-07:00").iso8601.should == "2011-04-15T13:11:56-0700"
+    context "when time is a UTC time" do
+      it "should end in +0000" do
+        Time.utc(2011, 4, 15, 13, 11, 56).iso8601.should == "2011-04-15T13:11:56+0000"
+      end
+    end
+
+    context "when time is non-UTC" do
+      it "should generate a time with a 4 digit timezone" do
+        Time.new(2011, 4, 15, 13, 11, 56, "-07:00").iso8601.should == "2011-04-15T13:11:56-0700"
+      end
     end
   end
 end

data/spec/lib/lucid_works/schema_spec.rb

@@ -144,6 +144,23 @@ describe LucidWorks::Schema do
         end
       end
     end
+
+    context "for an iso8601 attribute" do
+      it "setter should just store a Time" do
+        @model.time = Time.utc(2011)
+        @model.time.should be_a(Time)
+      end
+
+      it "setter should assume string is ISO8601 and convert to Time" do
+        @model.time = "2011-05-12T13:33:55-0500"
+        @model.time.should == Time.utc(2011,05,12,18,33,55)
+      end
+      
+      it "setter should just store an integer" do
+        @model.time = 12345678
+        @model.time.should == 12345678
+      end
+    end
   end
 
   describe "#has_attribute?" do

data/spec/spec_helper.rb

@@ -36,8 +36,12 @@ class LucidWorks::Server
     end
 
     collections.each do |c|
-      c.destroy
-      notes << "Deleted collection '#{c.name}'"
+      # TODO: figure out how to delete and recreate lwelogs
+      # For now just don't delete it
+      unless c.name == 'lwelogs'
+        c.destroy
+        notes << "Deleted collection '#{c.name}'"
+      end
     end
 
     default_collection = self.create_collection(:name => DEFAULT_COLLECTION_NAME)

metadata

@@ -2,7 +2,7 @@
 name: lucid_works
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors: 
 - Sam Pierson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 -07:00
+date: 2011-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency