muck-engine 0.4.34 → 3.0.3

data/app/views/shared/_growl.erb

@@ -1,4 +1,4 @@
-<% if GlobalConfig.growl_enabled -%>
+<% if MuckEngine.configuration.growl_enabled -%>
   <script type="text/javascript">
   jQuery(document).ready(function() {
     jQuery('#errorExplanation').hide();

data/{locales → config/locales}/en.yml

@@ -2,7 +2,7 @@
 en: 
   muck: 
     forms: 
-      please_enter_a_value: Please enter a value for {{label}}
+      please_enter_a_value: Please enter a value for %{label}
     engine: 
       required_text_mark: (required)
       choose_state: Choose State
@@ -16,7 +16,7 @@ en:
       admin_roles: Roles
       admin_access_codes: Access Codes
       admin_home: Home
-      admin_welcome: Welcome back {{user}}
+      admin_welcome: Welcome back %{user}
       admin_home_title: Admin Home
       select_language_prompt: Please select a language
     general: 
@@ -26,7 +26,7 @@ en:
       help: Help
       delete: Delete
       settings_saved: Settings have been saved.
-      time_ago: "{{time_in_words}} ago"
+      time_ago: "%{time_in_words} ago"
       enabled: Enabled?
       enable: Disable
       yes_text: "Yes"

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  match 'load_states_for_country/:id.:format' => 'muck/helper#load_states_for_country'
+  match '/admin' => 'admin/muck/default#index', :as => :admin
+end

data/lib/muck-engine.rb

@@ -0,0 +1,22 @@
+require 'will_paginate'
+require 'validation_reflection'
+require 'overlord'
+
+require 'muck-engine/config'
+require 'muck-engine/flash_errors'
+require 'muck-engine/json'
+require 'muck-engine/form_builder'
+require 'muck-engine/models/country'
+require 'muck-engine/models/language'
+require 'muck-engine/models/state'
+require 'muck-engine/models/general'
+require 'muck-engine/mailers/general'
+require 'muck-engine/controllers/application'
+require 'muck-engine/controllers/ssl_requirement'
+require 'muck-engine/engine'
+
+# Use to determine whether or not ssl should be used
+def muck_routes_protocol
+  #@@routes_protocol ||= 'http' if local_request?
+  @@routes_protocol ||= MuckEngine.configuration.enable_ssl ? (ENV["RAILS_ENV"] =~ /(development|test)/ ? "http" : "https") : 'http'
+end

data/lib/muck-engine/config.rb

@@ -0,0 +1,106 @@
+require 'ostruct'
+
+module MuckEngine
+  
+  def self.configuration
+    # In case the user doesn't setup a configure block we can always return default settings:
+    @configuration ||= Configuration.new
+  end
+  
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    
+    # Global application values.  These are used to display the app name, send emails, and configure where system emails go.
+    attr_accessor :application_url          # Url of your application
+    attr_accessor :application_name         # Common name for your application.  i.e. My App, Billy Bob, etc
+    attr_accessor :from_email               # Emails will come from this address i.e. noreply@example.com, support@example.com, system@example.com, etc
+    attr_accessor :from_email_name          # This will show up as the name on emails.  i.e. support@example.com <Example>
+    attr_accessor :support_email            # Support email for your application.  This is used for contact us etc.
+    attr_accessor :admin_email              # Admin email for your application
+    attr_accessor :customer_service_number  # Phone number if you have one (optional)
+    attr_accessor :mail_charset             # Email charset.  No need to change this unless you have a good reason to change the encoding.
+    attr_accessor :enable_ssl               # Enable ssl if you have an ssl certificate installed.  This will provide security between the client and server.
+    
+    # Application configuration
+    attr_accessor :local_jquery             # If true jquery will be loaded from the local directory. If false then it will be loaded from Google's CDN
+    attr_accessor :growl_enabled            # If true then notifications and errors will popup in an overlay div similar to 'growl' on the mac. This uses jGrowl which must be included in your layout
+    
+    # Email server configuration
+    attr_accessor :email_server_address     # Email server address.  'smtp.sendgrid.net' works for sendgrid - https://sendgrid.com/user/signup
+    attr_accessor :email_user_name          # Email server username
+    attr_accessor :email_password           # Email server password
+    attr_accessor :base_domain              # Basedomain that emails will come from
+
+    # Google Analtyics Configuration.  This will enable Google Analytics on your site and will be used if your template includes:
+    #                                  <%= render :partial => 'layouts/global/google_analytics' %>
+    attr_accessor :google_tracking_code       # Get a tracking code here: http://www.google.com/analytics/. The codes look like this: 'UA-9685000-0'
+    attr_accessor :google_tracking_set_domain # Base domain provided to Google Analytics. Useful if you are using subdomains but want all traffic 
+                                              # recorded into one account.
+
+    attr_accessor :required_text_mark       # Value to show to indicate a field is required. Default is '*'
+    def muck_admin_nav_items
+      @@muck_admin_nav_items ||= []
+    end
+
+    # Add an item to the main admin navigation menu
+    # Paramters:
+    # name:                 Name for the link
+    # path:                 Url to link to
+    # image:                Image for the link
+    def add_muck_admin_nav_item(name, path, image = '')
+      muck_admin_nav_items << OpenStruct.new(:name => name,
+                                             :path => path,
+                                             :image => image)
+    end
+
+
+    def muck_dashboard_items
+      @@muck_dashboard_items ||= []
+    end
+
+    # Add an item to the admin dashboard
+    # path:   Path to the partial
+    # locals: Hash of values to pass as locals to the partial
+    def add_muck_dashboard_item(path, locals = {})
+      muck_dashboard_items << OpenStruct.new(:path => path,
+                                             :locals => locals)
+    end
+
+    def muck_admin_css
+      @@muck_admin_css ||= [] 
+    end
+
+    # Add css for the admin UI
+    def add_muck_admin_css(css_file)
+      muck_admin_css << css_file
+    end
+      
+    def initialize
+      self.application_url = 'localhost:3000' 
+      self.application_name = 'My App'
+      self.from_email = 'support@example.com'
+      self.from_email_name = 'Example App'
+      self.support_email = 'support@example.com'
+      self.admin_email = 'admin@example.com'
+      self.customer_service_number = '1-800-'
+      self.mail_charset = 'utf-8'
+      self.email_server_address = "smtp.sendgrid.net"
+      self.email_user_name = 'admin@example.com'
+      self.email_password = 'password'
+      self.base_domain = 'example.com'
+      self.enable_ssl = false
+      self.growl_enabled = false
+      self.local_jquery = false
+      self.required_text_mark = '*'
+      
+      self.google_tracking_code = ""
+      self.google_tracking_set_domain = "example.com"
+      
+    end
+    
+  end
+end

data/lib/{action_controller/muck_application.rb → muck-engine/controllers/application.rb}

@@ -1,13 +1,15 @@
-module ActionController
+module MuckEngine
+  module Application
     
-  module MuckApplication
+    extend ActiveSupport::Concern
     
-    module ClassMethods
-
-    end
-
-    module InstanceMethods
-      protected
+    protected
+      
+      # called by Admin::Muck::BaseController to check whether or not the
+      # user should have access to the admin UI
+      def admin_access?
+        access_denied unless admin?
+      end
       
       # Detect the iphone.  Just call this method in a before filter:
       #    before_filter :adjust_format_for_iphone
@@ -94,7 +96,7 @@ module ActionController
       def setup_paging
         @page = (params[:page] || 1).to_i
         @page = 1 if @page < 1
-        @per_page = (params[:per_page] || (RAILS_ENV=='test' ? 1 : 40)).to_i
+        @per_page = (params[:per_page] || (::Rails.env=='test' ? 1 : 40)).to_i
       end
 
       def set_will_paginate_string
@@ -111,18 +113,9 @@ module ActionController
       def send_form_email(params, subject)
         body = []
         params.each_pair { |k,v| body << "#{k}: #{v}"  }
-        BasicMailer.deliver_mail(:subject => subject, :body => body.join("\n"))
-      end
-      
-      # render methods
-      def render_as_html
-        last_template_format = @template.template_format
-        @template.template_format = :html
-        result = yield
-        @template.template_format = last_template_format
-        result
+        BasicMailer.mail(:subject => subject, :body => body.join("\n")).deliver
       end
-      
+            
       # **********************************************
       # Parent methods
       
@@ -193,16 +186,6 @@ module ActionController
         end
         nil
       end
-      
-    end
-
-    def self.included(receiver)
-      receiver.extend ClassMethods
-      receiver.class_eval do
-        include InstanceMethods
-      end
-    end
 
   end
-
 end

data/lib/muck-engine/controllers/ssl_requirement.rb

@@ -0,0 +1,52 @@
+# Code adapted from http://github.com/rails/ssl_requirement 
+module MuckEngine
+  module SslRequirement
+    
+    extend ActiveSupport::Concern
+    
+    included do
+      before_filter :ensure_proper_protocol
+    end
+    
+    module ClassMethods
+      # Specifies that the named actions requires an SSL connection to be performed (which is enforced by ensure_proper_protocol).
+      def ssl_required(*actions)
+        write_inheritable_array(:ssl_required_actions, actions)
+      end
+
+      def ssl_allowed(*actions)
+        write_inheritable_array(:ssl_allowed_actions, actions)
+      end
+    end
+    
+    protected
+      # Only require ssl if we are in production
+      def ssl_required?
+        return ENV['SSL'] == 'on' ? true : false if defined? ENV['SSL']
+        return false if local_request?
+        return false if RAILS_ENV == 'test'
+        ((self.class.read_inheritable_attribute(:ssl_required_actions) || []).include?(action_name.to_sym)) && (::Rails.env == 'production' || ::Rails.env == 'staging')
+      end
+      
+
+      def ssl_allowed?
+        (self.class.read_inheritable_attribute(:ssl_allowed_actions) || []).include?(action_name.to_sym)
+      end
+
+    private
+      def ensure_proper_protocol
+        return true if ssl_allowed?
+
+        if ssl_required? && !request.ssl?
+          redirect_to "https://" + request.host + request.fullpath
+          flash.keep
+          return false
+        elsif request.ssl? && !ssl_required?
+          redirect_to "http://" + request.host + request.fullpath
+          flash.keep
+          return false
+        end
+      end
+    
+  end
+end

data/lib/muck-engine/engine.rb

@@ -0,0 +1,60 @@
+require 'muck-engine'
+require 'rails'
+
+module MuckEngine
+  class Engine < ::Rails::Engine
+    
+    def muck_name
+      'muck-engine'
+    end
+    
+    initializer 'muck-engine.mime_types' do |app|
+      Mime::Type.register "application/rdf+xml", :rdf
+      Mime::Type.register "text/xml", :opml
+      Mime::Type.register "text/javascript", :pjs
+      Mime::Type.register_alias "text/html", :iphone
+    end
+          
+    initializer 'muck-engine.controllers' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include MuckEngine::Application
+        include MuckEngine::SslRequirement
+        include MuckEngine::FlashErrors
+      end
+    end
+    
+    initializer 'muck-engine.helpers' do |app|
+      ActiveSupport.on_load(:action_view) do
+        include MuckEngineHelper
+        include MuckAdminHelper
+        include MuckEngine::FlashErrors
+      end
+    end
+    
+    initializer 'muck-engine.models' do |app|
+      ActiveSupport.on_load(:active_record) do
+        include MuckEngine::General
+      end
+    end
+    
+    initializer 'muck-engine.mailer' do |app|
+      ActiveSupport.on_load(:action_mailer) do
+        include MuckEngine::Mailers::General
+      end
+    end
+   
+    initializer 'muck-engine.i18n' do |app|
+      ActiveSupport.on_load(:i18n) do
+        I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', '..', 'config', 'locales', '*.{rb,yml}') ]
+        I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', '..', 'rails_i18n', '*.{rb,yml}') ]
+      end
+    end
+    
+    initializer 'muck-engine.add_admin_ui_links', :after => :add_locales do
+      # Add a link to admin home
+      #MuckEngine.add_muck_admin_nav_item(I18n.translate('muck.engine.admin_home'), '/admin', '/images/admin/home.gif')
+      MuckEngine.configuration.add_muck_admin_nav_item(I18n.translate('muck.engine.admin_home'), '/admin')
+    end
+        
+  end
+end