questionable 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lee Jarvis
+
+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,51 @@
+Questionable
+============
+
+Installation
+------------
+
+### RubyGems
+
+    gem install questionable
+
+### GitHub
+
+    git clone git://github.com/injekt/questionable.git
+    gem build questionable.gemspec
+    gem install questionable-<version>.gem
+
+Usage
+-----
+
+    class Person
+      include Questionable
+
+      questionable :name, :age
+      questionable :has_password? => :password
+
+      questionable :friends_with_robert? => :friends do |friends|
+        friends.include? 'Robert'
+      end
+
+      questionable :has_friend? => :friends do |friends, friend|
+        friends.include? friend
+      end
+
+      def initialize(name, age, password=nil)
+        @name = name
+        @age = age
+        @password = password
+        @friends = ['Phil', 'Robert']
+      end
+    end
+
+    roy = Person.new 'Roy', 36, 'Sekret!!'
+    roy.name? #=> true
+    roy.has_password? #=> true
+    roy.friends_with_robert? #=> true
+
+    dave = Person.new 'Dave', 42
+    dave.age? #=> true
+    dave.has_password? #=> false
+    dave.has_friend? 'Steve' #=> false
+

data/Rakefile

@@ -0,0 +1,6 @@
+task :test do
+  $:.unshift './test'
+  Dir.glob("test/*_test.rb").each { |test| require "./#{test}" }
+end
+
+task :default => :test

data/lib/questionable.rb

@@ -0,0 +1,84 @@
+module Questionable
+  VERSION = '0.1.0'
+
+  # Extend `klass` with Questionable. This means nothing more than
+  # a user can use both `include` and `extend`
+  #
+  # @param [Class] klass
+  def self.included(klass)
+    klass.extend self
+  end
+
+  # Add questionable items
+  #
+  # @example
+  #   class Person
+  #     include Questionable
+  #
+  #     questionable :name, :age
+  #     questionable :has_password? => :password
+  #
+  #     questionable :friends_with_robert? => :friends do |friends|
+  #       friends.include? 'Robert'
+  #     end
+  #
+  #     questionable :has_friend? => :friends do |friends, friend|
+  #       friends.include? friend
+  #     end
+  #
+  #     def initialize(name, age, password=nil)
+  #       @name = name
+  #       @age = age
+  #       @password = password
+  #       @friends = ['Phil', 'Robert']
+  #     end
+  #   end
+  #
+  #   roy = Person.new 'Roy', 36, 'Sekret!!'
+  #   roy.name? #=> true
+  #   roy.has_password? #=> true
+  #   roy.friends_with_robert? #=> true
+  #
+  #   dave = Person.new 'Dave', 42
+  #   dave.age? #=> true
+  #   dave.has_password? #=> false
+  #   dave.has_friend? 'Steve' #=> false
+  def questionable(*items, &block)
+    if items.first.respond_to? :keys
+      __create_questionable_method *items[0].shift, &block
+    else
+      if items.size == 1
+        __create_questionable_method items.shift, &block
+      else
+        items.each { |i| __create_questionable_method i, &block }
+      end
+    end
+  end
+
+  private
+
+  def __create_questionable_method(to, from=nil, &block)
+    from ||= to
+    meth_name = to.to_s.chomp('?').insert(-1, '?').to_sym
+    ivar = from.to_s.sub(/\A@/, '').insert(0, '@').chomp('?')
+
+    if block_given?
+      define_method(meth_name) do |*a|
+        if instance_variable_defined? ivar
+          yield instance_variable_get(ivar), *a
+        else
+          raise RuntimeError, "Instance variable #{ivar} is undefined"
+        end
+      end
+    else
+      define_method(meth_name) do
+        if instance_variable_defined? ivar
+          !!instance_variable_get(ivar)
+        else
+          raise RuntimeError, "Instance variable #{ivar} is undefined"
+        end
+      end
+    end
+  end
+
+end

data/questionable.gemspec

@@ -0,0 +1,14 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'questionable'
+
+Gem::Specification.new do |s|
+  s.name        = 'questionable'
+  s.version     = Questionable::VERSION
+  s.author      = 'Lee Jarvis'
+  s.email       = 'lee@jarvis.co'
+  s.homepage    = 'http://github.com/injekt/questionable'
+  s.summary     = 'Question your objects!'
+  s.description = 'Easily add method helpers for testing instance variables'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+unless Object.const_defined? 'Questionable'
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  require 'questionable'
+end
+
+require 'minitest/autorun'
+
+begin
+  require 'turn'
+rescue LoadError
+end
+
+class TestCase < MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end

data/test/questionable_test.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+class Klass
+  extend Questionable
+
+  questionable :foo, :bar, :missing
+  questionable :has_password => :password
+  questionable :has_missing? => :missing
+
+  questionable :has_ralf? do |i|
+    i.include? 'Ralf'
+  end
+
+  questionable :has_person? => :people do |v, person|
+    v.include? person
+  end
+
+  def initialize
+    @foo, @bar = true, false
+    @password = "sekret"
+    @has_ralf = ['Ralf']
+    @people = ['Lee', 'Rob']
+  end
+end
+
+class QuestionableTest < TestCase
+  def setup
+    @klass = Klass.new
+  end
+
+  test 'questioning multiple vars' do
+    assert @klass.foo?
+    refute @klass.bar?
+    assert_raises(RuntimeError, /@missing/) { @klass.missing? }
+  end
+
+  test 'alias/hash syntax' do
+    assert @klass.has_password?
+    assert_raises(RuntimeError, /@missing/) { @klass.has_missing? }
+  end
+
+  test 'blocks' do
+    assert @klass.has_ralf?
+    assert @klass.has_person? 'Lee'
+    refute @klass.has_person? 'Ralf'
+  end
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: questionable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Lee Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 Z
+dependencies: []
+
+description: Easily add method helpers for testing instance variables
+email: lee@jarvis.co
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/questionable.rb
+- questionable.gemspec
+- test/helper.rb
+- test/questionable_test.rb
+homepage: http://github.com/injekt/questionable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Question your objects!
+test_files: 
+- test/helper.rb
+- test/questionable_test.rb