mack 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,4 +1,6 @@
-===0.0.5
+===0.0.6
+* rake generate:<generator_name>
+* rake generate:plugin - will generate the stub of a plugin in the vendor/plugins directory. 
 * rake dump:config - prints out the configuration information for the specified environment.
 * redirect_to now takes an optional Hash as a second parameter, instead of a fixnum.
 * redirect_to will now do server side redirects if passed :server_side => true as part of the optional second argument Hash.

data/errors/errors.rb

@@ -75,5 +75,13 @@ module Mack
       end
     end
     
+    # Raised if a Mack::Generator::Base required parameter is not supplied.
+    class RequiredGeneratorParameterMissing < StandardError
+      # Takes the name of the missing parameter.
+      def initialize(name)
+        super("The required parameter '#{name.to_s.upcase}' is missing for this generator!")
+      end
+    end
+    
   end # Errors
 end # Mack

data/initialization/initializers/plugins.rb

@@ -4,6 +4,10 @@ Dir.glob(File.join(MACK_PLUGINS, "*")).each do |d|
   $: << File.join(d, "lib") # add the lib for this plugin to the global load path
 end
 plugins.sort.each do |plug|
-  require File.join(plug, "init.rb") # load the init.rb for each plugin.
+  begin
+    require File.join(plug, "init.rb") # load the init.rb for each plugin.
+  rescue Exception => e
+    puts e.message
+  end
   $:.delete(File.join(plug, "lib")) # remove the plugins lib directory from the global load path.
 end

data/lib/generators/generator_base.rb

@@ -0,0 +1,83 @@
+module Mack
+  module Generator # :nodoc:
+    # All generator classes should extend this class if they're expected to be used by the rake generate:<generator_name> task.
+    # A generator must by name in the following style: <name>Generator. 
+    # 
+    # Example:
+    #   class MyCoolGenerator < Mack::Generator::Base
+    #     require_param :name, :foo
+    #     
+    #     def generate
+    #       # do work...
+    #     end
+    #   end
+    # 
+    #   rake generate:my_cool # => calls MyCoolGenerator
+    class Base
+
+      include FileUtils
+      
+      # Used to define arguments that are required by the generator.
+      def self.require_param(*args)
+        required_params << args
+        required_params.flatten!
+      end
+      
+      # Returns the required_params array.
+      def self.required_params
+        @required_params ||= []
+      end
+      
+      # Takes a Hash of parameters.
+      # Raise Mack::Errors::RequiredGeneratorParameterMissing if a required parameter
+      # is missing.
+      def initialize(env = {})
+        @env = env
+        self.class.required_params.each do |p|
+          raise Mack::Errors::RequiredGeneratorParameterMissing.new(p) unless param(p)
+        end
+      end
+      
+      # Runs the generate method.
+      def run
+        generate
+      end
+      
+      # Returns a parameter from the initial Hash of parameters.
+      def param(key)
+        (@env[key.to_s.downcase] ||= @env[key.to_s.upcase])
+      end
+      
+      # Needs to be implemented by the subclass.
+      def generate
+        raise MethodNotImplemented.new("generate")
+      end
+      
+      # Takes an input_file runs it through ERB and 
+      # saves it to the specified output_file. If the output_file exists it will
+      # be skipped. If you would like to force the writing of the file, use the
+      # :force => true option.
+      def template(input_file, output_file, options = {})
+        if File.exists?(output_file)
+          unless options[:force]
+            puts "Skipped: #{output_file}"
+            return
+          end
+        end
+        File.open(output_file, "w") {|f| f.puts ERB.new(File.open(input_file).read).result(binding)}
+        puts "Wrote: #{output_file}"
+      end
+      
+      # Creates the specified directory.
+      def directory(output_dir, options = {})
+        if File.exists?(output_dir)
+          puts "Exists: #{output_dir}"
+          return
+        end
+        mkdir_p(output_dir)
+        puts "Created: #{output_dir}"
+      end
+      
+    end # Base
+  end # Generator
+end # Mack

data/lib/generators/plugin_generator/plugin_generator.rb

@@ -0,0 +1,30 @@
+# Generates plugins for Mack applications.
+# 
+# Example:
+#   rake generate:plugin name=my_cool_plugin
+# This will generate the following in your mack application:
+#   vendor/plugins/my_cool_plugin
+#   vendor/plugins/my_cool_plugin/init.rb
+#   vendor/plugins/my_cool_plugin/lib
+#   vendor/plugins/my_cool_plugin/lib/my_cool_plugin.rb
+class PluginGenerator < Mack::Generator::Base
+  
+  require_param :name
+  
+  def generate
+    plugin_dir = File.join(MACK_ROOT, "vendor", "plugins", param(:name).downcase)
+    template_dir = File.join(File.dirname(__FILE__), "templates")
+    
+    # create vendor/plugins/<name>
+    directory(plugin_dir)
+    # create vendor/plugins/<name>/lib
+    directory(File.join(plugin_dir, "lib"))
+    
+    # create vendor/plugins/<name>/init.rb
+    template(File.join(template_dir, "init.rb.template"), File.join(plugin_dir, "init.rb"))
+    # create vendor/plugins/<name>/lib/<name>.rb
+    template(File.join(template_dir, "lib", "plugin.rb.template"), File.join(plugin_dir, "lib", "#{param(:name).downcase}.rb"))
+    
+  end
+  
+end

data/lib/generators/plugin_generator/templates/init.rb.template

@@ -0,0 +1 @@
+require '<%= param(:name) %>'

data/lib/generators/plugin_generator/templates/lib/plugin.rb.template

@@ -0,0 +1 @@
+# Do work here for <%= param(:name) %>

data/tasks/rake_rules.rake

@@ -16,4 +16,12 @@ rule /^cachetastic:/ do |t|
   ENV['cache_name'] = cache_name
   ENV['cache_action'] = cache_action
   Rake::Task["cachetastic:manipulate_caches"].invoke
+end
+
+rule /^generate:/ do |t|
+  klass = t.name.gsub("generate:", '')
+  Rake::Task["environment"].invoke
+  klass = "#{klass.camelcase}Generator"
+  gen = klass.constantize.new(ENV)
+  gen.run
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mack
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - markbates
@@ -106,6 +106,10 @@ files:
 - initialization/initializers/orm_support.rb
 - initialization/initializers/plugins.rb
 - initialization/server/simple_server.rb
+- lib/generators/generator_base.rb
+- lib/generators/plugin_generator/plugin_generator.rb
+- lib/generators/plugin_generator/templates/init.rb.template
+- lib/generators/plugin_generator/templates/lib/plugin.rb.template
 - lib/utils/html.rb
 - lib/utils/server.rb
 - mack.rb