simple_ssi 0.0.4

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.bundle
+.document
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 seenmyfate
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# simple_ssi
+
+Make full use of Nginx Server Side Includes quickly and easily in your Rails 3 app. First up require the gem in your Gemfile:
+
+    gem 'simple_ssi'
+    
+Turn on server side includes in nginx
+
+    location / {
+      ssi on;
+      #etc
+    }
+    
+In your view, use the helper to specify the action you want to include:
+
+    <%= ssi :controller => 'users', :action => 'notifications' %>
+   
+Nginx will now include the HTML created by your action in the page dynamically, so you can cache the rest of the page and still include user specific information.
+
+The example above assumes that you have something along these lines in your application:
+    
+    #application_controller.rb
+    class ApplicationController < ActionController::Base
+    
+      def current_user
+        #some kind current user method
+      end
+    end
+    
+    #users_controller.rb
+    class Users < ApplicationController
+      def notifications
+        @notifications = current_user.notifications
+      end
+    end
+    
+    #views/users/notifications.html.erb
+    
+    <% for notification in @notifications %>
+        <%# do stuff%>
+    <% end %>
+    
+    #config/routes.rb
+    
+    match '/users/notifications' => 'users#notifications'
+  
+If you want to keep your ssi action separate, and you don't want to have to add a new route everytime, run the simple_ssi generator:
+
+    rails g simple_ssi
+    
+Now simply add any methods to app/controllers/ssi_controller.rb, add a view under app/views/ssi and pass the method name to the helper:
+
+    <%= ssi :notifications %>
+
+* * *
+To do:
+
+* Better readme
+* Example app
+* Benchmarks
+* Apache support
+
+
+* * *
+
+Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+* * *
+
+Copyright (c) 2010 seenmyfate. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_ssi"
+    gem.summary = %Q{Easily add nginx sever side includes to you rails 3 app}
+    gem.description = %Q{Easily add nginx sever side includes to you rails 3 app}
+    gem.email = "seenmyfate@gmail.com"
+    gem.homepage = "http://github.com/seenmyfate/simple_ssi"
+    gem.authors = ["seenmyfate"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_ssi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/app/controllers/ssi_controller.rb

@@ -0,0 +1,3 @@
+class SsiController < ApplicationController
+
+end

data/app/helpers/ssi_helper.rb

@@ -0,0 +1,13 @@
+module SsiHelper
+
+  def ssi(path={})
+    if path.is_a? Hash
+      url = url_for(path)
+    elsif path.is_a? Symbol
+      url = url_for(:controller => "ssi", :action => path.to_s)
+    elsif path.is_a? String
+      url = url_for(:controller => "ssi", :action => path)
+    end
+    "<!--# include file='#{url}' -->".html_safe
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do |map|
+  match 'tom' => 'tom#index'
+  match 'ssi(/:action(/:id(.:format)))', :controller => 'ssi'
+end

data/lib/generators/simple_ssi/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Creates an SsiController in your application
+
+Example:
+    rails generate nginx_ssi

data/lib/generators/simple_ssi/simple_ssi_generator.rb

@@ -0,0 +1,9 @@
+class SimpleSsiGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def ssi
+    copy_file "ssi_controller.rb", 'app/controllers/ssi_controller.rb'
+    empty_directory "app/controllers/ssi"
+    empty_directory "app/views/ssi"
+  end
+end

data/lib/generators/simple_ssi/templates/ssi_controller.rb

@@ -0,0 +1,3 @@
+class SsiController < ApplicationController
+  #Add your endpoints here
+end

data/lib/simple_ssi.rb

@@ -0,0 +1,8 @@
+require 'simple_ssi'
+require 'rails'
+module SimpleSsi
+  #
+  # Nginx Server Side Includes
+  #
+  require 'simple_ssi/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/simple_ssi/engine.rb

@@ -0,0 +1,5 @@
+class Engine < Rails::Engine
+  initializer 'my_engine.helper' do |app|
+    ActionView::Base.send :include, SsiHelper
+  end
+end

data/simple_ssi.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_ssi}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["seenmyfate"]
+  s.date = %q{2010-11-07}
+  s.description = %q{Easily add nginx sever side includes to you rails 3 app}
+  s.email = %q{seenmyfate@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/ssi_controller.rb",
+     "app/helpers/ssi_helper.rb",
+     "config/routes.rb",
+     "lib/generators/simple_ssi/USAGE",
+     "lib/generators/simple_ssi/simple_ssi_generator.rb",
+     "lib/generators/simple_ssi/templates/ssi_controller.rb",
+     "lib/simple_ssi.rb",
+     "lib/simple_ssi/engine.rb",
+     "simple_ssi.gemspec"
+  ]
+  s.homepage = %q{http://github.com/seenmyfate/simple_ssi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily add nginx sever side includes to you rails 3 app}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: simple_ssi
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- seenmyfate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Easily add nginx sever side includes to you rails 3 app
+email: seenmyfate@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- app/controllers/ssi_controller.rb
+- app/helpers/ssi_helper.rb
+- config/routes.rb
+- lib/generators/simple_ssi/USAGE
+- lib/generators/simple_ssi/simple_ssi_generator.rb
+- lib/generators/simple_ssi/templates/ssi_controller.rb
+- lib/simple_ssi.rb
+- lib/simple_ssi/engine.rb
+- simple_ssi.gemspec
+has_rdoc: true
+homepage: http://github.com/seenmyfate/simple_ssi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily add nginx sever side includes to you rails 3 app
+test_files: []
+