RubyGems - scotch-view_fu - Versions diffs - 0.9.1 - Mend

scotch-view_fu 0.9.1

Files changed (22) hide show

data/MIT-LICENSE +40 -0
data/README +145 -0
data/Rakefile +22 -0
data/init.rb +1 -0
data/lib/browser_detect/helper.rb +45 -0
data/lib/headliner/README +118 -0
data/lib/headliner/helper.rb +65 -0
data/lib/javascripter/README +87 -0
data/lib/javascripter/helper.rb +112 -0
data/lib/styler/README +95 -0
data/lib/styler/helper.rb +117 -0
data/lib/view_fu.rb +18 -0
data/lib/view_fu/controller_extensions.rb +13 -0
data/lib/view_fu/meta_helper.rb +52 -0
data/lib/view_fu/tag_helper.rb +146 -0
data/rails/init.rb +1 -0
data/test/browser_detect_test.rb +14 -0
data/test/headliner_test.rb +106 -0
data/test/styler_test.rb +14 -0
data/test/view_fu_test.rb +16 -0
data/view_fu.gemspec +42 -0
metadata +81 -0

data/lib/javascripter/helper.rb ADDED Viewed

@@ -0,0 +1,112 @@
+module Javascripter
+  module Helper
+    # alias for javascript_include_tag
+    def javascript(*input)
+      input = [input].flatten
+      javascript_include_tag(*input)
+    end
+    # Override this if needed
+    def javascripts(options={})
+      [
+        # include the default sources (minus application.js)
+        javascript(ActionView::Helpers::AssetTagHelper::JAVASCRIPT_DEFAULT_SOURCES),
+        # include the dynamic page javascripts
+        page_javascripts(options),
+        # application.js always needs to be at the end
+        javascript("application")
+      ].join("\n")
+    end
+    # returns an entire directory of javascripts recursively
+    def javascript_folder(path)
+      if use_cache?
+        return javascript("min/#{path}.js")
+      else
+        result = []
+        Dir["#{Rails.public_path}/javascripts/#{path}/**/*.js"].each do |item|
+          result << item.gsub("#{Rails.public_path}/javascripts/", "")
+        end
+        return javascript(result)
+      end
+    end
+    # Include Javascripts on the page
+    # options[:include] to an array of strings for javascripts to include
+    # options[:exclude] sets an array of strings for javascripts to exclude
+    # options[:cache] sets the cache option to javascript_include_tag (only for nonconditional items)
+    #
+    # Automatically includes javascripts (if they exist on filesystem)
+    # - javascripts for [controller]/[controller].js and [controller]/[action].js
+    #
+    def page_javascripts(options={})
+      # initialize collection
+      javascripts = []
+      conditional_scripts = []
+      @javascripts_add ||= []
+      @javascripts_ignore ||= []
+      # Additional scripts (if requested)
+      if options[:include]
+        @javascripts_add = [options[:include]].flatten + @javascripts_add
+      end
+      # Exclude scripts (if requested)
+      if options[:exclude]
+        @javascripts_ignore = [options[:exclude]].flatten + @javascripts_ignore
+      end
+      # Add more scripts
+      @javascripts_add.each do |javascript|
+        javascripts << javascript
+      end
+      # Ignore scripts
+      @javascripts_ignore.each do |javascript|
+        javascripts.delete(javascript)
+      end
+      # dedup javascript array
+      javascripts.uniq!
+      # Build Output
+      html_output = javascript_include_tag(*javascripts)
+      # Controller/action scripts
+      conditional_scripts << "#{controller.controller_name}"
+      conditional_scripts << "#{controller.controller_name}/#{controller.action_name}"
+      # only add conditional scripts if they exist on disk
+      conditional_scripts.each do |javascript|
+        if File.exist?("#{RAILS_ROOT}/public/javascripts/#{javascript}.js")
+          html_output << "\n"
+          html_output << javascript_include_tag(javascript)
+        end
+      end
+      # return output
+      return html_output
+    end
+    # add a javascript to the include list
+    def add_javascript(*javascripts)
+      @javascripts_add ||= []
+      javascripts.each do |javascript|
+        @javascripts_add << javascript
+      end
+    end
+    # ignore a javascript
+    def ignore_javascript(*javascripts)
+      @javascripts_ignore ||= []
+      javascripts.each do |javascript|
+        @javascripts_ignore << javascript
+      end
+    end
+  end
+end

data/lib/styler/README ADDED Viewed

@@ -0,0 +1,95 @@
+======
+Styler
+======
+Styler is designed to DRY up the process of including and generating
+stylesheets, so you can think less about stylesheet configuration and more
+about styling.
+Usage
+=====
+To use Styler, just update your layout(s) with this code:
+<head>
+<title>the.rails.ist</title>
+<%= stylesheets %>
+</head>
+Styler will then include your stylesheets automatically:
+<head>
+<title>the.rails.ist</title>
+<link href="/stylesheets/application.css?1170968897" />
+<!--[if IE 7]>
+<link href="/stylesheets/ie7.css?1170968897" />
+<![endif]-->
+<!--[if IE 6]>
+<link href="/stylesheets/ie6.css?1170968897" />
+<![endif]-->
+</head>
+Styler will also dynamically include stylesheets for each of your
+controllers (if such stylesheets are present), so you can keep your styles
+organized into logical sections.
+Organize your stylesheets
+=========================
+Styler uses a simple set of conventions:
+- Styles for your entire application should be stored in application.css
+- Styles for specific controllers should be stored in controller.css
+- Styles for specific actions should be stored in controller_action.css
+- Styles for Internet Explorer 7 should be stored in ie7.css
+- Styles for Internet Explorer 6 should be stored in ie6.css
+When used in combination, these conventions can scale up to support pretty
+big applications.
+Include additional stylesheets
+==============================
+Conventions are great, but need to add your own stylesheets?
+<%= stylesheets :include => "reset" %>
+<%= stylesheets :include => ["reset", "fonts"] %>
+Use nested stylesheets (optional)
+=================================
+For bigger projects, you might wish to break your stylesheets into separate
+directories.
+To use nested stylesheets, just create subdirectories in public/stylesheets
+for each of your controllers, and then add stylesheets for individual
+actions you wish to style.
+- Styles for an entire controller should be stored in controller.css
+- Styles for specific actions should be stored in controller/action.css
+Generator
+=========
+Styler also includes a generator that will create a default set of
+stylesheets (application.css, ie7.css, and ie6.css) and a separate
+stylesheet for each controller in your application.
+To use the generator, run this command in your terminal:
+script/generate stylesheets
+If you add a new controller, just run the generator again and a new
+stylesheet for the controller will be created. (Styler will safely ignore
+any existing stylesheets.)
+Feedback
+========
+Comments, bug reports, and svn diffs welcome at http://the.railsi.st.

data/lib/styler/helper.rb ADDED Viewed

@@ -0,0 +1,117 @@
+module Styler
+  module Helper
+    # alias for stylesheet_link_tag
+    def stylesheet(*input)
+      input = [input].flatten
+      stylesheet_link_tag(*input)
+    end
+    # override this in your application_helper to clean it up
+    def stylesheets(options = {})
+      [stylesheet("application"), page_stylesheets(options)].join("\n")
+    end
+    # returns an entire directory of stylesheets recursively
+    def stylesheet_folder(path)
+      if use_cache? # or browser_is? :ie
+        return stylesheet("min/#{path}.css")
+      else
+        result = []
+        Dir["#{Rails.public_path}/stylesheets/#{path}/**/*.css"].each do |css|
+          result << css.gsub("#{Rails.public_path}/stylesheets/", "")
+        end
+        return stylesheet(result)
+      end
+    end
+    # Include Stylesheets on the page
+    # options[:include] to an array of strings for stylesheets to include
+    # options[:exclude] sets an array of strings for stylesheets to exclude
+    #
+    # Automatically includes stylesheets (if they exist on filesystem)
+    # - stylesheets for [controller]/[controller].css and [controller]/[action].css
+    # - stylesheets for browser overrides (ie6.css, ie7.css, safari.css)
+    #
+    def page_stylesheets(options={})
+      # set default values
+      stylesheets = []
+      @stylesheets_add ||= []
+      @stylesheets_ignore ||= []
+      # Include sheets from options
+      if options[:include]
+        @stylesheets_add = [options[:include]].flatten + @stylesheets_add
+      end
+      # Exclude sheets from options
+      if options[:exclude]
+        @stylesheets_ignore = [options[:exclude]].flatten + @stylesheets_ignore
+      end
+      # Add all sheets from instance variable
+      @stylesheets_add.each do |stylesheet|
+        stylesheets << stylesheet
+      end
+      # Ignore all sheets from instance variable
+      @stylesheets_ignore.each do |stylesheet|
+        stylesheets.delete(stylesheet)
+      end
+      # dedupe stylesheets array
+      stylesheets.uniq!
+      # Build Initial Output
+      html_output = stylesheet_link_tag(*stylesheets)
+      # Build conditional stylesheets (we need to check these on the filesystem before including)
+      conditional_stylesheets = []
+      # Controller/action sheets
+      conditional_stylesheets << "pages/#{controller.controller_name}"
+      conditional_stylesheets << "pages/#{controller.controller_name}/#{controller.action_name}"
+      # IE6
+      if browser_is?(:ie6)
+        conditional_stylesheets << "ie6"
+      end
+      # IE7
+      if browser_is?(:ie7)
+        conditional_stylesheets << "ie7"
+      end
+      # Safari
+      if browser_is?(:safari) and
+        conditional_stylesheets << "safari"
+      end
+      # only add conditional stylesheets if they exist on disk
+      conditional_stylesheets.each do |stylesheet|
+        if File.exist?("#{RAILS_ROOT}/public/stylesheets/#{stylesheet}.css")
+          html_output << "\n"
+          html_output << stylesheet_link_tag(stylesheet)
+        end
+      end
+      return html_output
+    end
+    # Allows individual views to customize the stylesheet list
+    def add_stylesheet(*stylesheets)
+      @stylesheets_add ||= []
+      stylesheets.each do |stylesheet|
+        @stylesheets_add << stylesheet
+      end
+    end
+    # Allows individual views to customize the stylesheet list
+    def ignore_stylesheet(*stylesheets)
+      @stylesheets_ignore ||= []
+      stylesheets.each do |stylesheet|
+        @stylesheets_ignore << stylesheet
+      end
+    end
+  end
+end

data/lib/view_fu.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require "view_fu/tag_helper"
+require "view_fu/meta_helper"
+require "view_fu/controller_extensions"
+ActionView::Base.send :include, ViewFu::TagHelper
+ActionView::Base.send :include, ViewFu::MetaHelper
+ActionController::Base.send :include, ViewFu::ControllerExtensions
+require "browser_detect/helper"
+ActionView::Base.send :include, BrowserDetect::Helper
+require "headliner/helper"
+ActionView::Base.send :include, Headliner::Helper
+require "javascripter/helper"
+ActionView::Base.send :include, Javascripter::Helper
+require "styler/helper"
+ActionView::Base.send :include, Styler::Helper

data/lib/view_fu/controller_extensions.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module ViewFu
+  module ControllerExtensions
+    # allows us to say "helpers." anywhere in our controllers
+    def helpers
+      self.class.helpers
+    end
+    # checks to see if app is in production mode
+    def production?
+      Rails.env == "production"
+    end
+  end
+end

data/lib/view_fu/meta_helper.rb ADDED Viewed

@@ -0,0 +1,52 @@
+module ViewFu
+  module MetaHelper
+    # Output the current page's meta tags
+    def meta_tags
+      %(<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
+<meta content="no" name="imagetoolbar"/>
+<meta content="#{meta_keywords}" name="keywords"/>
+<meta content="#{meta_description}" name="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 ADDED Viewed

@@ -0,0 +1,146 @@
+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
+    # Writes an hr space tag
+    def space
+      "<hr class='space' />"
+    end
+    # Writes an anchor tag
+    def anchor(anchor_name)
+      "<a name='#{anchor_name}'></a>"
+    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
+    # 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
+    # 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_if
+    # Wrap a delete link
+    def delete_link(*args)
+      options = {:method => :delete, :confirm => "Are you sure you want to delete this?"}.merge(args.extract_options!)
+      args << options
+      link_to(*args)
+    end
+    # Wrap a block with a link
+    def link_to_block(*args, &block)
+      content = capture_haml(&block)
+      return link_to(content, *args)
+    end
+    # Check if we're on production environment
+    def production?
+      Rails.env == "production"
+    end
+    # Check if we're on New or Create actions
+    def is_new?
+      action = params[:action]
+      action == "new" || action == "create"
+    end
+    # Check if we're on Edit or Update actions
+    def is_edit?
+      action = params[:action]
+      action == "edit" || action == "update"
+    end
+    # Whether or not to use caching
+    def use_cache?
+      ActionController::Base.perform_caching
+    end
+    # Display will_paginate paging links
+    def paging(page_data, style = :sabros)
+      return unless page_data.class == 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
+  end
+end