bbcloud 0.6.2 → 0.7

data/lib/bbcloud/vendor/hirb/lib/hirb/dynamic_view.rb

@@ -1,113 +0,0 @@
-module Hirb
-  # This module extends a Helper with the ability to have dynamic views for configured output classes.
-  # After a Helper has extended this module, it can use it within a render() by calling
-  # dynamic_options() to get dynamically generated options for the object it's rendering. See Hirb::Helpers::AutoTable as an example.
-  #
-  # == Dynamic Views
-  # Whereas normal views are generated from helpers with static helper options, dynamic views are generated from helpers and
-  # dynamically generated helper options. Let's look at an example for Rails' ActiveRecord classes:
-  #
-  #   Hirb.add_dynamic_view("ActiveRecord::Base", :helper=>:auto_table) {|obj|
-  #    {:fields=>obj.class.column_names} }
-  #
-  # From this dynamic view definition, _any_ ActiveRecord model class will render a table with the correct fields, since the fields
-  # are extracted from the output object's class at runtime. Note that dynamic view definitions should return a hash of helper options.
-  #
-  # To define multiple dynamic views, create a Views module where each method ending in '\_view' maps to a class/module:
-  #
-  #   module Hirb::Views::ORM
-  #     def data_mapper__resource_view(obj)
-  #       {:fields=>obj.class.properties.map {|e| e.name }}
-  #     end
-  #
-  #     def sequel__model_view(obj)
-  #       {:fields=>obj.class.columns}
-  #     end
-  #   end
-  #
-  #   Hirb.add_dynamic_view Hirb::Views::ORM, :helper=>:auto_table
-  #
-  # In this example, 'data_mapper__resource_view' maps to DataMapper::Resource and 'sequel__model_view' maps to Sequel::Model.
-  # Note that when mapping method names to class names, '__' maps to '::' and '_' signals the next letter to be capitalized.
-  module DynamicView
-    # Add dynamic views to output class(es) for a given helper. If defining one view, the first argument is the output class
-    # and a block defines the dynamic view. If defining multiple views, the first argument should be a Views::* module where
-    # each method in the module ending in _view defines a view for an output class. To map output classes to method names in
-    # a Views module, translate'::' to '__' and a capital letter translates to a '_' and a lowercase letter.
-    # ==== Options:
-    # [*:helper*] Required option. Helper class that view(s) use to format. Hirb::Helpers::AutoTable is the only valid
-    #             helper among default helpers. Can be given in aliased form i.e. :auto_table -> Hirb::Helpers::AutoTable.
-    #
-    # Examples:
-    #    Hirb.add_dynamic_view Hirb::Views::ORM, :helper=>:auto_table
-    #    Hirb.add_dynamic_view("ActiveRecord::Base", :helper=>:auto_table) {|obj| {:fields=>obj.class.column_names} }
-    def self.add(view, options, &block)
-      raise ArgumentError, ":helper option is required" unless options[:helper]
-      helper = Helpers.helper_class options[:helper]
-      unless helper.is_a?(Module) && class << helper; self.ancestors; end.include?(self)
-        raise ArgumentError, ":helper option must be a helper that has extended DynamicView"
-      end
-      mod = block ? generate_single_view_module(view, &block) : view
-      raise ArgumentError, "'#{mod}' must be a module" unless mod.is_a?(Module)
-      helper.add_module mod
-    end
-
-    def self.generate_single_view_module(output_mod, &block) #:nodoc:
-      meth = class_to_method output_mod.to_s
-      view_mod = meth.capitalize
-      Views::Single.send(:remove_const, view_mod) if Views::Single.const_defined?(view_mod)
-      mod = Views::Single.const_set(view_mod, Module.new)
-      mod.send(:define_method, meth, block)
-      mod
-    end
-
-    def self.class_to_method(mod) #:nodoc:
-      mod.gsub(/(?!^)([A-Z])/) {|e| '_'+e }.gsub('::_', '__').downcase + '_view'
-    end
-
-    # Returns a hash of options based on dynamic views defined for the object's ancestry. If no config is found returns nil.
-    def dynamic_options(obj)
-      view_methods.each do |meth|
-        if obj.class.ancestors.map {|e| e.to_s }.include?(method_to_class(meth))
-          begin
-            return send(meth, obj)
-          rescue
-            raise "View failed to generate for '#{method_to_class(meth)}' "+
-              "while in '#{meth}' with error:\n#{$!.message}"
-          end
-        end
-      end
-      nil
-    end
-
-    #:stopdoc:
-    def add_module(mod)
-      new_methods = mod.instance_methods.select {|e| e.to_s =~ /_view$/ }.map {|e| e.to_s}
-      return if new_methods.empty?
-      extend mod
-      view_methods.replace(view_methods + new_methods).uniq!
-      update_config(new_methods)
-    end
-
-    def update_config(meths)
-      output_config = meths.inject({}) {|t,e|
-        t[method_to_class(e)] = {:class=>self, :ancestor=>true}; t
-      }
-      Formatter.dynamic_config.merge! output_config
-    end
-
-    def method_to_class(meth)
-      view_method_classes[meth] ||= Util.camelize meth.sub(/_view$/, '').gsub('__', '/')
-    end
-
-    def view_method_classes
-      @view_method_classes ||= {}
-    end
-    #:startdoc:
-
-    # Stores view methods that a Helper has been given via DynamicView.add
-    def view_methods
-      @view_methods ||= []
-    end
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/formatter.rb

@@ -1,116 +0,0 @@
-module Hirb
-  # A Formatter object formats an output object (using Formatter.format_output) into a string based on the views defined
-  # for its class and/or ancestry.
-  class Formatter
-    class<<self
-      # This config is used by Formatter.format_output to lazily load dynamic views defined with Hirb::DynamicView.
-      # This hash has the same format as Formatter.config.
-      attr_accessor :dynamic_config
-    end
-    self.dynamic_config = {}
-
-    def initialize(additional_config={}) #:nodoc:
-      @klass_config = {}
-      @config = additional_config || {}
-    end
-
-    # A hash of Ruby class strings mapped to view hashes. A view hash must have at least a :method, :output_method
-    # or :class option for a view to be applied to an output. A view hash has the following keys:
-    # [*:method*] Specifies a global (Kernel) method to do the formatting.
-    # [*:class*] Specifies a class to do the formatting, using its render() class method. If a symbol it's converted to a corresponding
-    #            Hirb::Helpers::* class if it exists.
-    # [*:output_method*] Specifies a method or proc to call on output before passing it to a helper. If the output is an array, it's applied
-    #                    to every element in the array.
-    # [*:options*] Options to pass the helper method or class.
-    # [*:ancestor*] Boolean which when true causes subclasses of the output class to inherit its config. This doesn't effect the current
-    #               output class. Defaults to false. This is used by ActiveRecord classes.
-    # 
-    #   Examples:
-    #     {'WWW::Delicious::Element'=>{:class=>'Hirb::Helpers::ObjectTable', :ancestor=>true, :options=>{:max_width=>180}}}
-    #     {'Date'=>{:class=>:auto_table, :ancestor=>true}}
-    #     {'Hash'=>{:method=>:puts}}
-    def config
-      @config
-    end
-
-    # Adds the view for the given class and view hash config. See Formatter.config for valid keys for view hash.
-    def add_view(klass, view_config)
-      @klass_config.delete(klass)
-      @config[klass.to_s] = view_config
-      true
-    end
-
-    # This method looks for an output object's view in Formatter.config and then Formatter.dynamic_config.
-    # If a view is found, a stringified view is returned based on the object. If no view is found, nil is returned. The options this
-    # class takes are a view hash as described in Formatter.config. These options will be merged with any existing helper
-    # config hash an output class has in Formatter.config. Any block given is passed along to a helper class.
-    def format_output(output, options={}, &block)
-      output_class = determine_output_class(output)
-      options = parse_console_options(options) if options.delete(:console)
-      options = Util.recursive_hash_merge(klass_config(output_class), options)
-      _format_output(output, options, &block)
-    end
-
-    #:stopdoc:
-    def _format_output(output, options, &block)
-      output = options[:output_method] ? (output.is_a?(Array) ?
-        output.map {|e| call_output_method(options[:output_method], e) } :
-        call_output_method(options[:output_method], output) ) : output
-      args = [output]
-      args << options[:options] if options[:options] && !options[:options].empty?
-      if options[:method]
-        send(options[:method],*args)
-      elsif options[:class] && (helper_class = Helpers.helper_class(options[:class]))
-        helper_class.render(*args, &block)
-      elsif options[:output_method]
-        output
-      end
-    end
-
-    def parse_console_options(options) #:nodoc:
-      real_options = [:method, :class, :output_method].inject({}) do |h, e|
-        h[e] = options.delete(e) if options[e]; h
-      end
-      real_options.merge! :options=>options
-    end
-
-    def determine_output_class(output)
-      output.respond_to?(:to_a) ? Array(output)[0].class : output.class
-    end
-
-    def call_output_method(output_method, output)
-      output_method.is_a?(Proc) ? output_method.call(output) : output.send(output_method)
-    end
-
-    # Internal view options built from user-defined ones. Options are built by recursively merging options from oldest
-    # ancestors to the most recent ones.
-    def klass_config(output_class)
-      @klass_config[output_class] ||= build_klass_config(output_class)
-    end
-
-    def build_klass_config(output_class)
-      output_ancestors = output_class.ancestors.map {|e| e.to_s}.reverse
-      output_ancestors.pop
-      hash = output_ancestors.inject({}) {|h, klass|
-        add_klass_config_if_true(h, klass) {|c,klass| c[klass] && c[klass][:ancestor] }
-      }
-      add_klass_config_if_true(hash, output_class.to_s) {|c,klass| c[klass] }
-    end
-
-    def add_klass_config_if_true(hash, klass)
-      if yield(@config, klass)
-        Util.recursive_hash_merge hash, @config[klass]
-      elsif yield(self.class.dynamic_config, klass)
-        @config[klass] = self.class.dynamic_config[klass].dup # copy to local
-        Util.recursive_hash_merge hash, self.class.dynamic_config[klass]
-      else
-        hash
-      end
-    end
-
-    def reset_klass_config
-      @klass_config = {}
-    end
-    #:startdoc:
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/helpers/auto_table.rb

@@ -1,24 +0,0 @@
-# This helper wraps around the other table helpers i.e. Hirb::Helpers::Table while
-# providing default helper options via Hirb::DynamicView. Using these default options, this
-# helper supports views for the following modules/classes:
-# ActiveRecord::Base, CouchFoo::Base, CouchPotato::Persistence, CouchRest::ExtendedDocument,
-# DBI::Row, DataMapper::Resource, Friendly::Document, MongoMapper::Document, MongoMapper::EmbeddedDocument,
-# Mongoid::Document, Ripple::Document, Sequel::Model.
-class Hirb::Helpers::AutoTable < Hirb::Helpers::Table
-  extend Hirb::DynamicView
-
-  # Takes same options as Hirb::Helpers::Table.render except as noted below.
-  #
-  # ==== Options:
-  # [:table_class] Explicit table class to use for rendering. Defaults to
-  #                Hirb::Helpers::ObjectTable if output is not an Array or Hash. Otherwise
-  #                defaults to Hirb::Helpers::Table.
-  def self.render(output, options={})
-    output = Array(output)
-    (defaults = dynamic_options(output[0])) && (options = defaults.merge(options))
-    klass = options.delete(:table_class) || (
-      !(output[0].is_a?(Hash) || output[0].is_a?(Array)) ?
-      Hirb::Helpers::ObjectTable : Hirb::Helpers::Table)
-    klass.render(output, options)
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/helpers/object_table.rb

@@ -1,14 +0,0 @@
-class Hirb::Helpers::ObjectTable < Hirb::Helpers::Table
-  # Rows are any ruby objects. Takes same options as Hirb::Helpers::Table.render except as noted below.
-  #
-  # ==== Options:
-  # [:fields] Methods of the object to represent as columns. Defaults to [:to_s].
-  def self.render(rows, options ={})
-    options[:fields] ||= [:to_s]
-    options[:headers] ||= {:to_s=>'value'} if options[:fields] == [:to_s]
-    item_hashes = options[:fields].empty? ? [] : Array(rows).inject([]) {|t,item|
-      t << options[:fields].inject({}) {|h,f| h[f] = item.__send__(f); h}
-    }
-    super(item_hashes, options)
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/helpers/parent_child_tree.rb

@@ -1,24 +0,0 @@
-class Hirb::Helpers::ParentChildTree < Hirb::Helpers::Tree
-  class <<self
-    # Starting with the given node, this builds a tree by recursively calling a children method.
-    # Takes same options as Hirb::Helper::Table.render with some additional ones below.
-    # ==== Options:
-    # [:value_method] Method or proc to call to display as a node's value. If not given, uses :name if node
-    #                 responds to :name or defaults to :object_id.
-    # [:children_method] Method or proc to call to obtain a node's children. Default is :children.
-    def render(root_node, options={})
-      value_method = options[:value_method] || (root_node.respond_to?(:name) ? :name : :object_id)
-      @value_method = value_method.is_a?(Proc) ? value_method : lambda {|n| n.send(value_method) }
-      children_method = options[:children_method] || :children
-      @children_method = children_method.is_a?(Proc) ? children_method : lambda {|n| n.send(children_method)}
-      @nodes = []
-      build_node(root_node, 0)
-      super(@nodes, options)
-    end
-
-    def build_node(node, level) #:nodoc:
-      @nodes << {:value=>@value_method.call(node), :level=>level}
-      @children_method.call(node).each {|e| build_node(e, level + 1)}
-    end
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/helpers/table/filters.rb

@@ -1,10 +0,0 @@
-class Hirb::Helpers::Table
-  # Contains filter methods used by :filters option. To define a custom filter, simply open this module and create a method
-  # that take one argument, the value you will be filtering.
-  module Filters
-    extend self
-    def comma_join(arr) #:nodoc:
-      arr.join(', ')
-    end
-  end
-end

data/lib/bbcloud/vendor/hirb/lib/hirb/helpers/table/resizer.rb

@@ -1,82 +0,0 @@
-class Hirb::Helpers::Table
-  # Resizes a table's fields to the table's max width.
-  class Resizer
-    # Modifies field_lengths to fit within width. Also enforces a table's max_fields.
-    def self.resize!(table)
-      obj = new(table)
-      obj.resize
-      obj.field_lengths
-    end
-
-    #:stopdoc:
-    attr_reader :field_lengths
-    def initialize(table)
-      @table, @width, @field_size = table, table.actual_width, table.fields.size
-      @field_lengths = table.field_lengths
-      @original_field_lengths = @field_lengths.dup
-    end
-
-    def resize
-      adjust_long_fields || default_restrict_field_lengths
-      @table.enforce_field_constraints
-      add_extra_width
-    end
-
-    # Simple algorithm which allows smaller fields to be displayed while
-    # restricting longer fields to an average_long_field
-    def adjust_long_fields
-      while (total_length = sum(@field_lengths.values)) > @width
-        average_field = total_length / @field_size.to_f
-        long_lengths = @field_lengths.values.select {|e| e > average_field }
-        return false if long_lengths.empty?
-
-        # adjusts average long field by ratio with @width
-        average_long_field = sum(long_lengths)/long_lengths.size * @width/total_length
-        @field_lengths.each {|f,length|
-          @field_lengths[f] = average_long_field if length > average_long_field
-        }
-      end
-      true
-    end
-
-    # Produces a field_lengths which meets the @width requirement
-    def default_restrict_field_lengths
-      original_total_length = sum @original_field_lengths.values
-      # set fields by their relative weight to original length
-      new_lengths = @original_field_lengths.inject({}) {|t,(k,v)|
-        t[k] = (v / original_total_length.to_f * @width).to_i; t  }
-
-      # set all fields the same if relative doesn't work
-      unless new_lengths.values.all? {|e| e > MIN_FIELD_LENGTH} && (sum(new_lengths.values) <= @width)
-        new_lengths = @field_lengths.inject({}) {|t,(k,v)| t[k] = @width / @field_size; t }
-      end
-      @field_lengths.each {|k,v| @field_lengths[k] = new_lengths[k] }
-    end
-
-    def add_extra_width
-      added_width = 0
-      extra_width = @width - sum(@field_lengths.values)
-      unmaxed_fields = @field_lengths.keys.select {|f| !remaining_width(f).zero? }
-      # order can affect which one gets the remainder so let's keep it consistent
-      unmaxed_fields = unmaxed_fields.sort_by {|e| e.to_s}
-
-      unmaxed_fields.each_with_index do |f, i|
-        extra_per_field = (extra_width - added_width) / (unmaxed_fields.size - i)
-        add_to_field = remaining_width(f) < extra_per_field ? remaining_width(f) : extra_per_field
-        added_width += add_to_field
-        @field_lengths[f] += add_to_field
-      end
-    end
-
-    def remaining_width(field)
-      (@remaining_width ||= {})[field] ||= begin
-        (@table.max_fields[field] || @original_field_lengths[field]) - @field_lengths[field]
-      end
-    end
-
-    def sum(arr)
-      arr.inject {|t,e| t += e }
-    end
-    #:startdoc:
-  end
-end