acts_as_singleton 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2009-03-30
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/acts_as_singleton.rb
+test/acts_as_singleton_test.rb

data/README.txt

@@ -0,0 +1,106 @@
+= acts_as_singleton
+
+http://github.com/stephencelis/acts_as_singleton
+
+
+== DESCRIPTION
+
+A lightweight singleton library for your Active Record models.
+
+It just makes sense to store mutable, site-wide, admin-level settings in the
+database. Right? A key-value table may be more flexible, but maybe we don't
+want to be flexible!
+
+
+== FEATURES/PROBLEMS
+
+* Lightning-fast queries! Doesn't get any faster than this! (Guaranteed.)
+* Follows the ultra-cool "singleton" pattern! (Tell your friends.)
+* What? That's not the "cool" singleton in Ruby? (Don't tell your friends?)
+
+
+== SYNOPSIS
+
+  class HomepageSettings < ActiveRecord::Base
+    include ActiveRecord::Singleton
+  end
+
+
+How Rubyish! Oh, you want it Railsish? Very well...
+
+  class HomepageSettings < ActiveRecord::Base
+    acts_as_singleton
+  end
+
+
+Have your cake and eat your silly idiom, too! Just try to create a row!
+
+  HomepageSettings.instance # => #<HomepageSettings...>
+
+
+Don't even try to access it otherwise. It won't work!
+
+
+== REQUIREMENTS
+
+* Active Record 2.3.2 or greater.
+* A delicate palate.
+
+
+== INSTALL
+
+=== As a gem
+
+From RubyForge:
+
+  % gem install acts_as_singleton
+
+
+Or GitHub:
+
+  % gem install stephencelis-acts_as_singleton --source=http://gems.github.com
+
+
+And configure:
+
+  config.gem "stephencelis-acts_as_singleton",
+    :lib => "acts_as_singleton",
+    :source => "http://gems.github.com"
+
+
+=== As a plugin
+
+Traditional:
+
+  % script/plugin install git://github.com/stephencelis/acts_as_singleton.git
+
+
+Or, as a submodule:
+
+  % git submodule add git://github.com/stephencelis/acts_as_singleton.git \
+                      vendor/plugins/acts_as_singleton
+
+
+== LICENSE
+
+(The MIT License)
+
+(c) 2009-* Stephen Celis, stephen@stephencelis.com.
+
+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,34 @@
+$: << File.dirname(__FILE__) + "/lib"
+require "rubygems"
+require "hoe"
+require "active_record"
+require "acts_as_singleton"
+
+Hoe.new("acts_as_singleton", ActiveRecord::Singleton::VERSION) do |p|
+  p.developer("Stephen Celis", "stephen@stephencelis.com")
+  p.remote_rdoc_dir = ''
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_singleton plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_singleton plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'acts_as_singleton'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require "acts_as_singleton"

data/lib/acts_as_singleton.rb

@@ -0,0 +1,76 @@
+module ActiveRecord
+  # A lightweight singleton library for your Active Record models.
+  #
+  #   class HomepageSettings < ActiveRecord::Base
+  #     include ActiveRecord::Singleton
+  #   end
+  #
+  #   HomepageSettings.instance # => #<Homepage...>
+  #
+  # Like Ruby's built-in module, it will not prevent you from instantiating
+  # more than one object, but it will make it more difficult.
+  #
+  #   HomepageSettings.__send__(:new).new_record? # => true
+  #
+  # Most methods assuming more than one database record will be made private
+  # upon including this module. Make sure your public class methods do not
+  # clash with the <tt>ActiveRecord::Singleton::PRIVATE</tt> pattern, or
+  # define them after including the module.
+  module Singleton
+    VERSION = "0.0.1"
+
+    # This pattern matches methods that should be made private because they
+    # should not be used in singleton classes.
+    PRIVATE = /^all(?:oc.*)?$|alloc|create|find|firs|mini|max|new|d_sco|upd/
+
+    def self.included(model)
+      model.class_eval do
+        private_class_method *methods.grep(PRIVATE) # Deny existent others.
+
+        class << self
+          def exists? # Refuse arguments.
+            super
+          end
+
+          # Returns the first (presumably only) record in the database, or
+          # creates one.
+          #
+          # If validation fails on creation, it will return an unsaved object.
+          #
+          #   HomepageSettings.instance.update_attributes :welcome => "Hello!"
+          def instance
+            first || create
+          end
+
+          def inspect
+            super.sub(/id: .+?, /) {} # Irrelevant.
+          end
+        end
+
+        def clone
+          raise TypeError, "can't clone instance of singleton #{self.class}"
+        end
+
+        def dup
+          raise TypeError, "can't dup instance of singleton #{self.class}"
+        end
+
+        def inspect
+          super.sub(/id: .+?, /) {} # Irrelevant.
+        end
+      end
+    end
+  end
+
+  class << Base
+    # Class method to provide a more Rails-like experience. Merely includes
+    # the <tt>ActiveRecord::Singleton</tt> module.
+    #
+    #   class HomepageSettings < ActiveRecord::Base
+    #     acts_as_singleton # Equivalent to "include ActiveRecord::Singleton".
+    #   end
+    def acts_as_singleton
+      include Singleton
+    end
+  end
+end

data/test/acts_as_singleton_test.rb

@@ -0,0 +1,68 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require "#{File.dirname(__FILE__)}/../init"
+require 'active_support'
+require 'active_support/test_case'
+
+def setup_db
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:')
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :homepage_settings do |t|
+      t.text :welcome_message
+      t.timestamp :published_at, :expired_at
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+setup_db
+class HomepageSettings < ActiveRecord::Base
+  acts_as_singleton
+end
+
+class ActsAsSingletonTest < ActiveSupport::TestCase
+  setup do
+    setup_db
+  end
+
+  teardown do
+    teardown_db
+  end
+
+  test "should be provocative" do
+    assert_raise(NoMethodError) { HomepageSettings.new }
+    assert_raise(NoMethodError) { HomepageSettings.create }
+    assert_raise(NoMethodError) { HomepageSettings.update }
+    assert_raise(NoMethodError) { HomepageSettings.alloc }
+    assert_raise(NoMethodError) { HomepageSettings.all }
+    assert_raise(NoMethodError) { HomepageSettings.first }
+    assert_raise(NoMethodError) { HomepageSettings.find }
+    assert_raise(NoMethodError) { HomepageSettings.named_scope }
+    assert_raise(NoMethodError) { HomepageSettings.minimum }
+    assert_raise(NoMethodError) { HomepageSettings.maximum }
+    assert_raise(ArgumentError) { HomepageSettings.exists? 1 }
+    assert_raise(TypeError) { HomepageSettings.instance.clone }
+    assert_raise(TypeError) { HomepageSettings.instance.dup }
+  end
+
+  test "should be lazy" do
+    assert !HomepageSettings.exists?
+    assert_instance_of HomepageSettings, HomepageSettings.instance
+    assert HomepageSettings.exists?
+  end
+
+  test "should be equal" do
+    assert_equal HomepageSettings.instance, HomepageSettings.instance
+  end
+
+  test "should be unidentifiable" do
+    assert_no_match(/id: .+?,/, HomepageSettings.inspect)
+    assert_no_match(/id: .+?,/, HomepageSettings.instance.inspect)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_singleton
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stephen Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: A lightweight singleton library for your Active Record models.  It just makes sense to store mutable, site-wide, admin-level settings in the database. Right? A key-value table may be more flexible, but maybe we don't want to be flexible!
+email: 
+- stephen@stephencelis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- init.rb
+- lib/acts_as_singleton.rb
+- test/acts_as_singleton_test.rb
+has_rdoc: true
+homepage: http://github.com/stephencelis/acts_as_singleton
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: acts_as_singleton
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A lightweight singleton library for your Active Record models
+test_files: []
+