provideal-plugin-utils 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+nbproject
+pkg
+.DS_Store

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

@@ -0,0 +1,7 @@
+Provideal Plugin Utils
+======================
+
+A small collection of Rails plugin utilities to deal with assets
+bundled within Rails plugins/engines.
+
+Copyright (c) 2009 Provideal Systems GmbH, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "provideal-plugin-utils"
+    gemspec.summary = "A collection of Rails plugin utilities"
+    gemspec.email = "info@provideal.net"
+    gemspec.homepage = "http://github.com/provideal/plugin-utils/"
+    gemspec.authors = ["René Sprotte"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1 @@
+require 'provideal_plugin_utils'

data/lib/provideal_plugin_utils/asset_tag_helper.rb

@@ -0,0 +1,55 @@
+module Provideal
+  module PluginUtils
+    module AssetTagHelper
+      
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          [
+            :stylesheet_link_tag,
+            :javascript_include_tag,
+            :image_path,
+            :image_tag
+          ].each do |m|
+            alias_method_chain m, :plugin_support
+          end
+        end
+      end
+
+      def stylesheet_link_tag_with_plugin_support(*sources)
+        stylesheet_link_tag_without_plugin_support(*Provideal::PluginUtils::AssetTagHelper.pluginify_sources("stylesheets", *sources))
+      end
+
+      def javascript_include_tag_with_plugin_support(*sources)
+        javascript_include_tag_without_plugin_support(*Provideal::PluginUtils::AssetTagHelper.pluginify_sources("javascripts", *sources))
+      end
+
+      def image_path_with_plugin_support(source, options = {})
+        options.stringify_keys!
+        pluginified_source = Provideal::PluginUtils::AssetTagHelper.plugin_asset_path(options["plugin"], "images", source) if options["plugin"]
+        image_path_without_plugin_support(pluginified_source)
+      end
+
+      def image_tag_with_plugin_support(source, options = {})
+        options.stringify_keys!
+        if options["plugin"]
+          pluginified_source = Provideal::PluginUtils::AssetTagHelper.plugin_asset_path(options["plugin"], "images", source)
+          options.delete("plugin")
+        end
+        image_tag_without_plugin_support(pluginified_source, options)
+      end
+
+      def self.pluginify_sources(type, *sources)
+        options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
+        if options["plugin"]
+          sources.map! { |s| plugin_asset_path(options["plugin"], type, s) }
+          options.delete("plugin")
+        end
+        sources << options
+      end
+
+      def self.plugin_asset_path(plugin_name, type, asset)
+        "/plugins/#{plugin_name}/#{type}/#{asset}"
+      end
+    end
+  end
+end

data/lib/provideal_plugin_utils.rb

@@ -0,0 +1,56 @@
+module Provideal
+  module PluginUtils
+    class << self
+      #
+      # Installs your plugins' assets into the host
+      # application by linking public/plugins/[your_plugin] to
+      # your plugins' public folder.
+      #
+      # In your plugins' init.rb:
+      #
+      #   Provideal::PluginUtils.install_assets('your_plugin', 'path to your plugins' public folder')
+      #
+      # The host application may access the plugins' assets using Rails
+      # asset tag helpers together with the provided :plugin option.
+      #
+      # Example:
+      #
+      #   <%= javascript_include_tag 'foo.js', :plugin => 'your_plugin' %>
+      #
+      # This will create a proper link to '/plugins/your_plugin/javascripts/foo.js'.
+      #
+      def install_assets(plugin_name, target_path)
+        # Precheck conditions
+        raise "Plugin name required" unless plugin_name
+        raise "Target path required" unless target_path
+        raise "Taget does't exists"  unless File.exists?(target_path)
+
+        # Create the plugins base path inside the hosts public folder
+        plugins_public_base_path = "#{RAILS_ROOT}/public/plugins"
+        FileUtils.mkdir_p(plugins_public_base_path)
+
+        # The source path
+        source_path = "#{plugins_public_base_path}/#{plugin_name}"
+        
+        # Create the symlink if the source_path is not present
+        # This allows for manual overrides
+        unless File.exists?(source_path)
+          system "ln -s #{target_path} #{source_path}"
+        end
+      end
+
+      #
+      # Enables Rails extensions
+      #
+      def enable #:nodoc:
+        # enable our overriden asset helper
+        require 'provideal_plugin_utils/asset_tag_helper'
+        ::ActionView::Helpers::AssetTagHelper.send :include, Provideal::PluginUtils::AssetTagHelper
+      end
+    end
+  end
+end
+
+if defined?(Rails) and defined?(ActionController)
+  Provideal::PluginUtils.enable
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: provideal-plugin-utils
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Ren\xC3\xA9 Sprotte"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: info@provideal.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/provideal_plugin_utils.rb
+- lib/provideal_plugin_utils/asset_tag_helper.rb
+has_rdoc: true
+homepage: http://github.com/provideal/plugin-utils/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A collection of Rails plugin utilities
+test_files: []
+