lockbox_middleware 1.2.0 → 1.2.1

data/vendor/plugins/active_scaffold/lib/active_scaffold/attribute_params.rb

@@ -0,0 +1,192 @@
+module ActiveScaffold
+  # Provides support for param hashes assumed to be model attributes.
+  # Support is primarily needed for creating/editing associated records using a nested hash structure.
+  #
+  # Paradigm Params Hash (should write unit tests on this):
+  #   params[:record] = {
+  #     # a simple record attribute
+  #     'name' => 'John',
+  #     # a plural association hash
+  #     'roles' => {
+  #       # associate with an existing role
+  #       '5' => {'id' => 5}
+  #       # associate with an existing role and edit it
+  #       '6' => {'id' => 6, 'name' => 'designer'}
+  #       # create and associate a new role
+  #       '124521' => {'name' => 'marketer'}
+  #     }
+  #     # a singular association hash
+  #     'location' => {'id' => 12, 'city' => 'New York'}
+  #   }
+  #
+  # Simpler association structures are also supported, like:
+  #   params[:record] = {
+  #     # a simple record attribute
+  #     'name' => 'John',
+  #     # a plural association ... all ids refer to existing records
+  #     'roles' => ['5', '6'],
+  #     # a singular association ... all ids refer to existing records
+  #     'location' => '12'
+  # }
+  module AttributeParams
+    # Takes attributes (as from params[:record]) and applies them to the parent_record. Also looks for
+    # association attributes and attempts to instantiate them as associated objects.
+    #
+    # This is a secure way to apply params to a record, because it's based on a loop over the columns
+    # set. The columns set will not yield unauthorized columns, and it will not yield unregistered columns.
+    def update_record_from_params(parent_record, columns, attributes)
+      action = parent_record.new_record? ? :create : :update
+      return parent_record unless parent_record.authorized_for?(:action => action)
+
+      multi_parameter_attributes = {}
+      attributes.each do |k, v|
+        next unless k.include? '('
+        column_name = k.split('(').first.to_sym
+        multi_parameter_attributes[column_name] ||= []
+        multi_parameter_attributes[column_name] << [k, v]
+      end
+
+      columns.each :for => parent_record, :action => action, :flatten => true do |column|
+        if multi_parameter_attributes.has_key? column.name
+          parent_record.send(:assign_multiparameter_attributes, multi_parameter_attributes[column.name])
+        elsif attributes.has_key? column.name
+          value = attributes[column.name]
+
+          # convert the value, possibly by instantiating associated objects
+          value = if value.is_a?(Hash)
+            # this is just for backwards compatibility. we should clean this up in 2.0.
+            if column.form_ui == :select
+              ids = if column.singular_association?
+                value[:id]
+              else
+                value.values.collect {|hash| hash[:id]}
+              end
+              (ids and not ids.empty?) ? column.association.klass.find(ids) : nil
+
+            elsif column.singular_association?
+              hash = value
+              record = find_or_create_for_params(hash, column, parent_record)
+              if record
+                record_columns = active_scaffold_config_for(column.association.klass).subform.columns
+                update_record_from_params(record, record_columns, hash)
+                record.unsaved = true
+              end
+              record
+
+            elsif column.plural_association?
+              collection = value.collect do |key_value_pair|
+                hash = key_value_pair[1]
+                record = find_or_create_for_params(hash, column, parent_record)
+                if record
+                  record_columns = active_scaffold_config_for(column.association.klass).subform.columns
+                  update_record_from_params(record, record_columns, hash)
+                  record.unsaved = true
+                end
+                record
+              end
+              collection.compact
+            end
+          else
+            if column.singular_association?
+              # it's a single id
+              column.association.klass.find(value) if value and not value.empty?
+            elsif column.plural_association?
+              # it's an array of ids
+              column.association.klass.find(value) if value and not value.empty?
+            else
+              # convert empty strings into nil. this works better with 'null => true' columns (and validations),
+              # and 'null => false' columns should just convert back to an empty string.
+              # ... but we can at least check the ConnectionAdapter::Column object to see if nulls are allowed
+              value = nil if value.is_a? String and value.empty? and !column.column.nil? and column.column.null
+              value
+            end
+          end
+
+          # we avoid assigning a value that already exists because otherwise has_one associations will break (AR bug in has_one_association.rb#replace)
+          parent_record.send("#{column.name}=", value) unless column.through_association? or parent_record.send(column.name) == value
+          
+          # Set any passthrough parameters that may be associated with this column (ie, file column "keep" and "temp" attributes)
+          unless column.params.empty?
+            column.params.each{|p| parent_record.send("#{p}=", attributes[p])}
+          end
+
+        # plural associations may not actually appear in the params if all of the options have been unselected or cleared away.
+        # NOTE: the "form_ui" check isn't really necessary, except that without it we have problems
+        # with subforms. the UI cuts out deep associations, which means they're not present in the
+        # params even though they're in the columns list. the result is that associations were being
+        # emptied out way too often. BUT ... this means there's still a lingering bug in the default association
+        # form code: you can't delete the last association in the list.
+        elsif column.form_ui and column.plural_association? and not column.through_association?
+          parent_record.send("#{column.name}=", [])
+        end
+      end
+
+      if parent_record.new_record?
+        parent_record.class.reflect_on_all_associations.each do |a|
+          next unless [:has_one, :has_many].include?(a.macro) and not a.options[:through]
+          next unless association_proxy = parent_record.send(a.name)
+
+          raise ActiveScaffold::ReverseAssociationRequired, "In order to support :has_one and :has_many where the parent record is new and the child record(s) validate the presence of the parent, ActiveScaffold requires the reverse association (the belongs_to)." unless a.reverse
+
+          association_proxy = [association_proxy] if a.macro == :has_one
+          association_proxy.each { |record| record.send("#{a.reverse}=", parent_record) }
+        end
+      end
+
+      parent_record
+    end
+
+    # Attempts to create or find an instance of klass (which must be an ActiveRecord object) from the
+    # request parameters given. If params[:id] exists it will attempt to find an existing object
+    # otherwise it will build a new one.
+    def find_or_create_for_params(params, parent_column, parent_record)
+      current = parent_record.send(parent_column.name)
+      klass = parent_column.association.klass
+      return nil if parent_column.show_blank_record and attributes_hash_is_empty?(params, klass)
+
+      if params.has_key? :id
+        # modifying the current object of a singular association
+        if current and current.is_a? ActiveRecord::Base and current.id.to_s == params[:id]
+          return current
+        # modifying one of the current objects in a plural association
+        elsif current and current.respond_to?(:any?) and current.any? {|o| o.id.to_s == params[:id]}
+          return current.detect {|o| o.id.to_s == params[:id]}
+        # attaching an existing but not-current object
+        else
+          return klass.find(params[:id])
+        end
+      else
+        if klass.authorized_for?(:action => :create)
+          if parent_column.singular_association?
+            return parent_record.send("build_#{parent_column.name}")
+          else
+            return parent_record.send(parent_column.name).build
+          end
+        end
+      end
+    end
+
+    # Determines whether the given attributes hash is "empty".
+    # This isn't a literal emptiness - it's an attempt to discern whether the user intended it to be empty or not.
+    def attributes_hash_is_empty?(hash, klass)
+      hash.all? do |key,value|
+        # convert any possible multi-parameter attributes like 'created_at(5i)' to simply 'created_at'
+        column_name = key.to_s.split('(').first
+        column = klass.columns_hash[column_name]
+
+        # booleans and datetimes will always have a value. so we ignore them when checking whether the hash is empty.
+        # this could be a bad idea. but the current situation (excess record entry) seems worse.
+        next true if column and [:boolean, :datetime, :date, :time].include?(column.type)
+
+        # defaults are pre-filled on the form. we can't use them to determine if the user intends a new row.
+        next true if column and value == column.default.to_s
+
+        if value.is_a?(Hash)
+          attributes_hash_is_empty?(value, klass)
+        else
+          value.respond_to?(:empty?) ? value.empty? : false
+        end
+      end
+    end
+  end
+end

data/vendor/plugins/active_scaffold/lib/active_scaffold/config/base.rb

@@ -0,0 +1,45 @@
+module ActiveScaffold::Config
+  class Base
+    include ActiveScaffold::Configurable
+    extend ActiveScaffold::Configurable
+
+    def self.inherited(subclass)
+      class << subclass
+        # the crud type of the action. possible values are :create, :read, :update, :destroy, and nil.
+        # this is not a setting for the developer. it's self-description for the actions.
+        def crud_type; @crud_type; end
+
+        protected
+
+        def crud_type=(val)
+          raise ArgumentError, "unknown CRUD type #{val}" unless [:create, :read, :update, :destroy].include?(val.to_sym)
+          @crud_type = val.to_sym
+        end
+      end
+    end
+    # delegate
+    def crud_type; self.class.crud_type end
+
+    # the user property gets set to the instantiation of the local UserSettings class during the automatic instantiation of this class.
+    attr_accessor :user
+
+    class UserSettings
+      def initialize(conf, storage, params)
+        # the session hash relevant to this action
+        @session = storage
+        # all the request params
+        @params = params
+        # the configuration object for this action
+        @conf = conf
+      end
+    end
+    
+    def formats
+      @formats ||= []
+    end
+    
+    def formats=(val)
+      @formats=val
+    end
+  end
+end

data/vendor/plugins/active_scaffold/lib/active_scaffold/config/core.rb

@@ -0,0 +1,230 @@
+require 'active_scaffold/config/base'
+module ActiveScaffold::Config
+  class Core < Base
+    # global level configuration
+    # --------------------------
+
+    # provides read/write access to the global Actions DataStructure
+    cattr_reader :actions
+    def self.actions=(val)
+      @@actions = ActiveScaffold::DataStructures::Actions.new(*val)
+    end
+    self.actions = [:create, :list, :search, :update, :delete, :show, :nested, :subform]
+
+    # configures where the ActiveScaffold plugin itself is located. there is no instance version of this.
+    cattr_accessor :plugin_directory
+    @@plugin_directory = File.expand_path(__FILE__).match(/vendor\/plugins\/([^\/]*)/)[1]
+
+    # lets you specify a global ActiveScaffold frontend.
+    cattr_accessor :frontend
+    @@frontend = :default
+
+    # lets you specify a global ActiveScaffold theme for your frontend.
+    cattr_accessor :theme
+    @@theme = :default
+
+    # lets you disable the DHTML history
+    def self.dhtml_history=(val)
+      @@dhtml_history = val
+    end
+    def self.dhtml_history?
+      @@dhtml_history ? true : false
+    end
+    @@dhtml_history = true
+
+    # action links are used by actions to tie together. you can use them, too! this is a collection of ActiveScaffold::DataStructures::ActionLink objects.
+    cattr_reader :action_links
+    @@action_links = ActiveScaffold::DataStructures::ActionLinks.new
+
+    # access to the permissions configuration.
+    # configuration options include:
+    #  * current_user_method - what method on the controller returns the current user. default: :current_user
+    #  * default_permission - what the default permission is. default: true
+    def self.security
+      ActiveRecordPermissions
+    end
+
+    # columns that should be ignored for every model. these should be metadata columns like change dates, versions, etc.
+    # values in this array may be symbols or strings.
+    def self.ignore_columns
+      @@ignore_columns
+    end
+    def self.ignore_columns=(val)
+      @@ignore_columns = ActiveScaffold::DataStructures::Set.new(*val)
+    end
+    @@ignore_columns = ActiveScaffold::DataStructures::Set.new
+
+    # lets you specify whether add a create link for each sti child
+    cattr_accessor :sti_create_links
+
+    # instance-level configuration
+    # ----------------------------
+
+    # provides read/write access to the local Actions DataStructure
+    attr_reader :actions
+    def actions=(args)
+      @actions = ActiveScaffold::DataStructures::Actions.new(*args)
+    end
+
+    # provides read/write access to the local Columns DataStructure
+    attr_reader :columns
+    def columns=(val)
+      @columns._inheritable = val.collect {|c| c.to_sym}
+      # Add virtual columns
+      @columns << val.collect {|c| c.to_sym unless @columns[c.to_sym]}.compact
+    end
+
+    # lets you override the global ActiveScaffold frontend for a specific controller
+    attr_accessor :frontend
+
+    # lets you override the global ActiveScaffold theme for a specific controller
+    attr_accessor :theme
+
+    # lets you specify whether add a create link for each sti child for a specific controller
+    attr_accessor :sti_create_links
+    def add_sti_create_links?
+      self.sti_create_links and not self.sti_children.nil?
+    end
+
+    # action links are used by actions to tie together. they appear as links for each record, or general links for the ActiveScaffold.
+    attr_reader :action_links
+
+    # a generally-applicable name for this ActiveScaffold ... will be used for generating page/section headers
+    attr_writer :label
+    def label(options={})
+      as_(@label, options) || model.human_name(options.merge(options[:count].to_i == 1 ? {} : {:default => model.name.pluralize}))
+    end
+
+    # STI children models, use an array of model names
+    attr_accessor :sti_children
+
+    ##
+    ## internal usage only below this point
+    ## ------------------------------------
+
+    def initialize(model_id)
+      # model_id is the only absolutely required configuration value. it is also not publicly accessible.
+      @model_id = model_id.to_s.pluralize.singularize
+
+      # inherit the actions list directly from the global level
+      @actions = self.class.actions.clone
+
+      # create a new default columns datastructure, since it doesn't make sense before now
+      attribute_names = self.model.columns.collect{ |c| c.name.to_sym }.sort_by { |c| c.to_s }
+      association_column_names = self.model.reflect_on_all_associations.collect{ |a| a.name.to_sym }.sort_by { |c| c.to_s }
+      @columns = ActiveScaffold::DataStructures::Columns.new(self.model, attribute_names + association_column_names)
+
+      # and then, let's remove some columns from the inheritable set.
+      @columns.exclude(*self.class.ignore_columns)
+      @columns.exclude(*@columns.find_all { |c| c.column and (c.column.primary or c.column.name =~ /(_id|_count)$/) }.collect {|c| c.name})
+      @columns.exclude(*self.model.reflect_on_all_associations.collect{|a| :"#{a.name}_type" if a.options[:polymorphic]}.compact)
+
+      # inherit the global frontend
+      @frontend = self.class.frontend
+      @theme = self.class.theme
+      @sti_create_links = self.class.sti_create_links
+
+      # inherit from the global set of action links
+      @action_links = self.class.action_links.clone
+    end
+
+    # To be called after your finished configuration
+    def _load_action_columns
+      ActiveScaffold::DataStructures::ActionColumns.class_eval {include ActiveScaffold::DataStructures::ActionColumns::AfterConfiguration}
+
+      # then, register the column objects
+      self.actions.each do |action_name|
+        action = self.send(action_name)
+        next unless action.respond_to? :columns
+        action.columns.set_columns(self.columns)
+      end
+    end
+
+    # To be called after your finished configuration
+    def _configure_sti
+      column = self.model.inheritance_column
+      if sti_create_links
+        self.columns[column].form_ui ||= :hidden
+      else
+        self.columns[column].form_ui ||= :select
+        self.columns[column].options ||= {}
+        self.columns[column].options[:options] = self.sti_children.collect do |model_name|
+          [model_name.to_s.camelize.constantize.human_name, model_name.to_s.camelize]
+        end
+      end
+    end
+
+    # To be called after include action modules
+    def _add_sti_create_links
+      new_action_link = @action_links['new']
+      unless new_action_link.nil?
+        @action_links.delete('new')
+        self.sti_children.each do |child| 
+          new_sti_link = Marshal.load(Marshal.dump(new_action_link)) # deep clone
+          new_sti_link.label = as_(:create_model, :model => child.to_s.camelize.constantize.human_name)
+          new_sti_link.parameters = {model.inheritance_column => child}
+          @action_links.add(new_sti_link)
+        end
+      end
+    end
+
+    # configuration routing.
+    # we want to route calls named like an activated action to that action's global or local Config class.
+    # ---------------------------
+    def method_missing(name, *args)
+      @action_configs ||= {}
+      titled_name = name.to_s.camelcase
+      underscored_name = name.to_s.underscore.to_sym
+      klass = "ActiveScaffold::Config::#{titled_name}".constantize rescue nil
+      if klass
+        if @actions.include? underscored_name
+          return @action_configs[underscored_name] ||= klass.new(self)
+        else
+          raise "#{titled_name} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
+        end
+      end
+      super
+    end
+
+    def self.method_missing(name, *args)
+      klass = "ActiveScaffold::Config::#{name.to_s.titleize}".constantize rescue nil
+      if @@actions.include? name.to_s.underscore and klass
+        return eval("ActiveScaffold::Config::#{name.to_s.titleize}")
+      end
+      super
+    end
+    # some utility methods
+    # --------------------
+
+    def model_id
+      @model_id
+    end
+
+    def model
+      @model ||= @model_id.to_s.camelize.constantize
+    end
+
+    # warning - this won't work as a per-request dynamic attribute in rails 2.0.  You'll need to interact with Controller#generic_view_paths
+    def inherited_view_paths
+      @inherited_view_paths||=[]
+    end
+
+    # must be a class method so the layout doesn't depend on a controller that uses active_scaffold
+    # note that this is unaffected by per-controller frontend configuration.
+    def self.asset_path(filename, frontend = self.frontend)
+      "active_scaffold/#{frontend}/#{filename}"
+    end
+
+    # must be a class method so the layout doesn't depend on a controller that uses active_scaffold
+    # note that this is unaffected by per-controller frontend configuration.
+    def self.javascripts(frontend = self.frontend)
+      javascript_dir = File.join(Rails.public_path, "javascripts", asset_path('', frontend))
+      Dir.entries(javascript_dir).reject { |e| !e.match(/\.js$/) or (!self.dhtml_history? and e.match('dhtml_history')) }
+    end
+
+    def self.available_frontends
+      frontends_dir = File.join(Rails.root, "vendor", "plugins", ActiveScaffold::Config::Core.plugin_directory, "frontends")
+      Dir.entries(frontends_dir).reject { |e| e.match(/^\./) } # Get rid of files that start with .
+    end
+  end
+end