tiny_singleton 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76e868a8bdf64ca3f34f698d482bc055a2687d89
+  data.tar.gz: 0b4c82ac841bb1062bd8181609b8606336e721e4
+SHA512:
+  metadata.gz: e328944480940c4278201473ef7a23a09c91ef2704e3892752d670fa37d6c1eed0402327e850df2981b570d9ffd1b5b7f8030b98a70c7a04240746cd1155cc92
+  data.tar.gz: 18aed245d724dfa9f6ec04a4dda3dcb92a1d8d8c7631cf50df65c711148b605b5981912d459313126b4028d59f26ea17dfe7ea9e1974a9135fd70bda040985e0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+pkg/

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown -M kramdown --title "tiny_singleton Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2015-02-23
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Damien Robert
+
+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,48 @@
+# tiny_singleton
+
+* [Homepage](https://github.com/DamienRobert/tiny_singleton#readme)
+* [Gems]("https://rubygems.org/gems/tiny_singleton)
+* [Issues](https://github.com/DamienRobert/tiny_singleton/issues)
+* [Documentation](http://rubydoc.info/gems/tiny_singleton/frames)
+* [Email](mailto:Damien.Olivier.Robert+gems at gmail.com)
+
+## Description
+
+  Tiny Singleton is a very simple implementation of the Singleton Design
+  Pattern. Compared to the Singleton module in the stdlib, one does not
+  need to class 'klass.instance' to get access to the singleton object, one
+  can call 'klass.new' as usual. It is thus easier to add the Singleton
+  Pattern to an existing class without changing the way the code calls it.
+
+## Features
+
+## Examples
+
+``` ruby
+require 'tiny_singleton'
+
+class Foo
+  prepend TinySingleton
+  def initialize(foo)
+    @foo=foo
+  end
+end
+
+foo=Foo.new("foo")
+bar=Foo.new("bar")
+foo.object_id == bar.object_id #=> true
+```
+
+## Requirements
+
+It needs at least `ruby 2.0` since it relies on `Module#prepend`
+
+## Install
+
+    $ gem install tiny_singleton
+
+## Copyright
+
+Copyright (c) 2015 Damien Robert
+
+MIT License. See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new(sign: {checksum: true, pgp: true},
+               build: {tar: true}, scm: {status: true}) do |tasks|
+    tasks.console.command = 'pry'
+  end
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  gem 'yard', '~> 0.8'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard
+

data/gemspec.yml

@@ -0,0 +1,17 @@
+name: tiny_singleton
+summary: "Singleton pattern using Module#prepend"
+description: |
+  Tiny Singleton is a very simple implementation of the Singleton Design
+  Pattern. Compared to the Singleton module in the stdlib, one does not
+  need to class 'klass.instance' to get access to the singleton object, one
+  can call 'klass.new' as usual. It is thus easier to add the Singleton
+  Pattern to an existing class without changing the way the code calls it.
+license: MIT
+authors: Damien Robert
+email: Damien.Olivier.Robert+gems@gmail.com
+homepage: https://github.com/DamienRobert/tiny_singleton#readme
+
+development_dependencies:
+  minitest: ~> 5.0
+  rubygems-tasks: ~> 0.2
+  yard: ~> 0.8

data/lib/tiny_singleton.rb

@@ -0,0 +1,27 @@
+require 'tiny_singleton/version'
+
+#prepend TinySingleton in a class to make it a Singleton Class
+module TinySingleton
+	def clone
+		return self
+	end
+	alias dup clone
+
+	def self.prepended(klass)
+		klass.singleton_class.send :prepend, ClassMethods
+	end
+	def self.included(klass)
+		klass.singleton_class.send :prepend, ClassMethods
+	end
+
+	module ClassMethods
+		def new(*args,&b)
+			singl=:@_singleton_
+			if instance_variable_defined?(singl)
+				return instance_variable_get(singl)
+			else
+				instance_variable_set(singl,super)
+			end
+		end
+	end
+end

data/lib/tiny_singleton/version.rb

@@ -0,0 +1,4 @@
+module TinySingleton
+  # tiny_singleton version
+  VERSION = "0.1.0"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'minitest/autorun'

data/test/test_tiny_singleton.rb

@@ -0,0 +1,54 @@
+require 'helper'
+require 'tiny_singleton'
+
+class TestTinySingleton < Minitest::Test
+	def setup
+		@fooClass=Class.new do
+			prepend TinySingleton
+			def initialize(foo)
+				@foo=foo
+			end
+		end
+	end
+
+	def test_version
+		version = TinySingleton.const_get('VERSION')
+
+		assert(!version.empty?, 'should have a VERSION constant')
+	end
+
+	def test_singleton_pattern
+		foo=@fooClass.new("foo")
+		bar=@fooClass.new("bar")
+		assert_equal foo.object_id, bar.object_id, 'Objects created by new should be identical'
+	end
+
+	def test_clone
+		foo=@fooClass.new("foo")
+		bar=foo.clone
+		assert_equal foo.object_id, bar.object_id
+	end
+
+	def test_dup
+		foo=@fooClass.new("foo")
+		bar=foo.clone
+		assert_equal foo.object_id, bar.object_id
+	end
+
+	def test_subclass
+		barClass=Class.new(@fooClass)
+		foo=@fooClass.new("foo")
+		bar=@fooClass.new("bar")
+		assert_equal foo.object_id, bar.object_id
+	end
+
+	def test_include
+		fooClass=Class.new do
+			include TinySingleton
+		end
+		foo=fooClass.new
+		bar=fooClass.new
+		assert_equal foo.object_id, bar.object_id
+	end
+
+end

data/tiny_singleton.gemspec

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'tiny_singleton/version'
+                  TinySingleton::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tiny_singleton
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damien Robert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |
+  Tiny Singleton is a very simple implementation of the Singleton Design
+  Pattern. Compared to the Singleton module in the stdlib, one does not
+  need to class 'klass.instance' to get access to the singleton object, one
+  can call 'klass.new' as usual. It is thus easier to add the Singleton
+  Pattern to an existing class without changing the way the code calls it.
+email: Damien.Olivier.Robert+gems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gitignore"
+- ".yardopts"
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/tiny_singleton.rb
+- lib/tiny_singleton/version.rb
+- test/helper.rb
+- test/test_tiny_singleton.rb
+- tiny_singleton.gemspec
+homepage: https://github.com/DamienRobert/tiny_singleton#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Singleton pattern using Module#prepend
+test_files: []