nifty-utils 1.0.0

data/lib/nifty/utils.rb

@@ -0,0 +1,2 @@
+require 'nifty/utils/version'
+require 'nifty/utils/railtie' if defined?(Rails)

data/lib/nifty/utils/active_record.rb

@@ -0,0 +1,38 @@
+module Nifty
+  module Utils
+    module ActiveRecord
+      
+      #:nodoc:
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        
+        # Allows you to automatically create inquiry methods for string field. For example, if you have
+        # an Order model which has a status field containing 'approved' or 'delivered' you may wish to 
+        # have a #approved? or #delivered? method on the model. 
+        #
+        #   class Order < ActiveRecord::Baser
+        #     STATUSES = ['approved', 'delivered']
+        #     inquirer :status, *STATUSES
+        #   end
+        #
+        #   order = Order.new(:status => 'approved')
+        #   order.approved?       #=> true
+        #   order.delivered?      #=> false
+        # 
+        #     
+        def inquirer(field, *options)
+          options.each do |option|
+            define_method "#{option}?" do 
+              self.read_attribute(field).to_s == option.to_s
+            end
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/nifty/utils/railtie.rb

@@ -0,0 +1,23 @@
+module Nifty
+  module Utils
+    class Railtie < Rails::Railtie #:nodoc:
+      
+      initializer 'nifty.utils.initialize' do
+
+        # Load the Active Record extensions
+        ActiveSupport.on_load(:active_record) do
+          require 'nifty/utils/active_record'
+          ::ActiveRecord::Base.send :include, Nifty::Utils::ActiveRecord
+        end
+        
+        # load the Action View helpers
+        ActiveSupport.on_load(:action_view) do
+          require 'nifty/utils/view_helpers'
+          ActionView::Base.send :include, Nifty::Utils::ViewHelpers
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/nifty/utils/version.rb

@@ -0,0 +1,5 @@
+module Nifty
+  module Utils
+    VERSION = '1.0.0'
+  end
+end

data/lib/nifty/utils/view_helpers.rb

@@ -0,0 +1,52 @@
+module Nifty
+  module Utils
+    module ViewHelpers
+      
+      # Displays the full contents of the `flash` hash within an appropriate <div>
+      # element. The ID of the outputted div will be `flash-alert` where alert is the
+      # type of flash. 
+      #
+      # If there are multiple flashes set, they will all be displayed.
+      def display_flash
+        flashes = flash.collect do |key,msg|
+          content_tag :div, content_tag(:p, h(msg)), :id => "flash-#{key}"
+        end.join.html_safe
+      end
+      
+      # Renders an `<img>` containing a link to the gravatar for the given e-mail address.
+      # Available options as follows:
+      # 
+      # * <tt>:size</tt>: the size in pixels of the outputted gravatar. Defaults to 35.
+      # * <tt>:default</tt>: the gravatar to fallback to if the user has no gravatar
+      #   (see gravatar for available options or pass a URL). Defaults to 'identicon'.
+      # * <tt>:rating</tt>: the maximum rating to use. Defaults to PG.
+      # * <tt>:class</tt>: the value for the class attribute for the outputted img tag.
+      #   Defaults to 'gravatar'.
+      # * <tt>:secure</tt>: wherher or not to output an HTTPS version of the gravatar or not.
+      #   Defaults to the value of `request.ssl?`.
+      def gravatar(email, options = {})
+        options[:size]    ||= 35
+        options[:default] ||= 'identicon'
+        options[:rating]  ||= 'PG'
+        options[:class]   ||= 'gravatar'
+        options[:secure]  ||= request.ssl?
+        host = (options[:secure] ? 'https://secure.gravatar.com' : 'http://gravatar.com')
+        path = "/avatar.php?gravatar_id=#{Digest::MD5.hexdigest(email)}&rating=#{options[:rating]}&size=#{options[:size] * 2}&d=#{options[:default]}"
+        image_tag([host,path].join, :class => options[:class], :width => options[:size], :height => options[:size])
+      end
+      
+      # Renders a tick or cross character based on the provided boolean. Additional options
+      # can be passed if needed.
+      # 
+      # * <tt>:true_text</tt> - text to display next to a tick
+      # * <tt>:false_text</tt> - text to display next to a cross
+      def boolean_tag(bool, tip = nil, options = {})
+        true_text, false_text = "", ""
+        true_text = " <b>#{options[:true_text]}</b>" if options[:true_text]
+        false_text = " <b>#{options[:false_text]}</b>" if options[:false_text]
+        content_tag :span, (bool ? "<span class='true'>&#x2714;#{true_text}</span>" : "<span class='false'>&#x2718;#{false_text}</span>").html_safe, :class => "boolean", :title => tip
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: nifty-utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-26 00:00:00.000000000 Z
+dependencies: []
+description: A set of useful utilties for Rails applications
+email:
+- adam@niftyware.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nifty/utils/active_record.rb
+- lib/nifty/utils/railtie.rb
+- lib/nifty/utils/version.rb
+- lib/nifty/utils/view_helpers.rb
+- lib/nifty/utils.rb
+homepage: https://github.com/niftyware/utils
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A set of useful utilties for Rails applications
+test_files: []