relevant-widget 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+relevant-widget-*.gem

data/README.md

@@ -0,0 +1,13 @@
+Relevant/Widget
+===============
+
+This library is the core of the widget system for Relevant. As a result, it will be a dependency of every widget.
+
+Registering Widgets
+-------------------
+
+In order for Relevant to be aware of your widget you will need to register it. You can do this in the same file as your widget, or you can just call it somewhere else if you'd like it to be optional.
+
+    Relevant.register FooWidget
+    
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require File.dirname(__FILE__) + "/lib/relevant/version.rb"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.version = Relevant::Version
+    gemspec.name = "relevant-widget"
+    gemspec.summary = "Base widget class for your mind!"
+    gemspec.description = "Base class to do widgets for the Relevant raditor"
+    gemspec.email = "opensource@thinkrelevance.com"
+    gemspec.homepage = "http://github.com/relevance/relevant-widget"
+    gemspec.authors = ["Jared Pace", "Rob Sanheim"]
+    gemspec.add_dependency "tilt", "1.1"
+    gemspec.add_development_dependency "rspec", "~> 2.0.0.beta.22"
+  end
+  Jeweler::GemcutterTasks.new
+  
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/relevant/relevant.rb

@@ -0,0 +1,18 @@
+
+module Relevant
+  
+  @widgets = []
+  
+  def self.widgets
+    @widgets
+  end
+  
+  def self.register(widget) 
+    @widgets << widget
+  end
+  
+  def self.unregister_all!
+    @widgets = []
+  end
+  
+end

data/lib/relevant/renderer.rb

@@ -0,0 +1,16 @@
+module Relevant
+  
+  class Renderer
+    def initialize(widget)
+      @widget = widget
+    end
+
+    def to_html
+      return unless @widget.class.template
+
+      template_handler = Tilt[@widget.class.template_format].new { @widget.class.template.strip }
+      template_handler.render(@widget)
+    end
+  end
+  
+end

data/lib/relevant/version.rb

@@ -0,0 +1,3 @@
+module Relevant
+  Version = VERSION = "0.0.2"
+end

data/lib/relevant/widget.rb

@@ -0,0 +1,41 @@
+require "tilt"
+require "relevant/relevant"
+require "relevant/renderer"
+
+module Relevant
+  module Widget
+    
+    def self.included(base)
+      base.extend ClassMethods
+      
+      attr_accessor :options
+    end
+
+    module ClassMethods
+      
+      def setup(options = {})
+        widget = new
+        widget.options = options
+        
+        widget
+      end
+      
+      def available_options(options = nil)
+        options.nil? ? @available_options : (@available_options = options)
+      end
+
+      def template_format(format = nil)
+        format.nil? ? @template_format : (@template_format = format)
+      end
+
+      def template(data = nil)
+        data.nil? ? @template : (@template = data)
+      end
+
+      def refresh_every(seconds = nil)
+        seconds.nil? ? @refresh_every : (@refresh_every = seconds)
+      end      
+    end
+    
+  end
+end

data/relevant-widget.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{relevant-widget}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jared Pace", "Rob Sanheim"]
+  s.date = %q{2010-09-24}
+  s.description = %q{Base class to do widgets for the Relevant raditor}
+  s.email = %q{opensource@thinkrelevance.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "lib/relevant/relevant.rb",
+     "lib/relevant/renderer.rb",
+     "lib/relevant/version.rb",
+     "lib/relevant/widget.rb",
+     "relevant-widget.gemspec",
+     "spec/relevant/relevant_spec.rb",
+     "spec/relevant/renderer_spec.rb",
+     "spec/relevant/widget_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/relevance/relevant-widget}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Base widget class for your mind!}
+  s.test_files = [
+    "spec/relevant/relevant_spec.rb",
+     "spec/relevant/renderer_spec.rb",
+     "spec/relevant/widget_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<tilt>, ["= 1.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    else
+      s.add_dependency(%q<tilt>, ["= 1.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    end
+  else
+    s.add_dependency(%q<tilt>, ["= 1.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+  end
+end
+

data/spec/relevant/relevant_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Relevant do
+  
+  context '#widgets' do
+    around do |example|
+      Relevant.unregister_all!
+      example.run
+      Relevant.unregister_all!
+    end
+    
+    it "can unregister_all widgets" do
+      Relevant.register TestWidget
+      Relevant.unregister_all!
+      Relevant.widgets.should == []
+    end
+    
+    it "can register widgets" do
+      Relevant.register TestWidget
+      Relevant.widgets.should == [TestWidget]
+    end
+  end
+  
+end

data/spec/relevant/renderer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Relevant::Renderer do
+  describe "to_html" do
+    it "renders the widgets template" do
+      TestWidget.template "Hello <%= @options[:name] %>"
+      TestWidget.template_format :erb
+      widget = TestWidget.setup(:name => 'Mr. Roboto')
+      
+      renderer = Relevant::Renderer.new widget
+      renderer.to_html.should == "Hello Mr. Roboto"
+    end
+  end
+  
+end

data/spec/relevant/widget_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Relevant::Widget do
+  describe "options" do
+    it "tracks the types for form building" do
+      TestWidget.available_options[:name].should == String
+    end
+  end
+  
+  describe 'template_format' do
+    it "reads the format if given no options" do
+      TestWidget.template_format.should == :erb
+    end
+    
+    it "allows sets the format if you pass it" do
+      TestWidget.template_format :haml
+      TestWidget.template_format.should == :haml
+    end
+  end
+  
+  describe 'template' do
+    it "reads the template if given no options" do
+      TestWidget.template.should == "Hello <%= @options[:name] %>"
+    end
+    
+    it "allows sets the template if you pass it" do
+      TestWidget.template "Hello World"
+      TestWidget.template.should == "Hello World"
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'active_support'
+require 'active_support/all'
+
+$LOAD_PATH.unshift "../lib"
+require "relevant/widget"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.mock_with :mocha
+
+  config.formatter = :progress
+  config.color_enabled = true
+  config.filter_run :focused => true
+  config.run_all_when_everything_filtered = true
+  config.alias_example_to :fit, :focused => true
+end
+
+class TestWidget
+  include Relevant::Widget
+  
+  available_options :name => String
+    
+  template_format :erb
+  template 'Hello <%= @options[:name] %>'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: relevant-widget
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jared Pace
+- Rob Sanheim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id002
+description: Base class to do widgets for the Relevant raditor
+email: opensource@thinkrelevance.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- lib/relevant/relevant.rb
+- lib/relevant/renderer.rb
+- lib/relevant/version.rb
+- lib/relevant/widget.rb
+- relevant-widget.gemspec
+- spec/relevant/relevant_spec.rb
+- spec/relevant/renderer_spec.rb
+- spec/relevant/widget_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/relevance/relevant-widget
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Base widget class for your mind!
+test_files: 
+- spec/relevant/relevant_spec.rb
+- spec/relevant/renderer_spec.rb
+- spec/relevant/widget_spec.rb
+- spec/spec_helper.rb