constant-redefinition 1.0.0 → 1.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm --create 1.8.7@constant-redefinition_gem
+rvm --create 1.9.2@constant-redefinition_gem
+rvm --create 1.9.3@constant-redefinition_gem

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.1.0
+
+* Support block-style setting/unsetting/resetting of constants
+
+# 1.0.0 
+
+* Initial release

data/Gemfile

@@ -1,12 +1,3 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-end
+gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 David Czarnecki
+Copyright (c) 2010-2012 David Czarnecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,123 @@
+# constant-redefinition
+
+Allows you to define constants if not defined on an object (or module) and redefine constants without warning.
+
+## Installation
+
+`gem install constant-redefinition`
+
+or in your `Gemfile`
+
+```ruby
+gem 'constant-redefinition'
+```
+
+## Usage
+
+Define a constant if not defined:
+
+```ruby
+define_if_not_defined(:A, 1)
+ => nil 
+A
+ => 1 
+```
+
+Define a constant and redefine it:
+
+```ruby
+define_if_not_defined(:B, 1)
+ => nil 
+redefine_without_warning(:B, 2)
+ => 2 
+B
+ => 2 
+```
+
+Redefine a constant which should set the constant:    
+
+```ruby
+redefine_without_warning(:C, 3)
+ => 3 
+C
+ => 3 
+```
+
+Define a constant within a module:
+
+```ruby
+Math.define_if_not_defined(:FOO, 2 * Math::PI)
+ => nil 
+Math::FOO
+ => 6.283185307179586 
+```
+
+Define and redefine a constant within a module:
+
+```ruby
+Math.define_if_not_defined(:BAR, 3)
+ => nil 
+Math.redefine_without_warning(:BAR, 5)
+ => 5 
+Math::BAR
+ => 5 
+```
+
+Redefine a constant within a module which should set the constant:
+
+```
+Math.redefine_without_warning(:AMAZING, 3)
+ => 3 
+Math::AMAZING
+ => 3 
+```
+
+You can also define a constant using a block which will unset the constant after the block:
+
+```ruby
+class Freaks
+  GOOBLE = 'gobble'
+end
+ => "gobble" 
+
+Freaks.define_if_not_defined(:HELLO, 'world') do
+    p Freaks::HELLO
+end
+"world"
+ => "world" 
+
+p Freaks::HELLO
+NameError: uninitialized constant Freaks::HELLO
+```
+
+You can also redefine a constant using a block, which will reset the constant to its original value after the block:
+
+```ruby
+class Freaks
+  GOOBLE = 'gobble'
+end
+ => "gobble" 
+ 
+Freaks.redefine_without_warning(:GOOBLE, 'one of us') do
+  p Freaks::GOOBLE
+end
+
+"one of us"
+ => "gobble" 
+```
+
+All credit is due to this post: http://stackoverflow.com/questions/3375360/how-to-redefine-a-ruby-constant-without-warning
+
+## Contributing to constant-redefinition
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2010-2012 David Czarnecki. See LICENSE.txt for further details.

data/Rakefile

@@ -1,53 +1,17 @@
-require 'rubygems'
 require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+Bundler::GemHelper.install_tasks
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "constant-redefinition"
-  gem.homepage = "http://github.com/czarneckid/constant-redefinition"
-  gem.license = "MIT"
-  gem.summary = %Q{Allows you to define constants if not defined on an object and redefine constants without warning}
-  gem.description = %Q{Allows you to define constants if not defined on an object and redefine constants without warning}
-  gem.email = "czarneckid@acm.org"
-  gem.authors = ["David Czarnecki"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
+require 'rspec/core/rake_task'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+task :default => :spec
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "constant-redefinition #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc "Runs tests on Ruby 1.8.7, 1.9.2 and 1.9.3"
+task :test_rubies do
+  system "rvm 1.8.7@constant-redefinition_gem,1.9.2@constant-redefinition_gem,1.9.3@constant-redefinition_gem do rake spec"
 end

data/constant-redefinition.gemspec

@@ -1,61 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{constant-redefinition}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["David Czarnecki"]
-  s.date = %q{2010-12-02}
+  s.name        = "constant-redefinition"
+  s.version     = "1.1.0"
+  s.authors     = ["David Czarnecki"]
+  s.email       = ["me@davidczarnecki.com"]
+  s.homepage    = "https://github.com/czarneckid/constant-redefinition"
+  s.summary     = %q{Allows you to define constants if not defined on an object and redefine constants without warning}
   s.description = %q{Allows you to define constants if not defined on an object and redefine constants without warning}
-  s.email = %q{czarneckid@acm.org}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "constant-redefinition.gemspec",
-    "lib/constant-redefinition.rb",
-    "test/helper.rb",
-    "test/test_constant-redefinition.rb"
-  ]
-  s.homepage = %q{http://github.com/czarneckid/constant-redefinition}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Allows you to define constants if not defined on an object and redefine constants without warning}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_constant-redefinition.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = "constant-redefinition"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+end

data/lib/constant-redefinition.rb

@@ -2,11 +2,25 @@ class Object
   def define_if_not_defined(const, value)
     mod = self.is_a?(Module) ? self : self.class
     mod.const_set(const, value) unless mod.const_defined?(const)
+    if block_given?
+      yield      
+      mod.send(:remove_const, const) if mod.const_defined?(const)
+    end
   end
 
   def redefine_without_warning(const, value)
     mod = self.is_a?(Module) ? self : self.class
-    mod.send(:remove_const, const) if mod.const_defined?(const)
-    mod.const_set(const, value)
+    if block_given?
+      original_value = mod.const_get(const) if mod.const_defined?(const)
+      constant_was_set = mod.const_defined?(const)
+      mod.send(:remove_const, const) if mod.const_defined?(const)
+      mod.const_set(const, value)
+      yield
+      mod.send(:remove_const, const) if mod.const_defined?(const)
+      mod.const_set(const, original_value) if constant_was_set
+    else
+      mod.send(:remove_const, const) if mod.const_defined?(const)
+      mod.const_set(const, value)
+    end
   end
 end

data/spec/constant-redefinition_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'constant-redefinition' do
+  describe 'class operations' do
+    it 'can define a constant if not already defined' do
+      Object.define_if_not_defined(:A, 1)
+
+      1.should be(Object::A)
+    end
+
+    it 'can re-define a constant if already defined' do
+      Object.define_if_not_defined(:B, 1)
+      1.should be(Object::B)
+
+      Object.redefine_without_warning(:B, 2)
+      2.should be(Object::B)
+    end
+
+    it 'can set a constant if not already defined' do
+      Object.redefine_without_warning(:C, 3)
+      3.should be(Object::C)
+    end
+
+    it 'can set a constant and unset it if passed a block' do
+      Object.define_if_not_defined(:GOOBLE, 'gobble') do
+        Object.const_get(:GOOBLE).should == 'gobble'
+      end
+
+      lambda { Object.const_get(:GOOBLE) }.should raise_error(NameError)
+
+      Object.redefine_without_warning(:GOOBLE, 'gobble') do
+        Object.const_get(:GOOBLE).should == 'gobble'        
+      end
+
+      lambda { Object.const_get(:GOOBLE) }.should raise_error(NameError)
+    end
+  end
+
+  describe 'module operations' do
+    it 'can define a constant if not already defined' do
+      Math.define_if_not_defined(:FOO, 2 * Math::PI)
+
+      (2 * Math::PI).should == Math::FOO
+    end
+
+    it 'can re-define a constant if already defined' do
+      Math.define_if_not_defined(:BAR, 3)
+      3.should be(Math::BAR)
+
+      Math.redefine_without_warning(:BAR, 5)
+      5.should be(Math::BAR)
+    end
+
+    it 'can set a constant if not already defined' do
+      Math.redefine_without_warning(:AMAZING, 3)
+      3.should be(Math::AMAZING)
+    end
+
+    it 'can set a constant and unset it if passed a block' do
+      Math.define_if_not_defined(:GOOBLE, 'gobble') do
+        Math.const_get(:GOOBLE).should == 'gobble'
+      end
+
+      lambda { Math.const_get(:GOOBLE) }.should raise_error(NameError)
+
+      Math.redefine_without_warning(:GOOBLE, 'gobble') do
+        Math.const_get(:GOOBLE).should == 'gobble'        
+      end
+
+      lambda { Math.const_get(:GOOBLE) }.should raise_error(NameError)
+
+      original_pi = Math::PI
+      Math.redefine_without_warning(:PI, 6) do
+        Math.const_get(:PI).should be(6)
+      end
+      Math.const_get(:PI).should == original_pi
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'constant-redefinition'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,119 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: constant-redefinition
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-02 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70347522369460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70347522369460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70347522368680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id003
-description: Allows you to define constants if not defined on an object and redefine constants without warning
-email: czarneckid@acm.org
+  version_requirements: *70347522368680
+description: Allows you to define constants if not defined on an object and redefine
+  constants without warning
+email:
+- me@davidczarnecki.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
 - constant-redefinition.gemspec
 - lib/constant-redefinition.rb
-- test/helper.rb
-- test/test_constant-redefinition.rb
-has_rdoc: true
-homepage: http://github.com/czarneckid/constant-redefinition
-licenses: 
-- MIT
+- spec/constant-redefinition_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/czarneckid/constant-redefinition
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 1728699172224103149
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4258598608484863096
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -4258598608484863096
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: constant-redefinition
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Allows you to define constants if not defined on an object and redefine constants without warning
-test_files: 
-- test/helper.rb
-- test/test_constant-redefinition.rb
+summary: Allows you to define constants if not defined on an object and redefine constants
+  without warning
+test_files:
+- spec/constant-redefinition_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,18 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rcov (0.9.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
-  rcov

data/README.rdoc

@@ -1,59 +0,0 @@
-= constant-redefinition
-
-Allows you to define constants if not defined on an object and redefine constants without warning.
-
-Define a constant if not defined:
-
-    define_if_not_defined(:A, 1)
-  
-    assert_equal 1, A
-  
-Define a constant and redefine it:
-
-    define_if_not_defined(:B, 1)
-    redefine_without_warning(:B, 2)
-    
-    assert_equal 2, B
-    
-Redefine a constant which should set the constant:    
-
-    redefine_without_warning(:C, 3)
-    
-    assert_equal 3, C
-
-Define a constant within a module:
-
-    Math.define_if_not_defined(:FOO, 2 * Math::PI)
-    
-    assert_equal 2 * Math::PI, Math::FOO
-
-Define and redefine a constant within a module:
-
-    Math.define_if_not_defined(:BAR, 3)
-    Math.redefine_without_warning(:BAR, 5)
-
-    assert_equal 5, Math::BAR
-
-Redefine a constant within a module which should set the constant:
-
-    Math.redefine_without_warning(:AMAZING, 3)
-    
-    assert_equal 3, Math::AMAZING
-    
-All credit is due to this post: http://stackoverflow.com/questions/3375360/how-to-redefine-a-ruby-constant-without-warning
-
-== Contributing to constant-redefinition
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2010 David Czarnecki. See LICENSE.txt for
-further details.
-

data/VERSION

@@ -1 +0,0 @@
-1.0.0

data/test/helper.rb

@@ -1,17 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'constant-redefinition'
-
-class Test::Unit::TestCase
-end

data/test/test_constant-redefinition.rb

@@ -1,41 +0,0 @@
-require 'helper'
-
-class TestConstantRedefinition < Test::Unit::TestCase
-  def test_can_define_a_constant_if_not_already_defined
-    define_if_not_defined(:A, 1)
-    
-    assert_equal 1, A
-  end
-  
-  def test_can_redefine_a_constant_if_already_defined
-    define_if_not_defined(:B, 1)
-    redefine_without_warning(:B, 2)
-    
-    assert_equal 2, B
-  end
-  
-  def test_redefine_a_constant_sets_constant_if_not_already_defined
-    redefine_without_warning(:C, 3)
-    
-    assert_equal 3, C
-  end
-  
-  def test_can_define_a_constant_in_a_module_if_not_already_defined
-    Math.define_if_not_defined(:FOO, 2 * Math::PI)
-    
-    assert_equal 2 * Math::PI, Math::FOO
-  end
-  
-  def test_can_redefine_a_constant_in_a_module_if_already_defined
-    Math.define_if_not_defined(:BAR, 3)
-    Math.redefine_without_warning(:BAR, 5)
-
-    assert_equal 5, Math::BAR
-  end
-  
-  def test_redefine_a_constant_in_a_module_sets_constant_if_not_already_defined
-    Math.redefine_without_warning(:AMAZING, 3)
-    
-    assert_equal 3, Math::AMAZING
-  end
-end