monkeysupport 0.2.0 → 1.0.0

data/README.md

@@ -0,0 +1,58 @@
+#MonkeySupport#
+
+MonkeySupport is a collection of monkeypatches to Rails, replacing
+existing methods with (somewhat) optimized C equivalents.
+
+If this interests you, you should also check out methodmissing's
+excellent HashWithIndifferentAccess at
+http://github.com/methodmissing/hwia .
+
+##Modules##
+
+MonkeySupport is largely a bunch of modules, each overwriting a part
+of ActiveSupport. By setting `$MonkeyModuleExcludes` to an array of
+module names before loading MonkeySupport, those modules will not be
+loaded. For example:
+
+    $MonkeyModuleExcludes = ["inflector", "output_safety"]
+    require 'monkeysupport'
+
+You can also specify a whitelist of modules to load with
+`$MonkeyModuleIncludes`, if you'd like. Typically, leaving both these
+variables undefined is what you'll want, though.
+
+MonkeySupport is currently comprised of the following modules:
+
+* inflector
+* output_safety
+
+##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.
+
+##Testing##
+
+There are some simple specs in `./spec`. To run against the
+activesupport test suite, add `require 'monkeysupport'` below the
+activesupport requires in activesupport's `Rakefile`. and rake away.
+
+##Problems / TODO##
+
+* Certain functions used to be memoized, then rails added test cases
+  for adding new inflections on the fly. The memoization is currently
+  disabled, but could be tweaked to be invalidated when the inflection
+  rules change.
+* Need to do a better job of identifying ruby versions for
+  output_safety module.
+* There's always more to port...
+
+##Copyright##
+
+Copyright (c) 2009 Burke Libbey. MIT License. See LICENSE for details.

data/Rakefile

@@ -6,30 +6,23 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "monkeysupport"
     gem.summary = "Monkeypatching Rails with C since 2009"
-    gem.description = "MonkeySupport provides C implementations for some of the more intensive string manipulation methods in activesupport."
+    gem.description = "MonkeySupport monkeypatches some of the performance-sink parts of rails with speedy C extensions."
     gem.email = "burke@burkelibbey.org"
     gem.homepage = "http://github.com/burke/monkeysupport"
     gem.authors = ["Burke Libbey"]
-    gem.files.include '{test,lib,ext}/**/*'
-    gem.extensions = ["ext/monkeysupport_c/extconf.rb", "ext/output_safety_ext/extconf.rb"]
+    gem.files.include '{spec,lib,ext}/**/*'
+    gem.extensions = ["ext/monkeysupport_c/extconf.rb", "ext/monkeysupport_output_safety/extconf.rb"]
     gem.add_development_dependency "shoulda"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo 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.libs << 'spec'
+    test.pattern = 'spec/**/*_spec.rb'
     test.verbose = true
   end
 rescue LoadError
@@ -38,10 +31,6 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
-
-task :default => :test
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/ext/monkeysupport_c/src/monkeysupport_c.c

@@ -8,7 +8,6 @@ Init_monkeysupport_c()
   VALUE mMonkeySupport = rb_define_module("MonkeySupport");
   VALUE cMSC = rb_define_class_under(mMonkeySupport, "C", rb_cObject);
 
-  /* ActiveSupport::ASC.camelize("my_string") */
   rb_define_singleton_method(cMSC, "activesupport_inflector_camelize",     activesupport_inflector_camelize,     2);
   rb_define_singleton_method(cMSC, "activesupport_inflector_demodulize",   activesupport_inflector_demodulize,   1);
   rb_define_singleton_method(cMSC, "activesupport_inflector_dasherize",    activesupport_inflector_dasherize,    1);

data/ext/monkeysupport_output_safety/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+extension_name = 'monkeysupport_output_safety'
+dir_config(extension_name)
+create_makefile(extension_name, 'src')

data/ext/{output_safety_ext/output_safety_ext.c → monkeysupport_output_safety/monkeysupport_output_safety.c}

@@ -1,13 +1,11 @@
-#include "stdbool.h"
+#include <stdbool.h>
 
 #include "ruby.h"
-#include "ruby/version.h"
 
 // Use a FL_USER flag for storing html safety information.
 // fingers crossed here, this is black black magic.
-#ifdef FL_USER4
 
-#define HFLAG FL_USER4
+#define HFLAG FL_USER7
 
 // by default, objects are not safe for html.
 VALUE obj_html_safe_qmark(VALUE self) { return Qfalse; }
@@ -71,12 +69,14 @@ str_concat(VALUE self, VALUE other)
   return self;
 }
 
+
 void
-Init_output_safety_ext()
+Init_monkeysupport_output_safety()
 {
+
   rb_define_method(rb_cObject, "html_safe?",       obj_html_safe_qmark, 0);
   rb_define_method(rb_cFixnum, "html_safe?",       fix_html_safe_qmark, 0);
-  
+
   rb_define_method(rb_cString, "html_safe",        str_html_safe,       0);
   rb_define_method(rb_cString, "html_safe!",       str_html_safe_bang,  0);
   rb_define_method(rb_cString, "html_safe?",       str_html_safe_qmark, 0);
@@ -84,6 +84,5 @@ Init_output_safety_ext()
 
   rb_define_method(rb_cString, "+",                 str_plus,           1);
   rb_define_method(rb_cString, "<<",                str_concat,         1);
-}
 
-#endif
+}

data/ext/monkeysupport_output_safety/src/monkeysupport_output_safety.c

@@ -0,0 +1,91 @@
+#include "ruby.h"
+
+// Use a FL_USER flag for storing html safety information.
+// fingers crossed here, this is black black magic.
+//#ifdef FL_USER4
+
+/*
+
+//#define HFLAG FL_USER4
+
+// by default, objects are not safe for html.
+VALUE obj_html_safe_qmark(VALUE self) { return Qfalse; }
+
+//fixnums are always safe for html.
+VALUE fix_html_safe_qmark(VALUE self) { return Qtrue; }
+
+VALUE // mark a string as safe for html.
+str_html_safe_bang(VALUE self)
+{
+  FL_SET(self, HFLAG);
+  return self;
+}
+
+VALUE // is this string safe for html?
+str_html_safe_qmark(VALUE self)
+{
+  return FL_TEST(self, HFLAG) ? Qtrue : Qfalse;
+}
+
+void
+set_html_safe(VALUE obj, bool val)
+{
+  if (val) {
+    FL_SET(obj, HFLAG);
+  } else {
+    FL_UNSET(obj, HFLAG);
+  }
+}
+
+
+VALUE // return a copy of this string, marked as safe for html.
+str_html_safe(VALUE self)
+{
+  VALUE other = rb_obj_dup(self);
+  return str_html_safe_bang(other);
+}
+
+VALUE
+str_plus(VALUE self, VALUE other)
+{
+  VALUE ret;
+  bool safe = ((str_html_safe_qmark(self) == Qtrue) &&
+               (str_html_safe_qmark(other) == Qtrue));
+
+  ret = rb_str_plus(self, other);
+
+  set_html_safe(ret, safe);
+  return ret;
+}
+
+VALUE
+str_concat(VALUE self, VALUE other)
+{
+  bool safe = ((str_html_safe_qmark(self) == Qtrue) &&
+               (str_html_safe_qmark(other) == Qtrue));
+
+  rb_str_concat(self, other);
+
+  set_html_safe(self, safe);
+  return self;
+}
+
+*/
+
+void
+Init_monkeysupport_output_safety()
+{
+  
+/*   rb_define_method(rb_cObject, "html_safe?",       obj_html_safe_qmark, 0); */
+/*   rb_define_method(rb_cFixnum, "html_safe?",       fix_html_safe_qmark, 0); */
+  
+/*   rb_define_method(rb_cString, "html_safe",        str_html_safe,       0); */
+/*   rb_define_method(rb_cString, "html_safe!",       str_html_safe_bang,  0); */
+/*   rb_define_method(rb_cString, "html_safe?",       str_html_safe_qmark, 0); */
+/*   rb_define_method(rb_cString, "_rails_html_safe", str_html_safe_qmark, 0); */
+
+/*   rb_define_method(rb_cString, "+",                 str_plus,           1); */
+/*   rb_define_method(rb_cString, "<<",                str_concat,         1); */
+}
+
+//#endif

data/lib/monkeysupport.rb

@@ -1,12 +1,30 @@
-require 'monkeysupport_c'
-
 require 'monkeysupport/c_proxy'
 require 'monkeysupport/memoizable'
 
-require 'monkeysupport/activesupport/inflector'
+require 'monkeysupport_c'
+
+module_loaders = {
+  "inflector" => lambda{
+    require 'monkeysupport/activesupport/inflector'
+  },
+
+  "output_safety" => lambda{
+    if ["1.8.7", "1.9.1"].include? RUBY_VERSION
+      require 'monkeysupport_output_safety'
+    else
+      puts "##MonkeySupport: output_safety module not supported by #{RUBY_VERSION}. Module not loaded."
+    end
+  }
+}
+
+modules = module_loaders.keys
+if $MonkeyModuleIncludes
+  modules &= $MonkeyModuleIncludes # intersection
+end
+if $MonkeyModuleExcludes
+  modules -= $MonkeyModuleExcludes # difference
+end
 
-if ["1.8.7", "1.9.1"].include? RUBY_VERSION
-  require 'output_safety_ext'
-else
-  puts "** MonkeySupport: output_safety module was not designed to work with #{RUBY_VERSION}. Extension not loaded."
+modules.each do |mdl|
+  module_loaders[mdl].call
 end

data/lib/monkeysupport/activesupport/inflector.rb

@@ -3,8 +3,9 @@ module ActiveSupport
 
     extend MonkeySupport::Memoizable
     extend MonkeySupport::CProxy
-    
-    monkey_memoize :pluralize, :singularize, :humanize
+
+    # This breaks a test case in rails now :(
+    # monkey_memoize :pluralize, :singularize, :humanize
 
     monkey_c_proxy(:camelize,
                    :activesupport_inflector_camelize,

data/monkeysupport.gemspec

@@ -5,42 +5,41 @@
 
 Gem::Specification.new do |s|
   s.name = %q{monkeysupport}
-  s.version = "0.1.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Burke Libbey"]
   s.date = %q{2009-12-28}
-  s.description = %q{MonkeySupport provides C implementations for some of the more intensive string manipulation methods in activesupport.}
+  s.description = %q{MonkeySupport monkeypatches some of the performance-sink parts of rails with speedy C extensions.}
   s.email = %q{burke@burkelibbey.org}
-  s.extensions = ["ext/monkeysupport_c/extconf.rb", "ext/output_safety_ext/extconf.rb"]
+  s.extensions = ["ext/monkeysupport_c/extconf.rb", "ext/monkeysupport_output_safety/extconf.rb"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "ext/monkeysupport_c/extconf.rb",
      "ext/monkeysupport_c/src/activesupport_inflector.c",
      "ext/monkeysupport_c/src/activesupport_inflector.h",
      "ext/monkeysupport_c/src/monkeysupport_c.c",
-     "ext/output_safety_ext/Makefile",
-     "ext/output_safety_ext/extconf.rb",
-     "ext/output_safety_ext/output_safety_ext.bundle",
-     "ext/output_safety_ext/output_safety_ext.c",
-     "ext/output_safety_ext/output_safety_ext.o",
+     "ext/monkeysupport_output_safety/Makefile",
+     "ext/monkeysupport_output_safety/extconf.rb",
+     "ext/monkeysupport_output_safety/monkeysupport_output_safety.c",
+     "ext/monkeysupport_output_safety/src/monkeysupport_output_safety.c",
      "lib/monkeysupport.rb",
      "lib/monkeysupport/activesupport/inflector.rb",
      "lib/monkeysupport/c_proxy.rb",
      "lib/monkeysupport/lru_cache.rb",
      "lib/monkeysupport/memoizable.rb",
      "monkeysupport.gemspec",
-     "test/monkeysupport_test.rb",
-     "test/test_helper.rb"
+     "spec/output_safety_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/burke/monkeysupport}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -48,8 +47,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Monkeypatching Rails with C since 2009}
   s.test_files = [
-    "test/monkeysupport_test.rb",
-     "test/test_helper.rb"
+    "spec/output_safety_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/output_safety_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe String do
+  context "newly created" do
+    it "should not be html_safe" do
+      "foo bar baz".html_safe?.should be_false
+    end
+  end
+
+  context "not marked as html_safe" do
+    it "should be html_safe once marked as html_safe" do
+      "foo".html_safe.html_safe?.should be_true
+    end
+    it "should be equal to the same html_safe string" do
+      "foo".html_safe.should ==("foo")
+    end
+    it "should return the same string after calling html_safe!" do
+      foo = "bar"
+      bar = foo.html_safe!
+      foo.should equal(bar)
+    end
+    it "should be modified when html_safe! is called" do
+      foo = "bar"
+      foo.html_safe!
+      foo.html_safe?.should be_true
+    end
+  end
+
+  context "marked as html_safe" do
+    it "should become html_unsafe when an unsafe string is concatenated to it" do
+      foo = "bar".html_safe
+      foo << "baz"
+      foo.html_safe?.should be_false
+    end
+    it "should remain html_safe when a safe string is concatenated to it" do
+      foo = "bar".html_safe
+      foo << "baz".html_safe
+      foo.html_safe?.should be_true
+    end
+    it "should return an unsafe string when added to an unsafe string" do
+      ("foo".html_safe + "bar").html_safe?.should be_false
+    end
+    it "should return safe string when added to a safe string" do
+      ("foo".html_safe + "bar".html_safe).html_safe?.should be_true
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require File.join(File.dirname(__FILE__),'../lib/monkeysupport')
+
+require 'spec/autorun'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: monkeysupport
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Burke Libbey
@@ -22,40 +22,39 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: MonkeySupport provides C implementations for some of the more intensive string manipulation methods in activesupport.
+description: MonkeySupport monkeypatches some of the performance-sink parts of rails with speedy C extensions.
 email: burke@burkelibbey.org
 executables: []
 
 extensions: 
 - ext/monkeysupport_c/extconf.rb
-- ext/output_safety_ext/extconf.rb
+- ext/monkeysupport_output_safety/extconf.rb
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - ext/monkeysupport_c/extconf.rb
 - ext/monkeysupport_c/src/activesupport_inflector.c
 - ext/monkeysupport_c/src/activesupport_inflector.h
 - ext/monkeysupport_c/src/monkeysupport_c.c
-- ext/output_safety_ext/Makefile
-- ext/output_safety_ext/extconf.rb
-- ext/output_safety_ext/output_safety_ext.bundle
-- ext/output_safety_ext/output_safety_ext.c
-- ext/output_safety_ext/output_safety_ext.o
+- ext/monkeysupport_output_safety/Makefile
+- ext/monkeysupport_output_safety/extconf.rb
+- ext/monkeysupport_output_safety/monkeysupport_output_safety.c
+- ext/monkeysupport_output_safety/src/monkeysupport_output_safety.c
 - lib/monkeysupport.rb
 - lib/monkeysupport/activesupport/inflector.rb
 - lib/monkeysupport/c_proxy.rb
 - lib/monkeysupport/lru_cache.rb
 - lib/monkeysupport/memoizable.rb
 - monkeysupport.gemspec
-- test/monkeysupport_test.rb
-- test/test_helper.rb
+- spec/output_safety_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/burke/monkeysupport
 licenses: []
@@ -85,5 +84,5 @@ signing_key:
 specification_version: 3
 summary: Monkeypatching Rails with C since 2009
 test_files: 
-- test/monkeysupport_test.rb
-- test/test_helper.rb
+- spec/output_safety_spec.rb
+- spec/spec_helper.rb

data/README.rdoc

@@ -1,34 +0,0 @@
-= MonkeySupport
-
-MonkeySupport is a collection of monkeypatches to Rails, replacing
-existing methods with (somewhat) optimized C equivalents.
-
-If this interests you, you should also check out methodmissing's
-excellent HashWithIndifferentAccess at
-http://github.com/methodmissing/hwia .
-
-== 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.
-
-== Problems / TODO
-
-* I haven't figured out a simple way to get this running with the
-  rails test suite. That would be handy.
-* Certain functions are memoized now, that rails doesn't memoize by
-  default. I've tried to choose carefully, but with unusual usage
-  patterns, this could cause memory issues. Simplest solution that
-  comes to my mind would be to use a simple LRU cache instead of a
-  plain hash.
-* There's always more to port...
-
-== Copyright
-
-Copyright (c) 2009 Burke Libbey. See LICENSE for details.

data/ext/output_safety_ext/extconf.rb

@@ -1,5 +0,0 @@
-require 'mkmf'
-
-extension_name = 'output_safety_ext'
-dir_config(extension_name)
-create_makefile(extension_name, '.')

data/test/monkeysupport_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class MonkeysupportTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end

data/test/test_helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'monkeysupport'
-
-class Test::Unit::TestCase
-end