merb_viewfu 0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jacques Crocker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,81 @@
+ViewFu
+======
+
+ViewFu is a Merb plugin that provides all the miscellaneous View tasks. It's a combination of the functionality of BrowserDetect, Headliner, Meta Tags - along with additional tweaks such as providing commonly used View Helpers Methods.
+
+Maintainer Info
+======
+
+Tyler Crocker
+NeoRails.com
+
+Looking for *the one* awesome rails developer to add to your project? I may be available to help out. Contact me at neorails@gmail.com. 
+
+
+ViewFu HTML Helpers
+=======
+ViewFu provides helpers for commonly used html elements
+
+br #=> <br />
+hr #=> <hr />
+anchor("posts") #=> <a name='posts'></a>
+clear #=> <div class="clear"></div>
+clear(:left) #=> <div class="clearleft"></div>
+clear_tag(:br) #=> <br class="clear" />
+lorem #=> Lorem ipsum dolor...
+
+
+ViewFu Helper Queries
+=======
+production? #=> returns true if Rails.env == "production"
+
+
+ViewFu Misc Helpers
+=======
+paging(@array) #=> display a will_paginate paging links (only if the array is a valid paging collection)
+paging(@array, :sabros) #=> wrap the paging links with a class "sabros"
+
+
+Haml Specific Helpers
+=======
+Haml allows you to pash a hash of attributes. ViewFu assists this by providing a simple "hidden" helper that allows you to conditionally hide page elements.
+
+%div{hidden} #=> <div style="display:none">
+%div.posts{hidden_if(@posts.empty?)} #=> hide the .posts div if the array is empty
+%p.empty{hidden_unless(@posts.empty?)} #=> hide the empty posts message if the array has elements
+
+Page Titles
+=======
+ViewFu allows you to easily set the current page title from anywhere on your views
+
+title
+Displays the current page title
+
+title(new_title)
+Sets the page title
+
+See lib/headliner/README for more details
+
+
+Meta Tags
+=======
+ViewFu allows you to set meta tags on your page header from anywhere. Just add a call to meta_tags somewhere in your page header.
+
+meta_tags
+output all the html meta tags currently on the page
+
+meta_keywords
+output the meta keywords tag
+
+meta_keywords(val)
+set the page meta keywords
+
+meta_description
+output the meta description tag
+
+meta_description(val)
+set the page meta description
+
+
+
+Copyright (c) 2008 NeoRails.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_viewfu"
+GEM_VERSION = "0.2"
+AUTHOR = "Jacques Crocker"
+EMAIL = "merbjedi@gmail.com"
+HOMEPAGE = "http://merbjedi.com/"
+SUMMARY = "View Helpers for Title, Meta tags, Browser Detect, and Common Tag Helpers"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/browser_detect/helper.rb

@@ -0,0 +1,47 @@
+module BrowserDetect
+  module Helper
+  
+    # check the current browser (via user agent) for the following:
+    # :mozilla / :firefox
+    # :ie6
+    # :ie7
+    # :ie
+    # :iphone
+    # :safari
+    def browser_is? name
+      name = name.to_s.strip
+
+      return true if browser_name == name
+      return true if (name == 'mozilla' or name == "firefox") && browser_name == 'gecko'
+      return true if name == 'ie6' && browser_name.index('ie6')
+      return true if name == 'ie7' && browser_name.index('ie7')
+      return true if name == 'ie' && browser_name.index('ie')
+      return true if name == 'iphone' && browser_name == 'iphone'
+      return true if name == 'webkit' && browser_name == 'safari'
+    end
+  
+    # find the current browser name
+    def browser_name
+      @browser_name ||= begin
+        ua = request.user_agent.to_s.downcase
+        if ua.index('msie') && !ua.index('opera') && !ua.index('webtv')
+          'ie'+ua[ua.index('msie')+5].chr
+        elsif ua.index('gecko/') 
+          'gecko'
+        elsif ua.index('opera')
+          'opera'
+        elsif ua.index('konqueror') 
+          'konqueror'
+        elsif ua.index('iphone')
+          'iphone'
+        elsif ua.index('applewebkit/')
+          'safari'
+        elsif ua.index('mozilla/')
+          'gecko'
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/headliner/README

@@ -0,0 +1,118 @@
+=========
+Headliner
+=========
+
+Headliner DRYs up your page titles.
+
+
+Background
+==========
+
+Normally, if your Rails application has lots of actions and a shared
+layout, you might find yourself setting custom page title names in your
+controllers.
+
+Here's an example:
+
+class PagesController < ApplicationController
+  def about
+    @title = "About us"
+  end
+end
+
+Then, in your main layout, you might have something like this:
+
+<head>
+<title>My website<% if @title %>: <%= @title %><% end %></title>
+</head
+
+This works okay... but page titles don't really belong in controllers, do
+they?
+
+So, by moving these titles into your views, we can DRY things up a bit and
+reinforce the MVC design pattern that's so fundamental to Ruby on Rails.
+
+
+Usage
+=====
+
+First, add this code to your main layout:
+
+<head>
+<%= title :site => "My website" %>
+</head>
+
+Then, to set the page title, add this to each of your views:
+
+<h1><%= title "My page title" %></h1>
+
+When views are rendered, the page title will be included in the right
+spots:
+
+<head>
+<title>My website | My page title</title>
+</head>
+<body>
+<h1>My page title</h1>
+</body>
+
+
+Options
+=======
+
+Use these options to customize the title format:
+
+:prefix (text between site name and separator)
+:separator (text used to separate website name from page title)
+:suffix (text between separator and page title)
+:lowercase (when true, the page name will be lowercase)
+:reverse (when true, the page and site names will be reversed)
+
+And here are a few examples to give you ideas.
+
+<%= title :separator => "&mdash;" %>
+<%= title :prefix => false, :separator => ":" %>
+<%= title :lowercase => true %>
+<%= title :reverse => true, :prefix => false %>
+
+
+Dealing with special pages
+==========================
+
+How do you set the page title without showing it in the view?
+
+<% title "My page title" %>
+
+What if your view headline is different from your page title?
+
+<%= title "My page title", "My headline" %>
+
+
+Mr. T says, ‘Use my method, fool!’
+==================================
+
+Just like ERB's HTML safe method, you can invoke Headliner with a single
+letter alias.
+
+<h1><%=t "My page title" %></h1>
+
+
+How does it work?
+=================
+
+Ruby on Rails renders actions *before* inserting them into layouts. So, if 
+you set a variable in your view, it will be accessible in your layout. But, 
+at first glance, it looks like you're using a variable (in the head)
+before it's been assigned a value (in the body). Cool, huh?
+
+
+Credits
+=======
+
+Special thanks to Nick Zadrozny and Jordan Fowler for their input.
+
+
+Feedback
+========
+
+Comments, bug reports, and svn diffs welcome at http://the.railsi.st.

data/lib/headliner/helper.rb

@@ -0,0 +1,65 @@
+module Headliner
+  module Helper
+    def title(options, headline='')
+      if options.is_a? String
+        save_title(options, headline)
+      else
+        display_title(options)
+      end
+    end
+
+    def save_title(title, headline)
+      @title = title.gsub(/<\/?[^>]*>/, '')
+      headline.blank? ? title : headline
+    end
+
+    def display_title(options)
+      # Prefix (leading space)
+      if options[:prefix]
+        prefix = options[:prefix]
+      elsif options[:prefix] == false
+        prefix = ''
+      else
+        prefix = ' '
+      end
+
+      # Separator
+      unless options[:separator].blank?
+        separator = options[:separator]
+      else
+        separator = '|'
+      end
+
+      # Suffix (trailing space)
+      if options[:suffix]
+        suffix = options[:suffix]
+      elsif options[:suffix] == false
+        suffix = ''
+      else
+        suffix = ' '
+      end
+
+      # Lowercase title?
+      if options[:lowercase] == true
+        @title = @title.downcase unless @title.blank?
+      end
+
+      # Set website/page order
+      unless @title.blank?
+        if options[:reverse] == true
+          # Reverse order => "Page : Website"
+          return tag(:title, @title + prefix + separator + suffix + options[:site])
+        else
+          # Standard order => "Website : Page"
+          return tag(:title, options[:site] + prefix + separator + suffix + @title)
+        end
+      end
+  
+      # If title is blank, return only website name
+      tag :title, options[:site]
+    end
+
+    # Mr. T says, "Use my method, fool!"
+    alias t title
+  end
+end

data/lib/merb_viewfu.rb

@@ -0,0 +1,19 @@
+require "view_fu/tag_helper"
+require "view_fu/meta_helper"
+
+require "browser_detect/helper"
+require "headliner/helper"
+
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:viewfu] = {}
+  
+  Merb::BootLoader.before_app_loads do
+    Merb::Controller.send(:include, ViewFu::MetaHelper)
+    Merb::Controller.send(:include, ViewFu::TagHelper)
+    Merb::Controller.send(:include, Headliner::Helper)
+    Merb::Controller.send(:include, BrowserDetect::Helper)
+  end
+end

data/lib/view_fu/meta_helper.rb

@@ -0,0 +1,51 @@
+module ViewFu
+  module MetaHelper
+    # Output the current page's meta tags
+    def meta_tags
+      %(
+        <meta name="keywords" content="#{meta_keywords}" />
+        <meta name="description" content="#{meta_description}" />
+      )
+    end
+
+    # Get/Set Meta Keywords
+    def meta_keywords(meta_keywords = nil)
+      if meta_keywords
+        @__meta_keywords = meta_keywords
+      else
+        @__meta_keywords ||= ""
+      
+        # Check if we have AppConfig to use for default
+        if defined? AppConfig
+          default_meta_keywords = AppConfig.default_meta_keywords
+        else
+          default_meta_keywords = ""
+        end
+      
+        # set the default if meta_keywords is blank
+        @__meta_keywords = default_meta_keywords if @__meta_keywords.blank?
+      end
+      return @__meta_keywords
+    end
+
+    # Get/Set Meta Description
+    def meta_description(meta_description = nil)
+      if meta_description
+        @__meta_description = meta_description
+      else
+        @__meta_description ||= ""
+      
+        # Check if we have AppConfig to use for default
+        if defined? AppConfig
+          default_meta_description = AppConfig.default_meta_description 
+        else
+          default_meta_description = ""
+        end
+      
+        # set the default if meta_description is blank
+        @__meta_description = default_meta_description if @__meta_description.blank?
+      end
+      return @__meta_description
+    end
+  end
+end

data/lib/view_fu/tag_helper.rb

@@ -0,0 +1,167 @@
+module ViewFu
+  module TagHelper
+
+    # Writes a br tag
+    def br
+      "<br />"
+    end
+
+    # Writes an hr tag
+    def hr
+      "<hr />"
+    end
+    
+    # Writes a nonbreaking space
+    def nbsp
+      "&nbsp;"
+    end
+    
+    # ported from rails
+    def auto_discovery_link_tag(type = :rss, url = nil, tag_options = {})
+      
+      # theres gotta be a better way of setting mimetype for a file extensionin Merb..
+      unless tag_options[:type]
+        if type.to_s == "rss"
+          tag_options[:type] = "application/rss+xml"
+        elsif type.to_s == "atom"
+          tag_options[:type] = "application/atom+xml"
+        end
+      end
+
+      tag(:link, :rel => (tag_options[:rel] || "alternate"),
+                  :type  => tag_options[:type].to_s,
+                  :title => (tag_options[:title] || type.to_s.upcase),
+                  :href  => (url || "#"))
+    end
+    
+    # Writes an hr space tag
+    def space
+      "<hr class='space' />"
+    end
+    
+    # Writes an anchor tag
+    def anchor(anchor_name, options = {})
+      tag(:a, options.merge(:name => anchor_name)) do
+        ""
+      end
+    end
+    
+    # Writes a clear tag
+    def clear_tag(tag, direction = nil)
+      if tag == :br
+        "<br class=\"clear#{direction}\" />"
+      else
+        "<#{tag} class=\"clear#{direction}\"></#{tag}>"
+      end
+    end
+  
+    def current_year
+      Time.now.strftime("%Y")
+    end
+
+    # Writes a clear div tag
+    def clear(direction = nil)
+      clear_tag(:div, direction)
+    end
+  
+    # Return some lorem text
+    def lorem
+      "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
+    end
+  
+    # Return a hidden attribute hash (useful in Haml tags - %div{hidden})
+    def hidden
+      {:style => "display:none"}
+    end
+    
+    # Easily link to an image
+    def link_to_image(image_path, label, url, options={})
+      # setup vertical alignment
+      vert_align = options.delete(:vert)
+      if vert_align.nil?
+        vert_style = "vertical-align: middle"
+      elsif vert_align.blank?
+        vert_style = ""
+      else
+        vert_style = "vertical-align: #{vert_align.to_i}px"
+      end
+
+      link_to(image_tag(image_path, :class => "vert-middle", :style => "#{vert_style}"), url, options)+"&nbsp;"+
+      link_to(label, url, options)
+    end
+    
+    def add_class_if(css_class, condition)
+      if condition
+        {:class => css_class}
+      else
+        {}
+      end
+    end
+
+    def add_class_unless(css_class, condition)
+      add_class_if(css_class, !condition)
+    end
+  
+    # Return a hidden attribute hash if a condition evaluates to true
+    def hide_if(condition)
+      if condition
+        hidden
+      else
+        {}
+      end
+    end
+    alias :hidden_if :hide_if
+    alias :show_unless :hide_if
+  
+    # Return a hidden attribute hash if a condition evaluates to false
+    def hide_unless(condition)
+      if !condition
+        hidden
+      else
+        {}
+      end
+    end
+    alias :hidden_unless :hide_unless
+    alias :show_if :hide_unless 
+  
+    # Wrap a delete link
+    def delete_link(*args)
+      options = {:method => :delete, :confirm => "Are you sure you want to delete this?"}.merge(extract_options_from_args!(args)||{})
+      args << options
+      link_to(*args)
+    end
+  
+    # Wrap a block with a link
+    def link_to_block(*args, &block)
+      content = capture(&block)
+      return link_to(content, *args)
+    end
+  
+    # Check if we're on production environment
+    def production?
+      Merb.env == "production"
+    end
+  
+    # Display will_paginate paging links
+    def paging(page_data, style = :sabros)
+      return unless page_data.is_a? WillPaginate::Collection
+      will_paginate(page_data, :class => "pagination #{style}", :inner_window => 3)
+    end
+
+    # clearbit icons
+    def clearbit_icon(icon, color, options = {})
+      image_tag "clearbits/#{icon}.gif", {:class => "clearbits #{color}", :alt => icon}.merge(options)
+    end
+
+    # pixel spacing helper
+    def pixel(options = {})
+      image_tag "pixel.png", options
+    end
+    
+    # check to see if an index is the first item in a collection
+    def is_first(i)
+      i.to_i.zero? ? {:class => "first"} : {}
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/viewfu_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "viewfu" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: merb_viewfu
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: View Helpers for Title, Meta tags, Browser Detect, and Common Tag Helpers
+email: merbjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/browser_detect
+- lib/browser_detect/helper.rb
+- lib/headliner
+- lib/headliner/helper.rb
+- lib/headliner/README
+- lib/merb_viewfu.rb
+- lib/view_fu
+- lib/view_fu/meta_helper.rb
+- lib/view_fu/tag_helper.rb
+- spec/spec_helper.rb
+- spec/viewfu_spec.rb
+has_rdoc: true
+homepage: http://merbjedi.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: View Helpers for Title, Meta tags, Browser Detect, and Common Tag Helpers
+test_files: []
+