interrogative 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "json"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "riot", ">= 0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "redcarpet"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.0)
+    riot (0.12.5)
+      rr
+    rr (1.0.4)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  json
+  rdoc (~> 3.12)
+  redcarpet
+  riot
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Adam Lloyd
+
+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,19 @@
+# interrogative
+
+`Interrogative` is a Ruby mixin for curious classes.
+
+## Contributing to interrogative
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Adam Lloyd. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "interrogative"
+  gem.homepage = "http://github.com/alloy-d/interrogative"
+  gem.license = "MIT"
+  gem.summary = %Q{A mixin for curious classes.}
+  gem.description = <<-EOD
+    A simple interface for keeping track of HTML-form-like questions without 
+    feeling like you're accomodating HTML forms.
+  EOD
+  gem.email = "alloyd@jibe.com"
+  gem.authors = ["Adam Lloyd"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/interrogative.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "interrogative"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Lloyd"]
+  s.date = "2012-02-13"
+  s.description = "    A simple interface for keeping track of HTML-form-like questions without \n    feeling like you're accomodating HTML forms.\n"
+  s.email = "alloyd@jibe.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "interrogative.gemspec",
+    "lib/interrogative.rb",
+    "lib/interrogative/question.rb",
+    "test/interrogative_test.rb",
+    "test/teststrap.rb"
+  ]
+  s.homepage = "http://github.com/alloy-d/interrogative"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "A mixin for curious classes."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<riot>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<riot>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<riot>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+  end
+end
+

data/lib/interrogative.rb

@@ -0,0 +1,42 @@
+require 'interrogative/question'
+
+# A mixin for curious classes.
+module Interrogative
+  # Get the array of all noted questions.
+  #
+  # @return [Array<Question>] array of all noted questions.
+  def questions; @_questions; end
+
+  # Give instructions for dealing with new questions.
+  #
+  # @param [Proc] postprocessor a block to run after adding a question;
+  #                             the question is given as the argument.
+  def when_questioned(&postprocessor)
+    (@_question_postprocessors||=[]) << postprocessor
+  end
+
+  # Give a new question.
+  #
+  # @param [Symbol, String] name the name (think <input name=...>) of
+  #   the question.
+  # @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>).
+  # @option attrs [Boolean] :multiple whether the question could have
+  #   multiple answers.
+  # @return [Question] the new Question.
+  def question(name, text, attrs={})
+    q = Question.new(name, text, self, attrs)
+    (@_questions||=[]) << q
+    
+    unless @_question_postprocessors.nil?
+      @_question_postprocessors.each do |postprocessor|
+        postprocessor.call(q)
+      end
+    end
+
+    return q
+  end
+end
+

data/lib/interrogative/question.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'yaml'
+
+module Interrogative
+
+  # A question with a unique name and a textual representation.
+  #
+  # Designed to translate well into an HTML form element without
+  # betraying the fact that it's meant to transform into an HTML form
+  # element.
+  class Question
+    attr_accessor :name, :text, :attrs
+
+    # @see Interrogative#question
+    def initialize(name, text, owner=nil, attrs={})
+      @name = name or raise ArgumentError, "A question must have a name."
+      @text = text or raise ArgumentError, "A question must have a label."
+      @owner = owner
+      @attrs = attrs
+    end
+
+    # Possible answers for the question.
+    #
+    # Returns `nil` unless the class that included Interrogative
+    # responds to a method called `#{ name }_options`; otherwise, it
+    # returns the result of calling that method.
+    #
+    # Options should be either an Array or a Hash.
+    # In the case of a Hash, the format should be `{ text => value }`.
+    #
+    # @return [Array, Hash] the possible answers for the question.
+    def options
+      return nil if @owner.nil?
+
+      options_method = "#{@name}_options".intern
+      if @owner.respond_to? options_method
+        @owner.send options_method
+      end
+    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 to_hash
+      h = @attrs.merge({
+        :text => text,
+        :name => name,
+      })
+
+      o = options
+      h[:options] = o if not o.nil?
+      return h
+    end
+
+    # Returns a JSON object created from the question's hash
+    # representation.
+    #
+    # @return [String]
+    # @see #to_hash
+    def to_json(opts={})
+      self.to_hash.to_json(opts)
+    end
+  end
+end
+

data/test/interrogative_test.rb

@@ -0,0 +1,11 @@
+require 'teststrap'
+
+context "interrogative" do
+  setup do
+    false
+  end
+
+  asserts "i'm a failure :(" do
+    topic
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'riot'
+require 'interrogative'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: interrogative
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Lloyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70276415456120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70276415456120
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &70276415471080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276415471080
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70276415470480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70276415470480
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70276415469800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70276415469800
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70276415468960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70276415468960
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70276415467980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70276415467980
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70276415467400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70276415467400
+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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- interrogative.gemspec
+- lib/interrogative.rb
+- lib/interrogative/question.rb
+- test/interrogative_test.rb
+- test/teststrap.rb
+homepage: http://github.com/alloy-d/interrogative
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4348943104626374028
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A mixin for curious classes.
+test_files: []