stricter_global_usage 1.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+html/
+pkg/
+vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+    - 1.8.7
+    - 1.9.2
+    - 1.9.3
+    - jruby-18mode
+    - jruby-19mode
+    - rbx-18mode
+    - rbx-19mode

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2012-06-10
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+group :development do
+
+  gem 'rubygems-tasks',  '~> 0.2'
+  gem 'rdoc',  '~> 3.0'
+  gem 'rspec',  '~> 2.4'
+  gem 'bundler',  '~> 1.0'
+  gem 'rake',  '~> 0.8'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Mark Rushakoff
+
+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.rdoc

@@ -0,0 +1,48 @@
+= stricter_global_usage
+
+{<img src="https://secure.travis-ci.org/mark-rushakoff/StricterGlobalUsage.png?branch=master" />}[http://travis-ci.org/mark-rushakoff/StricterGlobalUsage]
+
+* {Homepage}[https://github.com/mark-rushakoff/stricter_global_usage#readme]
+* {Issues}[https://github.com/mark-rushakoff/stricter_global_usage/issues]
+* {Documentation}[http://rubydoc.info/gems/stricter_global_usage/frames]
+
+== Description
+
+There are several methods in Ruby that use a default argument of a global variable; of those, Array#join and String#split are the main two that could potentially give you problems if someone sets the corresponding global variables to something other than the default.
+stricter_global_usage will raise an exception (default behavior) or give a runtime warning when you use a function and its argument falls back to the global variable - because chances are, that's not the behavior you intended.
+
+== Features
+
+Currently, StricterGlobalUsage wraps Array#join and String#split, applying the specified strategy if one of those methods is called without explicit arguments.
+
+== Examples
+
+  require 'stricter_global_usage'
+
+  # default behavior:
+  %w(cat dog).join # => raises exception!
+  %w(cat dog).join($,) # => explictly uses default global variable
+
+  # warn instead of raising exceptions
+  ::StricterGlobalUsage::Strategy.use(:warn)
+  'one two'.split # => warns, but effectively the same as `'one two'.split($;)`
+
+  # temporarily use a different strategy
+  ::StricterGlobalUsage::Strategy.with(:silent) do
+    'one two'.split # => will not raise or warn
+  end
+  %w(cat dog).join # => will warn again
+
+== Requirements
+
+StricterGlobalUsage does not depend on any other gems.
+
+== Install
+
+  $ gem install stricter_global_usage
+
+== Copyright
+
+Copyright (c) 2012 Mark Rushakoff
+
+Available under the terms of the MIT license.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "stricter_global_usage"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/lib/stricter_global_usage/core_ext/array.rb

@@ -0,0 +1,11 @@
+require 'stricter_global_usage/strategy'
+
+class Array
+  alias_method :join_without_global_check, :join
+  # http://www.ruby-doc.org/core-1.9.3/Array.html#method-i-join
+  # Method's argument defaults to `$,`.
+  def join(*args)
+    ::StricterGlobalUsage::Strategy.apply('Array#join') if args.length.zero?
+    join_without_global_check(*args)
+  end
+end

data/lib/stricter_global_usage/core_ext/string.rb

@@ -0,0 +1,12 @@
+require 'stricter_global_usage/strategy'
+
+class String
+  alias_method :split_without_global_check, :split
+  
+  # http://ruby-doc.org/core-1.9.3/String.html#method-i-split
+  # Method's argument defaults to `$;`.
+  def split(*args)
+    ::StricterGlobalUsage::Strategy.apply('String#split') if args.length.zero?
+    split_without_global_check(*args)
+  end
+end

data/lib/stricter_global_usage/default_global_variable_used.rb

@@ -0,0 +1,5 @@
+module StricterGlobalUsage
+  # The default error class used when StricterGlobalUsage raises an error.
+  class DefaultGlobalVariableUsed < RuntimeError
+  end
+end

data/lib/stricter_global_usage/strategy.rb

@@ -0,0 +1,68 @@
+module StricterGlobalUsage
+  # The Strategy module represents the action to take when a function is called and its argument defaults to the value
+  # of a global variable.
+  #
+  # Consumers of StricterGlobalUsage usually will only need to use the +use+ method to specify which strategy should be
+  # applied when necessary.
+  #
+  # There are three built-in strategies (although consumers are free to add more through the +add+ method):
+  #
+  # * +raise+: The default strategy. Raises ::StricterGlobalUsage::DefaultGlobalVariableUsed exception.
+  # * +warn+: Logs the call with Kernel.warn, then continues to execute the original method.
+  # * +silent+: Does nothing, then continues to execute the original method.
+  module Strategy
+    @strategies = {}
+    @name = nil
+
+    # Apply the current strategy (warns, raises an exception, or does something else the user chose).
+    # When you call apply yourself, you are expected to supply the name of the method as (e.g.) 'Dog#bark'.
+    def self.apply(method)
+      @strategies[@name].call(method)
+    end
+
+    # Create a new strategy. When that strategy is applied, it will be passed
+    # in information about the call to Strategy.apply.
+    #
+    #   ::StricterGlobalUsage::Strategy.add(:my_log) do |method_name|
+    #     MyLogger.log("Used #{method_name} whose argument fell back to a global variable")
+    #   end
+    def self.add(name, &block)
+      @strategies[name] = block
+    end
+
+    # Use the strategy represented by the given name.
+    #
+    #   ::StricterGlobalUsage::Strategy.use(:my_log)
+    def self.use(name)
+      @name = name
+    end
+
+    # Use the strategy represented by the given name for the context of the given block,
+    # then restore the previous strategy.
+    #
+    #   ::StricterGlobalUsage::Strategy.with(:silent) do
+    #     ::SomeVendorLibrary.do_stuff
+    #   end
+    def self.with(name, &block)
+      orig_name = @name
+      begin
+        use(name)
+        yield
+      ensure
+        @name = orig_name
+      end
+    end
+
+    add(:raise) do |method_name|
+      raise ::StricterGlobalUsage::DefaultGlobalVariableUsed.new(method_name)
+    end
+
+    add(:warn) do |method_name|
+      ::Kernel.warn("Called #{method_name} that used a default argument of a global variable")
+    end
+
+    add(:silent) { |_| }
+
+    use(:raise)
+  end
+end

data/lib/stricter_global_usage/version.rb

@@ -0,0 +1,4 @@
+module StricterGlobalUsage
+  # stricter_global_usage version
+  VERSION = "1.0"
+end

data/lib/stricter_global_usage.rb

@@ -0,0 +1,5 @@
+require 'stricter_global_usage/version'
+require 'stricter_global_usage/default_global_variable_used'
+require 'stricter_global_usage/core_ext/array'
+require 'stricter_global_usage/core_ext/string'
+require 'stricter_global_usage/strategy'

data/spec/core_ext/array_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'stricter_global_usage/core_ext/array' do
+  describe '#join' do
+    it 'applies the strategy when called without an argument' do
+      StricterGlobalUsage::Strategy.should_receive(:apply).once.with('Array#join')
+      %w(foo bar).join
+    end
+
+    it 'works like the example in the Ruby docs' do
+      StricterGlobalUsage::Strategy.should_receive(:apply).exactly(0).times
+      [ "a", "b", "c" ].join(nil).should == "abc"
+      [ "a", "b", "c" ].join("-").should == "a-b-c"
+    end
+  end
+end

data/spec/core_ext/string_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'stricter_global_usage/core_ext/string' do
+  describe '#split' do
+    it 'applies the strategy when called without an argument' do
+      StricterGlobalUsage::Strategy.should_receive(:apply).once.with('String#split')
+      '1,2,3,4,5'.split
+    end
+
+    it 'works like the example in the Ruby docs' do
+      StricterGlobalUsage::Strategy.should_receive(:apply).exactly(0).times
+      " now's  the time".split(nil).should == ["now's", "the", "time"]
+      " now's  the time".split(' ').should == ["now's", "the", "time"]
+      "1, 2.34,56, 7".split(%r{,\s*}).should == ["1", "2.34", "56", "7"]
+      "hello".split(%r//).should == ["h", "e", "l", "l", "o"]
+      "hello".split(%r//, 3).should == ["h", "e", "llo"]
+      "hi mom".split(%r{\s*}).should == ["h", "i", "m", "o", "m"]
+
+      "mellow yellow".split("ello").should == ["m", "w y", "w"]
+      "1,2,,3,4,,".split(',').should == ["1", "2", "", "3", "4"]
+      "1,2,,3,4,,".split(',', 4).should == ["1", "2", "", "3,4,,"]
+      "1,2,,3,4,,".split(',', -4).should == ["1", "2", "", "3", "4", "", ""]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'stricter_global_usage'
+
+include StricterGlobalUsage
+
+RSpec.configure do |config|
+  config.before do
+    ::StricterGlobalUsage::Strategy.use(:raise)
+  end
+end

data/spec/strategy_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe StricterGlobalUsage::Strategy do
+  describe '.use' do
+    it 'raises an exception with :raise' do
+      ::StricterGlobalUsage::Strategy.use(:raise)
+      expect { ::StricterGlobalUsage::Strategy.apply('Foo#bar') }.to raise_error(::StricterGlobalUsage::DefaultGlobalVariableUsed)
+    end
+
+    it 'warns with :warn' do
+      ::StricterGlobalUsage::Strategy.use(:warn)
+      Kernel.should_receive(:warn).once
+      ::StricterGlobalUsage::Strategy.apply('Foo#bar')
+    end
+  end
+
+  describe '.with' do
+    it 'temporarily does `use` and then reverts to the old value' do
+      ::StricterGlobalUsage::Strategy.use(:raise)
+      ::StricterGlobalUsage::Strategy.with(:silent) do
+        expect { ::StricterGlobalUsage::Strategy.apply('Foo#bar') }.not_to raise_error
+      end
+
+      expect { ::StricterGlobalUsage::Strategy.apply('Foo#bar') }.to raise_error(::StricterGlobalUsage::DefaultGlobalVariableUsed)
+    end
+  end
+end

data/spec/stricter_global_usage_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'stricter_global_usage'
+
+describe StricterGlobalUsage do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/stricter_global_usage.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/stricter_global_usage/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "stricter_global_usage"
+  gem.version       = StricterGlobalUsage::VERSION
+  gem.summary       = %q{Raises exceptions or runtime warnings when calling methods whose arguments default to global variables.}
+  gem.description   = %q{Raises exceptions or runtime warnings when calling methods whose arguments default to global variables.}
+  gem.license       = "MIT"
+  gem.authors       = ["Mark Rushakoff"]
+  gem.email         = "mark.rushakoff@gmail.com"
+  gem.homepage      = "https://github.com/mark-rushakoff/stricter_global_usage#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: stricter_global_usage
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Mark Rushakoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Raises exceptions or runtime warnings when calling methods whose arguments
+  default to global variables.
+email: mark.rushakoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/stricter_global_usage.rb
+- lib/stricter_global_usage/core_ext/array.rb
+- lib/stricter_global_usage/core_ext/string.rb
+- lib/stricter_global_usage/default_global_variable_used.rb
+- lib/stricter_global_usage/strategy.rb
+- lib/stricter_global_usage/version.rb
+- spec/core_ext/array_spec.rb
+- spec/core_ext/string_spec.rb
+- spec/spec_helper.rb
+- spec/strategy_spec.rb
+- spec/stricter_global_usage_spec.rb
+- stricter_global_usage.gemspec
+homepage: https://github.com/mark-rushakoff/stricter_global_usage#readme
+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'
+      segments:
+      - 0
+      hash: -224249549
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -224249549
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Raises exceptions or runtime warnings when calling methods whose arguments
+  default to global variables.
+test_files:
+- spec/core_ext/array_spec.rb
+- spec/core_ext/string_spec.rb
+- spec/spec_helper.rb
+- spec/strategy_spec.rb
+- spec/stricter_global_usage_spec.rb