interrogative 0.3.0 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/interrogative.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "interrogative"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Lloyd"]

data/lib/interrogative.rb

@@ -17,32 +17,35 @@ module Interrogative
     #
     # Useful when you need to postprocess questions at a higher level.
     #
-    # @param [Question] the Question.
+    # @param [Question] question the `Question`.
+    # @return [Question] the `Question`.
     def postprocess_question(question)
       unless @_question_postprocessors.nil?
         @_question_postprocessors.each do |postprocessor|
           postprocessor.call(question)
         end
       end
+      question
     end
 
     # Give a new question.
     #
-    # @param [Symbol, String] name the name (think <input name=...>) of
+    # @param [Symbol, String] name the name (think \<input name=...>) of
     #   the question.
-    # @param [String] label the text of the question (think <label>).
+    # @param [String] label the text of the question (think \<label>).
     # @param [Hash] attrs additional attributes for the question.
     # @option attrs [Boolean] :long whether the question has a long answer
-    #   (think <textarea> vs <input>).
+    #   (think \<textarea> vs \<input>).
     # @option attrs [Boolean] :multiple whether the question could have
     #   multiple answers.
-    # @return [Question] the new Question.
+    # @param [Proc] instance_block a block returning option values.
+    # @return [Question] the new `Question`.
+    # @see Question#options
     def question(name, text, attrs={}, &instance_block)
       q = Question.new(name, text, self, attrs, &instance_block)
       (@_questions||=[]) << q
       
       postprocess_question(q)
-
       return q
     end
   end
@@ -53,10 +56,10 @@ module Interrogative
   module ClassMethods
     include BaseMethods
 
-    # Get the array of all noted questions.
+    # Get the array of all noted questions for this class and its superclasses.
     #
     # @return [Array<Question>] array of all noted questions.
-    def questions(instance=nil)
+    def questions
       qs = []
       qs |= superclass.questions if superclass.respond_to? :questions
       qs |= (@_questions||=[])
@@ -70,14 +73,30 @@ module Interrogative
   module InstanceMethods
     include BaseMethods
 
+    # Get the array of all noted questions for this instance and its class
+    # (and all of its superclasses), bound to this instance.
+    #
+    # All questions will be bound to the instance on which `questions`
+    # is called, so their `instance_block`s, if provided, will be evaluated
+    # in its context.
+    #
+    # @return [Array<Question>]
+    # @see ClassMethods#questions
+    # @see Question#options
     def questions
       qs = []
-      qs |= self.class.questions(self) if self.class.respond_to? :questions
+      qs |= self.class.questions if self.class.respond_to? :questions
       qs |= (@_questions||=[])
-      qs
+      qs.map{|q| q.for_instance(self) }
     end
   end
 
+  # Gives the class `base` Interrogative's class-level methods
+  # and gives instances of `base` Interrogative's instance-level methods.
+  #
+  # Called when `Interrogative` is included.
+  #
+  # @param [Class] base the class in which `Interrogative` has been included.
   def self.included(base)
     base.extend(Interrogative::ClassMethods)
     base.class_eval do
@@ -85,4 +104,3 @@ module Interrogative
     end
   end
 end
-

data/lib/interrogative/question.rb

@@ -9,7 +9,7 @@ module Interrogative
   # betraying the fact that it's meant to transform into an HTML form
   # element.
   class Question
-    attr_accessor :name, :text, :attrs
+    attr_accessor :name, :text, :attrs, :instance
 
     # @see Interrogative#question
     def initialize(name, text, owner=nil, attrs={}, &instance_block)
@@ -17,9 +17,18 @@ module Interrogative
       @text = text or raise ArgumentError, "A question must have a label."
       @owner = owner
       @attrs = attrs
+      @instance = nil
       @instance_block = instance_block
     end
 
+    # Returns a copy of this question that is bound to some object.
+    #
+    # This object will be used as the instance on which the `instance_block`,
+    # if provided, is `instance_eval`ed.
+    def for_instance(instance)
+      self.clone.tap{|q| q.instance = instance }
+    end
+
     # Possible answers for the question.
     #
     # If a block was passed to the initializer, then the result of
@@ -35,10 +44,10 @@ module Interrogative
     # In the case of a Hash, the format should be `{ text => value }`.
     #
     # @return [Array, Hash] the possible answers for the question.
-    def options(instance=nil)
+    def options
       if (@instance_block)
-        if not instance.nil?
-          return instance.instance_eval &@instance_block
+        if not @instance.nil?
+          return @instance.instance_eval &@instance_block
         else
           return @instance_block.call
         end
@@ -52,26 +61,19 @@ module Interrogative
       end
     end
 
-    # Equivalent to calling `hash_for_instance` without an instance.
-    #
-    # @see #hash_for_instance
-    def to_hash
-      hash_for_instance(nil)
-    end
-
     # Returns a hash representation of the question.
     #
     # Attributes are merged into the top level, along with `:text` and
     # `:name`. Possible options are nested under `:options`.
     #
     # @return [Hash]
-    def hash_for_instance(instance=nil)
+    def to_hash
       h = @attrs.merge({
         :text => text,
         :name => name,
       })
 
-      o = options(instance)
+      o = options
       h[:options] = o if not o.nil?
       return h
     end
@@ -80,14 +82,7 @@ module Interrogative
     # representation.
     #
     # @return [String]
-    # @see #hash_for_instance
-    def json_for_instance(instance=nil, opts={})
-      self.hash_for_instance(instance).to_json(opts)
-    end
-
-    # Equivalent to calling `json_for_instance` without an instance.
-    #
-    # @see #json_for_instance
+    # @see #to_hash
     def to_json(opts={})
       self.to_hash.to_json(opts)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interrogative
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70347291288840 !ruby/object:Gem::Requirement
+  requirement: &70102326682260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70347291288840
+  version_requirements: *70102326682260
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &70347291287780 !ruby/object:Gem::Requirement
+  requirement: &70102326681220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70347291287780
+  version_requirements: *70102326681220
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70347291287080 !ruby/object:Gem::Requirement
+  requirement: &70102326680580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70347291287080
+  version_requirements: *70102326680580
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70347291286060 !ruby/object:Gem::Requirement
+  requirement: &70102326679560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70347291286060
+  version_requirements: *70102326679560
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70347291301860 !ruby/object:Gem::Requirement
+  requirement: &70102326695340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70347291301860
+  version_requirements: *70102326695340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70347291301240 !ruby/object:Gem::Requirement
+  requirement: &70102326694720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70347291301240
+  version_requirements: *70102326694720
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70347291300180 !ruby/object:Gem::Requirement
+  requirement: &70102326693660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70347291300180
+  version_requirements: *70102326693660
 description: ! "    A simple interface for keeping track of HTML-form-like questions
   without \n    feeling like you're accomodating HTML forms.\n"
 email: alloyd@jibe.com
@@ -125,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3466753285083621786
+      hash: -1066373110683406095
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: