zen 0.2.4.1 → 0.2.5

data/lib/zen/task/plugin.rake

@@ -0,0 +1,24 @@
+##
+# Task group for managing plugins.
+#
+# @author Yorick Peterse
+# @since  0.2.5
+#
+namespace :plugin do
+
+  desc 'Lists all installed plugins'
+  task :list do
+    Zen::Plugin::Registered.each do |name, pkg|
+      message = <<-MSG
+--------------------------
+Name: #{name}
+Author: #{pkg.author}
+
+#{pkg.about}
+MSG
+
+      puts message
+    end
+  end
+
+end

data/lib/zen/task/proto.rake

@@ -0,0 +1,95 @@
+require 'fileutils'
+require __DIR__('../ext/string')
+
+##
+# Task group used for creating various prototypes.
+#
+# @author Yorick Peterse
+# @since  0.2.5
+#
+namespace :proto do
+
+  desc 'Creates a new migration'
+  task :migration, :directory, :name do |task, args|
+    # Validate the input
+    if !args[:directory]
+      abort 'You need to specify a directory for the migration.'
+    end
+
+    if !args[:name]
+      abort 'You need to specify a name for the migration.'
+    end
+
+    if !File.directory?(args[:directory])
+      abort "The directory #{args[:directory]} doesn't exist."
+    end
+
+    proto_path = File.expand_path('../../../../proto/migration.rb', __FILE__)
+    new_path   = File.join(args[:directory], "#{Time.new.to_i}_#{args[:name]}.rb")
+
+    # Copy the prototype to the location
+    begin
+      FileUtils.cp(proto_path, new_path)
+      puts "Migration saved in #{new_path}"
+    rescue => e
+      puts "Failed to create the migration: #{e.message}"
+    end
+  end
+
+  desc 'Creates a new package'
+  task :package, :directory, :name do |task, args|
+    # Validate the input
+    if !args[:name]
+      abort 'You need to specify the name of your package.'
+    end
+
+    if !args[:directory]
+      abort 'You need to specify a directory where the package should be saved.'
+    end
+
+    name           = args[:name]
+    proto          = File.expand_path('../../../../proto/package', __FILE__)
+    klass          = name.camel_case
+    extension_path = File.join(args[:directory], name)
+    
+    FileUtils.rm_rf(extension_path)
+    
+    # Rename all files and folders
+    begin
+      FileUtils.cp_r(proto, extension_path)
+      
+      lib_path = "#{extension_path}/lib/#{name}"
+      
+      # Rename the base file and directory
+      FileUtils.mv("#{extension_path}/lib/package"   , lib_path)
+      FileUtils.mv("#{extension_path}/lib/package.rb", "#{extension_path}/lib/#{name}.rb")
+      
+      controller_filename = klass.snake_case.pluralize
+      model_filename      = klass.snake_case.singularize
+      
+      # Generate the controller
+      controller = File.open("#{lib_path}/controller/controllers.rb", 'r').read
+      controller.gsub!('CONTROLLER', klass.pluralize)
+      controller.gsub!('EXTENSION' , klass.pluralize)
+      
+      FileUtils.mv("#{lib_path}/controller/controllers.rb", "#{lib_path}/controller/#{controller_filename}.rb")
+      File.open("#{lib_path}/controller/#{controller_filename}.rb", 'w').write(controller)
+
+      # Move the view directory
+      FileUtils.mv("#{lib_path}/view/admin/package", "#{lib_path}/view/admin/#{controller_filename}")
+      
+      # Generate the model
+      model = File.open("#{lib_path}/model/model.rb", 'r').read
+      model.gsub!('MODEL'     , klass.singularize)
+      model.gsub!('EXTENSION' , klass.pluralize)
+      
+      FileUtils.mv("#{lib_path}/model/model.rb", "#{lib_path}/model/#{model_filename}.rb")
+      File.open("#{lib_path}/model/#{model_filename}.rb", 'w').write(model)
+      
+      puts "Done! Don't forget to rename the controllers/models/etc"
+    rescue => e
+      abort "Failed to generate the package: #{e}"
+    end
+  end
+
+end

data/lib/zen/task/theme.rake

@@ -0,0 +1,68 @@
+##
+# Task group for managing themes.
+#
+# @author Yorick Peterse
+# @since  0.2.5
+#
+namespace :theme do
+
+  desc 'Lists all installed themes'
+  task :list do
+    Zen::Theme::Registered.each do |name, pkg|
+      message = <<-MSG
+--------------------------
+Name: #{name}
+Author: #{pkg.author}
+Template directory: #{pkg.template_dir}
+
+#{pkg.about}
+MSG
+
+      puts message
+    end
+  end
+
+  desc 'Migrates a theme to the given version'
+  task :migrate, :name, :version do |task, args|
+    if !args[:name]
+      abort 'You need to specify the name of the theme.'
+    end
+
+    if !args[:version]
+      version = nil
+      puts 'No version specified, choosing the most recent version...'
+    else
+      version = args[:version].to_i
+    end
+
+    name = args[:name].to_sym
+
+    if !Zen::Theme::Registered[name]
+      abort 'The specified theme does not exist.'
+    end
+
+    theme = Zen::Theme::Registered[name]
+    table = 'migrations_theme_' + theme.name.to_s
+    
+    # Fetch the migrations directory
+    if theme.respond_to?(:migration_dir) and !theme.migration_dir.nil?
+      dir = theme.migration_dir
+    else
+      abort 'The specified theme does not have a migrations directory.'
+    end
+
+    if !File.directory?(dir)
+      abort 'The theme\'s migration directory doesn\'t exist.'
+    end
+
+    # Time to migrate the theme
+    puts 'Migrating...'
+
+    Zen::Database.handle.transaction do
+      Sequel::Migrator.run(
+        Zen::Database.handle, dir, :table => table, :target => version
+      )
+    end
+  end
+
+end

data/lib/zen/theme.rb

@@ -1,4 +1,5 @@
 require __DIR__('error/theme_error')
+require __DIR__('theme/base')
 require 'pathname'
 
 #:nodoc:
@@ -25,32 +26,22 @@ module Zen
   # Example:
   #
   #     Zen::Theme.add do |theme|
-  #       theme.author     = 'Yorick Peterse'
-  #       theme.name       = 'Default'
-  #       theme.identifier = 'com.yorickpeterse.theme.default'
+  #       theme.author = 'Yorick Peterse'
+  #       theme.name   = 'default'
   #     end
   #
-  # The "identifier" key is very important and just like packages and plugins it should
-  # always stay the same once it has been set.
-  #
-  # ## Identifiers
-  #
-  # Theme identifiers should be in the following format:
-  #
-  #     com.VENDOR.theme.NAME
-  #
-  # For example:
-  #
-  #     com.yorickpeterse.theme.fancy_blog
-  #
   # @author Yorick Peterse
   # @since  0.2.4
-  # @attr_reader [Array] themes Array of all installed themes.
   #
   module Theme
-    class << self
-      attr_reader :themes
-    end
+    ##
+    # Hash containing all registered themes. The keys are the names of the themes and
+    # the values instances of Zen::Theme::Base.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    Registered = {}
 
     ##
     # Adds a new theme to Zen. Note that the theme won't be used unless it has been set
@@ -58,33 +49,15 @@ module Zen
     #
     # @author Yorick Peterse
     # @since  0.2.4
-    # @yield  [theme] Struct object containing all getter/setters for each theme.
     #
     def self.add
-      @themes ||= {}
-
-      required = [:name, :author, :about, :identifier, :template_dir]
-      theme    = Zen::StrictStruct.new(
-        :name, :author, :about, :url, :identifier, :template_dir, :partial_dir,
-        :public_dir, :migration_dir
-      ).new
+      theme = Base.new
 
       yield theme
 
-      # Check if all required items have been set
-      theme.validate(required) do |k|
-        raise(Zen::ThemeError, "The following theme key is missing: #{k}")
-      end
-
-      # Validate all paths set
-      [:template_dir, :partial_dir, :public_dir, :migration_dir].each do |k|
-        # Only validate the path if it has been set
-        if theme.respond_to?(k) and !theme.send(k).nil? and !theme.send(k).empty?
-          if !File.exist?(theme.send(k))
-            raise(Zen::ThemeError, "The path #{k} doesn't exist.")
-          end
-        end
-      end
+      # Validate the theme
+      theme.validate
+      theme.name = theme.name.to_sym
 
       # Do we have a public directory?
       if theme.respond_to?(:public_dir) and !theme.public_dir.nil?
@@ -98,11 +71,7 @@ module Zen
         end
       end
 
-      if !@themes[theme.identifier].nil?
-        raise(Zen::ThemeError, "The theme #{theme.name} already exists.")
-      end
-
-      @themes[theme.identifier] = theme
+      Registered[theme.name] = theme
     end
 
     ##
@@ -110,19 +79,23 @@ module Zen
     #
     # @author Yorick Peterse
     # @since  0.2.4
-    # @param  [String] ident The identifier of the theme.
-    # @return [Struct] Instance of the theme.
+    # @param  [String/Symbol] name The name of the theme to retrieve.
+    # @return [Zen::Theme::Base]
     #
-    def self.[](ident)
-      if @themes.nil?
-        raise(Zen::ThemeError, "No themes have been added.")
+    def self.[](name)
+      if name.class != Symbol
+        name = name.to_sym
+      end
+
+      if Registered.nil?
+        raise(Zen::ThemeError, "No themes have been added yet.")
       end
 
-      if !@themes[ident]
-        raise(Zen::ThemeError, "The theme #{ident} doesn't exist.")
+      if !Registered[name]
+        raise(Zen::ThemeError, "The theme #{name} doesn't exist.")
       end
 
-      return @themes[ident]
+      return Registered[name]
     end
 
   end

data/lib/zen/theme/base.rb

@@ -0,0 +1,64 @@
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Theme
+    ##
+    # Base class used for all themes.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Base
+      include ::Zen::Validation
+
+      # The name of the theme
+      attr_accessor :name
+
+      # The author of the theme
+      attr_accessor :author
+
+      # A small description of the theme
+      attr_accessor :about
+
+      # The URL to the theme's homepage
+      attr_accessor :url
+
+      # Path to the directory containing all templates
+      attr_accessor :template_dir
+
+      # Path to the directory containing all template partials
+      attr_accessor :partial_dir
+
+      # Path to the theme's public directory (useful for CSS and Javascript files)
+      attr_accessor :public_dir
+
+      # Path to the directory containing all migrations for the theme
+      attr_accessor :migration_dir
+
+      ##
+      # Validates all attributes of this class.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      #
+      def validate
+        validates_presence([:name, :author, :about, :template_dir])
+
+        # Validate all the directories
+        validates_filepath(:template_dir)
+
+        [:partial_dir, :public_dir, :migration_dir].each do |m|
+          if !send(m).nil?
+            validates_filepath(m)
+          end
+        end
+
+        # Check if the theme hasn't already been registered
+        if ::Zen::Theme::Registered.key?(name.to_sym)
+          raise(::Zen::ValidationError, "The theme #{name} has already been registered.")
+        end
+      end
+
+    end
+  end
+end

data/lib/zen/validation.rb

@@ -0,0 +1,149 @@
+require __DIR__('error/validation_error')
+
+#:nodoc:
+module Zen
+  ##
+  # The Validation module is a very basic validation framework that's used by various
+  # internal modules/classes such as Zen::Plugin and Zen::Package.
+  #
+  # ## Usage
+  #
+  # Using the module is pretty simple. Include it, specify the validation rules in a 
+  # method and call it. All official modules and classes use a method called "validate"
+  # but you're free to name it whatever you want. A basic example looks like the 
+  # following:
+  #
+  #     class Something
+  #       include Zen::Validation
+  #
+  #       attr_accessor :name
+  #
+  #       def validate
+  #         validates_presence(:name)
+  #       end
+  #     end
+  #
+  # @author Yorick Peterse
+  # @since  0.2.5
+  #
+  module Validation
+    
+    ##
+    # Checks if the specified attributes exist and aren't set to nil.
+    #
+    # @example
+    #  validates_presence(:name)
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    # @param  [Array/Symbol/String] attributes Either a single or multiple attributes to
+    # validate.
+    # @raise  [ValidationError] Raised whenever a attribute is missing or is set to nil.
+    #
+    def validates_presence(attributes)
+      if attributes.class != Array
+        attributes = [attributes]
+      end
+
+      attributes.each do |f|
+        if !respond_to?(f) or send(f).nil?
+          raise(ValidationError, "The attribute \"#{f}\" doesn't exist.")
+        end
+      end
+    end
+
+    ##
+    # Checks if the length of a string matches the given length. You can specify a minimum
+    # length, a maximum one as well as both.
+    #
+    # @example
+    #  validates_length(:foobar, :min => 5, :max => 10)
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    # @param  [String/Symbol] attribute The attribute to validate.
+    # @param  [Hash] options Hash containing the options to use for determining how long
+    # the attribute's value should be.
+    # @option options [Fixnum] :min The minimum length of the attribute's value.
+    # @option options [Fixnum] :max The maximum length of the value.
+    # @raise  [ValidationError] Raised then the value of the attribute isn't long or short
+    # enough.
+    #
+    def validates_length(attribute, options)
+      value = send(attribute)
+
+      if !value.respond_to?(:length)
+        raise(
+          ValidationError, 
+          "The length of \"#{attribute}\" can't be checked as the method \"length\" " +
+          "doesn't exist."
+        )
+      end
+
+      # Time to validate the length
+      length = value.length
+
+      if options.key?(:min) and length < options[:min]
+        raise(ValidationError, "The attribute \"#{attribute}\" is too short.")
+      end
+
+      if options.key?(:max) and length > options[:max]
+        raise(ValidationError, "The attribute \"#{attribute}\" is too long.")
+      end
+    end
+
+    ##
+    # Checks if the given attributes match the specified regular expressions.
+    # When a hash is specified the keys should be the names of the attributes to validate
+    # and the values the regular expressions to use.
+    #
+    # @example
+    #  validates_format(:name, /[\w\-]+/)
+    #  validates_format(:name => /[\w\-]+/, :age => /[0-9]+/)
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    # @param  [Hash/Symbol] attribute The name of the attribute to validate or a hash
+    # containing all the attributes and their regular expressions.
+    # @param  [Regexp] regexp The regular expression to use when validating a single
+    # attribute.
+    # @raise [ValidationError] Raised when one of the attributes doesn't matches the 
+    # regular expression.
+    #
+    def validates_format(attribute, regexp = nil)
+      if attribute.class != Hash
+        attribute = {attribute => regexp}
+      end
+
+      # Try to match all attributes
+      attribute.each do |attr, regexp|
+        val   = send(attr)
+        match = val =~ regexp
+
+        if !match
+          raise(ValidationError, "The attribute \"#{attr}\" doesn't match #{regexp}.")
+        end
+      end
+    end
+
+    ##
+    # Checks if the specified attribute contains a valid filepath.
+    #
+    # @example
+    #  validates_filepath(:directory)
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    # @param [String/Symbol] attribute The attribute to validate.
+    # @raise [ValidationError] Raised when one of the paths didn't exist.
+    #
+    def validates_filepath(attribute)
+      path = send(attribute)
+      
+      if !File.exist?(path)
+        raise(ValidationError, "The path #{path} in \"#{attribute}\" doesn't exist.")
+      end
+    end
+
+  end
+end