trusty-cms 4.1.6 → 4.2.1

data/lib/generators/extension/extension_generator.rb

@@ -0,0 +1,97 @@
+begin
+  require 'git'
+rescue LoadError
+end
+
+class ExtensionGenerator < Rails::Generator::NamedBase
+  default_options :with_test_unit => false
+
+  attr_reader :extension_path, :extension_file_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @extension_file_name = "#{file_name}_extension"
+    @extension_path = "vendor/extensions/#{file_name}"
+  end
+
+  def manifest
+    record do |m|
+      m.directory "#{extension_path}/app/controllers"
+      m.directory "#{extension_path}/app/helpers"
+      m.directory "#{extension_path}/app/models"
+      m.directory "#{extension_path}/app/views"
+      m.directory "#{extension_path}/config/locales"
+      m.directory "#{extension_path}/config/initializers"
+      m.directory "#{extension_path}/db/migrate"
+      m.directory "#{extension_path}/lib/tasks"
+
+      m.template 'README.md',           "#{extension_path}/README.md"
+      m.template 'extension.rb',        "#{extension_path}/#{extension_file_name}.rb"
+      m.template 'tasks.rake',          "#{extension_path}/lib/tasks/#{extension_file_name}_tasks.rake"
+      m.template 'en.yml',              "#{extension_path}/config/locales/en.yml"
+      m.template 'routes.rb',           "#{extension_path}/config/routes.rb"
+      m.template 'radiant_config.rb',   "#{extension_path}/config/initializers/radiant_config.rb"
+      m.template 'lib.rb',              "#{extension_path}/lib/radiant-#{file_name}-extension.rb"
+      m.template 'gemspec.rb',          "#{extension_path}/radiant-#{file_name}-extension.gemspec"
+
+      if options[:with_test_unit]
+        m.directory "#{extension_path}/test/fixtures"
+        m.directory "#{extension_path}/test/functional"
+        m.directory "#{extension_path}/test/unit"
+
+        m.template 'Rakefile',            "#{extension_path}/Rakefile"
+        m.template 'test_helper.rb',      "#{extension_path}/test/test_helper.rb"
+        m.template 'functional_test.rb',  "#{extension_path}/test/functional/#{extension_file_name}_test.rb"
+      else
+        m.directory "#{extension_path}/spec/controllers"
+        m.directory "#{extension_path}/spec/models"
+        m.directory "#{extension_path}/spec/views"
+        m.directory "#{extension_path}/spec/helpers"
+        m.directory "#{extension_path}/features/support"
+        m.directory "#{extension_path}/features/step_definitions/admin"
+
+        m.template 'RSpecRakefile',       "#{extension_path}/Rakefile"
+        m.template 'spec_helper.rb',      "#{extension_path}/spec/spec_helper.rb"
+        m.file     'spec.opts',           "#{extension_path}/spec/spec.opts"
+        m.file     'cucumber.yml',        "#{extension_path}/cucumber.yml"
+        m.template 'cucumber_env.rb',     "#{extension_path}/features/support/env.rb"
+        m.template 'cucumber_paths.rb',   "#{extension_path}/features/support/paths.rb"
+      end
+    end
+  end
+
+  def class_name
+    super.to_name.gsub(' ', '') + 'Extension'
+  end
+
+  def extension_name
+    class_name.to_name('Extension')
+  end
+
+  def author_info
+    @author_info ||= begin
+      Git.global_config
+    rescue NameError
+      {}
+    end
+  end
+
+  def homepage
+    author_info['github.user'] ? "http://github.com/#{author_info['github.user']}/radiant-#{file_name}-extension" : "http://example.com/#{file_name}"
+  end
+
+  def author_email
+    author_info['user.email'] || 'your email'
+  end
+
+  def author_name
+    author_info['user.name'] || 'Your Name'
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--with-test-unit",
+           "Use Test::Unit for this extension instead of RSpec") { |v| options[:with_test_unit] = v }
+  end
+end

data/lib/generators/extension/templates/README.md

@@ -0,0 +1,6 @@
+# <%= extension_name %>
+
+TrustyCms is _so_ freaking awesome, but I made it better through this extension.
+
+Created by <%= author_name %>. <%- if author_email.include?('@') -%>If I don't update this content with real details,
+please contact me at <%= author_email %> with annoying messages telling me to do it.<%- end -%>

data/lib/generators/extension/templates/RSpecRakefile

@@ -0,0 +1,109 @@
+# Determine where the RSpec plugin is by loading the boot
+unless defined? TRUSTY_CMS_ROOT
+  ENV["Rails.env"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/trusty_cms/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(TRUSTY_CMS_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the TRUSTY_CMS_ROOT constant so specs will load the environment
+Object.send(:remove_const, :TRUSTY_CMS_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => [:spec, :features]
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(Rails.env.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the <%= file_name %> extension.'
+RDoc::Task.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
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/lib/generators/extension/templates/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the <%= file_name %> extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the <%= file_name %> extension.'
+RDoc::Task.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
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/lib/generators/extension/templates/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

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

@@ -0,0 +1,11 @@
+# Sets up the Rails environment for Cucumber
+ENV["Rails.env"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(TRUSTY_CMS_ROOT, "features", "**", "*.rb")).each {|step| require step unless step =~ /datasets_loader\.rb$/}
+
+Cucumber::Rails::World.class_eval do
+  dataset :<%= file_name %>
+end

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

@@ -0,0 +1,22 @@
+module NavigationHelpers
+
+  # Extend the standard PathMatchers with your own paths
+  # to be used in your features.
+  #
+  # The keys and values here may be used in your standard web steps
+  # Using:
+  #
+  #   When I go to the "<%= file_name %>" admin page
+  #
+  # would direct the request to the path you provide in the value:
+  #
+  #   admin_<%= file_name %>_path
+  #
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /<%= file_name %>/i => 'admin_<%= file_name %>_path'
+  })
+
+end
+
+World(NavigationHelpers)

data/lib/generators/extension/templates/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  <%= extension_name.downcase %>: <%= extension_name %>

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

@@ -0,0 +1,21 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency "application_controller"
+require "radiant-<%= file_name %>-extension"
+
+class <%= class_name %> < TrustyCms::Extension
+  version     TrustyCms<%= class_name %>::VERSION
+  description TrustyCms<%= class_name %>::DESCRIPTION
+  url         TrustyCms<%= class_name %>::URL
+
+  # See your config/routes.rb file in this extension to define custom routes
+
+  extension_config do |config|
+    # config is the TrustyCms.configuration object
+  end
+
+  def activate
+    # tab 'Content' do
+    #   add_item "<%= extension_name %>", "/admin/<%= file_name %>", :after => "Pages"
+    # end
+  end
+end

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

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+
+  # Replace this with your real tests.
+  def test_this_extension
+    flunk
+  end
+
+  def test_initialization
+    assert_equal File.join(File.expand_path(Rails.root), 'vendor', 'extensions', '<%= file_name %>'), <%= class_name %>.root
+    assert_equal '<%= extension_name %>', <%= class_name %>.extension_name
+  end
+
+end

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

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-<%= file_name %>-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-<%= file_name %>-extension"
+  s.version     = TrustyCms<%= class_name %>::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = TrustyCms<%= class_name %>::AUTHORS
+  s.email       = TrustyCms<%= class_name %>::EMAIL
+  s.homepage    = TrustyCms<%= class_name %>::URL
+  s.summary     = TrustyCms<%= class_name %>::SUMMARY
+  s.description = TrustyCms<%= class_name %>::DESCRIPTION
+
+  # Define gem dependencies here.
+  # Don't include a dependency on radiant itself: it causes problems when radiant is in vendor/radiant.
+  # s.add_dependency "something", "~> 1.0.0"
+  # s.add_dependency "radiant-some-extension", "~> 1.0.0"
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

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

@@ -0,0 +1,8 @@
+module TrustyCms<%= class_name %>
+  VERSION     = "1.0.0"
+  SUMMARY     = "<%= extension_name %> for TrustyCms CMS"
+  DESCRIPTION = "Makes TrustyCms better by adding <%= file_name %>!"
+  URL         = "<%= homepage %>"
+  AUTHORS     = ["<%= author_name %>"]
+  EMAIL       = ["<%= author_email %>"]
+end

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

@@ -0,0 +1,9 @@
+class Create<%= class_name %>Schema < ActiveRecord::Migration[5.2]
+  def self.up
+
+  end
+
+  def self.down
+
+  end
+end

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

@@ -0,0 +1,3 @@
+TrustyCms.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

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

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  # map.namespace :admin, :member => { :remove => :get } do |admin|
+  #   admin.resources :<%= file_name %>
+  # end
+end

data/lib/generators/extension/templates/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

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

@@ -0,0 +1,42 @@
+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}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+# Include any datasets from loaded extensions
+TrustyCms::Extension.descendants.each do |extension|
+  if File.directory?(extension.root + "/spec/datasets")
+    Dataset::Resolver.default << (extension.root + "/spec/datasets")
+  end
+end
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = Rails.root + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

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