asset_copier_generator 0.5

data/CHANGELOG

@@ -0,0 +1 @@
+10/30/08 - Initial version [Matthew Bass]

data/MIT-LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2007-2008 Matthew Bass (http://matthewbass.com)
+
+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,59 @@
+= asset_copier_generator
+
+Intelligent asset management for Rails plugins.
+
+== Installation
+ 
+Install the gem directly:
+
+  sudo gem install pelargir-asset_copier --source=http://gems.github.com  
+
+Or clone the project, build the gem, and install:
+
+  git clone git://github.com/pelargir/asset_copier.git
+  gem build asset_copier_generator.gemspec
+  sudo gem install asset_copier_generator
+
+== Apply to Target Plugin
+
+asset_copier_generator will copy the necessary files into a target plugin
+to enable intelligent asset management. You should then check these files in
+to source control. The generated files become a part of your plugin.
+
+To install the files in your plugin, first ensure that your plugin is installed
+or symlinked from an existing Rails app. From the root of that Rails app, run:
+
+  script/generate asset_copier plugin_name
+  
+Where "plugin_name" is the name of the plugin you want to install into. The
+appropriate files will be copied into your plugin. Now, to copy assets
+from your plugin into your Rails app, run:
+
+  rake plugin_name:install
+
+Your users can run this same Rake task any time they want to update files
+in their Rails app to reflect the assets needed by your plugin.
+
+== Usage
+
+Once applied to a target plugin, files within the /files directory of that
+plugin will be copied into RAILS_ROOT whenever the installation task is run.
+
+Files will also be copied every time the Rails server is started if the project
+is running in development mode. (Projects running in production mode will instead
+receive a warning in the log that one or more files are missing. No files
+will automatically be copied.)
+
+What if you remove a file from your plugin at some future point? Simply add
+the file path to deleted_files. The next time the Rails server is started
+or the install task is run, a warning will print in the log informing the
+user that the file has been removed from the plugin and can also safely
+be removed from their Rails project.
+
+== Resources
+
+Repository: http://github.com/pelargir/asset_copier
+Blog: http://matthewbass.com
+Author: Matthew Bass
+
+Extraction work sponsored by Terralien

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the asset_copier_generator gem.'
+Rake::TestTask.new(:test) do |t|
+  #t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the asset_copier_generator gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'asset_copier_generator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  #rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,2 @@
+* Hook install.rb to prompt if someone is installing the plugin and a file already exists.
+* Should be able to run asset_copier_generator from outside a Rails project.

data/USAGE

@@ -0,0 +1 @@
+describe how to use the generator

data/asset_copier_generator.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name     = "asset_copier_generator"
+  s.version  = "0.5"
+  s.date     = "2008-10-30"
+  s.summary  = "Intelligent asset management for plugins."
+  s.email    = "pelargir@gmail.com"
+  s.homepage = "http://github.com/pelargir/asset_copier"
+  s.description = "Provides intelligent asset management for Rails plugins."
+  s.has_rdoc = true
+  s.authors  = ["Matthew Bass"]
+  s.files    = [
+    "asset_copier_generator.rb",
+    "CHANGELOG",
+    "MIT-LICENSE",
+    "Rakefile",
+    "README",
+    "templates/asset_copier.rb.erb",
+    "templates/asset_copier.rake.erb",
+    "templates/init.rb.erb",
+    "templates/install.rb.erb",
+    "templates/deleted_files",
+    "TODO",
+    "USAGE",
+		"asset_copier_generator.gemspec"
+		]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+end

data/asset_copier_generator.rb

@@ -0,0 +1,15 @@
+class AssetCopierGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.directory "vendor/plugins/#{file_name}/tasks"
+      m.directory "vendor/plugins/#{file_name}/lib/#{file_name}"
+      
+      m.template "init.rb.erb", "vendor/plugins/#{file_name}/init.rb"
+      m.template "install.rb.erb", "vendor/plugins/#{file_name}/install.rb"
+      m.template "asset_copier.rake.erb", "vendor/plugins/#{file_name}/tasks/asset_copier.rake"
+      m.template "asset_copier.rb.erb", "vendor/plugins/#{file_name}/lib/#{file_name}/asset_copier.rb"
+      
+      m.file "deleted_files", "vendor/plugins/#{file_name}/deleted_files"
+    end
+  end
+end

data/templates/asset_copier.rake.erb

@@ -0,0 +1,11 @@
+# Generated by the asset_copier plugin
+# http://github.com/pelargir/asset_copier
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/<%= file_name %>/asset_copier')
+
+namespace :<%= file_name %> do
+  desc "Install files required by <%= file_name %>"
+  task :install do  
+    <%= class_name %>::AssetCopier.copy "<%= file_name %>"
+  end
+end

data/templates/asset_copier.rb.erb

@@ -0,0 +1,90 @@
+# Generated by the asset_copier plugin
+# http://github.com/pelargir/asset_copier
+
+require 'find'
+require 'digest/md5'
+
+module <%= class_name %>
+  class AssetCopier
+    @source = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'files'))
+    @destination = RAILS_ROOT
+    @deleted_files = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'deleted_files'))
+    class << self
+      attr_accessor :source, :destination, :deleted_files
+    end
+  
+    def self.copy(plugin_name)
+      begin
+        each_path do |path, dest_path, short_path| 
+          if File.directory?(path)
+            unless File.exists?(dest_path)
+              FileUtils.mkdir_p(dest_path)
+              log "Creating directory #{short_path} for #{plugin_name}"
+            end
+          elsif !compare(path, dest_path)
+            FileUtils.cp(path, dest_path)
+            log "Copying #{short_path} from #{plugin_name}"
+          end
+        end
+      rescue Exception => e
+        log "Error trying to copy files: #{e.inspect}"
+        raise e
+      end
+      print_deletion_warnings(plugin_name)
+    end
+  
+    def self.warn(plugin_name)
+      each_path do |path, dest_path, short_path|
+        next if File.directory?(path)
+        reinstall = false
+        if File.exists?(dest_path)
+          unless compare(path, dest_path)
+            log "WARNING: #{short_path} is out of date and needs to be reinstalled"
+            reinstall = true
+          end
+        else
+          reinstall = true
+          log "WARNING: #{short_path} is missing and needs to be installed"
+        end
+        log "WARNING: Please run rake #{plugin_name}:install" if reinstall
+      end
+      print_deletion_warnings(plugin_name)
+    end
+  
+    def self.compare(file1, file2)
+      File.exists?(file1) && File.exists?(file2) &&
+        Digest::MD5.hexdigest(File.read(file1)) == Digest::MD5.hexdigest(File.read(file2))
+    end
+  
+    def self.print_deletion_warnings(plugin_name)
+      File.open(deleted_files, "r") do |f|
+        f.readlines.reject { |l| l =~ /^#/ || l.strip.blank? }.each do |l|
+          log "WARNING: #{l} is no longer required by the #{plugin_name} plugin " <<
+              "and can can be safely removed" if File.exists?(l)
+        end
+      end
+    end
+  
+    def self.paths
+      returning [] do |paths|
+        Find.find(source) do |path|
+          Find.prune if path =~ /\/\..+/
+          Find.prune if path =~ /(CVS|\.svn|\.git)/
+          paths << path
+        end
+      end
+    end
+  
+    def self.each_path
+      paths.each do |path|
+        dest_path = path.gsub(source, destination)
+        short_path = dest_path.gsub("#{destination}/", "")
+        yield path, dest_path, short_path
+      end
+    end
+    
+    def self.log(msg)
+      puts msg
+    end
+  end
+end

data/templates/deleted_files

@@ -0,0 +1,14 @@
+# Generated by the asset_copier plugin
+# http://github.com/pelargir/asset_copier
+#
+# Files that have been removed from the plugin and should also be removed from
+# any Rails projects that use the plugin should be listed here, one entry
+# per line. For example:
+#
+#   public/javascripts/foo.js
+#   app/views/foo/bar.erb.html
+#
+# Adding the paths above to this file would ensure that foo.js and bar.erb.html
+# both get removed from the target Rails project the next time the plugin's
+# files are copied over.
+

data/templates/init.rb.erb

@@ -0,0 +1,7 @@
+require '<%= file_name %>/asset_copier'
+
+if RAILS_ENV == "development"
+  <%= class_name %>::AssetCopier.copy "<%= file_name %>"
+elsif RAILS_ENV == "production"
+  <%= class_name %>::AssetCopier.warn "<%= file_name %>"
+end

data/templates/install.rb.erb

@@ -0,0 +1,20 @@
+# Generated by the asset_copier plugin
+# http://github.com/pelargir/asset_copier
+
+require 'rake'
+ 
+begin
+  puts "============================================================="
+  puts "Attempting to install required files into your application..."
+  puts "============================================================="
+  RAKE_FILE = File.expand_path(File.join(File.dirname(__FILE__), 'tasks', 'asset_copier.rake'))
+  load RAKE_FILE
+  
+  Rake::Task['<%= file_name %>:install'].invoke
+  puts "=========================================================="
+  puts "Success!"
+  puts "=========================================================="
+rescue Exception => ex
+  puts "FAILED TO INSTALL REQUIRED FILES.  PLEASE RUN rake <%= file_name %>:install."
+  puts "EXCEPTION: #{ex}"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: asset_copier_generator
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Matthew Bass
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Provides intelligent asset management for Rails plugins.
+email: pelargir@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- asset_copier_generator.rb
+- CHANGELOG
+- MIT-LICENSE
+- Rakefile
+- README
+- templates/asset_copier.rb.erb
+- templates/asset_copier.rake.erb
+- templates/init.rb.erb
+- templates/install.rb.erb
+- templates/deleted_files
+- TODO
+- USAGE
+- asset_copier_generator.gemspec
+has_rdoc: true
+homepage: http://github.com/pelargir/asset_copier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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.4
+signing_key: 
+specification_version: 3
+summary: Intelligent asset management for plugins.
+test_files: []
+