predicates 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in predicates.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+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,55 @@
+# Predicates
+
+Truth accessors for your Ruby classes. Yep, that's about it.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'predicates'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install predicates
+
+## Usage
+
+Include Predicates in your class or model and define the predicate by supplying an attribute:
+
+    class User
+      include Predicates
+
+      attr_accessor :confirmed
+      predicate :confirmed?
+    end
+
+    user = User.new
+    user.confirmed = 1
+    user.confirmed? #=> true
+
+Predicates will define the attribute for you using `attr_accessor` if the attribute you supplied has not been defined yet.
+
+    class User
+      include Predicates
+
+      predicate :confirmed?
+    end
+
+    user = User.new
+    user.confirmed = 1
+    user.confirmed #=> 1
+    user.confirmed? #=> true
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch ( `git checkout -b my-new-feature` )
+3. Create tests and make them pass ( `rake test` )
+4. Commit your changes ( `git commit -am 'Added some feature'` )
+5. Push to the branch ( `git push origin my-new-feature` )
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end
+

data/lib/predicates/version.rb

@@ -0,0 +1,3 @@
+module Predicates
+  VERSION = "0.1.0"
+end

data/lib/predicates.rb

@@ -0,0 +1,51 @@
+require "predicates/version"
+
+module Predicates
+  class NameError < Exception; end
+
+  # Defines a predicate (truth accessor) for a given attribute. If the attribute has not been defined yet,
+  # the attribute will be created along with the predicate via +attr_accessor+.
+  #
+  # == Class Example
+  #
+  #   class User
+  #     include Predicates
+  #
+  #     predicate :confirmed?
+  #   end
+  #
+  #   user = User.new
+  #   user.single = 1
+  #   user.confirmed? #=> true
+  #   user.single = nil
+  #   user.confirmed? #=> false
+  #
+  # == Ohm Model Example
+  #
+  #   class User < Ohm::Model
+  #     include Predicates
+  #
+  #     attribute :confirmed
+  #     predicate :confirmed?
+  #   end
+  #
+  #   user = User.new
+  #   user.confirmed = 1
+  #   user.confirmed? #=> true
+  #   user.confirmed = nil
+  #   user.confirmed? #=> false
+
+  def predicate(method)
+    if method.to_s =~ /(.*?)\?+$/
+      attribute = $1.to_sym
+    else
+      raise NameError
+    end
+
+    attr_accessor attribute unless method_defined? attribute
+
+    define_method method do
+      !!send(attribute)
+    end
+  end
+end

data/predicates.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/predicates/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Erol Fornoles"]
+  gem.email         = ["erol.fornoles@gmail.com"]
+  gem.description   = %q{Truth accessors for Ruby classes.}
+  gem.summary       = %q{Truth accessors for Ruby classes.}
+  gem.homepage      = ""
+
+  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.name          = "predicates"
+  gem.require_paths = ["lib"]
+  gem.version       = Predicates::VERSION
+end

data/test/predicates_test.rb

@@ -0,0 +1,78 @@
+require_relative 'test_helper.rb'
+
+require 'predicates.rb'
+
+class WithPredicates
+  extend Predicates
+end
+
+class PredicatesTest < MiniTest::Unit::TestCase
+  def test_predicate_names_must_contain_a_question_mark
+    assert_raises Predicates::NameError do
+      Class.new WithPredicates do
+        predicate :name
+      end
+    end
+
+    assert_silent do
+      Class.new WithPredicates do
+        predicate :name?
+      end
+    end
+  end
+
+  def test_define_a_predicate_with_an_existing_attribute_accessor
+    klass = Class.new WithPredicates do
+      attr_accessor :attribute
+      predicate :attribute?
+    end
+
+    object = klass.new
+
+    assert object.respond_to?(:attribute?)
+
+    object.attribute = 1
+    assert object.attribute?
+
+    object.attribute = true
+    assert object.attribute?
+
+    object.attribute = nil
+    refute object.attribute?
+  end
+
+  def test_define_a_predicate_with_an_existing_attribute_reader
+    klass = Class.new WithPredicates do
+      attr_reader :attribute
+      predicate :attribute?
+
+      def initialize
+        @attribute = 1
+      end
+    end
+
+    object = klass.new
+
+    assert object.respond_to?(:attribute?)
+    refute object.respond_to?(:attribute=)
+
+    assert object.attribute?
+  end
+
+  def test_define_a_predicate_with_an_existing_attribute_method
+    klass = Class.new WithPredicates do
+      def attribute
+        1
+      end
+
+      predicate :attribute?
+    end
+
+    object = klass.new
+
+    assert object.respond_to?(:attribute?)
+    refute object.respond_to?(:attribute=)
+
+    assert object.attribute?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: predicates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Erol Fornoles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies: []
+description: Truth accessors for Ruby classes.
+email:
+- erol.fornoles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/predicates.rb
+- lib/predicates/version.rb
+- predicates.gemspec
+- test/predicates_test.rb
+- test/test_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Truth accessors for Ruby classes.
+test_files:
+- test/predicates_test.rb
+- test/test_helper.rb