mszczytowski-spring-fu 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Maciej Szczytowski
+
+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/Manifest

@@ -0,0 +1,7 @@
+spring-fu.gemspec
+lib/maciej_szczytowski/spring_fu.rb
+test/maciej_szczytowski/spring_fu.rb
+Manifest
+README
+LICENSE
+CHANGELOG

data/README

@@ -0,0 +1,85 @@
+SpringFu
+========
+
+This extension ...
+
+Installation
+============
+
+1. Install JRuby - see wiki.jruby.org for details.
+
+2. Install Rails and Warbler:
+
+  jruby -S gem install rails warbler
+
+3. Create Rails application:
+
+  jruby -S rails spring-on-rails
+
+  cd spring-on-rails
+
+4. Create Warbler configuration file:
+
+  jruby -S warble config
+
+5. Copy Spring and CommonsLogging jars into lib directory:
+
+  cp %PATH_TO_JARS_REPOSITORY%/spring.jar lib
+  cp %PATH_TO_REPOSITORY%/commons-logging.jar lib
+
+6. Create Spring context and fill it with Your Spring configuration:
+
+  mkdir config/spring/
+  vim config/spring/applicationContext.xml
+
+7. Copy web.xml template from Warbler into config directory:
+
+  cp %PATH_TO_GEMS_REPOSITORY%/warbler-%VERSION%/web.xml.erb config
+
+  vim config/web.xml.erb
+
+8. Add Spring listener into web.xml.erb file:
+
+  <context-param>
+    <param-name>contextConfigLocation</param-name>
+    <param-value>/WEB-INF/config/spring/applicationContext.xml</param-value>
+  </context-param>
+
+  <listener>
+    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
+  </listener>
+
+9. Add gem dependency in your Rails config:
+
+  config.gem 'mszczytowski-spring-fu', :lib => 'spring-fu', :source => 'http://gems.github.com'
+
+10. Add gem dependency in Warbler config:
+
+  config.gems << "spring-fu"
+
+10. Install gems:
+
+  jruby -S rake gems:install
+
+11. Create war file:
+
+  jruby -S rake war
+
+12. Deploy on Tomcat and have fun.
+
+Usage
+=====
+
+  class YourController < ApplicationController
+
+    spring_bean :useful_bean
+    spring_bean :another_bean, :as => "new_name"
+
+    def your_method
+      useful_bean.do_sth_cool_in_spring_bean
+      new_name.add(2, 2)
+    end
+
+  end
+
+Copyright (c) 2008 Maciej Szczytowski, released under the MIT license

data/lib/maciej_szczytowski/spring_fu.rb

@@ -0,0 +1,144 @@
+module MaciejSzczytowski
+  module SpringFu
+
+    ERROR_NOT_JRUBY = "calling java methods is allowed only in JRuby environment" 
+    
+    ERROR_SERVLET_CONTEXT_NOT_FOUND = "servlet context cannot be found"
+    
+    ERROR_SPRING_CONTEXT_NOT_FOUND = "spring context cannot be found"
+    
+    ERROR_SPRING_CLASS_NOT_IMPORTED = "class org.springframework.web.context.support.WebApplicationContextUtils is not found"
+    
+    ERROR_BEAN_NOT_FOUND = "bean %s cannot be found in spring context"
+    
+    def self.included(base)
+      if jruby? and servlet_context_exists? and spring_imported? and spring_context_exists?
+        base.send(:extend, ClassMethods)
+      else 
+        base.send(:extend, MockClassMethods)
+      end
+    end
+
+    # Example:
+    #
+    #   class YourController < ApplicationController
+    #     spring_bean :useful_bean
+    #     spring_bean :another_bean, :as => "new_name"
+    #
+    #     def your_method
+    #       useful_bean.do_sth_cool_in_spring_bean
+    #       new_name.add(2, 2)
+    #     end
+    #   end
+    #
+    module ClassMethods
+
+      def spring_bean(name, options = {})          
+        # use bean name as accessor, unless other is provided
+        options[:as] ||= name
+
+        # nil is default value, unless other is provided
+        options[:default] ||= nil
+        options[:allow_nil] ||= false
+
+        bean_name = nil
+        
+	if bean_exists_in_spring_context?(name)
+          bean_name = name
+        elsif bean_exists_in_spring_context?(name.to_s.camelize(:lower).to_sym)
+          bean_name = name.to_s.camelize(:lower).to_sym
+        elsif bean_exists_in_spring_context?(name.to_s.camelize.to_sym)
+          bean_name = name.to_s.camelize.to_sym
+        elsif bean_exists_in_spring_context?(name.to_s.underscore.to_sym)
+          bean_name = name.to_s.underscore.to_sym
+        end
+        
+        if bean_name
+          define_method(name) do
+            self.class.send(:get_bean_from_spring_context, bean_name)
+          end
+        elsif options[:default] or options[:allow_nil]
+          # there is no bean with given name, return default value
+          # when default is not nil, allow_nil options is not significant
+          define_method(name) do
+            options[:default]
+          end
+        else
+          # there is no bean with given name, raise an error
+          raise MaciejSzczytowski::SpringFu::ERROR_BEAN_NOT_FOUND % name.to_s
+        end
+      end
+
+      private
+      
+      def get_bean_from_spring_context(bean_name)
+        get_spring_context.get_bean(bean_name.to_s)
+      end
+
+      def get_spring_context
+        WebApplicationContextUtils.get_web_application_context($servlet_context)
+      end
+
+      def bean_exists_in_spring_context?(bean_name)
+        get_spring_context.contains_bean(bean_name.to_s)
+      end
+
+    end
+    
+    module MockClassMethods
+    
+      def spring_bean(name, options = {})
+        define_method(name) do
+          MaciejSzczytowski::SpringFu::MOCK_BEAN
+        end
+      end
+
+    end
+    
+    private 
+  
+    def self.jruby?
+      unless defined? JRUBY_VERSION
+        define_mock_bean_for_error MaciejSzczytowski::SpringFu::ERROR_NOT_JRUBY
+      else
+        true
+      end
+    end
+  
+    def self.servlet_context_exists?
+      unless $servlet_context
+        define_mock_bean_for_error MaciejSzczytowski::SpringFu::ERROR_SERVLET_CONTEXT_NOT_FOUND
+      else
+        true
+      end
+    end
+  
+    def self.spring_context_exists?
+      unless WebApplicationContextUtils.get_web_application_context($servlet_context) 
+        define_mock_bean_for_error MaciejSzczytowski::SpringFu::ERROR_SPRING_CONTEXT_NOT_FOUND
+      else
+        true
+      end
+    end
+  
+    def self.spring_imported?
+      #import org.springframework.web.context.support.WebApplicationContextUtils
+    #rescue NameError
+      #define_mock_bean_for_error MaciejSzczytowski::SpringFu::ERROR_SPRING_CLASS_NOT_IMPORTED
+    end
+  
+    def self.define_mock_bean_for_error(error_message)      
+      mock_bean = nil
+      def mock_bean.method_missing(meth,*args)
+        raise MaciejSzczytowski::SpringFu::ERROR_MESSAGE
+      end
+      
+      const_set(:ERROR_MESSAGE, error_message)
+      const_set(:MOCK_BEAN, mock_bean)
+
+      false
+    end
+    
+  end
+  
+end

data/lib/spring-fu.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/maciej_szczytowski/spring_fu'
+
+ActionController::Base.send(:include, MaciejSzczytowski::SpringFu)

data/spring-fu.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = %q{spring-fu}
+  s.version = "0.1.1"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  
+  s.authors = ["Maciej Szczytowski"]
+  s.date = %q{2008-07-30}
+  s.description = %q{SpringFramework support for JRuby on Rails application.}
+  s.email = %q{mszczytowski (at) gmail (dot) com}
+  s.extra_rdoc_files = ["README", "CHANGELOG", "LICENSE"]
+  s.files = ["spring-fu.gemspec", "lib/spring-fu.rb", "lib/maciej_szczytowski/spring_fu.rb", "Manifest", "README", "CHANGELOG", "LICENSE", "test/maciej_szczytowski/spring_fu_test.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/mszczytowski/spring-fu}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "spring-fu", "--main", "README", "CHANGELOG", "LICENSE"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{spring-fu}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{SpringFramework support for JRuby on Rails application.}
+  s.test_files = ["test/maciej_szczytowski/spring_fu_test.rb"]
+end

data/test/maciej_szczytowski/spring_fu_test.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+
+class MaciejSzczytowski::SpringFuTest < Test::Unit::TestCase
+  def test_this_plugin
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: mszczytowski-spring-fu
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Maciej Szczytowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: SpringFramework support for JRuby on Rails application.
+email: mszczytowski (at) gmail (dot) com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- LICENSE
+files: 
+- spring-fu.gemspec
+- lib/spring-fu.rb
+- lib/maciej_szczytowski/spring_fu.rb
+- Manifest
+- README
+- CHANGELOG
+- LICENSE
+- test/maciej_szczytowski/spring_fu_test.rb
+has_rdoc: true
+homepage: http://github.com/mszczytowski/spring-fu
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- spring-fu
+- --main
+- README
+- CHANGELOG
+- LICENSE
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: spring-fu
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: SpringFramework support for JRuby on Rails application.
+test_files: 
+- test/maciej_szczytowski/spring_fu_test.rb