view 1.0.0.alpha.2 → 1.0.0.alpha.3

data/README.rdoc

@@ -33,10 +33,10 @@ View will automatically try to choose the proper formatter. You can specify a fo
 
   <%= view @post.created_at, :as => :date %>
 
-You can add a block to specify your own behavior. The parsed value is passed in as a block-variable.
+You can add a block to specify your own behavior. The formatter is passed in as a block-variable.
 
-  <%= view @post.author do |author| %>
-    <%= link_to author, @post.author %>
+  <%= view @post.author do |formatter| %>
+    <%= link_to formatter.to_s, formatter.value %>
   <% end %>
 
 Most formatters pass their options down to the method they use, such as the image formatter:

data/lib/view/formatter.rb

@@ -68,10 +68,7 @@ module View
     # @abstract Subclass and override {#format} to implement your own formatter.
     # @return [String] the formatted value
     def format
-      msg <<-MSG.squeeze(' ')
-        The only thing a formatter needs to do is implement the #format method.
-        If you see this error, you forgot to do that for the #{self.class.type} formatter.
-      MSG
+      msg = "The '#{self.class.type}' formatter needs to implement the #format method."
       raise NotImplementedError.new(msg)
     end
 
@@ -114,13 +111,18 @@ module View
       end
     end
 
-    # This calls the format action. You can override it to do something with
-    # the formatted value. This doesn't (and shouldn't) do any formatting
-    # itself.
+    # The final result of the formatter, with the block captured if given.
     #
-    # @see #format
-    def to_s
-      format
+    # If a template is given, use it to capture the block, for maximum
+    # integration with ActionView.
+    #
+    # @return [String]
+    def format!
+      if block
+        captured_value
+      else
+        to_s
+      end
     end
 
     # @return All options, unfiltered.
@@ -129,6 +131,12 @@ module View
       @options
     end
 
+    # A hook for formatters to override so they can inject code between above
+    # the formatting, without all their inherited classes knowing about it.
+    def to_s
+      format
+    end
+
     private
 
     def self.skip_blank_formatter?
@@ -136,15 +144,7 @@ module View
     end
 
     def self.format(*args, &block)
-      new(*args, &block).send(:format!)
-    end
-
-    def format!
-      if block
-        captured_value
-      else
-        formatted_value
-      end
+      new(*args, &block).send(:formatted_value)
     end
 
     def self.formatters
@@ -158,6 +158,11 @@ module View
       @block    = block
     end
 
+    def formatted_value
+      formatter_not_found unless formatter
+      formatter.new(value, all_options, template, &block).format!
+    end
+
     def template_can_capture?
       template && template.respond_to?(:capture)
     end
@@ -171,16 +176,11 @@ module View
     end
 
     def captured_value_by_template
-      template.capture(*block_arguments, &block)
+      template.capture(self, *block_arguments, &block)
     end
 
     def captured_return_value
-      block.call(*block_arguments)
-    end
-
-    def formatted_value
-      formatter_not_found unless formatter
-      formatter.new(value, all_options, template, &block).to_s
+      block.call(self, *block_arguments)
     end
 
     def formatter
@@ -205,7 +205,7 @@ module View
     end
 
     def block_arguments
-      all_options[:block_arguments] || [ formatted_value ]
+      all_options[:block_arguments] || []
     end
 
     def as

data/lib/view/formatters/array.rb

@@ -3,11 +3,14 @@ module View
   # @abstract Subclass this for html safe lists with formatted each support.
   class Array < Formatter
 
+    # The formatted value will be html safe if all the elements in the array
+    # are safe too.
     def to_s
-      if all_safe?
-        super.html_safe
+      result = super
+      if result.respond_to?(:html_safe) && all_safe?
+        result.html_safe
       else
-        super
+        result
       end
     end
 
@@ -19,11 +22,11 @@ module View
 
     def formatted_values
       @formatted_values ||= value.map do |element|
-        View.format(element, each, template, &block)
+        View.format(element, each_options, template, &block)
       end
     end
 
-    def each
+    def each_options
       all_options[:each] || { :as => View.default_formatter }
     end
 

data/lib/view/formatters/auto.rb

@@ -28,12 +28,12 @@ module View
       auto_formatters.unshift(:formatter => formatter_name, :block => block)
     end
 
-    private
-
     def format
-      format!
+      formatted_value
     end
 
+    private
+
     def self.auto_formatters
       @auto_formatters ||= []
     end
@@ -43,6 +43,10 @@ module View
       as ? as[:formatter] : :guess
     end
 
+    add View.default_list_formatter do
+      value.respond_to?(:each)
+    end
+
     add :datetime do
       value.respond_to?(:strftime)
     end
@@ -51,10 +55,6 @@ module View
       View.file_methods.any? { |method| value.respond_to?(method) }
     end
 
-    add View.default_list_formatter do
-      value.respond_to?(:each)
-    end
-
     add :link do
       all_options.has_key?(:to)
     end

data/lib/view/formatters/currency.rb

@@ -1,8 +1,10 @@
 module View
 
+  # Delegate rendering to the number_to_currency helper from Rails.
+  # @see http://rubydoc.info/docs/rails/3.0.0/ActionView/Helpers/NumberHelper:number_to_currency
   class Currency < Formatter
 
-    self.allowed_options = [ :precision, :unit, :separator, :delimiter, :format ]
+    self.allowed_options = [ :precision, :unit, :separator, :delimiter, :format, :locale ]
 
     def format
       template.number_to_currency(value, options)

data/lib/view/formatters/delimited.rb

@@ -1,8 +1,10 @@
 module View
 
+  # Delegate rendering to the number_with_delimiter helper from Rails.
+  # @see http://rubydoc.info/docs/rails/3.0.0/ActionView/Helpers/NumberHelper:number_with_delimiter
   class Delimited < Formatter
 
-    self.allowed_options = [ :separator, :delimiter ]
+    self.allowed_options = [ :separator, :delimiter, :locale ]
 
     def format
       template.number_with_delimiter(value, options)

data/lib/view/formatters/file_link.rb

@@ -1,5 +1,20 @@
 module View
 
+  # Handy for paperclip attachment objects, this formatter will find out what
+  # the url is and make a link to that.
+  #
+  # Controll the link with the :text or :text_method option.
+  #
+  # @example
+  #
+  #   <%= view @user.avatar %>
+  #   <%= view @user.avatar, :text => "Click for the avatar" %>
+  #   <%= view @user.avatar, :text_method => :original_file_name %>
+  #
+  # By default, all links have the target _blank, so they won't screw up your
+  # site. Turn it off globally by putting:
+  #
+  #   View::FileLink.default_options = {}
   class FileLink < Formatter
 
     self.reserved_options = [ :text, :text_method ]
@@ -17,11 +32,15 @@ module View
     end
 
     def text
-      all_options[:text] || text_via_method || value.to_s
+      all_options[:text] || formatted_text
+    end
+
+    def formatted_text
+      View.format((text_via_method || value), {:as => :guess}, template, &block)
     end
 
     def text_via_method
-      send(text_method) if text_method
+      value.send(text_method) if text_method
     end
 
     def text_method

data/lib/view/railtie.rb

@@ -1,9 +1,9 @@
 module View
 
   class Railtie < ::Rails::Railtie
-    
-    ActiveSupport.on_load(:action_view) do
-      ActiveSupport.on_load(:after_initialize) do
+
+    ActiveSupport.on_load(:after_initialize) do
+      ActiveSupport.on_load(:action_view) do
         include Helper
       end
     end

data/lib/view/version.rb

@@ -1,3 +1,3 @@
 module View
-  VERSION = '1.0.0.alpha.2'
+  VERSION = '1.0.0.alpha.3'
 end

data/lib/view.rb

@@ -61,15 +61,14 @@ module View
   # gem should be done through this method (notwithstanding custom formatters).
   #
   # In every day usage you will access it through the +view+ helper method,
-  # because most formatters require a view to render links or images. Any
-  # helper method should also point to this method.
+  # because most formatters require a view to render links or images.
   #
   # @see View::Helper#view
   #
   # @example Rendering a link
   #   module PostsHelper
   #     def link_to_post
-  #       View.format @post, :as => :link, self
+  #       View.format @post, { :as => :link }, self
   #     end
   #   end
   #
@@ -77,17 +76,15 @@ module View
   # @param [Hash] options Any extra options
   #
   # @option options [Symbol] :as (:auto) The name of the formatter
-  # @option options [Array] :block_arguments (nil) Overrides the arguments passed to
+  # @option options [::Array] :block_arguments ([]) Adds arguments passed to
   #   the block of this method.
   #
   # @param [ActionView::Template] Template the view instance on which to call
   #   helper methods like +link_to+ and +image_tag+.
   #   You need this for many formatters.
   #
-  # @yield [formatted_string] The block will be captured (using the template if
-  #   possible) to alter the formatted string that would otherwise be returned.
-  #   Consider it as a final modifier after the view formatter has done its
-  #   work.
+  # @yield [formatter] The block will be captured (using the template if
+  #   possible) so you can use the formatter in more interesting ways.
   #
   # @return [String] the object formatted to a string
   def self.format(value, options = {}, template = nil, &block)
@@ -95,3 +92,5 @@ module View
   end
 
 end
+
+require 'view/railtie'

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require "rubygems"
 require "bundler/setup"
 Bundler.setup :default
-require 'active_support'
-require 'active_support/core_ext'
+require 'rails'
+require 'action_view'
 require 'rspec'
 require 'view'
 
@@ -17,6 +17,24 @@ module WithTranslation
   end
 end
 
+
+module TemplateHelper
+
+  # make it act like a helper spec
+  def helper
+    @helper ||= Template.new
+  end
+
+  class Template
+
+    include ActionView::Helpers
+    include View::Helper
+
+  end
+
+end
+
 RSpec.configure do |config|
   config.include(WithTranslation)
+  config.include(TemplateHelper)
 end

data/spec/view/formatter_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 describe "View::Formatter" do
 
-  it "doesn't touch strings" do
+  it "works" do
     View.format("bar").should == "bar"
   end
 
   it "parses the block" do
-    View.format("bar") { |val| val.upcase }.should == "BAR"
+    View.format("bar") { |formatter| formatter.to_s.upcase }.should == "BAR"
   end
 
 end

data/spec/view/formatters/currency_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Currency formatter" do
+
+  before do
+    helper.stub(:number_to_currency).and_return("called")
+  end
+
+  it "calls number_to_currency" do
+    helper.view(19.99, :as => :currency).should == "called"
+  end
+
+  it "allowes no other options" do
+    helper.should_receive(:number_to_currency).with(19.99, :unit => "£")
+    helper.view(19.99, :as => :currency, :unit => "£", :foo => "bar")
+  end
+
+end

data/spec/view/formatters/delimited_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "Delimited formatter" do
+
+  before do
+    helper.stub(:number_with_delimiter).and_return("called")
+  end
+
+  it "calls number_with_delimiter" do
+    helper.view(19.99, :as => :delimited).should == "called"
+  end
+
+  it "allowes no other options" do
+    helper.should_receive(:number_with_delimiter).with(19.99, :delimiter => ";")
+    helper.view(19.99, :as => :delimited, :delimiter => ";", :foo => "bar")
+  end
+
+end

data/spec/view/formatters/file_link_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "FileLink formatter" do
+
+  let :object do
+    Struct.new(:to_label, :url) {
+      def file?
+        true
+      end
+      def foo_bar
+        "foo is bar"
+      end
+    }.new("label", "url")
+  end
+
+  it "calls link_to" do
+    helper.should_receive(:link_to).with("label", "url", {:target => "_blank"}).and_return("called")
+    helper.view(object, :as => :file_link).should == "called"
+  end
+
+  it "uses the file_link automatically for paperclip like objects" do
+    helper.should_receive(:link_to).and_return("called")
+    helper.view(object).should == "called"
+  end
+
+  it "uses the :text option for link text" do
+    subject = helper.view(object, :as => :file_link, :text => "foo")
+    subject.should == %|<a href="url" target="_blank">foo</a>|
+  end
+
+  it "uses the :text_method option for link text" do
+    subject = helper.view(object, :as => :file_link, :text_method => :foo_bar)
+    subject.should == %|<a href="url" target="_blank">foo is bar</a>|
+  end
+
+  it "guesses the name of the link" do
+    subject = helper.view(object, :as => :file_link)
+    subject.should == %|<a href="url" target="_blank">label</a>|
+  end
+
+end

metadata

@@ -7,8 +7,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - alpha
-  - 2
-  version: 1.0.0.alpha.2
+  - 3
+  version: 1.0.0.alpha.3
 platform: ruby
 authors: 
 - Iain Hecker
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 +02:00
+date: 2010-10-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,8 +76,11 @@ files:
 - spec/view/formatters/auto_spec.rb
 - spec/view/formatters/blank_spec.rb
 - spec/view/formatters/boolean_spec.rb
+- spec/view/formatters/currency_spec.rb
 - spec/view/formatters/date_spec.rb
 - spec/view/formatters/datetime_spec.rb
+- spec/view/formatters/delimited_spec.rb
+- spec/view/formatters/file_link_spec.rb
 - spec/view/formatters/guess_spec.rb
 - spec/view/formatters/self_spec.rb
 - spec/view/formatters/sentence_spec.rb
@@ -122,8 +125,11 @@ test_files:
 - spec/view/formatters/auto_spec.rb
 - spec/view/formatters/blank_spec.rb
 - spec/view/formatters/boolean_spec.rb
+- spec/view/formatters/currency_spec.rb
 - spec/view/formatters/date_spec.rb
 - spec/view/formatters/datetime_spec.rb
+- spec/view/formatters/delimited_spec.rb
+- spec/view/formatters/file_link_spec.rb
 - spec/view/formatters/guess_spec.rb
 - spec/view/formatters/self_spec.rb
 - spec/view/formatters/sentence_spec.rb