zen 0.1a → 0.2

data/lib/zen/task/build.rb

@@ -0,0 +1,123 @@
+require 'fileutils'
+require 'find'
+
+module Zen
+  module Task
+    ##
+    # The Build class/task can be used to create the documentation, manifest, etc.
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    #
+    class Build < Thor
+      include Thor::Actions
+
+      namespace :build
+
+      desc 'gem', 'Builds a new RubyGem'
+
+      ##
+      # Builds a new version of the RubyGem and places it in ./pkg
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def gem
+        zen_path = File.expand_path('../../../../', __FILE__)
+
+        # Build and install the gem
+        run("gem build #{zen_path}/zen.gemspec")
+        run("mv #{zen_path}/zen-#{Zen::Version}.gem #{zen_path}/pkg")
+        run("gem install #{zen_path}/pkg/zen-#{Zen::Version}.gem")
+      end
+
+      desc 'gem_clean', 'Builds a new RubyGem and uninstalls any current versions of Zen'
+
+      ##
+      # Builds a new version of the RubyGem and uninstalls any current versions of Zen.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      # 
+      def gem_clean
+        zen_path = File.expand_path('../../../../', __FILE__)
+
+        begin
+          run('gem uninstall zen')
+        rescue
+          puts "Failed to uninstall the gem, most likely it wasn't installed in the first place."
+        end
+        
+        # Remove all logs files
+        log_dirs = Dir.glob(zen_path + '/spec/zen/log/**/*')
+        
+        if !log_dirs.empty?
+          log_dirs.each do |dir|
+            # Ignore non-directory files
+            if File.directory?(dir)
+              FileUtils.rm_rf(dir)
+            end
+          end
+        end
+        
+        self.gem
+      end
+
+      desc 'manifest', 'Builds the MANIFEST file'
+
+      ##
+      # Builds the MANIFEST file and places it in ./
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      # 
+      def manifest
+        zen_path = File.expand_path('../../../../', __FILE__)
+
+        ignore_exts  = ['.gem', '.gemspec']
+        ignore_files = ['.DS_Store', '.gitignore']
+        ignore_dirs  = ['.git', '.yardoc', 'spec', 'pkg', 'doc']
+        files        = ''
+        
+        Find.find(zen_path) do |f|
+          f[zen_path] = ''
+          f.gsub!(/^\//, '')
+
+          # Ignore directories
+          if !File.directory?(f) and !ignore_exts.include?(File.extname(f)) and !ignore_files.include?(File.basename(f))
+            files  += "#{f}\n"
+          else
+            Find.prune if ignore_dirs.include?(f)
+          end
+        end
+        
+        # Time to write the MANIFEST file
+        begin
+          handle = File.open 'MANIFEST', 'w'
+          handle.write files.strip
+          abort "The MANIFEST file has been updated."
+        rescue
+          abort "The MANIFEST file could not be written."
+        end
+      end
+
+      desc 'doc', 'Builds the documentation using YARD'
+
+      ##
+      # Builds the documentation using YARD.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def doc
+        zen_path = File.expand_path('../../../../', __FILE__)
+        command  = "yard doc #{zen_path}/lib -m markdown -M rdiscount -o #{zen_path}/doc "
+        command += "-r #{zen_path}/README.md --private --protected "
+        command += "--files #{zen_path}/license.txt,#{zen_path}/CHANGELOG.md,"
+        command += "#{zen_path}/ROADMAP.md"
+
+        run(command)
+      end 
+    end
+  end
+end

data/lib/zen/task/clean.rb

@@ -0,0 +1,46 @@
+require 'fileutils'
+
+module Zen
+  module Task
+    ##
+    # The Clean task can be used to remove various files from the repository.
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    #
+    class Clean < Thor
+      include Thor::Actions
+
+      namespace :clean
+
+      ##
+      # Removes all log files from the spec directory.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      desc 'log', 'Removes all log files from the spec directory'
+      def log
+        zen_path = File.expand_path('../../../../', __FILE__)
+
+        log_files = Dir.glob("#{zen_path}/spec/log/**/*.log")
+        log_files.each { |file| File.unlink(file) }
+      end
+
+      ##
+      # Removes all files generated by YARD.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      desc 'yard', 'Removes all files generated by YARD'
+      def yard
+        zen_path = File.expand_path('../../../../', __FILE__)
+
+        FileUtils.rm_rf("#{zen_path}/doc")
+        FileUtils.rm_rf("#{zen_path}/.yardoc")
+      end
+
+    end
+  end
+end

data/lib/zen/task/db.rb

@@ -0,0 +1,120 @@
+Sequel.extension(:migration)
+
+module Zen
+  module Task
+    ##
+    # Task that can be used for various database related operations such as creating
+    # a default user and migrating the entire database.
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    #
+    class DB < Thor
+      namespace :db
+
+      desc('migrate', 'Migrates the entire database to the latest version')
+
+      ##
+      # Migrates the entire database to the latest version.
+      #
+      # @author Yorick Peterse
+      # @param  [Boolean] show_output When set to false no output will be shown.
+      # @since  0.2
+      #
+      def migrate(show_output = true)
+        exts = Zen::Package.extensions
+
+        puts "Migrating..." if show_output === true
+
+        exts.each do |ident, ext|
+          dir   = ext.directory + '/../../migrations'
+          table = ext.identifier.gsub('.', '_').to_sym
+            
+          if File.directory?(dir)
+            Zen::Database.handle.transaction do
+              Sequel::Migrator.run(Zen::Database.handle, dir, :table => table)
+            
+              puts "Successfully migrated \"#{ext.name}\"" if show_output === true
+            end
+          end
+        end
+      end
+
+      desc('delete', 'Deletes all database tables')
+
+      ##
+      # Deletes all database tables.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def delete
+        exts = Zen::Package.extensions.map { |ident, ext| [ident, ext] }
+
+        exts.reverse.each do |ident, ext|
+          dir   = ext.directory + '/../../migrations'
+          table = ext.identifier.gsub('.', '_').to_sym
+            
+          if File.directory?(dir)
+            Zen::Database.handle.transaction do
+              puts "Uninstalling \"#{ext.name}\""
+              
+              Sequel::Migrator.run(Zen::Database.handle, dir, :table => table, :target => 0)
+              
+              # Remove the migrations table
+              Zen::Database.handle.drop_table table
+            end
+          end
+        end
+      end
+
+      desc('user', 'Creates a default administrator account')
+
+      ##
+      # Creates a default administrator account.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def user
+        password = (0..12).map do
+          letter = ('a'..'z').to_a[rand(26)]
+          number = (0..9).to_a[rand(26)]
+          
+          letter + number.to_s
+        end.join
+      
+        # Only insert the user if it isn't there yet.
+        user  = Users::Models::User[:email => 'admin@website.tld']
+        group = Users::Models::UserGroup[:slug => 'administrators']
+        
+        if group.nil?
+          group = Users::Models::UserGroup.new(
+            :name => 'Administrators',
+            :slug => 'administrators', :super_group => true
+          ).save
+        end
+        
+        if !user.nil?
+          abort "The default user has already been inserted."
+        end
+        
+        user = Users::Models::User.new(
+          :email => 'admin@website.tld', :name => 'Administrator',
+          :password => password, :status => 'open'
+        ).save
+        
+        user.user_group_pks = [group.id]
+        
+        puts "Default administrator account has been created.
+
+Email: admin@website.tld
+Passowrd: #{password}
+
+You can login by going to http://domain.tld/admin/users/login/
+"
+
+      end
+    end
+  end
+end

data/lib/zen/task/package.rb

@@ -0,0 +1,82 @@
+Sequel.extension(:migration)
+
+module Zen
+  module Task
+    ##
+    # The Package task is used to install, delete and manage Zen packages.
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    #
+    class Package < Thor
+      namespace :package
+
+      desc('list', 'Lists all installed packages')
+
+      ##
+      # Lists all installed extensions.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def list
+        table = []
+        table.push(['Name', 'Author', 'Identifier', 'Version', 'Type', 'Directory'])
+        table.push(['------', '------', '------', '------', '------','------'])
+        packages = Zen::Package.extensions.merge(Zen::Package.themes)
+
+        packages.each do |ident, ext|
+          table.push([ext.name, ext.author, ext.identifier, ext.version.to_s, ext.type, ext.directory])
+        end
+
+        print_table(table)
+      end 
+
+      desc('migrate', 'Migrates a package to the given version')
+
+      method_option(:version   , :type => :numeric, :default => nil)
+      method_option(:identifier, :type => :string , :default => nil, :required => true)
+     
+      ##
+      # Migrates a package to the given version.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def migrate
+        version = options[:version]
+        ident   = options[:identifier]
+        
+        if Zen::Package.extensions.nil? or Zen::Package.extensions.empty?
+          abort "No packages have been loaded. Be sure to add them to config/requires.rb."
+        end
+
+        if version.nil?
+          puts "No version specified with --version, choosing the most recent version..."
+        end
+
+        install_ext = Zen::Package[ident]
+
+        if ident.nil? or ident.empty?
+          abort "You specified an invalid identifier."
+        end
+
+        dir   = install_ext.directory + '/../../migrations'
+        table = install_ext.identifier.gsub('.', '_').to_sym
+         
+        puts "Migrating package..."
+        if File.directory?(dir)
+          Zen::Database.handle.transaction do
+            Sequel::Migrator.run(Zen::Database.handle, dir, :table => table, :target => version)
+            
+            if version == 0
+              # Remove the migrations table
+              Zen::Database.handle.drop_table table
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/zen/task/proto.rb

@@ -0,0 +1,116 @@
+require 'fileutils'
+require 'ruby-extensions'
+
+module Zen
+  module Task
+    ##
+    # The Proto task can be used to create migrations, packages and full blown applications.
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    #
+    class Proto < Thor
+      namespace :proto
+
+      desc 'migration', 'Creates a new migration'
+      method_option :directory, :type => :string, :required => true
+
+      ##
+      # Creates a new (blank) migration.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def migration
+        dir        = options[:directory]
+        proto_path = File.expand_path('../../../../proto/migration.rb', __FILE__)
+      
+        # Get the name
+        name = ask("Migration name:")
+        
+        # If no directory is specified we'll store the migrations under ./migrations
+        if dir.nil? or dir == ''
+          if !File.directory?('./migrations')
+            abort "No directory specified and ./migrations doesn't exist"
+          else  
+            dir = './migrations'
+            puts "Using ./migrations"
+          end
+        else  
+          puts "Using #{dir}"
+        end
+        
+        # Generate the prototype
+        puts "Generating..."
+        
+        proto = File.open(proto_path, 'r').read
+        path  = "#{dir}/#{Time.new.to_i}_#{name}.rb"
+        
+        begin
+          File.open(path, 'w').write(proto)
+          puts "Done!"
+        rescue => e
+          puts "Failed to generate the migration: #{e}"
+        end
+      end
+
+      desc 'package', 'Creates a new package'
+      method_option :directory, :type => :string, :required => true
+
+      ##
+      # Creates a new package.
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      #
+      def package
+        name           = ask("Package name:").strip.downcase.gsub(' ', '_')
+        proto          = File.expand_path('../../../../proto/package', __FILE__)
+        klass          = name.camel_case
+        extension_path = options[: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 extesion: #{e}"
+        end
+      end
+
+    end
+  end
+end