tschmidt-rails-engine-generator 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Terry Schmidt
+
+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.rdoc

@@ -0,0 +1,41 @@
+= rails-engine-generator
+
+Stubs out a new engine plugin. Pass the engine name, either CamelCased or
+under_scored, as an argument. Pass --with-generator to add an example
+generator also.
+
+This creates a plugin in vendor/plugins including an init.rb and README
+as well as standard plugin directories as well as app, config, and db directories.
+
+== Example
+
+`./script/generate engine Tickets`
+
+creates a standard tickets plugin:
+    vendor/plugins/tickets/README
+    vendor/plugins/tickets/init.rb
+    vendor/plugins/tickets/install.rb
+    vendor/plugins/tickets/app
+    vendor/plugins/tickets/app/controllers
+    vendor/plugins/tickets/app/helpers
+    vendor/plugins/tickets/app/models
+    vendor/plugins/tickets/app/views
+    vendor/plugins/tickets/app/views/layouts
+    vendor/plugins/tickets/config
+    vendor/plugins/tickets/db
+    vendor/plugins/tickets/db/migrations
+    vendor/plugins/tickets/lib/tickets.rb
+    vendor/plugins/tickets/test/tickets_test.rb
+    vendor/plugins/tickets/tasks/tickets_tasks.rake
+
+./script/generate plugin BrowserFilters --with-generator
+
+creates a tickets generator also:
+    vendor/plugins/tickets/generators/tickets/tickets_generator.rb
+    vendor/plugins/tickets/generators/tickets/USAGE
+    vendor/plugins/tickets/generators/tickets/templates/
+
+
+== Copyright
+
+Copyright (c) 2009 Terry Schmidt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails-engine-generator"
+    gem.summary = %Q{Generate Rails Engines}
+    gem.email = "tschmidt@ext-inc.com"
+    gem.homepage = "http://github.com/tschmidt/rails-engine-generator"
+    gem.authors = ["Terry Schmidt"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails-engine-generator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/rails-engine-generator.rb

@@ -0,0 +1 @@
+# nothing to see here

data/rails_generators/engine_generator/USAGE

@@ -0,0 +1,34 @@
+Description:
+    Stubs out a new engine plugin. Pass the engine name, either CamelCased or
+    under_scored, as an argument. Pass --with-generator to add an example
+    generator also.
+
+    This creates a plugin in vendor/plugins including an init.rb and README
+    as well as standard plugin directories as well as app, config, and db directories.
+
+Example:
+    `./script/generate engine Tickets`
+
+    creates a standard tickets plugin:
+        vendor/plugins/tickets/README
+        vendor/plugins/tickets/init.rb
+        vendor/plugins/tickets/install.rb
+        vendor/plugins/tickets/app
+        vendor/plugins/tickets/app/controllers
+        vendor/plugins/tickets/app/helpers
+        vendor/plugins/tickets/app/models
+        vendor/plugins/tickets/app/views
+        vendor/plugins/tickets/app/views/layouts
+        vendor/plugins/tickets/config
+        vendor/plugins/tickets/db
+        vendor/plugins/tickets/db/migrations
+        vendor/plugins/tickets/lib/tickets.rb
+        vendor/plugins/tickets/test/tickets_test.rb
+        vendor/plugins/tickets/tasks/tickets_tasks.rake
+
+    ./script/generate plugin BrowserFilters --with-generator
+
+    creates a tickets generator also:
+        vendor/plugins/tickets/generators/tickets/tickets_generator.rb
+        vendor/plugins/tickets/generators/tickets/USAGE
+        vendor/plugins/tickets/generators/tickets/templates/

data/rails_generators/engine_generator/engine_generator.rb

@@ -0,0 +1,48 @@
+class EngineGenerator < Rails::Generator::NamedBase
+  attr_reader :plugin_path
+
+  def initialize(runtime_args, runtime_options = {})
+    @with_generator = runtime_args.delete("--with-generator")
+    super
+    @plugin_path = "vendor/plugins/#{file_name}"
+  end
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_name
+      
+      m.directory "#{plugin_path}/app"
+      m.directory "#{plugin_path}/app/controllers"
+      m.directory "#{plugin_path}/app/helpers"
+      m.directory "#{plugin_path}/app/models"
+      m.directory "#{plugin_path}/app/views"
+      m.directory "#{plugin_path}/app/views/layouts"
+      m.directory "#{plugin_path}/config"
+      m.directory "#{plugin_path}/db"
+      m.directory "#{plugin_path}/db/migrate"
+      m.directory "#{plugin_path}/lib"
+      m.directory "#{plugin_path}/tasks"
+      m.directory "#{plugin_path}/test"
+
+      m.template 'README',         "#{plugin_path}/README"
+      m.template 'MIT-LICENSE',    "#{plugin_path}/MIT-LICENSE"
+      m.template 'Rakefile',       "#{plugin_path}/Rakefile"
+      m.template 'init.rb',        "#{plugin_path}/init.rb"
+      m.template 'install.rb',     "#{plugin_path}/install.rb"
+      m.template 'uninstall.rb',   "#{plugin_path}/uninstall.rb"
+      m.template 'plugin.rb',      "#{plugin_path}/lib/#{file_name}.rb"
+      m.template 'tasks.rake',     "#{plugin_path}/tasks/#{file_name}_tasks.rake"
+      m.template 'unit_test.rb',   "#{plugin_path}/test/#{file_name}_test.rb"
+      m.template 'test_helper.rb', "#{plugin_path}/test/test_helper.rb"
+      if @with_generator
+        m.directory "#{plugin_path}/generators"
+        m.directory "#{plugin_path}/generators/#{file_name}"
+        m.directory "#{plugin_path}/generators/#{file_name}/templates"
+
+        m.template 'generator.rb', "#{plugin_path}/generators/#{file_name}/#{file_name}_generator.rb"
+        m.template 'USAGE',        "#{plugin_path}/generators/#{file_name}/USAGE"
+      end
+    end
+  end
+end

data/rails_generators/engine_generator/templates/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) <%= Date.today.year %> [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/rails_generators/engine_generator/templates/README

@@ -0,0 +1,13 @@
+<%= class_name %>
+<%= "=" * class_name.size %>
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) <%= Date.today.year %> [name of plugin creator], released under the MIT license

data/rails_generators/engine_generator/templates/Rakefile

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

data/rails_generators/engine_generator/templates/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate <%= file_name %> Thing
+
+    This will create:
+        what/will/it/create

data/rails_generators/engine_generator/templates/generator.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Generator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # m.directory "lib"
+      # m.template 'README', "README"
+    end
+  end
+end

data/rails_generators/engine_generator/templates/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/rails_generators/engine_generator/templates/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/rails_generators/engine_generator/templates/plugin.rb

@@ -0,0 +1 @@
+# <%= class_name %>

data/rails_generators/engine_generator/templates/tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :<%= file_name %> do
+#   # Task goes here
+# end

data/rails_generators/engine_generator/templates/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/rails_generators/engine_generator/templates/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

data/rails_generators/engine_generator/templates/unit_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/rails-engine-generator_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class RailsEngineGeneratorTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rails-engine-generator'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: tschmidt-rails-engine-generator
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Terry Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tschmidt@ext-inc.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rails-engine-generator.rb
+- rails_generators/engine_generator/USAGE
+- rails_generators/engine_generator/engine_generator.rb
+- rails_generators/engine_generator/templates/MIT-LICENSE
+- rails_generators/engine_generator/templates/README
+- rails_generators/engine_generator/templates/Rakefile
+- rails_generators/engine_generator/templates/USAGE
+- rails_generators/engine_generator/templates/generator.rb
+- rails_generators/engine_generator/templates/init.rb
+- rails_generators/engine_generator/templates/install.rb
+- rails_generators/engine_generator/templates/plugin.rb
+- rails_generators/engine_generator/templates/tasks.rake
+- rails_generators/engine_generator/templates/test_helper.rb
+- rails_generators/engine_generator/templates/uninstall.rb
+- rails_generators/engine_generator/templates/unit_test.rb
+- test/rails-engine-generator_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/tschmidt/rails-engine-generator
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Generate Rails Engines
+test_files: 
+- test/rails-engine-generator_test.rb
+- test/test_helper.rb