question_mark_methods 0.0.1

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/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Roy Young
+
+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,114 @@
+# QuestionMarkMethods
+
+I love the attribute query methods in ActiveRecord, Query methods allow me to us whether an attribute value is present. For example:
+
+```ruby
+user = User.new(:name => "David")
+user.name? # => true
+
+anonymous = User.new(:name => "")
+anonymous.name? # => false
+```
+
+I love the question mark at the end of the method name, because it makes the code more readable. But what should we do if we do not use ActiveRecord? Also you can implement like below:
+
+```ruby
+class User
+  #initialize method...
+
+  def is_admin?
+    @is_admin
+  end
+end
+```
+
+But I am tired of this, all I need it is just adding a question mark at the end of the method name, so I build this gem to reduce that codes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'question_mark_methods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install question_mark_methods
+
+## Usage
+
+First, Include it in your class
+
+```ruby
+require 'QuestionMarkMethods'
+
+class User
+  include QuestionMarkMethods
+end
+```
+
+and then use it just like attribute query methods in ActiveRecord. For example
+
+```ruby
+class User
+  include QuestionMarkMethods
+
+  def initialize(name, is_charged)
+    @name = name
+    @is_charged = is_charged
+  end
+end
+
+user = User.new("alice", true)
+user.is_charged? # => true
+user.name? # => true
+```
+
+**You can also customize your method names**
+
+Add a macros `add_question_mark_methods`:
+
+```ruby
+class User
+  #...
+
+  add_question_mark_methods has_a_name?: :name, has_been_charged?: :is_charged
+
+  #instance methods...
+
+end
+
+user = User.new("alice", true)
+user.has_a_name? # => true
+user.has_been_charged? # => false
+```
+
+**Why don't use alias_method()?**
+
+let's look at how to use alias_method to implement this.
+
+```ruby
+class User
+  attr_reader :is_charged, :name
+
+  alias_method :has_been_charged?, :is_charged
+  alias_method :has_a_name?, :name
+
+  #same initialize...
+end
+
+user = User.new("alice", true)
+user.has_been_charged? # => true
+user.has_a_name? # => "alice"
+```
+
+When we using alias_method to do the same thing, We need to add `attr_reader` first and use `alias_method` twice to define two aliases. Maybe you have noticed the biggest problem, `user.has_a_name?` returns the value of @name, but we need a boolean in this case.
+
+## About
+
+I built this for fun and practicing metaprogramming, after finishing the mid-level course of [Tealeaf Academy](http://gotealeaf.com).
+
+Thanks @knwang!

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/question_mark_method.rb

@@ -0,0 +1,31 @@
+module QuestionMarkMethod
+  def method_missing(method_name)
+    if md = /\?$/.match(method_name.to_s)
+      return_boolean_value_of_attribute_related_with(md.pre_match)
+    else
+      super
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def add_question_mark_methods(options)
+      self.class_eval do
+        options.each do |new_method_name, old_method_name|
+          define_method new_method_name do
+            return_boolean_value_of_attribute_related_with(old_method_name.to_s)
+          end
+        end
+      end
+    end
+  end
+
+  private
+  def return_boolean_value_of_attribute_related_with(method_name)
+    attribute = "@" + method_name
+    !!instance_variable_get(attribute)
+  end
+end

data/lib/question_mark_methods/version.rb

@@ -0,0 +1,3 @@
+module QuestionMarkMethods
+  VERSION = "0.0.1"
+end

data/lib/question_mark_methods.rb

@@ -0,0 +1,4 @@
+require "question_mark_methods/version"
+
+module QuestionMarkMethods
+end

data/question_mark_methods.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'question_mark_methods/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "question_mark_methods"
+  gem.version       = QuestionMarkMethods::VERSION
+  gem.authors       = ["Roy Young"]
+  gem.email         = ["zhuoyuyang@gmail.com"]
+  gem.description   = %q{give boolean attribute a question mark method}
+  gem.summary       = ""
+  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.require_paths = ["lib"]
+end

data/spec/question_mark_method_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe QuestionMarkMethod do
+  let(:alice) { Member.new("alice", true) }
+  let(:bob) { Member.new("bob", false) }
+
+  context "end with a question mark" do
+    it "returns the original method result of false" do
+      bob.charged?.should == false
+    end
+
+    it "returns the original method result of true" do
+      alice.name?.should == true
+    end
+  end
+
+  context "not end with a question mark" do
+    it "raise an NoMethodError" do
+      lambda { alice.is_charged }.should raise_error(NoMethodError)
+    end
+  end
+
+  context "when added macros" do
+    before do
+      Member.class_eval do
+        add_question_mark_methods is_charged?: :charged, has_a_name?: :name
+      end
+    end
+
+    it "returns true when has a name" do
+      alice.has_a_name?.should == true
+    end
+
+    it "returns true when has beed charged" do
+      alice.is_charged?.should == true
+    end
+
+    it "raises a NoMethodError" do
+      lambda {alice.has_been_charged }.should raise_error(NoMethodError)
+    end
+  end
+end
+
+class Member
+  include QuestionMarkMethod
+
+  def initialize(not_a_boolean_value, boolean_value)
+    @name = not_a_boolean_value
+    @charged = boolean_value
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'question_mark_method'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: question_mark_methods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roy Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies: []
+description: give boolean attribute a question mark method
+email:
+- zhuoyuyang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/question_mark_method.rb
+- lib/question_mark_methods.rb
+- lib/question_mark_methods/version.rb
+- question_mark_methods.gemspec
+- spec/question_mark_method_spec.rb
+- spec/spec_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: ''
+test_files:
+- spec/question_mark_method_spec.rb
+- spec/spec_helper.rb