muck-engine 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,23 @@
+MuckEngine
+==========
+The muck engine is forms the basis for the muck framework and includes basic functionality utilized by the various muck engines.
+
+The easiest way to get started with muck is to generate your application using a template:
+  $ rails <your-app> -m http://github.com/jbasdf/rails-templates/raw/master/muck.rb
+
+Add optional functionality with the following command:
+  $ rake rails:template LOCATION=http://github.com/jbasdf/rails-templates/raw/master/mucktoo.rb
+
+Layout
+=======
+The muck template will build your basic application and construct all the needed files and configuration.
+
+If you build your own layout be sure to include the following script in your layout or the javascript in the system won't work:
+  <script type="text/javascript" language="JavaScript">
+    <%= yield :javascript %>
+  </script>
+
+
+
+
+Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the muck-engine plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the muck-engine plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MuckEngine'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "muck-engine"
+    gemspec.summary = "The base engine for the muck system.  Contains common tables, custom for, css and javascript."
+    gemspec.email = "justinball@gmail.com"
+    gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+    gemspec.description = "The base engine for the muck system.  Contains common tables, custom for, css and javascript."
+    gemspec.authors = ["Justin Ball"]
+    gemspec.files.include %w( lib/muck-engine.rb )
+    gemspec.rubyforge_project = 'muck-engine'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-engine/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

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

data/app/controllers/admin/muck/base_controller.rb

@@ -0,0 +1,24 @@
+class Admin::Muck::BaseController < ApplicationController
+
+  before_filter :login_required 
+  before_filter :admin_access?
+  
+  protected
+
+  def get_user
+    @user = current_user
+  end
+  
+  def authorized?
+    admin?
+  end
+
+  def permission_denied      
+    respond_to do |format|
+      format.html do
+        redirect_to home_path
+      end
+    end
+  end
+
+end

data/app/helpers/muck_custom_form_builder.rb

@@ -0,0 +1,186 @@
+class MuckCustomFormBuilder < ActionView::Helpers::FormBuilder
+
+  helpers = field_helpers +
+  %w(date_select datetime_select time_select collection_select) +
+  %w(select country_select time_zone_select) -
+  %w(hidden_field label fields_for)
+
+  helpers.each do |name|
+    define_method name do |field, *args|
+      options = args.detect {|argument| argument.is_a?(Hash)} || {}
+
+      render_field_template(name, field, options) do
+        super
+      end
+    end
+  end
+
+  def render_field_template(name, field, options)
+
+    tippable = !options[:tip].nil?
+
+    # used by country, state and other selects to specify a different id
+    field_id = options[:field_id]
+    
+    local_options = {
+      :extra_html   => options.delete(:extra_html),
+      :tip          => options.delete(:tip),
+      :tip_title    => options.delete(:tip_title),
+      :tip_key      => options.delete(:tip_key),
+      :tip_position => options.delete(:tip_position) || 'right',
+      :wrapper_id   => options.delete(:wrapper_id),
+      :pre_html     => options.delete(:pre_html),
+      :hide_required => options.delete(:hide_required),
+      :hide_control_error => options.delete(:hide_control_error),
+      :css_class    => options.delete(:css_class)
+    }
+
+    type = options.delete(:type)
+    type ||= :tippable if tippable
+
+    if !options[:label_class].nil?
+      label_options = { :class => options.delete(:label_class) }
+    else
+      label_options = { }
+    end
+
+    if local_options[:hide_required]
+      required = false
+      label_text = options[:label]
+    else
+      required = required_field?(field)
+      label_text = (options[:label] || field.to_s.camelize)
+      label_text = label_text + required_mark(field) if required
+    end
+    label_name = options.delete(:label)
+
+    is_checkbox = false
+    is_checkbox = true if %w(check_box).include?(name)
+
+    options[:class] ||= ''
+    options[:class] << add_space_to_css(options) + 'tip-field' if tippable
+    options[:class] << add_space_to_css(options) + "required-value" if required
+
+    if type == :choose_menu
+      options[:label_class] = 'desc'
+    end
+
+    locals = {
+      :field_element  => yield,
+      :field_name     => field_id || field_name(field),
+      :label_name     => options.delete(:required_label) || label_name || '',
+      :label_element  => label(field, label_text, label_options),
+      :is_checkbox    => is_checkbox,
+      :required       => required
+    }.merge(local_options)
+
+    if object.nil?
+      locals[:value] = ''
+      locals[:id] = ''      
+    else
+      locals[:value] = object.send(field)
+      locals[:id] = object.id
+    end
+
+    if has_errors_on?(field)
+      locals.merge!(:error => error_message(field, options))
+    end
+
+    @template.capture do
+
+      if type == :tippable              
+        @template.render :partial => 'forms/field_with_tips', :locals => locals
+      elsif type == :choose_menu
+        @template.render :partial => 'forms/menu_field', :locals => locals
+      elsif type == :color_picker
+        @template.render :partial => 'forms/color_picker_field', :locals => locals
+      elsif type == :default  
+        @template.render :partial => 'forms/default', :locals => locals
+      else
+        @template.render :partial => 'forms/field', :locals => locals
+      end
+    end
+  end
+
+  # creates a select control with states.  Default id is 'states'.  If 'retain' is passed for the class value the value of this
+  # control will be written into a cookie with the key 'states'.
+  def state_select(method, options = {}, html_options = {}, additional_state = nil)
+    country_id_field_name = options.delete(:country_id) || 'country_id'
+    country_id = get_instance_object_value(country_id_field_name)
+    @states = country_id.nil? ? [] : (additional_state ? [additional_state] : []) + State.find(:all, :conditions => ["country_id = ?", country_id], :order => "name asc")
+    self.menu_select(method, 'Choose State', @states, options.merge(:prompt => 'Please select a state', :wrapper_id => 'states-container'), html_options.merge(:id => 'states'))
+  end
+
+  # creates a select control with countries.  Default id is 'countries'.  If 'retain' is passed for the class value the value of this
+  # control will be written into a cookie with the key 'states'.
+  def country_select(method, options = {}, html_options = {}, additional_country = nil)
+    @countries ||= (additional_country ? [additional_country] : []) + Country.find(:all, :order => 'sort, name asc')
+    self.menu_select(method, 'Choose Country', @countries, options.merge(:prompt => 'Please select a country', :wrapper_id => 'countries-container'), html_options.merge(:id => 'countries'))
+  end
+
+  def get_instance_object_value(field_name)
+    obj = object || @template.instance_variable_get("@#{@object_name}")
+    obj.send(field_name) rescue nil
+  end
+
+  def menu_select(method, label, collection, options = {}, html_options = {})
+
+    # this code will look for a cookie that matches the control and set the value to the cookie value
+    # if html_options.has_key?(:class)
+    #     if html_options[:class].include?('retain')
+    #         id = html_options[:id]
+    #         @object.send("#{method}=", @template.cookies[id]) if @template.cookies.has_key? id
+    #     end
+    # end
+    if !options[:tip].nil?
+      html_options[:class] ||= ''
+      html_options[:class] << add_space_to_css(html_options) + 'tip-field'    
+    end
+    self.collection_select(method, collection, :id, :name, options.merge(:object => @object, :label => label, :type => :choose_menu, :label_class => 'desc', :field_id => html_options[:id]), html_options)
+  end
+
+  private
+
+  def add_space_to_css(options)
+    options[:class].empty? ? '' : ' '
+  end
+
+  def error_message(field, options)
+    if has_errors_on?(field)
+      errors = object.errors.on(field)
+      errors.is_a?(Array) ? errors.to_sentence : errors
+    else
+      ''
+    end
+  end
+
+  def has_errors_on?(field)
+    !(object.nil? || object.errors.on(field).blank?)
+  end
+
+  def field_name(field)
+    # TODO figure out if there is a built in method that does this.
+    "#{@object_name.to_s}_#{field.to_s}"
+  end
+
+  def required_mark(field)
+    required_field?(field) ? " <em id=\"#{field_name(field)}-label-required\">(required)</em>" : ''
+  end
+
+  def required_field?(field)
+    reflect_on = object.class if !object.blank?
+    if reflect_on.blank?
+      reflect_on = @object_name.to_s.camelize.constantize rescue nil
+    end
+    if !reflect_on.blank?
+      reflect_on.reflect_on_validations_for(field).map(&:macro).include?(:validates_presence_of)
+    else
+      false
+    end
+  end
+
+  def load_states
+    @states = State.find(:all, :order => "name" ).map {|u| [u.name, u.id] }
+  end
+
+end

data/app/helpers/muck_engine_helper.rb

@@ -0,0 +1,60 @@
+module MuckEngineHelper
+
+  def custom_form_for(record_or_name_or_array, *args, &proc) 
+    options = args.detect { |argument| argument.is_a?(Hash) } 
+    if options.nil? 
+      options = {:builder => MuckCustomFormBuilder} 
+      args << options 
+    end 
+    options[:builder] = MuckCustomFormBuilder unless options.nil? 
+    form_for(record_or_name_or_array, *args, &proc) 
+  end
+  
+  def output_errors(title, options = {}, fields = nil)
+    fields = [fields] unless fields.is_a?(Array)
+    flash_html = render(:partial => 'shared/flash_messages')
+    field_errors = render(:partial => 'shared/field_error', :collection => fields)
+    css_class = "class=\"#{options[:class]}\"" unless options[:class].nil?
+    
+    if !flash_html.empty? && field_errors.empty?
+      # only flash.  Don't render the 
+      render(:partial => 'shared/flash_error_box', :locals => {:flash_html => flash_html, :css_class => css_class})
+    elsif !field_errors.empty?
+      # field errors and/or flash
+      render(:partial => 'shared/error_box', :locals => {:title => title, 
+        :flash_html => flash_html, 
+        :field_errors => field_errors,
+        :css_class => css_class,
+        :extra_html => options[:extra_html]})
+    else
+      #nothing
+      ''
+    end
+  end
+
+  def error_styles
+    if GlobalConfig.growl_all_messages
+      ' style="display:none;" '
+    end
+  end
+  
+  def icon(object, size = :icon)
+    return "" if object.blank? || object.photo.blank?
+    link_to(image_tag(object.photo.url(size), :class => size), object, { :title => object.full_name })
+  end
+  
+  def secure_mail_to(email)
+    mail_to email, nil, :encode => 'javascript'
+  end
+  
+  # Used inside of format.js to return a message to the client.
+  # If jGrowl is enabled the message will show up as a growl instead of a popup
+  def page_alert(page, message, title = '')
+    if GlobalConfig.growl_enabled
+      page << "jQuery.jGrowl.error('" + message + "', {header:'" + title + "'});"
+    else
+      page.alert(message)
+    end
+  end
+  
+end

data/app/models/country.rb

@@ -0,0 +1,13 @@
+# == Schema Information
+#
+# Table name: countries
+#
+#  id           :integer(4)      not null, primary key
+#  name         :string(128)     default(""), not null
+#  abbreviation :string(3)       default(""), not null
+#  sort         :integer(4)      default(1000), not null
+#
+
+class Country < ActiveRecord::Base
+  
+end

data/app/models/language.rb

@@ -0,0 +1,3 @@
+class Language < ActiveRecord::Base
+  
+end

data/app/models/state.rb

@@ -0,0 +1,13 @@
+# == Schema Information
+#
+# Table name: states
+#
+#  id           :integer(4)      not null, primary key
+#  name         :string(128)     default(""), not null
+#  abbreviation :string(3)       default(""), not null
+#  country_id   :integer(8)      not null
+#
+
+class State < ActiveRecord::Base
+  belongs_to :country
+end

data/app/views/forms/_base_field.html.erb

@@ -0,0 +1,11 @@
+<%= pre_html %>
+<% if is_checkbox -%>
+	<%= field_element %>
+	<%= label_element %>
+<% else -%>
+	<%= label_element %>
+	<%= field_element %>
+<% end -%>
+<% if required -%><div id="<%= field_name %>_required" class="required-tip" style="display:none;"><em><%= I18n.t(:please_enter_a_value, :label => label_name, :scope => [:muck, :users, :forms, :_base_field]) %></em></div><% end -%>
+<% if !hide_control_error && defined? error -%><div class="form_error_message"><%= error %></div><% end -%>
+<%= extra_html %>

data/app/views/forms/_color_picker_field.html.erb

@@ -0,0 +1,27 @@
+<% color = value
+	 html_id = '_' + id.to_s + '_' + field_name %>
+<div <%= wrapper_id.nil? ? '' : "id=\"#{wrapper_id}\"" -%> class="form-row color-selector-container">
+	<%= render :partial => 'forms/base_field', :locals => local_assigns %>
+	<div id="colorSelector<%=html_id%>" class="color-selector">
+		<div id="colorSelectorDisplay<%=html_id%>" style="background-color:#<%=color%>;"></div>
+	</div>
+	<script type="text/javascript" language="JavaScript">
+	jQuery(document).ready(function() {
+		jQuery('#colorSelector<%=html_id%>').ColorPicker({
+			color: '#<%=color%>',
+			onShow: function (colpkr) {
+				jQuery(colpkr).fadeIn(100);
+				return false;
+			},
+			onHide: function (colpkr) {
+				jQuery(colpkr).fadeOut(100);
+				return false;
+			},
+			onChange: function (hsb, hex, rgb) {
+				jQuery('#colorSelectorDisplay<%=html_id%>').css('backgroundColor', '#' + hex);
+				jQuery('#<%=field_name%>').val(hex);
+			}
+		});		
+	});
+	</script>
+</div>