tweak 0.1.1

data/README.markdown

@@ -0,0 +1,101 @@
+Tweak
+=============
+
+(C) John Mair (banisterfiend) 2010
+
+_Scoped modification of core classes_
+
+Add temporary functionality to core classes.
+
+Based on some ideas found in this [Ruby-Forum thread](http://www.ruby-forum.com/topic/179060)
+
+`Tweak` provides the `using` method.
+
+* Install the [gem](https://rubygems.org/gems/tweak): `gem install tweak`
+* Read the [documentation](http://rdoc.info/github/banister/tweak/master/file/README.markdown)
+* See the [source code](http://github.com/banister/tweak)
+
+example: using
+-------------------------
+
+With the `using` method we can enhance a core class for the duration
+of a block:
+
+    module Tweaks
+      
+      class String
+        def hello
+          :hello
+        end
+      end
+
+      class Fixnum
+        Hello = :hello
+        
+        def bye
+          :bye
+        end
+      end
+      
+    end
+
+    using Tweaks do
+      "john".hello #=> :hello
+      5.bye #=> :bye
+      Fixnum::Hello #=> :hello
+    end
+
+    "john".hello #=> NameError
+    
+How it works
+--------------
+
+Makes use of the `Remix` and `Object2module` libraries. Note that `Tweak`
+modifies core classes by what is effectively a module inclusion, this
+means you cannot use `Tweak` to override existing functionality but
+more to augment and supplement that functionality.
+
+`Tweak` works by doing the following: 
+
+* Looks for top-level classes and modules with the same name as those
+defined under the using-module.
+* Uses `Object2module` to include the corresponding class/module
+defined under the using-module into the top-level class/module of the
+same name.
+* Uses `Remix` to uninclude that functionality at the end of the `using` block.
+
+Thread Safety
+--------------
+
+`Tweak` is not threadsafe.
+
+Limitations
+-----------
+
+Does not work with nested modules, e.g `class String::SomethingElse`
+
+This is not intended to be a robust or serious solution, it's just a
+little experiment. :)
+
+Companion Libraries
+--------------------
+
+Tweak is one of a series of experimental libraries that mess with
+the internals of Ruby to bring new and interesting functionality to
+the language, see also:
+
+* [Remix](http://github.com/banister/remix) - Makes ancestor chains read/write
+* [Object2module](http://github.com/banister/object2module) - Enables you to include/extend Object/Classes.
+* [Include Complete](http://github.com/banister/include_complete) - Brings in
+  module singleton classes during an include. No more ugly ClassMethods and included() hook hacks.
+* [Prepend](http://github.com/banister/prepend) - Prepends modules in front of a class; so method lookup starts with the module
+* [GenEval](http://github.com/banister/gen_eval) - A strange new breed of instance_eval
+* [LocalEval](http://github.com/banister/local_eval) - instance_eval without changing self
+
+Contact
+-------
+
+Problems or questions contact me at [github](http://github.com/banister)
+
+
+

data/Rakefile

@@ -0,0 +1,59 @@
+dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{direc}/lib/tweak/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+
+def apply_spec_defaults(s)
+  s.name = "tweak"
+  s.summary = "basic selector namespace implementation"
+  s.version = Tweak::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.add_dependency("remix",">=0.4.9")
+  s.add_dependency("object2module",">=0.5.0")
+  s.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = 'yard'
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+                     "test/*.rb", "CHANGELOG", "README.markdown", "Rakefile"]
+end
+
+task :test do
+  sh "bacon -k #{direc}/test/test.rb"
+end
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)        
+    s.platform = Gem::Platform::RUBY
+  end
+  
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:rmgems, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{direc}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end

data/lib/tweak.rb

@@ -0,0 +1,70 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/tweak/version.rb"
+require 'object2module'
+require 'remix'
+
+module Tweak
+  module ObjectExtensions
+
+    # Temporarily augment the top-level classes/modules of the same
+    # name as those defined in the using-module for the duration of
+    # the block.
+    # @yield The block where the functionality shall be available.
+    # @return The value of the block
+    # @param [Module, Symbol] name The using-module, may either be the
+    #   name of the using-module as a Symbol or the actual Module itself
+    # @example
+    #   module Tweaks
+    #     class String
+    #       def hello() :hello end
+    #     end
+    #   end
+    #
+    #   using Tweaks do
+    #     "john".hello #=> :hello
+    #   end
+    #
+    #   "john".hello #=> NoMethodError
+    def using(name, &block)
+      mod = name
+      if name.instance_of?(Symbol)
+        mod = Object.const_get(name)
+      end
+      
+      raise "name is not a Module or a Symbol" if !mod.instance_of?(Module)
+
+      tweaks = {}
+      begin
+        mod.constants.each do |v|
+          tweaked_source = mod.const_get(v)
+          
+          # Only include the class/module from the using-module if:
+          # 1. The class/module in the using-module is a module (or class)
+          # 2. A corresponding module (or class) is found at top-level
+          next if !tweaked_source.instance_of?(Module) && !Object.const_defined?(v) &&
+            !Object.const_get(v).instance_of?(Module)
+          
+          tweak_dest = Object.const_get(v)
+          tweak_source = mod.const_get(v)
+          tweak_dest.gen_include(tweak_source)
+          tweaks[tweak_dest] = tweaked_source
+        end
+        
+        yield
+        
+      ensure
+
+        # Uninclude all the using-module classes/modules
+        tweaks.each do |tweak_dest, tweak_source|
+          tweak_dest.uninclude(tweak_source, true)
+        end
+      end
+    end
+  end
+end
+
+class Object
+  include Tweak::ObjectExtensions
+end
+

data/lib/tweak/version.rb

@@ -0,0 +1,3 @@
+module Tweak
+  VERSION = "0.1.1"
+end

data/lib/tweak/version_flymake.rb

@@ -0,0 +1,3 @@
+module Tweak
+  VERSION = "0.1.1"
+end

data/test/test.rb

@@ -0,0 +1,53 @@
+direc = File.dirname(__FILE__)
+require 'rubygems'
+require 'bacon'
+require "#{direc}/../lib/tweak"
+
+class Module
+  public :include, :remove_const
+end
+
+puts "testing Tweak version #{Tweak::VERSION}..."
+
+describe Object2module do
+  before do
+    module Tweaks
+      
+      class String
+        def hello
+          :hello
+        end
+      end
+
+      class Fixnum
+        Hello = :hello
+        
+        def bye
+          :bye
+        end
+      end
+      
+    end
+  end
+
+  after do
+    Object.remove_const(:Tweaks)
+  end
+
+  describe 'using' do
+    it 'tweaks functionality of String and Fixnum classes for duration of block' do
+      lambda { "john".hello }.should.raise NoMethodError
+      lambda { 5.bye }.should.raise NoMethodError
+      
+      using Tweaks do
+        "john".hello.should == :hello
+        5.bye.should == :bye
+        Fixnum::Hello.should == :hello
+      end
+
+      lambda { "john".hello }.should.raise NoMethodError
+      lambda { 5.bye }.should.raise NoMethodError
+      Fixnum.const_defined?(:Hello).should == false
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: tweak
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: remix
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 9
+        version: 0.4.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: object2module
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+description: basic selector namespace implementation
+email: jrmair@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tweak/version.rb
+- lib/tweak/version_flymake.rb
+- lib/tweak.rb
+- test/test.rb
+- README.markdown
+- Rakefile
+has_rdoc: yard
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: basic selector namespace implementation
+test_files: []
+