provideal-plugin-utils 0.1.0 → 0.1.1

data/README

@@ -1,7 +1,53 @@
 Provideal Plugin Utils
 ======================
 
-A small collection of Rails plugin utilities to deal with assets
-bundled within Rails plugins/engines.
+A small collection of utilities to deal with assets bundled within Rails
+plugins/engines.
 
-Copyright (c) 2009 Provideal Systems GmbH, released under the MIT license
+The official homepgae is: http://github.com/provideal/provideal-plugin-utils
+
+It provides two things. First it provides a method to install assets bundled
+within a Rails plugin/engine into your host application (symlink into
+/public/plugins/my_plugin).
+
+Secondly it adds a :plugin option to Rails asset helper tags 'stylesheet_link_tag',
+'javascript_include_tag', 'image_path' and 'image_tag'.
+
+Example:
+
+Suppose you have a JavaScript file called foo.js bundled with your plugin 'my_plugin'.
+Using <%= javascript_include_tag 'foo.js', :plugin => 'my_plugin' %> will then create
+the correct uri to that asset.
+
+Installation
+------------
+
+sudo gem install provideal-plugin-utils -s http://gemcutter.org
+
+
+Usage
+-----
+
+* Install the gem
+* Make sure your plugins' assets are organized following Rails conventions
+  (images in public/images, stylesheets in public/stylesheets etc).
+* Trigger the installtion of your plugin assets with:
+
+    Provideal::PluginUtils.install_assets('my_plugin', 'path to your plugins public folder')
+
+  Example (called in init.rb):
+
+    Provideal::PluginUtils.install_assets('my_plugin', File.expand_path(File.join(File.dirname(__FILE__), 'public')))
+
+
+Known issues
+------------
+
+This version supports only symlinking the assets. As a result this version is
+not supported on Windows.
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Provideal Systems GmbH, released under the MIT license.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/provideal_plugin_utils.rb

@@ -19,26 +19,26 @@ module Provideal
       #
       # This will create a proper link to '/plugins/your_plugin/javascripts/foo.js'.
       #
-      def install_assets(plugin_name, target_path)
+      def install_assets(plugin_name, source_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)
+        raise "Source path required" unless source_path
+        raise "Source path does't exists" unless File.exists?(source_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)
+        # Target path
+        target_base_path = "#{RAILS_ROOT}/public/plugins"
+        FileUtils.mkdir_p(target_base_path) unless File.exists?(target_base_path)
+        target_path = "#{target_base_path}/#{plugin_name}"
 
-        # 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}"
+        # Only install if the target path does not
+        # exists
+        unless File.exists?(target_path)
+          File.symlink(source_path, target_path)
+        else
+          puts "Info: Assets for plugin #{plugin_name} exists. Skipping installation."
         end
       end
-
+      
       #
       # Enables Rails extensions
       #

data/provideal-plugin-utils.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{provideal-plugin-utils}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ren\303\251 Sprotte"]
+  s.date = %q{2009-09-17}
+  s.email = %q{info@provideal.net}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/provideal_plugin_utils.rb",
+     "lib/provideal_plugin_utils/asset_tag_helper.rb",
+     "provideal-plugin-utils.gemspec"
+  ]
+  s.homepage = %q{http://github.com/provideal/plugin-utils/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A collection of Rails plugin utilities}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: provideal-plugin-utils
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Ren\xC3\xA9 Sprotte"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 +02:00
+date: 2009-09-17 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ files:
 - init.rb
 - lib/provideal_plugin_utils.rb
 - lib/provideal_plugin_utils/asset_tag_helper.rb
+- provideal-plugin-utils.gemspec
 has_rdoc: true
 homepage: http://github.com/provideal/plugin-utils/
 licenses: []