middleman-php 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 271f40ca44968c945214e6326ef44b3ae3460dc3
-  data.tar.gz: f3677f60ff7356b6b6e371435fa94e360627ccfb
+  metadata.gz: 26d98133e4c55c4a74b5ad121984e33cad9ece6b
+  data.tar.gz: 419431e20bdd347b8f9fa3cbc5267d039cb9454a
 SHA512:
-  metadata.gz: 0abdf98107fd488ff0cb38bb5a21145425149740878c51a7bab52f7b91fbcb95fe4397756e33a0bf1b80851c41e0f5ceaa7f4bed24dc23c1d731d38162190083
-  data.tar.gz: 59950186010e88c02226e04f61ea06b0d030c4ec45cbad029de2226347f7dabe58a8fbc46f24aa89fa01da14583043ec4862a67f23b5908b97549b7867fd713e
+  metadata.gz: f8c7785c40471662ac0af9dfee39b87be17b646d7b1e21cf1662575985fedb670c67849807e1f13898126554e0fc351192cc75d776b0e69e80669a759e7b2ba9
+  data.tar.gz: 8f29f157662d873b69b7ddbff71e9c110161ac2062decb2649d363a2281ccce66d18fd95333dced5d25d6ca3f880f640b7bed58dcca1e8ec31f01dc1be9854b8

data/lib/middleman-php/extension.rb

@@ -1,17 +1,21 @@
+require 'shellwords'
+
 module Middleman
   class PhpExtension < Extension
-    # option :set_blah, "default", "An example option"
 
     def initialize(app, options_hash={}, &block)
-      # Call super to build options from the options_hash
       super
+    end
 
-      require 'shellwords'
-      app.use Middleman::PhpMiddleware
+    def before
+      template_extensions :php => :html
+    end
 
-      app.before do
-        template_extensions :php => :html
-      end
+    def after_configuration
+      app.use Middleman::PhpMiddleware,
+        source_dir: app.source_dir,
+        environment: app.settings.environment
     end
+
   end
 end

data/lib/middleman-php/injections.rb

@@ -0,0 +1,63 @@
+module Middleman
+  module Php
+    class Injections
+
+      def initialize debug=false
+        @debug      = debug
+        @injections = []
+      end
+
+      def add_server source_dir, env
+        full_path = File.join(source_dir, env['PATH_INFO'])
+        env.merge!({
+          'PHP_SELF'            => env['PATH_INFO'],
+          'SCRIPT_NAME'         => full_path,
+          'SCRIPT_FILENAME'     => full_path,
+          'DOCUMENT_ROOT'       => source_dir,
+          'REQUEST_TIME'        => Time.now.to_i,
+          'REQUEST_TIME_FLOAT'  => "%.4f" % Time.now.to_f,
+          'SERVER_ADMIN'        => 'ruby@middlemanapp.com'
+        })
+        add_parse_str(URI.encode_www_form(env), '$_SERVER')
+      end
+
+      def add_post rack_input
+        input = rack_input.read
+        unless input.length == 0
+          add_parse_str(input, '$_POST')
+        end
+      end
+
+      def add_get query_string
+        add_parse_str(query_string, '$_GET')
+      end
+
+      def add_include_path source_dir, path_info
+        path = File.dirname(File.join(source_dir, path_info))
+        add_raw("set_include_path(get_include_path() . PATH_SEPARATOR . '#{path}');")
+      end
+
+      def generate
+        if @injections.any?
+          injections = "<?php #{@injections.join(' ')} ?>" 
+          if @debug
+            puts '== PHP Injections:'
+            puts injections
+          end
+        end
+        return injections || ''
+      end
+
+      private
+
+      def add_parse_str values, array_name
+        @injections << "parse_str('#{values}', #{array_name});"
+      end
+
+      def add_raw source
+        @injections << source
+      end
+
+    end
+  end
+end

data/lib/middleman-php/middleware.rb

@@ -1,22 +1,68 @@
+require 'middleman-php/injections.rb'
+
 module Middleman
   class PhpMiddleware
 
-    def initialize(app)
-      @app = app
+    def initialize(app, config={})
+      @injections = Middleman::Php::Injections.new(true)
+      @app        = app
+      @config     = config
+      @env        = []
     end
 
     def call(env)
       status, headers, response = @app.call(env)
 
       if env['REQUEST_PATH'] =~ /\.php$/
+        set_environment(env)
         response.body.map! do |item|
-          `echo #{Shellwords.escape(item)} | php`
+          execute_php(item)
         end
         headers['Content-Length'] = response.body.join.length.to_s
-        headers['Content-Type'] = 'text/html'
+        headers['Content-Type']   = 'text/html'
+        headers['Cache-Control']  = 'no-cache, no-store, must-revalidate'
       end
 
       [status, headers, response]
     end
+
+    private
+
+    def set_environment env
+      @env = env
+    end
+
+    def execute_php source
+      inject_server
+      inject_include_path
+      inject_get
+      inject_post
+      `echo #{Shellwords.escape(@injections.generate + source)} | php`
+    end
+
+    def inject_server
+      if @config[:environment] == :development
+        @injections.add_server(@config[:source_dir], @env)
+      end
+    end
+
+    def inject_include_path
+      if @config[:environment] == :development
+        @injections.add_include_path(@config[:source_dir], @env['PATH_INFO'])
+      end
+    end
+
+    def inject_get
+      unless @env['QUERY_STRING'].empty?
+        @injections.add_get(@env['QUERY_STRING'])
+      end
+    end
+
+    def inject_post
+      if @env['REQUEST_METHOD'] == "POST"
+        @injections.add_post(@env["rack.input"])
+      end
+    end
+
   end
 end

data/lib/middleman-php/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Php
+    VERSION = "0.0.2"
+  end
+end

data/middleman-php.gemspec

@@ -1,9 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+require "middleman-php/version"
 
 Gem::Specification.new do |s|
   s.name        = "middleman-php"
-  s.version     = "0.0.1"
+  s.version     = Middleman::Php::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Robert Lord"]
   s.email       = ["robert@lord.io"]

data/readme.md

@@ -1,5 +1,9 @@
 # middleman-php
 
+middleman-php lets [Middleman](https://github.com/middleman/middleman)'s server render PHP. So your `source/kittens.php` file will actually render kittens, and not a mess of `<?php` open tags.
+
+Sometimes I have clients who want little bits of PHP interactivity on their site, but I still want to use Middleman to generate the PHP pages. This makes it so you don't have to `middleman build` and then upload to your site just to get a preview.
+
 ## Installation
 
 In your Middleman project's `Gemfile`, add:
@@ -16,26 +20,14 @@ configure :development do
 end
 ```
 
-If you want the php to be parsed on builds, too (instead of left for your server to parse), just omit the `configure` block:
+If you want the php to be parsed on builds, too (as opposed to raw PHP generated for a server to run), just omit the `configure` block:
 
 ```ruby
 activate :php
 ```
 
-## FAQ
-
-### So wait, what does this do?
-
-It lets [Middleman](https://github.com/middleman/middleman)'s server render PHP. So your `source/kittens.php` file will actually render kittens, and not a mess of `<?php` open tags.
-
-### Oh lord, why?? Why would you want that???
-
-Sometimes I have clients who want little bits of PHP interactivity on their site, but I still want to use Middleman to generate the PHP pages. This makes it so you don't have to `middleman build` and then upload to your site just to get a preview.
-
-### Are there any limitations?
-
-It will only render on pages where the URL ends in `.php`...so if you want to see `index.php`, you'll have to actually stick `index.php` in your browser.
+The PHP will only be rendered on pages where the URL ends in `.php`...so if you want to see `index.php`, you'll have to actually stick `index.php` in your browser. It will however, let you do fancy stuff like files ending in `.php.erb`...so your ERB can generate some php output.
 
-Also, right now the rendering is done through PHP's command line interface, which has [some limitations](http://www.php.net/manual/en/features.commandline.differences.php)...including no $_GET or $_POST. Hopefully this will be fixed in the future.
+Also thanks to [Mariano](https://github.com/mcavallo), who contributed a significant chunk of code to get $_GET, $_POST, and other PHP global request variables working.
 
-There are probably also bugs I haven't found, so if you find one, feel free to submit an issue!
+There are probably also bugs I haven't found, so if you find one, feel free to submit an issue!

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: middleman-php
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Lord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.1
 description: 
@@ -31,14 +31,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Rakefile
 - lib/middleman-php.rb
 - lib/middleman-php/extension.rb
+- lib/middleman-php/injections.rb
 - lib/middleman-php/middleware.rb
+- lib/middleman-php/version.rb
 - lib/middleman_extension.rb
-- lib/php_middleware.rb
 - middleman-php.gemspec
 - readme.md
 homepage: https://github.com/lord/middleman-php
@@ -50,17 +51,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Use Middleman to build PHP files

data/lib/php_middleware.rb

@@ -1,21 +0,0 @@
-class PhpMiddleware
-
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    status, headers, response = @app.call(env)
-
-    if env['REQUEST_PATH'] =~ /\.php$/
-      response.body.map! do |item|
-        `echo #{Shellwords.escape(item)} | php`
-      end
-      headers['Content-Length'] = response.body.join.length.to_s
-      headers['Content-Type'] = 'text/html'
-    end
-
-    [status, headers, response]
-  end
-
-end