rubykeyword 0.0.2 → 0.0.3

data/lib/rubykeyword.rb

@@ -1,63 +1,38 @@
+require 'yaml'
+
 class String
 
-  #Reference : http://ruby-doc.org/docs/keywords/1.9/
-  KEYWORDS = {
-    "BEGIN" => "Designates, via code block, code to be executed unconditionally before sequential execution of the program begins. Sometimes used to simulate forward references to methods.",
-    "END" => "Designates, via code block, code to be executed just prior to program termination.",
-    "__ENCODING__" => "The current default encoding, as an Encoding instance.",
-    "__END__" => "Denotes the end of the regular source code section of a program file. Lines below __END__ will not be executed. Those lines will be available via the special filehandle DATA. The following code will print out two stanzas of personal information. Note that __END__ has to be flush left, and has to be the only thing on its line.",
-    "__FILE__" => "The name of the file currently being executed, including path relative to the directory where the application was started up (or the current directory, if it has been changed). The current file is, in some cases, different from the startup file for the running application, which is available in the global variable",
-    "__LINE__" => "The line number, in the current source file, of the current line.",
-    "alias" => "Creates an alias or duplicate method name for a given method. The original method continues to be accessible via the alias, even if it is overriden. Takes two method-name arguments (which can be represented by strings or symbols but can also be the bare names themselves).",
-    "and" => "Boolean and operator. Differs from && in that and has lower precedence.",
-    "begin" => "Together with end, delimits what is commonly called a “begin” block (to distinguish it from the Proc type of code block). A “begin” block allows the use of while and until in modifier position with multi-line statements",
-    "break" => "Causes unconditional termination of a code block or while or until block, with control transfered to the line after the block. If given an argument, returns that argument as the value of the terminated block.",
-    "case" => "The case statement operator. Case statements consist of an optional condition, which is in the position of an argument to case, and zero or more when clauses. The first when clause to match the condition (or to evaluate to Boolean truth, if the condition is null) “wins”, and its code stanza is executed. The value of the case statement is the value of the successful when clause, or nil if there is no such clause.",
-    "class" => "Opens a class definition block. Takes either a constant name or an expression of the form << object. In the latter case, opens a definition block for the singleton class of object.",
-    "def" => "Paired with a terminating end, constitutes a method definition. Starts a new local scope; local variables in existence when the def block is entered are not in scope in the block, and local variables created in the block do not survive beyond the block.",
-    "defined?" => "defined? expression tests whether or not expression refers to anything recognizable (literal object, local variable that has been initialized, method name visible from the current scope, etc.). The return value is nil if the expression cannot be resolved. Otherwise, the return value provides information about the expression.",
-    "do" => "Paired with end, can delimit a code block",
-    "else" => "The else keyword denotes a final conditional branch. It appears in connection with if, unless, and case, and rescue. (In the case of rescue, the else branch is executed if no exception is raised.) The else clause is always the last branch in the entire statement, except in the case of rescue where it can be followed by an ensure clause.",
-    "elsif" => "Introduces a branch in a conditional (if or unless) statement. Such a statement can contain any number of elsif branches, including zero.",
-    "end" => "Marks the end of a while, until, begin, if, def, class, or other keyword-based, block-based construct.",
-    "ensure" => "Marks the final, optional clause of a begin/end block, generally in cases where the block also contains a rescue clause. The code in the ensure clause is guaranteed to be executed, whether control flows to the rescue block or not.",
-    "false" => "false denotes a special object, the sole instance of FalseClass. false and nil are the only objects that evaluate to Boolean falsehood in Ruby (informally, that cause an if condition to fail.)",
-    "for" => "A loop constructor, used with in:",
-    "if" => "Ruby’s basic conditional statement constructor. if evaluates its argument and branches on the result. Additional branches can be added to an if statement with else and elsif.",
-    "in" => "See for.",
-    "module" => "Opens a module definition block. Takes a constant (the name of the module) as its argument. The definition block starts a new local scope; existing variables are not visible inside the block, and local variables created in the block do not survive the end of the block.",
-    "next" => "Bumps an iterator, or a while or until block,to the next iteration, unconditionally and without executing whatever may remain of the block.",
-    "nil" => "A special “non-object”. nil is, in fact, an object (the sole instance of NilClass), but connotes absence and indeterminacy. nil and false are the only two objects in Ruby that have Boolean falsehood (informally, that cause an if condition to fail).",
-    "not" => "Boolean negation.",
-    "or" => "Boolean or. Differs from || in that or has lower precedence.",
-    "redo" => "Causes unconditional re-execution of a code block, with the same parameter bindings as the current execution.",
-    "rescue" => "Designates an exception-handling clause. Can occur either inside a begin<code>/<code>end block, inside a method definition (which implies begin), or in modifier position (at the end of a statement).",
-    "retry" => "Inside a rescue clause, retry causes Ruby to return to the top of the enclosing code (the begin keyword, or top of method or block) and try executing the code again.",
-    "return" => "Inside a method definition, executes the ensure clause, if present, and then returns control to the context of the method call. Takes an optional argument (defaulting to nil), which serves as the return value of the method. Multiple values in argument position will be returned in an array.",
-    "self" => "self is the current object and the default receiver of messages (method calls) for which no explicit receiver is specified. Which object plays the role of self depends on the context.",
-    "super" => "Called from a method, searches along the method lookup path (the classes and modules available to the current object) for the next method of the same name as the one being executed. Such method, if present, may be defined in the superclass of the object’s class, but may also be defined in the superclass’s superclass or any class on the upward path, as well as any module mixed in to any of those classes.",
-    "then" => "Optional component of conditional statements (if, unless, when). Never mandatory, but allows for one-line conditionals without semi-colons.",
-    "true" => "The sole instance of the special class TrueClass. true encapsulates Boolean truth; however, <emph>all</emph> objects in Ruby are true in the Boolean sense (informally, they cause an if test to succeed), with the exceptions of false and nil.",
-    "undef" => "Undefines a given method, for the class or module in which it’s called. If the method is defined higher up in the lookup path (such as by a superclass), it can still be called by instances classes higher up.",
-    "unless" => "The negative equivalent of if.",
-    "until" => "The inverse of while : executes code until a given condition is true, i.e., while it is not true. The semantics are the same as those of while; see while.",
-    "when" => "See case.",
-    "while" => "while takes a condition argument, and executes the code that follows (up to a matching end delimiter) while the condition is true.",
-    "yield" => "Called from inside a method body, yields control to the code block (if any) supplied as part of the method call. If no code block has been supplied, calling yield raises an exception.",
-    }
+  def set_keywords
+    @keywords = YAML::load( File.open( "#{File.expand_path File.dirname(__FILE__)}/settings.yaml" ) )
+  end
 
-  def keyword
-    return true if KEYWORDS.keys.include? self
-    return false
+  def keyword?
+    set_keywords
+    return (@keywords.keys.include? self)
   end
 
   def define
-    if keyword
-      return KEYWORDS[self]
+    set_keywords
+    return keyword? ? @keywords[self]['definition'] : false
+  end
+
+
+  def example_string
+    set_keywords
+    if keyword?
+      return @keywords[self].has_key?('example') ? @keywords[self]['example'].join("\n") : "No example"
+    else
+      return false
+    end
+  end
+  
+  def example
+    set_keywords
+    if keyword?
+      puts @keywords[self].has_key?('example') ? @keywords[self]['example'].join("\n") : "No example"
     else
       return false
     end
   end
 
 end
-

data/lib/settings.yaml

@@ -0,0 +1,350 @@
+#Reference : http://ruby-doc.org/docs/keywords/1.9/
+
+"BEGIN":
+    definition: "Designates, via code block, code to be executed unconditionally before sequential execution of the program begins. Sometimes used to simulate forward references to methods."
+    example:
+        - "puts times_3(gets.to_i)"
+        - "BEGIN {"
+        - "  def times_3(n)"
+        - "    n * 3"
+        - "  end"
+        - "}"
+
+"END":
+    definition: "Designates, via code block, code to be executed just prior to program termination."
+    example:
+        - " DATA.each do |line|"
+        - "   first, last, phone, email = line.split('|')"
+        - "  puts <<-EOM"
+        - "  First name: #{first}"
+        - "  Last name:  #{last}"
+        - "  Phone:      #{phone}"
+        - "  Email:      #{email}"
+        - "     EOM"
+        - "  end"
+        - "__END__"
+        - " "
+        - "David|Black|123-456-7890|dblack@..."
+        - "Someone|Else|321-888-8888|someone@else"
+
+"__ENCODING__":
+    definition: "The current default encoding, as an Encoding instance."
+
+
+"__END__":
+    definition: "Denotes the end of the regular source code section of a program file. Lines below __END__ will not be executed. Those lines will be available via the special filehandle DATA. The following code will print out two stanzas of personal information. Note that __END__ has to be flush left, and has to be the only thing on its line."
+
+"__FILE__":
+    definition: "The name of the file currently being executed, including path relative to the directory where the application was started up (or the current directory, if it has been changed). The current file is, in some cases, different from the startup file for the running application, which is available in the global variable"
+    
+"__LINE__":
+    definition: "The line number, in the current source file, of the current line."
+    
+"alias":
+    definition: "Creates an alias or duplicate method name for a given method. The original method continues to be accessible via the alias, even if it is overriden. Takes two method-name arguments (which can be represented by strings or symbols but can also be the bare names themselves)."
+    example:
+    - "class Person"
+    - "  def name=(name)"
+    - "    puts 'Naming your person #{name}!'"
+    - "    @name = name"
+    - "  end"
+    - " "
+    - "  alias full_name= name="
+    - "end"
+    - " "
+    - "p = Person.new"
+    - "p.name = 'David'        # Naming your person David!"
+    - " "
+    - "class Person"
+    - "  def name=(name)"
+    - "    puts 'Please use full_name='"
+    - "  end"
+    - "end"
+    - " "
+    - "p.name = 'Joe'          # Please use full_name="
+    - "p.full_name = 'Joe'     # Naming your person Joe!"
+    
+"and":
+    definition: "Boolean and operator. Differs from && in that and has lower precedence."
+    example:
+        - "if a == 1 and b == 2"
+        - "  puts 'foo'"
+        - "end"
+    
+"begin":
+    definition: "Together with end, delimits what is commonly called a “begin” block (to distinguish it from the Proc type of code block). A “begin” block allows the use of while and until in modifier position with multi-line statements"
+    example:
+        - "begin"
+        - "  i += 1"
+        - "  puts i"
+        - "end until i == 10"
+    
+"break":
+    definition: "Causes unconditional termination of a code block or while or until block, with control transfered to the line after the block. If given an argument, returns that argument as the value of the terminated block."
+    example:
+        - "result = File.open('lines.txt') do |fh|"
+        - "  fh.each do |line|"
+        - "    break line if my_regex.match(line)"
+        - "  end"
+        - "  nil"
+        - "end"
+
+"case":
+    definition: "The case statement operator. Case statements consist of an optional condition, which is in the position of an argument to case, and zero or more when clauses. The first when clause to match the condition (or to evaluate to Boolean truth, if the condition is null) “wins”, and its code stanza is executed. The value of the case statement is the value of the successful when clause, or nil if there is no such clause."
+    example:
+        - "case x"
+        - "when 1,2,3"
+        - "  puts '1, 2, or 3'"
+        - "when 10"
+        - "  puts '10'"
+        - "else"
+        - "  puts 'Some other number'"
+        - "end"
+    
+"class":
+    definition: "Opens a class definition block. Takes either a constant name or an expression of the form << object. In the latter case, opens a definition block for the singleton class of object."
+    example:
+        - "class Person"
+        - "  def self.species"
+        - "    'Homo sapiens'"
+        - "  end"
+        - "end"
+    
+"def":
+    definition: "Paired with a terminating end, constitutes a method definition. Starts a new local scope; local variables in existence when the def block is entered are not in scope in the block, and local variables created in the block do not survive beyond the block."
+    example:
+        - "def method_name(parameter1)"
+        - "  return 'This is your parameter #{parameter1}'"
+        - "end"
+    
+"defined?":
+    definition: "defined? expression tests whether or not expression refers to anything recognizable (literal object, local variable that has been initialized, method name visible from the current scope, etc.). The return value is nil if the expression cannot be resolved. Otherwise, the return value provides information about the expression."
+    example:
+        - "def x; end"
+        - "p defined?(x)  # 'method'"
+    
+"do":
+    definition: "Paired with end, can delimit a code block"
+    example:
+        - "array.each do |element|"
+        - "  puts element * 10"
+        - "end"
+    
+"else":
+    definition: "The else keyword denotes a final conditional branch. It appears in connection with if, unless, and case, and rescue. (In the case of rescue, the else branch is executed if no exception is raised.) The else clause is always the last branch in the entire statement, except in the case of rescue where it can be followed by an ensure clause."
+    example:
+        - "if x == 0"
+        - "  puts 'Zero'"
+        - "elif x == 1"
+        - "  puts 'One'"
+        - "else"
+        - "  puts 'Not Zero or One'"
+        - "end"
+    
+"elsif":
+    definition: "Introduces a branch in a conditional (if or unless) statement. Such a statement can contain any number of elsif branches, including zero."
+    example:
+        - "if x == 0"
+        - "  puts 'Zero'"
+        - "elif x == 1"
+        - "  puts 'One'"
+        - "else"
+        - "  puts 'Not Zero or One'"
+        - "end"
+    
+"end":
+    definition: "Marks the end of a while, until, begin, if, def, class, or other keyword-based, block-based construct."
+    example:
+        - "[1,2,3].each do |i|"
+        - "  puts i"
+        - "end"
+    
+"ensure":
+    definition: "Marks the final, optional clause of a begin/end block, generally in cases where the block also contains a rescue clause. The code in the ensure clause is guaranteed to be executed, whether control flows to the rescue block or not."
+    example:
+        - "begin"
+        - "  1/0"
+        - "rescue ZeroDivisionError"
+        - "  puts 'Can't do that!'"
+        - "ensure"
+        - "  puts 'That was fun!'"
+        - "end"
+
+"false":
+    definition: "false denotes a special object, the sole instance of FalseClass. false and nil are the only objects that evaluate to Boolean falsehood in Ruby (informally, that cause an if condition to fail.)"
+    
+"for":
+    definition: "A loop constructor, used with in:"
+    example:
+        - "for a in [1,2,3,4,5] do"
+        - "  puts a * 10"
+        - "end"
+    
+"if":
+    definition: "Ruby’s basic conditional statement constructor. if evaluates its argument and branches on the result. Additional branches can be added to an if statement with else and elsif."
+    example:
+        - "if x == 0"
+        - "  puts 'Zero'"
+        - "elif x == 1"
+        - "  puts 'One'"
+        - "else"
+        - "  puts 'Not Zero or One'"
+        - "end"
+    
+"in":
+    definition: "See for."
+    example:
+        - "for a in [1,2,3,4,5] do"
+        - "  puts a * 10"
+        - "end"
+    
+"module":
+    definition: "Opens a module definition block. Takes a constant (the name of the module) as its argument. The definition block starts a new local scope; existing variables are not visible inside the block, and local variables created in the block do not survive the end of the block."
+    
+"next":
+    definition: "Bumps an iterator, or a while or until block,to the next iteration, unconditionally and without executing whatever may remain of the block."
+    example:
+        - "[0,1,2,3,4].each do |n|"
+        - "  next unless n > 2"
+        - "  puts n"
+        - "end"
+    
+"nil":
+    definition: "A special “non-object”. nil is, in fact, an object (the sole instance of NilClass), but connotes absence and indeterminacy. nil and false are the only two objects in Ruby that have Boolean falsehood (informally, that cause an if condition to fail)."
+    
+"not":
+    definition: "Boolean negation."
+    example:
+        - "not true    # false"
+        - "not 10      # false"
+        - "not false   # true"
+    
+"or":
+    definition: "Boolean or. Differs from || in that or has lower precedence."
+    example:
+        - "if a == 0 or a == 1"
+        - "  puts a"
+        - "end"
+    
+"redo":
+    definition: "Causes unconditional re-execution of a code block, with the same parameter bindings as the current execution."
+    
+"rescue":
+    definition: "Designates an exception-handling clause. Can occur either inside a begin<code>/<code>end block, inside a method definition (which implies begin), or in modifier position (at the end of a statement)."
+    example:
+        - "begin"
+        - "  1/0"
+        - "rescue ZeroDivisionError"
+        - "  puts 'Can't do that!'"
+        - "end"
+        
+"retry":
+    definition: "Inside a rescue clause, retry causes Ruby to return to the top of the enclosing code (the begin keyword, or top of method or block) and try executing the code again."
+    example:
+        - "a = 0"
+        - "begin"
+        - "  1/a"
+        - "rescue ZeroDivisionError => e"
+        - "  puts e.message"
+        - "  puts 'Let's try that again...'"
+        - "  a = 1"
+        - "  retry"
+        - "end"
+        - "puts 'That's better!'"
+    
+"return":
+    definition: "Inside a method definition, executes the ensure clause, if present, and then returns control to the context of the method call. Takes an optional argument (defaulting to nil), which serves as the return value of the method. Multiple values in argument position will be returned in an array."
+    example:
+        - "def three"
+        - "  return 3"
+        - "end"
+        - " "
+        - "a = three"
+        - "puts a   # 3"
+    
+"self":
+    definition: "self is the current object and the default receiver of messages (method calls) for which no explicit receiver is specified. Which object plays the role of self depends on the context."
+    
+"super":
+    definition: "Called from a method, searches along the method lookup path (the classes and modules available to the current object) for the next method of the same name as the one being executed. Such method, if present, may be defined in the superclass of the object’s class, but may also be defined in the superclass’s superclass or any class on the upward path, as well as any module mixed in to any of those classes."
+    example:
+        - "module Vehicular"
+        - "  def move_forward(n)"
+        - "    @position += n"
+        - "  end"
+        - "end"
+        - " "
+        - "class Vehicle"
+        - "  include Vehicular  # Adds Vehicular to the lookup path"
+        - "end"
+        - " "
+        - "class Car < Vehicle"
+        - "  def move_forward(n)"
+        - "    puts 'Vrooom!'"
+        - "    super            # Calls Vehicular#move_forward"
+        - "  end"
+        - "end"
+    
+"then":
+    definition: "Optional component of conditional statements (if, unless, when). Never mandatory, but allows for one-line conditionals without semi-colons."
+    example:
+        - "if a > b; puts 'a wins!' end"
+        - "if a > b then puts 'a wins!' end"
+    
+"true":
+    definition: "The sole instance of the special class TrueClass. true encapsulates Boolean truth; however, <emph>all</emph> objects in Ruby are true in the Boolean sense (informally, they cause an if test to succeed), with the exceptions of false and nil."
+    
+"undef":
+    definition: "Undefines a given method, for the class or module in which it’s called. If the method is defined higher up in the lookup path (such as by a superclass), it can still be called by instances classes higher up."
+    example:
+        - "class C"
+        - "  def m"
+        - "    'Hi'"
+        - "  end"
+        - "end"
+        - "class D < C"
+        - "end"
+        - "class E < D"
+        - "end"
+        - " "
+        - "class D"
+        - "  undef m"
+        - "end"
+        - " "
+        - "C.new.m   # Hi"
+        - "D.new.m   # error"
+        - "E.new.m   # error"
+    
+"unless":
+    definition: "The negative equivalent of if."
+    example:
+        - "unless y.score > 10"
+        - "  puts 'Sorry; you needed 10 points to win.'"
+        - "end"
+    
+"until":
+    definition: "The inverse of while : executes code until a given condition is true, i.e., while it is not true. The semantics are the same as those of while; see while."
+    
+"when":
+    definition: "Used with keyword case"
+    example:
+        - "case x"
+        - "when 1,2,3"
+        - "  puts '1, 2, or 3'"
+        - "when 10"
+        - "  puts '10'"
+        - "else"
+        - "  puts 'Some other number'"
+        - "end"
+
+"while":
+    definition: "while takes a condition argument, and executes the code that follows (up to a matching end delimiter) while the condition is true."
+    example:
+        - "i = 0"
+        - "while i < 10"
+        - "  i += 1"
+        - "end"
+    
+"yield":
+    definition: "Called from inside a method body, yields control to the code block (if any) supplied as part of the method call. If no code block has been supplied, calling yield raises an exception."
+    

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubykeyword
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Edwin Rozario
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-23 00:00:00 +05:30
+date: 2012-03-07 00:00:00 +05:30
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/rubykeyword.rb
+- lib/settings.yaml
 has_rdoc: true
 homepage: https://github.com/EdwinRozario/RubyKeyword
 licenses: []