volt 0.9.0.pre3 → 0.9.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a657a85e80572c96acf329e6bcae5e6068ab330
-  data.tar.gz: 03b2010b74fe63a65b47a3032f0c96021dbaaea2
+  metadata.gz: e4d4f11c399ddcd63de7bc157707e0b1e5a91561
+  data.tar.gz: 773ade706e860021c11bf7d22c78e868fa51d139
 SHA512:
-  metadata.gz: ce9938c5ea6de3864eb535bc7edbc8af55e2063aef79d70b0dc478dc4c2836465b7e11f4451818ec5c07d4f833664d2ed8abb1a7821480567a0b9895b4d18cd7
-  data.tar.gz: f3a520c558f153268123966047d470847ce892bef26cadef22b9dd996be291c77297cced514a52557a5aad01469bf60add2640fead42e3465adbb1b01ab50c7e
+  metadata.gz: 0542352171aa44247b3471c8e3ea3838e6d2127f896c56312b127936d523840c6d6e76c7ad16126e46844322004ef119bc1949696e83563b9754db8bc014cbf0
+  data.tar.gz: fcb365747674befac85bf8a8b08bf64addb800fb193500e822a8f4cb7cad4ea20ee51f67688d4aedcb47bc89b189867b9c18d39e65ac79c1f2a680ffb457845a

data/CHANGELOG.md

@@ -2,18 +2,15 @@
 
 ## 0.9.0.pre1
 ### Added
+- the permissions api has been added!
 - added has_many and belongs_to on models.  See docs.
 - you can now serve http/rest from Volt.  Thanks to @jfahrer for his great work.  Docs coming soon.
 - there is now a generator for controllers and HttpControllers.
-- the following were renamed to follow gem naming conventions:
-  - volt-user-templates (now volt-user_templates)
-  - volt-bootstrap-jumbotron-theme (now volt-bootstrap_jumbotron_theme)
 - fixed generated component code
 - added .order for sorting on the data store (since .sort is a ruby Enum method)
 - calling .then on ArrayModels has been changed to calling .fetch and .fetch_first.  These both return a promise, and take an optional block
 - added .sync for synchronusly waiting on promises on the server only
 - added the ability to pass content into tags: (https://github.com/voltrb/docs/blob/master/en/docs/yield_binding.md)
-- the {action}_remove method had been changed to before_{action}_remove and after_{action}_remove to provide more hooks and a clearer understanding of when it is happening.
 - Changed it so content bindings escape all html (for CSRF - thanks @ChaosData)
 - Added formats, email, phone validators (thanks @lexun and @kxcrl)
 - each_with_index is now supported in views and the ```index``` value is no longer provided by default.
@@ -24,24 +21,31 @@
 - bindings will now resolve any values that are promises. (currently only content and attribute, if, each, and template coming soon)
 - ```store``` is now available inside of specs.  If it is accessed in a spec, the database will be cleaned after the spec.
 - ```the_page``` is a shortcut to the page collection inside of specs.  (Unfortunately, ```page``` is used by capybara, so for now we're using ```the_page```, we'll find a better solution in the future.)
+- Add filtering to logging on password, and option to configure filtered args.  Also, improve the way errors are displayed.
 
 ### Changed
+- template bindings have been renamed to view.  ```{{ view "path/for/view" }}``` instead of ```{{ template "path/for/view" }}```
+- the {action}_remove method had been changed to before_{action}_remove and after_{action}_remove to provide more hooks and a clearer understanding of when it is happening.
+- the following were renamed to follow gem naming conventions:
+  - volt-user-templates (now volt-user_templates)
+  - volt-bootstrap-jumbotron-theme (now volt-bootstrap_jumbotron_theme)
 - all plural attributes now return an empty ArrayModel.  This is to simplify implementation and to unify store's interface.
 - main_path in generated projects now includes the a component param that can be used to easily point at controllers/views in other components.
 - previously the main component's controllers were not namespaced.  We changed it so all controllers (including those in main) are namespaced.  This is makes things more consistent and keeps expectations when working with components.
 - model attributes no longer return NilModels.  Instead they just return nil.  You can however add an ! to the end to "expand" the model to an empty model.
 
-```page._new_todo # => now returns nil```
+    ```page._new_todo # => now returns nil```
 
-```page._new_todo! # => returns an empty model```
+    ```page._new_todo! # => returns an empty model```
 
-So if you wanted to use a property on ```_new_todo``` without initializing ```_new_todo```, you could add the ! to the lookup.
+  So if you wanted to use a property on ```_new_todo``` without initializing ```_new_todo```, you could add the ! to the lookup.
 - Volt.user has been renamed to Volt.current_user so its clearer what it returns
 - _'s are no longer required for route constraints (so just use ```controller: 'main', action: 'index'``` now)
 - the underlying way queries are normalized and passed to the server has changed (no external api changes)
 - changed .find to .where to not conflict with ruby Enum's .find
 - Volt::TaskHandler is now Volt::Task
 - Move testing gems to the generated Gemfile for projects
+- ```if ENV['BROWSER']``` is no longer required around integration tests.  We now use rspec filtering on ```type: :feature``` if you aren't running with ENV['BROWSER']
 
 ### Removed
 - .false?, .true?, .or, and .and were removed since NilModels were removed.  This means you get back a real nil value when accessing an undefined model attribute.

data/VERSION

@@ -1 +1 @@
-0.9.0.pre3
+0.9.0.pre4

data/app/volt/tasks/user_tasks.rb

@@ -1,13 +1,18 @@
 class UserTasks < Volt::Task
   # Login a user, takes a login and password.  Login can be either a username
   # or an e-mail based on Volt.config.public.auth.use_username
-  def login(login, password)
+  #
+  # login_info is a key with login and password (login may be e-mail)
+  def login(login_info)
+    login = login_info['login']
+    password = login_info['password']
+
     query = { User.login_field => login }
 
     # During login we need access to the user's info even though we aren't the user
     Volt.skip_permissions do
       store._users.where(query).fetch_first do |user|
-        fail 'User could not be found' unless user
+        fail VoltUserError, 'User could not be found' unless user
 
         match_pass = BCrypt::Password.new(user._hashed_password)
         fail 'Password did not match' unless  match_pass == password

data/lib/volt.rb

@@ -3,6 +3,7 @@ require 'volt/extra_core/extra_core'
 require 'volt/reactive/computation'
 require 'volt/reactive/dependency'
 require 'volt/utils/modes'
+require 'volt/utils/volt_user_error'
 
 require 'volt/config'
 unless RUBY_PLATFORM == 'opal'

data/lib/volt/cli/generate.rb

@@ -6,7 +6,9 @@ class Generate < Thor
   method_option :component, type: :string, default: 'main', banner: 'The component the model should be created in.', required: false
   def model(name, component = 'main')
     output_file = Dir.pwd + "/app/#{component.underscore}/models/#{name.underscore.singularize}.rb"
+    spec_file = Dir.pwd + "/spec/app/#{component.underscore}/models/#{name.underscore.pluralize}_spec.rb"
     template('model/model.rb.tt', output_file, model_name: name.camelize.singularize)
+    template('model/model_spec.rb.tt', spec_file, model_name: name.camelize.singularize)
   end
 
   desc 'component NAME', 'Creates a component named NAME in the app folder.'
@@ -14,8 +16,10 @@ class Generate < Thor
   def component(name)
     name = name.underscore
     component_folder = Dir.pwd + "/app/#{name}"
+    component_spec_folder = Dir.pwd + '/spec/app/' + name
     @component_name = name
     directory('component', component_folder, component_name: name)
+    directory('component_specs', component_spec_folder)
   end
 
 
@@ -31,7 +35,7 @@ class Generate < Thor
     require 'volt/cli/new_gem'
 
     if name =~ /[-]/
-      Volt.logger.error("Gem names should use underscores for their names.  Currently volt only supports a single namespace for a compoennt.")
+      Volt.logger.error("Gem names should use underscores for their names.  Currently volt only supports a single namespace for a component.")
       return
     end
 
@@ -46,37 +50,51 @@ class Generate < Thor
   method_option :name, type: :string, banner: 'The name of the HTTP Controller.'
   method_option :component, type: :string, default: 'main', banner: 'The component the http_controller should be created in.', required: false
   def http_controller(name, component = 'main')
-    output_file = Dir.pwd + "/app/#{component}/controllers/#{name.underscore.singularize}.rb"
-    template('controller/http_controller.rb.tt', output_file, component_module: component.camelize, http_controller_name: name.camelize.singularize)
+    name = name.underscore.pluralize + '_controller' unless name =~ /_controller$/
+
+    output_file = Dir.pwd + "/app/#{component}/controllers/server/#{name.underscore}.rb"
+    spec_file = Dir.pwd + "/spec/app/#{component.underscore}/controllers/server/#{name}_spec.rb"
+
+    template('controller/http_controller.rb.tt', output_file, component_module: component.camelize, http_controller_name: name.camelize)
+    template('controller/http_controller_spec.rb.tt', spec_file, component_module: component.camelize, http_controller_name: name.camelize)
   end
 
   desc 'controller NAME COMPONENT', 'Creates a model controller named NAME in the app folder of the component named COMPONENT.'
   method_option :name, type: :string, banner: 'The name of the model controller.'
   method_option :component, type: :string, default: 'main', banner: 'The component the controller should be created in.', required: false
   def controller(name, component = 'main')
-    output_file = Dir.pwd + "/app/#{component}/controllers/#{name.underscore.singularize}.rb"
-    template('controller/model_controller.rb.tt', output_file, component_module: component.camelize, model_controller_name: name.camelize.singularize)
+    controller_name = name.underscore.singularize + '_controller' unless name =~ /_controller$/
+    output_file = Dir.pwd + "/app/#{component.underscore}/controllers/#{controller_name}.rb"
+    spec_file = Dir.pwd + "/spec/app/#{component.underscore}/integration/#{name.underscore.pluralize}_spec.rb"
+
+    template('controller/model_controller.rb.tt', output_file, component_module: component.camelize, model_controller_name: controller_name.camelize)
+    template('controller/model_controller_spec.rb.tt', spec_file, describe: name.underscore.pluralize )
   end
 
   desc 'task NAME COMPONENT', 'Creates a task named NAME in the app folder of the component named COMPONENT.'
   method_option :name, type: :string, banner: 'The name of the task.'
   method_option :component, type: :string, default: 'main', banner: 'The component the task should be created in.', required: false
   def task(name, component = 'main')
-    output_file = Dir.pwd + "/app/#{component}/tasks/#{name.underscore.singularize}.rb"
+    name = name.underscore.singularize
+    output_file = Dir.pwd + "/app/#{component}/tasks/#{name}.rb"
+    spec_file = Dir.pwd + "/spec/app/#{component}/tasks/#{name}_spec.rb"
     template('task/task.rb.tt', output_file, task_name: name.camelize.singularize)
+    template('task/task_spec.rb.tt', spec_file, task_name: name.camelize.singularize)
   end
 
   desc 'view NAME COMPONENT', 'Creates a view named NAME in the app folder of the component named COMPONENT.'
   method_option :name, type: :string, banner: 'The name of the view.'
   method_option :component, type: :string, default: 'main', banner: 'The component the view should be created in.', required: false
   def view(name, component = 'main')
-    output_file = Dir.pwd + "/app/#{component}/views/#{component}/#{name.underscore.singularize}.html"
-    controller(name, component) unless controller?(name, component)
-    template('view/view.rb.tt', output_file, view_name: name.camelize.singularize)
+    name = name.underscore.singularize
+    view_folder = Dir.pwd + "/app/#{component}/views/#{name}/"
+    directory('view', view_folder, view_name: name, component: component)
+    controller(name, component) unless controller_exists?(name, component)
   end
 
   private
-  def controller?(name, component = 'main')
+
+  def controller_exists?(name, component = 'main')
     dir = Dir.pwd + "/app/#{component}/controllers/"
     File.exists?(dir + name.downcase.underscore.singularize + '.rb')
   end

data/lib/volt/controllers/http_controller.rb

@@ -12,7 +12,7 @@ module Volt
       @response_headers = HttpResponseHeader.new
       @response_body = []
       @request = request
-      @params = params.symbolize_keys.merge(request.params)
+      @params = Volt::Model.new(params.symbolize_keys.merge(request.params))
     end
 
     def perform(action)

data/lib/volt/extra_core/logger.rb

@@ -27,7 +27,7 @@ else
         @formatter = Volt::VoltLoggerFormatter.new
       end
 
-      def log_dispatch(class_name, method_name, run_time, args)
+      def log_dispatch(class_name, method_name, run_time, args, error)
         @current = {
           args: args,
           class_name: class_name,
@@ -35,7 +35,19 @@ else
           run_time: run_time
         }
 
-        log(Logger::INFO, task_dispatch_message)
+        level = error ? Logger::ERROR : Logger::INFO
+        text = TaskLogger.task_dispatch_message(self, args)
+
+
+        if error
+          text += "\n" + colorize(error.to_s, :red)
+          if error.is_a?(Exception) && !error.is_a?(VoltUserError)
+            text += "\n" + colorize(error.backtrace.join("\n"), :red)
+          end
+        end
+
+        log(level, text)
+
       end
 
       def args
@@ -75,15 +87,6 @@ else
           string.to_s
         end
       end
-
-      def task_dispatch_message
-        msg = "task #{class_name}##{method_name} in #{run_time}\n"
-        if args.size > 0
-          arg_str = args.map {|v| v.inspect }.join(', ')
-          msg += "with args: #{arg_str}\n"
-        end
-        msg
-      end
     end
 
     class VoltLoggerFormatter < Logger::Formatter

data/lib/volt/models/persistors/query/query_listener.rb

@@ -42,7 +42,13 @@ module Volt
       end.fail do |err|
         # TODO: need to make it so we can re-raise out of this promise
         Volt.logger.error("Error adding listener: #{err.inspect}")
-        Volt.logger.error(err.backtrace)
+        Volt.logger.error(err.backtrace) if err.respond_to?(:backtrace)
+
+        # If we get back that the user signature is wrong, log the user out.
+        if err.to_s.start_with?('user id or hash is incorrectly signed')
+          # Delete the invalid cookie
+          $page.cookies.delete(:user_id)
+        end
 
         raise err
       end

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

@@ -1,7 +1,7 @@
-require 'volt/page/bindings/template_binding'
+require 'volt/page/bindings/view_binding'
 
 # Component bindings are the same as template bindings, but handle components.
 module Volt
-  class ComponentBinding < TemplateBinding
+  class ComponentBinding < ViewBinding
   end
 end

data/lib/volt/page/bindings/{template_binding.rb → view_binding.rb}

@@ -1,11 +1,11 @@
 require 'volt/page/bindings/base_binding'
 require 'volt/page/template_renderer'
-require 'volt/page/bindings/template_binding/grouped_controllers'
-require 'volt/page/bindings/template_binding/view_lookup_for_path'
+require 'volt/page/bindings/view_binding/grouped_controllers'
+require 'volt/page/bindings/view_binding/view_lookup_for_path'
 
 
 module Volt
-  class TemplateBinding < BaseBinding
+  class ViewBinding < BaseBinding
 
     # @param [String]     binding_in_path is the path this binding was rendered from.  Used to
     #                     lookup paths in ViewLookupForPath

data/lib/volt/page/page.rb

@@ -9,7 +9,7 @@ require 'volt/page/bindings/attribute_binding'
 require 'volt/page/bindings/content_binding'
 require 'volt/page/bindings/each_binding'
 require 'volt/page/bindings/if_binding'
-require 'volt/page/bindings/template_binding'
+require 'volt/page/bindings/view_binding'
 require 'volt/page/bindings/yield_binding'
 require 'volt/page/bindings/component_binding'
 require 'volt/page/bindings/event_binding'

data/lib/volt/server/html_parser/view_scope.rb

@@ -38,7 +38,10 @@ module Volt
             else
               fail "else does not take a conditional, #{content} was provided."
             end
+          when 'view'
+            add_template(args)
           when 'template'
+            Volt.logger.warn('Deprecation warning: The template binding has been renamed to view.  Please update any views accordingly.')
             add_template(args)
           when 'yield'
             add_yield(args)
@@ -91,7 +94,7 @@ module Volt
       content = content.strip.gsub(/^\(/, '').gsub(/\)$/, '')
 
       @handler.html << "<!-- $#{@binding_number} --><!-- $/#{@binding_number} -->"
-      save_binding(@binding_number, "lambda { |__p, __t, __c, __id| Volt::TemplateBinding.new(__p, __t, __c, __id, #{@path.inspect}, Proc.new { [#{content}] }) }")
+      save_binding(@binding_number, "lambda { |__p, __t, __c, __id| Volt::ViewBinding.new(__p, __t, __c, __id, #{@path.inspect}, Proc.new { [#{content}] }) }")
 
       @binding_number += 1
     end

data/lib/volt/server/rack/component_paths.rb

@@ -62,7 +62,7 @@ module Volt
           $LOAD_PATH.unshift(app_folder)
 
           # Sort so we get consistent load order across platforms
-          Dir["#{app_folder}/*/{controllers,models,tasks}/*.rb"].each do |ruby_file|
+          Dir["#{app_folder}/*/{lib,controllers,models,tasks}/*.rb"].each do |ruby_file|
             path = ruby_file.gsub(/^#{app_folder}\//, '')[0..-4]
             require(path)
           end

data/lib/volt/spec/setup.rb

@@ -12,11 +12,19 @@ module Volt
       Volt.boot(app_path)
 
       unless RUBY_PLATFORM == 'opal'
-        require 'volt/spec/capybara'
+        begin
+          require 'volt/spec/capybara'
 
-        setup_capybara(app_path)
+          setup_capybara(app_path)
+        rescue LoadError => e
+          Volt.logger.warn("unable to load capybara, if you wish to use it for tests, be sure it is in the app's Gemfile")
+        end
       end
 
+      unless ENV['BROWSER']
+        # Not running integration tests with ENV['BROWSER']
+        RSpec.configuration.filter_run_excluding :type => :feature
+      end
 
       # Setup the spec collection accessors
       # RSpec.shared_context "volt collections", {} do

data/lib/volt/tasks/dispatcher.rb

@@ -1,4 +1,5 @@
 # require 'ruby-prof'
+require 'volt/utils/logging/task_logger'
 
 module Volt
   # The task dispatcher is responsible for taking incoming messages
@@ -47,14 +48,20 @@ module Volt
         # Unsafe method
         promise.reject(RuntimeError.new("unsafe method: #{method_name}"))
       end
+
+      # Called after task runs or fails
+      finish = proc do |error|
+        run_time = ((Time.now.to_f - start_time) * 1000).round(3)
+        Volt.logger.log_dispatch(class_name, method_name, run_time, args, error)
+      end
+
         # Run the promise and pass the return value/error back to the client
       promise.then do |result|
         channel.send_message('response', callback_id, result, nil)
 
-        run_time = ((Time.now.to_f - start_time) * 1000).round(3)
-        Volt.logger.log_dispatch(class_name, method_name, run_time, args)
+        finish.call
       end.fail do |error|
-        Volt.logger.error(error)
+        finish.call(error)
         channel.send_message('response', callback_id, nil, error)
       end
     end

data/lib/volt/utils/logging/task_argument_filterer.rb

@@ -0,0 +1,42 @@
+# TaskArgumentFilterer will recursively walk any arguemnts to a task and filter any
+# hashes with a filtered key.  By default only :password is filtered, but you can add
+# more with Volt.config.filter_keys
+class TaskArgumentFilterer
+  def self.filter(args)
+    self.new(args).run
+  end
+
+  def initialize(args)
+    # # Cache the filter args
+    @@filter_args ||= begin
+      # Load, with default, convert to symbols
+      arg_names = (Volt.config.filter_keys || [:password]).map(&:to_sym)
+    end
+
+    @args = args
+  end
+
+  def run
+    filter_args(@args)
+  end
+
+  private
+
+  def filter_args(args)
+    if args.is_a?(Array)
+      args.map {|v| filter_args(v) }
+    elsif args.is_a?(Hash)
+      args.map do |k,v|
+        if @@filter_args.include?(k.to_sym)
+          # filter
+          [k, '[FILTERED]']
+        else
+          # retunr unfiltered
+          [k, filter_args(v)]
+        end
+      end.to_h # <= convert back to hash
+    else
+      return args
+    end
+  end
+end

data/lib/volt/utils/logging/task_logger.rb

@@ -0,0 +1,14 @@
+require 'volt/utils/logging/task_argument_filterer'
+
+module Volt
+  class TaskLogger
+    def self.task_dispatch_message(logger, args)
+      msg = "task #{logger.class_name}##{logger.method_name} in #{logger.run_time}\n"
+      if args.size > 0
+        arg_str = TaskArgumentFilterer.filter(args).map {|v| v.inspect }.join(', ')
+        msg += "with args: #{arg_str}\n"
+      end
+      msg
+    end
+  end
+end