zen 0.2.8 → 0.3b

data/lib/zen/asset.rb

@@ -1,292 +0,0 @@
-require 'ramaze/gestalt'
-
-#:nodoc:
-module Zen
-  ##
-  # The Asset module is a module used to register what Javascript files and
-  # stylesheets should be loaded for the current request. This can be very
-  # useful if you want to add a widget to all pages or override a certain
-  # stylesheet.
-  #
-  # ## Adding Assets
-  #
-  # Assets can be added by calling either Zen::Asset.stylesheet or
-  # Zen::Asset.javascript. Both take an array of files and a hash with some
-  # configuration options, for more info on the exact usage and all the
-  # available parameters see the individual methods. Here are a few quick
-  # examples of loading files:
-  #
-  #     # Load 3 Javascript files of which 2 will be loaded globally
-  #     Zen::Asset.javascript(
-  #       ['mootools/core', 'mootools/more'], :global => true,
-  #     )
-  #
-  #     Zen::Asset.javascript(['application'], :controller => self)
-  #
-  #     # Do the same with a few stylesheets
-  #     Zen::Asset.stylesheet(['admin/css/forms'], :global => true)
-  #     Zen::Asset.stylesheet(['style'], :controller => self)
-  #
-  # ## Customizing Options
-  #
-  # This module uses Innate::Optioned to provide a few options that can be
-  # changed. The following options are available:
-  #
-  # * prefix: The global prefix to use for all assets, set to "admin" by default.
-  # * javascript_prefix: The prefix to use for all Javascript files on top of
-  #   the globalprefix.
-  # * stylesheet_prefix: Similar to the javascript_prefix option but for
-  #   stylesheets.
-  #
-  # ## Building Assets
-  #
-  # Building assets shouldn't be required as Zen already does this but if you
-  # happen to need it you can build the files as following:
-  #
-  #     Zen::Asset.build(:stylesheet)
-  #     Zen::Asset.build(:javascript)
-  #
-  # ## Controller Usage
-  #
-  # While this module can be called by any other piece of code the class
-  # Zen::Controller::AdminController provides shortcuts to Zen::Asset.javascript
-  # and Zen::Asset.stylesheet. These shortcuts work identical but are defined
-  # as class methods and thus can be used inside your class declaration:
-  #
-  #     class Something < Zen::Controller::AdminController
-  #       stylesheet ['reset'], :global => true
-  #     end
-  #
-  # @author Yorick Peterse
-  # @since  0.2.5
-  #
-  module Asset
-    include ::Innate::Optioned
-
-    options.dsl do
-      o 'Prefix for JS and CSS files'          , :prefix           , 'admin'
-      o 'Prefix for JS files on top of :prefix', :javascript_prefix, 'js'
-      o 'Prefix for CSS on top of :prefix'     , :stylesheet_prefix, 'css'
-    end
-
-    ##
-    # Hash containing all the global and controller specific stylesheets that
-    # have to be loaded when calling build_stylesheets.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    #
-    Stylesheets = {
-      :global => []
-    }
-
-    ##
-    # Hash containing all the global and controller specific stylesheets to
-    # load when calling build_javascripts.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    #
-    Javascripts = {
-      :global => []
-    }
-
-    ##
-    # Registers the given Javascripts files so that they're either loaded for
-    # the current action or for all actions. Note that the first argument of
-    # this method should always be an array.
-    #
-    # @example
-    #  # Loads /admin/js/users/access_rules.js for the current action only
-    #  Zen::Asset.javascript ['users/access_rules']
-    #
-    #  # This would load the file globally
-    #  Zen::Asset.javascript ['users/access_rules'], :global => true
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    # @see    Zen::Asset.process
-    #
-    def self.javascript(files, options = {})
-      options = {
-        :prefix => File.join(
-          '/', self.options.prefix, self.options.javascript_prefix
-        ),
-        :type   => :javascript
-      }.merge(options)
-
-      process(files, options)
-    end
-
-    ##
-    # Registers a number of stylesheets that can either be loaded globally or
-    # for the current action.
-    #
-    # @example
-    #  Zen::Asset.stylesheet ['foobar/admin_template'], :global => true
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    # @see    Zen::Asset.process
-    #
-    def self.stylesheet(files, options = {})
-      options = {
-        :prefix => File.join(
-          '/', self.options.prefix, self.options.stylesheet_prefix
-        ),
-        :type   => :stylesheet
-      }.merge(options)
-
-      process(files, options)
-    end
-
-    ##
-    # Builds either all Javascript files or stylesheets. This method will load
-    # both the global and action specific files.
-    #
-    # @example
-    #  # Build the HTML tags for all stylesheets
-    #  Zen::Asset.build(:stylesheet)
-    #
-    #  # Build the HTML tags for all Javascript files
-    #  Zen::Asset.build(:javascript)
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    # @param  [Symbol] type The type of assets to build.
-    # @return [String] The HTML tags for all the assets.
-    #
-    def self.build(type)
-      type       = type.to_sym
-      attrs      = {}
-      controller = Ramaze::Current.action.node.to_s.to_sym
-      method     = Ramaze::Current.action.method.to_s.to_sym
-      gestalt    = Ramaze::Gestalt.new
-
-      # The method in Ramaze::Current.action.method does not always contain the
-      # method since the assets are built in a layout.
-      if method.empty? and Ramaze::Current.actions[-2]
-        method = Ramaze::Current.actions[-2].method.to_s.to_sym
-      end
-
-      # Set the basic elements of the tag
-      if type === :stylesheet
-        tag         = :link
-        value       = :href
-        attrs[:rel] = 'stylesheet'
-        files       = Stylesheets
-      else
-        tag   = :script
-        value = :src
-        files = Javascripts
-      end
-
-      # Get all the files to build
-      if !files[controller].nil?
-        if files[controller].key?(method)
-          files = files[:global] + files[controller][method]
-        elsif !files[controller][:__all].nil?
-          files = files[:global] + files[controller][:__all]
-        else
-          files = files[:global]
-        end
-      else
-        files = files[:global]
-      end
-
-      # Build the tags
-      files.each do |f|
-        tag_attrs = {
-          value => f
-        }.merge(attrs)
-
-        if type === :javascript
-          gestalt.send(tag, '', tag_attrs)
-        else
-          gestalt.send(tag, tag_attrs)
-        end
-      end
-
-      return gestalt.to_s
-    end
-
-    private
-
-    ##
-    # Stores the given files in the correct hash based on the specified options.
-    #
-    # @example
-    #  process(
-    #    ['foobar', 'baz'],
-    #    :global => false,
-    #    :type   => :javascript,
-    #    :prefix => 'js'
-    #  )
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    # @param  [Array] files An array of files to load.
-    # @param  [Hash] options A hash containing all the required options.
-    # @option options [TrueClass] :global Specifies that all the files should be
-    # loaded globally.
-    # @option options [Symbol] :type The type of asset that's loaded, can either
-    # be :javascript or :stylesheet.
-    # @option options [String] :prefix The prefix to use for all the assets.
-    # @option options [TrueClass] :global When set to true the specified files
-    # will be loaded globally.
-    # @option options [Symbol/String] :controller The class of the controller
-    # for which the assets should be loaded.
-    # @option options [Symbol/String/Array] :method A string or symbol that
-    # represents a single method for which to load the assets OR an array of
-    # methods.
-    #
-    def self.process(files, options)
-      # Determine whether the files should be loaded globally
-      if options.key?(:global) and options[:global] === true
-        key = :global
-      else
-        key = options[:controller].to_s.to_sym
-      end
-
-      # Determine where to save the data
-      if options[:type] === :javascript
-        save = Javascripts
-        ext  = '.js'
-      else
-        save = Stylesheets
-        ext  = '.css'
-      end
-
-      # Get the method to load the assets for
-      if options.key?(:method) and options[:method].class != Array
-        options[:method] = [options[:method]]
-      end
-
-      # Add all the files
-      files.each do |f|
-        f = f.to_s + ext
-        f = File.join(options[:prefix], f)
-
-        # Load the assets for all the given methods
-        if options.key?(:method)
-          options[:method].each do |method|
-            method              = method.to_sym
-            save[key]         ||= {}
-            save[key][method] ||= []
-
-            save[key][method].push(f) unless save[key][method].include?(f)
-          end
-        # Load the assets for all methods in the controller
-        else
-          if key === :global
-            save[key].push(f) unless save[key].include?(f)
-          else
-            save[key]         ||= {}
-            save[key][:__all] ||= []
-            save[key][:__all].push(f) unless save[key][:__all].include?(f)
-          end
-        end
-      end
-    end
-  end # Asset
-end # Zen

data/lib/zen/bin/runner.rb

@@ -1,118 +0,0 @@
-# Load all commands
-require __DIR__('create')
-
-#:nodoc:
-module Zen
-  #:nodoc:
-  module Bin
-    ##
-    # Module used to set various global options for the command line utility and
-    # run a command based on the specified parameters.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.8
-    #
-    module Runner
-      # Hash containing all the available commands and their class names.
-      Commands = {
-        :create => Zen::Bin::Create
-      }
-
-      # The banner of this command.
-      Banner = <<-TXT.strip
-Zen is a modular CMS written on top of the awesome Ramaze framework.
-
-Usage:
-  zen [COMMAND] [OPTIONS]
-
-Example:
-  zen create blog
-      TXT
-
-      ##
-      # Runs a command based on the command line arguments or a specified array
-      # to use instead of ARGV.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.8
-      # @param  [Array] argv An array containing command line arguments.
-      #
-      def self.run(argv=ARGV)
-        stop = false
-        op   = OptionParser.new do |opt|
-          opt.banner         = Banner
-          opt.summary_indent = '  '
-
-          opt.separator "\nCommands:\n  #{commands_info.join("\n  ")}"
-          opt.separator "\nOptions:\n"
-
-          # Define the available options
-          opt.on('-v', '--version', 'Shows the version of Zen') do
-            puts Zen::Version
-
-            stop = true
-          end
-
-          opt.on('-h', '--help', 'Shows this help message') do
-            puts op
-
-            stop = true
-          end
-        end
-
-        # Parse it
-        op.order!(argv)
-
-        # exit() doesn't work for specs.
-        return if stop === true
-        return puts op if !argv[0]
-
-        # Run the command if it exists
-        cmd = argv.delete_at(0).to_sym
-
-        if Commands.key?(cmd)
-          cmd = Commands[cmd].new
-          cmd.run(argv)
-        else
-          return $stderr.puts "The specified command is invalid"
-        end
-      end
-
-      ##
-      # Generates an array of "rows" where each row contains the name and
-      # description of a command. The descriptions of all commands are aligned
-      # based on the length of the longest command name.
-      #
-      # This method has been ported from Ramaze.
-      #
-      # @author Yorick Peterse
-      # @since  23-07-2011
-      # @return [Array]
-      #
-      def self.commands_info
-        cmds    = []
-        longest = Commands.map { |name, klass| name.to_s }.sort[0].size
-
-        Commands.each do |name, klass|
-          name = name.to_s
-          desc = ''
-
-          # Try to extract the command description
-          if klass.respond_to?(:const_defined?) \
-          and klass.const_defined?(:Description)
-            desc = klass.const_get(:Description)
-          end
-
-          # Align the description based on the length of the name
-          while name.size <= longest do
-            name += ' '
-          end
-
-          cmds.push(["#{name}    #{desc}"])
-        end
-
-        return cmds
-      end
-    end # Runner
-  end # Bin
-end # Zen

data/lib/zen/error/language_error.rb

@@ -1,10 +0,0 @@
-#:nodoc:
-module Zen
-  ##
-  # Error class used by Zen::Language.
-  #
-  # @author Yorick Peterse
-  # @since  0.2.4
-  #
-  class LanguageError < StandardError; end
-end

data/lib/zen/error/package_error.rb

@@ -1,10 +0,0 @@
-#:nodoc:
-module Zen
-  ##
-  # Error class used by Zen::Package.
-  #
-  # @author Yorick Peterse
-  # @since  0.2.4
-  #
-  class PackageError < StandardError; end
-end

data/lib/zen/error/plugin_error.rb

@@ -1,10 +0,0 @@
-#:nodoc:
-module Zen
-  ##
-  # Error class used by Zen::Plugin.
-  #
-  # @author Yorick Peterse
-  # @since  0.2.4
-  #
-  class PluginError < StandardError; end
-end

data/lib/zen/error/theme_error.rb

@@ -1,10 +0,0 @@
-#:nodoc:
-module Zen
-  ##
-  # Error class used by Zen::Theme.
-  #
-  # @author Yorick Peterse
-  # @since  0.2.4
-  #
-  class ThemeError < StandardError; end
-end