volt 0.8.27.beta2 → 0.8.27.beta3

data/lib/volt/models/model.rb

@@ -12,6 +12,11 @@ module Volt
   class NilMethodCall < NoMethodError
   end
 
+  # The error is raised when a reserved field name is used in a
+  # volt model.
+  class InvalidFieldName < StandardError
+  end
+
   class Model
     include ModelWrapper
     include ModelHelpers
@@ -24,6 +29,14 @@ module Volt
     attr_reader :attributes
     attr_reader :parent, :path, :persistor, :options
 
+    INVALID_FIELD_NAMES = {
+      :attributes => true,
+      :parent => true,
+      :path => true,
+      :options => true,
+      :persistor => true
+    }
+
     def initialize(attributes = {}, options = {}, initial_state = nil)
       @deps        = HashDependency.new
       @size_dep    = Dependency.new
@@ -64,7 +77,7 @@ module Volt
 
       if attrs
         # Assign id first
-        id       = attrs.delete(:_id)
+        id = attrs.delete(:_id)
 
         # When doing a mass-assign, we don't save until the end.
         Model.nosave do
@@ -141,6 +154,8 @@ module Volt
       # Assign, without the =
       attribute_name = method_name.to_sym
 
+      check_valid_field_name(attribute_name)
+
       value = args[0]
 
       old_value = @attributes[attribute_name]
@@ -175,6 +190,8 @@ module Volt
       # Reading an attribute, we may get back a nil model.
       attr_name = attr_name.to_sym
 
+      check_valid_field_name(attr_name)
+
       # Track dependency
       # @deps.depend(attr_name)
 
@@ -293,6 +310,15 @@ module Volt
 
     private
 
+    # Volt provides a few access methods to get more data about the model,
+    # we want to prevent these from being assigned or accessed through
+    # underscore methods.
+    def check_valid_field_name(name)
+      if INVALID_FIELD_NAMES[name]
+        raise InvalidFieldName, "`#{name}` is reserved and can not be used as a field"
+      end
+    end
+
     def setup_buffer(model)
       model.attributes = attributes
       model.change_state_to(:loaded)

data/lib/volt/models/model_hash_behaviour.rb

@@ -29,7 +29,7 @@ module Volt
 
       keys = []
 
-      each_pair do |k,v|
+      each_pair do |k, v|
         keys << k
       end
 
@@ -75,8 +75,8 @@ module Volt
     end
 
     def each_pair
-      @attributes.each_pair do |k,v|
-        yield(k,v) unless v.is_a?(Model) && v.nil?
+      @attributes.each_pair do |k, v|
+        yield(k, v) unless v.is_a?(Model) && v.nil?
       end
     end
 
@@ -98,6 +98,5 @@ module Volt
         hash
       end
     end
-
   end
 end

data/lib/volt/models/persistors/array_store.rb

@@ -2,7 +2,6 @@ require 'volt/models/persistors/store'
 require 'volt/models/persistors/query/query_listener_pool'
 require 'volt/models/persistors/store_state'
 
-
 module Volt
   module Persistors
     class ArrayStore < Store
@@ -83,12 +82,12 @@ module Volt
 
       # Clear out the models data, since we're not listening anymore.
       def unload_data
-        puts "Unload Data"
+        puts 'Unload Data'
         change_state_to :not_loaded
         @model.clear
       end
 
-      def run_query(model, query={}, skip=nil, limit=nil)
+      def run_query(model, query = {}, skip = nil, limit = nil)
         @model.clear
 
         collection = model.path.last
@@ -126,21 +125,21 @@ module Volt
           query ||= {}
         end
 
-        return Cursor.new([], @model.options.merge(query: query))
+        Cursor.new([], @model.options.merge(query: query))
       end
 
       def limit(limit)
-        return Cursor.new([], @model.options.merge(limit: limit))
+        Cursor.new([], @model.options.merge(limit: limit))
       end
 
       def skip(skip)
-        return Cursor.new([], @model.options.merge(skip: skip))
+        Cursor.new([], @model.options.merge(skip: skip))
       end
 
       # Returns a promise that is resolved/rejected when the query is complete.  Any
       # passed block will be passed to the promises then.  Then will be passed the model.
       def then(&block)
-        raise "then must pass a block" unless block
+        fail 'then must pass a block' unless block
         promise = Promise.new
 
         promise = promise.then(&block)

data/lib/volt/models/persistors/cookies.rb

@@ -11,7 +11,7 @@ module Volt
         cookies = `document.cookie`
         Hash[cookies.split(';').map do |v|
           # Equals are valid as part of a cookie, so only parse the first equals.
-          parts = v.split('=', 2).map { |p| p = p.strip ; `decodeURIComponent(p)` }
+          parts = v.split('=', 2).map { |p| p = p.strip; `decodeURIComponent(p)` }
 
           # Default to empty if no value
           parts << '' if parts.size == 1
@@ -21,7 +21,7 @@ module Volt
         end]
       end
 
-      def write_cookie(key, value, options={})
+      def write_cookie(key, value, options = {})
         parts = []
 
         parts << `encodeURIComponent(key)`

data/lib/volt/models/persistors/model_store.rb

@@ -62,9 +62,9 @@ module Volt
 
       def save_changes?
         if RUBY_PLATFORM == 'opal'
-          return !(defined?($loading_models) && $loading_models) && @tasks
+          !(defined?($loading_models) && $loading_models) && @tasks
         else
-          return true
+          true
         end
       end
 
@@ -126,13 +126,12 @@ module Volt
         StoreTasks.save(collection, @model.path, self_attributes).then do
           save_promises = @save_promises
           @save_promises = nil
-          save_promises.each {|promise|  promise.resolve(nil) }
+          save_promises.each { |promise|  promise.resolve(nil) }
         end.fail do |errors|
           save_promises = @save_promises
           @save_promises = nil
-          save_promises.each {|promise|  promise.reject(errors) }
+          save_promises.each { |promise|  promise.reject(errors) }
         end
-
       end
 
       def event_added(event, first, first_for_event)
@@ -206,7 +205,7 @@ module Volt
 
           # puts "Update Collection: #{collection.inspect} - #{values.inspect} -- #{Thread.current['in_channel'].inspect}"
           QueryTasks.live_query_pool.updated_collection(collection.to_s, Thread.current['in_channel'])
-          return {}
+          {}
         end
       end
     end

data/lib/volt/models/validations.rb

@@ -1,5 +1,6 @@
 # require 'volt/models/validations/errors'
 require 'volt/models/validators/email_validator'
+require 'volt/models/validators/format_validator'
 require 'volt/models/validators/length_validator'
 require 'volt/models/validators/numericality_validator'
 require 'volt/models/validators/phone_number_validator'
@@ -10,10 +11,10 @@ module Volt
   # Include in any class to get validation logic
   module Validations
     module ClassMethods
-      def validate(field_name=nil, options=nil, &block)
+      def validate(field_name = nil, options = nil, &block)
         if block
           if field_name || options
-            raise "validate should be passed a field name and options or a block, not both."
+            fail 'validate should be passed a field name and options or a block, not both.'
           end
           self.custom_validations ||= []
           custom_validations << block
@@ -39,7 +40,6 @@ module Volt
       @marked_fields ||= ReactiveHash.new
     end
 
-
     # Marks all fields, useful for when a model saves.
     def mark_all_fields!
       validations = self.class.validations
@@ -50,7 +50,6 @@ module Volt
       end
     end
 
-
     def marked_errors
       errors(true)
     end
@@ -125,7 +124,7 @@ module Volt
         end
       end
 
-      return errors
+      errors
     end
 
     def run_custom_validations(errors, merge, old_model)
@@ -143,10 +142,9 @@ module Volt
         end
       end
 
-      return errors
+      errors
     end
 
-
     # calls the validate method on the class, passing the right arguments.
     def validate_with(merge, klass, old_model, field_name, args)
       merge.call(klass.validate(self, old_model, field_name, args))

data/lib/volt/models/validators/email_validator.rb

@@ -1,40 +1,19 @@
 module Volt
   class EmailValidator
-    DEFAULT_REGEX = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i
-    ERROR_MESSAGE = 'must be an email address'
+    DEFAULT_OPTIONS = {
+      with: /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i,
+      message: 'must be an email address'
+    }
 
     def self.validate(model, old_model, field_name, options)
       new(model, field_name, options).errors
     end
 
-    def initialize(model, field_name, options)
-      @value = model.read_attribute field_name
+    def self.new(model, field_name, options)
+      options = DEFAULT_OPTIONS if options == true
+      options = DEFAULT_OPTIONS.merge options
 
-      case options
-      when Hash, true, false
-        configure options
-      else
-        fail 'arguments can only be a Boolean or a Hash'
-      end
-    end
-
-    def valid?
-      return false unless @value.is_a? String
-
-      !!@value.match(@custom_regex || DEFAULT_REGEX)
-    end
-
-    def errors
-      valid? ? {} : { email: [ @custom_message || ERROR_MESSAGE ] }
-    end
-
-    private
-
-    def configure(options)
-      return unless options.is_a? Hash
-
-      @custom_message = options.fetch(:error_message) { nil }
-      @custom_regex = options.fetch(:with) { nil }
+      FormatValidator.new(model, field_name).apply options
     end
   end
 end

data/lib/volt/models/validators/format_validator.rb

@@ -0,0 +1,116 @@
+module Volt
+  class FormatValidator
+    # Creates a new instance with the provided options and returns it's errors
+    #
+    # @note the second param +old_model+ is unused and will soon be removed,
+    #   you can pass nil in the mean time
+    #
+    # @example
+    #   options = { with: /.+@.+/, message: 'must include an @ symobl' }
+    #
+    #   FormatValidator.validate(user, nil, 'email', options)
+    #
+    # @example
+    #   numbers_only = /^\d+$/
+    #   sum_equals_ten = ->(s) { s.chars.map(&:to_i).reduce(:+) == 10 }
+    #
+    #   options = [
+    #     { with: numbers_only, message: 'must include only numbers' },
+    #     { with: sum_equals_ten, message: 'must add up to 10' }
+    #   ]
+    #
+    #   FormatValidator.validate(user, nil, 'email', options)
+    #
+    # @param model [Volt::Model] the model being validated
+    # @param old_model [NilClass] no longer used, will be removed
+    # @param field_name [String] the name of the field being validated
+    #
+    # @param options (see #apply)
+    # @option options (see #apply)
+    #
+    # @return (see #errors)
+    def self.validate(model, old_model, field_name, options)
+      new(model, field_name).apply(options).errors
+    end
+
+    # @param model [Volt::Model] the model being validated
+    # @param field_name [String] the name of the field being validated
+    def initialize(model, field_name)
+      @name = field_name
+      @value = model.read_attribute field_name
+      @criteria = []
+    end
+
+    # Applies criteria to the validator in a variety of forms
+    #
+    # @see .validate param examples
+    # @param options [Hash, Array<Hash>] criteria and related error messages
+    #
+    # @option options [Regexp, Proc] :with criterion for validation
+    # @option options [String] :message to display if criterion not met
+    #   - will be appended to the field name
+    #   - should start with something like:
+    #     - +"must include..."+
+    #     - +"should end with..."+
+    #     - +"is invalid because..."+
+    #
+    # @return [self] returns itself for chaining
+    def apply(options)
+      return apply_list options if options.is_a? Array
+      with options[:with], options[:message]
+      self
+    end
+
+    # Returns the first of the validation errors or an empty hash
+    #
+    # @return [Hash] hash of validation errors for the field
+    #   - +{}+ if there are no errors
+    #   - +{ field_name: [messages] }+ if there are errors
+    def errors
+      valid? ? {} : { @name => error_messages }
+    end
+
+    # Returns an array of validation error messages
+    # @return [Array<String>]
+    def error_messages
+      @criteria.reduce([]) do |e, c|
+        test(c[:criterion]) ? e : e << c[:message]
+      end
+    end
+
+    # Returns true or false depending on if the model passes all its criteria
+    # @return [Boolean]
+    def valid?
+      error_messages.empty?
+    end
+
+    # Adds a criterion and error message
+    #
+    # @param criterion [Regexp, Proc] criterion for validation
+    # @param message [String] to display if criterion not met
+    #   - will be appended to the field name
+    #   - should start with something like:
+    #     - +"must include..."+
+    #     - +"should end with..."+
+    #     - +"is invalid because..."+
+    #
+    # @return (see #apply)
+    def with(criterion, message)
+      @criteria << { criterion: criterion, message: message }
+      self
+    end
+
+    private
+
+    def apply_list(array)
+      array.each { |options| apply options }
+      self
+    end
+
+    def test(criterion)
+      return false unless @value.respond_to? :match
+
+      !!(criterion.try(:call, @value) || criterion.try(:match, @value))
+    end
+  end
+end

data/lib/volt/models/validators/numericality_validator.rb

@@ -2,7 +2,7 @@ module Volt
   class NumericalityValidator
     def self.validate(model, old_model, field_name, args)
       # Construct the class and return the errors
-      self.new(model, field_name, args).errors
+      new(model, field_name, args).errors
     end
 
     attr_reader :errors
@@ -34,7 +34,7 @@ module Volt
             case arg
             when :min
               if @value < val
-               add_error("number must be greater than #{val}")
+                add_error("number must be greater than #{val}")
               end
             when :max
               if @value > val

data/lib/volt/models/validators/phone_number_validator.rb

@@ -1,40 +1,19 @@
 module Volt
   class PhoneNumberValidator
-    DEFAULT_REGEX = /^(\+?\d{1,2}[\.\-\ ]?\d{3}|\(\d{3}\)|\d{3})[\.\-\ ]?\d{3,4}[\.\-\ ]?\d{4}$/
-    ERROR_MESSAGE = 'must be a phone number with area or country code'
+    DEFAULT_OPTIONS = {
+      with: /^(\+?\d{1,2}[\.\-\ ]?\d{3}|\(\d{3}\)|\d{3})[\.\-\ ]?\d{3,4}[\.\-\ ]?\d{4}$/,
+      message: 'must be a phone number with area or country code'
+    }
 
     def self.validate(model, old_model, field_name, options)
       new(model, field_name, options).errors
     end
 
-    def initialize(model, field_name, options)
-      @value = model.read_attribute field_name
+    def self.new(model, field_name, options)
+      options = DEFAULT_OPTIONS if options == true
+      options = DEFAULT_OPTIONS.merge options
 
-      case options
-      when Hash, true, false
-        configure options
-      else
-        fail 'arguments can only be a Boolean or a Hash'
-      end
-    end
-
-    def valid?
-      return false unless @value.is_a? String
-
-      !!@value.match(@custom_regex || DEFAULT_REGEX)
-    end
-
-    def errors
-      valid? ? {} : { phone_number: [ @custom_message || ERROR_MESSAGE ] }
-    end
-
-    private
-
-    def configure(options)
-      return unless options.is_a? Hash
-
-      @custom_message = options.fetch(:error_message) { nil }
-      @custom_regex = options.fetch(:with) { nil }
+      FormatValidator.new(model, field_name).apply options
     end
   end
 end

data/lib/volt/models/validators/unique_validator.rb

@@ -10,12 +10,12 @@ module Volt
           query = {}
           # Check to see if any other documents have this value.
           query[field_name.to_s] = value
-          query['_id'] = {'$ne' => model._id}
+          query['_id'] = { '$ne' => model._id }
 
           # Check if the value is taken
           # TODO: need a way to handle scope for unique
           if $page.store.send(:"_#{model.path[-2]}").find(query).size > 0
-            message = (args.is_a?(Hash) && args[:message]) || "is already taken"
+            message = (args.is_a?(Hash) && args[:message]) || 'is already taken'
 
             errors[field_name] = [message]
           end

data/lib/volt/page/bindings/content_binding.rb

@@ -25,7 +25,7 @@ module Volt
 
       # Update the html in this section
       # TODO: Move the formatter into another class.
-      dom_section.html = value.gsub("\n", "<br />\n")
+      dom_section.text = value.gsub("\n", "<br />\n")
     end
 
     def remove

data/lib/volt/page/bindings/each_binding.rb

@@ -80,7 +80,7 @@ module Volt
 
       # TODORW: :parent => @value may change
       item_context                           = SubContext.new({ _index_value: position, parent: @value }, @context)
-      item_context.locals[@item_name.to_sym] = proc { @value[item_context.locals[:_index_value]]}
+      item_context.locals[@item_name.to_sym] = proc { @value[item_context.locals[:_index_value]] }
 
       position_dependency                    = Dependency.new
       item_context.locals[:_index_dependency] = position_dependency

data/lib/volt/page/bindings/template_binding/view_lookup_for_path.rb

@@ -0,0 +1,92 @@
+module Volt
+  # ViewFinderForPath helps find the location of view file given
+  # a template path.
+  class ViewLookupForPath
+    # Takes in the path of the current view file.  This allows for relative paths
+    # to be run.
+    #
+    # @param [Page] the page object
+    # @param [String] the path of the current view
+    def initialize(page, binding_in_path)
+      @page = page
+      path_parts       = binding_in_path.split('/')
+      @collection_name = path_parts[0]
+      @controller_name = path_parts[1]
+      @page_name       = path_parts[2]
+    end
+
+    # Returns true if there is a template at the path
+    def check_for_template?(path)
+      @page.templates[path]
+    end
+
+    # Takes in a lookup path and returns the full path for the matching
+    # template.  Also returns the controller and action name if applicable.
+    #
+    # Looking up a path is fairly simple.  There are 4 parts needed to find
+    # the html to be rendered.  File paths look like this:
+    # app/{component}/views/{controller_name}/{view}.html
+    # Within the html file may be one or more sections.
+    # 1. component (app/{comp})
+    # 2. controller
+    # 3. view
+    # 4. sections
+    #
+    # When searching for a file, the lookup starts at the section, and moves up.
+    # when moving up, default values are provided for the section, then view/section, etc..
+    # until a file is either found or the component level is reached.
+    #
+    # The defaults are as follows:
+    # 1. component - main
+    # 2. controller - main
+    # 3. view - index
+    # 4. section - body
+    def path_for_template(lookup_path, force_section = nil)
+      parts      = lookup_path.split('/')
+      parts_size = parts.size
+
+      default_parts     = %w(main main index body)
+
+      # When forcing a sub template, we can default the sub template section
+      default_parts[-1] = force_section if force_section
+
+      (5 - parts_size).times do |path_position|
+        # If they passed in a force_section, we can skip the first
+        next if force_section && path_position == 0
+
+        full_path = [@collection_name, @controller_name, @page_name, nil]
+
+        start_at = full_path.size - parts_size - path_position
+
+        full_path.size.times do |index|
+          if index >= start_at
+            if (part = parts[index - start_at])
+              full_path[index] = part
+            else
+              full_path[index] = default_parts[index]
+            end
+          end
+        end
+
+        path = full_path.join('/')
+        if check_for_template?(path)
+          controller = nil
+
+          if path_position >= 1
+            init_method = full_path[2]
+          else
+            init_method = full_path[3]
+          end
+
+          # Lookup the controller
+          controller = [full_path[0], full_path[1] + '_controller', init_method]
+
+          return path, controller
+        end
+      end
+
+      [nil, nil]
+    end
+
+  end
+end