wycats-merb-core 0.9.8

data/lib/merb-core/server.rb

@@ -0,0 +1,284 @@
+require 'etc'
+module Merb
+
+  # Server encapsulates the management of Merb daemons.
+  class Server
+    class << self
+
+      # Start a Merb server, in either foreground, daemonized or cluster mode.
+      #
+      # ==== Parameters
+      # port<~to_i>::
+      #   The port to which the first server instance should bind to.
+      #   Subsequent server instances bind to the immediately following ports.
+      # cluster<~to_i>::
+      #   Number of servers to run in a cluster.
+      #
+      # ==== Alternatives
+      # If cluster is left out, then one process will be started. This process
+      # will be daemonized if Merb::Config[:daemonize] is true.
+      def start(port, cluster=nil)
+        @port = port
+        @cluster = cluster
+        if @cluster
+          @port.to_i.upto(@port.to_i + @cluster.to_i-1) do |port|
+            pidfile = pid_file(port)
+            pid = IO.read(pidfile).chomp.to_i if File.exist?(pidfile)
+
+            unless alive?(port)
+              remove_pid_file(port)
+              puts "Starting merb server on port #{port}, pid file: #{pidfile} and process id is #{pid}" if Merb::Config[:verbose]
+              daemonize(port)
+            else
+              raise "Merb is already running: port is #{port}, pid file: #{pidfile}, process id is #{pid}"
+            end
+          end
+        elsif Merb::Config[:daemonize]
+          pidfile = pid_file(port)
+          pid = IO.read(pidfile).chomp.to_i if File.exist?(pidfile)
+
+          unless alive?(@port)
+            remove_pid_file(@port)
+            puts "Daemonizing..." if Merb::Config[:verbose]
+            daemonize(@port)
+          else
+            raise "Merb is already running: port is #{port}, pid file: #{pidfile}, process id is #{pid}"
+          end
+        else
+          trap('TERM') { exit }
+
+          if Merb::Config[:console_trap]
+            add_irb_trap
+          else
+            trap('INT') { puts "\nExiting"; exit }
+          end
+
+          puts "Running bootloaders..." if Merb::Config[:verbose]
+          BootLoader.run
+          puts "Starting Rack adapter..." if Merb::Config[:verbose]
+          Merb.logger.info! "Starting Merb server listening at #{Merb::Config[:host]}:#{port}"
+          Merb.adapter.start(Merb::Config.to_hash)
+        end
+      end
+
+      # ==== Parameters
+      # port<~to_s>:: The port to check for Merb instances on.
+      #
+      # ==== Returns
+      # Boolean::
+      #   True if Merb is running on the specified port.
+      def alive?(port)
+        puts "About to check if port #{port} is alive..." if Merb::Config[:verbose]
+        pidfile = pid_file(port)
+        puts "Pidfile is #{pidfile}..." if Merb::Config[:verbose]
+        pid = IO.read(pidfile).chomp.to_i
+        puts "Process id is #{pid}" if Merb::Config[:verbose]
+        Process.kill(0, pid)
+        true
+      rescue
+        false
+      end
+
+      # ==== Parameters
+      # port<~to_s>:: The port of the Merb process to kill.
+      # sig<~to_s>:: The signal to send to the process. Defaults to 9.
+      #
+      # ==== Alternatives
+      # If you pass "all" as the port, the signal will be sent to all Merb
+      # processes.
+      def kill(port, sig=9)
+        Merb::BootLoader::BuildFramework.run
+        begin
+          pidfiles = port == "all" ?
+            pid_files : [ pid_file(port) ]
+
+          pidfiles.each do |f|
+            pid = IO.read(f).chomp.to_i
+            begin
+              Process.kill(sig, pid)
+              FileUtils.rm(f) if File.exist?(f)
+              puts "killed PID #{pid} with signal #{sig}"
+            rescue Errno::EINVAL
+              puts "Failed to kill PID #{pid}: '#{sig}' is an invalid or unsupported signal number."
+            rescue Errno::EPERM
+              puts "Failed to kill PID #{pid}: Insufficient permissions."
+            rescue Errno::ESRCH
+              puts "Failed to kill PID #{pid}: Process is deceased or zombie."
+              FileUtils.rm f
+            rescue Exception => e
+              puts "Failed to kill PID #{pid}: #{e.message}"
+            end
+          end
+        ensure
+          Merb.started = false
+          exit
+        end
+      end
+
+      # ==== Parameters
+      # port<~to_s>:: The port of the Merb process to daemonize.
+      def daemonize(port)
+        puts "About to fork..." if Merb::Config[:verbose]
+        fork do
+          Process.setsid
+          exit if fork
+          File.umask 0000
+          STDIN.reopen "/dev/null"
+          STDOUT.reopen "/dev/null", "a"
+          STDERR.reopen STDOUT
+          trap("TERM") { exit }
+          Dir.chdir Merb::Config[:merb_root]
+          at_exit { remove_pid_file(port) }
+          Merb::Config[:port] = port
+          BootLoader.run
+          Merb.adapter.start(Merb::Config.to_hash)
+        end
+      end
+
+      def change_privilege
+        if Merb::Config[:user]
+          if Merb::Config[:group]
+            puts "About to change privilege to group #{Merb::Config[:group]} and user #{Merb::Config[:user]}" if Merb::Config[:verbose]
+            _change_privilege(Merb::Config[:user], Merb::Config[:group])
+          else
+            puts "About to change privilege to user #{Merb::Config[:user]}" if Merb::Config[:verbose]
+            _change_privilege(Merb::Config[:user])
+          end
+        end
+      end
+
+      # Removes a PID file used by the server from the filesystem.
+      # This uses :pid_file options from configuration when provided
+      # or merb.<port>.pid in log directory by default.
+      #
+      # ==== Parameters
+      # port<~to_s>::
+      #   The port of the Merb process to whom the the PID file belongs to.
+      #
+      # ==== Alternatives
+      # If Merb::Config[:pid_file] has been specified, that will be used
+      # instead of the port based PID file.
+      def remove_pid_file(port)
+        pidfile = pid_file(port)
+        puts "Removing pid file #{pidfile} (port is #{port})..."
+        FileUtils.rm(pidfile) if File.exist?(pidfile)
+      end
+
+      # Stores a PID file on the filesystem.
+      # This uses :pid_file options from configuration when provided
+      # or merb.<port>.pid in log directory by default.
+      #
+      # ==== Parameters
+      # port<~to_s>::
+      #   The port of the Merb process to whom the the PID file belongs to.
+      #
+      # ==== Alternatives
+      # If Merb::Config[:pid_file] has been specified, that will be used
+      # instead of the port based PID file.
+      def store_pid(port)
+        pidfile = pid_file(port)
+        puts "Storing pid file to #{pidfile}..."
+        FileUtils.mkdir_p(File.dirname(pidfile)) unless File.directory?(File.dirname(pidfile))
+        puts "Created directory, writing process id..." if Merb::Config[:verbose]
+        File.open(pidfile, 'w'){ |f| f.write("#{Process.pid}") }
+      end
+
+      # Gets the pid file for the specified port.
+      #
+      # ==== Parameters
+      # port<~to_s>::
+      #   The port of the Merb process to whom the the PID file belongs to.
+      #
+      # ==== Returns
+      # String::
+      #   Location of pid file for specified port. If clustered and pid_file option
+      #   is specified, it adds the port value to the path.
+      def pid_file(port)
+        if Merb::Config[:pid_file]
+          pidfile = Merb::Config[:pid_file]
+          if Merb::Config[:cluster]
+            ext = File.extname(Merb::Config[:pid_file])
+            base = File.basename(Merb::Config[:pid_file], ext)
+            dir = File.dirname(Merb::Config[:pid_file])
+            File.join(dir, "#{base}.#{port}#{ext}")
+          else
+            Merb::Config[:pid_file]
+          end
+        else
+          pidfile = Merb.log_path / "merb.#{port}.pid"
+          Merb.log_path / "merb.#{port}.pid"
+        end
+      end
+
+      # Get a list of the pid files.
+      #
+      # ==== Returns
+      # Array::
+      #   List of pid file paths. If not clustered, array contains a single path.
+      def pid_files
+        if Merb::Config[:pid_file]
+          if Merb::Config[:cluster]
+            ext = File.extname(Merb::Config[:pid_file])
+            base = File.basename(Merb::Config[:pid_file], ext)
+            dir = File.dirname(Merb::Config[:pid_file])
+            Dir[dir / "#{base}.*#{ext}"]
+          else
+            [ Merb::Config[:pid_file] ]
+          end
+        else
+          Dir[Merb.log_path / "merb.*.pid"]
+        end
+       end
+
+      # Change privileges of the process to the specified user and group.
+      #
+      # ==== Parameters
+      # user<String>:: The user who should own the server process.
+      # group<String>:: The group who should own the server process.
+      #
+      # ==== Alternatives
+      # If group is left out, the user will be used as the group.
+      def _change_privilege(user, group=user)
+
+        puts "Changing privileges to #{user}:#{group}"
+
+        uid, gid = Process.euid, Process.egid
+        target_uid = Etc.getpwnam(user).uid
+        target_gid = Etc.getgrnam(group).gid
+
+        if uid != target_uid || gid != target_gid
+          # Change process ownership
+          Process.initgroups(user, target_gid)
+          Process::GID.change_privilege(target_gid)
+          Process::UID.change_privilege(target_uid)
+        end
+      rescue Errno::EPERM => e
+        puts "Couldn't change user and group to #{user}:#{group}: #{e}"
+      end
+
+      def add_irb_trap
+        trap('INT') do
+          exit if @interrupted
+          @interrupted = true
+          puts "Interrupt a second time to quit"
+          Kernel.sleep 1.5
+          ARGV.clear # Avoid passing args to IRB
+
+          if @irb.nil?
+            require 'irb'
+            IRB.setup(nil)
+            @irb = IRB::Irb.new(nil)
+            IRB.conf[:MAIN_CONTEXT] = @irb.context
+          end
+
+          trap(:INT) { @irb.signal_handle }
+          catch(:IRB_EXIT) { @irb.eval_input }
+
+          puts "Exiting IRB mode, back in server mode"
+          @interrupted = false
+          add_irb_trap
+        end
+      end
+    end
+  end
+end

data/lib/merb-core/tasks/audit.rake

@@ -0,0 +1,68 @@
+namespace :audit do
+
+  desc "Print out the named and anonymous routes"
+  task :routes => :merb_env do
+    seen = []
+    unless Merb::Router.named_routes.empty?
+      puts "Named Routes"
+      Merb::Router.named_routes.each do |name,route|
+        puts "  #{name}: #{route}"
+        seen << route
+      end
+    end
+    puts "Anonymous Routes"
+    (Merb::Router.routes - seen).each do |route|
+      puts "  #{route}"
+    end
+    nil
+  end
+
+  desc "Print out all controllers"
+  task :controllers => :merb_env do
+    puts "\nControllers:\n\n"
+    abstract_controller_classes.each do |klass|
+      if klass.respond_to?(:subclasses_list)
+        puts "#{klass} < #{klass.superclass}"
+        subklasses = klass.subclasses_list.sort.map { |x| Object.full_const_get(x) }
+        unless subklasses.empty?
+          subklasses.each { |subklass| puts "- #{subklass}" }
+        else
+          puts "~ no subclasses"
+        end
+        puts
+      end
+    end
+  end
+  
+  desc "Print out controllers and their actions (use CONTROLLER=Foo,Bar to be selective)"
+  task :actions => :merb_env do
+    puts "\nControllers and their actions:\n\n"
+    filter_controllers = ENV['CONTROLLER'] ? ENV['CONTROLLER'].split(',') : nil
+    abstract_controllers = abstract_controller_classes
+    classes = Merb::AbstractController.subclasses_list.sort.map { |x| Object.full_const_get(x) }
+    classes = classes.select { |k| k.name.in?(filter_controllers) } if filter_controllers
+    classes.each do |subklass|
+      next if subklass.in?(abstract_controllers) || !subklass.respond_to?(:callable_actions)
+      puts "#{subklass} < #{subklass.superclass}"
+      unless subklass.callable_actions.empty?
+        subklass.callable_actions.sort.each do |action, null|
+          if subklass.respond_to?(:action_argument_list)
+            arguments, defaults = subklass.action_argument_list[action]
+            args = arguments.map { |name, value| value ? "#{name} = #{value.inspect}" : name.to_s }.join(', ')
+            puts args.empty? ? "- #{action}" : "- #{action}(#{args})"
+          else
+            puts "- #{action}"
+          end
+        end
+      else
+        puts "~ no callable actions"
+      end
+      puts
+    end    
+  end
+  
+  def abstract_controller_classes
+    ObjectSpace.classes.select { |x| x.superclass == Merb::AbstractController }.sort_by { |x| x.name }
+  end
+  
+end

data/lib/merb-core/tasks/gem_management.rb

@@ -0,0 +1,229 @@
+require 'rubygems'
+require 'rubygems/dependency_installer'
+require 'rubygems/uninstaller'
+require 'rubygems/dependency'
+
+module GemManagement
+  
+  # Install a gem - looks remotely and local gem cache;
+  # won't process rdoc or ri options.
+  def install_gem(gem, options = {})
+    from_cache = (options.key?(:cache) && options.delete(:cache))
+    if from_cache
+      install_gem_from_cache(gem, options)
+    else
+      version = options.delete(:version)
+      Gem.configuration.update_sources = false
+
+      update_source_index(options[:install_dir]) if options[:install_dir]
+
+      installer = Gem::DependencyInstaller.new(options.merge(:user_install => false))
+      exception = nil
+      begin
+        installer.install gem, version
+      rescue Gem::InstallError => e
+        exception = e
+      rescue Gem::GemNotFoundException => e
+        if from_cache && gem_file = find_gem_in_cache(gem, version)
+          puts "Located #{gem} in gem cache..."
+          installer.install gem_file
+        else
+          exception = e
+        end
+      rescue => e
+        exception = e
+      end
+      if installer.installed_gems.empty? && exception
+        puts "Failed to install gem '#{gem} (#{version})' (#{exception.message})"
+      end
+      installer.installed_gems.each do |spec|
+        puts "Successfully installed #{spec.full_name}"
+      end
+      return !installer.installed_gems.empty?
+    end
+  end
+
+  # Install a gem - looks in the system's gem cache instead of remotely;
+  # won't process rdoc or ri options.
+  def install_gem_from_cache(gem, options = {})
+    version = options.delete(:version)
+    Gem.configuration.update_sources = false
+    installer = Gem::DependencyInstaller.new(options.merge(:user_install => false))
+    exception = nil
+    begin
+      if gem_file = find_gem_in_cache(gem, version)
+        puts "Located #{gem} in gem cache..."
+        installer.install gem_file
+      else
+        raise Gem::InstallError, "Unknown gem #{gem}"
+      end
+    rescue Gem::InstallError => e
+      exception = e
+    end
+    if installer.installed_gems.empty? && exception
+      puts "Failed to install gem '#{gem}' (#{e.message})"
+    end
+    installer.installed_gems.each do |spec|
+      puts "Successfully installed #{spec.full_name}"
+    end
+  end
+
+  # Install a gem from source - builds and packages it first then installs.
+  def install_gem_from_src(gem_src_dir, options = {})
+    if !File.directory?(gem_src_dir)
+      raise "Missing rubygem source path: #{gem_src_dir}"
+    end
+    if options[:install_dir] && !File.directory?(options[:install_dir])
+      raise "Missing rubygems path: #{options[:install_dir]}"
+    end
+
+    gem_name = File.basename(gem_src_dir)
+    gem_pkg_dir = File.expand_path(File.join(gem_src_dir, 'pkg'))
+
+    # We need to use local bin executables if available.
+    thor = "#{Gem.ruby} -S #{which('thor')}"
+    rake = "#{Gem.ruby} -S #{which('rake')}"
+
+    # Handle pure Thor installation instead of Rake
+    if File.exists?(File.join(gem_src_dir, 'Thorfile'))
+      # Remove any existing packages.
+      FileUtils.rm_rf(gem_pkg_dir) if File.directory?(gem_pkg_dir)
+      # Create the package.
+      FileUtils.cd(gem_src_dir) { system("#{thor} :package") }
+      # Install the package using rubygems.
+      if package = Dir[File.join(gem_pkg_dir, "#{gem_name}-*.gem")].last
+        FileUtils.cd(File.dirname(package)) do
+          install_gem(File.basename(package), options.dup)
+          return
+        end
+      else
+        raise Gem::InstallError, "No package found for #{gem_name}"
+      end
+    # Handle standard installation through Rake
+    else
+      # Clean and regenerate any subgems for meta gems.
+      Dir[File.join(gem_src_dir, '*', 'Rakefile')].each do |rakefile|
+        FileUtils.cd(File.dirname(rakefile)) do 
+          system("#{rake} clobber_package; #{rake} package")
+        end
+      end
+
+      # Handle the main gem install.
+      if File.exists?(File.join(gem_src_dir, 'Rakefile'))
+        # Remove any existing packages.
+        FileUtils.cd(gem_src_dir) { system("#{rake} clobber_package") }
+        # Create the main gem pkg dir if it doesn't exist.
+        FileUtils.mkdir_p(gem_pkg_dir) unless File.directory?(gem_pkg_dir)
+        # Copy any subgems to the main gem pkg dir.
+        Dir[File.join(gem_src_dir, '*', 'pkg', '*.gem')].each do |subgem_pkg|
+          dest = File.join(gem_pkg_dir, File.basename(subgem_pkg))
+          FileUtils.copy_entry(subgem_pkg, dest, true, false, true)          
+        end
+
+        # Finally generate the main package and install it; subgems
+        # (dependencies) are local to the main package.
+        FileUtils.cd(gem_src_dir) do
+          system("#{rake} package")
+          FileUtils.cd(gem_pkg_dir) do
+            if package = Dir[File.join(gem_pkg_dir, "#{gem_name}-*.gem")].last
+              # If the (meta) gem has it's own package, install it.
+              install_gem(File.basename(package), options.dup)
+            else
+              # Otherwise install each package seperately.
+              Dir["*.gem"].each { |gem| install_gem(gem, options.dup) }
+            end
+          end
+          return
+        end
+      end
+    end
+    raise Gem::InstallError, "No Rakefile found for #{gem_name}"
+  end
+
+  # Uninstall a gem.
+  def uninstall_gem(gem, options = {})
+    if options[:version] && !options[:version].is_a?(Gem::Requirement)
+      options[:version] = Gem::Requirement.new ["= #{options[:version]}"]
+    end
+    update_source_index(options[:install_dir]) if options[:install_dir]
+    Gem::Uninstaller.new(gem, options).uninstall
+  end
+
+  # Use the local bin/* executables if available.
+  def which(executable)
+    if File.executable?(exec = File.join(Dir.pwd, 'bin', executable))
+      exec
+    else
+      executable
+    end
+  end
+  
+  # Create a modified executable wrapper in the specified bin directory.
+  def ensure_bin_wrapper_for(gem_dir, bin_dir, *gems)
+    if bin_dir && File.directory?(bin_dir)
+      gems.each do |gem|
+        if gemspec_path = Dir[File.join(gem_dir, 'specifications', "#{gem}-*.gemspec")].last
+          spec = Gem::Specification.load(gemspec_path)
+          spec.executables.each do |exec|
+            executable = File.join(bin_dir, exec)
+            puts "Writing executable wrapper #{executable}"
+            File.open(executable, 'w', 0755) do |f|
+              f.write(executable_wrapper(spec, exec))
+            end
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def executable_wrapper(spec, bin_file_name)
+    <<-TEXT
+#!#{Gem.ruby}
+#
+# This file was generated by Merb's GemManagement
+#
+# The application '#{spec.name}' is installed as part of a gem, and
+# this file is here to facilitate running it.
+
+begin 
+  require 'minigems'
+rescue LoadError 
+  require 'rubygems'
+end
+
+if File.directory?(gems_dir = File.join(Dir.pwd, 'gems')) ||
+   File.directory?(gems_dir = File.join(File.dirname(__FILE__), '..', 'gems'))
+  $BUNDLE = true; Gem.clear_paths; Gem.path.unshift(gems_dir)
+end
+
+version = "#{Gem::Requirement.default}"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem '#{spec.name}', version
+load '#{bin_file_name}'
+TEXT
+  end
+
+  def find_gem_in_cache(gem, version)
+    spec = if version
+      version = Gem::Requirement.new ["= #{version}"] unless version.is_a?(Gem::Requirement)
+      Gem.source_index.find_name(gem, version).first
+    else
+      Gem.source_index.find_name(gem).sort_by { |g| g.version }.last
+    end
+    if spec && File.exists?(gem_file = "#{spec.installation_path}/cache/#{spec.full_name}.gem")
+      gem_file
+    end
+  end
+
+  def update_source_index(dir)
+    Gem.source_index.load_gems_in(File.join(dir, 'specifications'))
+  end
+  
+end