partialclass 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime-*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in partialclass.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simon Worthington
+
+MIT License
+
+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,74 @@
+# Partial Classes
+
+This gem allows you to specify arguments to a class before you
+actually initialize it. This is useful for two main reasons:
+
+1. It means you can specify initializer arguments ahead of time,
+   cutting down on the number of variables you need to pass around
+   or wrapper classes you need to manually write.
+2. You can write a base class that takes initializer arguments
+   and then generate more specific child classes by specifying the
+   required arguments.
+
+This is particularly useful if your class performs some some kind
+of memory- or resource-hungry action in it's initializer that you 
+want to save until later (e.g. `File.new` opens the file straight 
+away).
+
+The key point about all this is that you still get to pass around
+classes, not `Proc`s or anything else, so you will still get the 
+behaviour that you expect a class to have. See the Usage
+section for more information.
+
+If the idea of this confuses or disorientates you, stop usage
+immedieatly and seek medial assistance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'partialclass'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install partialclass
+
+## Usage
+
+	require 'partialclass'
+
+You can use `specialize` to generate a specialized child class:
+
+	Logfile = File.specialize "mylog.txt"   # No files open yet
+	...
+	f = Logfile.new 'w'                     # File opened here!
+
+You can also use the `<<` operator to push arguments to the class:
+
+	SpecificDay = Time << 2009 << 10 << 25
+	puts SpecificDay.new           # 2009-10-25 00:00:00 +0100
+	puts SpecificDay.new 22, 35    # 2009-10-25 22:35:00 +0100
+
+You can also specialize classes multiple times:
+
+	SpecificMinute = SpecificDay << 22 << 35
+	puts SpecificMinute.new 06     # 2009-10-25 22:35:06 +0100
+
+Specialized classes are child classes of the original:
+
+	SpecificDay.superclass         # Time
+
+In many cases there maybe another way of acheiving this effect. If
+you don't like this way, then don't use it!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+	t.libs << "test/common"
+	t.test_files = FileList['test/test_*.rb']
+	t.verbose = false
+end

data/lib/partialclass/version.rb

@@ -0,0 +1,3 @@
+module PartialClass
+  VERSION = "0.1.0"
+end

data/lib/partialclass.rb

@@ -0,0 +1,26 @@
+require "partialclass/version"
+
+class Class
+	def specialize(*args)
+		_specialize(self, *args)
+	end
+
+	def << (arg)
+		specialize(arg)
+	end
+
+	unless Class.respond_to? :define_singleton_method
+		def define_singleton_method name, &block
+			metaclass = class << self; self; end
+			metaclass.define_method(:name, &block)
+		end
+	end
+
+	private
+	def _specialize(parent, *prep)
+		Class.new(parent) do
+			define_method(:initialize)           { |*args| super(*(prep + args)) }
+			define_singleton_method(:specialize) { |*args|  _specialize(parent, *(prep+args)) }
+		end
+	end
+end

data/partialclass.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partialclass/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "partialclass"
+  spec.version       = PartialClass::VERSION
+  spec.authors       = ["Simon Worthington"]
+  spec.email         = ["simon@simonwo.net"]
+  spec.summary       = "Specialise a Ruby class by providing some of its initializer arguments or attributes ahead of time."
+  spec.homepage      = "https://github.com/simonwo/partialclass"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/common.rb

@@ -0,0 +1,4 @@
+class TestClass
+	def initialize(*args); @args = args        end
+	def mymethod(*args);   (@args + args).join end
+end

data/test/test_correctness.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require_relative "common.rb"
+require_relative "../lib/partialclass.rb"
+
+class CorrectnessTests < Test::Unit::TestCase
+	def setup
+		@Class    = TestClass << 1 << 2 << 3
+		@Instance = @Class.new 4, 5, 6
+	end
+
+	def test_method_inheritence
+		assert_respond_to @Instance, :mymethod
+		assert_equal "123456", @Instance.mymethod
+	end
+
+	def test_superclass
+		assert_equal TestClass, @Class.superclass
+		assert @Instance.is_a?    TestClass
+		assert @Instance.kind_of? TestClass
+	end
+end

data/test/test_interface.rb

@@ -0,0 +1,15 @@
+require "test/unit"
+require_relative "common.rb"
+require_relative "../lib/partialclass.rb"
+
+class InterfaceTests < Test::Unit::TestCase
+	def test_for_single
+		assert_respond_to Class, :<<
+		assert_respond_to TestClass, :<<
+	end 
+
+	def test_for_specialize
+		assert_respond_to Class, :specialize
+		assert_respond_to TestClass, :specialize
+	end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: partialclass
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Simon Worthington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- simon@simonwo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/partialclass.rb
+- lib/partialclass/version.rb
+- partialclass.gemspec
+- test/common.rb
+- test/test_correctness.rb
+- test/test_interface.rb
+homepage: https://github.com/simonwo/partialclass
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Specialise a Ruby class by providing some of its initializer arguments or
+  attributes ahead of time.
+test_files:
+- test/common.rb
+- test/test_correctness.rb
+- test/test_interface.rb