insightful 0.0.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+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.markdown

@@ -0,0 +1,40 @@
+# Insightful
+
+<q>DRY, SEO-friendly Rails Views</q>
+
+## Usage
+
+### Install
+
+    sudo gem install represent
+    
+### Helpers
+
+#### Tooltip Helpers
+
+Ever want to centralize tooltips and helpful hints for form fields in your projects?  Now you can.
+
+#### Metadata Helpers
+
+Adding metadata to your views is easy (`app/views/pages/index.html.erb`):
+
+    <% title       @post.title %>
+    <% description @post.description %>
+    <% keywords    @post.tag_list %>
+    <% body_class  "post post-template" %>
+    
+    <div id="content">...</div>
+    
+Default metadata is just as easy (`app/views/layouts/application.html.erb`):
+
+    <%= meta_tags "My Site",
+        :keywords => "Rails 3, jQuery",
+        :description => "This is what Facebook displays" %>
+
+#### System Helpers
+
+Need to check what browser it is?  No problem.
+
+#### Layout Helpers
+
+Would you like to create a nested menu, or a grid?  No problem.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "insightful"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.0.1.5"
+  s.summary           = "Insightful: DRY, SEO-friendly Rails Views"
+  s.homepage          = "http://github.com/viatropos/insightful"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "DRY, SEO-friendly Rails Views"
+  s.has_rdoc          = false
+  s.rubyforge_project = "insightful"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/insightful/adapter.rb

@@ -0,0 +1,14 @@
+# since I love the haml pretty-printed output so much,
+# this makes it so I can use that instead of the built in
+# rails ugly printing
+module Insightful
+  module Adapter
+    def render_tag(name, *args, &block)
+      if self.respond_to?("is_haml?".to_sym) and is_haml?
+        haml_tag(name.to_sym, options)
+      else
+        tag(name.to_sym)
+      end
+    end
+  end
+end

data/lib/insightful/body_helper.rb

@@ -0,0 +1,18 @@
+module Insightful
+  module BodyHelper 
+    def body_id(string)
+      @body_id = string
+    end
+  
+    def body_class(string)
+      @body_class = string
+    end
+  
+    def body_attributes(options = {})
+      options[:class] = @body_class if @body_class
+      options[:id] = @body_id if @body_id
+    
+      options
+    end
+  end
+end

data/lib/insightful/grid_helper.rb

@@ -0,0 +1,31 @@
+module Insightful
+  module GridHelper
+    def grid_for(array, options = {}, &block)
+      return "" if array.empty?
+      columns = options[:columns] || 3
+      (array / columns).each do |row|
+        yield row
+      end
+    end
+  
+    def row_for(array, options = {}, &block)
+      return "" if array.empty?
+      array.each_with_index do |node, i|
+        attributes = options.has_key?(:li_attributes) ? options[:li_attributes] : {}
+        attributes[:class] ||= ""
+        if i == 0 and options.has_key?(:first)
+          attributes[:class] << "#{options[:first]}"
+        elsif i == array.length - 1 and options.has_key?(:last)
+          attributes[:class] << "#{options[:last]}"
+        end
+        haml_tag :li, attributes do
+          if block_given?
+            yield node, i
+          else
+            haml_concat node.title
+          end
+        end
+      end
+    end
+  end
+end

data/lib/insightful/head_helper.rb

@@ -0,0 +1,213 @@
+module Insightful
+  module HeadHelper
+  
+    def meta(options = {})
+      title(options[:title]) if options.has_key?(:title)
+      description(options[:description]) if options.has_key?(:description)
+      keywords(options[:keywords]) if options.has_key?(:keywords)
+      copyright(options[:copyright]) if options.has_key?(:copyright)
+    end
+  
+    def meta_tags(*args)
+      options = args.extract_options!
+      site = options[:site] || args.first
+      result = title_tag(site, options[:title])
+      result << "\n"
+      result << content_type_tag
+      result << "\n"
+      result << description_tag(options[:description])
+      result << "\n"
+      result << keywords_tag(options[:keywords])
+      result << "\n"
+      result << copyright_tag(options[:copyright])
+      result
+    end
+  
+    # country
+    # classification
+    # author
+    # apple-mobile-web-app-capable
+    # apple-touch-fullscreen
+    # google-analytics
+    # Revisit-After
+    # category
+    def meta_tag(name, content = '')
+      tag(:meta, :name => name, :content => content)
+    end
+  
+    def title(string)
+      @content_for_title = string
+    end
+  
+    def title_tag(*args)
+      options = args.extract_options!
+    
+      site = options[:site] || args.first
+      # 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
+
+      # Title
+      title = @content_for_title
+      if options[:lowercase] === true
+        title = title.downcase unless title.blank?
+      end
+    
+      # title
+      if title.blank?
+        result = content_tag :title, site
+      else
+        title = normalize_title(title)
+        title = [site] + title
+        title.reverse! if options[:reverse] === true
+        sep = prefix + separator + suffix
+        result = content_tag(:title, title.join(sep))
+      end
+      result
+    end
+  
+    def description(string)
+      @content_for_description = string
+    end
+
+    def description_tag(default='')
+      content = normalize_description(@content_for_description || default)
+      tag(:meta, :name => :description, :content => content) unless content.blank?
+    end
+
+    def keywords(string)
+      @content_for_keywords = string
+    end
+
+    def keywords_tag(default = '')
+      content = normalize_keywords(@content_for_keywords || default)
+      tag(:meta, :name => :keywords, :content => content) unless content.blank?
+    end
+  
+    def copyright(string)
+      @content_for_copyright = string
+    end
+
+    def copyright_tag(default='')
+      content = @content_for_copyright || default
+      tag(:meta, :name => :copyright, :content => content) unless content.blank?
+    end
+  
+    def robots(*args)
+      content_for(:robots, args.join(", "))
+    end
+  
+    def robots_tag(*args)
+      options = args.extract_options!
+    
+      noindex_name = tags[:noindex].is_a?(String) ? tags[:noindex] : 'robots'
+      nofollow_name = tags[:nofollow].is_a?(String) ? tags[:nofollow] : 'robots'
+
+      if noindex_name == nofollow_name
+        content = [(tags[:noindex] ? 'noindex' : nil), (tags[:nofollow] ? 'nofollow' : nil)].compact.join(', ')
+        unless content.blank?
+          result << "\n"
+          result << tag(:meta, :name => noindex_name, :content => content)
+        end
+      else
+        if tags[:noindex]
+          result << "\n"
+          result << tag(:meta, :name => noindex_name, :content => 'noindex')
+        end
+        if tags[:nofollow]
+          result << "\n"
+          result << tag(:meta, :name => nofollow_name, :content => 'nofollow')
+        end
+      end
+      # canonical
+      unless tags[:canonical].blank?
+        result << "\n"
+        result << tag(:link, :rel => :canonical, :href => tags[:canonical]) 
+      end
+
+      return result
+    end
+  
+    def copyright(from)
+      now = Time.now.year
+      now.eql?(from) ? now : "#{from} - #{now}"
+    end
+  
+    # Apple
+    # http://developer.apple.com/safari/library/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html
+  
+    # Facebook (and opengraph)
+    # http://developers.facebook.com/docs/opengraph#types
+  
+    # http://wiki.developers.facebook.com/index.php/Facebook_Share/Specifying_Meta_Tags
+    def snapshot_tag(href)
+      tag(:link, :rel => "image_src", :href => href)
+    end
+  
+    # http://wiki.developers.facebook.com/index.php/Facebook_Share/Specifying_Meta_Tags
+    def medium(type)
+      tag(:meta, :name => :medium, :content => type)
+    end
+  
+    def classification(type)
+      tag(:meta, :name => "og:type", :content => type)
+    end
+  
+    def content_type_tag(type = "text/html", charset = "UTF-8")
+      meta_tag("Content-Type", "#{type}; charset=#{charset}")
+    end
+  
+    def search_link_tag(href, title)
+      link_tag({:rel => "search", :type => "application/opensearchdescription+xml", :href => href, :title => title})
+    end  
+  
+    def favicon_link_tag(favicon = "/favicon.ico")
+      link_tag({:rel => "shortcut icon", :href => favicon, :type => "image/x-icon"})
+    end
+  
+    def link_tag(options = {})
+      tag(:link, options)
+    end
+  
+    private
+
+      def normalize_title(title)
+        if title.is_a? String
+          title = [title]
+        end
+        title.map { |t| h(strip_tags(t)) }
+      end
+  
+      def normalize_description(description)
+        return '' unless description
+        truncate(strip_tags(description).gsub(/\s+/, ' '), :length => 200)
+      end
+  
+      def normalize_keywords(keywords)
+        return '' unless keywords
+        keywords = keywords.flatten.join(', ') if keywords.is_a?(Array)
+        strip_tags(keywords).mb_chars.downcase
+      end
+  end
+end

data/lib/insightful/navigation_helper.rb

@@ -0,0 +1,119 @@
+module Insightful
+  module NavigationHelper
+
+    # - menu(c(:menu)) do |attributes, node|
+    # 	- attributes[:class] = "one two"
+    # 	- node[:title]
+    def menu(nodes, options = {}, &block)
+      menu_builder(nodes, 0, options, &block)
+    end
+
+    def nested_set_menu(clazz, options = {}, &block)
+      menu(simple_nested_set(clazz), options) do |node, children, level|
+        if block_given?
+          case block.arity
+        		when 1
+              yield node[:node]
+        		when 2
+              yield node[:node], children
+        		when 3
+              yield node[:node], children, level
+        	end
+        end
+      end
+    end
+
+    def menu_builder(nodes, level = 0, options = {}, &block)
+      return "" if nodes.empty?
+
+      menu_attributes = options[:menu_attributes] if options.has_key?(:menu_attributes)
+      options.delete(:menu_attributes)
+
+      haml_tag :ul, menu_attributes do
+        nodes.each_with_index do |node, i|
+          # set the attributes
+          attributes = options[:li_attributes].blank? ? {} : options[:li_attributes].dup
+          attributes[:class] ||= ""
+          if i == 0 and options.has_key?(:first)
+            attributes[:class] << " #{options[:first]}".squeeze(" ")
+          elsif i == nodes.length - 1 and options.has_key?(:last)
+            attributes[:class] << " #{options[:last]}".squeeze(" ")
+          end
+
+          haml_tag :li, attributes do
+            children = nil
+            if node.has_key?(:children)
+              children = node[:children]
+            elsif node.respond_to?(:children)
+              children = node.children
+            end
+
+            if block_given?
+              case block.arity
+            		when 1
+                  yield node
+            		when 2
+                  yield node, children
+            		when 3
+                  yield node, children, level
+            	end
+            end
+
+            # pass it in again
+            menu_builder(children, level + 1, options, &block) unless children.empty?
+          end
+        end
+      end
+    end
+
+    def simple_nested_set(clazz) # Post for example
+      stack = [] # Post for example
+      result = []
+      clazz.all(:order => "lft").each do |node|
+        if stack.empty?
+          stack.push({:node => node, :children => []})
+          result << stack.last
+          next
+        end
+        if stack.last[:node].lft < node.lft && node.lft < stack.last[:node].rgt
+          child = {:node => node, :children => []}
+          stack.last[:children] << child
+          unless node.leaf? # (node.rgt - node.lft == 1)
+            stack.push(child)
+          end
+
+          if node.rgt + 1 == stack.last[:node].rgt
+            stack.pop
+          end
+        else
+          stack.pop
+        end
+      end
+
+      result
+    end
+  
+    def breadcrumb(item, options = {}, &block)
+      options[:from] ||= "/" + item.url.gsub(/^\//, "").split("/").first
+      options[:to] ||= item.url
+      breadcrumb_builder(options[:from], options, &block)
+    end
+  
+    def breadcrumb_builder(current_url, options, &block)
+      item = site.find_by_url(current_url)
+      return "" unless item
+      haml_tag :a, options.merge(:href => current_url) do
+        if block_given?
+          yield item
+        else
+          haml_concat item.title
+        end
+      end
+      if options[:to] != current_url
+        haml_concat options[:delimiter] || " » "
+        next_node = options[:to].gsub(/#{current_url}\/?/, "").split("/").first
+        breadcrumb_builder("#{current_url}/#{next_node}", options, &block)
+      end
+    end
+  end
+end

data/lib/insightful/system_helper.rb

@@ -0,0 +1,61 @@
+module Insightful
+  module SystemHelper
+    # 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
+  
+    def windows?
+      # Can't match for just 'win' cause it will match darwin as well.
+      (/win32|mswin|mingw/).match(RUBY_PLATFORM) ? true : false
+    end
+
+    # Works on Debian and Ubuntu, don't have anything else to test on.
+    def linux?
+      (/linux/).match(RUBY_PLATFORM) ? true : false
+    end
+
+    # Works on my MacBook Pro, don't have anything else to test on,
+    def mac?
+      (/darwin/).match(RUBY_PLATFORM) ? true : false
+    end
+  end
+end

data/lib/insightful/tooltip_helper.rb

@@ -0,0 +1,13 @@
+module Insightful
+  module TooltipHelper
+    # associates the "title" attribute of a node with a rendered partial
+    def insight(partial, options = {})
+      if options.has_key?(:class)
+        options[:class] << " insightful"
+      else
+        options[:class] = "insightful"
+      end
+      {:title => (render :partial => partial).to_s}.merge!(options)
+    end
+  end
+end

data/lib/insightful.rb

@@ -0,0 +1,22 @@
+
+# This takes care of the rest of functionality you need
+# for an SEO and easy to build page.
+# It includes: metadata helpers, grid helpers (e.g. for photo gallerys),
+# navigation helpers (menus and breadcrumbs),
+# better render method so you can pass a block to partials
+# http://github.com/rpheath/navigation_helper.git
+# http://github.com/justinfrench/lovely-layouts.git
+# http://github.com/ianwhite/truncate_html
+# http://github.com/dekart/breadcrumbs.git
+# http://github.com/html/once/blob/master/lib/once.rb
+# http://github.com/fnando/breadcrumbs.git
+# http://github.com/semanticart/smart-meta
+
+Dir["#{File.expand_path(File.dirname(__FILE__))}/insightful/*"].each {|file| require file}
+
+Insightful.send(:include, Insightful::HeadHelper)
+Insightful.send(:include, Insightful::BodyHelper)
+Insightful.send(:include, Insightful::NavigationHelper)
+
+ActionView::Base.send(:include, Insightful) if defined?(ActionView)
+ActionController::Base.helper(Insightful) if defined?(ActionController)

data/rails/init.rb

@@ -0,0 +1 @@
+require 'insightful'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: insightful
+version: !ruby/object:Gem::Version 
+  hash: 65
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  - 5
+  version: 0.0.1.5
+platform: ruby
+authors: 
+- Lance Pollard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: DRY, SEO-friendly Rails Views
+email: lancejpollard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- init.rb
+- MIT-LICENSE
+- lib/insightful/adapter.rb
+- lib/insightful/body_helper.rb
+- lib/insightful/grid_helper.rb
+- lib/insightful/head_helper.rb
+- lib/insightful/navigation_helper.rb
+- lib/insightful/system_helper.rb
+- lib/insightful/tooltip_helper.rb
+- lib/insightful.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/viatropos/insightful
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: insightful
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Insightful: DRY, SEO-friendly Rails Views"
+test_files: []
+