trusty-cms 4.1.4 → 4.1.9

data/lib/generators/extension/templates/tasks.rake

@@ -0,0 +1,47 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :<%= file_name %> do
+
+      desc "Runs the migration of the <%= extension_name %> extension"
+      task :migrate => :environment do
+        require 'trusty_cms/extension_migrator'
+        if ENV["VERSION"]
+          <%= class_name %>.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          <%= class_name %>.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+
+      desc "Copies public assets of the <%= extension_name %> to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from <%= class_name %>"
+        Dir[<%= class_name %>.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(<%= class_name %>.root, '')
+          directory = File.dirname(path)
+          mkdir_p Rails.root + directory, :verbose => false
+          cp file, Rails.root + path, :verbose => false
+        end
+      end
+
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = <%= class_name %>.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/lib/generators/extension/templates/test_helper.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+# Load the environment
+unless defined? TRUSTY_CMS_ROOT
+  ENV["Rails.env"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/trusty_cms/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{TRUSTY_CMS_ROOT}/test/test_helper"
+
+class ActiveSupport::TestCase
+
+  # Include a helper to make testing Radius tags easier
+  test_helper :extension_tags
+
+  # Add the fixture directory to the fixture path
+  self.fixture_path << File.dirname(__FILE__) + "/fixtures"
+
+  # Add more helper methods to be used by all extension tests here...
+
+end

data/lib/generators/extension_controller/USAGE

@@ -0,0 +1,36 @@
+Description:
+    The extension_controller generator creates stubs for a new controller and 
+    its views for an extension.
+  
+    The generator takes an extension name, controller name, and a list of 
+    views as arguments.  The controller name may be given in CamelCase or 
+    under_score and should not be suffixed with 'Controller'.  To create a 
+    controller within a module, specify the controller name as 
+    'module/controller'.
+
+    The generator creates a controller class in 
+    vendor/extension_name/app/controllers with view templates in 
+    vendor/extension_name/app/views/controller_name, a helper class in 
+    vendor/extension_name/app/helpers, and a functional test suite in 
+    vendor/extension_name/test/functional.
+
+Example:
+    ./script/generate extension_controller MyExt Assets list show
+
+    Controller: vendor/my_ext/app/controllers/assets_controller.rb
+    Views:      vendor/my_ext/app/views/assets/list.rhtml [...]
+    Helper:     vendor/my_ext/app/helpers/assets_helper.rb
+    Spec:       vendor/my_ext/spec/controllers/assets_controller_spec.rb
+    Test:       vendor/my_ext/test/functional/assets_test.rb (if extension created with "--with-test-unit")
+
+Modules Example:
+    ./script/generate extension_controller MyExt 'admin/assets' upload remove
+
+    Controller: vendor/my_ext/app/controllers/admin/assets_controller.rb
+    Views:      vendor/my_ext/app/views/admin/assets/upload.rhtml [...]
+    Helper:     vendor/my_ext/app/helpers/admin/assets_helper.rb
+    Spec:       vendor/my_ext/spec/controllers/admin/assets_controller_spec.rb
+    Test:       vendor/my_ext/test/functional/admin/assets_controller_test.rb (if extension created with "--with-test-unit")
+    
+Note: Once you have created an extension controller you will still need to
+map routes to the controller in the extension file.

data/lib/generators/extension_controller/extension_controller_generator.rb

@@ -0,0 +1,84 @@
+require 'rails_generator/base'
+require 'rails_generator/generators/components/controller/controller_generator'
+
+class ExtensionControllerGenerator < ControllerGenerator
+
+  attr_accessor :extension_name
+  default_options :with_test_unit => false
+
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args = runtime_args.dup
+    @extension_name = runtime_args.shift
+    super(runtime_args, runtime_options)
+  end
+
+  def manifest
+    if extension_uses_rspec?
+      rspec_manifest
+    else
+      super
+    end
+  end
+
+  def rspec_manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Controller", "#{class_name}Helper"
+
+      # Controller, helper, views, and spec directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('spec/controllers', class_path)
+      m.directory File.join('spec/helpers', class_path)
+      m.directory File.join('spec/views', class_path, file_name)
+
+      # Controller spec, class, and helper.
+      m.template 'controller_spec.rb',
+        File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")
+
+      m.template 'helper_spec.rb',
+        File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+
+      m.template 'controller:controller.rb',
+        File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+
+      m.template 'controller:helper.rb',
+        File.join('app/helpers', class_path, "#{file_name}_helper.rb")
+
+      # Spec and view template for each action.
+      actions.each do |action|
+        m.template 'view_spec.rb',
+          File.join('spec/views', class_path, file_name, "#{action}_view_spec.rb"),
+          :assigns => { :action => action, :model => file_name }
+        path = File.join('app/views', class_path, file_name, "#{action}.html.erb")
+        m.template 'controller:view.html.erb',
+          path,
+          :assigns => { :action => action, :path => path }
+      end
+    end
+  end
+
+  def banner
+    "Usage: #{$0} #{spec.name} ExtensionName #{spec.name.camelize}Name [options]"
+  end
+
+  def extension_path
+    File.join('vendor', 'extensions', @extension_name.underscore)
+  end
+
+  def destination_root
+    File.join(Rails.root, extension_path)
+  end
+
+  def extension_uses_rspec?
+    File.exists?(File.join(destination_root, 'spec')) && !options[:with_test_unit]
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--with-test-unit",
+           "Use Test::Unit tests instead sof RSpec.") { |v| options[:with_test_unit] = v }
+  end
+end

data/lib/generators/extension_controller/templates/controller.rb

@@ -0,0 +1,10 @@
+class <%= class_name %>Controller < ApplicationController
+  # Remove this line if your controller should only be accessible to users
+  # that are logged in:
+  #  no_login_required
+<% for action in actions -%>
+
+  def <%= action %>
+  end
+<% end -%>
+end

data/lib/generators/extension_controller/templates/controller_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper'
+
+describe <%= class_name %>Controller do
+
+<% if actions.empty? -%>
+  #Delete this example and add some real ones
+<% else -%>
+  #Delete these examples and add some real ones
+<% end -%>
+  it "should use <%= class_name %>Controller" do
+    controller.should be_an_instance_of(<%= class_name %>Controller)
+  end
+
+<% unless actions.empty? -%>
+<% for action in actions -%>
+
+  it "GET '<%= action %>' should be successful" do
+    get '<%= action %>'
+    response.should be_success
+  end
+<% end -%>
+<% end -%>
+end

data/lib/generators/extension_controller/templates/functional_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+# Re-raise errors caught by the controller.
+<%= class_name %>Controller.class_eval { def rescue_action(e) raise e end }
+
+class <%= class_name %>ControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/lib/generators/extension_controller/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= class_name %>Helper
+end

data/lib/generators/extension_controller/templates/helper_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper'
+
+describe <%= class_name %>Helper do
+
+  #Delete this example and add some real ones or delete this file
+  it "should include the <%= class_name %>Helper" do
+    included_modules = self.metaclass.send :included_modules
+    included_modules.should include(<%= class_name %>Helper)
+  end
+
+end

data/lib/generators/extension_controller/templates/helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name %>HelperTest < ActionView::TestCase
+end

data/lib/generators/extension_controller/templates/view.html.erb

@@ -0,0 +1,2 @@
+<h1><%= class_name %>#<%= action %></h1>
+<p>Find me in <%= File.join(extension_path, path) %></p>

data/lib/generators/extension_controller/templates/view_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../../spec_helper'
+
+describe "/<%= class_name.underscore %>/<%= action %>" do
+  before do
+    render '<%= class_name.underscore %>/<%= action %>'
+  end
+
+  #Delete this example and add some real ones or delete this file
+  it "should tell you where to find the file" do
+    response.should have_tag('p', 'Find me in app/views/<%= class_name.underscore %>/<%= action %>.rhtml')
+  end
+end

data/lib/generators/extension_mailer/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Stubs out a new mailer and its views for the given extension.
+    Pass the mailer name, either CamelCased or under_scored, 
+    and an optional list of emails as arguments.
+
+    This generates a mailer class in app/models, view templates in
+    app/views/mailer_name, a unit test in test/unit, and fixtures in
+    test/fixtures.
+
+Example:
+    `./script/generate extension_mailer MyExt Notifications signup forgot_password invoice`
+
+    creates a Notifications mailer class, views, test, and fixtures:
+        Mailer:     vendor/my_ext/app/models/notifications.rb
+        Views:      vendor/my_ext/app/views/notifications/signup.erb [...]
+        Test:       vendor/my_ext/test/unit/test/unit/notifications_test.rb
+        Fixtures:   vendor/my_ext/test/fixtures/notifications/signup [...]

data/lib/generators/extension_mailer/extension_mailer_generator.rb

@@ -0,0 +1,68 @@
+require 'rails_generator/base'
+require 'rails_generator/generators/components/mailer/mailer_generator'
+
+class ExtensionMailerGenerator < MailerGenerator
+
+  attr_accessor :extension_name
+  default_options :with_test_unit => false
+
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args = runtime_args.dup
+    @extension_name = runtime_args.shift
+    super(runtime_args, runtime_options)
+  end
+
+  def manifest
+    if extension_uses_rspec?
+      rspec_manifest
+    else
+      super
+    end
+  end
+
+  def rspec_manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name
+
+      # Mailer, view, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('app/views', file_path)
+
+      # Mailer class and unit test.
+      m.template "mailer:mailer.rb",    File.join('app/models', class_path, "#{file_name}.rb")
+
+      # View template and fixture for each action.
+      actions.each do |action|
+        relative_path = File.join(file_path, action)
+        view_path     = File.join('app/views', "#{relative_path}.erb")
+
+        m.template "mailer:view.erb", view_path,
+                   :assigns => { :action => action, :path => view_path }
+      end
+    end
+  end
+
+  def banner
+    "Usage: #{$0} #{spec.name} ExtensionName #{spec.name.camelize}Name [options]"
+  end
+
+  def extension_path
+    File.join('vendor', 'extensions', @extension_name.underscore)
+  end
+
+  def destination_root
+    File.join(Rails.root, extension_path)
+  end
+
+  def extension_uses_rspec?
+    File.exists?(File.join(destination_root, 'spec')) && !options[:with_test_unit]
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--with-test-unit",
+           "Use Test::Unit tests instead sof RSpec.") { |v| options[:with_test_unit] = v }
+  end
+end

data/lib/generators/extension_mailer/templates/fixture.erb

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in <%= path %>

data/lib/generators/extension_mailer/templates/mailer.rb

@@ -0,0 +1,15 @@
+class <%= class_name %> < ActionMailer::Base
+
+<% for action in actions -%>
+
+  def <%= action %>(sent_at = Time.now)
+    subject    '<%= class_name %>#<%= action %>'
+    recipients ''
+    from       ''
+    sent_on    sent_at
+
+    body       :greeting => 'Hi,'
+  end
+<% end -%>
+
+end

data/lib/generators/extension_mailer/templates/unit_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < ActionMailer::TestCase
+  tests <%= class_name %>
+<% for action in actions -%>
+  def test_<%= action %>
+    @expected.subject = '<%= class_name %>#<%= action %>'
+    @expected.body    = read_fixture('<%= action %>')
+    @expected.date    = Time.now
+
+    assert_equal @expected.encoded, <%= class_name %>.create_<%= action %>(@expected.date).encoded
+  end
+
+<% end -%>
+<% if actions.blank? -%>
+  # replace this with your real tests
+  def test_truth
+    assert true
+  end
+<% end -%>
+end

data/lib/generators/extension_mailer/templates/view.erb

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in <%= path %>

data/lib/generators/extension_migration/USAGE

@@ -0,0 +1,34 @@
+Description:
+    The extension_migration generator creates a stub for a new migration for an 
+    extension.
+
+    The generator takes the extension name, a migration name as its arguments,
+    and an optional list of attribute pairs as arguments. The migration name 
+    may be given in CamelCase or under_score.
+
+    You can name your migration in either of these formats to generate add/remove
+    column lines from supplied attributes: AddColumnsToTable or RemoveColumnsFromTable
+
+    A migration class is generated in vendor/extensions/extension_name/db/migrate 
+    prefixed by a timestamp of the current date and time. 
+
+Examples:
+    `./script/generate extension_migration MyExt AddSslFlag`
+
+    If the current date is May 14, 2008 and the current time 09:09:12, this creates the AddSslFlag migration
+    vendor/extensions/my_ext/db/migrate/20080514090912_add_ssl_flag.rb
+
+    `./script/generate migration MyExt AddTitleBodyToPost title:string body:text published:boolean`
+    
+    This will create the AddTitleBodyToPost in vendor/extensions/my_ext/db/migrate/20080514090912_add_title_body_to_post.rb
+    with this in the Up migration:
+
+      add_column :posts, :title, :string  
+      add_column :posts, :body, :text  
+      add_column :posts, :published, :boolean
+
+    And this in the Down migration:
+    
+      remove_column :posts, :published  
+      remove_column :posts, :body  
+      remove_column :posts, :title