wagn 1.14.6 → 1.14.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10504368aca16ec7391adb5e9777576dec0d7ffe
-  data.tar.gz: 6e82c4b52133d3c8341cb993d321ecbef2dadd01
+  metadata.gz: 3184f07aaf8e3892565b0a4975933d614c541e20
+  data.tar.gz: 2bc8a005bdec8efdf7bbdeb8f993ca83e0274445
 SHA512:
-  metadata.gz: 7fde2052c74abcbb39c23ce8cf8eabfe1a585a5106ab0d478aab32a0ce92699a7041f97e37ff99e476e048731fd30037b8838ee40d7f4651458abd4de1109d6a
-  data.tar.gz: deafe3aeb7de4766adcf4c9e13485db15d973a1666e81b3b6f96fb81619553165b931193b2cfc006bb9f234f9641456987f7e3625d4a89051d280ed2e253761d
+  metadata.gz: aae7e080cf2d3671947ca0e2dc5fcb6ccd2fc2946618aa3285b1cdc6469d1491ae69cc968701a8b45395c442f11f9d01d8a372b13d1952220541e49f08d7a4d1
+  data.tar.gz: 6c5e63fb992a4f4b2b15c691f2c65bc279d92032e257d4962a676d5fd07d0dfbacba8d2c7d5db6980b56d5d14d9ace5448e9ecdc1f4aa6bf8e40a4db9e08b078

data/VERSION

@@ -1 +1 @@
-1.14.6
+1.14.7

data/app/controllers/card_controller.rb

@@ -10,15 +10,17 @@ class CardController < ActionController::Base
   include Card::HtmlFormat::Location
   include Recaptcha::Verify
 
+  before_filter :start_performance_logger  if Wagn.config.performance_logger
+  after_filter  :stop_performance_logger   if Wagn.config.performance_logger
+  after_filter :request_logger            if Wagn.config.request_logger
+  
   before_filter :per_request_setup, :except => [:asset]
   before_filter :load_id, :only => [ :read ]
   before_filter :load_card, :except => [:asset]
   before_filter :refresh_card, :only=> [ :create, :update, :delete, :rollback ]
   
-  if Wagn.config.request_logger
-    require 'csv'
-    after_filter :request_logger 
-  end
+  
+
   
   layout nil
 
@@ -126,27 +128,15 @@ class CardController < ActionController::Base
   end
 
   def request_logger
-    unless env["REQUEST_URI"] =~ %r{^/files?/}
-      log = []
-      log << (Card::Env.ajax? ? "YES" : "NO")
-      log << env["REMOTE_ADDR"]
-      log << Card::Auth.current_id
-      log << card.name
-      log << action_name
-      log << params['view'] || (s = params['success'] and  s['view'])
-      log << env["REQUEST_METHOD"]
-      log << status
-      log << env["REQUEST_URI"]
-      log << DateTime.now.to_s
-      log << env['HTTP_ACCEPT_LANGUAGE'].to_s.scan(/^[a-z]{2}/).first
-      log << env["HTTP_REFERER"]
-      
-      log_dir = (Wagn.paths['request_log'] || Wagn.paths['log']).first
-      log_filename = "#{Date.today}_#{Rails.env}.csv"
-      File.open(File.join(log_dir,log_filename), "a") do |f|
-        f.write CSV.generate_line(log)
-      end
-    end
+    Wagn::Log::Request.write_log_entry self    
+  end
+  
+  def start_performance_logger
+    Wagn::Log::Performance.start :method=>env["REQUEST_METHOD"], :message=>env["PATH_INFO"] 
+  end
+  
+  def stop_performance_logger
+    Wagn::Log::Performance.stop
   end
   
   protected

data/lib/card/format.rb

@@ -8,7 +8,7 @@ class Card
       :layout=>:layout, :new=>:edit, :setup=>:edit, :normal=>:normal, :template=>:template } #should be set in views
     
     cattr_accessor :ajax_call, :registered, :max_depth
-    [ :perms, :denial_views, :error_codes, :view_tags, :aliases ].each do |acc|
+    [ :perms, :denial_views, :closed_views, :error_codes, :view_tags, :aliases ].each do |acc|
       cattr_accessor acc
       self.send "#{acc}=", {}
     end
@@ -34,9 +34,10 @@ class Card
 
       def extract_class_vars view, opts
         return unless opts.present?
-        perms[view]       = opts.delete(:perms)      if opts[:perms]
-        error_codes[view] = opts.delete(:error_code) if opts[:error_code]
-        denial_views[view]= opts.delete(:denial)     if opts[:denial]
+        perms[view]        = opts.delete(:perms)      if opts[:perms]
+        error_codes[view]  = opts.delete(:error_code) if opts[:error_code]
+        denial_views[view] = opts.delete(:denial)     if opts[:denial]
+        closed_views[view] = opts.delete(:closed)     if opts[:closed]
 
         if tags = opts.delete(:tags)
           Array.wrap(tags).each do |tag|
@@ -182,7 +183,7 @@ class Card
         @current_view = view = ok_view canonicalize_view( view ), args       
         args = default_render_args view, args
         with_inclusion_mode view do
-          Wagn.with_logging card.name, :view, view, args do
+          Wagn.with_logging :view, view, :context=>card.name, :details=>args do
             send "_view_#{ view }", args
           end
         end
@@ -295,11 +296,16 @@ class Card
     def ok_view view, args={}
       return view if args.delete :skip_permissions
       approved_view = case
-        when @depth >= @@max_depth      ; :too_deep                    # prevent recursion. @depth tracks subformats
-        when @@perms[view] == :none     ; view                         # view requires no permissions
-        when !card.known? &&
-          !tagged( view, :unknown_ok )  ; view_for_unknown view, args  # handle unknown cards (where view not exempt)
-        else                            ; permitted_view view, args    # run explicit permission checks
+        when @depth >= @@max_depth                      # prevent recursion. @depth tracks subformats
+          :too_deep
+        when @@perms[view] == :none                     # permission skipping specified in view definition
+          view
+        when args.delete(:skip_permissions)             # permission skipping specified in args
+          view
+        when !card.known? && !tagged(view, :unknown_ok) # handle unknown cards (where view not exempt)
+          view_for_unknown view, args  
+        else                                            # run explicit permission checks
+          permitted_view view, args    
         end
 
       args[:denied_view] = view if approved_view != view
@@ -422,17 +428,21 @@ class Card
       opts[:home_view] = [:closed, :edit].member?(view) ? :open : view
       # FIXME: special views should be represented in view definitions
 
-      view = case
-      when @mode == :edit
-        if @@perms[view]==:none || nested_card.structure || nested_card.key.blank? # eg {{_self|type}} on new cards
-          :blank
-        else
-          :edit_in_form
+      view = case @mode
+      when :edit
+        not_ready_for_form = @@perms[view]==:none || nested_card.structure || nested_card.key.blank? # eg {{_self|type}} on new cards
+        not_ready_for_form ? :blank : :edit_in_form
+      when :template
+        :template_rule
+      when :closed
+        case
+        when @@closed_views[view] == true || @@error_codes[view] ; view
+        when specified_view = @@closed_views[view]               ; specified_view
+        when !nested_card.known?                                 ; :closed_missing
+        else                                                     ; :closed_content
         end
-      when @mode == :template   ; :template_rule
-      when @@perms[view]==:none ; view
-      when @mode == :closed     ; !nested_card.known?  ? :closed_missing : :closed_content
-      else                      ; view
+      else
+        view
       end
       sub.render view, opts
       #end

data/lib/card/generators/set/USAGE

@@ -1,9 +1,16 @@
 Description:
     Generates new set files in mods and matching specs.
 
-Example:
+Examples:
     wagn generate set standard type tshirt
 
     This will create:
-        mods/05_standard/sets/type/tshirt.rb
-        spec/mods/05_standard/sets/type/tshirt_spec.rb
+        mods/standard/sets/type/tshirt.rb
+        mods/standard/spec/sets/type/tshirt_spec.rb
+        
+        
+    wagn generate set standard type_plus_right basic about tshirt
+
+    This will create:
+        mods/standard/sets/type_plus_right/basic/about/tshirt.rb
+        mods/standard/spec/sets/type_plus_right/basic/about/tshirt_spec.rb

data/lib/card/generators/set/set_generator.rb

@@ -1,14 +1,22 @@
 class SetGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
   
-  argument :mod#, :required => true, :type => :array, :desc => "The names of the attachment(s) to add.",
-             #:banner => "attachment_one attachment_two attachment_three ..."
-  argument :set_pattern
-  argument :anchor
+  argument :mod, :required => true 
+  argument :set_pattern, :required => true
+  argument :anchors, :required=>true, :type=>:array
+  class_option :core, :type=>:boolean, :desc=>'create set files in Wagn gem'
+
     
   def create_files
-    template 'set_template.erb',           "mod/#{mod}/set/#{set_pattern}/#{anchor}.rb"
-    template 'set_spec_template.erb', "spec/mod/#{mod}/set/#{set_pattern}/#{anchor}_spec.rb"
+    mod_path = if options.core?
+        File.join Wagn.gem_root, 'mod', mod
+      else
+        File.join 'mod', mod
+      end
+    set_path  = File.join(mod_path, 'set', set_pattern, anchors[0..-2], "#{anchors.last}.rb")
+    spec_path = File.join(mod_path, 'spec', 'set', set_pattern, anchors[0..-2], "#{anchors.last}_spec.rb" )
+    template 'set_template.erb', set_path
+    template 'set_spec_template.erb', spec_path
   end
   
 end

data/lib/card/generators/set/templates/set_spec_template.erb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 
-describe Card::Set::<%= set_pattern.camelize %>::<%= anchor.camelize %> do
+describe Card::Set::<%= set_pattern.camelize %>::<%= anchors.map(&:camelize).join('::') %> do
 
 end

data/lib/card/set.rb

@@ -55,7 +55,8 @@ class Card
     is running `wagn generate set modname set_pattern set_anchor`. In the current example, this
     would translate to `wagn generate set mymod right address`. Note that both the set_pattern 
     and the set_anchor must correspond to the codename of a card in the database to function
-    correctly.
+    correctly but you can add arbitrary subdirectories to organize your code rules. The rule above 
+    for example could be saved in mywagn/mod/mymod/set/right/address/america/north/canada.rb.
 
     
     When Wagn loads, it uses these files to autogenerate a tmp_file that uses this set file to
@@ -135,7 +136,7 @@ class Card
 
         define_method event do
           run_callbacks event do
-            Wagn.with_logging self.name, :event, event, opts do
+            Wagn.with_logging :event, event, :context=>self.name, :details=>opts do
               send final_method
             end
           end

data/lib/wagn.rb

@@ -24,22 +24,21 @@ module Wagn
       WAGN_GEM_ROOT
     end
     
-    def with_logging cardname, method, message, details, &block
-      if Wagn.config.performance_logger and 
-         Wagn.config.performance_logger[:methods] and 
-         Wagn.config.performance_logger[:methods].include? method        
-        Wagn::Log.start_block :cardname=>cardname, :method=>method, :message=>message, :details=>details
-        result = block.call
-        Wagn::Log.finish_block
-        result
+    def with_logging method, message, opts, &block
+      if (pl_config=Wagn.config.performance_logger) && pl_config[:methods] && pl_config[:methods].include?(method)
+        Wagn::Log::Performance.with_timer(method, message, opts) do
+          block.call
+        end
       else
         block.call
       end
     end
     
+    
     def future_stamp
       ## used in test data
       @@future_stamp ||= Time.local 2020,1,1,0,0,0
     end
   end
+  
 end

data/lib/wagn/config/environments/development.rb

@@ -33,6 +33,14 @@ Wagn.application.class.configure do
   # See everything in the log (default is :info)
   config.log_level = :debug
   
+  #change log_level to :wagn to activate performance logger
+  # config.performance_logger = {
+  #     :methods => [:event, :search, :fetch, :view],  # choose methods to log
+  #     :min_time => 100,                              # show only method calls that are slower than 100ms
+  #     :max_depth => 3,                               # show nested method calls only up to depth 3
+  #     :details=> true                                # show method arguments and sql
+  # }
+  
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 

data/lib/wagn/generators/wagn/templates/Gemfile

@@ -103,6 +103,7 @@ group :development, :test do
   gem 'jasmine'
   gem 'jasmine-rails', :git=>"https://github.com/chuenlok/jasmine-rails.git"
   gem 'jasmine-jquery-rails'
+  gem 'phantomjs', '1.9.7.1' #locked because 1.9.8.0 is breaking
 end
 
 group :debug do

data/lib/wagn/log.rb

@@ -1,69 +1,238 @@
+require 'csv'
 
-class Wagn::Log  
-  TAB_SIZE = 2
-  @@log = []
-  @@last_toplevel_card = nil
-  
-  class << self
-    
-    # args: 
-    # :method  => :view|:event|:fetch|:search
-    # :cardname, :message, :details
-    def start_block args  
-      level = @@log.last ? @@log.last[:level] + 1 : 1
-      @@log << args.merge( :start => Time.now, :level=>level, :subtree =>[] )
+class Wagn::Log
+
+  class Request
+    def self.path
+      path = (Wagn.paths['request_log'] && Wagn.paths['request_log'].first) || File.dirname(Wagn.paths['log'].first)
+      filename = "#{Date.today}_#{Rails.env}.csv"
+      File.join path, filename
     end
     
-    def finish_block
-      log = @@log.pop
-      duration = (Time.now - log[:start]) * 1000
-      return if limit = Wagn.config.performance_logger[:limit] and limit > 0 and duration < limit
-        
-      log_msg = "#{ indent log[:level] }(%d.2ms) #{ log[:method] }: #{ log[:message] }" % duration
-      log_msg += details log if Wagn.config.performance_logger[:details] 
-      log_msg += subtree log
-      
-      if log_parent = @@log.last
-        if sibling = log_parent[:subtree].last and ( sibling[:card] == log[:cardname] or not log[:cardname] )
-          sibling[:lines] << log_msg
-        else
-          log_parent[:subtree] << {:card=>log[:cardname], :lines=>[log_msg]}
-        end
-      else
-        if log[:cardname] and @@last_toplevel_card != log[:cardname]
-          @@last_toplevel_card = log[:cardname]
-          Rails.logger.wagn log[:cardname]
+    def self.write_log_entry controller
+      return if controller.env["REQUEST_URI"] =~ %r{^/files?/}
+
+      controller.instance_eval do
+        log = []
+        log << (Card::Env.ajax? ? "YES" : "NO")
+        log << env["REMOTE_ADDR"]
+        log << Card::Auth.current_id
+        log << card.name
+        log << action_name
+        log << params['view'] || (s = params['success'] and  s['view'])
+        log << env["REQUEST_METHOD"]
+        log << status
+        log << env["REQUEST_URI"]
+        log << DateTime.now.to_s
+        log << env['HTTP_ACCEPT_LANGUAGE'].to_s.scan(/^[a-z]{2}/).first
+        log << env["HTTP_REFERER"]
+
+        File.open(Wagn::Log::Request.path, "a") do |f|
+          f.write CSV.generate_line(log)
         end
-        Rails.logger.wagn log_msg
       end
     end
-    
-    
-    def indent level, args={}
-       res = (' '*TAB_SIZE + '|') * level
-       res += args[:no_link] ? '  ' : '--'
+
+  end
+  
+
+  class Performance
+    TAB_SIZE = 3
+    @@log = []
+    @@context_entries = []
+    @@active_entries = []
+    @@current_level = 0
+   
+    def self.the_log
+     @@the_log  
     end
-    
-    def details log
-      if log[:details]
-        ", " + log[:details].to_s.gsub( "\n", "\n#{ indent( log[:level]+1, :no_link=>true) }" )  
-      else
-        ''
+    class Entry
+      attr_accessor :level, :valid, :context, :parent, :children_cnt, :duration
+      
+      def initialize( parent, level, args )
+        @start = Time.new
+        @message = "#{ args[:method] }: #{ args[:message] }"
+        @details = args[:details]
+        @context = args[:context]
+        @level = level
+        @duration = nil
+        @valid = true
+        @parent = parent
+        @children_cnt = 0
+        if @parent         
+          @parent.add_children
+          #@sibling_nr = @parent.children_cnt
+        end
       end
+
+      def add_children
+        @children_cnt += 1
+      end
+      
+      def delete_children
+        @children_cnt -= 1
+      end
+      
+      def has_younger_siblings?
+        @parent && @parent.children_cnt > 0 #@sibling_nr
+      end
+      
+      def save_duration
+        @duration = (Time.now - @start) * 1000
+      end
+      
+      def delete
+        @valid = false
+        @parent.delete_children if @parent
+      end
+
+
+      # deletes the children counts in order to print the tree;
+      # must be called in the right order
+      #
+      # More robuts but more expensive approach: use @sibling_nr instead of counting @children_cnt down, 
+      # but @sibling_nr has to be updated for all siblings of an entry if the entry gets deleted due to 
+      # min_time or max_depth restrictions in the config, so we have to save all children relations for that
+      def to_s!
+        @to_s ||= begin 
+          msg = indent
+          msg += if @duration
+              "(%d.2ms) #{@message}" % @duration
+            else
+              @message
+            end
+          if @details
+            msg +=  ", " + @details.to_s.gsub( "\n", "\n#{ indent(false) }#{' '* TAB_SIZE}" )
+          end
+          @parent.delete_children if @parent
+          msg
+        end
+      end
+      
+      private 
+
+      def indent link=true
+        @indent ||= begin
+          if @level == 0
+            "\n"
+          else
+            res = '  '
+            res += (1..level-1).inject('') do |msg, index|
+                if younger_siblings[index]
+                  msg <<  '|' + ' ' * (TAB_SIZE-1) 
+                else
+                  msg << ' ' * TAB_SIZE
+                end
+              end
+            
+            res += link ? '|--' : '  '
+          end
+        end
+      end
+
+      def younger_siblings
+        res = []
+        next_parent = self
+        while (next_parent)
+          res << next_parent.has_younger_siblings?
+          next_parent = next_parent.parent
+        end
+        res.reverse
+      end
+      
     end
-    
-    def subtree log
-      if log[:subtree].present?
-        "\n" + log[:subtree].map do |subentry| 
-            msg = subentry[:card] ? "#{ indent(log[:level]) }#{ subentry[:card] }\n" : ''        
-            msg += subentry[:lines].join("\n")
-          end.join("\n")
-      else
-        ''
+
+
+    class << self
+      def start args={}
+        @@current_level = 0
+        @@log = []
+        @@context_entries = []
+        @@active_entries = []
+        @@first_entry = new_entry(args)
       end
+      
+      def stop
+        while (entry = @@context_entries.pop) do
+          finish_entry entry
+        end
+        if @@first_entry
+          @@first_entry.save_duration
+          finish_entry @@first_entry
+        end
+        print_log
+      end
+      
+      def with_timer method, message, args, &block
+        if args[:context] 
+          
+          # if the previous context was created by an entry on the same level 
+          # the finish the context if it's a different context
+          if @@context_entries.last && @@current_level == @@context_entries.last.level+1 && 
+                                       args[:context] != @@context_entries.last.context
+            finish_entry @@context_entries.pop
+          end
+          
+          # start new context if it's different from the parent context
+          if  @@context_entries.empty? || args[:context] != @@context_entries.last.context
+            @@context_entries << new_entry( :method=>'process', :message=>args[:context], :context=>args[:context] )
+          end
+        end
+
+        timer = new_entry args.merge(:method=>method, :message=>message)
+        begin
+          result = block.call       
+        ensure
+          timer.save_duration
+          finish_entry timer
+
+          # finish all deeper nested contexts
+          while @@context_entries.last && @@context_entries.last.level >= @@current_level
+            finish_entry @@context_entries.pop
+          end
+          # we don't know whether the next entry will belong to the same context or will start a new one 
+          # so we save the time    
+          @@context_entries.last.save_duration if @@context_entries.last         
+        end
+        result
+      end
+
+      private 
+      
+      def print_log
+        @@log.each do |entry|
+          Rails.logger.wagn entry.to_s! if entry.valid
+        end
+      end
+      
+      def new_entry args
+        args.delete(:details) unless Wagn.config.performance_logger[:details]
+        level = @@current_level
+                
+        last_entry = @@active_entries.last
+        parent = if last_entry
+            last_entry.level == level ? last_entry.parent : last_entry
+          end
+        
+        @@log << Wagn::Log::Performance::Entry.new(parent, level, args )
+        @@current_level += 1 
+        @@active_entries << @@log.last
+        
+        @@log.last
+      end
+      
+      def finish_entry entry
+        min_time = Wagn.config.performance_logger[:min_time]
+        max_depth = Wagn.config.performance_logger[:max_depth]
+        if (max_depth && entry.level > max_depth) || (min_time && entry.duration < min_time)
+          entry.delete
+        end
+        @@active_entries.pop
+        @@current_level -= 1
+      end
+      
     end
-    
   end
-  
+
 end