From e0843136405e26a13405567d65fe7e5cc40dfcff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Fri, 26 Jun 2009 09:53:53 +0200 Subject: Added HelperGenerator. --- railties/lib/generators/named_base.rb | 8 ++--- railties/lib/generators/rails/helper/USAGE | 24 +++++++++++++++ .../generators/rails/helper/helper_generator.rb | 15 +++++++++ .../generators/rails/helper/templates/helper.rb | 2 ++ .../test_unit/helper/helper_generator.rb | 13 ++++++++ .../test_unit/helper/templates/helper_test.rb | 4 +++ railties/test/generators/helper_generator_test.rb | 36 ++++++++++++++++++++++ .../generators/integration_test_generator_test.rb | 2 +- .../generators/performance_test_generator_test.rb | 2 +- 9 files changed, 100 insertions(+), 6 deletions(-) create mode 100644 railties/lib/generators/rails/helper/USAGE create mode 100644 railties/lib/generators/rails/helper/helper_generator.rb create mode 100644 railties/lib/generators/rails/helper/templates/helper.rb create mode 100644 railties/lib/generators/test_unit/helper/helper_generator.rb create mode 100644 railties/lib/generators/test_unit/helper/templates/helper_test.rb create mode 100644 railties/test/generators/helper_generator_test.rb (limited to 'railties') diff --git a/railties/lib/generators/named_base.rb b/railties/lib/generators/named_base.rb index 223b34ce57..4f173bffce 100644 --- a/railties/lib/generators/named_base.rb +++ b/railties/lib/generators/named_base.rb @@ -13,15 +13,15 @@ module Rails def initialize(*args) super - assign_names! + assign_names!(self.name) parse_attributes! if respond_to?(:attributes) end protected - def assign_names! - base_name, @class_path, @file_path, @class_nesting, @class_nesting_depth = extract_modules(name) - @class_name_without_nesting, @singular_name, @plural_name = inflect_names(base_name) + def assign_names!(given_name) + self.name, @class_path, @file_path, @class_nesting, @class_nesting_depth = extract_modules(given_name) + @class_name_without_nesting, @singular_name, @plural_name = inflect_names(self.name) @table_name = if !defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names plural_name diff --git a/railties/lib/generators/rails/helper/USAGE b/railties/lib/generators/rails/helper/USAGE new file mode 100644 index 0000000000..e74d4b6425 --- /dev/null +++ b/railties/lib/generators/rails/helper/USAGE @@ -0,0 +1,24 @@ +Description: + Stubs out a new helper. Pass the helper name, either + CamelCased or under_scored. + + To create a helper within a module, specify the helper name as a + path like 'parent_module/helper_name'. + + This generates a helper class in app/helpers and invokes your test + framework. + +Example: + `./script/generate helper CreditCard` + + Credit card helper. + Helper: app/helpers/credit_card_helper.rb + Test: test/unit/helpers/credit_card_helper_test.rb + +Modules Example: + `./script/generate helper 'admin/credit_card'` + + Credit card admin helper. + Helper: app/helpers/admin/credit_card_helper.rb + Test: test/unit/helpers/admin/credit_card_helper_test.rb + diff --git a/railties/lib/generators/rails/helper/helper_generator.rb b/railties/lib/generators/rails/helper/helper_generator.rb new file mode 100644 index 0000000000..6f741b0978 --- /dev/null +++ b/railties/lib/generators/rails/helper/helper_generator.rb @@ -0,0 +1,15 @@ +module Rails + module Generators + class HelperGenerator < NamedBase + def check_class_collisions + class_collisions "#{class_name}Helper" + end + + def create_helper_files + template 'helper.rb', File.join('app/helpers', class_path, "#{file_name}_helper.rb") + end + + invoke_for :test_framework + end + end +end diff --git a/railties/lib/generators/rails/helper/templates/helper.rb b/railties/lib/generators/rails/helper/templates/helper.rb new file mode 100644 index 0000000000..3fe2ecdc74 --- /dev/null +++ b/railties/lib/generators/rails/helper/templates/helper.rb @@ -0,0 +1,2 @@ +module <%= class_name %>Helper +end diff --git a/railties/lib/generators/test_unit/helper/helper_generator.rb b/railties/lib/generators/test_unit/helper/helper_generator.rb new file mode 100644 index 0000000000..e7fc4e0dbd --- /dev/null +++ b/railties/lib/generators/test_unit/helper/helper_generator.rb @@ -0,0 +1,13 @@ +module TestUnit + module Generators + class HelperGenerator < Base + def check_class_collisions + class_collisions "#{class_name}Helper" + end + + def create_helper_files + template 'helper_test.rb', File.join('test/unit/helpers', class_path, "#{file_name}_helper_test.rb") + end + end + end +end diff --git a/railties/lib/generators/test_unit/helper/templates/helper_test.rb b/railties/lib/generators/test_unit/helper/templates/helper_test.rb new file mode 100644 index 0000000000..591e40900e --- /dev/null +++ b/railties/lib/generators/test_unit/helper/templates/helper_test.rb @@ -0,0 +1,4 @@ +require 'test_helper' + +class <%= class_name %>HelperTest < ActionView::TestCase +end diff --git a/railties/test/generators/helper_generator_test.rb b/railties/test/generators/helper_generator_test.rb new file mode 100644 index 0000000000..506889e4a7 --- /dev/null +++ b/railties/test/generators/helper_generator_test.rb @@ -0,0 +1,36 @@ +require 'abstract_unit' +require 'generators/generators_test_helper' +require 'generators/rails/helper/helper_generator' +require 'generators/test_unit/helper/helper_generator' + +ObjectHelper = Class.new + +class HelperGeneratorTest < GeneratorsTestCase + + def test_helper_skeleton_is_created + run_generator + assert_file "app/helpers/admin_helper.rb", /module AdminHelper/ + end + + def test_invokes_default_test_framework + run_generator + assert_file "test/unit/helpers/admin_helper_test.rb" + end + + def test_logs_if_the_test_framework_cannot_be_found + content = run_generator ["admin", "--test-framework=unknown"] + assert_match /Could not find and invoke 'unknown:generators:helper'/, content + end + + def test_check_class_collision + content = capture(:stderr){ run_generator ["object"] } + assert_match /The name 'ObjectHelper' is either already used in your application or reserved/, content + end + + protected + + def run_generator(args=["admin"]) + silence(:stdout) { Rails::Generators::HelperGenerator.start args, :root => destination_root } + end + +end diff --git a/railties/test/generators/integration_test_generator_test.rb b/railties/test/generators/integration_test_generator_test.rb index 9e1e265c9a..1961a102b9 100644 --- a/railties/test/generators/integration_test_generator_test.rb +++ b/railties/test/generators/integration_test_generator_test.rb @@ -6,7 +6,7 @@ class IntegrationTestGeneratorTest < GeneratorsTestCase def test_integration_test_skeleton_is_created run_generator - assert_file "test/integration/integration_test.rb" + assert_file "test/integration/integration_test.rb", /class IntegrationTest < ActionController::IntegrationTest/ end protected diff --git a/railties/test/generators/performance_test_generator_test.rb b/railties/test/generators/performance_test_generator_test.rb index 0a92bb587b..fdfbf9031c 100644 --- a/railties/test/generators/performance_test_generator_test.rb +++ b/railties/test/generators/performance_test_generator_test.rb @@ -6,7 +6,7 @@ class PerformanceTestGeneratorTest < GeneratorsTestCase def test_performance_test_skeleton_is_created run_generator - assert_file "test/performance/performance_test.rb" + assert_file "test/performance/performance_test.rb", /class PerformanceTest < ActionController::PerformanceTest/ end protected -- cgit v1.2.3