naught 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590655f0e3a1d6ace3edabc144bab9b497512816
-  data.tar.gz: 88d5907481c580e2a725f1078ac84029579a1b8e
+  metadata.gz: 890ad068bee3a49dddd992e4c9b5187d4b8c7f2e
+  data.tar.gz: f2349e58df72fd26f6e00f0d0b70f98e77439cdd
 SHA512:
-  metadata.gz: fb7129d4cef2b7aa3440033c81abf745c094316e44b0ddee3642b73c6208f2f2411d29cce030ba183baa676001204048dcc9510347bfff7aa4c28e4c77dadca5
-  data.tar.gz: 0552239f6f101b7d21e4c227e34bc4feb17c510c8b57693342934064037de01f6a4c7bfe48eb9eaa9875a8f4ac00fea2caa1a73c0c0788441b416130110057da
+  metadata.gz: 1ff56002a0c9051c16852efe538d1799a14eb7480154515e8a907408e380b1717a8fe393b8936f775f1053684e32c41641a075461f09a48f8ef68e3c5e573c06
+  data.tar.gz: 4eb1d18c75d4ac998207152005bd20807a15bd68f24b83213b4842ab5185d4c023fd9e09c441c2a148c5274b000a7b194c383337ce68b2583bca2307f50ae0a5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'naught.gemspec'
+
+# Avoid long parameter lists
+ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+ClassLength:
+  Max: 144 # TODO: Lower to 100
+
+MethodLength:
+  CountComments: false
+  Max: 21  # TODO: Lower to 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 2
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+Lambda:
+  Enabled: false
+
+MethodName:
+  Enabled: false
+
+ClassVars:
+  Enabled: false

data/.travis.yml

@@ -1,2 +1,20 @@
-env:
-  - TRAVIS=true
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+  - jruby-head
+  - rbx
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true

data/Changelog.md

@@ -1,6 +1,12 @@
+## 1.0.0
+
+  - [Replace `::BasicObject` with `Naught::BasicObject`](https://github.com/avdi/naught/commit/8defad0bf9eb65e33054bf0a6e9c625c87c3e6df)
+  - [Delegate explicit conversions to nil instead of defining them explicitly](https://github.com/avdi/naught/commit/85c195de80ed56993b88f47e09112c903a92a167)
+  - Add support for (and run tests on) Ruby 1.8, 1.9, 2.0, 2.1, JRuby, and Rubinius
+
 ## 0.0.3
 
 Features:
 
-  - New "pebble" mode
-      
+  - New "pebble" mode (Guilherme Carvalho)
+

data/Gemfile

@@ -3,7 +3,29 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in naught.gemspec
 gemspec
 
+gem 'rake'
+
+group :development do
+  platforms :ruby_19, :ruby_20, :ruby_21 do
+    gem 'guard'
+    gem 'guard-bundler'
+    gem 'guard-rspec'
+  end
+  gem 'pry'
+  gem 'pry-rescue'
+end
+
 group :test do
-  gem "libnotify"
-  gem 'coveralls', require: false
+  gem 'coveralls', :require => false
+  gem 'json', :platforms => [:jruby, :rbx, :ruby_18, :ruby_19]
+  gem 'libnotify'
+  gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+  gem 'rspec', '>= 2.14'
+  gem 'rubocop', '>= 0.16', :platforms => [:ruby_19, :ruby_20, :ruby_21]
+end
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubinius-coverage', '~> 2.0'
+  gem 'rubysl', '~> 2.0'
 end

data/README.markdown

@@ -107,7 +107,7 @@ null.foo.bar.baz                   # => <null>
 null << "hello" << "world"         # => <null>
 ```
 
-### What's that "config" thing?
+#### What's that "config" thing?
 
 That's what you use to customize the generated class to your
 liking. Internally, Naught uses the [Builder
@@ -176,8 +176,8 @@ null_io = NullIO.new
 
 null_io << "foo"                # => nil
 null_io.readline                # => nil
-null_io.foobar                  # => 
-# ~> -:11:in `<main>': undefined method `foobar' for 
+null_io.foobar                  # =>
+# ~> -:11:in `<main>': undefined method `foobar' for
 #  <null:IO>:NullIO (NoMethodError)
 ```
 
@@ -205,6 +205,23 @@ end
 # >> Yep, checks out!
 ```
 
+#### What about predicate methods? You know, the ones that end with question marks? Shouldn't they return `false` instead of `nil`?
+
+Sure, if you'd like.
+
+```ruby
+require 'naught'
+
+NullObject = Naught.build do |config|
+  config.predicates_return false
+end
+
+null = NullObject.new
+null.foo                        # => nil
+null.bar?                       # => false
+null.nil?                       # => false
+```
+
 #### Alright smartypants. What if I want to add my own methods?
 
 Not a problem, just define them in the `.build` block.
@@ -214,6 +231,7 @@ require 'naught'
 
 NullObject = Naught.build do |config|
   config.define_explicit_conversions
+  config.predicates_return false
   def to_path
     "/dev/null"
   end
@@ -222,11 +240,16 @@ NullObject = Naught.build do |config|
   def to_s
     "NOTHING TO SEE HERE MOVE ALONG"
   end
+
+  def nil?
+    true
+  end
 end
 
 null = NullObject.new
-null.to_s                       # => "NOTHING TO SEE HERE MOVE ALONG"
 null.to_path                    # => "/dev/null"
+null.to_s                       # => "NOTHING TO SEE HERE MOVE ALONG"
+null.nil?                       # => true
 ```
 
 #### Got anything else up your sleeve?
@@ -245,8 +268,8 @@ null = NullObject.instance
 
 null.__id__                     # => 17844080
 NullObject.instance.__id__      # => 17844080
-NullObject.new                  # => 
-# ~> -:11:in `<main>': private method `new' called for 
+NullObject.new                  # =>
+# ~> -:11:in `<main>': private method `new' called for
 #  NullObject:Class (NoMethodError)
 ```
 
@@ -280,7 +303,7 @@ NullObject = Naught.build do |config|
   else
     config.singleton
   end
-end  
+end
 ```
 
 The only caveat is that when swapping between singleton and

data/Rakefile

@@ -1,6 +1,15 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+begin
+  require 'rubocop/rake_task'
+  Rubocop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled'
+  end
+end
+
+task :default => [:spec, :rubocop]

data/lib/naught.rb

@@ -1,4 +1,4 @@
-require "naught/version"
+require 'naught/version'
 require 'naught/null_class_builder'
 require 'naught/null_class_builder/commands'
 

data/lib/naught/basic_object.rb

@@ -0,0 +1,17 @@
+module Naught
+  if defined? ::BasicObject
+    class BasicObject < ::BasicObject
+    end
+  else
+    class BasicObject #:nodoc:
+      keep = %w[
+        ! != == __id__ __send__ equal? instance_eval instance_exec
+        method_missing singleton_method_added singleton_method_removed
+        singleton_method_undefined
+      ]
+      instance_methods.each do |method_name|
+        undef_method(method_name) unless keep.include?(method_name)
+      end
+    end
+  end
+end

data/lib/naught/conversions.rb

@@ -0,0 +1,55 @@
+module Naught
+  module Conversions
+    def self.included(null_class)
+      unless class_variable_defined?(:@@included) && @@included
+        @@null_class = null_class
+        @@null_equivs = null_class::NULL_EQUIVS
+        @@included = true
+      end
+      super
+    end
+
+    def Null(object = :nothing_passed)
+      case object
+      when NullObjectTag
+        object
+      when :nothing_passed, *@@null_equivs
+        @@null_class.get(:caller => caller(1))
+      else
+        fail ArgumentError, "#{object.inspect} is not null!"
+      end
+    end
+
+    def Maybe(object = nil)
+      object = yield if block_given?
+      case object
+      when NullObjectTag
+        object
+      when *@@null_equivs
+        @@null_class.get(:caller => caller(1))
+      else
+        object
+      end
+    end
+
+    def Just(object = nil)
+      object = yield if block_given?
+      case object
+      when NullObjectTag, *@@null_equivs
+        fail ArgumentError, "Null value: #{object.inspect}"
+      else
+        object
+      end
+    end
+
+    def Actual(object = nil)
+      object = yield if block_given?
+      case object
+      when NullObjectTag
+        nil
+      else
+        object
+      end
+    end
+  end
+end

data/lib/naught/null_class_builder.rb

@@ -1,4 +1,5 @@
-require 'naught/null_class_builder/conversions_module'
+require 'naught/basic_object'
+require 'naught/conversions'
 
 module Naught
   class NullClassBuilder
@@ -10,14 +11,14 @@ module Naught
 
     def initialize
       @interface_defined = false
-      @base_class        = BasicObject
-      @inspect_proc      = ->{ "<null>" }
+      @base_class        = Naught::BasicObject
+      @inspect_proc      = lambda { '<null>' }
       @stub_strategy     = :stub_method_returning_nil
       define_basic_methods
     end
 
     def interface_defined?
-      @interface_defined
+      !!@interface_defined
     end
 
     def customize(&customization_block)
@@ -33,10 +34,6 @@ module Naught
       @null_equivalents ||= [nil]
     end
 
-    def generate_conversions_module(null_class)
-      ConversionsModule.new(null_class, null_equivalents)
-    end
-
     def generate_class
       respond_to_any_message unless interface_defined?
       generation_mod    = Module.new
@@ -48,7 +45,13 @@ module Naught
       null_class = Class.new(@base_class) do
         const_set :GeneratedMethods, generation_mod
         const_set :Customizations, customization_mod
-        const_set :Conversions, builder.generate_conversions_module(self)
+        const_set :NULL_EQUIVS, builder.null_equivalents
+        include Conversions
+        remove_const :NULL_EQUIVS
+        Conversions.instance_methods.each do |instance_method|
+          undef_method(instance_method)
+        end
+        const_set :Conversions, Conversions
 
         include NullObjectTag
         include generation_mod
@@ -70,11 +73,20 @@ module Naught
       end
     end
 
-    def respond_to_missing?(method_name, include_private=false)
-      command_name = command_name_for_method(method_name)
-      Commands.const_defined?(command_name) || super
-    rescue NameError
-      super
+    if RUBY_VERSION >= '1.9'
+      def respond_to_missing?(method_name, include_private = false)
+        command_name = command_name_for_method(method_name)
+        Commands.const_defined?(command_name) || super
+      rescue NameError
+        super
+      end
+    else
+      def respond_to?(method_name, include_private = false)
+        command_name = command_name_for_method(method_name)
+        Commands.const_defined?(command_name) || super
+      rescue NameError
+        super
+      end
     end
 
     ############################################################################
@@ -88,7 +100,7 @@ module Naught
     end
 
     def respond_to_any_message
-      defer(prepend: true) do |subject|
+      defer(:prepend => true) do |subject|
         subject.module_eval do
           def respond_to?(*)
             true
@@ -99,7 +111,7 @@ module Naught
       @interface_defined = true
     end
 
-    def defer(options={}, &deferred_operation)
+    def defer(options = {}, &deferred_operation)
       list = options[:class] ? class_operations : operations
       if options[:prepend]
         list.unshift(deferred_operation)
@@ -136,10 +148,10 @@ module Naught
     end
 
     def define_basic_class_methods
-      defer(class: true) do |subject|
+      defer(:class => true) do |subject|
         subject.module_eval do
           class << self
-            alias get new
+            alias_method :get, :new
           end
           klass = self
           define_method(:class) { klass }
@@ -157,18 +169,18 @@ module Naught
 
     def stub_method_returning_nil(subject, name)
       subject.module_eval do
-        define_method(name) {|*| nil }
+        define_method(name) { |*| nil }
       end
     end
 
     def stub_method_returning_self(subject, name)
       subject.module_eval do
-        define_method(name) {|*| self }
+        define_method(name) { |*| self }
       end
     end
 
     def command_name_for_method(method_name)
-      method_name.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+      method_name.to_s.gsub(/(?:^|_)([a-z])/) { Regexp.last_match[1].upcase }
     end
   end
 end