scaffold_logic 1.6.0

data/lib/scaffold_logic/data_import.rb

@@ -0,0 +1,80 @@
+# Adapted from http://paulbarry.com/articles/2008/04/19/importing-data-with-rails
+
+require 'faster_csv' if Object.const_defined?('FasterCSV')
+
+module ScaffoldLogic
+  class DataImport
+    attr_reader :file, :fields, :row_map
+
+    # Class Methods ==================================================================================
+    def self.run(file)
+      new(file).run
+    end
+
+    def self.save(upload)
+      # create file path
+      _path = File.join('tmp', upload['datafile'].original_filename)
+
+      # write file
+       File.open(_path, 'wb') { |f| f.write(upload['datafile'].read) }
+
+      self.run(_path)
+    end
+
+    # Instance Methods ===============================================================================
+    def initialize(file)
+      @file = file
+      raise 'You must specify a file' unless @file
+    end
+
+    def initialize_row!
+      unless @fields_initialized
+        initialize_fields!
+      else
+        initialize_row_map!
+        process_row
+      end
+    end
+
+    def create_from_row( model )
+      model.create(row_map)
+    end
+
+    def run
+      @errors = []
+      @row_index = 1
+
+      FasterCSV.foreach(file, :col_sep => "\t", :row_sep => :auto) do |@row|
+        initialize_row!
+        @row_index += 1
+      end
+
+      @errors
+    end
+
+    def valid_row?
+      @missing_fields = []
+
+      @required_fields.each do |field|
+        @missing_fields << field if row_map[field].blank?
+      end
+
+      @missing_fields.empty?
+    end
+
+    private
+
+    def initialize_fields!
+      @fields = @row.map{ |f| f && f.strip.downcase.to_sym }
+      @fields_initialized = true
+    end
+
+    def initialize_row_map!
+      @row_map ||= {}
+      @row_map.clear
+      @row.each_with_index do |_c, _i|
+        @row_map[fields[_i]] = _c && _c.strip
+      end
+    end
+  end
+end

data/lib/scaffold_logic/form_helper.rb

@@ -0,0 +1,148 @@
+module ScaffoldLogic
+  module FormHelper
+    SELECT_PROMPT_OPTION = '<option>Select...</option>'
+
+    # Returns a check mark.
+    #
+    # Usage:
+    #
+    #   <%= checkmark -%>
+    def checkmark
+      %{<div class="checkmark"></div>}.html_safe
+    end
+
+    def countdown_field(field_id,update_id,max,options = {})
+      function = "$('#{update_id}').innerHTML = (#{max} - $F('#{field_id}').length);"
+      count_field_tag(field_id,function,options)
+    end
+
+    def count_field(field_id,update_id,options = {})
+      function = "$('#{update_id}').innerHTML = $F('#{field_id}').length;"
+      count_field_tag(field_id,function,options)
+    end
+
+    def count_field_tag(field_id,function,options = {})
+      %{
+        <script type="text/javascript">
+          Event.observe($('#{field_id}'), 'keydown', function (){ #{function} });
+        </script>
+      }.html_safe
+    end
+
+    # Returns a simulated text-field for read-only versions of a form.
+    #
+    # Usage:
+    #
+    #   <%= faux_field 'Name', @user.name -%>
+    def faux_field(label, content, options={:field_id => nil, :help => nil})
+      if options[:help]
+        options[:field_id] ||= "field_#{Time.zone.now.to_i}#{rand(10000)}"
+        %{#{tag_for_label_with_inline_help label, options[:field_id], options[:help]}<div class="faux_field">#{content}</div>}.html_safe
+      else
+        %{<label>#{label}</label><div class="faux_field">#{content}</div>}.html_safe
+      end
+    end
+
+    # Returns a legend tag that renders correctly in all browsers.
+    #
+    # Usage:
+    #
+    #   <%= legend_tag "Report Criteria" -%>
+    #
+    # With help text:
+    #
+    #   <%= legend_tag "Report Criteria", :help => "Some descriptive copy here." -%>
+    #     <span id="hide_or_show_backlinks" class="show_link" style="background-color: #999999;
+    #     border: 1px solid #999999;" onclick="javascript:hide_or_show('backlinks');"></span>Backlinks (<%=
+    #     @google_results.size -%>)
+    #   <%- end -%>
+    #
+    # Recommended CSS to support display of help icon and text:
+    #
+    #   .help_icon {
+    #     display: block;
+    #     float: left;
+    #     margin-top: -16px;
+    #     margin-left: 290px;
+    #     border-left: 1px solid #444444;
+    #     padding: 3px 6px;
+    #     cursor: pointer;
+    #   }
+    #
+    #   div.popup_help {
+    #     color: #666666;
+    #     width: 98%;
+    #     background: #ffffff;
+    #     padding: 1em;
+    #     border: 1px solid #999999;
+    #     margin: 1em 0em;
+    #   }
+    def legend_tag(text, options={})
+      options[:id] ||= "#{text.downcase.gsub(' ', '-')}-legend"
+      if options[:help]
+        _html = %{<div id="#{options[:id]}" class="faux_legend">#{text}<span class="help_icon" onclick="$('#{options[:id]}-help').toggle();">?</span></div>\r}
+        _html << %{<div id="#{options[:id]}-help" class="popup_help" style="display: none;">#{options[:help]}<br /></div>\r}
+      else
+        _html = %{<div id="#{options[:id]}" class="faux_legend">#{text}</div>\r}
+      end
+      _html.gsub!(/ id=""/,'')
+      _html.gsub!(/ class=""/,'')
+      _html.html_safe
+    end
+
+    # Create a set of tags for displaying a field label with inline help.
+    # Field label text is appended with a ? icon, which responds to a click
+    # by showing or hiding the provided help text.
+    #
+    # Sample usage:
+    #
+    #   <%= tag_for_label_with_inline_help 'Relative Frequency', 'rel_frequency', 'Relative frequency of search traffic for this keyword across multiple search engines, as measured by WordTracker.' %>
+    #
+    # Yields:
+    #
+    #   <label for="rel_frequency">Relative Frequency: <%= image_tag "/images/help_icon.png", :onclick => "$('rel_frequency_help').toggle();", :class => 'inline_icon' %></label>
+    #   <div class="inline_help" id="rel_frequency_help" style="display: none;">
+    #     <p>Relative frequency of search traffic for this keyword across multiple search engines, as measured by WordTracker.</p>
+    #   </div>
+    def tag_for_label_with_inline_help( label_text, field_id, help_text )
+      _html = ""
+      _html << %{<label for="#{field_id}">#{label_text}}
+      _html << %{<img src="/images/icons/help_icon.png" onclick="$('#{field_id}_help').toggle();" class='inline_icon' />}
+      _html << %{</label>}
+      _html << %{<div class="inline_help" id="#{field_id}_help" style="display: none;">}
+      _html << %{<p>#{help_text}</p>}
+      _html << %{</div>}
+      _html
+    end
+
+    # Create a set of tags for displaying a field label followed by instructions.
+    # The instructions are displayed on a new line following the field label.
+    #
+    # Usage:
+    #
+    #   <%= tag_for_label_with_instructions 'Status', 'is_active', 'Only active widgets will be visible to the public.' %>
+    #
+    # Yields:
+    #
+    #   <label for="is_active">
+    #     Status
+    #     <span class="instructions">Only active widgets will be visible to the public.</span>
+    #   </label>
+    def tag_for_label_with_instructions( label_text, field_id, instructions )
+      _html = ""
+      _html << %{<label for="#{field_id}">#{label_text}}
+      _html << %{<span class="instructions">#{instructions}</span>}
+      _html << %{</label>}
+      _html
+    end
+
+    # Returns a string of HTML option tags for the given array of option values. Specify the selected value for stickiness.
+    #
+    # Usage:
+    #
+    #   <%= select_tag :user, tags_for_option_values(User.all.map{ |c| [c.name, c.id] }, params[:user]) -%>
+    def tags_for_option_values( a, selected = nil, prompt_option = SELECT_PROMPT_OPTION )
+      "#{prompt_option}#{a.map{ |_e| _flag = _e[1].to_s == selected ? 'selected="1"' : ''; _e.is_a?(Array) ? "<option value=\"#{_e[1]}\" #{_flag}>#{_e[0]}</option>" : "<option>#{_e}</option>" }}".html_safe
+    end
+  end
+end

data/lib/scaffold_logic/helper.rb

@@ -0,0 +1,174 @@
+module ScaffoldLogic
+  module Helper
+    # Returns true if the current request's action matches the specified string or regular expression.
+    def action?( expression )
+      !! ( expression.class == Regexp ? controller.action_name =~ expression : controller.action_name == expression )
+    end
+
+    # Returns true if the current request's controller matches the specified string or regular expression.
+    def controller?( expression )
+      !! ( expression.class == Regexp ? controller.controller_name =~ expression : controller.controller_name == expression )
+    end
+
+    def meta_description(content=nil)
+      content_for(:meta_description) { content } unless content.blank?
+    end
+
+    def meta_keywords(content=nil)
+      content_for(:meta_keywords) { content } unless content.blank?
+    end
+
+    # Display admin links for standard CRUD actions. Action symbols follow the convention in
+    # routes.rb. The controller must be namespaced as Admin::MyController.
+    #
+    # Use in index views like this:
+    #
+    # <%- @models.each do |model| -%>
+    #   <td class="crud_links"><%= admin_crud_links(model, [:destroy, :edit]) -%></td>
+    # <%- end -%>
+    def admin_crud_links(model, actions)
+      crud_links_for_actions_and_paths actions.map{ |a| {a => eval((a == :destroy || a == :show) ? "admin_#{model.class.name.underscore}_path(model)" : "#{a.to_s}_admin_#{model.class.name.underscore}_path(model)") } }.inject({}) {|a, b| a.merge(b)}
+    end
+
+    # Display links for standard CRUD actions. Action symbols follow the convention in routes.rb.
+    #
+    # Use in index views like this:
+    #
+    # <%- @models.each do |model| -%>
+    #   <td class="crud_links"><%= crud_links(model, [:edit, :show]) -%></td>
+    # <%- end -%>
+    def crud_links(model, actions)
+      crud_links_for_actions_and_paths actions.map{ |a| {a => eval((a == :destroy || a == :show) ? "#{model.class.name.underscore}_path(model)" : "#{a.to_s}_#{model.class.name.underscore}_path(model)") } }.inject({}) {|a, b| a.merge(b)}
+    end
+
+    # Display links for the specified hash of CRUD actions and paths. Action symbols follow the
+    # convention in routes.rb.
+    #
+    # Use in index views like this:
+    #
+    # <td class="crud_links"><%= crud_links_for_actions_and_paths(:show => model_path) -%></td>
+    def crud_links_for_actions_and_paths(actions_and_paths)
+      _html = ''
+
+      [:show, :edit, :destroy].each do |action|
+        next unless actions_and_paths.key?(action)
+
+        if action == :show
+        _html << link_to(image_tag('icons/view.png', :class => 'crud_icon', :width => 14, :height => 14), actions_and_paths[action], :title => "View")
+        elsif action == :edit
+        _html << link_to(image_tag('icons/edit.png', :class => 'crud_icon', :width => 14, :height => 14), actions_and_paths[action], :title => "Edit")
+        elsif action == :destroy
+        _html << link_to(image_tag('icons/delete.png', :class => 'crud_icon', :width => 14, :height => 14), actions_and_paths[action], :confirm => 'Are you sure? This action cannot be undone.', :method => :delete, :title => "Delete")
+        end
+      end
+
+      _html.html_safe
+    end
+
+    # Returns a navigation link.
+    #
+    # Usage:
+    #   <ul>
+    #     <%= nav_link( root_path, 'Home', 'home' ) -%>
+    #   </ul>
+    def nav_link(url, link_text, id, options = {})
+      %{
+        <li id="#{id}" class="#{@active_tab == id || options[:active] ? 'here' : ''}" onclick="javascript:window.location='#{url}';">
+          <a href="#{url}" title="#{link_text}">#{link_text}</a>
+        </li>
+      }.html_safe
+    end
+
+    def nav_link_with_dropdowns(url, link_text, id, options = {}, &proc)
+      concat %{<li id="#{id}" class="#{@active_tab == id || options[:active] ? 'here' : ''}" onclick="javascript:window.location='#{url}';"><a href="#{url}" title="#{link_text}">#{link_text}</a>}.html_safe
+      yield
+      concat %{</li>}.html_safe
+      return ''
+    end
+
+    # Returns a link_to tag with sorting parameters that can be used with ActiveRecord.order_by.
+    #
+    # To use standard resources, specify the resources as a plural symbol:
+    #   sort_link(:users, 'email', params)
+    #
+    # To use resources aliased with :as (in routes.rb), specify the aliased route as a string.
+    #   sort_link('users_admin', 'email', params)
+    #
+    # You can override the link's label by adding a labels hash to your params in the controller:
+    #   params[:labels] = {'user_id' => 'User'}
+    def sort_link(model, field, params, html_options={})
+      if (field.to_sym == params[:by] || field == params[:by]) && params[:dir] == "asc"
+        classname = "arrow-asc"
+        dir = "desc"
+      elsif (field.to_sym == params[:by] || field == params[:by])
+        classname = "arrow-desc"
+        dir = "asc"
+      else
+        dir = "asc"
+      end
+
+      options = {
+        :anchor => html_options[:anchor],
+        :by => field,
+        :dir => dir,
+        :search => params[:search],
+        :category => params[:category],
+        :show => params[:show]
+      }
+
+      options[:show] = params[:show] unless params[:show].blank? || params[:show] == 'all'
+
+      html_options = {
+        :class => "#{classname} #{html_options[:class]}",
+        :style => "color: white; font-weight: #{params[:by] == field ? "bold" : "normal"}; #{html_options[:style]}",
+        :title => "Sort by this field"
+      }
+
+      field_name = params[:labels] && params[:labels][field] ? params[:labels][field] : field.titleize
+
+      _link = model.is_a?(Symbol) ? eval("#{model}_url(options)") : "/#{model}?#{options.to_params}"
+      link_to(field_name, _link, html_options)
+    end
+
+    # Returns a navigation link.
+    # <b>DEPRECATED:</b> Please use <tt>nav_link</tt> instead.
+    def tab_for(link, link_title, tab_name, options = {})
+      nav_link link, link_title, tab_name, options
+    end
+  end
+end
+
+class Hash
+  def to_params
+    params = ''
+    stack = []
+
+    each do |k, v|
+      next if v.blank?
+
+      if v.is_a?(Hash)
+        stack << [k,v]
+      elsif v.is_a?(Array)
+        v.each{|val| stack << ["#{k}[]",v]}
+      else
+        params << "#{k}=#{v}&"
+      end
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |k, v|
+        next if v.blank?
+
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          params << "#{parent}[#{k}]=#{v}&"
+        end
+      end
+    end
+
+    params.chop!
+    params
+  end
+
+end

data/lib/scaffold_logic/menu_helper.rb

@@ -0,0 +1,27 @@
+module ScaffoldLogic
+  module MenuHelper
+
+    # Returns an admin menu item.
+    #
+    # Usage:
+    #
+    # menu_item(
+    #   :heading => 'Reports',
+    #   :url     => admin_reports_path
+    # )
+    def menu_item(args)
+      raise ArgumentError, "Missing required values! You must pass a heading and url." unless args[:heading] && args[:url]
+      _id = args[:heading].downcase.gsub(/[^a-z]/, '_')
+      %{
+        <div class="menu_icon" id="#{_id}">
+          <h2><a href="#{args[:url]}" title="#{args[:heading]}">#{args[:heading]}</a></h2>
+          #{args[:description]}
+          <script type="text/javascript">
+            Event.observe($('#{_id}'), 'click', function (){ window.location = '#{args[:url]}'; });
+          </script>
+        </div>
+      }.html_safe
+    end
+
+  end
+end

data/lib/scaffold_logic/tab_interface_helper.rb

@@ -0,0 +1,125 @@
+module ScaffoldLogic
+  module TabInterfaceHelper
+    # Returns formatted tabs with appropriate JS for activation. Use in conjunction with tab_body.
+    #
+    # Usage:
+    #
+    #   <%- tabset do -%>
+    #     <%= tab_tag :id => 'ppc_ads', :label => 'PPC Ads', :state => 'active' %>
+    #     <%= tab_tag :id => 'budget' %>
+    #     <%= tab_tag :id => 'geotargeting' %>
+    #   <%- end -%>
+    #
+    def tabset(&block)
+      concat %{
+        <div class="jump_links">
+          <ul>
+      }.html_safe
+      yield
+      concat %{
+          </ul>
+        </div>
+        <br style="clear: both;" /><br />
+        <input type="hidden" id="show_tab" />
+        <script type="text/javascript">
+          function hide_all_tabs() { $$('.tab_block').invoke('hide'); }
+          function activate_tab(tab) {
+            $$('.tab_control').each(function(elem){ elem.className = 'tab_control'});
+            $('show_' + tab).className = 'tab_control active';
+            hide_all_tabs();
+            $(tab).toggle();
+            $('show_tab').value = tab
+          }
+          function sticky_tab() { if (location.hash) { activate_tab(location.hash.gsub('#','')); } }
+          Event.observe(window, 'load', function() { sticky_tab(); });
+        </script>
+      }.html_safe
+      return ''
+    end
+
+    # Returns a tab body corresponding to tabs in a tabset. Make sure that the id of the tab_body
+    # matches the id provided to the tab_tag in the tabset block.
+    #
+    # Usage:
+    #
+    #   <%- tab_body :id => 'ppc_ads', :label => 'PPC Ad Details' do -%>
+    #     PPC ads form here.
+    #   <%- end -%>
+    #
+    #   <%- tab_body :id => 'budget' do -%>
+    #     Budget form here.
+    #   <%- end -%>
+    #
+    #   <%- tab_body :id => 'geotargeting' do -%>
+    #     Geotargeting form here.
+    #   <%- end -%>
+    #
+    def tab_body(args, &proc)
+      concat %{<div id="#{args[:id]}" class="tab_block form_container" style="display: #{args[:display] || 'none'};">}.html_safe
+      concat %{#{legend_tag(args[:label] || args[:id].titleize, :help => args[:help] )}}.html_safe
+      concat %{<a name="#{args[:id]}"></a><br />}.html_safe
+      yield
+      concat %{</div>}.html_safe
+      return ''
+    end
+
+    # Returns the necessary HTML for a particular tab. Use inside a tabset block.
+    # Override the default tab label by specifying a :label parameter.
+    # Indicate that the tab should be active by setting its :state to 'active'.
+    # (NOTE: You must define a corresponding  CSS style for active tabs.)
+    #
+    # Usage:
+    #
+    #   <%= tab_tag :id => 'ppc_ads', :label => 'PPC Ads', :state => 'active' %>
+    #
+    def tab_tag(args, *css_class)
+      %{<li id="show_#{args[:id]}" class="tab_control #{args[:state]}" onclick="activate_tab('#{args[:id]}');"><a href="##{args[:id]}">#{args[:label] || args[:id].to_s.titleize}</a></li>}.html_safe
+    end
+
+    # Create a set of tags for displaying a field label with inline help.
+    # Field label text is appended with a ? icon, which responds to a click
+    # by showing or hiding the provided help text.
+    #
+    # Sample usage:
+    #
+    #   <%= tag_for_label_with_inline_help 'Relative Frequency', 'rel_frequency', 'Relative frequency of search traffic for this keyword across multiple search engines, as measured by WordTracker.' %>
+    #
+    # Yields:
+    #
+    #   <label for="rel_frequency">Relative Frequency: <%= image_tag "/images/help_icon.png", :onclick => "$('rel_frequency_help').toggle();", :class => 'inline_icon' %></label><br />
+    #   <div class="inline_help" id="rel_frequency_help" style="display: none;">
+    #     <p>Relative frequency of search traffic for this keyword across multiple search engines, as measured by WordTracker.</p>
+    #   </div>
+    def tag_for_label_with_inline_help( label_text, field_id, help_text )
+      _html = ""
+      _html << %{<label for="#{field_id}">#{label_text}}
+      _html << %{<img src="/images/icons/help_icon.png" onclick="$('#{field_id}_help').toggle();" class='inline_icon' />}
+      _html << %{</label><br />}
+      _html << %{<div class="inline_help" id="#{field_id}_help" style="display: none;">}
+      _html << %{<p>#{help_text}</p>}
+      _html << %{</div>}
+      _html
+    end
+
+    # Create a set of tags for displaying a field label followed by instructions.
+    # The instructions are displayed on a new line following the field label.
+    #
+    # Usage:
+    #
+    #   <%= tag_for_label_with_instructions 'Status', 'is_active', 'Only active widgets will be visible to the public.' %>
+    #
+    # Yields:
+    #
+    #   <label for="is_active">
+    #     Status<br />
+    #     <span class="instructions">Only active widgets will be visible to the public.</span>
+    #   <label><br />
+    def tag_for_label_with_instructions( label_text, field_id, instructions )
+      _html = ""
+      _html << %{<label for="#{field_id}">#{label_text}}
+      _html << %{<span class="instructions">#{instructions}</span>}
+      _html << %{</label><br />}
+      _html
+    end
+  end
+end