rich_support 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.bundle
+*.gem
+Gemfile.lock
+pkg/*
+suit/rails-*/dummy/db/*.sqlite3
+suit/rails-*/dummy/log/*.log
+suit/rails-*/dummy/tmp/*
+suit/shared/mysql

data/.suit

@@ -0,0 +1,4 @@
+--- 
+:version: 0.1.0
+:capybara: true
+:mysql: false

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= Rich-Support CHANGELOG
+
+== Version 0.1.0 (April 10, 2011)
+
+* Initial release

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Engel
+
+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.textile

@@ -0,0 +1,141 @@
+h1. Rich-Support
+
+A small gem making your own gem Rails 2 and 3 compliant and providing the String class a few goodies
+
+h2. Introduction
+
+Rich-Support is a small module of E9s ("http://github.com/archan937/e9s":http://github.com/archan937/e9s) making your own gem Rails 2 and 3 compliant. It also adds a small amount of handy methods to the String class.
+
+*Attention:* This gem does *NOT* add Rails 3 functionality to a Rails 2 application, but provides an unified interface for certain differences in implementation between Rails 2 and 3. A few examples:
+
+* it provides a unified interface for the @after_initialize@ hook of the Rails application
+* it provides the @ActiveSupport::Dependencies.autoload_paths@ to be called in both Rails 2 and 3
+* it defines @String.html_safe@ if it hasn't been defined already (it only returns the String and does *NOT* HTML escapes the String)
+
+A real world example of a Rich-Support implementation is the "Rich-CMS":https://github.com/archan937/rich_cms/tree/edge gem of which Rich-Support is extracted from.
+
+h2. Installation
+
+Add Rich-Support as gem dependency in your @gemspec@ file:
+
+<pre>
+  s.add_dependency "rich_support"
+</pre>
+
+Require Rich-Support in your gem (e.g. in @libs/rich_cms.rb@ for the gem Rich-CMS)
+
+<pre>
+  require "rich_support"
+</pre>
+
+Your gem is now Rails 2 and 3 compliant.
+
+h2. Using the Rails configuration after_initialize hook regardless of the major Rails version
+
+As calling the @after_initialize@ differs in the major Rails versions, but you can just call @Rich::Support.after_initialize@ instead as it will handle things for you:
+
+<pre>
+  Rich::Support.after_initialize do
+    register_assets
+    copy_images
+    require_models
+  end
+</pre>
+
+h2. Registering your gem controllers, views and routes in Rails 2
+
+As only Rails 3 recognizes your controllers, views and routes automatically, you will have to append them in Rails 2 yourself. Fortunately with Rich::Support, you will only have to append your gem path:
+
+<pre>
+  Rich::Support.append_gem_path File.expand_path("../..", __FILE__)
+</pre>
+
+*Note*: The source file in this example is located in the @lib@ directory of the gem itself
+
+Calling @append_gem_path@ registers the following in Rails 2:
+
+* @controllers@ - Which is assumed to be located in @app/controllers@
+* @views@ - Which is assumed to be located in @app/views@
+* @routes@ - Which is assumed to be located in @config/routes.rb@
+
+h2. Some String class goodies
+
+Rich-Support adds a small amount of methods to the @String@ class:
+
+* @String.upcase_first@ - Upcases the first character of a String and leaves the remainder alone unlike @String.capitalize@ which downcases it
+* @String.upcase_first!@ - Only returns the upcased String when it has changed otherwise it returns a @nil@ value
+* @String.copy_case@ - Copies the letter casing of a passed String (e.g. @"paul".copy_case("Engel")@ returns @"Paul"@ and @"CoDe".copy_case("HERO")@ returns @"CODE"@)
+* @String.copy_case!@ - Only returns the case copied String when it has changed otherwise it returns a @nil@ value
+* @String.singularize!@ and @String.pluralize!@ - Which (as you expected) only returns a String when it has changed otherwise a @nil@ value
+
+h2. Developing Rich-Support yourself
+
+1. Create your own Rich-Support fork "https://github.com/archan937/rich_support/fork":https://github.com/archan937/rich_support/fork
+2. Clone your Rich-Support fork repository
+
+<pre>
+  git clone git@github.com:<your_username>/rich_support.git && cd rich_support
+</pre>
+
+3. Setup your environment in order to use the "GemSuit":https://github.com/archan937/gem_suit tests provided within Rich-Support
+
+<pre>
+  gem install gem_suit && suit fit -v
+</pre>
+
+4. Run unit tests in both Rails 2 and 3
+
+<pre>
+  suit test unit -v
+</pre>
+
+5. Start either of the dummy Rails applications for development purposes (Rails 3 at default)
+
+<pre>
+  suit s
+</pre>
+
+To run the Rails 2 application:
+
+<pre>
+  suit s -r2
+</pre>
+
+6. *Get on programming* and send your pull request! ;)
+
+*Note*: For more information about GemSuit, please visit "its Github page":https://github.com/archan937/gem_suit.
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. Enrichments
+
+The all-in-one gem at – "http://codehero.es/rails_gems_plugins/e9s":http://codehero.es/rails_gems_plugins/e9s – "http://github.com/archan937/e9s":http://github.com/archan937/e9s
+
+h2. E9s modules
+
+* Rich-Support <br>
+  "http://codehero.es":http://codehero.es <br>
+  "http://github.com/archan937/rich_support":http://github.com/archan937/rich_support
+* Rich-CMS <br>
+  "http://codehero.es/rails_gems_plugins/rich_cms":http://codehero.es/rails_gems_plugins/rich_cms <br>
+  "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
+* Rich-i18n <br>
+  "http://codehero.es/rails_gems_plugins/rich_i18n":http://codehero.es/rails_gems_plugins/rich_i18n <br>
+  "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
+* Rich-pluralization <br>
+  "http://codehero.es/rails_gems_plugins/rich_pluralization":http://codehero.es/rails_gems_plugins/rich_pluralization <br>
+  "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+
+h2. License
+
+Copyright (c) 2011 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl – "http://codehero.es":http://codehero.es – "http://gettopup.com":http://gettopup.com – "http://twitter.com/archan937":http://twitter.com/archan937 – "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+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/Rakefile

@@ -0,0 +1,29 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+require "rake/rdoctask"
+require "rich/support/core/string/colorize"
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Test Rich-Support."
+task :test do
+  begin
+    require "gem_suit"
+    system "suit test unit -v"
+  rescue LoadError
+    puts "Please install GemSuit with 'gem install gem_suit'".red
+  end
+end
+
+desc "Generate documentation for Rich-Support."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Rich-Support"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include "README.textile"
+  rdoc.rdoc_files.include "MIT-LICENSE"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rich/support/actionpack/action_controller/test_case.rb

@@ -0,0 +1,28 @@
+module ActionController
+  class TestCase
+
+  protected
+
+    def assert_named_route(result, name)
+      assert_equal result, named_routes[name.to_s]
+    end
+
+    def named_routes
+      @named_routes ||= Hash[*begin
+        if Rails::VERSION::MAJOR >= 3
+          Rails.application.routes.routes.collect do |route|
+            [route.name, route.path.gsub("(.:format)", "")] unless route.name.blank?
+          end
+        else
+          ActionController::Routing::Routes.routes.collect do |route|
+            name = ActionController::Routing::Routes.named_routes.routes.index(route).to_s
+            path = route.segments.collect(&:to_s).join
+            path.chop! if path.length > 1
+            [name, path] unless name.blank?
+          end
+        end
+      end.compact.flatten]
+    end
+
+  end
+end

data/lib/rich/support/actionpack.rb

@@ -0,0 +1,3 @@
+if defined?(ActionController)
+  require "rich/support/actionpack/action_controller/test_case"
+end

data/lib/rich/support/activesupport/active_support/dependencies.rb

@@ -0,0 +1,12 @@
+module ActiveSupport
+  module Dependencies
+
+    extend self
+
+    unless respond_to? :autoload_paths
+      alias_method :autoload_paths     , :load_paths
+      alias_method :autoload_once_paths, :load_once_paths
+    end
+
+  end
+end

data/lib/rich/support/activesupport.rb

@@ -0,0 +1,3 @@
+if defined?(ActiveSupport)
+  require "rich/support/activesupport/active_support/dependencies"
+end

data/lib/rich/support/core/string/colorize.rb

@@ -0,0 +1,41 @@
+module Rich
+  module Support
+    module Core
+      module String
+        module Colorize
+
+          COLORS = {:red => 31, :green => 32, :yellow => 33}
+
+          def self.included(base)
+            COLORS.each do |name, code|
+              base.send :define_method, name do
+                _colorize code
+              end
+            end
+
+            base.send :include, InstanceMethods
+          end
+
+          module InstanceMethods
+            def colorize
+              self.gsub(/\{\{(#{COLORS.keys.join("|")}):(.+)\}\}/) do |match|
+                $2.send $1
+              end
+            end
+          end
+
+        private
+
+          def _colorize(color)
+            "\e[1m\e[#{color}m#{self}\e[0m"
+          end
+
+        end
+      end
+    end
+  end
+end
+
+class String
+  include Rich::Support::Core::String::Colorize
+end

data/lib/rich/support/core/string/html_safe.rb

@@ -0,0 +1,17 @@
+module Rich
+  module Support
+    module Core
+      module String
+        module HtmlSafe
+
+          unless ::String.new.respond_to? :html_safe
+            def html_safe
+              self
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rich/support/core/string/inflections.rb

@@ -0,0 +1,39 @@
+module Rich
+  module Support
+    module Core
+      module String
+        module Inflections
+
+          def upcase_first
+            empty? ?
+              self :
+              self[0].chr.capitalize + self[1, size]
+          end
+
+          def copy_case(s)
+            send((:downcase unless s.dup.downcase!) || (:upcase unless s.dup.upcase!) || (:upcase_first unless s.dup.upcase_first!) || :to_s)
+          end
+          alias_method :cp_case, :copy_case
+
+          def upcase_first!
+            self == (result = upcase_first) ? nil : replace(result)
+          end
+
+          def copy_case!(s)
+            self == (result = cp_case(s))   ? nil : replace(result)
+          end
+          alias_method :cp_case!, :copy_case!
+
+          def singularize!
+            downcase == (result = singularize).downcase ? nil : replace(result)
+          end
+
+          def pluralize!
+            downcase == (result = pluralize).downcase   ? nil : replace(result)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rich/support/core/string.rb

@@ -0,0 +1,7 @@
+require "rich/support/core/string/html_safe"
+require "rich/support/core/string/inflections"
+
+class String
+  include Rich::Support::Core::String::HtmlSafe
+  include Rich::Support::Core::String::Inflections
+end

data/lib/rich/support/core.rb

@@ -0,0 +1,2 @@
+require "rich/support/core/string"
+require "rich/support/core/string/colorize"

data/lib/rich/support/rails/engine.rb

@@ -0,0 +1,4 @@
+unless defined?(Rails::Engine)
+  class Rails::Engine
+  end
+end

data/lib/rich/support/rails.rb

@@ -0,0 +1,3 @@
+if defined?(Rails)
+  require "rich/support/rails/engine"
+end

data/lib/rich/support/test/unit/test_case.rb

@@ -0,0 +1,92 @@
+# https://github.com/jm/pending/blob/master/lib/pending.rb
+
+unless Rails::VERSION::MAJOR >= 3
+
+  module Test
+    module Unit
+      class TestCase
+        @@pending_cases = []
+        @@at_exit = false
+
+        # The pending method lets you define a block of test code that is currently "pending"
+        # functionality.
+        #
+        # You can use it two ways.  One is simply put a string as the parameter:
+        #
+        #   def test_web_service_integration
+        #     pending "This is not done yet..."
+        #   end
+        #
+        # This will output a "P" in the test output alerting there is pending functionality.
+        #
+        # You can also supply a block of code:
+        #
+        #   def test_new_helpers
+        #     pending "New helpers for database display" do
+        #       output = render_record(User.first)
+        #       assert_equal "Jerry User (jerry@users.com)", output
+        #     end
+        #   end
+        #
+        # If the block doesn't fail, then the test will flunk with output like:
+        #
+        #   <New helpers for database display> did not fail.
+        #
+        # If the test fails (i.e., the functionality isn't implemented), then it will
+        # not fail the surrounding test.
+        #
+        def pending(description = "", &block)
+          if block_given?
+            failed = false
+
+            begin
+              block.call
+            rescue
+              failed = true
+            end
+
+            flunk("<#{description}> did not fail.") unless failed
+          end
+
+          caller[0] =~ (/(.*):(.*):in `(.*)'/)
+          @@pending_cases << "#{$3} at #{$1}, line #{$2}"
+          print "P"
+
+          @@at_exit ||= begin
+            at_exit do
+              puts "\nPending Cases:"
+              @@pending_cases.each do |test_case|
+                puts test_case
+              end
+            end
+          end
+        end
+
+        # This method will define a test method using the description as the test name
+        # ("pending function" => "test_pending_function")
+        #
+        # Instead of doing this:
+        #
+        # def test_function_is_pending
+        #   pending "this test is pending"
+        # end
+        #
+        # You can just do this:
+        #
+        # pending "function is pending"
+        #
+        # This method can be called with a block passed, the same as the instance method
+        #
+        def self.pending(description, &block)
+          test_name = "test_#{description.gsub(/\s+/,'_')}".to_sym
+          defined = instance_method(test_name) rescue false
+          raise "#{test_name} is already defined in #{self}" if defined
+          define_method(test_name) do
+            pending(description) {self.instance_eval(&block)}
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/rich/support/test.rb

@@ -0,0 +1,3 @@
+if defined? Test
+  require "rich/support/test/unit/test_case"
+end

data/lib/rich/support/version.rb

@@ -0,0 +1,11 @@
+module Rich
+  module Support
+    module VERSION
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join(".")
+    end
+  end
+end

data/lib/rich/support.rb

@@ -0,0 +1,51 @@
+module Rich
+  module Support
+    extend self
+
+    def append_gem_path(path)
+      (@gem_paths ||= []) << path
+
+      check_controllers_for path
+      check_routes_for      path
+      check_views_for       path
+    end
+
+    def after_initialize(&block)
+      if Rails::VERSION::MAJOR >= 3
+        ActiveSupport.on_load :after_initialize, :yield => true, &block
+      else
+        Rails.configuration.after_initialize &block
+      end
+    end
+
+  private
+
+    def check_controllers_for(path)
+      return if Rails::VERSION::MAJOR >= 3
+      if File.exists?(controllers = File.expand_path("app/controllers", path))
+        $LOAD_PATH << controllers
+        ActiveSupport::Dependencies.autoload_paths << controllers
+        ActiveSupport::Dependencies.autoload_once_paths.delete controllers
+      end
+    end
+
+    def check_routes_for(path)
+      return if Rails::VERSION::MAJOR >= 3
+      if File.exists?(routes = File.expand_path("config/routes.rb", path))
+        require routes
+      end
+    end
+
+    def check_views_for(path)
+      return if Rails::VERSION::MAJOR >= 3
+      if File.exists?(views = File.expand_path("app/views", path))
+        if ActionController::Base.respond_to? :append_view_path
+          ActionController::Base.append_view_path views
+        elsif ActionController::Base.respond_to? :view_paths
+          ActionController::Base.self.view_paths << views
+        end
+      end
+    end
+
+  end
+end

data/lib/rich_support.rb

@@ -0,0 +1,7 @@
+require "rich/support"
+require "rich/support/core"
+require "rich/support/actionpack"
+require "rich/support/activesupport"
+require "rich/support/rails"
+require "rich/support/test"
+require "rich/support/version"

data/rich_support.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rich/support/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rich_support"
+  s.version     = Rich::Support::VERSION::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Engel"]
+  s.email       = ["paul.engel@holder.nl"]
+  s.homepage    = "https://github.com/archan937/rich_support"
+  s.summary     = %q{A small gem making your own gem Rails 2 and 3 compliant and providing the String class a few goodies}
+  s.description = %q{Rich-Support is a small module of E9s (http://github.com/archan937/e9s) making your own gem Rails 2 and 3 compliant. It also adds a small amount of handy methods to the String class.}
+
+  s.rubyforge_project = "rich_support"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/suit/rails-2/dummy/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails", "2.3.11"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+gem "rich_support", :path => File.expand_path("../../../..", __FILE__)
+
+group :test do
+  gem "mysql"
+  gem "shoulda"
+  gem "mocha"
+  gem "capybara"
+  gem "launchy"
+end