phpow 0.0.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2eed5b96c884f3eff408f84ec68a64fd21b5747
+  data.tar.gz: d94a5d3d20c08815add5fe9f04ece86a67b0ef0e
+SHA512:
+  metadata.gz: 3e8661ea2fc257257e34bfbafaf99e8f15f7fe4181993bdc95ce071aa80c57222ed4ecf8d0f42edcbe5cd300afc4b1a328951404a98dcefb08cd3633658381a0
+  data.tar.gz: 51af992bc6ca45bf964a3b909b8a27d837a802b577b9eafb2ded27f552408a93500e9b46b32d5022705377d24ea610730a2bef08930ef200d3cfc2b667cffda3

data/README.md

@@ -1,51 +1,30 @@
 Phpow
 =====
 
-Develop your legacy PHP applications utilizing POW's TLDs on Mac OS X
+Develop your legacy PHP applications utilizing POW's TLDs on Mac OS X.
 
 Installation
 ------------
 
-Add this line to your application's Gemfile:
-
-    gem 'phpow'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install phpow
+```bash
+gem install phpow
+```
 
 Usage
 -----
 
-`phpow install`
-
-Creates the apache configuration file that will listen on port 8888
-
-`phpow uninstall`
+`phpow -h` for all commands and options.
 
-Removes the apache configuration file that will listen on port 8888
-
-`phpow create`
-
-Creates symbolic links to phpow's `config.ru` and `.powconfig` files in the current working directory.
+### Configuration
 
-`phpow destroy`
+By default phpow will set up apache to listen on port 8888, and serve projects from the folder `~/Sites`.
 
-Removes the symbolic links to phpow's `config.ru` and `.powconfig` files in the current working directory.
+Use the `--port PORT` and `--folder FOLDER` options to use a different port/location.
 
-### Configuration
+POW
+---
 
-By default phpow will set up apache to listen on port 8888, and serve projects from `/Users/username/Sites`. Either one of these defaults can be overridden by creating a `.phpowconfig` file in your home directory.
-
-```
-# ~/.phpowconfig Example
-export PHPOW_APACHE_PORT=8080
-export PHPOW_PROJECTS_DIRECTORY=/Users/username/another/specific/directory
-```
+Set up a POW to portmap to your apache port. If you have the [powder](https://github.com/Rodreegez/powder) gem `powder portmap 8888` will do the trick.
 
 Contributing
 ------------

data/bin/phpow

@@ -1,11 +1,39 @@
 #!/usr/bin/env ruby
-
-lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
-$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
 
 require 'phpow'
+require 'optparse'
+
+args = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: phpow COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     preview: preview apache.conf"
+  opt.separator  "     install: install apache.conf"
+  opt.separator  "     uninstall: delete apache.conf"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-p", "--port PORT", "the port apache will listen on") do |port|
+    args[:port] = port
+  end
+
+  opt.on("-f", "--folder FOLDER", "the folder that will serve as apache's document root") do |document_root|
+    args[:document_root] = document_root
+  end
+
+  opt.on("-h","--help","help") do
+  end
+end
+
+opt_parser.parse!
 
-args = ARGV.dup
-ARGV.clear
+command_name = ARGV.shift
+if %w[preview install uninstall].include?(command_name)
+  Phpow::ApacheConfiguration.new(args).send(command_name)
+else
+  puts opt_parser
+end
 
-Phpow::Client.run(args)

data/lib/phpow.rb

@@ -1 +1 @@
-require 'phpow/core'
+require 'phpow/apache_configuration'

data/lib/phpow/apache_configuration.rb

@@ -0,0 +1,71 @@
+require 'erb'
+
+module Phpow
+  class ApacheConfiguration
+    attr_accessor :port, :document_root
+
+    def initialize(args = {})
+      @port = args.fetch(:port, 8888)
+      @document_root = args.fetch(:document_root, default_document_root)
+    end
+
+    def preview
+      puts template_result
+    end
+
+    def install
+      puts "You are about to write the file '#{pathname}'?"
+      print "Enter 'yes' to confirm: "
+      return unless gets.strip == "yes"
+
+      write_file
+    end
+
+    def uninstall
+      puts "You are about to permanently delete the file '#{pathname}'?"
+      print "Enter 'yes' to confirm: "
+      return unless gets.strip == "yes"
+
+      File.delete(pathname)
+    end
+
+    private
+
+    def pathname
+      "/etc/apache2/users/#{user}.conf"
+    end
+
+    def user
+      %x{whoami}.strip
+    end
+
+    def default_document_root
+      "/Users/#{user}/Sites"
+    end
+
+    def ensure_file_has_ideal_permissions
+      File.chmod(0644, pathname)
+    end
+
+    def ensure_file_is_writable
+      unless File.owned?(pathname)
+        puts "'#{File.dirname(pathname)}' is write protected by root. You will have to enter your administrator password in order to create #{pathname}"
+        %x{sudo touch #{pathname} && sudo chown #{user} #{pathname}}
+      end
+    end
+
+    def write_file
+      ensure_file_is_writable
+      ensure_file_has_ideal_permissions
+      File.write(pathname, template_result)
+    end
+
+    def template_result
+      template_source.result(instance_eval { binding })
+    end
+
+    def template_source
+      ERB.new(File.read(File.join(File.dirname(__FILE__), "templates", "apache.conf.erb")))
+    end
+  end
+end

data/lib/phpow/templates/apache.conf.erb

@@ -1,4 +1,4 @@
-# Apache configuration
+# Apache configuration generated by phpow
 # Should be written to /etc/apache2/users/username.conf on Mac OS X
 
 # Enable PHP
@@ -11,12 +11,12 @@ LoadModule php5_module libexec/apache2/libphp5.so
   </IfModule>
 </IfModule>
 
-# Pow is using port 80. Will forward to apache on <%= apache_port %> using Phpow::RackApp
-Listen <%= apache_port %>
+# Pow is using port 80. Will forward to apache on <%= port %>
+Listen <%= port %>
 
 # Virtual hosts, piggy-backing on POW's .dev
-DocumentRoot <%= projects_directory %>
-<Directory "<%= projects_directory %>/">
+DocumentRoot <%= document_root %>
+<Directory "<%= document_root %>/">
   Options Indexes MultiViews FollowSymLinks
   AllowOverride All
   Order allow,deny
@@ -25,5 +25,5 @@ DocumentRoot <%= projects_directory %>
 
 NameVirtualHost 127.0.0.1
 <VirtualHost 127.0.0.1>
-  VirtualDocumentRoot <%= projects_directory %>/%-2+
+  VirtualDocumentRoot <%= document_root %>/%-2+
 </VirtualHost>

data/lib/phpow/version.rb

@@ -1,3 +1,3 @@
 module Phpow
-  VERSION = "0.0.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phpow
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Ott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Develop your legacy PHP applications utilizing POW's TLDs on Mac OS X
 email:
@@ -26,37 +25,32 @@ files:
 - Rakefile
 - bin/phpow
 - lib/phpow.rb
-- lib/phpow/client.rb
-- lib/phpow/core.rb
-- lib/phpow/rack_app.rb
-- lib/phpow/templates/.powconfig
+- lib/phpow/apache_configuration.rb
 - lib/phpow/templates/apache.conf.erb
-- lib/phpow/templates/config.ru
 - lib/phpow/version.rb
 - phpow.gemspec
 homepage: http://github.com/danott/phpow
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Having a single TLD for both Rails and PHP development keeps things simple.
   But both POW and Apache can't listen on port 80. Get around this by running a light
   weight Rack application in POW as an in-between for Apache/PHP running on a different

data/lib/phpow/client.rb

@@ -1,108 +0,0 @@
-module Phpow
-
-  class Client
-    
-    require 'fileutils'
-    extend Phpow
-    
-    ##
-    # A convenvetion borrowed from powify. Define the allowable command line methods.
-    #
-    AVAILABLE_METHODS = %w[create destroy install uninstall help]
-
-    class << self
-
-      ##
-      # Phpow::Client.run
-      #
-      # A wrapper for the command line interface.
-      #
-      def run(args = [])
-
-        load_config
-
-        method = args[0].to_s.downcase
-        begin
-          raise "The command `#{args[0]}` does not exist for `phpow`!" unless Phpow::Client::AVAILABLE_METHODS.include?(method)
-          return send(method)
-        rescue Exception => e
-          puts e
-        end
-        help
-      end
-
-
-      ##
-      # phpow create
-      # Create the symbolic links to effectively run Phpow:RackApp.
-      #
-      def create
-        symlink_files.each do |file|
-          FileUtils.ln_s(File.join(File.dirname(__FILE__), "templates", file), File.join(current_path, file))
-        end
-      end
-
-
-      ##
-      # phpow destroy
-      # Unlink the files that were linked using phpow create.
-      #
-      def destroy
-        symlink_files.each do |file|
-          symlink_path = File.join(current_path, file)
-          FileUtils.rm(symlink_path) if File.symlink?(symlink_path)
-        end
-      end
-
-
-      ##
-      # phpow install
-      # Install the apache configuration file in `apache_conf_path`
-      #
-      def install
-        require 'erb'
-        template = ERB.new(File.read(File.join(File.dirname(__FILE__), "templates", "apache.conf.erb")))
-        result = template.result(binding)
-
-        # Need the current user to own the file in able to write to it.
-        unless File.owned?(apache_conf_path)
-          puts "'#{File.dirname(apache_conf_path)}' is write protected by root. You will have to enter your administrator password in order to create #{apache_conf_path}"
-          %x{sudo touch #{apache_conf_path} && sudo chown #{user} #{apache_conf_path}}
-        end
-
-        f = File.new(apache_conf_path, 'w')
-        f.puts(result)
-        f.chmod(0644)
-        f.close
-      end
-
-
-      ##
-      # phpow uninstall
-      # Remove the apache configuration file from `apache_conf_path`
-      #
-      def uninstall
-        puts "Are you sure you want to remove the file '#{apache_conf_path}'?"
-        print "Enter 'yes' to confirm: "
-        
-        confirmation = gets.strip.downcase
-        return unless confirmation == "yes"
-        
-        %x{sudo rm #{apache_conf_path}}
-      end
-
-
-      ##
-      # Print helpful information to the command line.
-      #
-      def help
-        print <<-HELPTEXT
-See README at http://github.com/danott/phpow
-        HELPTEXT
-      end
-
-    end
-
-  end
-
-end

data/lib/phpow/core.rb

@@ -1,50 +0,0 @@
-require 'phpow/client'
-require 'phpow/rack_app'
-
-module Phpow
-
-  attr_accessor :apache_port, :projects_directory
-
-  def apache_port
-    @apache_port || 8888
-  end
-
-  def projects_directory
-    @projects_directory || "/Users/#{user}/Sites"
-  end
-
-  def projects_directory=(directory)
-    @projects_directory = directory.gsub(/\/*$/, '')
-  end
-
-  def current_path
-    %x{pwd}.strip
-  end
-
-  def user
-    %x{whoami}.strip
-  end
-
-  def apache_conf_path
-    "/etc/apache2/users/#{user}.conf"
-  end
-
-  def symlink_files
-    %w[config.ru .powconfig]
-  end
-
-
-  ##
-  # Configuration variables can be stored in '~/.phpowconfig'
-  # 
-  # PHPOW_APACHE_PORT: Configure apache to run on a port other than 8888
-  # PHPOW_PROJECTS_DIRECTORY: Serve your projects out of a directory other than /Users/user/Sites
-  #
-  def load_config     
-    if File.exists?(File.expand_path('~/.phpowconfig'))
-      self.apache_port = %x{source ~/.phpowconfig; echo $PHPOW_APACHE_PORT}.strip unless %x{source ~/.phpowconfig; echo $PHPOW_APACHE_PORT}.strip.empty?
-      self.projects_directory = %x{source ~/.phpowconfig; echo $PHPOW_PROJECTS_DIRECTORY}.strip unless %x{source ~/.phpowconfig; echo $PHPOW_PROJECTS_DIRECTORY}.strip.empty?
-    end
-  end
-
-end

data/lib/phpow/rack_app.rb

@@ -1,39 +0,0 @@
-module Phpow
-
-  class RackApp
-
-    require 'net/http'
-    include Phpow
-
-    def initialize
-      load_config
-    end
-
-    def call(env)      
-      request = Rack::Request.new(env)
-      headers = {}
-      
-      # Make the POW request to the Apache server
-      # http://myapp.dev/full/path/goes/here/
-      # ...will map to...
-      # http://myapp.dev:8888/full/path/goes/here/
-      http = Net::HTTP.new(request.host, apache_port)      
-      response = http.send_request(request.request_method, request.fullpath, request.body.read, headers)
-
-      # Map Net::HTTP response back to Rack::Request.call expects
-      status, headers, body = response.code, response.to_hash, [response.body]
-
-      # Research showed that browsers were choking on this for some reason.
-      # Probably not the be-all-end-all solution, but works for local development thus far.
-      headers.delete('transfer-encoding')
-
-      # Send the response back to POW
-      [status, headers, body]
-
-    rescue Errno::ECONNREFUSED
-      [500, {}, ["Server is down, try $ sudo apachectl start"]]
-    end
-
-  end
-
-end

data/lib/phpow/templates/.powconfig

@@ -1 +0,0 @@
-export POW_WORKERS=10

data/lib/phpow/templates/config.ru

@@ -1,2 +0,0 @@
-require 'phpow'
-run Phpow::RackApp.new