lucid_works 0.6.29 → 0.7.1

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2-p180@lucidworks
+rvm use 1.9.2-p180@lucidworks --create

data/Rakefile

@@ -11,3 +11,28 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+class Hash
+  def recursively_sort
+    raise "Hash#recursively_sort requires Ruby 1.9" if RUBY_VERSION < "1.9"
+    sorted_array = self.sort
+    sorted_array.map! do |kv|
+      k, v = kv
+      v = v.recursively_sort if v.is_a?(Hash)
+      [k,v]
+    end
+    Hash[sorted_array]
+  end
+end
+
+namespace :l10n do
+
+  desc "Sort the EN locale file"
+  task :sort do
+    en_path = File.join(File.dirname(__FILE__), 'config', 'locales', "en.yml")
+    translations = YAML.load_file(en_path)
+    File.open(en_path, 'w') do |f|
+      YAML.dump translations.recursively_sort, f
+    end
+  end
+end

data/config/locales/en.yml

@@ -1,51 +1,13 @@
 ---
 en:
   activemodel:
-    models:
-      lucid_works:
-        activity:
-          one: Activity
-          other: Activities
-          type:
-            autocomplete: Generate autocomplete index
-            click: Process click logs
-            optimize: Optimize index
-            spelling: Generate spellcheck index
-        collection:
-          one: Collection
-          other: Collections
-          settings:
-            one: Settings
-            other: Settings
-            de_duplication:
-              'off': 'Off'
-              overwrite: Overwrite
-              tag: Tag
-        datasource:
-          one: Data source
-          other: Data sources
-          status:
-            crawlState:
-              ABORTED: Aborted
-              ABORTING: Aborting
-              EXCEPTION: Exception
-              FINISHED: Finished
-              IDLE: Idle
-              RUNNING: Running
-              STOPPED: Stopped
-              STOPPING: Stopping
-          type:
-            external: External
-            file: Local Filesystem
-            jdbc: Database
-            lucidworkslogs: LucidWorks Solr Logs
-            sharepoint: Sharepoint
-            solrxml: Solr XML
-            web: Web Site
+    #
+    # This section is standard ActiveModel
+    # and is used by human_attribute_name
+    #
     attributes:
       lucid_works:
         collection:
-          name: Name
           info:
             collection_name: Collection name
             data_dir: Data directory
@@ -65,15 +27,16 @@ en:
             root_dir: Root directory
             total_disk_bytes: Total disk bytes
             total_disk_space: Total disk space
+          name: Name
           settings:
             auto_complete: Auto complete
-            boosts: Boosts
             boost_recent: Boost recent
+            boosts: Boosts
             click_boost_data: Click boost data
             click_boost_field: Click boost field
             click_enabled: Click scoring enabled
-            default_sort: Default sort
             de_duplication: De-duplication
+            default_sort: Default sort
             display_facets: Display facets
             elevations: elevations
             index_time_stopwords: Exclude stop words from index
@@ -91,47 +54,172 @@ en:
             unsupervised_feedback_emphasis: Unsupervised feedback emphasis
             update_server_list: Update server list
         datasource:
-          type: Type
-          commitWithin: Commit within
-          commit_within_min: "Commit within (minutes)"
-          deleteAfter: Delete logs after
+          aliases: Site Aliases Mappings
+          auth: Authentication credentials
+          authorization: Authorization
           bounds: Constrain to
-          max_bytes: Skip files larger than (bytes)
+          commit_on_finish: Commit when crawl finishes
+          commit_within: Commit within
+          commit_within_min: Commit within (minutes)
+          connector_type: Connector Type
+          deleteAfter: Delete logs after
+          domain: Domain
+          excluded_urls: Excluded URLs
+          fail_unsupported_file_types: Fail unsupported file types
           history:
-            crawlStarted: Started
-            crawlStopped: Stopped
-            crawlState: State
-            numNew: New
-            numUpdated: Updated
-            numDeleted: Deleted
-            numUnchanged: Unchanged
-            numFailed: Failed
+            crawl_started: Started
+            crawl_state: State
+            crawl_stopped: Stopped
+            num_deleted: Deleted
+            num_failed: Failed
+            num_new: New
+            num_unchanged: Unchanged
+            num_updated: Updated
+          host: Domain Name
+          ignore_robots: Ignore robots.txt
+          include_datasource_metadata: Include data source metadata
+          included_urls: Included URLs
+          kdcserver: Kerberos KDC server
+          log_extra_detail: Log extra detail
+          max_bytes: Skip files larger than (bytes)
+          my_site_base_url: MySite URL
+          no_duplicates: Suppress duplicates
+          password: Password
+          proxy_host: Proxy host
+          proxy_password: Proxy password
+          proxy_port: Proxy port
+          proxy_username: Proxy user name
+          realm: Realm
+          sharepoint_url: SharePoint URL
           status:
-            crawlStarted: Last crawl started
-            crawlStopped: Last crawl stopped
-            crawlState: State
+            crawl_started: Last crawl started
+            crawl_state: State
+            crawl_stopped: Last crawl stopped
             doc_count: Documents indexed
-            jobId: Job ID
-            numNew: New docs
-            numUpdated: Updated docs
-            numDeleted: Deleted docs
-            numUnchanged: Unchanged docs
-            numFailed: Failed docs
-            numTotal: Total docs
-          sharepointUrl: SharePoint URL
-          connectorType: Connector Type
-          authorization: Authorization
+            job_id: Job ID
+            num_deleted: Deleted docs
+            num_failed: Failed docs
+            num_new: New docs
+            num_total: Total docs
+            num_unchanged: Unchanged docs
+            num_updated: Updated docs
+          type: Type
+          url: URL
+          use_sp_search_visibility: Use SP Search Visibility
           username: Username
-          password: Password
-          domain: Domain
-          mySiteBaseURL: MySite URL
-          includedURls: Included URLs
-          excludedURls: Excluded URLs
-          kdcserver: Kerberos KDC server
-          useSPSearchVisibility: Use SP Search Visibility
-          aliases: Site Aliases Mappings
-#    errors:
-#      models:
-#        lucid_works:
-#          collection:
-#            exclusion: is reserved
+          warn_unknown_mime_types: Log warnings for unknown mime types
+          windowsdomain: Windows domain
+        field:
+          copy_fields: Copy this field to fields
+          default_boost: Default boost
+          default_value: Default value
+          dynamic_base: Dynamically generated from
+          editable: Editable
+          facet: Facet
+          field_type: Field type
+          highlight: Highlight
+          include_in_results: Include in results
+          index_for_autocomplete: Index for autocomplete
+          index_for_spellcheck: Index for spell checking
+          index_term_freq_and_pos: Index term frequencies and positions
+          indexed: Indexed
+          multi_valued: Multi-valued
+          name: Name
+          omit_positions: Omit positions
+          omit_tf: Omit term frequencies and positions
+          query_time_stopword_handling: Enable stopword handling
+          search_by_default: Search by default
+          short_field_boost: Short field boost
+          stored: Stored
+          synonym_expasion: Enable synonym expansion
+          term_vectors: Term vectors
+          use_for_deduplication: Use for de-duplication
+          use_in_find_similar: Use in 'find similar'
+        fieldtype:
+          name: Name
+          _class: Class
+    #
+    # This section containts two things:
+    # Model names wich support ActiveModel <model>.model_name.human
+    # Translations for attribute values.  This is our own invention,
+    # accessed with LucidWorks::Base#human_attribute_value(attribute)
+    # or from class LucidWorks::Base.human_attribute_value(attribute, value)
+    #
+    models:
+      lucid_works:
+        activity:
+          one: Activity
+          other: Activities
+          type:
+            autocomplete: Generate autocomplete index
+            click: Process click logs
+            optimize: Optimize index
+            spelling: Generate spellcheck index
+        collection:
+          one: Collection
+          other: Collections
+          settings:
+            de_duplication:
+              'off': 'Off'
+              overwrite: Overwrite
+              tag: Tag
+            one: Settings
+            other: Settings
+        datasource:
+          one: Data source
+          other: Data sources
+          status:
+            crawl_state:
+              ABORTED: Aborted
+              ABORTING: Aborting
+              EXCEPTION: Exception
+              FINISHED: Finished
+              IDLE: Idle
+              RUNNING: Running
+              STOPPED: Stopped
+              STOPPING: Stopping
+          type:
+            external: External
+            file: File system
+            ftp: FTP
+            hdfs: Hadoop file system
+            jdbc: Database
+            kfs: Kosmos file system
+            lucidworkslogs: LucidWorks Solr Logs
+            s3: Hadoop S3 Block FS
+            s3n: Hadoop S3 Native FS
+            sharepoint: SharePoint
+            smb: Windows Share
+            solrxml: Solr XML
+            web: Web site
+        field:
+          one: Field
+          other: Fields
+          index_term_freq_and_pos:
+            document_only: none
+            document_termfreq: term frequencies
+            document_termfreq_termpos: term frequencies and positions
+        fieldtype:
+          one: Field type
+          other: Field types
+        jdbcdriver:
+          one: JDBC driver
+          other: JDBC drivers
+  #
+  # These hints appear next to fields in SimpleForm forms
+  #
+  simple_form:
+    hints:
+      collection:
+        name: ! 'Collection names may use the characters: A-Z, a-z, 0-9, dash and
+          underscore'
+      datasource:
+        crawl_depth: Set to -1 to crawl with no depth limit.
+        exclude_paths: A list of regular expressions, one per line, e.g. .*\.pdf will
+          ignore filenames ending in .pdf.
+        include_paths: A list of regular expressions, one per line, e.g. http://example\.com/.*
+          will match everything within the site only.
+        max_bytes: Default = 10 MiB. Set to -1 to indicate no file size limit.
+        url: e.g. http://cnn.com. Please include protocol (http/https).
+      synonym:
+        mapping: ! 'Example: car, automobile, auto'

data/lib/lucid_works/associations/has_many.rb

@@ -18,7 +18,7 @@ module LucidWorks
         if target.save
           target
         else
-          raise target.errors.full_messages
+          raise LucidWorks::RecordInvalid.new(target.errors.full_messages)
         end
       end
 
@@ -40,7 +40,7 @@ module LucidWorks
       #
       # Interestingly for us the cost difference is marginal between the two forms of
       # the call.  Should we just grab all of them and return the one they want?
-      # Probably not.  Not every elegant and there is some cost to creating models
+      # Probably not.  Not very elegant and there is some cost to creating models
       # on our end.
       #
       # Okay for now we will just not cache .find()

data/lib/lucid_works/associations/has_one.rb

@@ -17,7 +17,7 @@ module LucidWorks
         if @target.save
           @target
         else
-          raise @target.errors.full_messages
+          raise LucidWorks::RecordInvalid.new(@target.errors.full_messages)
         end
       end
 

data/lib/lucid_works/associations/proxy.rb

@@ -25,9 +25,9 @@ module LucidWorks
         !!@target
       end
 
-      # Can targets be retrieved for all owners if this type, in one step using owner/all/target
-      def supports_all?
-        @options[:supports_all]
+      # Can targets be retrieved for all owners of this type, in one step using owner/all/target
+      def retrieveable_en_masse?
+        @options[:retrieveable_en_masse]
       end
 
       def reload!

data/lib/lucid_works/associations.rb

@@ -113,7 +113,7 @@ module LucidWorks
 
         class_eval <<-EOF, __FILE__, __LINE__ + 1
           def #{resource}
-            @#{resource}_association ||= Associations::HasOne.new(self, #{resource_class_name}, #{options.to_s})
+            @#{resource}_association ||= Associations::HasOne.new(self, #{resource_class_name}, #{options.inspect})
           end
 
           def #{resource}!
@@ -137,7 +137,7 @@ module LucidWorks
 
         class_eval <<-EOF, __FILE__, __LINE__ + 1
           def #{resources}(options={})
-            @#{resources}_association ||= Associations::HasMany.new(self, #{resource_class_name}, #{options.to_s})
+            @#{resources}_association ||= Associations::HasMany.new(self, #{resource_class_name}, #{options.inspect})
             @#{resources}_association.remember_find_options(options) unless options.empty?
             @#{resources}_association
           end

data/lib/lucid_works/base.rb

@@ -45,8 +45,6 @@ module LucidWorks
     define_model_callbacks :save, :only => [:before, :after]
 
     class << self
-      include ActionView::Helpers::NumberHelper rescue nil
-
       attr_accessor :collection_name # :nodoc:
       attr_accessor_with_default :singleton, false
       
@@ -66,7 +64,7 @@ module LucidWorks
       #   end
 
       def schema(&block)
-        @schema ||= LucidWorks::Schema.new
+        @schema ||= LucidWorks::Schema.new(self)
         if block_given?
           @schema.instance_eval(&block)
           @schema.create_accessors_for_attributes(self)
@@ -177,7 +175,7 @@ module LucidWorks
             target_class     = class_eval(association_info[:class_name]) # get scoping right
             target_name      = association_info[:class_name].underscore
 
-            if kind_of_find == :all && association_info[:supports_all]
+            if kind_of_find == :all && association_info[:retrieveable_en_masse]
               all_targets_path = "#{collection_url(parent)}/all/#{target_name}"
               raw_response = ActiveSupport::Notifications.instrument("lucid_works.request") do |payload|
                 begin
@@ -205,9 +203,7 @@ module LucidWorks
                 # [{"history":[...history_models...],"id":372},{"history":[...history_models...],"id":371}]
                 JSON.parse(raw_response).each do |group_of_targets|
                   owner_id = group_of_targets['id']
-                  # Note: to_i in the next line is because most REST API interfaces return ids a integers
-                  # but one returns them as strings.  There is no plan to fix this brokeness (FOCUS-2359).
-                  owner = results_array.detect { |result| result.id == owner_id.to_i }
+                  owner = results_array.detect { |result| result.id == owner_id }
                   targets = group_of_targets[target_name].collect do |target_attrs|
                     target_class.new(target_attrs.merge(:parent => owner, :persisted => true))
                   end
@@ -215,7 +211,7 @@ module LucidWorks
                   association_proxy.target = targets
                 end
               end
-            else # kind_of_find != :all || !supports_all
+            else # kind_of_find != :all || !retrieveable_en_masse
               results_array.each do |result|
                 result.send("#{association_name}!")
               end
@@ -250,31 +246,14 @@ module LucidWorks
       # If the attributes is listed in the schema as having :values =>, it will be translated.
 
       def human_attribute_value(attribute, value)
-        if schema[attribute][:values]
-          l10n_scope = %w{activemodel models} + self.name.underscore.split('/') + [attribute]
-          return I18n.t(value, :scope => l10n_scope, :default => value)
-        end
-
-        case schema[attribute][:type]
-        when :boolean
-          value.to_yesno
-        when :integer
-          number_with_delimiter(value)
-        else
-          value.to_s
-        end
-      rescue
-        value.to_s
+        schema[attribute].human_value(value)
       end
 
       # For attributes listed in the schema as having :values, this will create an array-of-arrays
       # 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]
-        schema[attribute][:values].map do |value|
-          [human_attribute_value(attribute, value), value]
-        end
+        schema[attribute].to_select
       end
 
       def collection_name # :nodoc:
@@ -332,7 +311,7 @@ module LucidWorks
           rescue RestClient::Conflict,                   # 409
                  RestClient::UnprocessableEntity,        # 422
                  RestClient::InternalServerError => e    # 500
-            payload[:exceptionion] = e
+            payload[:exception] = e
             attach_errors_to_model(e.response)
             false
           rescue RestClient::Exception => exception
@@ -358,6 +337,10 @@ module LucidWorks
           payload[:uri]      = member_url
           payload[:options]  = options
           payload[:repsonse] = RestClient.delete(member_url, options)
+        rescue RestClient::Conflict => e
+          payload[:exception] = e
+          attach_errors_to_model(e.response)
+          false
         rescue RestClient::Exception => exception
           # Tack on what we were doing when we got the exception, then send it on up
           exception.message = "#{exception.message} while performing #{payload[:method]} #{payload[:uri]}"
@@ -409,6 +392,10 @@ module LucidWorks
 
     private
 
+    def schema
+      self.class.schema
+    end
+
     def singleton? # :nodoc:
       self.class.singleton
     end
@@ -418,20 +405,12 @@ module LucidWorks
     end
 
     def encode # :nodoc:
-      omit_attrs = [ 'id' ]
-      omit_attrs += self.class.schema.attrs_to_omit_during_update if persisted?
-      attrs_as_json = @attributes.inject({}) do |memo, kv|
+      attrs_as_json = @attributes.inject({}) do |encoded_attrs, kv|
         attr, value = kv
-        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 rescue value
-          else
-            memo[attr] = value
-          end
+        unless attr.to_s == 'id'
+          schema[attr].encode_and_insert(value, encoded_attrs, persisted?)
         end
-        memo
+        encoded_attrs
       end
       attrs_as_json.to_json
     end
@@ -445,14 +424,8 @@ module LucidWorks
         elsif self.class.respond_to?(:belongs_to_association_name) && attr.to_sym == self.class.belongs_to_association_name
           next # Dont overwrite our connection to our parent
         end
-        unless self.class.schema.has_attribute?(attr)
-          if self.class.schema.dynamic_attributes?
-            self.class.schema.add_attribute(self.class, attr, :string)
-          else
-            raise "unknown attribute: \"#{attr}\""
-          end
-        end
-        send "#{self.class.schema.sanitize_identifier(attr)}=", value
+        attribute = schema.find_or_create_attribute(attr)
+        send "#{attribute.name}=", value
       end
     end