motr 0.0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3-ruby"
+gem "rspec-rails"
+gem "mocha","0.9.12"
+
+group :test do
+  gem 'spork', '~> 0.9.0.rc'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Brent Kirby / kurb media, 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,26 @@
+= Motr
+
+{Official Documentation}[http://rubydoc.info/github/kurbmedia/motr/master/frames]
+
+Motr is a basic Rails engine which adds additional functionality to your applications. The {core Motr}[http://github.com/kurbmedia/motr] engine 
+provides a number of helpers and functionality geared towards bringing the ease of Rails back-end development, to the front-end.
+
+Rails view helpers and form builders are convenient an easy to use, however some aren't very design/html friendly (whose idea was it to 
+wrap fields with errors in a div?). The goal is to keep html valid and sensible where possible, and make things like javascript integration 
+easier and more efficient.
+
+Additional documentation will be provided shortly, as a few final methods are added. For now check out the 
+documentation provided at {rubydoc.info}[http://rubydoc.info/github/kurbmedia/motr/master/frames].
+
+== Contributing
+
+Motr is maintained and funded by {kurb media}[http://kurbmedia.com/], and was designed for our own internal use, so (like Rails itself), it is
+opinionated in how it works. However, additions / enhancements / alternative methods are more than welcome and encouraged. We also welcome 
+feature requests, especially from designers/front-end developers who spend a lot of time working along-side Rails developers.
+
+== License
+
+Motr is Copyright © 2010-2011 kurb media, llc.
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file. Donations in the form of beer, cash, or 
+1980's movie memorabilia are welcomed (and encouraged!).
+

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'motr'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+desc "Run watchr"
+task :watchr do
+  `watchr .watchr`
+end

data/app/helpers/motr_helper.rb

@@ -0,0 +1,7 @@
+module MotrHelper #:nodoc:
+
+  include Motr::Helpers::LayoutHelpers
+  include Motr::Helpers::Navigation
+  include Motr::Forms::Helpers
+  
+end

data/lib/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  motr:
+    errors:

data/lib/motr.rb

@@ -0,0 +1,20 @@
+require 'rails'
+require 'active_support/dependencies'
+require 'set'
+
+module Motr
+  
+  module Helpers
+    autoload :LayoutHelpers, 'motr/helpers/layout_helpers'
+    autoload :Navigation,    'motr/helpers/navigation'
+  end
+  
+  module Errors
+    autoload :MotrError,      'motr/errors/motr_error'
+    autoload :InvalidOptions, 'motr/errors/invalid_options'
+  end
+
+end
+
+require 'motr/forms'
+require 'motr/rails'

data/lib/motr/errors/invalid_options.rb

@@ -0,0 +1,13 @@
+module Motr #:nodoc
+  module Errors #:nodoc
+
+    ##
+    # Raised when invalid options/arguments are passed to a constructor or method
+    # @param (see Motr#Errors#MotrError)
+    # 
+    # 
+    # 
+    class InvalidOptions < MotrError
+    end
+  end
+end

data/lib/motr/errors/motr_error.rb

@@ -0,0 +1,19 @@
+module Motr #:nodoc
+  module Errors #:nodoc
+
+    # Default parent Motr error for all custom errors. This handles the base
+    # key for the translations and provides the convenience method for
+    # translating the messages.
+    class MotrError < StandardError
+      BASE_KEY = "motr.errors"
+      ##
+      # Translate an error message
+      # @param [String] key The i18n message key
+      # @param [Hash] options Options to pass to the i18n library
+      # 
+      def translate(key, options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+      end
+    end
+  end
+end

data/lib/motr/forms.rb

@@ -0,0 +1,31 @@
+module Motr
+  
+  module Forms
+    
+    autoload :Base,    'motr/forms/base'
+    autoload :Helpers, 'motr/forms/helpers'
+    autoload :Builder, 'motr/forms/builder'
+    
+    # The class to be applied to the wrapper that wraps the entire field
+    mattr_accessor :error_class
+    @@error_class = 'field_with_errors'
+    
+    # The class to be applied to the error message element
+    mattr_accessor :message_error_class
+    @@message_error_class = 'errors_for_field'
+    
+    # An ERB template to be used when rendering a field with errors
+    mattr_accessor :error_template
+    @@error_template = %{
+          <span class="<%= error_class %>">
+               <%= html_tag %>
+               <span class="<%= message_error_class %>"><%= [messages].flatten.join(",") %></span>
+          </span>}
+          
+    # Setup the default form builder
+    mattr_accessor :default_builder
+    @@default_builder = Motr::Forms::Builder
+    
+  end
+  
+end

data/lib/motr/forms/base.rb

@@ -0,0 +1,18 @@
+module Motr
+  
+  module Forms
+    
+    class Base < ActionView::Helpers::FormBuilder
+      
+      def render_field_with_errors(html_tag, messages)        
+        error_class         = Motr::Forms.error_class
+        message_error_class = Motr::Forms.message_error_class
+        render_binding      = binding
+        renderer            = ERB.new(Motr::Forms.error_template)        
+        renderer.result(render_binding).to_s.html_safe
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/forms/builder.rb

@@ -0,0 +1,28 @@
+module Motr
+  
+  module Forms
+    ##
+    # 
+    # Default Motr form builder. Extends the passed input tags to include additional 
+    # html attributes, primarily for javascript integration.
+    #
+    class Builder < Motr::Forms::Base
+      
+      # Access the template object
+      attr_accessor :template
+      # Tracks the order in which fields are used in the form, this allows the easy rebuilding of the submitted form
+      # data when submitted since normally the hash isn't ordered.
+      attr_accessor :field_order
+      
+      private
+      
+      # Convenience method to use the +content_tag+ method from our template
+      # 
+      def content_tag(tag, content, options = {}, escape = true, &block) #:nodoc:
+        @template.content_tag(tag, content, options, escape, &block)
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/forms/helpers.rb

@@ -0,0 +1,30 @@
+module Motr
+  module Forms
+    ##
+    # 
+    # # Custom form helpers and modifications
+    #
+    module Helpers
+      
+      ##
+      # 
+      # Cusomizes the default form_for helper to add additional functionality
+      # (see ActionView::Helpers::FormHelper for more information)
+      # 
+      # @option options [Boolean] :validate Adds a data-validatable attribute to the form for javascript hooks
+      # 
+      def motr_form(record, options = {}, &block)
+       
+        raise ArgumentError, "Missing block" unless block_given?
+        
+        options.reverse_merge!(:builder => Motr::Forms.default_builder)
+        options[:html] ||= {}
+        options[:html].merge!('data-validatable' => true) if options.delete(:validate)
+        form_for(record, options, &block)
+                
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/helpers/layout_helpers.rb

@@ -0,0 +1,153 @@
+module Motr
+  module Helpers
+    ##
+    # 
+    # # Convenience helpers generally used in layout files
+    # 
+    module LayoutHelpers
+      
+      ##
+      # Include javascript libraries from local and external resources. 
+      # This method extends +javascript_include_tag+ to support loading libraries from sources
+      # such as Google's CDN, or javascripts packaged by motr
+      # 
+      # When loading libraries from Google CDN, uncompressed versions will be used in any environment
+      # besides production. In production environments, minified versions will be used.
+      # 
+      # @param [Array] *args An argument list containing a the libraries to load, and any load options
+      # @return [String]  A javscript "script" tag
+      # @example
+      #   include_javascripts(:jquery => '5.0', :source => :google) #=> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.0/jquery.min.js"...
+      # 
+      def include_javascripts(*args)
+        
+        options = args.extract_options!
+        source  = options.delete(:source)
+        cache   = options.delete(:cache) || false
+
+        if !source.nil? && source.to_s.match(/google/i) && !args.empty?
+          raise Motr::Errors::InvalidOptions.new("When using Google as a :source, all arguments must be in the hash format { :library => :version }.") 
+        elsif source.nil? && args.empty? && !options.empty?
+          raise Motr::Errors::InvalidOptions.new("Missing :source attribute for `include_javascripts`. When passing a library/version hash as an argument, a source (cdn) is required.")
+        end
+        
+        response = ""
+        
+        unless source.nil?
+          options.stringify_keys!.each do |lib| 
+            response << javascript_include_tag(js_load_path(*lib), :cache => false)
+          end          
+        end        
+        response << javascript_include_tag(*args.map(&:to_s), :cache => cache)
+                
+      end
+      
+      ##
+      # 
+      # Allows easy assigning of meta tags from templates
+      # @param [Symbol] name Name of the meta tag (ie: keywords / description)
+      # @param [String] content The content to be used in the meta tag
+      # @return [String] A html meta tag with the name and content attributes set
+      # 
+      def meta_tag(name, content = nil)
+        return _retrieve_variable(:"__#{name}") if content.nil?
+        content = tag(:meta, :name => name, :content => content)
+        _create_variable(:"__#{name}", content, false)
+        content
+      end
+      
+      ##
+      # 
+      # Creates a page id to be used for identifying a page for CSS/design purposes. If a variable
+      # is defined, it will be used. If not, one will be generated from the current controller/action.
+      # 
+      # @param [String] content The string to be used as the page id.
+      # @return [String] The assigned page id
+      # @example Create a page_id and use it in the body tag
+      #   <%= page_id('home') %>
+      #   
+      #   <body id="<%= page_id %>"> #=> <body id="home">
+      # 
+      # @example Defaulting page id to controller/action
+      #   # IndexController#home
+      #   <body id="<%= page_id %>"> #=> <body id="index_home">
+      # 
+      # 
+      def page_id(content = nil)
+        _create_variable(:__page_id, content, false) and return unless content.nil?
+        return _retrieve_variable(:__page_id) if content_for?(:__page_id)
+        cname = controller.class.to_s.gsub(/controller$/i,'').underscore.split("/").join('_')
+        aname = controller.action_name
+        "#{cname}_#{aname}"
+      end
+      
+      ##
+      # 
+      # Convenience method for content_for allowing for single-line variable creation. Also defines a method that can be
+      # re-used within a template.
+      # 
+      # @param [Symbol] var_name The name of the variable to create
+      # @param [String] content The content that variable defines
+      # @return [String] An empty string. Use the newly created method from +var_name+ to return the value
+      # 
+      # @example Setting a "page_class" variable
+      #   <% set_var(:page_class, 'cool') %>
+      #   <%= page_class %> #=> 'cool'
+      #
+      #  
+      def set_var(var_name, content)
+        _create_variable("#{var_name}", content) and return ''
+      end
+      
+      ##
+      # 
+      # Configures a "robots" meta tag based on the rails environment. In environments other than 'production'
+      # it sets the value to "noindex, nofollow" for each page that uses the layout in which it is called. This
+      # helps prevent spiders from crawling / indexing content when used on staging sites.
+      # 
+      # @return [String] A html meta tag for "robots" with the appropriate content attribute set
+      # 
+      def robot_meta_tag
+        tag(:meta, :name => 'robots', :content => (Rails.env.eql?('production') ? 'index, follow' : 'noindex, nofollow'))
+      end
+      
+      private
+      
+      def _create_variable(var, content, create_method = true) #:nodoc:
+        content_for(var.to_sym) do
+          content
+        end
+        return '' unless create_method
+        class_eval <<-MAKE_VAR, __FILE__, __LINE__ + 1
+          def #{var}
+            content_for(:#{var})
+          end
+          public :#{var}
+        MAKE_VAR
+      end
+            
+      def js_load_path(libname, version) #:nodoc:
+        # 
+        # @todo Make this considerably cleaner and more flexible
+        #   possibly use google's cdn loader directly
+        #
+        minify       = Rails.env.eql?('production') ? "min." : ""
+        google_base  = "https://ajax.googleapis.com/ajax/libs/%s/%s/%s"
+        jqtools_base = "http://cdn.jquerytools.org/%s/all/jquery.tools.min.js"
+        
+        return jqtools_base % (version || "1.2.5") if libname.downcase == "jquerytools"
+        
+        filename = libname.match(/jqueryui/i) ? "jquery-ui" : libname
+        google_base % [libname, version, "#{filename}.#{minify}js"]
+        
+      end
+      
+      def _retrieve_variable(var) #:nodoc:
+        (content_for?(var.to_sym) ? content_for(var.to_sym) : "")
+      end
+      
+    end
+    
+    
+  end
+end

data/lib/motr/helpers/navigation.rb

@@ -0,0 +1,104 @@
+module Motr
+  module Helpers
+    ##
+    # 
+    # Convenience helpers for building navigation lists, and defining 'on' states.
+    #
+    module Navigation
+      
+      ##
+      # 
+      # Creates a link wrapped in a list item, to be used within a list-based navigation.
+      # 
+      # @param [String] text The text used within the link
+      # @param [String] path The url used as the link's +href+ attribute
+      # @param [Hash] attrs Hash of attributes to be applied to the link. This format is the same as Rail's +link_to+ helper
+      # @option attrs [String] :active_class The class to use if this link is 'active'. Defaults to "on"
+      # @option attrs [Proc] :proc A callback which, when called, determines the active state of the link
+      # @option attrs [Regex] :matcher A regular expression to be matched against +path+
+      # @param [Symbol] wrapper The html tag to be used as the wrapper. Defaults to +:li+
+      # 
+      # @example Create a list item link to any page
+      #   nav_link_to('Home Page', '/home') #=> <li><a href="/home">Home Page</a>
+      # 
+      # @example 'Active state' functionality for the current page
+      #   nav_link_to('Current Page', '/current_url') #=> <li class="on"><a href="/current_url" class="on">Current Page</a></li>
+      # 
+      def nav_link_to(text, path, attrs = {}, wrapper = :li)
+        
+        link_attrs    = update_link_attrs(path, attrs)
+        wrapper_attrs = link_attrs.delete(:wrapper)      
+        content_tag(wrapper, link_to(text, path, link_attrs), wrapper_attrs)
+        
+      end
+      
+      alias :nav_link :nav_link_to
+      
+      ##
+      # 
+      # Creates a navigational list format, including a parent list / wrapper. Useful for nested list navigation
+      # @param [String] text The text used within the link
+      # @param [String] path The url used as the link's +href+ attribute
+      # @param [Hash] attrs Hash of attributes to be applied to the link. This format is the same as Rail's +link_to+ helper
+      # @option attrs [String] :active_class The class to use if this link is 'active'. Defaults to "on"
+      # @option attrs [Proc] :proc A callback which, when called, determines the active state of the link
+      # @option attrs [Regex] :matcher A regular expression to be matched against +path+
+      # @param [Symbol] wrapper The html tag to be used as the wrapper. Defaults to +:li+
+      # @param [Symbol] container The element that will be used as a container for the nested list
+      # @param [Block] &block A block containing the content of the nested items
+      # 
+      # @example Create a nested list navigation
+      #   navigation('Home Page', '/home') do
+      #     nav_link_to('Sub Page', '/about')
+      #   end
+      # @example
+      #   <li><a href="/home">Home Page</a>
+      #     <ol>
+      #         <li><a href="/about">Sub Page</a></li>
+      #     </ol>
+      #   </li>
+      # 
+      def navigation(text, path, attrs = {}, wrapper = :li, container = :ol, &block)
+
+        wrapper_attrs = attrs.delete(:wrapper)        
+        parent_link   = nav_link_to(text, path, attrs)
+        child_links   = content_tag(container, capture(&block), wrapper_attrs)
+        link_attrs    = update_link_attrs(path, attrs.merge(:wrapper => (attrs.delete(:item) || {}) ))
+
+        content_tag(wrapper, (parent_link << child_links), wrapper_attrs)
+        
+      end
+      
+      private
+      
+      def update_link_attrs(path, attrs)
+        
+        proc          = attrs.delete(:proc)
+        regex         = attrs.delete(:matcher)
+        klasses       = attrs.delete(:class).try(:split, ' ')
+        on_class      = attrs.delete(:active_class) || "on"
+        wrapper_attrs = attrs.delete(:wrapper) || {}
+        wklasses      = wrapper_attrs[:class].try(:split, ' ')
+        
+        klasses  ||= []
+        wklasses ||= []
+        
+        if proc && proc.call(path)
+          klasses  << on_class
+          wklasses << on_class
+        elsif regex && path.match(regex)
+          klasses  << on_class
+          wklasses << on_class
+        end
+        
+        attrs.merge!(:class => klasses.join(" ")) unless klasses.compact.empty?
+        wrapper_attrs.merge!(:class => wklasses.join(" ")) unless wklasses.compact.empty?
+        
+        attrs.merge!(:wrapper => wrapper_attrs)
+                
+      end
+            
+    end
+    
+  end
+end

data/lib/motr/rails.rb

@@ -0,0 +1,10 @@
+module Motr
+  class Engine < ::Rails::Engine    
+    config.motr = Motr    
+    
+    initializer :after_initialize do
+      ActionView::Base.send :default_form_builder=, Motr::Forms.default_builder
+    end
+    
+  end
+end

data/lib/motr/version.rb

@@ -0,0 +1,3 @@
+module Motr
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: motr
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brent Kirby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: motr is a Rails engine aimed at simplifying routine development. The core motr engine includes various helpers, utilities, and modifications to rails core.
+email: 
+- dev@kurbmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/helpers/motr_helper.rb
+- lib/config/locales/en.yml
+- lib/motr/errors/invalid_options.rb
+- lib/motr/errors/motr_error.rb
+- lib/motr/forms/base.rb
+- lib/motr/forms/builder.rb
+- lib/motr/forms/helpers.rb
+- lib/motr/forms.rb
+- lib/motr/helpers/layout_helpers.rb
+- lib/motr/helpers/navigation.rb
+- lib/motr/rails.rb
+- lib/motr/version.rb
+- lib/motr.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/kurbmedia/motr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1164898289255422466
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: motr
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: motr is a Rails engine aimed at simplifying routine development
+test_files: []
+