common_view_helpers 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gemini SBS, LLC
+
+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.rdoc

@@ -0,0 +1,47 @@
+= Common View Helpers
+
+A set of view helpers Gemini uses in all of our Rails applications.
+
+== Installation
+
+  gem install common_view_helpers
+
+== Summary
+
+  # Use words if within the last week, otherwise use date
+  # Show year if not this year
+  time_ago_in_words_or_date(date, options={})
+  
+  # Output an easily styleable key-value pair
+  info_pair(label, value)  
+
+  # Give this helper an array, and get back a string of <li> elements. 
+  # The first item gets a class of first and the last, well.. last. 
+  # This makes it easier to apply CSS styles to lists, be they ordered or unordered.
+  # http://zeke.tumblr.com/post/98025647/a-nice-little-view-helper-for-generating-list-items
+  convert_to_list_items(items)
+
+  # This works just like link_to, but with one difference..
+  # If the link is to the current page, a class of 'active' is added
+  link(name, options={}, html_options={})
+
+  # Absolute path to an image
+  image_url(source)
+
+  # e.g. http://localhost:3000, or https://productionserver.com
+  base_url
+
+  # Generate a list of column name-value pairs for an AR object
+  list_model_columns(obj)
+  
+  # Javascript friendly (escaped) string
+  js_string(string)
+
+== Copyright & Licensing
+
+Copyright (c) 2010 {Gemini SBS}[http://geminisbs.com], released under the MIT license
+
+== Authors
+
+* {Zeke Sikelianos}[http://github.com/zeke]
+* {Mauricio Gomes}[http://github.com/mgomes]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/lib/common_view_helpers'
+
+ActionView::Base.send(:include, CommonViewHelpers::ViewHelpers)

data/lib/common_view_helpers.rb

@@ -0,0 +1,112 @@
+module CommonViewHelpers
+  module ViewHelpers
+
+    # Use words if within the last week, otherwise use date (show year if not this year)
+    def time_ago_in_words_or_date(date,options={})
+      return unless date
+      if (Time.now-date)/60/60/24 < 7
+        time_ago_in_words(date) + " ago"
+      elsif date.year == Time.now.year
+        options[:short_format] ? date.strftime(options[:short_format]) : date.strftime("%b %e").gsub("  ", " ")
+      else
+        options[:long_format] ? date.strftime(options[:long_format]) : date.strftime("%b %e, %Y").gsub("  ", " ")
+      end
+    end
+  
+    # Output an easily styleable key-value pair
+    def info_pair(label, value)
+      value = content_tag(:span, "None", :class => "blank") if value.blank?
+      label = content_tag(:span, "#{label}:", :class => "label")
+      content_tag(:span, [label, value].join(" "), :class => "info_pair")
+    end
+
+    # Give this helper an array, and get back a string of <li> elements. 
+    # The first item gets a class of first and the last, well.. last. 
+    # This makes it easier to apply CSS styles to lists, be they ordered or unordered.
+    # http://zeke.tumblr.com/post/98025647/a-nice-little-view-helper-for-generating-list-items
+    def convert_to_list_items(items, *args)
+      default_options = {:stripe => true}
+      options = default_options.merge(args.extract_options!)
+      out = []
+      items.each_with_index do |item, index|
+        css = []
+        css << "first" if items.first == item
+        css << "last" if items.last == item
+        css << "even" if options[:stripe] && index%2 == 1
+        css << "odd" if options[:stripe] && index%2 == 0 # (First item is odd (1))
+        out << content_tag(:li, item, :class => css.join(" "))
+      end
+      out.join("\n")
+    end
+  
+    # Build an HTML table
+    # For collection, pass an array of arrays
+    # For headers, pass an array of label strings for the top of the table
+    # All other options will be passed along to the table content_tag  
+    def generate_table(collection, headers=nil, options={})
+      return if collection.blank?
+      thead = content_tag(:thead) do
+        content_tag(:tr) do
+          headers.map {|header| content_tag(:th, header)}
+        end
+      end unless headers.nil?
+      tbody = content_tag(:tbody) do
+        collection.map do |values|
+          content_tag(:tr) do
+            values.map {|value| content_tag(:td, value)}
+          end
+        end
+      end
+      content_tag(:table, [thead, tbody].compact.join("\n"), options)
+    end
+    
+    # Pass in an ActiveRecord object, get back edit and delete links inside a TD tag
+    def options_td(record_or_name_or_array, hide_destroy = false)
+      items = []
+      items << link_to('Edit', edit_polymorphic_path(record_or_name_or_array))
+      items << link_to('Delete', polymorphic_path(record_or_name_or_array), :confirm => 'Are you sure?', :method => :delete, :class => "destructive") unless hide_destroy
+      list = content_tag(:ul, convert_to_list_items(items))
+      content_tag(:td, list, :class => "options")
+    end
+
+    # This works just like link_to, but with one difference..
+    # If the link is to the current page, a class of 'active' is added
+    def link(name, options={}, html_options={})
+      link_to_unless_current(name, options, html_options) do
+        html_options[:class] = (html_options[:class] || "").split(" ").push("active").join(" ")
+        link_to(name, options, html_options)
+      end
+    end
+  
+    # Absolute path to an image
+    def image_url(source)
+      base_url + image_path(source)
+    end
+  
+    # e.g. http://localhost:3000, or https://productionserver.com
+    def base_url
+      "#{request.protocol}#{request.host_with_port}"
+    end
+
+    # Generate a list of column name-value pairs for an AR object
+    def list_model_columns(obj)
+      items = obj.class.columns.map{ |col| info_pair(col.name, obj[col.name]) }
+      content_tag(:ul, convert_to_list_items(items), :class => "model_columns")
+    end
+
+		# Outputs a JS friendly (escaped) string
+		def js_string(string)
+			js_escape_map = {
+			        '\\'    => '\\\\',
+			        '</'    => '<\/',
+			        "\r\n"  => '\n',
+			        "\n"    => '\n',
+			        "\r"    => '\n',
+			        '"'     => '\\"',
+			        "'"     => "\\'" }
+
+			string.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { js_escape_map[$1] }
+		end
+
+  end  
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/../lib/common_view_helpers'
+
+ActionView::Base.send(:include, CommonViewHelpers::ViewHelpers)

data/spec/common_view_helpers_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'rubygems'
+require 'RedCloth'
+require 'active_support' # to get methods like blank? and starts_with?
+require 'action_view'  
+require File.dirname(__FILE__) + '/../lib/common_view_helpers'
+
+include ActionView::Helpers
+include CommonViewHelpers::ViewHelpers
+# include ActionView::Helpers::TextHelper
+# include ActionView::Helpers::TagHelper
+# include ActionView::Helpers::DateHelper
+# include ActionView::Helpers::CacheHelper
+# include ActionView::Helpers::CaptureHelper # For the generate_table method
+
+describe CommonViewHelpers do
+  context "time_ago_in_words_or_date" do
+    it "gets relative times right" do
+      time_ago_in_words_or_date(Time.now - 10.minutes).should == "10 minutes ago"
+      time_ago_in_words_or_date(Time.now - 1.day).should == "1 day ago"
+      time_ago_in_words_or_date(Time.now - 2.days).should == "2 days ago"
+    end
+    
+    it "should use short format for non-relative dates in the last year" do
+      time_ago_in_words_or_date(Time.now - 8.days).should =~ /\w{3} \d+/i
+      time_ago_in_words_or_date(Time.now - 6.months).should =~ /\w{3} \d+/i
+    end
+    
+    it "should display year format for non-relative dates beyond one year ago" do
+      time_ago_in_words_or_date(Time.now - 13.months).should =~ /\w{3} \d+, \d{4}/i
+    end
+  end
+  
+  context "generate_table" do
+    it "should generate a simple table" do
+      collection = [%w(lucy 12)]
+      headers = %w(name age)
+      # generate_table(collection, headers).should == "<table><thead><tr><th>name</th><th>age</th></tr></thead><tbody><tr><td>lucy</td><td>12</td></tr></tbody></table>"
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'common_view_helpers'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: common_view_helpers
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Zeke Sikelianos
+- Mauricio Gomes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 4
+        - 1
+        - 0
+        version: 4.1.0
+  type: :development
+  version_requirements: *id003
+description: Common view helpers used by Gemini in most of our applications
+email: admin@geminisbs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- init.rb
+- lib/common_view_helpers.rb
+- rails/init.rb
+- spec/common_view_helpers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/geminisbs/common_view_helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Common view helpers for Rails apps
+test_files: 
+- spec/common_view_helpers_spec.rb
+- spec/spec_helper.rb